# EUDI Wallet and European Business Wallet Developer Docs and APIs | iGrant.io: full documentation

Build on the European Digital Identity Wallet framework. Full support for OpenID4VC, SD-JWT, and ISO 18013-5 mdoc.

This file concatenates the markdown of all 442 documentation pages. Install the iGrant.io Agent Skills with `npx skills add L3-iGrant/skills` to have an AI agent build these integrations.

---

# Reference guide to EUDI Wallet abbreviations
Source: https://docs.igrant.io/docs/abbreviations/

---
id: abbreviations
title: Reference guide to EUDI Wallet abbreviations
description: Browse common EUDI Wallet abbreviations and their meanings used across digital identity, verifiable credentials, and wallet documentation.
hide_title: true
sidebar_label: Abbreviations
keywords: [abbreviations, EUDI Wallet, glossary, digital identity, verifiable credentials, eIDAS, OpenID4VC, acronyms, reference]
slug: /abbreviations/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


| Abbr       | Expanded form                                                         |
| :--------- | :-------------------------------------------------------------------- |
| ADA        | Automated Data Agreements                                             |
| ARF        | European Digital Identity Wallet Architecture and Reference Framework |
| CAB        | Conformity Assessment Body                                            |
| CRUD       | Create / Read / Update / Delete                                       |
| DA         | Data Agreement                                                        |
| DCQL       | Digital Credentials Query Language                                    |
| DDA        | Data Disclosure Agreement                                             |
| DGA        | Data Governance Act                                                   |
| DID        | Decentralized Identifier (according to W3C)                           |
| DPIA       | Data Protection Impact Assessment                                     |
| DS         | Data Source                                                           |
| DUS        | Data Using Service                                                    |
| EAA        | Electronic Attestation of Attributes                                  |
| EBWOID     | European Business Wallet Owner Identification                         |
| ECDH       | Elliptic-curve Diffie-Hellman                                         |
| EEA        | European Economic Area                                                |
| eIDAS      | electronic IDentification, Authentication and trust Services          |
| ETSI       | European Telecommunications Standards Institute                       |
| EU         | European Union                                                        |
| EUDI       | European Digital Identity                                             |
| EUDIW      | European Digital Identity Wallet                                      |
| FAQ        | Frequently Asked Questions                                            |
| GDPR       | General Data Protection Regulation                                    |
| HSM        | Hardware Security Module                                              |
| IETF       | Internet Engineering Task Force                                       |
| ISO        | International Organization for Standardization                        |
| JOSE       | JSON Object Signing and Encryption                                    |
| JSON       | JavaScript Object Notation                                            |
| JWE        | JSON Web Encryption                                                   |
| JWK        | JSON Web Key                                                          |
| JWS        | JSON Web Signature                                                    |
| JWT        | JSON Web Token                                                        |
| KA         | Key Attestation                                                       |
| LoA        | Level of Assurance                                                    |
| LoTL       | List of Trusted Lists                                                 |
| LPID       | Legal Person Identification Data                                      |
| MAC        | Message Authentication Code                                           |
| mDL        | Mobile Driving Licence                                                |
| mdoc       | ISO/IEC 18013-5 mobile document                                       |
| OAuth      | Open Authorization                                                    |
| OID4VC     | OpenID for Verifiable Credentials                                     |
| OID4VCI    | OpenID for Verifiable Credentials Issuance                            |
| OID4VP     | OpenID for Verifiable Presentation                                    |
| OP         | OpenID Provider                                                       |
| OpenID4VC  | OpenID for Verifiable Credentials                                     |
| OpenID4VCI | OpenID for Verifiable Credential Issuance                             |
| PID        | Person Identification Data                                            |
| PKI        | Public Key Infrastructure                                             |
| PoP        | Proof of Possession                                                   |
| PuB-EAA    | Electronic Attestation of Attributes issued by a Public Sector Body   |
| QEAA       | Qualified Electronic Attestation of Attributes                        |
| QES        | Qualified Electronic Signatures                                       |
| QTSP       | Qualified Trust Service Provider                                      |
| RP         | Relying Party                                                         |
| SD-JWT     | Selective Disclosure for JWT                                          |
| SD-JWT VC  | SD-JWT-based Verifiable Credentials                                   |
| SDK        | Software Development Kit                                              |
| SE         | Secure Element                                                        |
| SIOP       | Self-issued OpenID Provider                                           |
| SSI        | Self Sovereign Identity                                               |
| TAO        | Trust Anchor Operator                                                 |
| TEE        | Trusted Execution Environment                                         |
| TI         | Trusted Issuer                                                        |
| TLS        | Transport Layer Security                                              |
| ToIP       | Trust over Internet Protocol                                          |
| TS3        | Technical Specification 3 (EUDI Wallet Unit Attestation)              |
| TSP        | Trust Service Provider                                                |
| UC         | Use case                                                              |
| URL        | Uniform Resource Locator                                              |
| VC         | Verifiable Credential                                                 |
| VCI        | Verifiable Credentials Issuance                                       |
| VP         | Verifiable Presentation                                               |
| W3C        | World Wide Web Consortium                                             |
| WIA        | Wallet Instance Attestation                                           |
| WSCA       | Wallet Secure Cryptographic Application                               |
| WSCD       | Wallet Secure Cryptographic Device                                    |
| WUA        | Wallet Unit Attestation                                               |
| ZKP        | Zero-Knowledge Proof                                                  |

---

# Agent Skills catalogue
Source: https://docs.igrant.io/docs/agent-skills-catalogue/

---
id: agent-skills-catalogue
title: Agent Skills catalogue
description: Browse every iGrant.io Agent Skill for EUDI Wallet and European Business Wallet integrations, grouped by role, with what each skill does, its protocols and its dependencies.
hide_title: false
hide_table_of_contents: true
sidebar_label: Skills catalogue
keywords: [agent skills catalogue, SKILL.md, EUDI Wallet, European Business Wallet, OpenID4VCI, OpenID4VP, DCQL, DC API, consent management, iGrant.io skills]
slug: /agent-skills-catalogue/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Agent Skills catalogue for EUDI Wallet integrations | iGrant.io DevDocs</title>
  <meta name="description" content="Browse every iGrant.io Agent Skill for EUDI Wallet and European Business Wallet integrations, grouped by role, with what each skill does, its protocols and its dependencies." />
</head>

import SkillsCatalogue from '@site/src/components/SkillsCatalogue';

Every skill below lives in [L3-iGrant/skills](https://github.com/L3-iGrant/skills) and is installed with `npx skills add L3-iGrant/skills`. This catalogue is generated from each skill's `SKILL.md`, so it always reflects the latest published version. Use the search box to filter, and select any card to open its `SKILL.md`.

<SkillsCatalogue />


---

# Agent Skills for EUDI Wallet integrations
Source: https://docs.igrant.io/docs/agent-skills/

---
id: agent-skills-overview
title: Agent Skills for EUDI Wallet integrations
description: Install iGrant.io Agent Skills so your AI coding agent (Claude Code, Cursor, and any SKILL.md agent) can build EUDI Wallet and European Business Wallet integrations on the Organisation Wallet Suite and Consent Building Block.
hide_title: false
sidebar_label: Overview
keywords: [agent skills, SKILL.md, Claude Code, Cursor, AI coding agent, EUDI Wallet, European Business Wallet, OpenID4VCI, OpenID4VP, DCQL, DC API, consent management, iGrant.io, Organisation Wallet Suite]
slug: /agent-skills/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Agent Skills for EUDI Wallet integrations | iGrant.io DevDocs</title>
  <meta name="description" content="Install iGrant.io Agent Skills so your AI coding agent can build EUDI Wallet and European Business Wallet integrations on the Organisation Wallet Suite and Consent Building Block." />
</head>

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { ClaudeIcon, CursorIcon, CodexIcon, CopilotIcon } from '@site/src/components/AgentIcons';

**Agent Skills** teach AI coding agents (Claude Code, Cursor, and any agent that supports the `SKILL.md` format) how to build European Digital Identity (EUDI) Wallet and European Business Wallet integrations on the iGrant.io Organisation Wallet Suite (OWS) and Consent Building Block. Instead of copying code from these docs by hand, you install the skills once and describe what you want to build; your agent loads the relevant skill on demand and follows the exact iGrant.io API contracts.

The skills are open source (Apache-2.0) and published at [L3-iGrant/skills](https://github.com/L3-iGrant/skills). You can also browse them on [skills.sh](https://www.skills.sh/l3-igrant/skills).

## What you can build

- **Credential issuance** using OpenID4VCI 1.0 (in-time and deferred), issuing SD-JWT VC, W3C VC 2.0 and mso_mdoc credentials.
- **Credential verification** using OpenID4VP 1.0 with DCQL, including same-device presentation over the Digital Credentials API (DC API).
- **Consent management** for recording and managing individual consents against data agreements.

Each skill keeps per-organisation API keys behind a backend proxy (the key never reaches the browser), handles HMAC-verified webhooks, and pushes live status to the frontend over Server-Sent Events (SSE), following least privilege by role (issuer versus verifier).

## Install and set up

```bash
npx skills add L3-iGrant/skills
```

The command auto-detects your agent and lets you choose which skills to install. Following least privilege, install only the issuer or verifier set you need; dependencies are pulled in automatically (see the [Skills catalogue](/docs/agent-skills-catalogue/)).

<Tabs groupId="agent">
<TabItem value="claude-code" label={<span style={{display: 'inline-flex', alignItems: 'center', gap: '6px'}}><ClaudeIcon size={14} /> Claude Code</span>} default>

Claude Code loads `SKILL.md` skills automatically. Confirm what is installed:

```bash
npx skills list
```

Then prompt Claude Code to build using the skills (see [Prompt your agent](#prompt-your-agent) below).

</TabItem>
<TabItem value="cursor" label={<span style={{display: 'inline-flex', alignItems: 'center', gap: '6px'}}><CursorIcon size={14} /> Cursor</span>}>

Cursor reads the installed `SKILL.md` skills. Reference the `igrantio` skills in your prompt and Cursor applies the matching one.

</TabItem>
<TabItem value="codex" label={<span style={{display: 'inline-flex', alignItems: 'center', gap: '6px'}}><CodexIcon size={14} /> Codex</span>}>

Codex (OpenAI) supports the `SKILL.md` format. Install the skills as above, then reference the `igrantio` skills in your prompt and Codex applies the matching one.

</TabItem>
<TabItem value="copilot" label={<span style={{display: 'inline-flex', alignItems: 'center', gap: '6px'}}><CopilotIcon size={14} /> GitHub Copilot</span>}>

GitHub Copilot supports the `SKILL.md` format. Install the skills as above, then reference the `igrantio` skills in your prompt.

</TabItem>
<TabItem value="other" label="Other agents">

Any agent that supports the `SKILL.md` format works. Target a specific agent, or all detected agents:

```bash
npx skills add L3-iGrant/skills -a cursor   # a specific agent
npx skills add L3-iGrant/skills -a '*'       # all detected agents
```

List the available skills without installing:

```bash
npx skills add L3-iGrant/skills --list
```

</TabItem>
</Tabs>

## Prompt your agent

Describe the integration and reference the skills. For example:

> Using the igrantio skills, build me an OpenID4VCI issuer backend with per-tenant API keys, and a React frontend that shows the credential-offer QR and updates live when the wallet accepts.

> Add verifiable-presentation verification (OpenID4VP + DCQL) to my Express app using the igrantio verifier skills.

> Using the igrantio consent skills, add consent capture against a data agreement, with allow, withdraw and history.

Your agent loads the matching skill, applies the OWS endpoints, payloads and response fields it defines, and keeps the API key on the backend.

## Keep your skills up to date

```bash
npx skills update
```

Run this whenever the skills are updated so your agent builds against the latest API contracts.

## Browse the skills

See the **[Skills catalogue](/docs/agent-skills-catalogue/)** for every available skill, grouped by role, with what each one does and its dependencies.

## Documentation index for agents

Point your agent at the machine-readable documentation index at [docs.igrant.io/llms.txt](https://docs.igrant.io/llms.txt) so it can discover every guide and reference on this site.

:::info Related API references
The skills build against the same APIs documented here: [Issue a credential (in-time)](/docs/openID4vci-issue-credential-intime/) and [Send and verify credentials (OpenID4VP)](/docs/openID4vc-send-verify-credentials/) for the wallet flows, and the [Consent Management APIs](/docs/consent-management-apis/) for consent records.
:::


---

# Get API Keys
Source: https://docs.igrant.io/docs/developer-apis/get-started/

---
id: api-getting-started
title: Get API Keys
description: Get API keys and start integrating iGrant.io APIs for credential issuance, verification, consent management, and digital wallet workflows.
keywords: [API getting started, API key, developer setup, OpenID4VC, credential API, digital wallet API, iGrant.io]
hide_title: true
sidebar_label: Get API Keys
slug: /developer-apis/get-started/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


## Get API Keys

Begin your development journey with our APIs by following these steps:

1. **Get Access to our APIs**: Send in an email to [iGrant.io Developer Support](mailto:support@igrant.io?subject=Request%20Developer%20Access) to obtain your API keys.

2. **Explore Documentation**: Each API's detailed documentation provides setup guides, usage examples, and troubleshooting tips.

3. **Test and Implement**: Utilise our demo environment for testing to integrate APIs seamlessly into your projects.

## Need Help?

Our support team is ready to assist you at every step:

- **Email**: [support@igrant.io](mailto:support@igrant.io)
- **WhatsApp Us**: [WhatsApp Us](https://wa.me/message/3YFVQOBN5ZYFE1)
- **GitHub Issues**: Report bugs or suggest improvements by creating an issue on our [GitHub repository](https://github.com/igrantio).

Your feedback drives our continuous improvement, and we’re excited to see how our APIs will help you achieve your development goals. Welcome to the future of data identity and data exchange with iGrant.io!

---

# Developer APIs
Source: https://docs.igrant.io/docs/developer-apis/

---
id: api-intro
title: Developer APIs
description: Explore iGrant.io developer APIs for OpenID4VC credential issuance and verification, consent management, and digital wallet integration.
keywords: [developer API, OpenID4VC, OpenID4VCI, OpenID4VP, credential issuance, credential verification, consent management, digital wallet, EUDI Wallet]
hide_title: true
sidebar_label: Overview
slug: /developer-apis/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import Cards from '@site/src/components/Card';

<NoteBox title="Ready to integrate?" variant="tip">
Get your API keys from <a href="/docs/developer-apis/get-started/">Get API Keys</a>, or start with the <a href="/docs/get-started/">Get Started guide</a> for step-by-step tutorials.
<br />
<strong>Prefer to build with AI?</strong> Install the iGrant.io Agent Skills with <code>npx skills add L3-iGrant/skills</code> and your AI coding agent (Claude Code, Cursor, Codex, GitHub Copilot, or any SKILL.md agent) can build these API integrations for you. See <a href="/docs/agent-skills/">Build with AI Agents</a>.
</NoteBox>

iGrant.io provides comprehensive APIs for building on the European Digital Identity (EUDI) Wallet and European Business Wallet ecosystem. Our APIs cover credential issuance and verification using OpenID4VC (OpenID4VCI and OpenID4VP), consent management, extensions, and data marketplace integration.

<Cards />


---

# Set up webhooks for OpenID4VC integrations
Source: https://docs.igrant.io/docs/openid4vc-webhooks/

---
id: openid4vc-webhooks
hide_title: true
title: Set up webhooks for OpenID4VC integrations
description: Understand how to configure webhooks in OpenID4VC workflows to manage real‑time events like credential issuance, updates, and verification responses.
keywords: [webhooks, OpenID4VC, event notifications, credential issuance events, verification events, Organisation Wallet, European Business Wallet, API integration]
sidebar_label: Webhook Events
slug: /openid4vc-webhooks/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


# Webhook Events

Organisation Wallet Suite by iGrant.io provides webhooks to notify your application about important events in the OpenID4VC-based credential issuance and verification process. This document lists all available webhook events and their descriptions for the OpenID4VC implementation.

## Webhook Management

Before receiving webhook events, you need to configure your webhook endpoints. The following APIs are available for managing webhooks:

| API | Description | Documentation |
|-----|-------------|---------------|
| Create Webhook | Create a new webhook endpoint | [Create Webhook](/docs/openid4vc-api/config-create-webhook) |
| Read Webhook | Get details of a specific webhook | [Read Webhook](/docs/openid4vc-api/config-read-webhook) |
| Update Webhook | Modify an existing webhook configuration | [Update Webhook](/docs/openid4vc-api/config-update-webhook) |
| Delete Webhook | Remove a webhook endpoint | [Delete Webhook](/docs/openid4vc-api/config-delete-webhook) |
| List Webhooks | Get all configured webhooks | [List Webhooks](/docs/openid4vc-api/config-list-webhooks) |

## Issuer Webhooks

Issuer webhooks notify you about events related to credential issuance and management.

| Event Name | Description |
|------------|-------------|
| `openid.credential.offer_sent` | Triggered when a credential offer is created and delivered using QR code or credential offer endpoint |
| `openid.credential.offer_received` | Triggered when a credential offer is accessed by the wallet unit (or holder) |
| `openid.credential.token_issued` | Triggered when a token is issued during the credential issuance process |
| `openid.credential.credential_issued` | Triggered when a credential is issued to the wallet unit (or holder) by the issuer |
| `openid.credential.credential_acked` | Triggered when a credential is received and acknowledged in the wallet unit (or holder) |
| `openid.credential.credential_accepted` | Triggered when the credential is accepted by the wallet unit (or holder) to store |
| `openid.credential.credential_deleted` | Triggered when the credential is deleted by the wallet unit (or holder) |
| `openid.credential.issuance_denied` | Triggered when credential issuance is denied for various reasons such as: wallet unit attestation invalid or missing, proof of possession invalid, valid credential already exists (if credential uniqueness is enforced), or authorisation failed |

## Verifier Webhooks

Verifier webhooks notify you about events related to presentation requests and verifications.

| Event Name | Description |
|------------|-------------|
| `openid.presentation.request_sent.v3` | Triggered when a presentation request is created and delivered using QR code |
| `openid.presentation.request_received.v3` | Triggered when a presentation request is accessed by the wallet unit (or holder) |
| `openid.presentation.presentation_acked.v3` | Triggered when a presentation request is received, acknowledged, and verification is performed by the verifier |

## Webhook Payload

Each webhook event includes a JSON payload containing relevant information about the event. The payload structure follows a consistent format with common fields and event-specific data.

### Common Payload Fields

| Field | Type | Description |
|-------|------|-------------|
| `deliveryID` | string | Unique identifier for this webhook delivery |
| `webhookID` | string | Identifier of the webhook configuration |
| `timestamp` | string | ISO 8601 timestamp of when the event occurred |
| `type` | string | The type of event (e.g. "openid.credential.offer_sent") |
| `data` | object | Event-specific payload data that varies by event type |

### Payload Structure

All webhook events follow this consistent structure:

#### Issuance Webhook Example
```json
{
  "deliveryID": "67f770eec8426b0b55e30c2e",
  "webhookID": "67f770936e45cf84e6880d25",
  "timestamp": "2025-04-10T07:19:10Z",
  "data": {
    "credential": {
      "CredentialExchangeId": "3e154218-88d5-4529-8143-bf1ccf0e08c0",
      "credentialDefinitionId": "a79fb535-5e17-4571-928a-7b30011e4fa8",
      "walletUnitAttestationVerified": false
      // Additional credential history fields
    },
    "organisationId": "64ec561de2f6a8000142c671"
  },
  "type": "openid.credential.offer_sent"
}
```

#### Verification Webhook Example

```json
{
  "deliveryID": "67f77188c8426b0b55e30d08",
  "webhookID": "67f770936e45cf84e6880d25",
  "timestamp": "2025-04-10T07:21:44Z",
  "data": {
    "organisationId": "64ec561de2f6a8000142c671",
    "presentation": {
      "presentationExchangeId": "73315f05-089f-4548-b7ba-052ce828c7d7",
      "presentationDefinitionId": "bd28cfc2-4938-4f47-b91a-77412676d107",
      "walletUnitAttestationVerified": false
      // Additional verification history fields
    }
  },
  "type": "openid.presentation.request_received.v3"
}
```

For detailed field definitions, please refer to:
- [Issue credential](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential) response section for issuance webhooks
- [Send verification request (v3)](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3) response section for current version verification webhooks

## Delivery Guarantees

Webhook delivery follows an at-most-once guarantee. This means:
- Delivery is attempted once
- There is no built-in retry mechanism if the target endpoint is unreachable or errors out
- It is recommended to implement appropriate error handling and logging on your webhook endpoint

For detailed information about the payload structure for each event type, please refer to the specific event documentation.

## Webhook Security

Each webhook delivery includes an `X-iGrant-Signature` header that allows you to verify the authenticity of the webhook. The signature is generated using HMAC-SHA256 and includes a timestamp to prevent replay attacks.

### Signature Format

The `X-iGrant-Signature` header follows this format:
```
X-iGrant-Signature: t=<timestamp>,sig=<signature>
```

Where:
- `timestamp`: ISO 8601 timestamp in UTC (e.g., "2025-04-10T07:19:10Z")
- `signature`: HMAC-SHA256 signature of the payload

### Verifying the Signature

To verify a webhook signature:

1. Extract the timestamp and signature from the header
2. Get the raw request body
3. Concatenate the timestamp and request body with a period (`.`)
4. Compute HMAC-SHA256 using your webhook's secret key
5. Compare the computed signature with the received signature

Example verification code in Go:

```go
func verifyWebhookSignature(timestamp, signature, secretKey string, payload []byte) bool {
    // Construct the signed payload
    signedPayload := timestamp + "." + string(payload)
    
    // Create HMAC-SHA256 hash
    h := hmac.New(sha256.New, []byte(secretKey))
    h.Write([]byte(signedPayload))
    
    // Get the computed signature
    computedSig := hex.EncodeToString(h.Sum(nil))
    
    // Compare signatures
    return hmac.Equal([]byte(computedSig), []byte(signature))
}
```

### Security Best Practices

1. Always verify the webhook signature before processing the payload
2. Check that the timestamp is recent (e.g., within 5 minutes) to prevent replay attacks
3. Keep your webhook secret key secure and never share it
4. Use HTTPS endpoints for webhook delivery
5. Consider implementing rate limiting to prevent abuse


---

# Q1 2026 (January - March)
Source: https://docs.igrant.io/docs/changelog/2026-q1/

---
id: changelog-2026-q1
title: Q1 2026 (January - March)
description: Product updates for the Organisation Wallet Suite and Data Wallet in Q1 2026.
hide_title: false
sidebar_label: Q1 2026 (Jan - Mar)
keywords: [changelog, release notes, Organisation Wallet Suite, Data Wallet, iGrant.io, Q1 2026]
slug: /changelog/2026-q1/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


## March 2026 (2026.03.x)

### Organisation Wallet Suite
- Payment Extensions (TS12) - five new payment extensions covering merchant authorisation, issuer authorisation, account access, data confirmation, and fund confirmation scenarios
- One-click credential issuance - PID and Photo ID credential extensions enable instant issuance from dashboard without manual configuration
- Sandbox Organisations - organisations can now define custom ecosystems during development and external demonstrations
- European Business Wallet Owner ID (EBWOID) - renamed from Legal Person Identification Data (LPID) to align with the upcoming European Business Wallet regulation
- DCQL (Digital Credential Query Language) support for granular multi-credential queries
- Document Signing extension for qualified electronic signatures via EUDI Wallet
- Dashboard improvements - restructured navigation with cleaner URL hierarchy, credential branding reset, and backend query optimisations for improved stability with large credential histories

### Data Wallet
- Payment security - checkout transactions now meet the EU's latest specifications (Technical Specification 12) for tamper-proof transactions aligned with Strong Customer Authentication under PSD2
- Android card stack - card stack animation brought to Android, matching iOS experience with fluid credential browsing
- Performance and stability enhancements for faster, more reliable credential management and sharing

## February 2026 (2026.02.x)

### Organisation Wallet Suite
- Passwordless login with EUDI Wallet - administrators can sign in by scanning QR codes with their EUDI Wallet, plus role-based access control and self-service password recovery
- Sandbox sub-tenant enhancements - test environments now support extensions and custom configurations to replicate production setups
- Wallet Unit Attestation (WUA) lifecycle improvements - automatic 24-hour refresh cycles with configurable validity periods and direct dashboard management controls
- Dashboard redesign - modernised interface with improved modals, responsive layouts, visual credential issuance lifecycle views, and expanded verification history with detailed status indicators

### Data Wallet
- Advanced filtering for verifiable presentations - verifiers can request specific data values within credentials for more precise control over information sharing
- Dynamic add cards screen - streamlined interface that updates in real time to show relevant cards without requiring manual app store updates

## January 2026 (2026.01.x)

### Organisation Wallet Suite
- Sandbox sub-tenants with dedicated issuer and verifier environments, separate API keys, webhooks, and extensions
- Platform performance optimisations, stability improvements, and general fixes across workflows

### Data Wallet
- View, track, refresh, or cancel pending credential requests within the app
- Transaction logs now display exact timestamps instead of relative time indicators
- Credential presentations now support multiple encryption schemes including A128GCM, A256GCM, and A128CBC-HS256


---

# Q2 2026 (April - June)
Source: https://docs.igrant.io/docs/changelog/2026-q2/

---
id: changelog-2026-q2
title: Q2 2026 (April - June)
description: Product updates for the Organisation Wallet Suite and Data Wallet in Q2 2026.
hide_title: false
sidebar_label: Q2 2026 (Apr - Jun)
keywords: [changelog, release notes, Organisation Wallet Suite, Data Wallet, iGrant.io, Q2 2026]
slug: /changelog/2026-q2/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


## June 2026 (2026.06.x)

### Organisation Wallet Suite
- Verification standard update - verification for the W3C Digital Credentials API and ISO/IEC 18013-7 Annex C is now more closely aligned with the interoperable browser-based flow
- Trust-list decisions for IACA certificates - during Annex C and DC API verification, issuer trust is checked against the configured trust list using the issuer certificate or IACA
- Stronger SSRF protection - protection against server-side request forgery is enabled by default, with internal service-to-service calls unaffected
- Simpler Presentation Definition configuration - a new "Login and Risk-based Authentication (non-TS12)" transaction-data template can be attached to any verification without duplication
- Verifier-side WUA removed - the enforce-WUA option and the "Partial" status are removed from verification history, while issuer-side and holder-side WUAs are unchanged
- Clearer verification results and operations - failed checks identify the missing requested claims rather than a single generic message, and runtime logs produce clean, single-line entries for tools such as Grafana and Loki
- More accurate credential issuance - issued credentials and previews align more closely with the expected SD-JWT VC and ISO/IEC 18013-5 mdoc formats

### Data Wallet
- mdoc presentation over DC API matures - the wallet can now share mobile documents (mdoc) through browser-based API flows on both platforms
- DCQL presentation requests - the wallet understands DCQL verification requests, giving verifiers an OpenID4VP-aligned way to request data through QR codes, deep links, and existing flows
- Array-based selective disclosure for SD-JWT - the wallet resolves selectively disclosable list elements when displaying, presenting, and verifying SD-JWT credentials, with indexed array elements ordered correctly on iOS
- Native UI refresh across both platforms - core screens rebuilt with SwiftUI on iOS and Jetpack Compose on Android for a cleaner, faster codebase
- Performance improvements and optimisations - on Android, large credentials load after a backup restore and revocation and expiry checks use streamed parsing; on iOS, removing an account fully wipes the database and its sidecar files
- Faster trust checks and issuer discovery - trust lists are prefetched and cached at launch, with a 30-minute cache refreshed when the app returns to the foreground
- Payment and visual polish - on Android, scheduled payments support one-off, future-dated account payments; on iOS, payment authorisation falls back to the Wallet Unit Attestation key when a payment credential's key ID is empty

## May 2026 (2026.05.x)

### Organisation Wallet Suite
- ISO 18013-7 Annex C device request over the DC API - securely define and share credentials on the same device or across devices, with signed and unsigned requests supported in iOS and Android browsers
- Passwordless login extension with optional callback URI - tenants running an Identity Provider such as Keycloak can map an EUDI Wallet presentation to an existing user account using native identity matching, without a bespoke resolution endpoint
- Claim validation at issuance - credential claims are validated against the credential definition when an offer is created, with a small set of standard claims such as jti permitted as issuer overrides
- Age Verification extension - a template covering the claims and structure set out in the Blueprint, so relying parties can issue and verify age-verification credentials
- Inspect SD-JWT, JWT, and CBOR in the dashboard - click any record to decode the raw token or mdoc bytes in place, with header, payload, and disclosures laid out side by side with the wire form
- Developer API keys - organisation administrators can generate an API key and distribute it via email to multiple developers in the same workflow

### Data Wallet
- ISO 18013-7 Annex C device request over the DC API - the wallet can be selected directly from the browser's wallet picker on iOS or Android to present mobile documents (mdoc), covering same-device and cross-device verification flows
- Legacy Hyperledger Indy database removed - a leaner app on iOS and Android with faster load times across common flows, and credentials encrypted at rest under a single, well-maintained storage layer
- Per-credential key binding for OpenID4VCI compliance - the wallet can independently prove possession of each credential
- Demonstrating Proof of Possession (DPoP) for token and credential requests - when the issuer's metadata advertises DPoP, the wallet binds both the access token and credential request to its private key, protecting against token replay by another party
- Multi-credential and credential-set verification over the DC API - more reliable cross-device verification against verifiers that exercise the full breadth of the W3C Digital Credentials API specification
- Issuer JWKS with multiple signing keys - issuers that rotate signing keys or run more than one active key are now handled end-to-end
- Backup reliability on Android - backups to Google Drive and DataPod are confirmed only after the file has uploaded successfully
- Stability and polish - small visual consistency improvements on the home, connection, and credential card screens, with issuer-supplied background_image artwork honoured in connection metadata on both platforms

## April 2026 (2026.04.x)

### Organisation Wallet Suite
- In-dashboard documentation search - search docs, APIs, and guides directly within the dashboard, with grouped results, filters, and relevance ranking
- End-to-end Certificate Signing Requests (CSR) - generate, download, and submit CSRs; issued certificate chains within the Organisation Wallet bind keys and use them as X.509 certificates in flows
- Templates for age verification and mobile driving license (mDL) - new templates aligned with the EU Digital Identity rulebooks reduce manual setup for common credential and verification use cases

### Data Wallet
- Device-bound presentation for mdoc credentials - device-bound signatures with multi-document support in the EUDI Wallet, aligned with ISO/IEC 18013-5 and OpenID4VP
- Passwordless login with any credential - authenticate using any wallet-held credential (ID, licence, account), removing the need for passwords
- Stronger payment security (TS12 alignment) - Strong Customer Authentication (SCA) flows now meet TS12 requirements for EUDI wallet-based payments in Europe
- Performance improvements - general speed, stability, and reliability enhancements


---

# Q3 2026 (July - September)
Source: https://docs.igrant.io/docs/changelog/2026-q3/

---
id: changelog-2026-q3
title: Q3 2026 (July - September)
description: Product updates for the Organisation Wallet Suite and Data Wallet in Q3 2026.
hide_title: false
sidebar_label: Q3 2026 (Jul - Sep)
keywords: [changelog, release notes, Organisation Wallet Suite, Data Wallet, iGrant.io, Q3 2026]
slug: /changelog/2026-q3/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


## September 2026 (2026.09.x)

### Organisation Wallet Suite
- Batch credential issuance - issuers can issue multiple single-use credential copies in one OpenID4VCI 1.0 request, each bound to a separate key to reduce linkability across presentations
- Configurable key attestation requirements - issuers can now request proof that the wallet's cryptographic key is trustworthy, with that proof freshly generated for it, aligned with OpenID4VCI 1.0 and EUDI ARF TS3 v1.5
- Batch issuance of Wallet Instance Attestations - the Wallet Provider backend can now issue a batch of Wallet Instance Attestations, as per OpenID4VCI 1.0, each bound to its own key, and it reissues the next batch before the last copy is used
- Configurable status-list signing keys and CWT support - mdoc status lists support CWT or JWT responses through content negotiation, with configurable signing keys per credential configuration
- OpenID conformance and HAIP 1.0 alignment - supported OpenID4VCI 1.0 and OpenID4VP 1.0 certification profiles are continuously tested against the HAIP 1.0 final test plans, with public conformance results available
- Clearer verification results - shared checks across DCQL, Presentation Exchange, and the Digital Credentials API report all detected credential issues, with detailed failure reasons and a dashboard checklist

### Data Wallet
- Single-use credential copies - iOS and Android use a fresh copy for each presentation to reduce linkability, with the remaining copies shown on each card
- More precise selective disclosure - Android shares only the requested claims, including nested fields, and applies disclosure requirements separately to each credential in a multi-credential request
- A simpler consent screen - on iOS and Android the sharing screen has been redesigned so the user only needs to tap when there is a real choice to make
- Issuance and presentation alignment - iOS and Android updates cover OpenID4VCI 1.0, DCQL for SD-JWT VC and mdoc, and EUDI ARF TS3, including device-binding proofs and user-confirmation details
- Credentials that renew themselves - on iOS and Android, when a credential expires the wallet automatically refreshes it and notifies the issuer, so cards stay valid with less effort
- More reliable and easier to trust - on iOS and Android, clearer information about who is asking for data, even when a service does not name itself

## August 2026 (2026.08.x)

### Organisation Wallet Suite
- Issuer-controlled Key Attestation and TS3 Wallet Unit Attestation - with a credential definition, an issuer can now require Key Attestation and specify the exact assurance level for key storage and user authentication, in line with ISO/IEC 18045:2022
- Wallet Provider backend - TS3 wallet unit attestation and an evidence-based Key Attestation issuance model as per the EUDI ARF TS3 v1.5 data model, pairing a Wallet Instance Attestation with a Key Attestation
- Selective disclosure for nested objects and array elements - when a credential definition marks both a parent object and its fields as selectively disclosable, the issued credential carries recursive disclosures as per SD-JWT (RFC 9901)
- Structured validity for Legal Person Identification Data - LPID attestations now return a structured validity result on credential and verification reads
- Purpose-built attestation for Age Verification - the Age Verification extension requests the purpose-built age-verification attestation by default, a data-minimising choice expressed in Digital Credentials Query Language (DCQL) as per OpenID4VP 1.0
- Live status tracking and platform maintenance - live status tracking in issuance and verification history is more reliable, newly created signing keys are ordered correctly, and the platform's dependencies and packaging have been modernised

### Data Wallet
- Hardware-backed wallet and key attestation - the wallet now presents a Wallet Unit Attestation (WUA) together with a wallet-provider-signed Key Attestation, as per EUDI ARF TS3 v1.5
- TS3 WUA data model - the Data Wallet and its OpenID4VC SDK now model the WUA to the EUDI ARF TS3 v1.5 data model, pairing a Wallet Instance Attestation (WIA) with a Key Attestation
- Trust and origin checks on the DC API - requests must be signed, and the verifier must be verified against the OWS trust list before credential sharing
- Native user-interface migration - a single native toolkit on each platform, Jetpack Compose on Android and SwiftUI on iOS, with the issuance, verification, payment, and settings screens migrated
- Strong Customer Authentication for IBAN account payments - Strong Customer Authentication (SCA) now recognises the Strong User Authentication (SUA) IBAN account-payment credential under EUDI ARF TS12, and on iOS the payment confirmation screen shows a recurring payment schedule and covers account payment, e-mandate, and Qualified Electronic Signature Access Credential (QESAC) flows
- More robust proof-of-possession - proof-of-possession now holds across deferred issuance, concurrent flows, and app restarts, following DPoP (RFC 9449)
- Browser-based authorisation - RFC 8252 OAuth 2.0 support for smoother sign-in, more reliable multi-credential issuance, and consistent trust indicators from the first passwordless login
- Data Agreement Policy for all verifications - Data Agreement Policy details are also available for ordinary, non-TS12 verification transactions on iOS and Android, so users can see the data agreement and its policy for any verification

## July 2026 (2026.07.x)

### Organisation Wallet Suite
- Qualified electronic signing through the CSC v2.2.0 API - qualified and remote signing through Qualified Trust Service Providers now works with either CSC 1.0.4.0 or 2.2.0.0, selected per organisation in the QTSP secure vault
- Trusted-list validation aligned with ETSI TS 119 602 - validation now runs against a remote lookup service instead of parsing trusted-list files within the verifier
- Direct identity matching for Passwordless Login - operators can now choose an identity-resolution method in the dashboard, resolve the subject directly from a presented credential, and select a claim
- Consistent transaction data handling - a schema-driven form now validates TS12 Strong Customer Authentication data for payments, e-mandates, and qualified electronic signatures in the dynamic credential request flow, and non-TS12 Passwordless Login transaction data is now accepted during issuance
- Annex C and Digital Credentials API refinements - sandbox organisations can now attach the reader certificate chain when signing Annex C of ISO 18013-7 (ReaderAuth)
- Privacy-by-design guidance for verifiers - the Age Verification extension now warns when the holder's exact date of birth is exposed and recommends selective disclosure in line with the GDPR data-minimisation principle
- Verification and issuance correctness - SD-JWT PID array claims, including nationalities, now display correctly; verification QR codes and deep links preserve characters such as `&`, `<`, and `>`; and deferred Pre-Authorised credentials can be issued

### Data Wallet
- Trusted-list validation aligned with ETSI - the wallet can now run checks against a remote lookup service and evaluate the certificate chain against the ETSI TS 119 602 and ETSI TS 119 612 trusted lists
- Trust checks gate issuance and verification - trust checks complete before the exchange screen appears on both iOS and Android
- Capability, standing, and credential scope evaluation - each party is evaluated for its specific role, its current standing based on trust lists, and, where permitted, the exact credential type in play, matched by standards
- Native UI on modern native stacks - SwiftUI runs on a single, consistent, more maintainable UI foundation across platforms
- Sturdier handling of ISO 18013-5 mdoc credentials - CBOR and COSE checks cleanly reject broken credentials rather than bringing the wallet down
- Simpler, more compatible OpenID4VCI issuance - the redundant client assertion has been removed from the token request on iOS and Android; Android retains wallet-attestation client authentication, and batch issuance now resolves cryptographic binding methods
- Payments and strong customer authentication metadata - EWC TS12 transaction data is now correctly added when a payment or login is confirmed via the Digital Credentials API path
- Backup, restore, and everyday stability - on iOS, the last-backup date reads synchronously and DataPods retain the correct pod credentials through re-authentication; on Android, the restore progress indicator no longer freezes because restore work is now tied to the screen's lifecycle


---

# Get consent record
Source: https://docs.igrant.io/docs/consent-management-admin-api/audit-consent-record-read

---
id: audit-consent-record-read
title: "Get consent record"
description: "This endpoint is used to get a single consent record by ID in an organisation defined in the consent building block."
sidebar_label: "Get consent record"
hide_title: true
hide_table_of_contents: true
api: eJzdWF9v2zgS/yoDvlwCyHLq/rs1FnuXNr2u0UW3l6T30g3QsTiSuJFIlaSc+AK/3Se5j3af5DCkLNmys0ifDrg8OILIGc78ZuY3Qz0ISS6zqvHKaDEX16VyQFo2RmkPykHrSII3UJAHBKd0URFkRjvSHixlxkpYrmFxAUoDajC2QK0csj6QlCtNkpd8OYgtW1VJpQtYVia7TUUiTEM2iCykmAtspfJv4+bLcMQloRSJaNBiTZ6sE/MvDyPTP2v1rSW2xOTBkuXvlHmRCMWrDfpSJEJjTWIusl3lC1Zt6VurLEkx97alRLispBrF/EH4dcMizlulC7HZ3PBm17AGx+uzszP+lxntSXt+xKapVBb8mf7u2LiHHX2NZW+9itJ7luwc11vvla/4xR4eIhk5fz6OCd03lpwj1y+coNsPiHKjSPzJgWsoU3ln/CkHvg/6BXo8LyxRTdqncF2SJahb52FJgPD54+Lvn9+F07xFzh6j4USiR8CtFFhaKaeMTkBpqVZKtlidikTcT7TxE6UnvH+JjsQ8x8rRbly+CMV+98ouO10/o+PIOo+exE0ywlfJwxgmIje2Ri/mQiSC7rFuAsSvXr54/Ww2m9Gfs9fZ8+XyeTbLfvjh7NkB2r+G4Diocc3ON+i4SpaY3XItOFMTnH9a9HXk4E750rSe03JxASefPpwmIEkbz9j7Ej3XxxrQMpK/CWkx97+JBFRKKSDsxT7uVw608bAmD84bOxTZFkFALcHoag10r5wPyxa1Uz6FC9a/r9WBNEFjiSs24rKP1LL1oHJokMMAbROcAYQrVWj0raUEEFZYKdkLgStNW0nGpiDNpU0yFZtEyN0cWhwNzf0kv53URlIl5mIv5w7CcF2OspLz9a5UWdknfYkOlkQaCrUifWDC1uAnmLLdetSK3nGT90HYSfs/sgm8edSskNpPTl98tpxlz+ULepm/StP0wNC3pllvDdwWIhtThmIOT5xWvKx0VrVySCq3jXXIKtKuteQAC1TaefBYN8SmxdRgAWNVoTRWAwgh/kPVPwHxRb/5KObDMtyVJqDKZnK7Ymrb50M+3DR+oXdOXRpTEerH8Ix9YHSubWke0Bo8CSc3ximvVlStwTQ+AJfC35jCjm6ne+4QyldrcKgkaAMnxgb4pMU7DQgNh8i0vSOnAcDIck9OiQjIUfiCJsgVVXK3z3ftI65mJeqCA517shNf0iTHzKewCPxTM8tj6CfLdYh6xyjw5g0o76jKU/hHIIagzs2h1dGiaUM69J3a2J3sctPeYNJtzZy/lWCGjw83m/gYJJ6QRj1PHWmaQ14HUuUSYHerKrizwqolty2ZUYPlQtjJOeWH5L+lvs4WeqWkarFKoMZb9lh5WJFVucJlFcspls+kscbkKVy/uZjDJVVxggoNuPcA4hTxl5AJlHljP1nKyZLOYrfrgEBrcc2Tj6faHRsq9nHomj7F2m+CSub6eARI8qgq9+Q2HcVEIioT54jDrtxteXIeH5j8EWvaYtwp+8MK35e+CGOQ2zqoXF+0YCx3wcBV7hd0/nMjuXt9h9JRnuTGRkIaDqvQeWg7xZv4l4xiFF6N+ftA8ajPnHBMuOvD4upXmL1++ersFCx5q2jF8WyzjJzL26ri7CgJZRilH/isF3GM3T9yiQxK03roR+8jgs++a/7dTRWy1ti3RnJthueLneNvxpiMs2iQHqKjtKciWNlnz4uzs80R9UeSb0i4N0cc7+I0vnVg60tj1T8DR+1D8/I7rwb/X9AstCfLM4AjuyIL4ZgRRpHIWqv8Olzpzhv1gfjxhu9ZHgu+6YlzvhCy0zX50vAVsaDgM1/q5mIaLozTrvAmsT6mD6NL3oZbSLDk2O3xgmrTGSoS0VruHKX3jZtPp5JqM8FGpaqwqH2qzHQ1E5tkrOPKY8EU/4gaF5ePaLoZULjiZIgx3GIx0Hp80d1oI4zDnfa8y8NIuQe97tMi9CXOVtK+y8E4+YU+t2XTr3t6vkI8pr/ocXdQ9yRjt/sabYSvcKKNp6CAb39VgKHBjE4ToLRIR2rn0An+uDatZUQmt7T+6WsqNmFKzM22bjALdUM1KsbStU1jrP9rj9/gv3o/vNoHfth8kKO9EJz851//PmV2Rri6I6lcGdmV7uMUFFp17NwRuxBmlTEkZqUk2TAXtS70lSqfOLMiS6rQoCQj7tfJbufPLIXXWDm+QElVKM+jLFYVf2rREpzh0akxEjxlpTaVKRS5BEjjMgCMoOkOKlpRxdHj+g4kgEtVKb8OSrD1psZwz8xM3VQKdUYxeME9S0UbZw0XvuBA6A4QKirYWaPWZPk2UamMtAuMsk25BrOSYJaeHWB+d3eXYlhOjS2mnayb/rJ4++7j1bsJy2yGrxtDHDhRpclabmjbVOaajfGanc1epM/TZyzbGOdr1Dv2vCc/nvtHAd8h4//Vt66umD3d+2lToQq30gDeQ0doX+IXMJGIfUoTiZiPv1zdJKI0zrPQwwO3/8+22mz49beWbGDSRKzQhqSLvKccP8t+dnsUoJPLrh+dwqMf1456s+UrzWQV2CXOcLdMZwcf3zY80XdsxgbGXedZRo3fkT9onZvdhvD+3TV/HGp9uU+Yt4EwuwfWftS2MXdGE/iXWf6oyI+cqB9o/VO/Pa48KtDzddzNSN1sNpv/AqXHgMY=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Get consent record</h1>

<MethodEndpoint method={"get"} path={"/audit/consent-record/{consentRecordId}"}></MethodEndpoint>



This endpoint is used to get a single consent record by ID in an organisation defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"consentRecordId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent record for data agreement (based on ISO 27560) retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecord\": {\n    \"id\": \"65471222e8c7c3bb3c2c9901\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n    \"individualId\": \"string\",\n    \"optIn\": true,\n    \"state\": \"signed\",\n    \"signatureId\": \"string\",\n    \"sectorPreferences\": [\n      {\n        \"sector\": \"\",\n        \"optIn\": true,\n        \"isLastUpdated\": true\n      }\n    ]\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Fetch all data agreements
Source: https://docs.igrant.io/docs/consent-management-admin-api/audit-data-agreement-list

---
id: audit-data-agreement-list
title: "Fetch all data agreements"
description: "This endpoint is used to fetch all data agreements defined in the consent building block."
sidebar_label: "Fetch all data agreements"
hide_title: true
hide_table_of_contents: true
api: eJztO11zFDmSfyWjXjAb5fIHGGY6NjauwcA0w0CfbYa4wQSoq7K6NVZJtZLK7V5Hv90vuZ92v+QiJdVXd9nYwLxs3D7Mmi4pM5XK70xdRxmaVPPSciWjUXS24AZQZqXi0gI3UBnMwCrI0aYLYEJAxiwDNteIBUprIMOcS8yAS7ALhFRJg9LCrOIi43IOM6HSiySKI1WiZoRnkkWjiFUZt8fMsnEN6g03NoqjkmlWoEVtotHH6w363lbFDDWoHDSmSmeGaDMXvIRcaSjZnEuHIoExSJwzyy8RlIZKamQZmwmESyYqhJwJYWDG0guC8GX/C1HICcU/K9SrKI4kKzAaRSrPDRJdGv9ZcY1ZNMqZMBhHJl1gwaLRdWRXJS3l0uIcdRRHGeasEjYa7cdRwSUvqiIa7a/X8XUNVvCC202U/bP+xq5oI8ihM2u0lZZQojs1Jt9K4IGnqo95LEHN/sTUwpLbBUyOQeMlN/7qhtnUW/B1SozVXM6j9foTrTYlCY2h74f7+/R/qZIWpaU/WVkKnrpb3fvTEH3XHXilJrGy3O/OuvLkfuEWC9NB7M8VxZHlVtAPPRHcuoOxbEWdRNsyLo2Tc1NiyvNAGF0OA8PlXCCUlS6VQbALZiFlEmaNVjhdSgDG0EPrFE3yS9SGCWAyG9oGsxX8rWBy9TfgMuOXPKuYIFq0quYLYH2QJ05UknMZxdHVrlR2l8tdYs+MGWzupb2oj1EgmzTQ/3Xc4UTsbkQrIVC/16L377ckAXFUKsFTkgjBlnklnjHDTRRHBdqFyt7l7x1olpJGRnGUKz1Ha0kjaQvPMV2lAqNP8caV8mxbbNz2gtloFEVxhFesKN1dPjl6/PTg8PAQf0qfpo9ms0fpYfrT458Pt641WscRcZt7cbob9INkP9nfAnW2QAigSAosGdC+bFgFywUn60kKjLx0kkQ4DNHRMnIyeNQ+usmxx+JkI+zrQ6Hr+SqY9ydvCI6z5e1W2CnYiuROFdyS1PEcpPKruLxU4hKzh31s7vK/io5WfQ++IFujTUM1db9DJTPUgcnuAvraZRbkt2YIc3WJWmKWAHxYoIRUI7Pko9iGV4sdhwWzaCx45LVKNg6RC+FWBVPq/UoMTn2VnjPJjb9/lhVcuu0ZpjxD2p0umJwjcFu7zT5+EHiJwmvvTYZrWuvb3dRbei2ttPjxOvb06f7BoI7JG6RjGPRx4KTjRWNOhiWJeBaW/Dhd/r2rxzV82OHejOdKCLX0xh+LS9TgYTsJrYa1bhj7wtrSjPb2wi9Jqoq9UvNLlq52bzj3FHXBJIkGqS6zXWm/RL3q2yCEaU9oKfiJwSxUJTKQytJvjE7jZTlII2kHWF4gHejPSnOT8dTei68v3m9R/roLaE3RQ1YZq1enmFql7w76F2TCLlKmcdsoBpBgPMx17CKBE6QYgis5Rc1VdsxWZjAYGsT36MnRJhqyKhR4eaAUe3Hl4t6MIK/jaI5qrlm54OkJ0mm+n3mvGoigOyDXcWSs0myOb5T3Mt+F5dTDAlEDW8eRXXCdTZm2Kzr26YI5oC2WmVICmbwJjdUVbrtKrjMoCabXcROgrtfhxsbWaj6rLHYvimnNSCGaUI4J8S53ycGmbRy4L9aArOO3vns2pDF4xVIrVrCkkI3TSiEwtZgl97WvXQp+fCxzNGBn+6eEyfH9De/bbdr7lrYBH7s8i0tjmUwRzh2i84hSrPOIzfHcmf0eoLsS8bISAmQHaRvlbp+5/dcWiU45UBpu+SW3q7uLbLjUDdVoITUBTA9VyizOlV7d/aBT1EbJgVM9D6CGEZlUlfe4UzL524pOMKAWW3eXm4hcOripV30x7liiW/X0du2kdN8ntR1ot2lbn4hUY3aM+XDMfIMHeXT84eC39x/+WD27mB69efVYn/3XyS+jR6Pnb0Y/7Y/qnHjrWjRmZPKZ8LUO7sTO65lPRH8AEYej53Q2Z5UQ3uVwgnNurC+YjJ4MhiunDrmjxP3v06bq/RALeO7cQZ0d3jnUrzesB/PJr4LZ0PAOtG56eWeub0ufgwIzAtOYkCb83m3KWHsgcM7EZzUTfO7j+T2fwbCUvl5yy8RniiVIjmEPymomePrZMnPhN3PLC2axWUN0SaoHfYwCEkqAN5DUCTZzitNH4jL0BonfvIWEZKGben87p35zUIhHlUHYBUl2es/Zjc9GVTrF+l8VFUA+G9SXPMX2mLTBu/ewPgr/6q930ltydszs95B75pMpBCWbGBnheDoZg8ZSaSfdc5RUi8QMWG5RU/FkOhlHgYLTqiiYXt0pkSZ0708ElFpdclfv7KAzlM14rCYG48EC2rRXG7pEzXOOGRV4mFxBfYfoYyWyd2Rp+FwyW2nHm6vd/GK3UBkKMgPNly0DUX9x9anKLpTmxPMQg6l8I1HeaTYYCJl5umC96i4zDlhRCctLgdCQZR7emq12ibxjPYqthHI+zHT2emZ5w+Ulc+PHabNt4NdfmFlsfCHCMHu2crQWaCwryh8fuR0NRW7vHJMaVpfMUG3B1aRnKzCqQBhPJ0053rhqrKosMAk8g53prw9jyFAq6+WOWbqjFTCNwOA8yjTL7XkUA08wAQatONhg5SkVXKEFSibaS66vxZcypFgBXnFjjfuuGQVEibPrgdV35sx1kiTrQRXKuWQCAsCGPOPuJnbG2OoqdQprgMHr03dvwaDmTNRVFpVDzlFkBq4HLn4ESZLEcINIDHz1sjXwYUxemqV24FMtSgOfXi/NL8gy1DE0UhaW+UN+8FfrReIEc9QoUwxLvDadrcr+D/1l6wROA0d6bKLUO4GJd3GNKvWt4AxzRUIjV3ZBskS8HxaJHZKJhYPuxM9SHY1WbJBUFxs6xb1cq8LXVcI1zyrrymgejbPES6Yzk2zZu7uJF65eL2avUv6Ov375x4uTs/88ff1zkiS3m8WamAUzC1/288DroKDlWHuiED55k43cLlAPCA8lRYMyECpWm3bs7hl8dnh0dPBzc4zD/cPt4HAMSxRi90KqpQQPsLUV3jH6+KDu8iXwOxM883VMM4KzZ8cJuH5gwecLVzLCq5LJDDPfFjJVSZ4Ns94pA1RDe1FjbdwYuD4YE2DQ8bbdHTaAxBSNYXqVbDJo+mMMzYQcq2RCrDqib1qd2SihZb7cEwTa3XWriN42bsj8rpOHKxe2ubKybOGH0IDXGZdx2nnDSZ2fuvNp2cHsMH2UPcaj/MmQvA+eO9Wr0jbFJZL++ty+QUoNJ2wssPMg7UeVD5nSzcPUpvI7orlxX7ZYgFibJYISem8pkxSn+CuJgRdsjnFHe9Gmm/Q1rv/O9GU8G13gavSvJ79d5EOsfoYpq5znBO6SxpyjfkCe0wN0CsJWWxVXZ3m8VWYg0ZdlnQkOzrCz37t5t80pEp9LLucJTPohGtu44oYVsa8aO29ZG7UmMaSgo6XcVQiEUhckvVXZWLRVHej6RAQucNW1l02IOUCUVHL3LoSlPboYuCVMdKpCD4wrF5mYKrGuohJa5TFgwbgAlmUajUEDu4GXDIxkpVko69k649K30/uW/gdxOJg+6+ObOepS01TFVnnrgenxkepr/iIIkYmBgVUXKFsHWhknVJNjMGjIZG1ZTC/a43tkyLdV207GL8/g5eTFm+MRnAbf57vgGoWvISx4CTO0SwzhQDfb6DBWZuHsHlUnQ6v9cKpkilqa4Hu4IRx4yaR1wvg85OW+v20SmCpjeDPXYUZw3jnKeQR7FAgj5dcWz6MtRrVO+TuMlHD21c2aBFnadu/9eJAMvOPG5qUF+ZkTLAavP5x2HVQYytg5efn86dHBkWs8tUnLnQ9wuH/4eHf/YPfg6Oxgf/Rof7S//8d2VF7DrTUgUJZWWqOkUlFHWbmRD6xT+aZ3Fq7TKOD2gc80CBrq3VIrldch3k2R73eWbScyc5U04/V801EvmQGBuYWZYPKi9iYDoYDbTas9rUR1GwPcpxjrp2NuLbL7WiK4tH6Y7JAG0gjJ7420N3dTl+FrZOdRp9TUoaCNrD81xxni+zekuU+eDKS5YzCrokAq8jb2AvZ8ntuEV7XidCKsDd4n8AFdattK4J+VsZ5forYzPuxSLiRv7c4O84WMh8ShZhmcBKbAjrdDoSDDmnGnYOWDzfHjVzE5986kQOgSo00fJr6TFYZc7izB2xZlazrIg3QWQ+JyaNTHNDNDNNTgRbU7ZPOjqPHYat9GlpWiyaUbpwh84r5SkWm2lDFFutwaX0JwNx3qDk247+y6GwdkMy649fF/qoqSWbLsZCBCZ/7rhfZeZez22a4Pk+nIO5lgxPo2w9XO20uouVw7daqD5Kh1m9hyA9BSDSUJkapMT5icnpPO90jzJfZ2COqrVUdH+nOvB/Cm3gfGusKnR9PDkMDmMuN0qZ5mKZikBjAPmQIslb7IhVoaJ3KbkwPGaySNQTBpeQoFMlIp46/Sy+ow//xMS22VXIUq8pdNguSLwMyy9xQ4nPrK8C09pru1gCsfhXho/dkcond7/Oa+Td8wdhBHTQN9q4B4v4bsrX4iu/1Mvv95v9mKgfYLDfWaMFBRY95EI+49fHAjohrUTajCeMwxM4uZYjq7oTh/T6wBKmQ1WKi0GCbBt9dUiXJc8tNu/+zrrc6zbloTZkjfEaTpZGNWMFNp5dTFA5jVedZ4OnnQDmab2Hs9yg2oDFEPVvvKGcnHqWu0fLfmhP7Ov4fKDBzm/3XlL9MVCoR6oucaBvV8/m0T2dN21VbT37u8KZt3JaM71t5r3AcHSQPyoTTQPeoBUagsE5ONgYWb4J3R4s44vlMlYJeMizDH3MA+PKqBE63fApyIpgcKLu+TUL8XaOfTXMRAP34d9tsNkutXAz1u7K/jaMHMNIQtgwHjTUkWz3396gGVr5rAZxOFswYey1u8st+OQeKV3YJOE2frrtgFwfLDZQNjEe0Tlp2GzZPTd3D49OjJ/kMQ3LVgTZVSnJpXQpD5XLhiAXGHwD72rxX60GeMYsmycgmxf8oysPHgXs8cuhYUtVb6ucrc6env7mDFp+0WbF+F2t1DctNw8/E+ycMW+AEz0pqOZwMHX68H+P9ehvLQvzDbYs3RPV+A/Huxpq7Vu9AONTg0GzzyTqvSbrrt43U0LvmvSH9+ouc0ls3Jv0djyqjo0EVoL0Vz9O+r7CIaRXsu49ojz7jbqoLzzIR46PHVMRYq0BUmydtR5gwLtctKnvC5ZtImXO1dHkbbT4tOLVn3+U1gjP88AOlTe2g39+SvrD56G+b4H8IjJc+19pXSOIhd7V02ChXTiavAknBSBTwNT8nOun0P8nZfenC+gEcDBZUjZi7zy/lV3Sb74mmEL7AjlfXlYKsZ9yWLkqX4MAZM5skG2BGEjX9fqUoTR3YvcPWPL1RkoOPlqlaT0GJxRW8SP99Z+4+Gf+35+av2pz7j28VbItlsgp3//e//eeh7FKdLzLhZ+MgKr0I/Y7Oi2SQofjwGdQITS0knRUsi3zXUAEE+r7sldlWXSd1TvbSZvHNV8IzPaRAKlkwItL67pqhlWaoMLKYLqYSacyqZo2Qz4Ys8VC9xzymc/yP1cvGyLzU4IKyyqvAPQVwiyt1sq7u80AOcV6HM7RrV4JxBXbIQ1OOUEnXiHjKlKP24VS1yJUsXCIdufq/P8+VymTD3OVF6vhf2mr03k+cv3p6+2KU96zYuau+BBLXOFGpRbp5AuPJu8ig58A9njC2Y7NDz8qaHnJvq0DHBf+mz0KC4Fq/sXikYl53nFN5WffSPRcPYWNdafYqjhTKWllxfkxN/r8V6TT/754nOhnFDl5QNV4q7p/xrH5cOnvOCjFf7xtRt929n7kP4fV+K3kJKHWd+IyVfeTl6C+Leuhb7J/qH5r6E+ZFS8GDT6Wr9znGaYtmleSteWHe94KsXZ/QQsbKLvtu4cG4j/NHJj5lcdWBvehBPAv23Mzfd3/J3UtdfcfWPZrn/cuOGxmv51cQlyqf+D+BoeK4=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Fetch all data agreements</h1>

<MethodEndpoint method={"get"} path={"/audit/data-agreements"}></MethodEndpoint>



This endpoint is used to fetch all data agreements defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreements (based on ISO 27560) listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreements\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c8492\",\n      \"version\": \"1.0.0\",\n      \"controllerId\": \"string\",\n      \"controllerUrl\": \"string\",\n      \"controllerName\": \"string\",\n      \"policy\": {\n        \"id\": \"65471222e8c7c3bb3c2c7701\",\n        \"name\": \"Default data policy\",\n        \"version\": \"1.0.0\",\n        \"url\": \"https://example.com/privacy-policy\",\n        \"jurisdiction\": \"EU\",\n        \"industrySector\": \"Healthcare\",\n        \"dataRetentionPeriodDays\": 365,\n        \"geographicRestriction\": \"EU\",\n        \"storageLocation\": \"EU\",\n        \"thirdPartyDataSharing\": true\n      },\n      \"dataAttributes\": [\n        {\n          \"id\": \"65471222e8c7c3bb3c2c8501\",\n          \"name\": \"Name\",\n          \"description\": \"Full name of the individual\",\n          \"sensitivity\": false,\n          \"category\": \"Personal\",\n          \"scope\": \"read\",\n          \"restrictions\": [\n            {\n              \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n              \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n            }\n          ]\n        }\n      ],\n      \"purpose\": \"string\",\n      \"purposeDescription\": \"string\",\n      \"lawfulBasis\": \"\",\n      \"methodOfUse\": \"\",\n      \"dpiaDate\": \"\",\n      \"dpiaSummaryUrl\": \"string\",\n      \"signature\": {\n        \"id\": \"65471222e8c7c3bb3c2c5501\",\n        \"payload\": \"{...}\",\n        \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n        \"verificationMethod\": \"Ed25519Signature2020\",\n        \"verificationPayload\": \"{...}\",\n        \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n        \"verificationArtifact\": \"\",\n        \"verificationSignedBy\": \"did:key:z6Mkf...\",\n        \"verificationSignedAs\": \"individual\",\n        \"verificationJwsHeader\": \"\",\n        \"timestamp\": \"2024-01-15T10:30:00Z\",\n        \"signedWithoutObjectReference\": false,\n        \"objectType\": \"revision\",\n        \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n      },\n      \"active\": \"\",\n      \"forgettable\": \"\",\n      \"compatibleWithVersionId\": \"string\",\n      \"lifecycle\": \"draft\",\n      \"dataUsingServices\": [\n        null\n      ],\n      \"openApiSpecification\": {},\n      \"dataSources\": [\n        null\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Fetch all consent records
Source: https://docs.igrant.io/docs/consent-management-admin-api/audit-data-agreement-records-list

---
id: audit-data-agreement-records-list
title: "Fetch all consent records"
description: "This endpoint is used to fetch all consent records with pagination for individuals in an organisation defined in the consent building block."
sidebar_label: "Fetch all consent records"
hide_title: true
hide_table_of_contents: true
api: eJzlWW1z3LYR/is7+BJphnd68Uuam0xa2XLSm7iOGtv54miiPXJ5RAQCDACedNXct/6S/rT+ks4CJI/knRRZ0850Wn+wzwSw7/vsYnEnMnKplZWXRouZ+FBIB6SzykjtQTqoHWXgDeTk0wJQKUiNdqQ9WEqNzRzcSF9AhUupkYlAbixIncmVzGpUDqQG1GDsErV0cUtGudSU8ZIvqKO4qKXKpF7CQpn0eioSYSqy4cg8EzOBdSb9OXo8W1qikrT/McrwVjovElGhxZI8WSdmn+5Gmr2rywVZMHknuDfgrmUVBN7KP4Uz0LREL1cExkKtLWGGC0WwQlUT5KiUgwWm10zh6viKBZXM4rea7FokQmNJYiZMnjtiuSz9VktLmZjlqBwlwqUFlShmd8KvK94qtaclWZGIjHKslRez40SUUsuyLsXseLNJ7lqySpbSj1kOdf0L3vJB0Pt0tuRrq6GioDVNnyrgSZRqyPmjlr/VBPNzZspuX/xK6Y60rSZ4k9fqFTrpxB6ezluplzvKvQ2nYMHHmAtHELYBAZMumo5A0RLVL2ah5DLG3REveospr66kR/ULK2bJ8YeqXiiZ/uLRXcfD0ssSPXV7RCJIsz8+iYaJSMSYiUhEy0QkYsiEY3TLJB7eYXK5x6zz8yA5Su16uQXz8wQy9NjTny1vRzkK8/N7PCCzBwy/Rw5HqTe2tfqDzo1bHyR/yZHnKpbV8frp8TH/w5qybWd3AqtKyTTY9ehXxyLc9ehVlvHBy3i60bmBBP4iPZXhByr1Qx4woRGhk9xLr/jD6/7hnZA7GxuUbitLzpHrFg7QDWFNuhGefeHAVZTKvFHokJMRwUm9VAQDWJvCh4IsQVk7DwsChI/v5n/9+CZw8xYZm42Gg5HvLa2kk0YnvRg5FIm4nWjjJ1JPeP8CHXV5vk38TzEWcIuskdaf0RXsRI+exGUysrnM9uVrbmyJXswEJ8wtllUw8csXz788OT09pT+kX6bPFotn6Wn61VfHJzvW/iE4x0GJa1a+Qsc1KADuYg3OlARnF/OuSsUKZGrPeDM/h4OL7w8TyEgbz7b3BXqO1jWgZUv+LDKLuf9ZJCCnNAWEge/jfulAGw9r8uC8sdtS1VoQUGdgtFoD3Urnw7JF7aSfwjnTH1J1kJlAscAVC/Fj56lF7UHmUCG7AeoqllOE93Kp0deWEkAuPDLrDoErTK0yts2SNBdIyqZik4isH0Pzva65neTXk9JkpMRMDGJuxw0filFUcrzeFDItuqAv0MGCSMNSrkjviNAK/AhR2q17pegUb3BnFPYPyQTe3CtWCO1Hhy+eLE7TZ9lzepG/nE6nO4K+NtW6FbBNRBamCMkcfnFY8bLUqaqzbVC51tchqki72pIDXDLce/BYVsSixdAIwGsltytqa4Tg/23WP8Li827zXptvl+GmMMGqLCY3gwxtQzxk5qbyc93jujBGEer77OltTTt8bU2zYK1ejWPOlXGS+zG1BlP5YLgpfMsQtnc73XLVkF6twaHMQBs4MDaYL7N4owGhYheZulPkMBgwotyjQyIaZK/5AiXIJams30U35SOupgXqJTs692QnvqBJjqmfwjzgT8koj6GeLNbB6w2iwKtXIL0jlU/hpwAMgZybQa2jREcV6VB3SmN70eWOOoHbNqY9wQgff1xu4s9w4hFh1OHUnqK5jesAqpwCrK5SQZ3QTXcd3KjAciL0Yk76bfBfU5dnc72SmaxRJVDiNWssPazIylyGhp2pxPSZVNaYfAofXp3P4EdSsR8MBbjTAGJn8ccQCaF7ubCUkyWdxmrXGAKtRW50uvZi3FSMeqZY9CnmfhVIMtY3vVRGHqVyjy7TXV+lTOwjdqtys+XRcbwj8jssqbVxQ+zBDB+ePg9tkGsV5C69SVpuTbXxAavcW3T+Y5Vx9foMoqM44btbAKQtM4XOQ90Q3oQ/ya6PhhbzsiTHkbKnTR1Vj30OHxJbkQ2l7HdvMj/FjWzpYUljplVtK+P2otF+Z7UHNsngYvX0KPg/uGhtNhsGvEFis+27acA+b7d3hovtrnEIpLW1pP0FLvsO7F+iB61D3B2u482dve+ZE5bQeFTzEeDcR+8Db+5d/gNQAa5QKobFPu3TFy1xlvUpxFloHodwhTMa2ulEx+EZx2P4+Pu0341EbmcUA2scbxJRoLtoKvgjsIN7mZRLJHfanm9WX7h+DzBmEVA3cnlHt/7pHDTd+h3q3PkEUBoFVvg07imHozZGuyFSODjoTD9//wOcfvni5fEhKOkYcV2dpuRcXivFBasgzMJw7I5ZPY+37SHHBTJOVzWL3QzT9hw8+axrer96kbXGvjZZsAj/Pu+xvxybZJxW29P7Yqmz8PNjjpEd8nuQcIt+r/YoHmvHzoQLa18YK/8W2qahaV585gTjf8s0c0ZWvpY4siuyENiMbBR7q9pKvw4DmbNKfk/885LHQR6XPLsVZzzpZaVL8oXh2e+S4oTXF2ImjsIk+KipDZMmPbiJDYz3jX/PqTSNXCIRteXetfC+crOjo4xKM8FKTuXSovZTaY5Wp2J3+vXeM+Iv7yPj4vIeSpdbpd+z76PLWtW3jWX80MzTotW2A7WzJuzaijPqti/moTPm4CTtm5CLd884t24q+NWAzhVENt2oiftTeUtZ7LevooxwBQfaeAoEeP6kghkqTOkwAZoupyOyM2gOfr02tWWLTK5p/c3VlIeKQurctGnC1ZvDt0TJtnR1VRnr/9TZrzer/G77aWj47eadkOwOwcE///6PQ+4PEd7fUCZdEaGUbuM9LFwW4t0h2i64WaZsErOSGdlwM6td6GxVPnFmRZbkUoPM2OJ+nfTvHqml8BmV4xFOJpfcocANKkU+MHOGL2+VycBTWmijzFKSS4A0LoKBuYDcgKIVqVATOb3Ci8hCKunXgQjW3pQYJl2pKSslUacUnRfUs7Ss420nvsRAKAYQEijIWaLWZHmeoWRKOnacbchVmBYEp9PjHZvf3NxMMSxPjV0eNWfd0dv56zfv3r+Z8JnNtlfa+oEDNTNpzdWrDeWuYxanx6fPp8+mJ6ELM86XqHvyfHvfI9Q4HXoQ/N/2pNXkuqdbf1QplGFsFmx718Dbp/jQFfvbAcBdJqIwzvOWuzuu+x+t2mz4cxy+B9iTjv26fcu51zD/2RexvXpeM95tH8bCcb56BKx9tOCf+7z1gChtu/pESe597nqI5eDV64mM/x0PQg/IGN4CnijaPW9ED3DrRhpbjpf8HxuQNPQGbRMRQjyeOktTqvq+22m1Nv0G4rs3H/h9o/bFsOJeh4rb/Og9EaFe92iPi28Ugf/uDReGR75mpPue1t902+PKvQe6gt/4gBXYbDb/AgJRCoY=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Fetch all consent records</h1>

<MethodEndpoint method={"get"} path={"/audit/consent-records"}></MethodEndpoint>



This endpoint is used to fetch all consent records with pagination for individuals in an organisation defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"query","name":"lawfulBasis","schema":{"type":"string","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"ID contains individual ID, data agreement ID or consent record ID","in":"query","name":"id","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"sector of the object","in":"query","name":"sector","schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent records for data agreements (based on ISO 27560) listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"consentRecords"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"items":{"allOf":[{"type":"object","title":"ConsentRecord","description":"A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)","x-not-in-database":false,"required":["id","agreementRevisionHash","state"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."},"dataAgreementId":{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"},"dataAgreementRevisionId":{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"},"dataAgreementRevisionHash":{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."},"individualId":{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"},"optIn":{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."},"state":{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]},"signatureId":{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"},"sectorPreferences":{"type":"array","items":{"type":"object","description":"specifies the preferred sector details","x-not-in-database":false,"required":["sector","location"],"properties":{"sector":{"type":"string","format":"","example":"","description":"Name of the sector"},"optIn":{"type":"boolean","description":"Defines sector is opted in or not"},"isLastUpdated":{"type":"boolean","description":"Defines consent record for this sector is last updated"}}}}}},{"type":"object","properties":{"timestamp":{"type":"string"},"dataAgreement":{"type":"object","properties":{"version":{"type":"string","description":"Version of data agreement"},"purpose":{"type":"string","description":"Name of purpose"},"lawfulBasis":{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}}}}]},"type":"array"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecords\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c9901\",\n      \"dataAgreementId\": \"string\",\n      \"dataAgreementRevisionId\": \"string\",\n      \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n      \"individualId\": \"string\",\n      \"optIn\": true,\n      \"state\": \"signed\",\n      \"signatureId\": \"string\",\n      \"sectorPreferences\": [\n        {\n          \"sector\": \"\",\n          \"optIn\": true,\n          \"isLastUpdated\": true\n        }\n      ],\n      \"timestamp\": \"string\",\n      \"dataAgreement\": {\n        \"version\": \"string\",\n        \"purpose\": \"string\",\n        \"lawfulBasis\": \"\"\n      }\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Get data agreement
Source: https://docs.igrant.io/docs/consent-management-admin-api/audit-read-record

---
id: audit-read-record
title: "Get data agreement"
description: "This endpoint is used to fetch a single data agreement for audit purposes, e.g. by an external third party."
sidebar_label: "Get data agreement"
hide_title: true
hide_table_of_contents: true
api: eJztW1tz3Day/itdfLG8xaEutuxkamvryJbtjOPEOrrEtYlcNoZsziACAQYAZzSrmrfzS/an7S/ZagC8zVCytPbZh63NgzMigUajLx+6G82bKEOTal5armQ0js7n3ADKrFRcWuAGKoMZWAU52nQODAyXM4GQMcuAzTRigdJCrjSwKuMWykqXyqCJAZNZAtMVMAl4bVFLJsDOuc6gZNqukiiOVIma0cqTLBpHjsApsuwUU6WzKI5KplmBFrWJxr/dbLB6IfkfFcLkGFROi6jp75jaKI44vS2ZnUdxJFmB0Tgido9qbidEWuMfFdeYRWOrK4wjk86xYNH4JrKrkqYYq7mcRev1RxpsSiUNGnp/sLdH/0uVtCgt/WRlKXjqNrL7uyHmbjr0Sk3btNzP7nHSWa7h3nIr6MFxb2C8sfkj2ZE+scK4NGDnCKbElOeBHSeaWmdBNWDnzELKJEyRphqU1uk4ATiC3rLOACRfoDZMAJPZ0DTS8Z8KJld/Ai4zvuBZxQTxolU1I5PpkfS6TS5lFEfXI6nsiMsRCWXKDEbjnAmDXe38FgW2yRz8r+OOJGKnB62EQH2hRe/vn0n3cVQqwdNVFEeCLfNKvGCGmyiOCrRzlb3PLxxpllq+oB+50jO0lk0F/SV4jukqFRh9jDcUybNtY3HTC2ajcRTFEV6zonS6fHb49Pn+wcEBfpc+T59Mp0/Sg/S7p98fbKk1WscRSZt7I7of9f1kL9nbInU+RwikyAosOXbfNqyC5Zw7r9aYIi+dJdEahvhoBTkZ3Gp/Oe+GZIDtvD4VUs8XyVycviM6Dl7aqbBTsBXZnSq4JavjOUjlR3G5UGKB2eP+ak75X1yORn3NesG2xpvYdOKeQyUz1EHITgF97zJzJgQtM1ML1BKzBODDHCWkGpnlcgZsA2hjJ2HBLBoLfvHaJRug5kK4URnmrBIWFkxUGINzX6VnTHLj9c+ygks3PcOUZ0iz0zmTMwRugUtPpQ/0AhcovPfeBlwntb/dz72l99JKi2/vY8+f7+0P+pi8xTqGSR8HSTpZNHAybEkkszDk2/nyL10/runDDvcwnish1NKDPxYL1OBpOwuthr1uePW5taUZ7+6GJ0mqit1S8wVLV6Nb9n2CumCSTINcl9mutS9Qr/oYhHDSM1qNLIvBzFUlMpDK0jNGu/G2HKyRvAMsL5A29Hulucl4ah8k11cXW5y/7RJaU9iQVcbq1RmmVun7k/4BmbDzlGncBsVAEoynuY7d+X+KFDlwJU9Qc5Uds5XpLMelxRnq29Z78uxwcxlCFdA1USgdVXLgjCiv42iGaqZZOefpKdJuvl54bxqKoDsk13FkrNJshu+UP2W+apUzTwtETWwdRy6EPKEIkrZ9NmeOaLvKVCmBTN62jI/2toLeOir1Pm4C1fU6aOzIWs2nlcWuopjWjByCWyzccybE+9xFqpvYOKAv1pCs47f+8WzIY/CapVasYEkhG6eRQmBqMUseiq9dDr59LHM4gLP9XcLk+OHA+/M2732kbcjHLgXh0lgmU4RLt9BlBErDZcRmeOlgv0fovky8roQA2Vm0jXK399z+tcWicw6Uhlu+4HZ1f5MNSt1wjZZSE8D0lkqZxZnSq/tv9AS1UXJgVy8DqeGFTKrKB+iUIH/b0YkG1GbrdLm50Hodb/tV34w7SHSnn97tne+4sbTTHrW7vK3PRKoxO8Z8OGa+5QR5cvxh/6eLD7+uXlydHL5781Sf//X0h/GT8ct34+/2xiGQ21aLxowgnwmK9bjkzuy8n/n08xswcTB+SXtzqITwPodTnHFjfdo+fjYYrpy5xR0n7r+Pm673TRDw0h0HdXZ471C/nrAezCe/SGbDwzvUuunlvaW+bX2OCkyJTAMhTfg9qjNv2AWBMyY+qangMx/P7/oMhqX0dsEtE58oliA7hl0oq6ng6SfLzJWfzC0vmMVmDPElq4LOjLAIJcAbi9QJNnOO01/EZejNIn7y1iJkC93U+1+X1E+OCsmoMggjkITTuw43PhlV6RTrvyoqgHwyqBc8xXabNMEf72F8FP7qj3fWW3J2zOzXsHvukykEJZsYGeH4ZHIEGkulnXXPUFJFDDNguUVNxZOTyVEUODirioLp1b0SaVru4lRAqdWCZ5RLdpYzlM34VU0MxpMFtGmvNrRAzXOOmS/iraDWIfpYifCOkIbPJLOVdrK5HuVXo0JlKAgGmjdbAFG/cfWpys6V5iTzEIOpfCNR3mkmGAiZeTpnXGJWp6kpM45YUQnLS4HQsGUe35mtdpm8Zz2KrYRyZ5jpzPXC8sDlLXPj4UkzbeDpD8zMN94QY5i9WDleCzSWFeW3j9wOhyK3905IjahLZqi2MGXpFZmCUQXC0cmkKRMbWHI7V5WlKizPYOfkx8cxZCiV9XbHLOloBUwjMLiMMs1yexnFwBNMgEFrDjagPKWCK7RAyUSr5FotvpQhxQrwmhtr3HvNKCBKHK4HUd9bMjdJkqwHXSjnVLYOBBv2jNNN7MDY6ip1DmuAwduz9z+DQc2ZqKssKoeco8gM3AwofgxJksRwi0kMvPW2NfDiiE5pltqBV7UpDbx6uzQ/IMtQx9BYWRjmN/nBq9abxCnmqFGmGIZ4bzpflf0H/WHrBM6CRHpiotQ7gYk/4hpX6qPgFHNFRiNXdk62RLIfNokdsom5o+7Mz1IdjUZssFQXGzrFvVyrwtdVgpqnlXVlNL+MQ+Il05lJtvDufuaFq7fz6ZuUv+dvX//66vT8f8/efp8kyd2wWDMzZ2buy36eeB0UtBJrdxTCJw/ZyO0c9YDxUFI0aAOhYrWJY/fP4LODw8P975ttHOwdbAeHR7BEIUZXUi0leIItVviD0ccH9e1TAr8wwTNfxzRjOH9xnIC7pyr4bO5KRnhdMplh5oAITFXSyYZZb5eBqqG5qLEGNwYFl7xgAgw62bazwwSQmKIxTK+STQGdfBugmUh/PSZWHdM3rc9slNAyX+4JBu103Tqix8YNmx85e7h2YZsrK8uWfggNeJ1xGeedt+zUnVP33i3bnx6kT7KneJg/G7L3wX2nelXaprhE1l/v2xmAu3DCBoHdCdK+VPkQlG5upobKr4jmjvq2xQLFGpaISrh7S5mkOMWrJAZesBnGHe9Fm27y1xz99+Yv49n4Clfjvz376SofEvULTFnlTk7gLmnMOepHdHJ6gs5B2Gqr4uqQx6MyA4m+LOsgOByGnfn+mHfTnCPxmeRylsCkH6KxDRU3ooh91didljWoNYkhBR0t565CIJS6IuutygbRVnWg6xMRuMJVFy+bEHOAKank6D6MpT2+GLghTHSqQo+MKxeZmCqxrqICsiqmdMZiwbgAlmUajUEDoyBLBkay0syV9WKdcpkZEnUf6b+RhAP0WR/fzFCXmm77t8pbj0xPjlRf84qghUwMDKy6QtkeoJVxRjU5BoOGIGsLMb1pHz0gQ76r2nZ69PocXk9evTsew1k4+/wtuEbhawhzXsIU7RJDONDNNjqClVnYu1+qk6HV53CqZIpamnD2cENr4IKF7oeXIS/399smgRNlDJ8KbM6ty85WLiPYpUAYKb+2eBltCao9lL8CpITDV7rZrm1p+3jvx4ME8E4am0oL9jMjWgzefjjrHlAe3GDn9PXL54f7h+7iqU1a7r2Bg72Dp6O9/dH+4fn+3vjJ3nhv79ftqLymW3tA4CyttEZJpaKOs3IjH1nn8s3dWVCnUcDtI59pEDXUo1Irldch3m2R71eWbScyc5U04/1886BeMgMCcwtTweRVfZoMhAJuNo32vBLXbQzwkGLsghtf1rm9yO5rieDS+mG2QxpILSS/NNbe6KYuw9eLXUadUlOHgzay/thsZ0ju/0Ka++zZQJp7BGZVFEhF3gYvYNfnuU14VTtOJ8LakH0CH9Cltq0F/l4Z6+UlapzxYZdyIXmLOzvMFzIek4SaYXAahAI7HodCQYaivvDCo3zAHO0wJ6bDvdMpEG6J0aaPE3+TFZpc7m3B24iy1R3kSTrEkLgcavUxTc8QNTV4U+022Xwrbvxq9dlGyErR5NK1UwQ5cV+pyDRbypgiXW6NLyE4TYe6QxPut11tbMoFtz7+T1VRMkvITgARbua/XGjvVcbu7u36MDkZ+0MmgFgfM1ztvFVCLeX6UKc6SI5at4ktNwAt11CSEanK9IzJ+Tn5fI81X2Jvm6C+WHV0rL/0fgDv6nlgrCt8+mV6KySwOcw4X6q7WQom6QKYh0wBlkpf5UItjTO5zc4B4z2S2iCYtDyFAhm5lPGq9LY6LD/f01KjkqtQRV7ZZEi+CMwsu6DA4cxXhu+4Y7rfFXDloxBPrd+bQ/xut9889NI3tB3EUXOBvlVAfNiF7J3nRHb3nvz958N6KwauX3Iu0YSGinrlzWXEg5sPbl2oJnXbUqE95piZ+VQxnd1SnH/gqoEqZDVZqLQYZsFfr6kS5VHJz7r3Z1++6jzvpjWhh/Q9UTqZbPQKZiqtnLt4AtM6zzo6mTxqG4ZN7E89yg2oDFG39/rKGdnHmbto+WrPCfc7/xkuM7CZ//rK/5uvuEiob2K+zWfggrq9gCKzoTsHmJy9h4Pnh8/2HlPHlea4oPOmSilmyCshyJTnLnEjWyHCT32/eJ/+lNG5XlYuOfE97gMT9x/UaN61ZtRa6Zcqc9ed9Lt7yf1x+zqsb+Ht7KG2tEYnT/f21gPkB1TaqvHFwMbX6wENXMiQqv8Nsy3RHD6wB/8/SzR13dQds6jBLbMhIw8glXadRr/dREcl/xHp50f6oMGyGWFtdETRLW26CKX+aIZuz/T1xDjaddHvLqHUqHGG3ZuNrynWDjaJk6HPNI6xUIHR0Obb9plmWKgRK3nCZ5pJm3C1uziIqNFnsw+QzeqwYoCM8a8HKH1speCaUrwOa1m0Z5B/ED4d8WJsPx45CnZYN0BsZJEnE1ceI2ul8qS3QXfL0BalCYo+9+h8Br8MFJQrTl1YnvPr+g7js+cRPsOOVNbX6qxm3OeTJUvxcfjCpk92DGHin1eq0iSR0RWu/vKZMkDaXq5qvwn1b1eRJHv01x7/08iv3T9/0z7qC74dvGWjzSTY+cf//f2xLyCfLTHjZu6PPbwOxebNclMTPfreBdQJTCxlBHSUiXxkqDqNfFaXsu2qrmFRQkl5ZmiLciXKjM+oSwWWTAi0/upD0X1SqTKwmM6lEmrG3RdLkk2Fz8ApmXW97qQ9l324YMbngY4Iq6wqfJe+yxK4azx0ygsXNLMq1CDdLSK406HOJwVdQEmJOnFfmaQofS9MbXIlS+cIB665qi/z5XKZMPc6UXq2G+aa3XeTl69+Pns1ojnrtr+h1QMZah3G1abc9Ke72lvyJNn3XzUYWzDZ4ecN2u24aqObsgHjf/NHZMGHLV7b3VIwLjtt7x7HfvOfloX2nlF3D+PNL8M+xtFcGUuTbm7o1L/QYr2mx39UqB2AxtGCae6LFwR33NDvbLji15XLzmk4hh7DrR+vDe6mhilJGOVAxQdEV4RiWx+3uYQggBgx6EcdpSmWtjN/68Rcd8+BN6/O6bOoys77OHnlcDL86ETrfd42IdOzQP92ujj7U/5M9vkjrv7SDPdvbp3QwLQfTZKi6O6fyiTJSg==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Get data agreement</h1>

<MethodEndpoint method={"get"} path={"/audit/data-agreement/{dataAgreementId}"}></MethodEndpoint>



This endpoint is used to fetch a single data agreement for audit purposes, e.g. by an external third party.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreement\": {\n    \"id\": \"65471222e8c7c3bb3c2c8492\",\n    \"version\": \"1.0.0\",\n    \"controllerId\": \"string\",\n    \"controllerUrl\": \"string\",\n    \"controllerName\": \"string\",\n    \"policy\": {\n      \"id\": \"65471222e8c7c3bb3c2c7701\",\n      \"name\": \"Default data policy\",\n      \"version\": \"1.0.0\",\n      \"url\": \"https://example.com/privacy-policy\",\n      \"jurisdiction\": \"EU\",\n      \"industrySector\": \"Healthcare\",\n      \"dataRetentionPeriodDays\": 365,\n      \"geographicRestriction\": \"EU\",\n      \"storageLocation\": \"EU\",\n      \"thirdPartyDataSharing\": true\n    },\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\",\n        \"restrictions\": [\n          {\n            \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n            \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n          }\n        ]\n      }\n    ],\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"\",\n    \"methodOfUse\": \"\",\n    \"dpiaDate\": \"\",\n    \"dpiaSummaryUrl\": \"string\",\n    \"signature\": {\n      \"id\": \"65471222e8c7c3bb3c2c5501\",\n      \"payload\": \"{...}\",\n      \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n      \"verificationMethod\": \"Ed25519Signature2020\",\n      \"verificationPayload\": \"{...}\",\n      \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n      \"verificationArtifact\": \"\",\n      \"verificationSignedBy\": \"did:key:z6Mkf...\",\n      \"verificationSignedAs\": \"individual\",\n      \"verificationJwsHeader\": \"\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"signedWithoutObjectReference\": false,\n      \"objectType\": \"revision\",\n      \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n    },\n    \"active\": \"\",\n    \"forgettable\": \"\",\n    \"compatibleWithVersionId\": \"string\",\n    \"lifecycle\": \"draft\",\n    \"dataUsingServices\": [\n      null\n    ],\n    \"openApiSpecification\": {},\n    \"dataSources\": [\n      null\n    ]\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create data agreement
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-create-agreement

---
id: config-create-agreement
title: "Create data agreement"
description: "This endpoint creates a data agreement for an organisation."
sidebar_label: "Create data agreement"
hide_title: true
hide_table_of_contents: true
api: eJztXf1yGzeSfxXU/GMpRVEftmyHtbV1smTHdJyYJ8lx3VquBJxpkohmgAmAEc24+N89yT3aPclVozHfQ5q0lVvvFre2UjI5aACN7kZ//Hr4KYjAhFqkVigZDILrmTAMZJQqIS0LNXALhnEWccsZn2qABKRlE6UZl0zpKZfCcBzcZzdyaBmPjWIabKalYXYGLEYKlmm4E0YoydTEfUykowbh/o0MeoFKQTuawygYBKGSEzE9d8+f5Q8GvSDlmidgQZtg8P5DL9DwRwbGPlPRIhh8wmEWHxx8CniaxiJ0FA9/N7jPT4EJZ5Bw/CvVOJ8VYPBfuJ5yFhwcx28mweD9p8AuUggGgRr/DiEuwAob4wcXtSG9BkfPZIVvuCguPGdMCqGY+IUhXzgzQk5jYGmmU2WA2Rm3LOSSjQGHGpDIMqv6jJ2x2rRMGJZJcQfa8JhxGXUNY+MF+y7hcvEdEzISdyLKeIxr0Sqbzhivk7yEUOmITuTjgVT2QMgDZM+YGwgGEx4bIK4LDVEweB/4ZePZ0F8XFU703IloFceg3+q49u+feeJGqViEi6AXxHw+yeJn3AgT9IIE7ExFbyZvHWkeWnGHf0yUnoK1fBzjv2IxgXARxhB86DWO1JPFw62dzMh9zjIZgWbzmQhnzKL41xlrZjyOkZNTdQdaQtRn7N0MJEmwkNOWdvSqck+T56eRGTqIiYhj91QEE57Flt3xOIMecydX1SrGo0RINzyCUESAo8MZl1NgwjIhiUpdO2O4g5gObpXMjnJWb3aykg4o03GbvSLC//qJjNVCTul0Em6DQRD0AvjIk9RN+/j00ZPjk5MTeBo+CR+Oxw/Dk/DJk6PjltYEyx5NujHpC89Jx4tCkupUUc5yA+QfWfYCVBpBVmGzqY77R/2jFvFfiEydPtsTpMETFcdqTnoPyR1oRrT3cQXI141nn1mbmsHhof+kH6rkMNXijoeLgxX7HoFOuETReHv5mnFblfY70At2V1/7qCa0GnjUY2amsjhiUln8jONuSJa9NKJ2MCsSwA39nmlhIhHarfj6/G1r5a+qhJa9QMgoM1YvriC0Sm9O+iXw2M5CrqE1xdCTZIZoLnvuErgEvD6EkiPQQkUXfGEq0wlpYQp61XwPH582p0GrghcjEWWpo4oKHCHlZS+Ygppqns5EeAm4m69n3g8FRaYrJJe9wFil+RReK7p8vmqWK6LF4pzYshfYmdDRiGu7wG1fzbgjWs4yVioGLldNY3UGzWmukSRLkSbpuPFUl0t/YmfWajHOLFQPimvNUSGEhcSsv887zosXJPOru35rG9QY+MhDGy/YHG9rgU/GMYQWov629rW6gnu3s09PO+xsfZdseLG94f25vfa6pS3I95zfKKSxXIbAbtxENwFTmt0EfAo3zuzXCG26iBdZHDNZmbR0cNp7Lv/VWqJTDpBGWHEn7GJzkfWH2lCNkhLOFNWYjVOF3MJU6cXmGx2BNkp27Orck+qeyIQq3eJM0eS3FR1psFxs3Vk2J1oue229qotxxRKt1dP12vlaGIs7rVFbp231RYQaoguYDLdQqZcPL94d//T23T8Wz25Hp69/eKSv/+vy5eDh4Pz14OnRwDty7WPREKHJ5zH6ekIKJ3akZxSD3MMiTgbnuDdnlYC9mbBLmApjKYgaPO50V67c5G4l7n8fmqp3Lxbwxl0HeWDQsc9ybz9xfQvOoQ5VkmQyn2ClbcmpLjvjjbVzndMCcbLMgJdjFOjUq5dARz3JV/Q5E1JZSTV02fhYfZDWlnJHjI2RWmGqCjf/IA/u2CGLYcrjX9U4FlOKGw7dcWke4rd3wvL4V/RZUF/YIUuzcSzCXy03tzRYWJFwC8UzuDyZJXg3lYtrTpLHcNwpaH0SFwQWk9Dg1iQoc9XobmOG4Xn9alSmw/bV85MjiOzKDLADJvFqOGSVIfm/Mgy3fzWg74Sj43eMA3rNKdrPO4VJBb/gdouVnxydPDo4Oj44Pr0+Ohq4//+jtYVriumAKVm46sAuRsMzpiFV2inZFCSmSSBifGJBY/g+Gp4FflVXWZJwvXjbHVm0p3t7GbNUqzsRoVJUpjMYVNGspscMkWVgw1p24g60mAiIMMXA5YLlRwzksqHZRYMnppLbTDt+fTyY3B4kKoIYrVHxTctO5d+4DElmZ0oLPAfvCqpJI17fKwYYlvCFy4HMuJAQ5dFyyI0jlmSxFWkMrFiW2V8bNFcXuWFGhC9i5a5SUxlLzCLzRtLa+HBUDOv49CU3s8Y3uDCIni3cWhMwlifp/TuQp10O5BvHpILVKTdoOcc8vEVRMCoBdjYaFilFw+bCzlRmMX0oIrY3+nG/xyKQypLccYtntGBcA+PsJog0n9iboMdEH/qMs1IcrL9sMCJdgGUY05SHnB8LZVRkvGDwURhr3Peao1/WdzeHZ/XGnPnU7/eXnSo0EZLHzBMslmfc2fScrbY6C53CYkr11dWbn5kBLfC2KXKAEwFxZNinjoMfsH6/32MrRKLjW5Ktji/O0Fngoe34Kheljq9ezc1L4BHoHiukzD9Gm3xHR0sicQkT0CBD8I+QNl0v0voH9ceWfXblOVJjE2YA+mxIN2ChSnUrOIaJQqGRCztDWULed4vEHsrEzFF34mcxnYdPNJaU5zzGwFQiLE4y0Sqh9I4/5nFmXTaPpnGWeM51ZPote7eZeMHi1Wz8QyjeiFcv/vH88vo/r1593+/315vFfDEzbmaUfSTiuc9QcqzckffiyGSDsDPQHcKDsVmnDPjEWdOObZ5IiE5OT4+/L7ZxcnTS9lHP2Bzi+OBWqrlkRLC0FXQxkvvg0t8Gc7O/8FhElE41A3b97KLPXE0jEdOZy1zBx5TLCCJniJjJUrzZIKrt0lM1OBY05MaNs0RIkfCYGXC8LUf7AUxCCMZwveg3GTS6H0MzxItV8jheVETflDrTyORFlHXyAu3OulREso0NmT9w8vDReXUuuy1L+t41EHngZ5x2rtipu6c23i0/Hp+ED6NHcDp53CXvnfsO9SK1RY4LpT/ftxMAV/KAwgK7G6T8Uk26TGlzM7mp3HwnHVJcky3uKeZmCan46k/IJfopdCQ9JhI+hV5Fe8GGzfUVV//mvrOIBrewGPz5+KfbSRern0HIM3dzMuFi14kA/QBvTiLoFIQvWolfZ3nIKnMmgbLDzgT7y7Aynq55N8wpkphKIad9Nqy7aLxxxAUrepS8drdlbtSK+BSdjnLlLq6Llbp10V5aWLRF7uhSnMJuYVG1l4WL2bEoqeTBJgsLa+vizD3C40py6oFxWSvTKyJPJrNkjHcsJFzEjEeRBmPAsAPPS86M5KmZKUtsHQsZGWR13dLfE4e96bPk30xBpxorw60s2wNT4yOm+eggcCLTY5xZdQuyvEAx7n5g2PCCGTBosloWk0T7bIs4el3S7/LsxTV7MXz++mLArvzdR3VYDTFlGmYiZWOwc/DuQDXaqDBWRn7vNFUlQsvv4VDJELQ0/u4RBueAO+4r5+c+bKcKq+mzkTJGjGMo7q2bylZuAnaIjjBg+G3hJmgxqryUv8JIxc6+Ym01l6X29V73B9HAO240D83LzxRpcfbq3VX1giLjxvYuX5w/OT0+dfWvMmj5kjj6+GjwcEUcndPNNcCvLMy0BokZq4qyCiMfWKfyRQnPH6dRTNgHFGkgNdAHqVZqkrt4qzzfr8weD2XkEnqG9Lx5Uc+5YTFMLBvHXN7mt0mHK+BG49O0Vlx16QNskxMmBMfaXD+lNJkL67uX7cNABDH8Ukh7cTZ5NSCf7CaoZKIqKyg96w/Fdrr4/gVh7uPHHWHuGTOLJAHMNRf2gh1SnFu4V7niVDysBu/77B240LaUwN8zY4lfcW5nyO1SziUv7c4ep0TGPnKoeIxd5sCaPbJDPiHDa4gbXqQKtbM5PbzcK4AFX6wGG+73qaDmYRZfVbJrIVSIqLMZEuZdcBNT4FYIH4TCWgV6fJ1GdUyYX3BoXtGlnDtoh2eWoHRFpPlc9tDdFdZQHsEdt08+FD4/waKySFg+FrGwFASEKkm5RfOOVsKjBD6f9K+lx9ZDjN4NRwO6abwlqxsOl8cvzyFndH6zYzJkAlqX0a0wjJWrZilKkspMC8NlUPFrS6N0PwYHb/HWvKJU6Zo6z2Zl2IyuYKJWx8cgy9sQmG0Lr7703wuKInYre7ZdUXStkYzW74lqkNvhGzoqFBMhwXhQQz5zc5p4awDAyolyUqum8hCVC25mY8V1tCIzveWsniqLcrIs03H3EqjEpVKQZ6m4qtawPl9uvK769B7C9wYpjYYNGF+kwsypGREY50HG2Wj4oERWmh6ZfHSMMQbPAY+UNkL5uHKVh6/WHF/w+PdQmY7N7HTlL9OVzlp+J+b1OWaLsE5bFRM8secfKUfQFo3at59VPyfK4B9nEVguYtNCFlRpjrSaiLhT+taRTv2w0uc8G46OMTH5Znjx6Jdz521211E6eE61fkFQCSJAgtya7zNggM7KfZnhcMA48xz9Erx0C2Rzy1NqxBcmd9fBDw3Q86seYotqZZ0oIR860M4+wEO5Qg+47ro0J6jDrT80a2/LJQ0wKXpk7pRPjo528O4dvPsecXGPvj/pxB/fEy74mlIppeOMhamabFjlc0gYtIUgUidJOIehACJn5CbWYXhRtFgU4+pUNsIEIFA4R5KVQ9mejxryepiYMKnoKSHvVHwH0X59tp9XOAHdd/2XzrfD+O8w/juM/w7jv8P47zD+O4z/DuO/w/jvMP47jP83gvG/J/j+XwrB32Hvv5hT3zbgfgeu34Hrd+D6Hbh+B67fget34PoduH4Hrt+B63fg+h24fgeu34Hrd+D6Hbh+B67fgeu/dXB9B6bvnwit/8xqdrj6vwpXX4KgPpt1dEs/Jz1gr/NxzFiX+KRpajP0WfMx43QpR7MkXGIBWPhIgc2Vvp3Eam6cyDWRA4Y0EmEQXFoRsgQ4qpShoyRZ7eYfYVpyq+QyVAEdNgoSJYF3/QW7/oJvEjO96y/4V1aZXX/Brr/gn9NfsHFbQR0EOrwgwAHlx8+GI+cXFWiEsglhE+BwN4qh3mXwbTQp9II/OqHQ6NAKDWhZLhaSJyJ8LeRt53OpBvREnThe0ovju8RkM3uzBoBamYb5F9R/Bo66HnC6gp7/E6JOfNwKqf+JpwSv8WMrOJB72HoHWVrpl0GD6sv5SjlcCw3aViuWLVBNF3CpuBU7+eKIoI+rEMFb2WITTvWvx5q2aP4ViraTtu2kbbl1p5d73qeIOjiWX9yXqxJZZ+w7V1sS4XdlwEuprJCnBClp5Nh8j5eDXyHuhRb0wOR9VFrNyySwqzObjBKgVrHj/VXJd+cSn+xTRgHT9jfyRp4ZbLwoEug3gclCTD8ofRMg1i1LMFNRrrys9WJSQ0SAcX6swtttIMEiKtjsEbbEz2FU/Ik3vvOGtfiTx+JPiK58gcJ/Sh963MpfCFDpzNwV+bEq2HFVx8/qV7muTsGMfI4kXuCROPI3AeECUMIhnOF7gmPsXzAo95Vj4Q43cFNZVC3f2Zy3bKtoJ7MqedBtkJwbd5shwGX0Y+EqexkuspuFRpTZZScW9wCrqc4lmlN1pN9r27+3vPsw6ki4d4i8zyLyOMxi6suqa0C/pIdZOJONDdo/lwoeQwklIfxIh0p9JUdzdch/12jPA22wkL9PiBsC25ylabwg9M05l8rJsPiT3DpnfzGHhlVLNnx+/YJdvjhnT588Pe0zNqx0mXLfYOZhTfUqAXwMIbXMZGTFhtjeU2NW9d85AzyWt2FXvghnsO7vFuNeenRB15nvXb08Ozj+/ytlORnL7TzK2IynKbj6wtBWDMzw6g17+vjomL29PidAad4Z5UubfyJ0YFiUGkl12trgC53DixIcWcYpVVJvsGaxlf15dPromJ/AY3hy+vj7o6Oj40enfHzUhgJdVossPG9IdG9Gd1qKcK78B7tcGrvwBFBY8ouSllbLr1e8gc90rU7qhKkGwGKFVfFqr2X+QI8qQ7hgLB4Ui/DBXQT0z+3kdzPpDR+2BYgKlxqMq2HYEofiPIpKpp8KRKFKRV4XaChbff1X24PcqkvtQqBst1a2NwcWKazeIlIMG3B9IFp7qqzCYQFNKux5dD5mq5//MymNPXSWEFTq9Ovkyenjo/1C9vwpT7I4xpt65ury6N0g2Uf0YoA69TFHe59mrvZMPxfXMfA42OaNAlUPDrRW+lxFLqWDf1d7GFqvM2j6ZOXorq7D4kgfHR0tO8h3SEQpBc86Nu7d/kajtyxtTIs1p1u+bOHfizU5LM5VUUAzN02DR5QfzrRrJHv/KThLxY+Af37Al2NYPsVUelAvdeHuEw/pDFJFDRvczoJBcEi/dniI7sNBNXdOS6C8fDP9mii/Qt++XfYPR5CoA56KvphqLm1fqMO7kwATr83+Tj7Ny0UdZAx93UHpQ7l98lvc4eVMKANu+gB7e5Es4WnyJsTgzAtg3tjSCBxHQwd7QjHFOJiEz6FHS7Ah2qTfanR+YzQNSxADMHYmayI+5tjU32iN7De2J5UlDJbVXBBOIOUh7PcY9Kf9BtkB8wP/tlCZRo4c3MLi77/13atNUCMuy9+hfJ7LXMeLR8o3FmBktq5r3nOpu/m9yCQWHev1o1vbQV5v4abG32b3daOtelXXtOuGXtHeTIRb/cj08Yo2YmwP7uj5fb+GXb751bOrs2V1fQtprSnURy9l92a1LdO3WuY9lPU00/ta7+HmTYVlmulregCXzvAU3Xjrflanq+3uC34ap9ZvV2lZq3WXNdu7ij6ulb+I0uizKi15Dfi/Uhp8Q03RglKEbJXhaxoCuuD3q3D1nUj0Yr6V6O0OWHY3ODpY1ZHUiTfuRnnW4ZsrAI5BLYW0MnhaD8vzilNFwVXBZS042epsUwUpRW8LqMGVcgVdBQOqhBptvIjrOfywslzfLJLnjzfLip0lweKdYaK2iop6F5+1C2LO7i3dWzAmKve9PETegZZxOHVG/EdxFZdWT/xQflS/CMqHW35OMYjt/e9//88+Ycyv5hAJM2u8sKyJSC0AJtTeCNoFyZlx1e54cmAQwA5imiex7SKHueIhsrJW6VDMkZhiIyubY+7OUneEwpaTVEWU7FOxmgqEPIPk45hAeoh3c6/DQaPuAEoO70BQMUeEZ1YlPDeCaSzcuwmcH+B7OKaZhym7RiPmIowcchZjj4qUoPvuRVQhSGqXzb2XlIczYCcdl+98Pu9z93Vf6emhH2sOXw/Pn/989fwAxyzL3Hl5Dujz5EiP3Csqb3pUy/7D/jG9+MjYhMvKeuiXstvoi8Y7Fwqf/tv4zW/vKFr4aA/TmAtZeWcO+cbv/S+Be4WueMcfesEMvejB++DTJ4wf3+p4ucSP/8hAL+jnwe+4FmQ43mM21/ugeFnfoqsanBM/DpzFwsfjjDzXRryDzjONOAsxw7b22aqjP3pzdR30grH/ffLExTaB5nN0IPg8GAQ3gctQq7SoV7nPPwUxl9OMo8kJiO7Sp4bqLvatc7H9HxUAD5eLyiqb3jZtBv9bAWTUh/wN5fFHWPy9eJy+WTmg8PDpaTxNLCL9H/lnAKI=
sidebar_class_name: "post api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create data agreement</h1>

<MethodEndpoint method={"post"} path={"/config/data-agreement"}></MethodEndpoint>



This endpoint creates a data agreement for an organisation. 
It also returns the latest revision of the created data agreement.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data attributes contain specifications of exactly what is collected.


</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Marketing communications","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Collecting user data for personalised marketing","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"consent","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"data_source","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T00:00:00Z","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataExchange</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data exchange details

</div><SchemaItem collapsible={false} name={"dataExchangeProfile"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AIP10`, `OID4VC`]"} schema={{"type":"string","description":"Data exchange profile","enum":["AIP10","OID4VC"]}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Definition id for OID4VC data exchange profile"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"isExistingSchema"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is schema existing"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) created successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data attributes contain specifications of exactly what is collected.


</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataExchange</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data exchange details

</div><SchemaItem collapsible={false} name={"dataExchangeProfile"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AIP10`]"} schema={{"type":"string","description":"Data exchange profile","enum":["AIP10"]}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data agreement ID defined in AIP"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential definition identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"isExistingSchema"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is schema existing"}}></SchemaItem><SchemaItem collapsible={false} name={"qrId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"firebaseDynamicLink"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the presentation request"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the presentation request"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requestedAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Map of requested attributes

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the requested attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of restrictions for the requested attribute

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential definition identifier"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreement\": {\n    \"id\": \"65471222e8c7c3bb3c2c8492\",\n    \"version\": \"1.0.0\",\n    \"controllerId\": \"string\",\n    \"controllerUrl\": \"string\",\n    \"controllerName\": \"string\",\n    \"policy\": {\n      \"id\": \"65471222e8c7c3bb3c2c7701\",\n      \"name\": \"Default data policy\",\n      \"version\": \"1.0.0\",\n      \"url\": \"https://example.com/privacy-policy\",\n      \"jurisdiction\": \"EU\",\n      \"industrySector\": \"Healthcare\",\n      \"dataRetentionPeriodDays\": 365,\n      \"geographicRestriction\": \"EU\",\n      \"storageLocation\": \"EU\",\n      \"thirdPartyDataSharing\": true\n    },\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\",\n        \"restrictions\": [\n          {\n            \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n            \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n          }\n        ]\n      }\n    ],\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"\",\n    \"methodOfUse\": \"\",\n    \"dpiaDate\": \"\",\n    \"dpiaSummaryUrl\": \"string\",\n    \"signature\": {\n      \"id\": \"65471222e8c7c3bb3c2c5501\",\n      \"payload\": \"{...}\",\n      \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n      \"verificationMethod\": \"Ed25519Signature2020\",\n      \"verificationPayload\": \"{...}\",\n      \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n      \"verificationArtifact\": \"\",\n      \"verificationSignedBy\": \"did:key:z6Mkf...\",\n      \"verificationSignedAs\": \"individual\",\n      \"verificationJwsHeader\": \"\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"signedWithoutObjectReference\": false,\n      \"objectType\": \"revision\",\n      \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n    },\n    \"active\": \"\",\n    \"forgettable\": \"\",\n    \"compatibleWithVersionId\": \"string\",\n    \"lifecycle\": \"draft\",\n    \"dataUsingServices\": [\n      null\n    ],\n    \"openApiSpecification\": {},\n    \"dataSources\": [\n      null\n    ],\n    \"dataExchange\": {\n      \"dataExchangeProfile\": \"AIP10\",\n      \"id\": \"string\",\n      \"credentialDefinitionId\": \"string\",\n      \"schemaId\": \"string\",\n      \"isExistingSchema\": true,\n      \"qrId\": \"string\",\n      \"firebaseDynamicLink\": \"string\",\n      \"presentationRequest\": {\n        \"name\": \"string\",\n        \"version\": \"string\",\n        \"requestedAttributes\": {\n          \"name\": \"string\",\n          \"restrictions\": [\n            {\n              \"schemaId\": \"string\",\n              \"credDefId\": \"string\"\n            }\n          ]\n        }\n      }\n    }\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create individual
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-create-individual

---
id: config-create-individual
title: "Create individual"
description: "This endpoint creates an individual for an organisation in the consent building block. This is used to onboard existing or new users."
sidebar_label: "Create individual"
hide_title: true
hide_table_of_contents: true
api: eJztWV9v4zgO/yqEnmYA10l7nS4uWCy203YPwRxmim33aVogjMXY2sqSR5KT5gK/3Se5j7afZEHZSZw/ndl5Wxz6EjgKSVHkj/xRzkpI8plTVVDWiJG4L5QHMrKyygTIHGEgD2hAGanmStaoYWYdr1iXo1EeWROUgVAQZNZ4MgGmtdJSmRym2mZPKUSzykPtSUKwYM3UopNAz8oHlrMODC34d+dTkQhbkYuWx1KMRGbNTOVX0ZvxxhGRCEdfavLhvZVLMVqxXCAT+BGrSqssmhj87vlsK+Gzgkrkp8rxBkGR52/bs0VNrT/NxOjzSoRlRWIk7PR3yoJIRFBB88KOC7vxuytQa7vQSyitJB1DtxWHRaGyAkpcgqMZOTIZgbclgTI+IH9ThlXoOZAzqMEvfaAS3jjKlQ9tSLrFBGa1yXgBNYyvE5jZ2kjcLACF7G0KlzsObPaxMwiclOgmp8bYwJmZEpTKB3wiAwsVCkCojfpSExgMtYsm1tZSGIeY1Yo1Of+du3ZhyPGapExJAtVt5iizTkJFrlTBQ4lVxckPFvCIeUAjB9axNoJXJtfUP4qzC8jQsBW24GlOrL+GIOaOqCQTIp6eT4wNJ8qcSAw4RU9iNEPtKdmHguTPLvE+OGVykYiZdSUGMRIiEfSMZRVhcHH+7vwUz+iCfnh38c/hcHh6/i6TFxcHoLgvaB3E8TVHfhcUzi5S0bDlNunj7/CBC+bn7mua2fJg7183OOMoGxsKcjtIGeyhqIWo8qDVE+kl3I7Hu87dR8f+qoNUojosk5s1vsfXwHbAV5SpmSKXwiW0JlP4hZO/BuxDa+pBcK94EHtgfxApXKFh+MYeowxoDOTgS01OkY8BVpJMUGF56+xcSXLfE+hjycbp6dmRZCsPma21ZGfQwC8fEpjWIbZNYxewIJA2lluBcwLclIGdwdpDqDoXfQrj6/fvY8uI4qV1BNz2lFuju2ma5K80q5vn4NB3XVM5kmL0WRgsiQ/apakqrCHxuF8WUepIrHaP/hHLrrFQr4xj5LE8HuxdA22H55bjiVMPT7TMtMUnbgXg+fxse6LkBNDDJJqdRHhG/7+5wQ2LwfiaVdqjflPlNoqxfO2LjzaoWUcr9/aJzLf1r2muYvVxRz0aHBklXiqr49aWFb35dPf2iMFEkKlLTi0a6aySIhHKevHYJIKR9hLs9/eZKUM+Gm+1QMlj7jfN477upYEWhVGeq3vcV9jFX8/WY7IH4qZppX3FPT0C8Ww4fCX6V6J/JfpXon8l+leifyX6vzXRH9D5voVec2zfNUjwdZaR97Na66VIREHI1SFGK9Y+b+l/18gUuQ1UdYAKHZYUyB1RPP2uuaFfOeScdVdWxvLh5+ve9gdDy35FbbW3uVAmUB693PSd8+GwOWL+SP62rer9kYM3zZEw/2awDoV16j8kD0Lz7jtHqv+v0IzNegAjNycHcZu9GDWJ8JTVToVlHBcvK/WB+PGRayJg7jkW451JtqRQWH53VVkfT46hECMxaF9lDXbquN3aR9v71VnazjORiNppMRJFCJUfDQaSSnuClUpV7tCEVNnB/EwwQ+xNqgFzZp0XzPj25yOWHrfHvuPst0lbH34TfWwXEqF4tzZuIumYRFx2wItoOug+l7djbv3A8GRCbEHH7wsJ5qjrDctMduxMoN0GytoHZt/K0Uw9k2wn2UnrI0zgjbGhpZLgUOkYhgozepsApXm6Z3YEneKPS1s7jsjJEy1/mqSxmXEl/Lp933izxtr+tYIny6+NjP3p79hYtz+AbSj72FTztXGly8CmOjpu7pVLy6XbhY4pewvHqbBPJltK6/HQln/WohxBZWZ23Wowi61m40JdVdaFnzcI3Pqv/rVd2oXuVvigrDdK8OaP//7vLY+5CHcLksoXwFcDoOesQJNTnDjm5DZnjIXC3LsezeLtp/bkwZOenXg7J0cqN5shLun0caqJeSwuo/YJIEiVq8AXQtSaQjveWK0kVFZCoKwwVttckU+ADE4jRDG+C9c0Jx1nRW5R8YX4VGmeGdkI1sGWGN+dZ7astIqzc4R/PJ6jvNbxPD5eNSESKmAtVYh+lmgMOb4yaZWR8bQd/8RlhVlBcJYOD2K+WCxSjD+n1uWDTtcP/j2+uvl4d3PCOs12KN3mgUtd2qzmWXbdDLjrtfk6G56dp/9IT+P8ZX0o0fT86cZF9eJ1vEdff5u/MLr2GOg5DCqNyvDZYjBXHRt87v7YiL2zTx4Fc8bos1it+Ab7m9NNw8t8xYm0k4g5ugi3SEJrtooE8sTNWVy14TiJlcnium579R6zM120GpdZRlX4qmyf1m4/3d2LREy7f17KyOLC4YKvHbgQI/EgHkT8JyeCME4OvL4SGk1eY87yrV3uDcwAu6TyFEmle+i9pUGz7Hm5zy/tYfizd1faVfmRofiBlj9txNtfXlTYcForzZl8bJrmT9QUcVI=
sidebar_class_name: "post api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create individual</h1>

<MethodEndpoint method={"post"} path={"/config/individual"}></MethodEndpoint>



This endpoint creates an individual for an organisation in the consent building block. This is used to onboard existing or new users.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Individual created successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individual\": {\n    \"id\": \"64541a2e6e7569000145cd66\",\n    \"externalId\": \"user@example.com\",\n    \"externalIdType\": \"email\",\n    \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n    \"name\": \"string\",\n    \"iamId\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"pushNotificationToken\": \"string\",\n    \"deviceType\": \"android\",\n    \"mapperId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create data policy
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-create-policy

---
id: config-create-policy
title: "Create data policy"
description: "This endpoint creates a new data policy that can be reused as global parameter across all newly crearted data agremements."
sidebar_label: "Create data policy"
hide_title: true
hide_table_of_contents: true
api: eJztWetu4zYWfpUD/mlSyIrtXGZqFMWmmdk2bTETxJldYCcBhpaOJTYUqZKUHTXQv32SfbR9ksUhJV9kZ5rBFFjsYv4YMkWeG8/10yNL0SZGlE5oxSbsJhcWUKWlFspBYpA7tMBB4RJS7jiUWoqkBpdzBwlXMEMwWFlMgVvIpJ5xCSU3vECHBnhitLXApSQKsvYUjcM0EOOZwQILVM7GLGK6RMNJkMuUTVii1VxkF16EK8+VRWxF2rLJ+7uIGfytQuu+12nNJo90xqFy9MjLUorEkzv61ZJyj8wmORacnkpDzJxA6/8F8pPHnjXOFejZr5g40HNwdYmwEoT+sQkLr+m/cJIWVhseBkq7gVAD0nTGLbLJnEuLQWZhMGWT90zxAlnEKiPZXdSTSqT02zKyzgiVsYjNtSm4YxPGIoYPvCg927PTkxej8XiML5MXyfFsdpyMkxcvhiMW9VRiTRSYPpv0K5zzSrrN69+h+oYX6G2UY7elidgCjRXB8s9jNYqH8XCH+N8CmW36cCCCA861lHrp31gsFmgg0D4kCciuz+aeO1faydFRuxInujgqjVjwpB48ofcVmoIrVA7eXf8C3MEyF0kOjqJogaaGxbbswTvWgcPTCGyuK5mC0o7WOGmDKTgNSc5VhqBJJycKJIV+rYywqUjcJ9n19bsdyX/aJNRETKi0ss7UU0ycNs8n/SNy6fKEG9xhcdmSBBtoNhEjH7pGClGh1RUaodNXvLYb7IRymKF5it/x2WmfzSvyS9MRhdJTBaEgJcpNxDLUmeFlLpJrJG0+33g/rCiC2SDZRMw6bXiGv+iQeT6LyzTQAtkRayLmcmHSK25cTWpPc+6JrrnMtJbI1VNsnKmwz+aGSFLOdnWIcdtSbZqm2c5WbRTc9dNft9OWWtmQvMbD4Z+SkP8wz/YydpceMgobZds6o1Ige51nBn25IfegeDTIZUHByRVok3ElrBcw1DdhweAcTQhHbuHWOzCQUkZLieaWwcEPr66uDz0LvVRoiFo4pRKhMljx9CXuS1X4UhW+VIUvVeF/uipQslqIXhDvZOjrbs9ujv46Q4VGJF9DRwgKnaKEhJeuMmjbwDWCS0GzRVtGbEjVNYS68ZUFK1QmEYxexuBnF+HPKrBVaNydhtEhJKYu3ep2rMgUJz4+a48PgVepcEJl8a26VedWpAhzowsvxS2zVZKgtZqyfaJlVagI+FryNlJnSFLSWaoXUif3mD4/44uURW01fBOSf7DnZbp6pKulTWjE71yK3zGdKl7aXLt2NSz+yG3ub6FA63hR/vkV5OxsTwXpbhsuX3mPX6vybF7pZoXeTapkcF1ZWdOVePK3DGaVo8wODpNciYRLSp9WK7t5LVxKTFenSKhbz1lVBdm+z3ed1TdfXGOiTcrumo2r+Swzvjz5Zryj5Q2Vg5+7wtAOn74ZWXK7ERGs2XKLZwvyGMdxs5frJi/RZ0URg+nfhct15d7uqv8HCaZ1+J1CQO2gD3buoDOqV1Ti3MFMcnVPKXuPy8OSgjzhMqkkp9CF7QiI1/QKXlM2sIQUKCdrcom58C4hVOy12xNSn2nRLhw6pOOgRUh+mr59c0gPHKjMxnBelrL2y3DBlfY+LH4PTeiU/BVpd4kGLl/f/BWu/3oBL1+8PI0BLp1Pi1yoALCQw8wFytR27hP8HfAhwdKBrUIWu6TuYstYm/87A8S3qjPNRl55tlX4aDZOjtMTPJ2ffex5x3DEhuTfd+cH0x/PByPfwq3T27NFGg/HJ4PhaDA6vRkNJ8fDyXD4j91I6OiSDN7HujxPPpbzskSFaUzGXyeYy+lbeHk2HMG7mwu6blw1ZrxyuTakxPc1+ftCpBWXIXR2oyG8pQwa9XTqkXrrcjSflH9OTk9GfIxn+OL07JvhcDg6OeWz4W5Xfd1OLugnHgU8LYSCylKzSVGac9uigmnoZ1edADlLVyiDaA+D+f3A1/XtbqAvcs8Q823ClIyUBqlV5oVAkJQ03GpDFMYtElg4CyshSKLSYIrh76f57/O8NznedSBelGgGBq2w1LIAN07MeeJCR1G2VQyMLycRJLoUmIaXvWDbln/aNS3PV2JT1DiOP1NWOFgipFp95eBe6SWIdvDq7fJ1ypcL0Ibml8MWHtiBDHb7QosuNFHWp/Q2jRH23I5IbZFqPTACpzOkWIClcLnfLJRwgktY9SPhCCmfI089cPxIvE8CQLEtwoxTUSgrt8aw9xwcfRKysdnmoTHaXOiUGjz//GqD/Q6s0m/c1qf3TUarez8ZDps95Pe4zdpVvt+jeNPsuaR3ap2Idkxz+omgz/+XaS6VQ6O4pDim6dyz6dnIl9SkMsLVbPL+kZ2X4mekx7uGdOQZfdcIw+vVCmwr0OWaPomU2nrVucvZhB2FLyRHq3418LWecG8axkK3YrW40hrYSLHQA16KWGSGKxcLfbQYsybq05g6nrWN1j4yNrzeQ+lurXPoaPyNdZqvTM/DAoEORNYbjXWwFDtvvS7MvDup4+oS7rEG8k2a+IPH0UiIsOCyWsFQH7bofIDABorKepylNDgXD5iGfPIhyAgf4EBpquo5gjNcSG+Gkid4GAHGWdwjO4H24Le1rgxZZHCP9XcfYkb3T2Fwvf5s9bpztE3Uk0a0j6F3rVH2g3ArgG2FnG3f1EeRrG0oKQAQfRSoB+88hd54VOYJmCUQ3sFFwvITcAbBFI0Hpea6SzM88WkGCy5IRVuVpTbuLysHXNtK/LBe2rbHevNOSK8OwcG///mvQ+pFOEyXmAqbB6vjQwvIEZSwQCPmrfP5OBEJ+ZReECrgm8bKIs1Wcj6whOChyBSIlGzn6qg9z2cSqcT5ZS5t5IeFTDguYUmzrPPMrJYihVKnYfjVUmcCbQSo+Mx7aPhqK3GBktyf0qHPmXwmpHC1J8Irp4swQCW6KKXg1Pt5708Dgpb5AYsmaqGAw7ySsg6AiZez4EqhofIqRYLKekfuYrbkSY4w3uODy+Uy5v51rE121J61R79cXrx+M309oDPNGkta3wNFeqqTikbyLhesHZ56/Pg4HvneSVtXcLUhT/iW/DHIeqN2/Xc/hbc50eGDOyolF2oDtw7p/337gXwNWNxFLKcCMXnPHh8JaXpnZNPQ8m8Vmjp8MF9w4x3Ml5yuNvmKcU/ZmF0E/Qc3JABtl1VIzr06TvUhnDhPaLz86N7NGnb1dnrDIjZrv9gXvmYzw5cs8r8Tdss8PKP9nfha4dcfmeQqq3hG+wPdpp2LtqvIva8i7QNp1r1S9YaU/YISlKFfUm3vkW/J+X7G+rvV9vDmyQOrIhZ20y3eNU3zHx6ihac=
sidebar_class_name: "post api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create data policy</h1>

<MethodEndpoint method={"post"} path={"/config/policy"}></MethodEndpoint>



This endpoint creates a new data policy that can be reused as global parameter across all newly crearted data agremements.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An object of type Policy

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

A set consisting of the new Policy object created, together with the initial Revision object.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A policy governs data and DataAgreement in the realm of an organisation that is refered to as "data controller" (GDPR) and owner of referencing Agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"policy\": {\n    \"id\": \"65471222e8c7c3bb3c2c7701\",\n    \"name\": \"Default data policy\",\n    \"version\": \"1.0.0\",\n    \"url\": \"https://example.com/privacy-policy\",\n    \"jurisdiction\": \"EU\",\n    \"industrySector\": \"Healthcare\",\n    \"dataRetentionPeriodDays\": 365,\n    \"geographicRestriction\": \"EU\",\n    \"storageLocation\": \"EU\",\n    \"thirdPartyDataSharing\": true\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create webhook
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-create-webhook

---
id: config-create-webhook
title: "Create webhook"
description: "This endpoint creates a webhook. The webhook sends the events that you subscribe to, to an external IT system. The payload URL must start with `http://` or `https://`, and it must be unique for the organisation. Subscribe to a minimum of 1 event type."
sidebar_label: "Create webhook"
hide_title: true
hide_table_of_contents: true
api: eJztW9tyGzcS/RXUPCWpIXXxZROu41pH8iZM4sgVyfE6tkoEB80hIgwwATCkGJXe9kv20/ZLtrqBuZGUKTvJy0YvKg0GaHQ3+noGvE4ElBYy7kEkoxlXDtJEgMusLL00OhklZ3PpGGhRGqk9yyxwD45xtoTp3JjLITubQ/3AHGjhmJ8DgwVoj/9yz1amYq6aItUpMG9S5g3jmsGVB6u5YuMz5lbOQxGolXylDBfs1Y/fs6JynjnPrWdL6edsMve+HO3tTZix4cHhU8q4Fkz6MH8KrNLy1wrYzFhix9ica+k4CjVkpx1mGGeF1LKoCmZm7CAwzvyqhOE7/U4jPw7sQmYQpQOezeMs7lCMb87OXrKXJ6dnSM33+Q8CTY1YsblRwrFHbCZBCTdiEwFKLsCuxseTlE2iCsODlwU4z4uSHlYlTEi+ieCeTwLNOEzUIu0DlAAZaJQtOuK4oCN8H+j01jZnxsz0F8j8kP3TWJTuZHz88Kej8C6tV4Y1k65Wx4IOgRkyHK7YxHEtpubqxObxXdg8syBAe8kVi4dTWnCgPZFhFjJjxabuZa6j7mu9BYMgef41GH9tufaDU5lr7isLEzYHLsAGZS24qoBJxyb+yyeNcp+mTuZfPpnD1dNJypZzsMAm4RHnImVllmAz7oDN4YoLyGTBFfvmxbOjwek3zw4fPUaVTzokh09+cUYPogk8nbRMOsgseHYJq8BTLRlXS75yUUCc+O3pyQ+1DaWMK2eQNx2UZ7SvD5Tk4WWpZEaq27saLJfLwczYYlBZBTozAsRkyMY6+CHKkZJXCcB3QXdxpwn6ShFtYgozY4EcN5tDdhkEqHW7cTgFvwQ0v+ZkuPdQlJ7cr/UXktsS39owXnlTcC8zZsHbVUPUgiuNdoBe7yvHiFMybOmYKcEGO0HhD/f3JynTxuO/B9ExmvWtYbeqZ1KzTAG3zMOVH77TSZo0NMciGSWZ0TOZH1Gcex18MkkTC79W4PxXRqyS0XUSjwH/7R4AHj2OuWwOBcf/SovUvQSHT9HHaZlSJ7Nk9PaaSEuL8fdtEs/ilVVJWm9ytiohSZPWp59TaMUhEus7WCXnaYIWkYyS4L1JmnjpFQ4ESU7sq1L0JFqP8m0QDxqoop69iUGfvNWwiuj0TVjm2lhwbCLR0TEskMf3I0CIYG1kY3IWMgOEwFAM2dgzT6a0HrLZzJoimGsY/q2OObWbJ+marjuqHF3X2nHeSp1vlR6j+CnKSOEcnYR8xkIGchFZqjUUaXdjyx3zFCnhLjkqSRO44kVJZ1gvjyPDzBR7yIjbkzmGveSmby13ErgXSmLi2BAQk8AdYky6EbjQPzGoo8Nx5qTOFXQjjOYFiDb4kLy6KtAJNjwqTXZykJzfbHGRVg8bbrHFnTZV1EmewRq6OqotI0URH7Dcmqp0Q/asX05ExT5g3FoM83T2GJneU3f0fMvCrHJAhUY7JXBDcZQ0TKlKOo+kpHeBmT4dYSBMt1CYBTBRBZVGA3abHpRhFNX+Bdc8hwK0f92Gr6hWEmpDdUdhISualV1NEluuqRBNllU2JDiumdRCLqSouGI5uZ2xjQYiPymOcXfpMBoJUOAhZcIsNZmdsTFCoU6kZVivoGjSQ+F2O8bpWuXUMUuiFKOf1NJLKprT3njGdQZK0Xhkd8gVFhHdESHd5iCmwwu4KqVd1USDcJub1cJueRNWdNnor2jfnN/cpImQufRcveZKwZ2P9zgsYkta1T/a55T+uzUjo7Oj5E1W+fcYxkvQUgw/m0TzY9yGesRotarHyMqbGnSMh3tSgsanl0xqD3lMUhpAuFgXR5kCd50NpqCMzusa3SgBlh2Pj49MUbDSGm8yo5oipOavLVaRUjTZmcHTIzLSuQosczLUKB1e4Sqbc51Hb67pzWnfnWTDNCLbX98tlYefDRcP1lcjB42Kah5GbBILmAtcjam5fo5RrE7PXfoXPLvEF5kpoE3AC7ByJiNz6ZZVJWghdX5ngl1ZqR77/a66eXhmNgNLwoeCb+vrWhdbp7T/XtCh75xFwu6elEHpd88Ljr19GrKDbn0hQMtb5nhzCXqD8U1r7GwZz/GOs9ek3TF3XeieWXdNdbh4sGNWfWi3z9w0wTvOjRrA2SFacs9fcHsJvlQ8gzvHS+45K9p1d0uGvpO7a9SlSW4IwCA3TEiXKeMqC4znFkKyjS30H5b1OrwP8fmi3fWi2fUi7IqaCpnF8SnmmXbzqTEKuN7Y/TWKO/G2glhH1hVWp2ShM46Ki12mRO2dRLRhyI5hxivlqSqYEJJFRaUIwxHcuuk2TbvV0raNlQNBrZApysrD7ahDFxoIrUnbBNftcd2nklA2JEjpiXzTbPPKz9FdMulXdRHZVOXHhtRSOWA89h9mxlzJMzQSrVajnvkEf6M9phUVsTpiWdq0XX3TSaGSLmV56tRPFOtD3f0xB4kMgG3PkXLHil6dfX/KMqw1Z6EI7YsYoLMPPdybm/OP6GuHCdprtwuv2/SNrjpY9t02GCZdoqgU2iVgE+STh/v7fyaWICm+YuuNlf0HAQuN83bdZbtVYEcVO/r3oRC34Q7PbjmdaA592HYbahYgWao6Q2PZIEXEQoo1EJR+DYvYbHak2B0PXoV+XVIeoxqo3zb3m/bHn/OD2WH2QDyER7PH/G/Tz7MvxD4coH+FY/n4DXvYCFXJZqldnxd0447Mv2O3SOY9p1Hj/tLVp4BVPAa+5kNBYDMU4S7g7jVdAaUyq4IQwmcb/XWg1fmmEHtcs9TMZaYEEvVD4J67gTt/LgJzdAf05R4TucdE7jGRe0zkHhO5x0TuMZF7TOQeE7nHRJqSVZs+HLIKFf9HoRtNHVcrN+QnwzKuskrx9wEeEeQws20Yx5b+IF7F6H6Gx6fQwrVShj45Zc5QIoIsMNh83OeOPh533+HNij8YvOgViR+GXiAnbWu8uyc5O2I4/TZDF10roPJ68ubNmzeDFy8Gx8dn8/moKEbO/RxucXB/S50bUl/3IAyVmLFU67U8h/uHjwf7nw/2vzg72B8dHIwODn9OdmEsPUsCWzPfsoNZDXzouMJ1gfqrfn1FgJ471wTCfanfh9KcfJekSbBUdH2c8PAD0Zfu1mCtsUdGIHxC/x93dtuCgvR7iHZ1axVUuIHtHsDD/f2bLeS3WFJ7Zl/hh3ddVp6V3PICPFhUx6ZCcGLMFmtn0zgq7YyXNDBQa8G9aTAW6VghHX7UT3HCmum35naXe3u0QW0+7WUpXvRpwpV03qXNpZHuDb4mFKJiqBWSs7XekJCI9ctT5NRcSUoL69Zx8Be2jlca4Wdj5W9UkPRV8+gv7ThjHe+sRoehbdZ0FPJwZaVfESr7rJSUkd+eY/D0PHeoi9dt/CrAzw1ePiuNI7G5nyejZC9gonvLBjwNmzqiulZQQWEiT0maVAiDNaCVgMIMeCmHAasaSrO3OExu0nUap57nUue3kXHh9RZK563Ap3ju4bhqsdtSMAykicTdgsaSNMGrQAgFR5OrceU1oPjlmEqV5rtIB4VsvoBQ6ujRaeqT+s5VaWEmr0DEqBR4ZBP2iTaxyvGWS0VqwO8pn6YMhvlwjeyIxYVPVqayqJHBJayeTkKWQh/4sb0w+Ly2sh5o3wUsd8OLa+jiNjxwG9J3O1x1G3ZzfhsAsqODPL+9FfiogrlbLcd76Z3atnXhrcVe/ByEhjYzdbDiGQUrKLhUBHaWpbH+H40lt5Yov26H+i7QTt4IDM0i9sl///2fTzG/cHa6BCHdPPQlNfJAVc6iw3BTp5XWLCRdWh5HjMiBmg2cWYAFmeuIzftVGtejgjoXqvGKNxN9KAo3c0ZJwUojmIdsro0yuUSQFjSfkqlzpmHJFCxAEVyKQY6uxU6lwg+QSKS+r6tz+gqqJPbXwY1IPAs5tgrSaBcu/c0qpdBhhfTEZ8G1Djc1lcxAO/KI2vlLns2BHQ73N3S+XC6HnF4Pjc334lq39/346PkPp88HuOamBbHbc8CQIUxWFXXzmqQJRs9wXof7hw+HD4b0OQbDbsF1h59wa5Ytt3+26mS/+99H3P8+4v73Efe/j/g//n1ErN5wYK9UXGoMmVX40Boq1bfxVxNJ2u3K51jMjt4m19dT7uCVVTc3OPxrBZaK4TRZcEspjErjuoam4vaSsnz8SDqINxXISrcVP1jKhhXPCEZ979xuvY1RKUmTafxZR0G9RWL5Ei9v8GUySt4l7xLCRSmxUT+D49eJ4jqveI7zA12sN7A67Re8l1Twxn9QsvqVXnW4XK99gzD4F0XbuuQJprfvYPW0mR7e3LqgqbfDbDxGxCX/B9+0/50=
sidebar_class_name: "post api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create webhook</h1>

<MethodEndpoint method={"post"} path={"/config/webhook"}></MethodEndpoint>



This endpoint creates a webhook. The webhook sends the events that you subscribe to, to an external IT system. The payload URL must start with `http://` or `https://`, and it must be unique for the organisation. Subscribe to a minimum of 1 event type.

The service sends each event as an HTTP POST to the payload URL. The body holds 5 fields: `deliveryID`, `webhookID`, `timestamp`, `type` and `data`. The `type` field holds 1 of the subscribed event types, and the `data` field holds the event object. For an OID4VC event, `data` holds `organisationId`, an optional `sandboxOrgId`, and the credential or the presentation record.

The service signs each delivery with the `X-IGrant-Signature` header. The value is `t=<timestamp>,sig=<hex>`, where `<hex>` is the lowercase hexadecimal HMAC-SHA256 of `<timestamp>.<json-payload>` with the secret key. The service always signs the JSON payload, also when the content type is `application/x-www-form-urlencoded`. In that case, URL decode the `payload` form field before you check the signature.

The service makes 1 delivery attempt for each event. There is no automatic retry.

The response status code of this operation is `200`, not `201`. The response holds the secret key in clear text.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The webhook configuration.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The webhook configuration to create or to update. The service ignores `id`, `orgId`, `sandboxOrgId` and `timestamp` if you send them. It takes the organisation from the `organizationId` header.

</div><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTPS or HTTP URL that receives the webhook payload. The value must start with `http://` or `https://` and must be unique for the organisation.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"The content type of the webhook payload. For `application/x-www-form-urlencoded`, the JSON payload is sent in a single form field named `payload`.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook does not receive event deliveries. Optional. Defaults to `false`.","default":false}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key used to compute the `X-IGrant-Signature` HMAC-SHA256 header for each delivery. The receiver uses it to check the authenticity of the payload. Do not use a value of spaces only: the service accepts it but then sends no signature header."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the server does not verify the TLS certificate of the payload URL. Optional. Defaults to `false`.","default":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The server sends this error if a mandatory field is missing, if the payload URL does not start with `http://` or `https://`, if a webhook with the same payload URL exists, if you subscribe to no event type, or if an event type or a content type is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete data agreement
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-delete-agreement

---
id: config-delete-agreement
title: "Delete data agreement"
description: "This endpoint allows the admin to delete all revisions of a chosen data agreement defined earlier in an organisation."
sidebar_label: "Delete data agreement"
hide_title: true
hide_table_of_contents: true
api: eJzlWNtuGzkS/ZUCX8YetNqSfElGGAzWE3t2NBkkQexggY0NpESW1ByzyQ7JlqwYetsv2U/bL1kUu3VXFg7mYYHdPDitbpJ1eKrqsIpPQlGQXldROysG4rbQAciqymkbAY1xswCxIEBVagvRgSJDkfgTeJrqoJ0N4MaAIAsXyILCiIATT1SSjaBorC0pIPRGkwdtAS04P0GrA7LZXGTCVeTTj6ESAyGdHevJVbJ0uVxJZKJCjyVF8kEMPj7tQP9g9eeaYHiV0Fhwoz9I8izNXyuMhciExZLEQDDG1cJDJTLh6XOtPSkxiL6mTARZUIli8CTivOIpIXptJ2KxuOfBoXI2UODv/W6X/5PORkY5eBJYVUbLtJ2TPwKDe9pfbwUv6mj4xfuWTZHtbOwSvp+QJa/l9yvKoXSKDEisYu2pcVEgr9HoQApaMI1j7Bwa698FCNpODIF3sxySr3WaayHUCQ97uHcM0s+r6CYeq0JLCHpike0AWgX9Y8Ba6ajtJL+zd/YyaEUw9q5MKO5EqKWkEJy/EyCdqUubAa6Rh8LVRsGIGCXP9aTAOPlAiiPhsWNd7GjbYR+NMJAYjNEE2nTRR6HZZ82u3rBLs5bP5Mvm8Qoj8iDy+gsa/YXUjcUqFC62b5uXv2IokhdKChHLStxnovIcj1E3DtZqPwwyMXa+xCgGQmSCHrGskhMvzs9e9Pr9Pr2UL+TpaHQq+/Liotvbc+rS2zC8EoutrTzb1lYQ7xl4x4S7Opg5uyQtfydgVEcYOw+RZGG1RE5iDJzCG25BY0itZjGou2TZ1iVzv2u3ckbLOQPY/PCepPNK3C82XPOnaHx59kN/b5e3BcG71xzmHHuujeECI8wwbGSEWGyFxbOBPOV5vjhoddOW3jXFGUPqbzoWro5v97c/cs4Q2q+ZbQN+2+jQKhaVlOwYYUlq2qihcYSRQfvA+nog5GHGSS7RyNogpy5sZ0C+Xq/EOatBoM812WjmHBJjnUJC2zzt7kBK/UlGl+lAqjk/jljFMMBvN2/fHPMDgtIy5nBZVWaeXsMrtC7FsP6StBZuOF6JR1fkYXh9+wu8/+UVvHzx8jwHGMYki6htSKcXB8xYk1FhGT5NvAM9SqoihLpRsaHKdsja/L0kIL+zS2o2dOXZrGBv1Jen6ozOxxf/6XmPODbD+A/5/Ojm18tO75hxreXt2ZD63f5Zp9vr9M5ve93BaXfQ7f59PxOW6zKGFGNLnecYK7CqyJLKmfy1wAxv3sLLi24PPty+YncTMDyGiXUsnOdN/DzneJ9qVaNpUmc/G5qvrKDZ7im9vdTbWJD/Jv05Oz/rYZ8u6MX5xQ/dbrd3do6jbvdA3I7Jk5XEByfatkyqA/kmSwsMID1hJAWRz9slPSlYlgdlA+2xM37opHN9uxrYhbxDxHh7YRYj68A4O0kgCAyLRlwNyMAzaAasY4AVCEZUeVLU/Py2+H1e9MrT/QDCsiLf8RR04JIF0Ec9RhmbiqJqTzHw6TjJQLpKk2o+7iTbNv6bZdHy/E1sQs3z/E9ihaMZgXL2uwgP1s1ANyKzOyqdU+m4AOfBungsFvxv1/jVdll9xKWRAi4gbt5C/8X5Rfe4rc3V0qfj2hg+lwtClWrmJ172rKlXt1cfIat7VUdY1dgHJva+qdDdrNfIe+dfOcWVWnq+2jB/n+0VxdsV2Hr22pfaRpoklCsHnnW7iwPLH/D/2uc/H9j4Qf4/2LWiHKDm7P+YmvcUXO0lcfTC2NV2n6Dzb2yS/rcIGtpI3qJhxZqSh2Rmh6NUPMja6zhPze1lpV8TP95zxxlxwj1vowLr4vs+EyXFwnHT3CR/6pJjIQbipOmiT7ie6qyE4+Rpp/ddNN3Q9HBTfUWla1GLTNSej6YixioMTk4Ula6Dlc71xKONuXYn075YZLtr3ESctBXnoWVC8/nASvdrSprSLjl0SczKM9i8aBv9htN1q3/ZZm2KtP3e+t0QHmgOnNtkYxuQ3BsTTNHUtKwNP22t8wkaM1DWIXJJU3ka60dSMNOxgE8NRvgER9ZxeVMQRI/aJBoqlHScAeWTfGfZAbQTf5y72jMjnQea//QpFxwe2o7dMolQpiSiEjVzGeqqcj7+ZcXfev/6r+tX28SvB+8F7GoSHP3rH/885poC4WZGSoeiKdDpURZoJ82VwJS8HrfcJTdryZS4KXf3qfirA3GPZMad4KbkSU8saMWMx3nWzseRIS6W0ms0IUtF/0RHNDDjnjQmY8EZraByqmlinXETTSEDsjhKBCNYmoGhKRn2Hid7UgQcaaPjPC2CdXRl0whJV1ZGI9dwyXlpe54mqVHizphvrCCdpc3FR8JZorXkuUYwWpINSV6WIVehLAj6eXeP89lslmP6nDs/OWnnhpPfh6+u39xcd3jOYn0ntPYDB6pysuakXYYy52zjL67V89O8l2ogF2KJdgNPc5G2czG3mwob4vxfuwVsEzrSYzypDOpUJScCn1pV+9jeDba3DZ3N7Qx2b/XuM1G4EHnW0xPXSx+8WSz49eeafNLWTEzRp8hrxE8HflaHW/BNio7etyfUMXz14vHgdpaiZVmxksQ0ZegDa9rexeSC709aSWOAzahLyR3qxvy9w3SxeTJcXf9+fXstmp5oWzgfknC2D2zgILxdDW1Q8F9W+4NTfuSAfU3zn1bDmy9fnbDS7WY0k3W/WCz+DaH40Us=
sidebar_class_name: "delete api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete data agreement</h1>

<MethodEndpoint method={"delete"} path={"/config/data-agreement/{dataAgreementId}"}></MethodEndpoint>



This endpoint allows the admin to delete all revisions of a chosen data agreement defined earlier in an organisation.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) deleted successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"65471222e8c7c3bb3c2c6601\",\n  \"schemaName\": \"dataAgreement\",\n  \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n  \"objectData\": \"{...}\",\n  \"signedWithoutObjectId\": false,\n  \"serizalizedSnapshot\": \"{...}\",\n  \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n  \"timestamp\": \"2024-01-15T10:30:00Z\",\n  \"authorizedByIndividualId\": \"string\",\n  \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n  \"successorId\": \"string\",\n  \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n  \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete data policy
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-delete-policy

---
id: config-delete-policy
title: "Delete data policy"
description: "This endpoint is used to delete an existing data policy."
sidebar_label: "Delete data policy"
hide_title: true
hide_table_of_contents: true
api: eJzlWNtuGzkS/ZUCX8YetNqSfElGGAzWE3t2tBkkQexggY0NpESW1ByzyQ7JlqwYetsv2U/bL1kUu3VXFg7ytpsHp9VNsg5PVR1W8UkoCtLrKmpnxUDcFjoAWVU5bSPoAHUgBdGBIkORAC3Qow5R2wkojAiVM1rOc5EJV5FHXmaoxEBIZ8d6cpVmvUtjRCYq9FhSJB/E4OPTjukPVn+uCYZX4MZsx43+JBlFJjR/rTAWIhMWS+JfacWhEpnw9LnWnpQYRF9TJoIsqEQxeBJxXvHYEL22E7FY3PPgUDkbKPD3frfL/0lnI9nIj1hVRsu0iZM/A6N62l9vhSvqaPjFe5rqwHvIdnZ0CT9OyJLX8kfw7SAonSIDEqtYewoQC4JAXqPRzHQLJjQczKGx/kOAoO3EEHg3yyE5Sae5FkKd8LCPescg/byKbuKxKrSEoCcW2Q6gVdA/BqyVZt/ld/bOXgatCMbelQnFnQi1lBSC83cCpDN1aTPANfJQuNooGBGj5LmeFBgnH0ix/x871sWOth2OixEGEoMxmkCbLvooNPus2dUb9mXW8pl82TxeYUQeRF5/QaO/kLqxWIXCxfZt8/J3DEXyQkkhYlmJ+0xUnqMw6sbBWu2HQSbGzpcYxUCITNAjllVy4sX52Ytev9+nl/KFPB2NTmVfXlx0e3tOXXobhldisbWVZ9tigi4nnqjkuNs18I4Jd3Uwc3ZJWv5OwKiOMHYeIsnCaokGPGFwNmy6BY0htZrFoO6SZVuXzP2u3WqZl1sf3pN0Xon7xYZrvovGl2c/9fd2eVsQvHvNYc6x59oYLjDCDMNGRojFVlg8G8hTnueLg1Y3beldU5wxpP6uY+Hq+HZ/+yPnDKH9mtk24LeNDq1iUUnJjhGWpKaNGhpHGBm0D6AtHAh5mHGSSzSyNphkdzsD8vV6Jc5ZDQJ9rslGM+eQGOsUEtrmaXcHUuo7GV2mA6nmPDhiFcMAf7t5++aYHxCUljGHy6oy8/QaXqF1KYb1l6S1cMPxSjy6Ig/D69vf4P1vr+Dli5fnOcAwJllEbQOgMSlgxpqMCsvwaeId6FFSFSHUjYoNVbZD1ubvJQH5nV1Ss6Erz2YFe6O+PFVndD6++G/Pe8SxGcZ/yOdHN79fdnrHjGstb8+G1O/2zzrdXqd3ftvrDk67g273H/uZsFyXMaQYW+o8x1iBVUWWVM7krwVmePMWXl50e/Dh9hW7m4DhMUysY+E8b+LXOcf7VKsaTZM6+9nQfGUFzXZP6e2l3saC/Dfpz9n5WQ/7dEEvzi9+6na7vbNzHHW7B+J2TJ6sJD440QKqUluudnyTpQUGkJ4wcvnD5+2SnhQsy4OygfbYGT900rm+XQ3sQt4hYry9MIuRdWCcnSQQBIZFI64GZOAZNAPWMcAKBCOqPClqfn5b/D4veuXpfgBhWZHveAo6cMkC6KMeo4xNRVG1pxj4dJxkIF2lSTUfd5JtG//Nsmh5/iY2oeZ5/p1Y4WhGoJz9IcKDdTPQjcjsjkrnVDouwHmwLh6LBf/bNX61LpPbKlotfTeujeHztyBUqSh+4ulnTV26vcoIWcWrOsKqiD4wsfdNBe1mXUbeO//KKa7I0vPVhvn7bK/43a601rPXPtM20iShXDnqrNtdHFj+gJ/Xvv31wMYP8vzBrpXjADVn/8fUvKfgai+JoxTGrrb7BJ1/YzP0v0XQ0EbyFg0r05Q8JDM7HKUiQdZex3nqXi8r/Zr48Z47y4gTbmqbbG8b3vtMlBQLx/1wk/mpB46FGIiTpkE+aYTh5GnZ0S6aHmd6uEe+otK1GEUmas8HThFjFQYnJ4pK18FK53ri0cZcu5NpXyyy3TVuIk7aOvLQMqH5fGCl+zUBTcGW3LekYeUHbF60fXvD4Lpzv2xzNMXVfsf8bggPNAfOZLKxDT/ueAmmaGpaVnyfttb5BI0ZKOsQuVCpPI31IymY6VjApwYjfIIj67hoKQiiR20SDRVKOs6A8km+s+wA2ok/z13tmZHOA81/+ZQLDgZtx26ZMihTylCJmrkMdVU5H/+y4m+9f/3X9att4teD98JzNQmO/v3Pfx1zpYBwMyOlQ9GU3fQoC7STptGfktfjlrvkZi2ZEjflnj2VdHUg7nzMuBPclDzpiQWtmPE4z9r5ODLEJVB6jSZkqZSf6IgGZtxpxmQsOKMVVE41rakzbqIpZEAWR4lgBEszMDQlw97j1E75jyNtdJynRbCOrmzaG+nKymjkyiw5L23P0yS1P9zvagsI6eRsrjMSzhKtJc8nv9GSbEhisgy5CmVB0M+7e5zPZrMc0+fc+clJOzec/DF8df3m5rrDcxbrm561HzhQlZM1N8zLUOacbfzFFXh+mvdSZeNCLNFu4GkuxTavz3bzYEOHv+dGrk3ISI/xpDKoU+2aCHhqZehje0+3eRkwWF2u3WeicCHysKcnvtH54M1iwa8/1+ST9GViij6FSqNWOvCzOtwJb27r6H17gBzDVy/+DuJfqoxlrEkTmmrwgUVofTG44PuLVnwYWfP5UnKHuDFx75BbbIr21fUf17fXoulJtiXuIUlc+8AGDuLaVbsGBf9lXT445WcOrdc0/2U1vPny1QkrhW1GM0v3i8XiP765iX8=
sidebar_class_name: "delete api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete data policy</h1>

<MethodEndpoint method={"delete"} path={"/config/policy/{policyId}"}></MethodEndpoint>



This endpoint is used to delete an existing data policy.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"policyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data policy deleted successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"65471222e8c7c3bb3c2c6601\",\n  \"schemaName\": \"dataAgreement\",\n  \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n  \"objectData\": \"{...}\",\n  \"signedWithoutObjectId\": false,\n  \"serizalizedSnapshot\": \"{...}\",\n  \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n  \"timestamp\": \"2024-01-15T10:30:00Z\",\n  \"authorizedByIndividualId\": \"string\",\n  \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n  \"successorId\": \"string\",\n  \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n  \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete webhook
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-delete-webhook

---
id: config-delete-webhook
title: "Delete webhook"
description: "This endpoint deletes a webhook. The server disables the webhook and marks it as deleted. After the delete, the webhook sends no more events, and the other webhook endpoints do not find it. The response contains the webhook in its final state."
sidebar_label: "Delete webhook"
hide_title: true
hide_table_of_contents: true
api: eJzlWVtzG7cV/isYPMWZ5ZK6xHXYTKauqMlwbNcZS47r2BoRXBxyEWKBNYAlxWr41l/Sn9Zf0jkA9kZSlZLmqXmxqd1z+XDOwbntPeVQGsiYA07HCyYtJJSDzYwondCKjul1LiwBxUstlCMcJDiwhJENzHOtVym5zoFYMGswhAvL5hIscTnUBIQpTgpmVpYIR5iNInhKXi4cGE8aHiU9NguKW6I0KbQBAmtQziZeGFJpl4NpaGt4lnBNlHZkIRQnwgVwBmyplQWSaeWYUH14QhHhLHIwSaxjDlKaUF2CYWiBKadjmmm1EMuJR/kh8NGElsywAhwYS8ef7g/MBmQ6IXrRU+Z0PCvqgDtWlBLomD5/wU4Wp9kZP4dvFs/Zn+Yvsm/5CE5oQgUKK5nLaUIVK5A6CptymlADXyph0HnOVJBQm+VQMDq+p25bIrF1Rqgl3SXUuq1XZoXXurtB7mAZiwynoxH+h0YC5fAnK0spMm+G4S8Wj3XfUVAaNJITgTuC8mxSvl14k7ToPlGBcLVZetgl20rN+HsjaVJrvEbACbXVHO04B37pfU4TGsMKGS1kBtwr2OLvlSivrPwJjFhEmDShThRgHStKepPURtDzXyBz/qXzNmid2Pfay8ZTweVVCILajdosmRLWP2sDX2RAmNywrY1BC2swW7IQIHngFJYECAmBuwxKR2aWKT7Xd2/RIDOMhr45BT/04T7Y90p8qYAIDsqJhQCzF21PjLFd7ZbfrrBrF+Jy5oje9K9Z6iOwc+b/QVsU81+8Edzg7R69oOSWLLRp81aAOQep1dLivWSNXA6l1NsClEtJGxAGMhBrsEEW4gg5CVFhAtEbRWymS/BH7QT44wd99zqgaVR0U0aU1Hdm7lxpx8NhfJJmuhgitR2KpWHKIYTutXoUw0UgJki1n7S6CFRV4GU+yAxJ79HdYLPZDBbaFIPKSFCZ5sDpze7I7W6RHVzSY5ngIMd6J3jYNhixi7w2aIJZ/owsja5Ki04thBJFVeBJT+rjnhFmDF7iorKO5FpywvqEra5+uBlYVBaLouqQBDTC+noklFchhXV1vHgwfTlcQyA3UOg1EF4FkwJZM1mBPUwTGWZv5d4wxZaAEfuhTcPRrP5Qx/yNjKRoOLuW9LBsG+FZVhmyyUHhEYXiYi14xSRZhgthGgtEPAk+Y3Zl24KXEK43CuMI31Ulx2O5HIQhnDmGRxMOCvt4qF41YRHwdcLSSwqyU6GEE76vSXrPM6YykKGaRLgpk1Jvek+w5Bw8ZJXTt3BXCrOthcZqfqCsPuyRN4GjC6PP0b652e2w+C2FY/IDkxKe7N5JYCIbz9V37aWvTm+nk/OfLuIb7zufLn1U/tkH60yXoARPv57F8CPMQEj3mAHjMx/lTEV5U3Tu2xIU/vUjEcrBMpZQBcBDYJFZPFNA11EQ0jEGjVcjORgymU4udFGQ0minMy3Tz+qzuu7gywz4EsEkSoohu9DoPS9GWFuBIVZwn9k6WOEuy5laxttcy8u93kfFBjIvts9fGsBoCWXp63R9ts+NCBoT1RjGZIbdElh3i9yzpP07ZjE+893vrCv/lmUrfJHpAsjC6MJDW/uOKIJLjnCVoLhQyycL7J71s/pdruqh8/RiAcYfPvTfR1/XtjhK0v689U5/lMof9nEi7Ngep4tzzVEyhIPX+paDEg/QOL0CdQD8MBo7KqMfn0i9d9pHaPcP3Qvrbqim67NHqGqnPUx5GIJPpI0WQOqQLZljb5hZgSsly+DJ+ZI55ofUyPe0Yug6tTszwFwohqHQ4IyMaHAozqS2lQHClgZCsTWQacN/v6rXwZ7i37et1ttG623QipYKlSWOVa3yudYSmDrQ/gGPO8MRc5Yc7bBwUA824yAFVpjQ8Tfj2uMH9KRkBdu2j6uNG+qTJhmTWSVj50Bmfx9Mf8Bud3Alloq5ysCM5MB4GBWAZXmL5qH5wFce7M8yCcwQB3e+WwsjXHvKMCcnxGpfiCALAJvVArNkq6veuxVEGxwZU3+DxQ+aRJ/lwyRy/fqKZNgVLkK7GDva2LiT9+9eeyTtaPz4THJ9QZD8oUDn3Sjw7fXs48ePHwdv3gwmk+s8HxfF2NqfZzh0Fcw90OeG0td1hPYtZmzVeiPP6ej0+WD0YjD69vpkND45GZ+c/kx3O1xjHE4Fze5pb8XU9B8h8mdxPBS2HuCDxVOK96O7vajXGwc7hXCTegDevqIJDXGIFxsJzkcnv2q30lUNxmhzoTkuR/zvSUfbkR1Hf0JouVuf+7YMTNe856PR7oj4I3HSeuSvjBOhysqRZhOG5jg0yHvFKpdrI/7hC8q+ac7/wKZ5B1ZXJoOwtdSV4iFEexuVnPn8Wgf1RrjcxzSOX4pMJ37c6u002y3rgb2/+ZVrvv8ve0+VA+M3vWFj7dXs2SjUrcoIt/VbzJel8BXs0w0mG8eWuO9tVog3CS3A5Rr3xMHofr/pcjqmw7BFHEa/DO+b1e3O7zIRwrHl8QQKHRHShFa4RGpWPhwKPWClSMOmJxV6uD6lu2RfxpVjS6GWD4mx4fURSTft8a8wCoLzaiO0jVR4EDfUwX7tjvplvPD1VnZvzfrj1Bd6TAvYcGadHV6sA6GCzXpymuruNzRzIKWBhbgDHq7ELGAkM/KV0rFHcIYJ6c1QsgyeJQTSZbondkwi43dbXRm0yGAF2+9jFRBqoesLwzJ/YaBgQvoFVVlq4/7S2K89v/ihfdQ3fEt8EJwNE/nq3//81zNflsjVBriweegl62nRD27rTkfR1NbS6LXAvp5M41xvQS4GVq/BgFiquE912yTyYyEkbeeP31gI768PUJnVUnBSak4cZLnSUi8FLtZAsbk3MCMKNkTCGqRfceFF819R5kIKt/VCcIFSMIfkmS5KKXAmCs7zxzOwxPZOaGWxpWBkUUmJYcKF8zgLphQYTGpSZKCsTyV1yJUsy4GcpqMDm282m5T516k2y2HktcPX04vLv11dDpBn1y4eWz9goHKdVUU9cNCE4p0N/jodnZ6nZ6lfoZfauoKpDp7wuajOyft3oJOB/6Cf2GIewY57WEomFJqxCgvzkD8/xQ9vNKGtFcft56+bhObaOiS8v58zC++N3O3w8ZcKjM/YCV0z42M8pNlm5Dn2rbPrk6/exbr3jDzhU97Rs9SJUmGW9GmNjilN6ArzaOcr3g4X4zGBIsjw/qWfwDucB2V61y09k8vXl9eXuIev0HTdNL3yaTr+QAVHge1n7IAC/8XacpTlO7wer2D7fUMe3jzI0FSJQI1mwln0P+F+z/I=
sidebar_class_name: "delete api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete webhook</h1>

<MethodEndpoint method={"delete"} path={"/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint deletes a webhook. The server disables the webhook and marks it as deleted. After the delete, the webhook sends no more events, and the other webhook endpoints do not find it. The response contains the webhook in its final state.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to delete.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List data agreement revisions
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-list-agreement-revisions

---
id: config-list-agreement-revisions
title: "List data agreement revisions"
description: "This endpoint lists all revisions of a data agreement defined earlier in an organisation."
sidebar_label: "List data agreement revisions"
hide_title: true
hide_table_of_contents: true
api: eJztXN1yG7eSfpWuubGUGlKUbMkO69SppS07puPYXEmOa2O5YnCmSSLCABMAI4px6e48yT7aPslWA5hfjmTJdvbi1ObCochBowH079eN+RylaBLNc8uVjMbR2YobQJnmiksLghtrgAkBGi+54UoaUAtgkDLLgC01YobSQooLLjEFZFpw1MAlMAlKL5nkhhHpYRRHKkft/pim0ThKlFzw5Wtu7KSkc1JOEsVRzjTL0KI20fjD5w6X7yT/s0CYHjtuJKj5H5jYKI44/Zozu4riSLIMo3FErFYzTNMojjT+WXCNaTS2usA4MskKMxaNP0d2k9MQYzWXy+j6Ou5O/KbI5qhpVo2J0qkBq8Bc8BwWSkPOllz65cIEJC6Z5ZcISkMhNbKUzQXCJRMFwoIJYWDOkgui8Gn0aVhy/2eBelOzrxYLg7bF9YIJ08c2lxaXqKM4SnHBCmGj8SiOMi55VmTReOTWE8gKnnHbnbK91l/YFQ0E2bdmjbbQEnJ0q8bh1zK4P7q+/khjTa6kQUNPH4xG9L9ESYvS0keW54Inbmf3/jDE3ecG9VyTZFnuR7fOuzF5JSOWW0FfHLce7K5+IhvyTawwLg3YFYLJMeGLwI5XB8PlUiDkhc6VQbArZiFhEuZIQw1KiylYNQSYQGta4AYKyS9RGyaAybRvGMw38EPG5OYH4DLllzwtmCBetCqWK2BtkifukIbnMoqjq4FUdsDlgDZlzgxWZ1Mf1ocosE1K5z8dN3YidueglRCo32nR+vsNyVIc5UrwhORHsPWiEE+Z4aTBGdqVSt8u3jnSLCFdiOJoofQSrSVdoCF8gckmERh9jDsHydNtlXTDM2ajcRTFEV6xLHdneXT46PH+wcEBPkkeJw/n84fJQfLk0Y8HW8caXccR7Tb3QnQ36vvD0XC0RepshRBIkRRYspxt2bAK1iue0BFpTJDnTpJoDkN81Bs57V1qezpv7EgA63FtKnQ8XyTz7uQ10XEGvB4KOxnbkNypjFuSOr4AqfxTXF4qcYnpbns2d/hfnI6e+pb5gmyNu4Z45r6HQqaowya7A2hrl1mR75ojLNUlaonpEOD9CiUkGpnlcrnlymK3w4JZNBb85KVKFsZr44IL4Z4KRsxb9Bic+jZ9HrA049INTzHhKdLoZMXkEoFbcpKOStuVCrxE4bX3JsM1K/XtbuotvZYWWnx/HXv8eLTfq2PyBunoJ30cdtLtRWVO+iWJ9iw88v10+demHpf0YYd7M75QQqi1N/6YXaIGT9tJaNGvdf2zr6zNzXhvL3wzTFS2l2t+yZLN4IZ1z1BnTJJokOoy25T2S9Sbtg1CmLWElsKOGMxKFSIFqSx9x2g1XpaDNJJ2gOUZ0oL+KDQ3KU/svfb1+bstzl81CV1TrJEWxurNKSZW6buTfolM2FXCNG4bxUASjKd5HTv/f4IUOXAlZ6i5So/ZxvSGIb3zPTw67E5DVoVCHk+Uoh6uUlLglChfx9ES1VKzfMWTE6TVfPvm/VRRBN0geR1HxirNlvhaeS/zTbOcelogSmLXcWRXXKczpu2Gln26Yo5oPctcKYFM3jSNj6m3sgqdQk40vY6bQPX6OpzYxFrN54XF5kExrRkpBLeYue+ZEG8XLh/o2sae82IVyTJ+a7tnl8rgFUus2MCaQjZOTwqBicV0eF/72uTg+8cyhz12tr1KmB7f3/C+2ea9bWkr8rHLcLg0lskE4dxNdB5RcnMesSWeO7PfInRXJl4UQoBsTFpHudtrrv/aYtEpB0rDLb/kdnN3kQ2H2lGNmlIVwLSmSpjFpdKbuy90htoo2bOqZ4FU/0QmUfk9zpRM/raiEw0oxdadZXcilx529aotxg1LdKue3q6dlPP7dLJB7TZtazORaEyPcdEfM9/gQR4ev9//5d373zZPL2aHr396pM/+6+Tl+OH42evxk9G4zEa3jkVjSiafCY9wcCd2Xs98+vkdmDgYP6O1OauE8HYBJ7jkxnqkZHzUG66cuskdJ+6/j13V+y4W8Ny5gzI7vHOoXw647s0nv0imo+ENas308s67vi19jgrMiUxlQqrwe1Bm3rAHApdM/K7mgi99PL/nMxiW0K+X3DLxO8USJMewB3kxFzz53TJz4QdzyzNmsXqG+JKExHyIwiSUAHcmKRNs5hSnPYnL0KtJ/OCtSUgWmqn31+/UL44K7VFhEAYgyU7vObvxu1GFTrD8qyAA5HeD+pInWC+TBnj3Hp6Pwl/t55305pwdM/st7J75ZApBySpGRjieTSegMVfaSfcSJYGQmAJbWNQEnsymkyhwcFpkGdObOyXSNN27EwG5Vpc8pVyyMZ2hbMbPamIwniygTVrY0CVqvuCYEsDD5AbKM0QfK5G9I0vDl5LZQru9uRosLgaZSlGQGah+2TIQ5S8OnyrsSmlOex5iMLXoJMo71QADITNPVsxhuiFNTZhxxLJCWJ4LhIots3trttpk8o54FNsI5XyYaYz1m+UNl5fMzpezaljPty+ZWXV+IcYwfbpxvGZoLMvy7x+5HfZFbm/dJlVbnTND2IJDg+cbMCpDmMymFQ5vYM3tShWWsG6ews7s590YUpTKerljls5oA0wjMDiPUs0W9jyKgQ9xCAxqcbDBylMquEELlEzUh1wei4cypNgAXrkSAP2uGQVEQ2fXw1bfeWc+D4fD614VWnDJBASCFXvGnU3sjLHVReIU1gCDV6dv34BBzZkoURa1gAVHkRr43HPwYxgOhzHcIBI9v3rZ6vlhQl6aJbbnp1KUen56tTYvkaWoY6ikLDzmF/neH60XiRNcoEaZYHjEa9PZJm9/0X7seginYUda20Sp9xCm3sVVqtS2gnNcKBIaubErkiXa+36R2CGZWDnqTvws4Wj0RIelEmxogHsLrTKPq4RjnhfWwWh+GmeJ10ynZrhl7+4mXrh5tZr/lPC3/NWL356fnP3n6asfh8Ph7WaxZGbFzMrDfp54GRTUO1avKIRP3mQjtyvUPcJDSVGvDATEqmvH7p7BpweHh/s/Vss4GB1sB4cTWKMQgwup1hI8wdpWeMfo4wNXfDAEiv7KBE89jmnGcPb0eAiuEJjx5cpBRniVM5li6gwRmCInz4Zpa5WBqqGxqLE0bgxcBYoJMOj2th4dBoDEBI1hejPsbtDs+xiaKTlWyYTYNETf1DrTgdBSD/cEgXZnXSuit40dmR84ebhyYZuDlWVNP4QGvMy4jNPOG1bq/NSdV8v25wfJw/QRHi6O+uS9d92J3uS2ApdI+st1+9IkFZywssDOg9Q/qkWfKe0upjSV3xDNTdqyxQLF0iwRlVB7S5ikOMUfSQw8Y0uMG9qLNunyV7n+O/OX8nR8gZvxX0e/XCz6tvopJqxwnhO4SxoXHPUD8pyeoFMQttlCXJ3l8VaZgUQPyzoTHJxhY7x3826YUyS+lFwuhzBth2isc8TVVsQeNXbesjRqVWJIQUfNuUMIhFIXJL1FXlm0TRno+kQELnDTtJdViNnDlFRycBfGkhZfDNwjTDRQoQfGwUUmJiTWISqhSB0DZowLYGmq0Rg0MAh7ycBIlpuVsn5b51z6Qnbb0n+nHQ6mz/r4Zok619ROsQVvPTCtfXSNE+4gaCITAwOrLlDWDrQwTqimx2DQGNdX0Svak3tkyLehbSeTF2fwYvr89fEYToPv81VwjcJjCCuewxztGkM40Mw2Ghsr07B2P1UjQyv9cKJkglqa4Hu4oTnwkknrhPFZyMt9fdsMYaaM4VVHhRnDeWMp5xHsUSCMlF9bPI+2Nqp2yt9gpISzr67LI8jStntvx4Nk4N1udA8tyM+SaDF49f606aC8cYOdkxfPHh/uH7rCU5203HkBB6ODR4PR/mD/8Gx/NH44Go9Gv21H5SXdUgMCZ0mhNUqCihrKyo18YJ3KV7WzcJxGAbcPfKZB1FAPcq3Uogzxbop8vxG2ncrUIWnG63nXUa+ZAYELC3PB5EXpTXpCATeanva8Etd1DHAfMNa3NN0KsnssEVxa3892SAOpheTXStqrsylh+HKy86gBNTU4qCPrj9Vy+vb9K9Lco6OeNHcCZpNlSCBvZS9gz+e5VXhVKk4jwurs/RDeo0ttawn8ozDW75co7YwPu5QLyWu7s8M8kLFLO1Q9BmWnGex4OxQAGVb1uQUrH2yOb3yKybk3OgVClRhtsjv0lazQ5HJnCd62KFvdQZ6ksxgS132tPqbqGaKmBi+qzSab78WNn630bWRZKZpcu3aKsE/cIxWpZmsZU6TLrfEQgjvpgDtU4b6z66xIuWVzLrj18X+ispxZsuxkIEJl/stAewsZu7236/10NvZOJhixts1w2Hl9COUul06dcJAFal0nttwA1FxDTkKkCtMSJqfnpPMt1jzEXjdBfRF1dKw/83oAr8txYKwDPv00rRmG0H3MOF0qu1kyJqkAzEOmAGulLxZCrY0TuW7ngPEaSW0QTFqeQIaMVMr4o/Sy2r9/vqeltEoOoYr8YZMgeRCYWfaOAodTjwzfUmO6Wwm48FGIp9buzSF+t9tv7lv0DW0HcVQV0LcAxPsVZG/1E+nta/L1z/v1VvSUX6iV14SGinLm7jTi3s0HN05UkrppqtAec8zMaq6YTm8A5+85a6AKaUkWCi36WfDlNZWjnOT8tFk/+3Kp86yZ1oQe0rdEaTbt9AqmKilCLzURmJd51mQ2fVB3ZJvYez3KDQiGKDuqPXJG8nHqCi3frDmhvvPvoTI9i/l/XfnbdOXaFQjKTvjbOrBn9VNbRX7v4mZs2ZSEZgN5q1AfHCK1ogcooLm0fcqWlGVi2mlQuIneGT3caHx3qgPsknER+pYr2geHJXHi9WuIE9N0FcDleRLKzvy6H81FCPTll2m/6bBc9ue3dmN0HUcrZmYhTOkNEG9KqvjC41UPCK6qAp3uFE77/Sxv8Mp+/QwSr+wWdeowc1JWXUpxhbqbmk9KaTu5KRWbwA8OHeXJD3XI5pOxhOW+KNrJEsPdBH8bRm5CBvfAlDcBtFrXMIarlJjCp/BWwf7uTfCRM+oHuz4mJuDpXJ7LiaHW4QoCOo9MkVAArfR5RN0aRUaxds15Xa2gsJynSJGqUMnFfZrauCu/ulWFHjG/n+4Cjf9IfsLZc83/YoL/helpgNjCt/7LUHn9G0usvblnleE123Vu6lm/AfO9NYko1Uds6Egc+fPIV7bIT2KykjxhdHOKGWq1aRwLc5Wv8wZTrYy9O2/dGLydjjUy+fv0It35vgSVaGc/V8Y+yHCVn1caUeMjTiy+Q2G4ORfvTtUDILWW/92Qo2naAxn1iHzIg5lICuFvFrQ1YFjTozzSFHODfxYezJhjXQz1FdAelfrGHS3VAVMfEu2EUjGVonZ9zdiXiyd5Lja+fvyMSeVkmP/low7XdkZZoPMr0+dnL+DkxTN48vjJ4RBg2rgnxcIViVCYb+NceJVgbsEU3opNqUG9tVnNv8sNCN1oHbvyVZWy2z5vbdzLUB/rO/Od05eTwf7/HRjrZKy08yRjK5bn6BCyqW0YmOnpW3hyNNqHd2fPfEtU2dsfwPm/qPg1rcByrzrb2hCg+ulx3d5TXo1sk3pLHvte9ufR4aN9doBH+Pjw6MfRaLT/6JDNR9vF7JMmTMjKKzVUBvFaSg0JAffyQEwFd5KwlI7Ss9ZCiBrRwBfuXS3ahD2KBUJRXad5W6h8IPbYJjFM8FfFhA/QMUX/5/3k927SmzzcFiAPvWs0DoWzdSXVRRQNrMpDnInKeYlsdZStzf/p/ds0mqz21VDvxyvsrBFSRfUH6nUIgePWUzWOTBCwVHRrh4LHVnbc+CLEjf5mQk9Pbd0zV4XspG8Hjw+PRruNe9J0d5qQMn/8i0IIcuErV3KisIfoP/I3XdvTzBk5grxwZRV/B7pn4P69rsg2QzvUWulnKnUxNX1utud+3G7kawdr9ei+bKQ660cjyjK2yPeISi0eT3sW7tqbt+4wytr4bG3N4T1vD/97bU3Z8eEAQtTgpunskYc+Cu3uSHz4HE1y/jPSx490FduyJaFEURvFpdVfDVqQ1SDRRSr6DGr3wZzzgdKD8m6Gu/NBEVjPoyZByTRXpemwNMZleB8+RxfE5a1sxJErBjfZoVsN/QO32KpHe/ZuHlqxWQ+JaPOy0NAVLd2dffcmgnG05991sEeR16AyIHufO68muN7TjRcg+APse/vBMWYqnG+411lfLEwxUwOW8yFfaibtkKu9y4No+0UGp5awl+VNZIz/uYfSx1p4fDjoRL8UoRp09F+EFwx46atfajAJ6ltiP518fDZ1/RCk5NSPkoRXKpw1u5DI1H9q0fkEfhrIqDg4d55gwa/KprVPnkf4BDtSWd+cYTXjvoCYswR3Y8DhctghO4Yw8B8bVWjakcEFbv75aeicBrXnlOYmNDy5FhRSY9/n9h/V/tXr5z/VX7U3vn54S7WrQbDzP//6713fMXS6xpSblQ/q8Sp0F3X7C6pygW9WR+0CxsI47FIsBobakZAvy94luymbFtwrK5LqHozrSUn5kq4lwJryWOt73RQ1EOYq9YmvEmrJqYEFJZsLX3Kl6qW73OzQKTJTDr32hT9HhBVWZT55cmUh7m6aucMLHXnLIjSduLZRcE61LCAK6jiUEvXQvVYgQekvP5Qil7NkhXDgbtO093y9Xg+Z+3mo9HIvjDV7r6fPnr85fT6gMdc1jlSfAwlqiduXolxdSHbx/fDhcN9fYzc2Y7LBj7sE1bn73VT/zk26yp39rW9oCcpr8cru5YJx2bjg7G3Zh/DeloBGDJplgHHfq1bKFX2Mo5Uylih8/kyR0zstrq/pa//2EWfmuKFzTPsT9OYm/L3vYendBu8Iqtex1GY/vg/j932pyi2slEBxywFdMs191f9e+7lzEqKgXbjx3Tq9rJTmXm6anJQsdgXCVdKCM6gd+iQhPKAxfitga7nWn56fRT79bPubC+dvwodGmavNW9f1eBbo38b1x/aQf5Ce/4ybf1aP+19uHFC5O/807RSVRf4XaJ+FSw==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List data agreement revisions</h1>

<MethodEndpoint method={"get"} path={"/config/data-agreement/{dataAgreementId}/revisions"}></MethodEndpoint>



This endpoint lists all revisions of a data agreement defined earlier in an organisation.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) revisions listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revisions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreement\": {\n    \"id\": \"65471222e8c7c3bb3c2c8492\",\n    \"version\": \"1.0.0\",\n    \"controllerId\": \"string\",\n    \"controllerUrl\": \"string\",\n    \"controllerName\": \"string\",\n    \"policy\": {\n      \"id\": \"65471222e8c7c3bb3c2c7701\",\n      \"name\": \"Default data policy\",\n      \"version\": \"1.0.0\",\n      \"url\": \"https://example.com/privacy-policy\",\n      \"jurisdiction\": \"EU\",\n      \"industrySector\": \"Healthcare\",\n      \"dataRetentionPeriodDays\": 365,\n      \"geographicRestriction\": \"EU\",\n      \"storageLocation\": \"EU\",\n      \"thirdPartyDataSharing\": true\n    },\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\",\n        \"restrictions\": [\n          {\n            \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n            \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n          }\n        ]\n      }\n    ],\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"\",\n    \"methodOfUse\": \"\",\n    \"dpiaDate\": \"\",\n    \"dpiaSummaryUrl\": \"string\",\n    \"signature\": {\n      \"id\": \"65471222e8c7c3bb3c2c5501\",\n      \"payload\": \"{...}\",\n      \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n      \"verificationMethod\": \"Ed25519Signature2020\",\n      \"verificationPayload\": \"{...}\",\n      \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n      \"verificationArtifact\": \"\",\n      \"verificationSignedBy\": \"did:key:z6Mkf...\",\n      \"verificationSignedAs\": \"individual\",\n      \"verificationJwsHeader\": \"\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"signedWithoutObjectReference\": false,\n      \"objectType\": \"revision\",\n      \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n    },\n    \"active\": \"\",\n    \"forgettable\": \"\",\n    \"compatibleWithVersionId\": \"string\",\n    \"lifecycle\": \"draft\",\n    \"dataUsingServices\": [\n      null\n    ],\n    \"openApiSpecification\": {},\n    \"dataSources\": [\n      null\n    ]\n  },\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"revisions\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all data agreements
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-list-agreement

---
id: config-list-agreement
title: "List all data agreements"
description: "This endpoint allows the admin to read all data agreements and their revisions defined earlier in an organisation."
sidebar_label: "List all data agreements"
hide_title: true
hide_table_of_contents: true
api: eJztPO1yGzeSr9I1fyxvjShKtuyEtbW1tGUndBybJ8lxbSxVDM70kIgwwATASOK69G+f5B7tnuSqAcwnRzJlO3V1W5sfDsUZdDca/d0NfopSNInmheVKRpPodMUNoEwLxaUFJoS6MmBXCCzNuQSrQCNL6QGkzDJgS42Yo7QGmEzpTa5B4yU3XEkDKWZcYgrItOCogUtgEpReMskNI5yjKI5Ugdr9MUujSZQomfHla27stAIexVHBNMvRojbR5MOnHtVTCWrxOyYWrrhdweyoJmGWRnHE6Z0/StTrKI4kyzGaRJ0XNP5Rco1pNMmYMBhHJllhzqLJp8iuC3rdWM3lMrq5ifu435T5AjWoDDQmSqeGmGQueAGZ0lCwJZd+ozAFiUtm+SWC0lBK4iRbCIRLJkqEjAlhYMGSC4LwcfxxdAvpKssM2q3I5tLiEnUURylmrBQ2mozjKOeS52UeTcZuPwGs4Dm3fZTdvf7MrmkhyKE9a7SlllCg2zWOvpTA/fEAl19yYZGOYEPsFmtINcvsXqLyQqDFFIxltjS3cE/wDJN1IjC61zEfEVq8TlZMLhEs00vcYFbAUD/cWqziCCWdx4co5UtumfjtigmBNjq/uTknOKZQ0qChlQfjMf0vUdKSZkw+RawoBE+ckO39bojaTy1MhSb1styvJu7VauW+4RZz94EJ8TZzyhWI8yoVxZHlVmDgQVsnN5SwPhYg8hiX3naYAhOeBRJJahgYLpcCoSh1oQyCXTELCZOwQFpqUNI5WjUCmEIHLXADpeSXqA0TzuYMLCOh+EvO5PovwGXKL3laMkG0aFUuV8C6II+dDI/OZBRH17tS2V0ud4lRC2awPrvmMD9EgWwyS/7TUYsTsTsbrYRA/U6Lzt9vSELiqFCCJyQxgl1lpXjGDCdxzdGuVPo2e+dAs4RMRRRHmSJ5smQqaEktv+dx73B5OiRamdI5s9EkIjG7ZqQk0SR6cvj46f7BwQF+lzxNHi0Wj5KD5LvH3x9sHGt0E0fEbe4Fazvo+6PxaLwB6nSFEECRFFjyNV3ZsAquVjyhI9KYIC+cJBEOQ3Q0jJwNbrWLbnbksTjZCOu6UOh4Pgvm3fFrguPsTrMUdnK2JrlTObckdTwDqfxbXF4qcYnpwy42d/ifRUdvfQ2+IFuTvgGbu++hlCnqwGR3AF3tMity7QuEpbpELTEdAbxfoYREI7Nkf1nPAseOw4JZNBY88kolS+O1MeNCuLeCjfcOLwanvu1gIEQZtDzFhKdIq4PJ5ZaiBwelgx8EXqLw2nub4ZpX+radekuvpaUW317Hnj4d7w/qmLxFOoZBHwVOOl7U5mRYkohn4ZVvp8u/tPW4gg873JvxTFHk6I0/5peowcN2EloOa90w9pW1hZns7YVvRonK9wrNL1my3r1l33PUOZMkGqS6zLal/RL1umuDEOYdoaWoLAazUqVIQSpL37k42MtykEbSDrA8R9rQ76XmJuWJvRdfX7zboPxVG9ANRRdpaaxen2Bild4e9I/IhF0lTOOmUQwgwXiYN7GLCY6Rogmu5Bw1V+kRW5vBKG0Q36Mnh300LlzSFVAKCrlKSYFTgnwTR0tUS82KFU+OkXbz9cz7oYYIugXyJo6MVZot8bXyXuarsJx4WCAqYDdxZFdcp3Om7Zq2fbJiDmiDZaGUQCZvQ2N1iZuukusUCoLpddwEqDc34cSm1mq+KC22D4ppzUghtgjqBs6L1SCr+K3rng1pDF6zxIo1XFHIxulNITCxmI7ua1/bFHz7WOZwwM52dwmzo/sb3jebtHctbQ0+dgkgl8YymSCcOURnEeV+ZxFb4pkz+x1A2xLxshQCZAtpE+Vu7rn5a4NEpxwoDbf8ktv19iIbDrWnGg2kOoDpoEqYxaXS6+03OkdtlBzY1fMAahiRSVRxjzMlk7+p6AQDKrF1Z9lH5NLEvl51xbhlie7U07u1k4ohPttuQbtL27pEJBrTI8yGY+ZbPMijo/f7P797/+v62cX88PUPj/XpP45/nDyaPH89+W48qZL1jWPRmJLJZ8KXfrgTO69nPiX9BkQcTJ7T3pxVQnibwTEuubG+hDR5MhiunDjkjhL333lf9b6JBTxz7qDKDrcO9asFN4P55GfB9DS8Ba2dXm7N9U3pc1BgQWBqE1KH37tV5g17IHDJxG9qIfjSx/N7PoNhCT29dJUNiiVIjmEPinIhePKbZebCL+aW58xi/U6rMBKQUALcQ1Il2MwpTheJy9BrJH7xBhKShXbq/eWc+tlBIR6VBmEXJNnpPWc3fjOq1AlWf5VUAPnNoL7kCTbbpAXevYf3o/BX930nvQVnR8x+DbmnPplCULKOkRGO5rMpaCyUdtK9REnVWUyBZRY1FU/ms2kUKDgp85zp9VaJNKF7dyyg0OqSp5RLttAZymY8VhOD8WABbdKpDV2i5hnHlAo8TK6hOkP0sRLZO7I0fCmZLbXjzfVudrGbqxQFmYH6yYaBqJ64+lRpV0pz4nmIwVTWS5R36gUGQmaerJgrdoc0NWHGActLYXkhEGqyzMM7s9U2kVvWo9haKOfDTGutZ5Y3XF4ye1/O62UD3/7IzKr3hAjD9Nna0ZqjsSwvvn3kdjgUub11TKpZXTBDtQVXLF+swagcYTqf1Z0L4xoBqrTUbuAp7Mx/ehhDilJZL3fM0hmtgWkEBmeRKyGfRTHwEY6AQSMONlh5SgXXaIGSieaQq2PxpQwp1oDX3FjjnmtGAdHI2fXA6q0582k0Gt0MqlDGJRMQANbkGXc2sTPGVpeJU1gDDF6dvH0DBjVnoqqyqAwyjiI18Gng4CcwGo1iuEUkBp562Rp4MCUvzRI78KgSpYFHr67Mj8hS1DHUUhZe85t874/Wi8QxZqhRJhhe8dp0ui66X3RfuxnBSeBIh02Ueo9g5l1crUpdK7jATJHQyLVdkSwR74dFYodkYuWgO/GzVEejN3okVcWGVnEv0yr3dZVwzIvSujKaR+Ms8RXTqRlt2LvtxAvXr1aLHxL+lr96+euL49P/Onn1/Wg0utssVsSsmFn5sp8HXgUFDceaHYXwyZts5HaFekB4KCkalIFQserbse0z+PTg8HD/+3obB+ODzeBwClcoxO6FVFcSPMDGVnjH6OMD13wwVBT9hQme+jqmmcDps6MRuNZpzpcrVzLC64LJFFPfkTRlQZ4N084uA1RDa1FjZdwYuAYdE2DQ8bZZHRaAxASNYXo96jNo/m0MzYwcq2RCrFuibxqd6ZXQUl/uCQLtzrpRRG8bezK/6+Th2oVtrqwsG/ghNOBVxmWcdt6yU+entt4t218cJI/Sx3iYPRmS98F9J3pd2Lq4RNJf7dt3bqnhhLUFdh6keaiyIVPa30xlKr8impt2ZYsFiJVZIiih95YwSXGKP5IYeM6WGLe0F23Sp692/VvTl/J0coHryT+f/HyRDbH6GSasdJ4TuEsaM476AXlOD9ApCFtvVFyd5fFWmYFEX5Z1Jjg4w9Z67+bdMqdIfCm5XI5g1g3RWO+Ia1bEvmrsvGVl1OrEkIKOhnJXIRBKXZD0lkVt0dZVoOsTEbjAddte1iHmAFFSyd1tCEs6dDFwrzDRqgo9MK5cZGKqxLqKSujhx4A54wJYmmo0Bg3sBl4yMJIVZqWsZ+uCS9/n71r6b8ThYPqsj2+WqAtNAygb5a0HpsNHN1HiDoIQmRgYWHWBsnGgpXFCNTsCg8a4gZNB0Z7eI0O+q9p2PH15Ci9nL14fTeAk+D7fBdcofA1hxQtYoL3CEA60s40WY/04DTX3HKpWhlb54UTJBLU0wfdwQzjwkknrhPF5yMt9f9uMYK6M4fXAiZnAWWsrZxHsUSCMlF9bPIs2GNU45a8wUsLZVzcEE2Rp071340Ey8I4b/UML8rMkWAxevT9pO6gwD7Rz/PL508P9Q9d4apKWrTdwMD54vDve390/PN0fTx6NJ+Pxr5tReQW30oBAWVJqjZJKRS1l5UY+sE7l695ZOE6jgNsHPtMgaKh3C61UVoV4t0W+X1m2ncnUVdKM1/O+o75iBgRmFhaCyYvKmwyEAm41ve1pJaqbGOA+xVg/mHVnkd3XEsGl9cNkhzSQRkh+qaW9PpuqDF8hO4tapaYWBU1kfV5vZ4jvX5DmPnkykOZOwazzHKnIW9sL2PN5bh1eVYrTirB6vB/Be3SpbSOBv5fGen6Jys74sEu5kLyxOzvMFzIeEofq1+A4MAV2vB0KBRlWT9oFKx9sjp8Li8m5tyYFQpcYbfJw5DtZYchlawnetCgb00EepLMYEq+GRn1MPTNEQw1eVNtDNt+KGo+t8m1kWSmavHLjFIFP3FcqUs2uZEyRLrfGlxDcSYe6Qx3uO7vOypRbtuCCWx//0+Qbs2TZyUCEzvznC+2dytjds13vZ/OJdzLBiHVthqudN4dQcbly6lQHyVDrJrHlBqChGgoSIlWajjA5PSed75DmS+zNENRnq46O9OdeD+B1tc7NCNbmpINhBP3XjNOlapolZ5IawDxkCnCl9EXm5mRJ5PqTA8ZrJI1BMGl5AjkyUinjj9LL6jD//ExLPRlIFarIHzYJki8CM8veUeBw4ivDd/SYtmsBlz4K8dC6szlE7+b4zX2bvmHsII7qBvpGAfF+Ddk7/UR69558//N+sxUD7ReacTZhoKLC3Ecj7j18cCuiCtRtqMJ4zBEzq4ViOr2lOH9PrAEqpBVYKLUYJsG311SBclrwk3b/7POtztN2WhNmSN8SpPmsNyuYqqR06uIBLKo8azqfPWhm2E3svR7lBlSGqEbNfeWM5OPENVq+WnNCf+ffQ2UGNvMfXfnTdGVwjmBw6PoFFcxM1BUTOrEXYTJ9UzQ6Tz+rft0x9xQt48JsTDW0Yc61yvg2jrgLugjLGgc3nc33x86rDXeQhtr1tcucHdV3TbiE6Wzu4qJ6GuGoHkbYZnB4eIqhKfV8bpphcPSgu5ybFxTkkefu3wloYs5enmaqtAfDUgL0x+AoNAW0XCNZlqO1ZDlPXnN5MfheoZEiUSeOx/hHSR3xATHZzt7cMYDaQuOmagjP3eOodw+c3gIvfMR0cD7uFqn/mRV+vCasbc2BfIOtD4D1lH7ZaFCXnK+UwztHg+6rFTcbQzVDg0u1VxzkiwNCMa6S1Q0Vv8X+ONX/P9ZsiuafoWj/kbb7SVt9NJU73TDNLWN/HmLbDvdce7+65jfEw/oaQvPWxoieT1DnrOOk27fjOswJ6SzdswuF/HZgsk8UKsvErHeqt8E7pZdbt/qcNAC7ZFyEW0c17IPDCjjR+iXAiWi65+iqtBKqa4fNNLnL7+nLz8N+0yO5unzY4cb4Jo5WzMxDkWEbV1uXN3jmu00PqNlUlyn6KFzs7rG8wWv75RgkXtsN6DQf7sW0K1gDGnDUuxy5U7N5dvIWDp4ePhk/BMGdGpgyoapSVgpBFmDlSvvEHQL72N8y7EJfMIquitKVr/1t3IGF+/e6ntjWPNRa6ecqdbunz+0xyPPNgamuCjWrh+Sm5ubjMcnDBvihO5l1oP9sYOPBcvTuisnQzPknphusObznzc1/L9ZUnXVXiEENDk2PRz7FLLWbRf/wKZoW/Cekj+d0DdayJWXjUbdaRrvPw1RI5O/dFsyuokm052+S71G2stsohcuoiYShm+RHmKtAYbgB1lxBSjFXu6zgI77UTNoRV3uXB9HmVeETS3Z+eRsY4x8PQDpvtu9cjz+8igmNz/ZfhMvHnn/N7eNpEMDKz/QaDPOZ65ySmJIrTcLd9NP2vAK5y48dOB/Bo4Gc2ggLF35n/Loab/noaYSPsCOV9W1cqxn3rYaCJfgwBhwtRz2wEwgL/7pWpSaO7F7g+m8fqTlA28tUpTBhNMI1q0kQ/UTM32v+NfvnPzRfdRnfvLwhnPUi2Pmff/33Qz9bcHKFKTcrXxGpE9d+J7IuLPqxVtQjmFkqFlOVQ2S7hgYXkC+r4MWuq/amu/vf5Kiuex3uf4O//+2nYhSNGhUqBYvJSiqhlpxa3SjZQvjmDPU53DVI5wlJ0Vydy7cIHBBWWpX7C5yugMzdnRR3eGF2Z1mG9rQbMAPnFqpWg6DZJClRj9wF5ASlH5OuRK5gyQrhwM3dd3l+dXU1Yu7xSOnlXlhr9l7Pnr94c/Jil9bcNBFScw4kqFWFrxLlOld0bdnRo9G+v/BqbM5kix4XBw78REVfG1q2+P/mhy+CQlu8tnuFYFy2rkd6I/Yh/BxGmANvm7HzOFopStY/RJ8+kZ9/p8XNDX3tf4/AGTdu6PTS4dZve/+f+QmNQUovyCx1f0nD2RB/o/U+2P/cH9G4g/j6tzS+kPD7/iLGHaRUgfAXUvJlv5BxJz3ND2V8IU23/GjGHUjrdxqM5/SH5r4z+4Gyr+DySMD9qmmSYNFetRFY3bSjhB9enNLvK5R21fWqF86rhg+tsj+T6xbsvoP1JNC/rTJud8lfyZr9hOu/1a/7J7cuqJ26f5s4RKnn/wKrVwYs
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all data agreements</h1>

<MethodEndpoint method={"get"} path={"/config/data-agreements"}></MethodEndpoint>



This endpoint allows the admin to read all data agreements and their revisions defined earlier in an organisation.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filtering data agreements by draft/completed status","in":"query","name":"lifecycle","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Data exchange target","in":"query","name":"target","required":false,"schema":{"type":"string","enum":["digital_wallet"]}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreements (based on ISO 27560) listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"dataAgreements"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"items":{"allOf":[{"type":"object","title":"DataAgreement","description":"An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.\n","x-not-in-database":false,"required":["purpose","purposeDescription","controllerUrl","controllerName","policy","lawfulBasis","methodOfUse","active","forgettable","lifecycle"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""},"version":{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"},"controllerId":{"type":"string","description":"ID of the controller"},"controllerUrl":{"type":"string","description":"URL of data controller (may be omitted if no data involved)"},"controllerName":{"type":"string","description":"Name of data controller (may be omitted if no data involved)"},"policy":{"description":"Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.\n","type":"object","title":"Policy","x-not-in-database":false,"required":["name","url"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""},"name":{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"},"version":{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"},"url":{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"},"jurisdiction":{"type":"string","format":"","example":"EU","description":"Jurisdiction"},"industrySector":{"type":"string","format":"","example":"Healthcare","description":"Industry sector"},"dataRetentionPeriodDays":{"type":"integer","format":"","example":365,"description":"Data retention period in days"},"geographicRestriction":{"type":"string","format":"","example":"EU","description":"Geographic restriction"},"storageLocation":{"type":"string","format":"","example":"EU","description":"Storage location"},"thirdPartyDataSharing":{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}},"dataAttributes":{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"},"purpose":{"type":"string","description":"Name of purpose"},"purposeDescription":{"type":"string","description":"Description of purpose"},"lawfulBasis":{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]},"methodOfUse":{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]},"dpiaDate":{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"},"dpiaSummaryUrl":{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"},"signature":{"x-fk-model":"Signature","description":"Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)\n","type":"object","title":"Signature","x-not-in-database":false,"required":["payload","signature","verificationMethod","verificationPayload","verificationPayloadHash","verificationSignedBy","timestamp"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."},"payload":{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."},"signature":{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"},"verificationMethod":{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."},"verificationPayload":{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"},"verificationPayloadHash":{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"},"verificationArtifact":{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"},"verificationSignedBy":{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."},"verificationSignedAs":{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."},"verificationJwsHeader":{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"},"timestamp":{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"},"signedWithoutObjectReference":{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"},"objectType":{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]},"objectReference":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}},"active":{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"},"forgettable":{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."},"compatibleWithVersionId":{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"},"lifecycle":{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]},"dataUsingServices":{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]},"openApiSpecification":{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."},"dataSources":{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}},{"type":"object","title":"DataAgreementExtras","required":["dataExchange"],"properties":{"dataExchange":{"type":"object","description":"Data exchange details","properties":{"dataExchangeProfile":{"type":"string","description":"Data exchange profile","enum":["AIP10"]},"id":{"type":"string","description":"Data agreement ID defined in AIP"},"credentialDefinitionId":{"type":"string","description":"Credential definition identifier"},"schemaId":{"type":"string","description":"Schema identifier"},"isExistingSchema":{"type":"boolean","description":"Is schema existing"},"qrId":{"type":"string"},"firebaseDynamicLink":{"type":"string"},"presentationRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the presentation request"},"version":{"type":"string","description":"Version of the presentation request"},"requestedAttributes":{"type":"object","description":"Map of requested attributes","properties":{"name":{"type":"string","description":"Name of the requested attribute"},"restrictions":{"type":"array","items":{"type":"object","properties":{"schemaId":{"type":"string","description":"Schema identifier"},"credDefId":{"type":"string","description":"Credential definition identifier"}}},"description":"List of restrictions for the requested attribute"}}}},"components":{"schemas":{"restriction":{"type":"object","properties":{"schemaId":{"type":"string","description":"Schema identifier"},"credDefId":{"type":"string","description":"Credential definition identifier"}}},"requestedAttribute":{"type":"object","properties":{"name":{"type":"string","description":"Name of the requested attribute"},"restrictions":{"type":"array","items":{"type":"object","properties":{"schemaId":{"type":"string","description":"Schema identifier"},"credDefId":{"type":"string","description":"Credential definition identifier"}}},"description":"List of restrictions for the requested attribute"}}}}}}},"required":["isExistingSchema","schemaId"]}}}]},"type":"array"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreements\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c8492\",\n      \"version\": \"1.0.0\",\n      \"controllerId\": \"string\",\n      \"controllerUrl\": \"string\",\n      \"controllerName\": \"string\",\n      \"policy\": {\n        \"id\": \"65471222e8c7c3bb3c2c7701\",\n        \"name\": \"Default data policy\",\n        \"version\": \"1.0.0\",\n        \"url\": \"https://example.com/privacy-policy\",\n        \"jurisdiction\": \"EU\",\n        \"industrySector\": \"Healthcare\",\n        \"dataRetentionPeriodDays\": 365,\n        \"geographicRestriction\": \"EU\",\n        \"storageLocation\": \"EU\",\n        \"thirdPartyDataSharing\": true\n      },\n      \"dataAttributes\": [\n        {\n          \"id\": \"65471222e8c7c3bb3c2c8501\",\n          \"name\": \"Name\",\n          \"description\": \"Full name of the individual\",\n          \"sensitivity\": false,\n          \"category\": \"Personal\",\n          \"scope\": \"read\",\n          \"restrictions\": [\n            {\n              \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n              \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n            }\n          ]\n        }\n      ],\n      \"purpose\": \"string\",\n      \"purposeDescription\": \"string\",\n      \"lawfulBasis\": \"\",\n      \"methodOfUse\": \"\",\n      \"dpiaDate\": \"\",\n      \"dpiaSummaryUrl\": \"string\",\n      \"signature\": {\n        \"id\": \"65471222e8c7c3bb3c2c5501\",\n        \"payload\": \"{...}\",\n        \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n        \"verificationMethod\": \"Ed25519Signature2020\",\n        \"verificationPayload\": \"{...}\",\n        \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n        \"verificationArtifact\": \"\",\n        \"verificationSignedBy\": \"did:key:z6Mkf...\",\n        \"verificationSignedAs\": \"individual\",\n        \"verificationJwsHeader\": \"\",\n        \"timestamp\": \"2024-01-15T10:30:00Z\",\n        \"signedWithoutObjectReference\": false,\n        \"objectType\": \"revision\",\n        \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n      },\n      \"active\": \"\",\n      \"forgettable\": \"\",\n      \"compatibleWithVersionId\": \"string\",\n      \"lifecycle\": \"draft\",\n      \"dataUsingServices\": [\n        null\n      ],\n      \"openApiSpecification\": {},\n      \"dataSources\": [\n        null\n      ],\n      \"dataExchange\": {\n        \"dataExchangeProfile\": \"AIP10\",\n        \"id\": \"string\",\n        \"credentialDefinitionId\": \"string\",\n        \"schemaId\": \"string\",\n        \"isExistingSchema\": true,\n        \"qrId\": \"string\",\n        \"firebaseDynamicLink\": \"string\",\n        \"presentationRequest\": {\n          \"name\": \"string\",\n          \"version\": \"string\",\n          \"requestedAttributes\": {\n            \"name\": \"string\",\n            \"restrictions\": [\n              {\n                \"schemaId\": \"string\",\n                \"credDefId\": \"string\"\n              }\n            ]\n          }\n        }\n      }\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read data attributes
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-list-data-attribute

---
id: config-list-data-attribute
title: "Read data attributes"
description: "This endpoint reads all data attrinbutes defined in a data agreement."
sidebar_label: "Read data attributes"
hide_title: true
hide_table_of_contents: true
api: eJzdWF+P2zYS/yoDvjQBtLbXSdrCKIrby6aF0XYv6CZPiYEdi2OZXYpUSMpr19DbfZL7aPdJDkNJlmVrm2xw93Ivu7LEmfnNj/OP3AtJPnWqCMoaMRPv1soDGVlYZQI4QukBtQaJAQFDcMosy0AeJK2UIQnKADZfM0eUkwkjkQhbkEPWOZdiJlJrVir7VflwjQGvWA1rEYko0GFOgZwXsw/7EzDvjfpUEsyvwa4ADdjlH5QGkQjFXwsMa5EIgzmJmWAIVy2CuRSJcPSpVI6kmAVXUiJ8uqYcxWwvwq5gEc/eZKKqklPDN2W+JMdWHaXWSQ/Bgr9XBaysgwIzZaJzI7gCQxkGtSGwDkrDjOFSE2xQlwQr1NrDEtN71nA3uRu16D+V5HYdfLtaeQo91CvUfgi2MoEyciIRklZY6iBmk0Tkyqi8zMVsEv1p1GqVq3Bqsu/rb7hlQTBDPjsKpTNQUPSaRl8L8HJSVQuW9YU1njyvnk4m/C+1JpAJ/IhFoVUamR3/4Rnd/kh74Tiogqql5XEgxTcqUB4fUOt/rGI4NYAOcdP3/PoQ03VIMxJUBnxBqVo1QDwzQltMg97BwxoDKF6pNaWBJBOyvTA2XChzwZCW6OnATEfVh3pD+ggWyYlPSp5HZyJW1uUYxEyIRNAW80Lz529fvfzucjqd0vfpd+mL5fJFOk2/fzW5/IyXML8WVRt1X2rr5hx7/ZK5CWvq1CcxQZTxAU1K8DEa+ig4Nz4KzOijYOs9RV8K4qdSazBHRpWRaqNkifrc5+7XGUQG4Ml4FdRGhd0RgKW1mtA8hqDZ1L6l204TW5I9stlUioEy63Zf7uhbct6aAa9eN6qGDfnUFk/YUy5UZxZuWQe0YRv38tRQrC4DqdiW3iMEh7T7fJRXiShKV1g/4EHFNk90VovuFTqHu6jhUJeHQAQVanq7VafI0tI5MuEtZvRIOettR706Fsameh4zfMkIbUA9b+vSZ/S948VHZTjWM8ANKs0d5Vj39FWrnLF+jXIGzY3JkwRroO0TBwsvqqRpHp/XfXMCue0WPTYmVSLW6N862ihb+sG066udG8k1mDyomMKOvvGAUDQazkzE/Kyt3NA2fL0FQ9twpp1niMFIrE4L2llf6dKoTRLQygeS4Ms0Je9XpdbcmNeEMk5Ce1b6su6Pfd1L5JGrKBlgMzkNCF4+qbEetylyzrrXVkbf+fm637D+OrU76aGoOXD5csLRcKZ+oHZ19ervA45X1QD77w2WYW2d+pPkGTWvnjhz/H9RMzeBnEENntyGHEQzJxzF7piWLrbGD3txVahfiB8XPMAFzHhQr0O8m+MXicgprC3P+lkcY+NwPhPjevIfc/hfHMJ/vD+Z1qtmQTfPMQrGOHQsuKbcNi6IRJROi5lYh1D42XgsKbcXWKiRyhyaMFJ2vJmK8wn/NnAbyB5T4+vPA5oWHT+3HCb17rYsHbYJ6xfN5F0T3E37V02Etm2oj+3q7RzuaQccx2RCE50jeLdujxXNTHPX03MHtRnISx9gSVwpV2pLEh5UWMNdjRHu4JmxgaKC4FDpSEOBKT1PgEbZ6ETtDBrBH3a2dMzIxT3tfrwb8cFJKLOybUZhGjOKclTMpS+LwrrwtwN/nf/q5+5Vn/hu8Vn0HoTg2b//+a/nPIcj3D6QVH5d11fapms0GQEaCRtyhyE+brNKmRK7UZLcCOYBSk8ePOnVhbcbcqQyA0oy42GXNPLxLJc6iq9R+4RPuypT3E0fUGsK0Zi3WkkorIRA6dpYbTNFPgEyuIwEc1d5AE0b0rFRcibGM/JSaZ4dWQmWweYYeHlq80KrOEPHzYvuOcpK3RxK4rE79g3AUqoQceZoDDk+k2iVkqmHqTbkCkzXBNPR5Izzh4eHEcbPI+uycSPrx7/OX7+5uX1zwTJVN0B1+8CBKm1achK3ocw5W+/XdDJ9OXoxuoyjmfUhR3OE53dCeTJc+tNMOCrU/7WLiSY/A23DuNCoDMOLfOybovWhua5gNL2yJRIxO79mOK1ci0SsrQ+sZ7/nAeu901XFr+vzd6xnyvOGyeFDxbHb/9ubiEEy7rmQdRcSUZxPD7GIfjHwp14r/AWUdjjtkCz4h4vJ+UQ+n/3edPTn8Ojt0iCUtq6b3TGSFuJpWMTzSVP1GWC96ipNqTj25Gz4qI476c9v3olEcBfoN5b72Fiah6Nrjj620x5TQ+C/vJGDIj9wQv9Cux8Py+svjwoc+lq9mplaVFX1H4WpDTU=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data attributes</h1>

<MethodEndpoint method={"get"} path={"/config/data-agreement/{dataAgreementId}/data-attributes"}></MethodEndpoint>



This endpoint reads all data attrinbutes defined in a data agreement.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data attributes for data agreement listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"properties":{"dataAgreement":{"type":"object","properties":{"id":{"type":"string"},"purpose":{"type":"string"}}}},"type":"object"}]},"type":"array"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAttributes\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c8501\",\n      \"name\": \"Name\",\n      \"description\": \"Full name of the individual\",\n      \"sensitivity\": false,\n      \"category\": \"Personal\",\n      \"scope\": \"read\",\n      \"dataAgreement\": {\n        \"id\": \"string\",\n        \"purpose\": \"string\"\n      }\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all individuals
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-list-individuals

---
id: config-list-individuals
title: "List all individuals"
description: "This endpoint is used to list all individuals in the organisation defined in the consent building block."
sidebar_label: "List all individuals"
hide_title: true
hide_table_of_contents: true
api: eJzdWN1u2zgWfpUD3mwLKLaTSbpYYzCYtMkMjHY6wSa9agP4WDySOKZIlaTseAPd7ZPso+2TLA4l+T+TpsDuxd4kssTz//cdPgpJPnWqCsoaMRZ3hfJARlZWmQDKQ+1JQrCglQ+AWoMyUi2UrFF7UAZCQWBdjkZ5ZB4gKVOGZP8ttcaTCTCrlZbK5DDTNp0PRCJsRS6STKQYi9SaTOUflA+TjQCRiAodlhTIeTH+/Lin7ce6nJEDm4Gj1DrpWVM/VxVk1kGFuTJRwgAuwVCOQS1YW6iNI5Q40wQL1DVBhlp7mGE6Zw7T0ZQVVCzia01uJRJhsCQxFjbLPAWRCEdfa+VIinGG2lMifFpQiWL8KMKq4qPKBMrJiURIyrDWQYxHiSiVUWVdivGoaZLHnq1WpQr7Indt/Q0fmBDMMZsdhdoZqChaTYPvVfC01WpX8iejvtYEkysWigbs7A9KD7TtLKGHQM6g3kRxIr9JGx+cMrlomns+7SvOG8/fz0Yj/pdaE8gEfsSq0iqNkR3+4VnHxy1+lePMCqql3krX+DNQGR9Q69+zmFKd/LVVQQXNLzYWHMTitkCt7VKvoLSStGevbI7DslBpASWuwFFGjkxK4G1JoIwPyL+UYZLeV+BXPlAJrxzlyoe2KrqXCWS1SfkFaphcJZDZ2khcvwAK6esBXO4osJZjMwhc0VFNLmdjA+fLjKBUPuCcDCxVKAChbqNsMNQOt8t8AJO2E1RMyTXdqWuXhhy/k5QqSaA6YW1ecjKWKngosaq48IMFPMIe0MihdUyN4JXJNW2b4uwSUjTMJRY3LYjp+7aCuSMqyQTPOf9wYmw4UeZEYsAZelqn215SyMPES0RmXYlBjIVIBD1gWcU0eHN+cX6KZ/SG/nrx5m+j0ej0/CKVb94cJMVdQb0T16Wya8hANMmmQF6gQ+3J/dz9HKS2PJD993WesZeNDQW5nUwZ7mVRm6LKg1Zz0iu4mUx2lbuLin2rglSiOiyT6z6/J1fAfMBXlKpMkeOG3LIcwC8c/D5hv7Ssvghu01/EXrJ/EQN4h4bTN84lZUBjIAfchBT56GAlyQQVVjfOLpQk9xJHHws2zk7PjgRbeUhtrSUrgwZ+eZ/ArA5x8Bi7hCWBtLHcClwQ4LoMbAa9hlB1KvoBTK7evo0tIx4vrSPoemaX3U3szM83q+uH4NDvtNzPbXNO1mGqCmtI3O+XRdvCD321N3Sx7BoLbZVx9DyWx529y+CdIwzsEk5rjuGcVqm2OOdWAJ7tZ95TJaeAHqaR7TSmZ9T/WQHXfAwmV0zSmvosyU08xudrX3y0QWXdgLmzczLP01/RQsXq44561DkynniqrI5zW1X06vfb10cYJoIMo4jPAo10VvGMVdaL+yYRnGlPpf2+HMZqPjJvqUDJY+o3DTPumKFzuIq+WgOsLVEHqXmzObWfcGntHJlwgzk9gUt28qY9HRFOB4O2i/eUNbQB9aSf8c/wu+PDW3gqYgPABSrN0HCb99lFz5x1/R7mrDQjTG5b1kAP+NYSfmiSDgU+z/vjnso97NvxxqhJRIH+xtFC2Xpb5Zm1mtAcsOUekmIg305ycvQXDwhVx+FARBytrZSP9BC+X4Khh3DAPbiaGm56e4kVXx2y7VcS3lNIgq/TlLzPaq0ZnBaEMq4Qj0x93iLKXSYz5HlS1axJt3IcITx9ERTdbsHknHXvrIxG8vPVlvj7fSv3K2VDfSw91k47H3HYD9gfaQSbmff2iOFNc8TNnwzWobBO/YPkgWsuXojS/79cMzE9kie3IAdRzJ6PmkR4SmunwiruHZeVek/8eM8rT8CcN9ztreM+ESWFwvJ6nMels8JQiLEYtsvyUO1syq3oY2vyFZW200wkonZajEURQuXHw6Gk0p5gpQYqd2jCQNnh4kwcLoG3gdt4/hQb334+wul+Y/YtR78NWm/82vvYvuiWytZvm63ysku8fozs6nZ5M2EMAZyejKzSbulnRN7u991Im+7wmUIrBsraB4ZxlaNMPZBsV6JpqyNM4ZWxocUkwaHS0Q0VpvQ6ARrkgz22Y+gIf1zZ2rFHTua0+mnKEI7Ny2xfKJjGQulQjfB1VVkXfl77b2O/+nXzatfxm8MHSbkmglf//ue/XjPaR7hdklS+AN6QgB7SAk1OEXgtyK1RTwwzQ5AeocYlsPbkwZPOTrxdkCOVmzWWTTr6eKmSOoqvUfsEEKTKFU/DJWpNoUV5VisJlZUQKC2M1TZX5BMgg7PoYJ4KS9C0IB0HHRdYvDGaKc3QmZlgHWyJgY+ntqy0iitEDF40z1Fe62hPvKpCiOMAsJYqRD1LNIYcb45apWQ8bVCwuKwwLQjOBqMDny+XywHGzwPr8mFH64cfJu+uP95enzBNswFAmzhwokqb1gzp+1Tmmm3jdTY6Ox/8MDiN0Mr6UKLZ0ufDkQu4/UrY6r//y5u8roQDPYRhpVEZtiC67LFrWZ+7+71Y3xv17xNRWB/4++MjY6NPTjcNv25vlWIrU55jtbk5etLi/+5t4FEj59zDNpeCkZx3ytg/v1nxl17t/YkqPa78Tk2evOr7E5FP3PhtNLjnHy52hjjt+rEYw9vyuExTqrb1PgAPzfY0/PX6TiSC2/3uBJnHCdI9bN3toVlt8d4fJq0K/Hdrw94l+ZEr9z2tflofb788SbAeYO1p9td90zT/Af+uJA4=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all individuals</h1>

<MethodEndpoint method={"get"} path={"/config/individuals"}></MethodEndpoint>



This endpoint is used to list all individuals in the organisation defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"query","name":"externalIndividualId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Individuals listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"individuals"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"items":{"allOf":[{"type":"object","title":"Individual","description":"Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.","x-not-in-database":false,"properties":{"id":{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."},"externalId":{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"},"externalIdType":{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."},"identityProviderId":{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}},{"type":"object","title":"IndividualExtras","required":["name","email","phone"],"properties":{"name":{"type":"string","description":"Name of the individual"},"iamId":{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"},"email":{"type":"string","description":"Email ID"},"phone":{"type":"string","description":"Phone"},"pushNotificationToken":{"type":"string","description":"Device token of the individual"},"deviceType":{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]},"mapperId":{"type":"string","description":"Defines the mapper id of the individual"}}}]},"type":"array"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individuals\": [\n    {\n      \"id\": \"64541a2e6e7569000145cd66\",\n      \"externalId\": \"user@example.com\",\n      \"externalIdType\": \"email\",\n      \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n      \"name\": \"string\",\n      \"iamId\": \"string\",\n      \"email\": \"string\",\n      \"phone\": \"string\",\n      \"pushNotificationToken\": \"string\",\n      \"deviceType\": \"android\",\n      \"mapperId\": \"string\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List data policy revisions
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-list-policy-revisions

---
id: config-list-policy-revisions
title: "List data policy revisions"
description: "This endpoint reads all data policy revisions defined in the consent building block."
sidebar_label: "List data policy revisions"
hide_title: true
hide_table_of_contents: true
api: eJzlWV9z2zYS/yo7fKndoWhJ/pNU0+mcG6ep21zisZO7mYs9YwhckahBgAFAyYqHb/dJ7qPdJ7lZgJQoiUnt5vpy92JTJLC7WOz+9t9DlKLlRpROaBVNone5sIAqLbVQDgyy1AKTElLmGJRaCr4Eg3NhhVYWUpwJhSkIBS5H4FpZVA6mlZCpUBlMpeZ3SRRHukTDiMV5Gk0irtVMZK+FdRee4mVLMIqjkhlWoENjo8mHhy3p3ivxsUI4PwM9A6ZAT39D7qI4EvS1ZC6P4kixAumXJ32eRnFk8GMlDKbRxJkK48jyHAsWTR4ityxprXVGqCyq63ib45uqmKIhdga5NqkFp8HeiRJm2kDJMqH8uRI4BYUZc2KOoA1UinTHphJhzmSFMGNSWpgyfkcUboe3SSv2xwrNci23ns0sug2pZ0zaPrGFcpihieIoxRmrpIsmwzgqhBJFVUSToT9PQ1aKQrhtlptn/Su7p42g+s5s0FVGQYn+1Jj8UQFHw7q+ob22JGuxtHo8HNI/rpVD5eiRlaUU3Gv24DdL0j10qJeG7MmJsHt9CR3OK8twwkl6cbFeFW8R4JUxqNwFy/Azsne19CKs9lpoVBXFEd6zoiRGozqOnHZMnjss7CPovaPFHZ0L2gdszoQk8+nSHh+3xEnWP0KchCYrtJiCVtAaxYrDYR03lvL7tN9sidyaxoY2hnUc5cxeEGboqivyVGuJTO2QPVcp3TxaEDNCFYPfWGBQNhR2WHjbC1ze4L374xwU3rsd6gQYdV3HDZx80cLCim1upy1sZnqOhkCToJSpFM6YY6eZQSzInhoMNchk0cKbyZgS1lstuJw5EBYMztBgSj7JLFxHnhy5jtFSormOYO/V2cXlvmehF6r1ZNqlOKHyiqclL74fKO0GQg2IEFnGyp3X/v0hoEgcVUZGN9v+I9JdKI2jmTYFc9Ek6qozOjk+ejYaj8f4nD/jh9PpIR/zZ8+Gox21RXWLiI8lfRYgphuqdm2WFUjqIE03S+o4mqOxm/DxO6xGyTAZ7hD/WyCzSR/2hAPOFMy0lHrhv1gs5mgg0N4nCUivj+aeO1faycFB8ybhujgojZgzvhx85twXaAqmyMzeX74G5mCRC56Do2g/R7OE+abswZa93FNvk2kMNteVTEFpR+8YnSaYIc+ZyhDIvMGJAulAv1VG2FRw9yS9vny/I/kvXUI1xa+0ss4sr5A7bR5P+mdk0uWcGezDA08SbKBZx96pLpGikdDqAo3Q6Rlb9iNuL7/Dk+NtNuTuFEYDUYJLoX3qlBLlOo4y1JlhZS74JdJpvl55r1YUwXRI1nFknTYsw9eab0fOp3O5CrRAtsQoSuXCpBfMuCUd+ypnnmgfNveyCXnaTmpqUiiJZvBx21D1+LxKSj0ibcXeHaxuM84etP42Q4VG8G9XeS4UOkUJnJWuMmgbFzaCSUFxtElbbADtJYQ85RsLVqhMIhi9SMDn1cLvVWArLw/5zmgfuFmWbnVPVmSKER+P3+N9YFUqnFBZcq2u1akVKcLM6MJLcR3ZinO0VhPucy2rQsXA1pI3PjsNublIfeSgpBzTx2O/oBw6nOpNCANBnz63Do90ybQIjfjEpPiE6ZVipc21a96Glz8zm/tbKNA6VpT//VhyctITS9rbhvMzb/vrozyaV9qN1bvw2iQncklX4slfRzCtnK8SHPJcCc4kAamluqlzLUxKTFe7SKhrz1lRBv9hh+8a37sfLn2eHt3Unav5KjU+P/puvJtMUmD4tQ0RurFhSksWzHY8Iqo3zOLRgjwkSVL3cu3yEtusyGMw/btwua7c293j/w7UNAb/uRTR82yV6g8qceZgKpm6I/DuMXlYkJNzJnklGbkubHpAsqZXsCWhgcWPFSonl2QSM+FNQqjEn67Hpb5So607YBpwdI9QjFn45ertm316YEABN4HTspRL/xpeMKW9DYtPIR29IntFWk15//nLdz/B5U8v4Pmz58cJwLnzsMiECu0DMpiZQJna1nyCvQPecywd2Cqg2DnlGRvK6v5uFZBcq1Y1HVx5tFbYaDrmh+kRHs9OvvS8ozhiQ/L33fne1c+ng5FP5tbw9miRxsPx0WA4GoyO342Gk8PhZDj8x64ntHRJBm9jLc6TjeWsLFFhmpDy1wBzfvUWnp8MR/D+3Qu6blylaKxyuTZ0iB+XZO9zkVZMBtfZ9YbwlRA03u6abJJ6SxXVk/Dn6PhoxMZ4gs+OT74bDoejo2M2He7m15dNDYO+9lHA0kIoqCylneSlObPADTJHaWnuS6UmypOxtIEyiHY/mN0NfFzfzAa2Rd5SxGyTMIGR0iC1yrwQCJJAw60WxKHwIoGFs7ASgiQqDaYYfj7Nfh9nvfxw14BYUaIZGLTCUsoCzDgxY9yFjGJVYoe2TwxclwLT8HHL2Tblv2qTlscfoitqkiRfKSvsLRBSrb5xcKf0oinsd1b5OOXDBfXolKbii5LHRmRmDFtGnRdN3ujX9CTzO/1QSbKm7TXPKikpVOfIUt/PfCA6R6HZtUluygjwy4oaEE3/s2fj6Eldsm4Kh8Zo80KnvrdBz2cd9jfb591Oyta7++qf1Z0eDanbs0O+xyTWZvBjz8Hrukfh79UaZHpUc/R/rJpLtLoyHH1pPtOV2lXQ8RM7rP9bCjpXDo1ikkCMmhSezZaOfD7BKyPc0g8eTkvxK9LjDbWrHctoHhHcvmn03cRRgS7XNNHIfMfeDyAm0UGYbxwEeDh4aCcR9YHpDDqCLH1TjjMsdCNq03Jb93xSLPSAlSIRmWHKJUIfzMfR7tziylG/O/scGRs+91C6WeshpHj+FlttrK6DhRfNPCEocj3DOG1cte23b9XYF+dwh0sgh6ZmCG8mKJTph2FJkyPebtC5hcAGisr6FlRpcCbuMYWFcDncBhnhFvaUpjQnR3CGCenVUDKO+zFgkiVbZCfQbPx+qStDGhnc4fKH28QHAqFmuvUcxr3nYMEE6dJWZamN+8tKf+vzi1frV5uKXy/esdLVJtj79z//tU+5BYOrBabC5iFRx/um1UatgTkaMWt0569ZcFKJnlOV75PAyiLVSnI2sNSbQ5EpEClp3C3jZr+fUHGK5MoJJm3sk/9M0NhgQbWp88ysliKFUqehmNVSZwJtDKjY1CuY2ucLkDhH6ScC5HF+6DcVUrilJ8Iqp4tQEHFdlFIwyuX85aWhN5b5gokiqVDAwAfQ0ADxchZMKTSUK0jBUVmPKa3JlYznCGPfl93U+WKxSJj/nGiTHTR77cHr8xcv31y9HNCeet0bWt8DGWqqeUUldmvKq16xz9mTw2TkcyFtXcFURx6abvZPTbf9oQPLf9b4tXFah/fuoJRMqE7POYDWh2Yo220xTDZGqK30N3GUa+toy8MD9YzeG1nX9DpMFT2eCUsXlvZX190D/7nz1d5z3xGQrcesfnsYODxF8KcOS78gSjuFW0tyQz+Md84n6nPvsonc+/DZYXmvKC2uq2VXklbElSXU1GNq4J4kC59POVXxnY072UXdjZavXr6LQtG4GVHufERpHoh6r1DbwSWIQH/pBnu3fE+e/Csuf1gtD18+u2EV0MJqUtFNXdf/AYicdUk=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List data policy revisions</h1>

<MethodEndpoint method={"get"} path={"/config/policy/{policyId}/revisions"}></MethodEndpoint>



This endpoint reads all data policy revisions defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"policyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data policy revisions listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A policy governs data and DataAgreement in the realm of an organisation that is refered to as "data controller" (GDPR) and owner of referencing Agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revisions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"policy\": {\n    \"id\": \"65471222e8c7c3bb3c2c7701\",\n    \"name\": \"Default data policy\",\n    \"version\": \"1.0.0\",\n    \"url\": \"https://example.com/privacy-policy\",\n    \"jurisdiction\": \"EU\",\n    \"industrySector\": \"Healthcare\",\n    \"dataRetentionPeriodDays\": 365,\n    \"geographicRestriction\": \"EU\",\n    \"storageLocation\": \"EU\",\n    \"thirdPartyDataSharing\": true\n  },\n  \"revisions\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all data policies
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-list-policy

---
id: config-list-policy
title: "List all data policies"
description: "This endpoint reads all data policies defined in the consent building block."
sidebar_label: "List all data policies"
hide_title: true
hide_table_of_contents: true
api: eJzdWF9vG7kR/yoDvlwCrCVZTi6FcDjUjYPUvdQQ4qQvOQMecUe7jLnkHsmVrBr71k/Sj9ZPUgy5klZ/fLHT9qUv9mqX85vhcOY3M3wQOXnpVB2UNWIiPpXKA5m8tsoEcIS5B9QacgwItdVKKvKQ01wZykEZCCWBtMaTCTBrlM6VKWCmrbwbiEzYmhwy9GUuJkJaM1fFB+XDlJFWIhM1OqwokPNi8uVhz5hzA3b2lWSApQolXF6Ao4XyCS4Titf81pBjIIMViYnYWeDot0Y5ysVkjtpTJrwsqUIxeRBhVfNyH5wyhWjbbF/3VVPNyIGdgyNpXe4hWPB3qoa5dVBjoUzc2ADOwVCBQS0IrIPGsNNwpgkWqBuCOWrtYYbyjhFuR7eDR0y387mn8CSzlQlUkBOZyGmOjQ5iMspEpYyqmkpMRnE/HaxWlQr7Knf3+le8Z0Ewx/bsKDTOQE1x1zT4XgNPR217w7K+5nDxvHo8GvE/aU0gE/gR61orGT07/OrZuoceeu04oIJK0ttD6GlOASMyEVTQ/GK6XZXtAcjGOTJhigU9YnvfS2/T6uiFzlUiE3SPVc2KTttMBBtQXwaq/BPwPvHins8VywEuUGkOnz72+PUanG39HnA2mqPQUw7WwDooNhrO2qyLlG9jX+2ZvA6NHW+M2kyU6KeckLbpmzyzVhOaA9hLk/PJkwc1Z1px9IMHhLpDOFARYy9puaL78P0aDN2HA/TgGmrbNhNr0mN8tXe0h8G25rU9IkvUuYLCLsgZn+gUTQ4XGPC8cEQVh1bHp45QV+xfNGBdgUb5GMAQSgygPDiak6Oc0xM9/CoiHGeRs1qT+1XAi/cX048vowq7NOukZikjmaE3Oj0n9P2JseFEmRMG4iDZZPY21b8kQslE47S42U8llR+yaibm1lUYxET0PSt+fP3qzel4PKY/yDfybDY7k2P55s3o9MBtol2T41OhLxLb9MrV4WFcYUXsDvZ0t6TNxIKc32WSb6g6HYwGowPwvyWYXXx4oQJINDC3Wttl/OKpWpCDhP2SLWC/Pll7GULtJ8Nh92YgbTWsnVqgXJ08su8puQoNh9nnjx8AAyxLJUsIXPEX5Faw2LU9xXK0exZjMs/Al7bRORgb+B3yblIYyhJNQcDhDUFVxBv62jjlcyXDs/z67vOB5X/pA7VcyvLGB7e6Jhmsezr0nwl1KCU6OkYNERJ8wmyzmFQfiQuTsmZKTtn8AlfHyfeovrMfX++r4XTnippAmTmVjW1UzshtJgqyhcO6VPIj8W7+c+e93yCC60G2mfDBOizog5X7RfT5Wq4TFug1GBesUrl8ii6seNvXJUbQYzR9VA0z8EFZY0ioGTPluO9QI1V3uOgcrkTvRUfTcc0+MWvlA0d8F+1pqYdNE8fdXuxxu+rvyXOS/OBBOsr5HFFHDi0J89jGPrCaV6mz2dU2Qz7ruuFq07W9RwRPn9US9QmanLPurc1jIePni576m3137FP4VvpYhG+O5dWIS/sB/JHg2QbMn45svG2PnMdng00orVN/p/zANa+f2S3+f7nm0gRyBjV4csyyUc2ejzipSTZOhVUcp85r9Qvx4w233gELnrISCXWdyk0mKgql5fGsiNNHjaEUEzFMw9pw0/4wNCs+NqhdUGU7u7oGYVuhcqrsCdZqoAqHJgyUHS7G4nDgug7cqBePwfj0+QjSzXbT13z26cjWW9/4HtOLbhBKXtsOX+dd2K0HhT2amF7CHa2Ag5NTXnaj36dyPeV1NfN2B+cWkhqoGh8LZu1oru4pT/PsbbIRbuGFsYEiQHCodHRDjZJeZkCDYrAHO4FO8KeVbRx75OSOVj/fDiLnKTO36zRBGdOEKlTsS9/UtXXhjxv/bfev3m9f7Tp+u/ggJDdC8OJf//jnS+5MEa6XlCtfJnqm+64x4EZ0QU7NO9/FY1aSXWIXKic3gMsAjScPnvT8xHMnQaowoCLJhlXWyUdW7nFvBgi5KhTPO0vUmkJU5q1WOdQ2h0CyNFbbQpHPgAzOooO571+CpgXpOMpwesXripnSKqwiCDbBVhh4ubRVrRUaSenw8lTJi0bH/Xgu4gjzRmsOk1yFaGeFxpDj8qCVJOMjgaxDrkZZEoxjF7nr8+VyOcD4eWBdMexk/fDD5dt3V9fvTlim3U4d23PgQM2tbLizX4fyprMV49H41eBscCriWONDhaZnD9/LHN717OdCj3//25dFXaIGug/DWqMyva44sdKX7gpJ9Maym0yU1gf++PDAs8tnp9uWX6fLjshWyvNxbC8sHt3SN66cjpp4xzyze/MUSSFNMM/R/r+9dPod4zd3T99p+HNvkH7HlPXVxNaSG/7hYuLHUrauefFok9C5lFT3pQ46g7Zf6d6/+yQywWy+WyDuYoHoHhh9/cmsetj7tSKZwH/ZaUdFfuLE/IVWP2+Wpy+PCmzqU1rNDrpp2/bf1F6ApA==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all data policies</h1>

<MethodEndpoint method={"get"} path={"/config/policies"}></MethodEndpoint>



This endpoint reads all data policies defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

A list of Policy objects readable for the current session's credentials.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policies</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"policies\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c7701\",\n      \"name\": \"Default data policy\",\n      \"version\": \"1.0.0\",\n      \"url\": \"https://example.com/privacy-policy\",\n      \"jurisdiction\": \"EU\",\n      \"industrySector\": \"Healthcare\",\n      \"dataRetentionPeriodDays\": 365,\n      \"geographicRestriction\": \"EU\",\n      \"storageLocation\": \"EU\",\n      \"thirdPartyDataSharing\": true\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all webhooks
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-list-webhooks

---
id: config-list-webhooks
title: "List all webhooks"
description: "This endpoint lists all the webhooks of the organisation. Each item in the list also gives the result of the last payload delivery to the webhook. The server does not list deleted webhooks. Use the `offset` and `limit` query parameters to page through the list."
sidebar_label: "List all webhooks"
hide_title: true
hide_table_of_contents: true
api: eJztGttyG7f1VzB4aZJZURTluA6bydSVPBmN5ctEclzH0Yjg4pBEhAXWAJYUq+Fbv6Sf1i/pnAPsjaQixWlfMn2xxd1zPwfnhr3jEkoHuQgg+XgmtIeMS/C5U2VQ1vAxv1woz8DI0ioTmFY+eCa0ZmEBbAXThbU3ntkZ/bZuLozyAlEH7IXIF0wFKJgy9BqRmdDesrlagqdnDnylQ01ACx9YKdbaCskkaLUEt2bBdrkN2OUCmAe3BMekBc+MjYIhBgSQjVwD9s4D4U7sbOYhTJgwkk20KlSYsE8VUi+FEwUEcB4ZlWKOGM5W80Uj9OBn87NBrgZW4ENNn+W2AM9myvnQk8pBqUUOngnTcg4LEZjyTINH1YVhQ5JGNPLUEENmXQRbqRClkDATaKel0BWQOK11F1bLaEwPuYPAbmBdG7SWVBmWaxCOBbhFdXjGbQmOPHUm+Zjn1szU/Fz58D4Zj2e8NQ0ff7zbCozXVTEFh4wc5NZJMp+/USWbWYd2VCYFwnNmYC6CWmKEsMo4EFJMNURt2Exo7dlU5DdIYTKcDHjGFbIgB/GMG1EAH/NoSZ5xB58q5Toh6/MFFIKP73hYlwiqTIA5OI7RTJbj42HGC2VUURV8PNxssruaLFl/m2Vf11fiFhGZ2aezg1A5w0ogrWHwuQIeDTebK8T1pTUePEKPhkP8L7cmgAn4pyhLrXKy7OEvHqW761AvHbo1qIjdOoEwtX4zI0cmGez0F8hR86CCxgdvW/hsi1ReOQcmvBVzuEeLrr1OInQ8TdFoPONwK4oSGR1tMh5sEPosQOEfQe8SgTvWx7j3TCyF0hhIXdqjr2viKOvnEEehMR49SGYNq8Oj4XC8yVLMPEz79ZbIdZD0rDHcZHwh/FsHS2WrrshTazUIs0P2zEiMAfBM0Tl38CfPBCsThR0WFIWRy2u4DZ/PwcBt2KEeXAUbit3t0gGdPMCkCIJyQ5NW+Sbjda5GmXbR2wpjUrn4VIHHHF8fNVWHUBve7en7yJXEVOfmZ5LyGVWWd07zrD5Tl2iHjPtqirynIF8swQTMflJ5DC5EjIn1JWBmwBR34fWP4NQsHUQ6QgX4IIqSX2X3nq+UWneM/bxTUTANVzEx7y+rdZ1ROTChV2LtmQcjPQMqljMFWkZM5VkUIWNwm0MZ2MQLI6f29g0ahPJs/5Qr2QkNH5wy8x1h3xn1qQKmJJigZipGd7c+d0ODP30mjmaj/Fg+ga9nT8Wfp8/yb+QQjtD10S2fz7Brl1g87cr4viybjHd1/h3cEplf8UZ0A9k9ecHoNUW8aBxMYk5BWzOn4iEauhJKbdcFmIAVs4Z3kAM1S0QL5QCKz5hSPGrMfG5LIFU7Af6woj+cR2kaFt2GIVHqO3MRQunHh4fpySC3xSEdz0M1d8IEFKF7rB6U4SQCM4Tablm6Ehgs2h93a1/We3R7sFqtDmbWFQeV02ByK0Hyq82e0z2+vwjuywQ7eYmcQGL7aMSu5LVBM2y7jtnc2ar06NTUf6CmR7W6x0w4h4e4qHygXo6JPmDLqx9uDmaVj01mC9I0kdgUd/vuFC8kTJ9O00M7KOwSmKyiSVN/5nfTRI79iQmvhBFzwIitE1trVlJqn78RkRUNZteSJJZvIzzPK8dWCzCoojJSLZWshE7Tg3WNBZI8GT4T/oYOVpwFMibtytA4ga1nKVGtsADlqBz1Csivh+pFExZRvk5YEqVIe6CMCorGqaz3PBcmBx2rSRJ3ILS2q94TLDk7D0UV7DXclio2pkg0KrfLrFZ2z5uI0RWjj9G+udpssPjNVRD6vdAaHu3e04jEVoTVd+0Lqk5vzk6f/HiS3pDvKF1SVP4lTWolGCUHX01S+DHh4gxHGTA9oygXJtE7Q+e+KcHgr7eMmrFUQg2AjIHFJkmnKF2HQUzH9ZhptQTHTs9OT2xRsNLZYHOrmxGwli93QCVCaKSUQnZm0XtERnlfgWNeScpsHVnhNl8IM0+nuaa3IL4Pko1gRLaPXzrAaIll6avB8ngbGyVoTFTLMGaT1FJdI/Yka3+nLCbTzNylfy3yG3yB8y+bOVuQaEvqiJJw2R6sEoxUZv5ogl1daWT9/Ud113l2NgNHyseZeO/r2hZ7Qdo/r8npD0KRsg8DYcf2MFzaeewFQ3HwWF9LMOoemGBvwOwIvhuNHZbJj4+E3tL2AdhtpXth3Q3VwfL4AajaafdD7obgI2GTBRA6ZksRxCvhbiDQ4ufR+RInoqLFe1wxDJ3anTugIa0pbjik0aAllc+19ZUDJuYOYrGNW4v/XtXryD7A39ct1+uG63XkipaKlSWNVQ8Poe9R3QmOl5Nsb4fFjE02q5eFseNvxrWHFWxXZk0fVxs31ifLcqHzSqfOgU3+fnD2PXa7BxdqbkSoHEzYAoSMowLgXq6R5r75IG6+els5/BVHuFbLuAnKmLdUiCAP9dKUXjDh2dpWvXc3kGywZ0z9DIvvNImU5eMkcnl+wXLsCmexXUwdbb2/fffDOUnSjsYPzySXJwzB7wt02Y0Caq8nHz58+HDw6tXB6enlYjEuirH3P01w6CpEuKfPjaWv6whLLWZq1Xojz2g4enowfHYw/ObyaDg+OhofjX7iG1ofbo3O/lz4cJocf1HlOfh7lhqfu/NOQeOTg9JmJhJoEBW2wyh8AKqzNDLW63tqvgXzQYQK4WSqtqPhEDmOhs+ohx6Nnm5xpK19n23adRdCAh7DeyRnlQlKM2NXg+2VUbYdjJgderubvSbd2a/sLp7a8blZoLc2xylor80Hu5ua9yosejKQ4Siou3l9W/BVd4XerFR3Bad02JP8zUue8ZhMMHgQ4Mnw6DetgLuCgHPWnVhJ6zr8+7TDbc+iqh/SLfa+RWfjyydDXGDukN9z2Ntj9TchmTJlFdrrFzTHrkHeGVGFhXXqH9QV9E3z9W/cjv+xTHNmAjgjdH0Sic2WjWIxrJwKa1qNPi8VlcWPV3hqgpjjzU6zl7zKeAFhYfFCaE43LaUICz7mh3EvedgJ7Mh038XQKRQ2ycQzXuEuqtkcSSjsgSjVIC6MBsoeLkccs+lWWQ54bub3kfHx9R5KV63CF+j36K5a7bYfiw/SpU+0WHvR9DyFXL3c3coub8+oX8DAxL4176wCUzmJGXLSo9M0CbTomQJu62fqFq8rMUlNooxswr4wNrUawQmlyQylyOHLjMFgPtgiO2YJ8du1rRxa5OAG1t9NBpSVlJnZ+oiInI4IFEJp2nOVpXXhr439Wv3V9+2jvuFb4J1wbJDYF//+57++pKrBLlYglV/ElrQeOqkuLTuNSVOiS2eXCscDdpbWAx707MDbJThQc5PWsmGdJXy6RmwHCJ9h+9vfQiAzb7WSrLSSBcgXxmo7V7ifAyOmZGC82VgxDUvQVCPwaNEF6VRpFdbxorYKthABwanCKhytovNIPQdz7BKVNR47E8FmldYYJlIFkrMQxoDDMqNVDsZT8qhDrhT5AthoMNyx+Wq1Ggh6PbBufphw/eH52cmL1xcvDhBn05au1g8YqNLmVVHPLTzjeGajv0bD0ZPB8YA28aX1oRCmI895vKvXrHPkZT+FNWn3/98I/FG/EUjZEh8clloog8FSxduFWBo+pi8HeOcm7yrjC+sDvry7w3vUd05vNvg43q5TyWimwH1fnXSD63/7ncFeDW+wVrSfGxA6H/NYpx4t+G/9aOBXRKnvoFtJrvCHo/xH1bwu+2TciPSclikdrJ3maNMt+N+/uMT7lAq92q2TN1Qn0x+drweEWXdob5fMKAL+i0bbi/It5qeXsP6uAY9v7kVoynSERgPhTuE/ObMJ2w==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all webhooks</h1>

<MethodEndpoint method={"get"} path={"/config/webhooks"}></MethodEndpoint>



This endpoint lists all the webhooks of the organisation. Each item in the list also gives the result of the last payload delivery to the webhook. The server does not list deleted webhooks. Use the `offset` and `limit` query parameters to page through the list.

The newest webhook comes first. The server replaces an `offset` that is less than 0 and a `limit` that is 0 or less with the default value.

Each item holds the secret key of the webhook in clear text.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"webhooks"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"description":"The webhooks on the requested page.","items":{"allOf":[{"required":["id","orgId","payloadUrl","contentType","subscribedEvents","disabled","secretKey","skipSslVerification","timestamp"],"type":"object","title":"Webhook","description":"A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.","properties":{"id":{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"},"orgId":{"type":"string","description":"Unique identifier of the organisation that owns the webhook."},"sandboxOrgId":{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."},"payloadUrl":{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"},"contentType":{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]},"subscribedEvents":{"type":"object","title":"subscribedEvents","description":"The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.","properties":{"consentManagementWebhook":{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}},"digitalWalletWebhook":{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}},"dataMarketplaceWebhook":{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}},"disabled":{"type":"boolean","description":"When `true`, the webhook receives no event delivery."},"secretKey":{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."},"skipSslVerification":{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."},"timestamp":{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}},{"properties":{"isLastDeliverySuccess":{"description":"The result of the last payload delivery to the webhook. The value is `true` if the last delivery is complete and the endpoint sent a status code from 200 to 208, or 226. The value is also `true` if the server made no delivery to the webhook until now.","example":true,"type":"boolean"}},"required":["isLastDeliverySuccess"],"type":"object"}],"description":"A webhook with the result of its last payload delivery.","title":"WebhookWithLastDeliveryStatus"},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"webhooks\": [\n    {\n      \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n      \"orgId\": \"string\",\n      \"sandboxOrgId\": \"string\",\n      \"payloadUrl\": \"https://example.com/hooks/igrant\",\n      \"contentType\": \"application/json\",\n      \"subscribedEvents\": {\n        \"consentManagementWebhook\": [\n          \"data.update.initiated\"\n        ],\n        \"digitalWalletWebhook\": [\n          \"openid.credential.offer_sent\"\n        ],\n        \"dataMarketplaceWebhook\": [\n          \"datamarketplace.data_disclosure_agreement_record\"\n        ]\n      },\n      \"disabled\": true,\n      \"secretKey\": \"string\",\n      \"skipSslVerification\": true,\n      \"timestamp\": \"2026-08-09T10:11:12Z\",\n      \"isLastDeliverySuccess\": true\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read data agreement
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-read-agreement

---
id: config-read-agreement
title: "Read data agreement"
description: "This endpoint allows the admin to view the latest data agreement defined"
sidebar_label: "Read data agreement"
hide_title: true
hide_table_of_contents: true
api: eJztXOtyG7eSfpWu+WMpRVIXW7LDOnVqacmO6TgxV5Lj2kSuBJxpkogwwBjAkGJU+neeZB9tn2SrAcyVI5mKla3dsyc/HIocNBqN7kZfPsxNlKCJNc8sVzIaRhcLbgBlkikuLTAh1MqAXSCwJOUSrIIlx5X7RjCLxkLCLAM214gpSgsJzrjE5FIi04KjBi6BSVB6ziQ3jKYZwJhIGwUaba6lqZPTuOSGKwkyT6eoB5cy6kUqQ+2GjpNoGMVKzvj8DFkyKqaNelHGNEvRojbR8Jeb1rI+SP45Rxifgpo5dqa/Y0yjOP2aMbuIepFkKUbDiBZUEh4nUS/S+DnnGpNoaHWOvcjEC0xZNLyJ7DqjIcZqLufR7e0nethkSho09Pvh/j79L1bSEpfDm4hlmeCxW8ze74aYu6nRyzQt1XI/usGJGyzE+5lbXpi4XIflVtAXp40hvZYYRrK2U8QU40H6JsOYzwJjTkhguJwLhCzXmTIIdsEsxEzCFGmoQWkxAasGACNoTAvcQC75ErVhAphMuobBdA3fpEyuvwEuE77kSc4E8aJVPl8Aa5I8w1jpxCvDdV8q2+eyT+KZMoPRcMaEwfo+/RIFtkkx/KfTmiR6bke0EgL1By0af/9IWtCLMiV4vI56kWCrWS5eMsNN1ItStAuVvJ99cKRZbPmSPsyUnqO1bCroL8FnGK9jgdGnXmtLebKpNm54ymw0jKJehNcszdxeHh89e35weHiIL+Ln8dPp9Gl8GL949u3hxrZGt72IpM29Om1H/WCwP9jfIHWxQAikSAssuYOmblgFqwWPaYs0xsgzp0k0hyE+KkGOO5fanM4bJClgNa5Jhbbni2Q+nL0jOs4VVUNhJ2Vr0juVcktax2cglX+Ky6USS0x2m7O5zf/idPTU18wXdGvY9lIT9z3kMkEdhOw2oGldZsGEoGnmaolaYjIA+LhACbFGZrmcA2s55V7dwfrJC5PMjbfGGRfCPZXgjOXCwpKJHHvgzLfuvMNBQMMTjHmCNDpeMDlH4Ja8vaPSPBQELlF4673LcU0Ke9vOvKW30lyLx7ex58/3DzptTN6hHd2kT4MknSxKd9KtSSSz8Mjj2fJPdTsu6MMO9258puhw984f0yVq8LSdhubdVtc9+8LazAz39sI3g1ile5nmSxav+3ese4I6ZZJUg0yX2bq2L1Gvmz4IYdJQWo0s6YFZqFwkIJWl71yo4nU5aCNZB1ieIi3o91xzk/DYPkiurz5scP62TuiWAogkN1avzzG2Sm9P+g0yYRcx07jpFANJMJ7mbc9FAmdIMQRXcoKaq+SUrU1tOi4tzlHfNd/T46P2NORVKALzRCFzVMmAE6J824vmqOaaZQsenyGt5uuF911JEXSN5G0vMlZpNsd3yp8yXzXLuacFoiB224vsgutkwrRd07LPF8wRrWaZKiWQybum8XHfRqisE8iIprdxE6je3oYdG1mr+TS3WN8opjUjg+AWU3N/UNexX6wkWcRvzePZkMXgNYutWMOKQjZOTwqBscVk8FD/Wufg8WOZow4/21wljE8f7nh/3OS96WlL8j3yecClsUzGCJduossIlIbLiM3x0rn9BqFtmXidCwGyNmkV5W6uufprg0VnHCgNt3zJ7Xp7lQ2b2jKNilIZwDSmipnFudLr7Rc6QW2U7FjVSSDVPZGJVfaAPSWXv2noRAMKtXV72Z7o9ra3aVdNNa55onvt9H7rfMeNpZU2qN1nbU0mYo3JKc66Y+Y7TpCnpx8Pfvjw8ef1y6vJ0bvvnumL/zh7M3w6PHk3fLE/DIHc5rZoTMjlM+Fzde7UztuZT0QfgYnD4QmtzXklhPczOMM5N9Yn8cPjznDl3E3uOHH/fWqb3qN4wEt3HBTZ4dahfjHgtjOf/CKZloXXqNXTy62lvql9jgpMiUzpQsrwu19k3rAHAudM/Kqmgs99PL/nMxgW069Lbpn4lWIJ0mPYgyyfCh7/apm58oO55SmzWD5DfMk8pTMjTEIJcGuSIsFmznCak7gMvZzED96YhHShnnr/eUn94KiQjHKD0AdJfnrP+Y1fjcp1jMVfORVAfjWolzzGapk0wB/v4fko/NV83mlvxtkps1/D7oVPphCULGNkhNPJeAQaM6Wdds9RUn0ME2Azi5qKJ5PxKAocnOdpyvR6q0SapvtwJiDTaskTyiVr0xnKZvyspgfGkwW0caM2tETNZxwTKvAwuYZiD9HHSuTvyNPwuWQ210421/3ZVT9VCQpyA+UvGw6i+MXVp3K7UJqTzEMMpmatRHmnHGAgZObxglF1skhTY2YcsTQXlmcCoWTL7N6brdaZ3LIexdZCuTPM1MZ6YXnH5TWz9eWkHNbx7RtmFq1fiDFMXq4drykay9Ls8SO3o67I7b0TUinqjBmqLUxZfEWqYFSKMJqMy+KygRW3C5VbqsfyBHYm3+/2IEGprNc7ZmmP1sA0AoPLKNFsZi+jHvABDoBBpQ42eHlKBddogZKJapOLbfGlDCnWgNfcWON+14wCooHz60HUW0vmZjAY3Haa0IxLJiAQLNkzbm96zhlbncfOYA0weHv+/kcwqDkTRZVFzWDGUSQGbjo2fgiDwaAHd6hEx69etzp+GNEpzWLb8VOhSh0/vV2ZN8gS1D0otSw85hf50W+tV4kznKFGGWN4xFvTxTprftF87HYA50EiDTFR6j2AsT/iSlNqesEpzhQpjVzbBekSyb5bJXZIJxaOulM/S3U0eqLFUlFsqBX3Zlqlvq4StnmaW1dG89M4T7xiOjGDDX+3nXrh+u1i+l3M3/O3r39+dXbx7+dvvx0MBve7xYKZBTMLX/bzxIugoJJYtaIQPnmXjdwuUHcoDyVFnToQKlZtP7Z9Bp8cHh0dfFsu43D/cDM4HMEKhehfSbWS4AlWvsIfjD4+cM0HQ0XRn5jgia9jmiFcvDwdgOtupXy+cCUjvM6YTDBxjghMntHJhkljlYGqobGosXBuDFIuecoEGHSyrUaHASAxRmOYXg/aApo8jqMZ08EqmRDrmuqbymZaJbTEl3uCQru9rgzR+8aWzvedPly7sM2VlWVFP4QGvMi4jLPOO1bqzqmtV8sOpofx0+QZHs2Ou/S9c92xXme2LC6R9hfrdgrgGk5YemB3glQ/qlmXK20vpnCVXxHNjZq6xQLFwi0RldB7i5mkOMVvSQ94yubYq1kv2rjNX3n0b81fwpPhFa6Hfxz/cDXrEvVLjFnuTk7gLmmccdRP6OT0BJ2BsPVGxdV5Hu+VGUj0ZVnngsNhWBvvj3k3zBkSn0su5wMYN0M01triUhQ9XzV2p2Xh1MrEkIKOinNXIRBKXZH25lnp0dZFoOsTEbjCdd1fliFmB1NSyf42jMUNvhi4R5ioVYWeGFcuMj2qxLqKSmiB9wBTxgWwJNFoDBroB1kyMJJlZqGsF+uUy8SQqJue/pEkHFyf9fHNHHWmCSOwUd56YhpydAgAtxE0kekBA6uuUFYHaG6cUo1PwaAhl7XhMb1qjx6QId9XbTsbvb6A1+NX706HcB7OPt8F1yh8DWHBM5iiXWEIB+rZRk2wMglr91PVMrTiHI6VjFFLE84ebmgOXDJpnTKehLzc97fNACbKGD4VWJ5bl7WlXEawR4EwUn5t8TLaEFR1KH+FkxLOv1Jnu9ClzeO9GQ+Sg3fSaG9a0J850WLw9uN5/YDyzg12zl6fPD86OHKNpypp2XoBh/uHz/r7B/2Do4uD/eHT/eH+/s+bUXlBt7CAwFmca42SSkU1Y+VGPrHO5MveWdhOo4DbJz7TIGqo+5lWalaEeHdFvl9Zth3LxFXSjLfz9kG9YgYEzixMBZNXxWnSEQq40fS055W4rmKAhxRjPUbn3iK7ryWCS+u72Q5pIEFIfiq1vdybogxfTHYZ1UpNNQ6qyPpTuZwuuf+JNPf4uCPNHYFZpylSkbf0F7Dn89wyvCoMpxZhtWQ/gI/oUttKA3/PjfXyEoWf8WGXciF55Xd2mC9k7JKEysfgrIBO7Xg/FAoyrMJUeS8ffI52PqdHh3sNKRC6xGjj3YHvZAWQy9YavOlRNtBBnqTzGBJXXVAfU2KGCNTgVbUOsnksbvxsxdlGnpWiyZWDUwQ5cV+pSDRbyR5FutwaX0JwOx3qDmW47/w6yxNu2ZQLbn38H6s0Y5Y8OzmI0Jn/cqG9URm7H9v1cTwZ+kMmOLGmz3C182oTCikXhzrVQWaodZXYcgNQcQ0ZKZHKTUOZnJ2TzTdY8yX2CgT1xaqjY/3E2wG8K8aBsa7w6adpzDCA9mPG2VKBZkmZpAYwD5kCrJS+mjkoI6lcGzlgvEUSDIJJy2NIkZFJGb+VXle75ecxLYVXchWqyG82KZIvAjPLPlDgcO4rw/f0mLZrAec+CvHUmtgc4ncTfvPQpm+AHfSisoG+UUB8WEP23nMiuX9Nvv/5MGxFR/uFQKkmACqKmdvTiAeDD+6cqCB111QBHnPKzGKqmE7uKM4/cNZAFZKCLORadLPg22sqQznK+Hm9f/blVudFPa0JGNL3RGkybmEFExXnARVMBKZFnjWajJ9UMGPT86ce5QZUhijAvr5yRvpx7hotX205ob/zz2EyHYv5l638ZbbSiSPoBF2/ooKZiZpqQjv26tqXSTZVo/HrF83PqTKGxyFBy7gwG6iGOs2JVjO+zUHcJJ2FYdUBNxpPDvbdqdbdQepq15dH5vi0uBxAGcpoPHFxUYlGOC3BCNsAh7tRDFWp50tohk7oQXM4N68oyKOTu433r2LOVp5mirQHw1Ai9LkTCk0BLddInuV0LVnK43dcXnU+l2mkSNSp4xl+zqkj3qEm2/mbewCotWkcqobmuR+Oej/g9A564SMmnfi4O7T+B5Z5eE0YW8OBPMLSO8h6Tv8cNKjJzlfq4b3QoIdaxe0GqKYLuFSeip1ycUQoxlWE4K0tsQ2n+r8nmk3V/CsM7V/a9jBtK7emOE43XHPN2X8KsW1ZIuqQWHFwn91VyBrBN663xONvqoTXl7JilnlISavGFu54GX/DbB0OgiemuEel1aoqArs+s8l9AdQqONi9q/juQuLDXV9RoLL9pbyUI0MXL8oC+mVk8pjKD0pfRoR1y1OqVFScV71eKmrwBCnPFyq+eggkmCelmAPC1svTXZHzH+nEd9Gw5n8wwf/A5Dw0KMK3/suAW/kLASqdlbuyPlYHO9514+eOjtm9JZhJqJGINW2JI38ZeVwAaTjGC8ljJuj+giG9r20Lc7iByxpTjXpne97qWsVmMatWB30IknPr22YEcJl8X4bKQYfL6mZpEVV12anFI8Bq6nPx9lQd5ffG8h+t7j5OOgruHSofqohMxLnw97KaFjCo6FEVzuRTQ/7PlYKnWEFJPH6kw6S+UqKFOWDiE8qdALShRv6uR9x4sM0oy8Tao29OmFROh/kfPqxz/pdqaNS1hPGri9dw9voEXjx/cTQAuudbVghYuGAWYE3NLgFex5hZMLn3YmO63tMQVv3vQgABy9vyK38KZ3Df5w3BvQnogq493zl/M+of/M+1spyOFX6edGzBsgxdf2Fsaw5mfP4eXhzvH8CHixMPKC1uRoXW5h8EHRiXrUZvOpvWEBqd49MKHFnlKXVS76ln8SD/8+zo2QE7xGN8fnT87f7+/sGzIzbd34QCndWbLKy4kEhNZG+lBOcKXQNfxi4jAVKW4qD0rDXq67Vo4Au3VmdNwr4HAEJRV7zrMnvPd4aIYWoelEyE5C5B/+fD9Hc77Y2fbiqQb1xqNK6HYSsciosoapV+3yCKVcaLvkDL2Jr8nz8c5FZntQuB8jBeYWeFkCjq3hJSjC7ghkS08VTVhaMGmlR059HFmM04sSN8bZU0dihYIlCps6/D50fH+7t0pU5zXFJDwe/zLBeCzuqF68xTfEOEn/lXAzTpTxl5/Cx33Wf/OoOOgQfRQ94pUI/hUGulT1Tiijr0uX6L4dMm3rkZlVWju+4dlpv6bH//toN8h05UevCyY+Eh8G+/yaHyMh2iefb/WDRnGGrC1NiaqVxuCujoge+j+OcSUIEcdI0m1OCmacnIl9Bz7e7a/XITjTL+PdLHT/RyD8vm1G2Imt1AWn0aUK/RHP3bSOwiGkZ7/l0lexRg9Uu/sXfTesfIrU+Plt0vLznFVAWWw5X36s51gqnqs4wP+FwzaQdc7S0PIypWt+/EsnnRYusgY/zPHZQ+VfLwsZ7bzUIqVZHCfxFeqOIFWr1SZRRMtrgM1Eq2J2MHFSPDptpBHN4Sc1EHaJIf/61B5zfw00BKuImpc/Mzfl3geX/zPMJvsCOV9bg1qxn32IqMxbjbAxzMBy2yQwgD/7ZWuSaJ9K9w/fffCA1By5upwoICFtSh80gzPQT430r5Vevn31VfNQVfPbyhreUg2Pmvf/znrgdTnq8w4WbhI/ayUt+GXpWdVH+PB7WLBnPj2jpi1jeE1EQ+L6o1dl3guQhcAVVR3sH1Ej6nG1uwoiTVehiwImx1phKf1Sqh5pywfSjZVHg0CgE73HsfaPdcJ9419jwmwhFhuVWpz4xcx5y7S7hu8wJYeZ4HPJ5D1IM7SAtshSAwtpSoB+6NKzFKfy+sULmMxQuEQ3fRsCnz1Wo1YO7ngdLzvTDW7L0bn7z68fxVn8bcVkWiah9IUYuWZqHKZXHcBe+Dp4MD/4YPY1Mma/zQ64o2m4ytq8WlX/5f+h6mYOwWr+1eJhiXtXdFeI/3S3g7UyhN9OuLHbbfrPSpFy0U9TJ+iW5uKJT6oMXtLX39OUftnG4vWjLNPeSHHCM39DnpztfrAtw5C0fXLtz58qfO5RQOTZI3c+7Hx6xX5O82Xg7lSo3B3RGD/qlRTOlsbfzGKXtbPzK+e3UR+eyp6VGvnEcNH2o97iZvbefqWaB/az3L5pC/kSZ/j+u/l4/7X+4cUDp0/zRJiuqs/w1b95NR
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data agreement</h1>

<MethodEndpoint method={"get"} path={"/config/data-agreement/{dataAgreementId}"}></MethodEndpoint>



This endpoint allows the admin to view the latest data agreement defined
earlier in an organisation. It also returns the latest revision number.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data attributes contain specifications of exactly what is collected.


</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataExchange</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data exchange details

</div><SchemaItem collapsible={false} name={"dataExchangeProfile"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AIP10`]"} schema={{"type":"string","description":"Data exchange profile","enum":["AIP10"]}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data agreement ID defined in AIP"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential definition identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"isExistingSchema"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is schema existing"}}></SchemaItem><SchemaItem collapsible={false} name={"qrId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"firebaseDynamicLink"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the presentation request"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the presentation request"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requestedAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Map of requested attributes

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the requested attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of restrictions for the requested attribute

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential definition identifier"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreement\": {\n    \"id\": \"65471222e8c7c3bb3c2c8492\",\n    \"version\": \"1.0.0\",\n    \"controllerId\": \"string\",\n    \"controllerUrl\": \"string\",\n    \"controllerName\": \"string\",\n    \"policy\": {\n      \"id\": \"65471222e8c7c3bb3c2c7701\",\n      \"name\": \"Default data policy\",\n      \"version\": \"1.0.0\",\n      \"url\": \"https://example.com/privacy-policy\",\n      \"jurisdiction\": \"EU\",\n      \"industrySector\": \"Healthcare\",\n      \"dataRetentionPeriodDays\": 365,\n      \"geographicRestriction\": \"EU\",\n      \"storageLocation\": \"EU\",\n      \"thirdPartyDataSharing\": true\n    },\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\",\n        \"restrictions\": [\n          {\n            \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n            \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n          }\n        ]\n      }\n    ],\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"\",\n    \"methodOfUse\": \"\",\n    \"dpiaDate\": \"\",\n    \"dpiaSummaryUrl\": \"string\",\n    \"signature\": {\n      \"id\": \"65471222e8c7c3bb3c2c5501\",\n      \"payload\": \"{...}\",\n      \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n      \"verificationMethod\": \"Ed25519Signature2020\",\n      \"verificationPayload\": \"{...}\",\n      \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n      \"verificationArtifact\": \"\",\n      \"verificationSignedBy\": \"did:key:z6Mkf...\",\n      \"verificationSignedAs\": \"individual\",\n      \"verificationJwsHeader\": \"\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"signedWithoutObjectReference\": false,\n      \"objectType\": \"revision\",\n      \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n    },\n    \"active\": \"\",\n    \"forgettable\": \"\",\n    \"compatibleWithVersionId\": \"string\",\n    \"lifecycle\": \"draft\",\n    \"dataUsingServices\": [\n      null\n    ],\n    \"openApiSpecification\": {},\n    \"dataSources\": [\n      null\n    ],\n    \"dataExchange\": {\n      \"dataExchangeProfile\": \"AIP10\",\n      \"id\": \"string\",\n      \"credentialDefinitionId\": \"string\",\n      \"schemaId\": \"string\",\n      \"isExistingSchema\": true,\n      \"qrId\": \"string\",\n      \"firebaseDynamicLink\": \"string\",\n      \"presentationRequest\": {\n        \"name\": \"string\",\n        \"version\": \"string\",\n        \"requestedAttributes\": {\n          \"name\": \"string\",\n          \"restrictions\": [\n            {\n              \"schemaId\": \"string\",\n              \"credDefId\": \"string\"\n            }\n          ]\n        }\n      }\n    }\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read individual
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-read-individual

---
id: config-read-individual
title: "Read individual"
description: "This endpoint is used to read an individual info defined for an organisation in the consent building block."
sidebar_label: "Read individual"
hide_title: true
hide_table_of_contents: true
api: eJzlWM1u4zgSfpUCTwmgyEk2ncUag8GkO5mB0YueRid96g6QsliSOKFINUnZ8Rq67ZPso+2TLIqSZct20NOXPexeEpliFevnq49VWgtJPnOqDsoaMRUPpfJARtZWmQDKQ+NJQrDgCCWgAWWkWijZoAZlcguScmVIQm4dv7auQKM8sjpQBkJJkFnjyQSYN0pLZQqYa5s9pyIRtiYXt86kmIrMmlwVnwjlbDhEJKJGhxUFcl5Mv6z37P1s1LeGYHYLNo/nz/+gLIhEKH5bYyhFIgxWJKZia/pMikQ4+tYoR1JMg2soET4rqUIxXYuwqnm/D06ZQrTtI2/2Nbvh+f3l+Tn/y6wJZAI/Yl1rlUVXJn94tmy9o6927GhQnfTWjCip9e95dKw/dfAgqKB5YRSMsff3JWptl3oFlZWkPUdgux2WpcpKqHAFjnJyZDICbysCZXxA/qUMi9BLIGdQg1/5QBWcOCqUD11q+sUE8sZkvIAaZrcJ5LYxEocFoJCdpnAzMmA4x+YQGFnRTIaVsYFRNSeolA/4TAaWKpSA0HQZNRgaF1VstKUw6xBZsyQDqzfXLg05XpOUKUmg+sMcZdZJqMlVKniosK4ZfcECHlEPaOTEOpZG8MoUmnZdcXYJGRrWwho8LYjlN9jGwhFVZIJnXL+cGRvOlDmTGHCOnsQ0R+0p2YeCPIRbInLrKgxiKkQi6AWrOsLg+urN1QVe0jX99c31387Pzy+u3mTy+voAFA8lbYI4lMXYkVS0rLlL+uwHbGg8uV/6n2lmq4OzPw044ygbG0pyI6RM9lDUQVR50OqZ9Ao+zmZj4x6iYX/WQKpQHZbJ3Qbfs1tgPeBrylSuyKVwA53KFH7l5G8A+7VT9VWAdfBV7IH9q0jhHRqGb+RHZUBjIAffGnKKfAywkmSCCquPzi6UJPcjgT6WbJxfXB5JtvKQ2UZLNgYN/Po+gXkTIh8bu4QlgbSx3EpcEOBQBjaHjYVQ9yb6FGa3b99GyojbK+sIeqLs0d22bfJnyOruJTj0I5790jFxMqSpLq0h8bhfFh1fH8Zq7PoHrHpioZ0yjpHH6niwxwreOcLAIWFYcw6faZVpi89MBeDZf9b9pOQToIenqPYpwjPa/90D7ngbzG5ZpHP1uyIf4zbe3/jygw0q76+VB/tM5vvyt7RQsfqYUY8GR8Ydr5XVcW2rmk5+vz89ojARZJqKU4tGOqv4YlXWi8c2EYy012C/fw43ET4q76RAyWPmt+1j2yZ76GNE7inc5TsKTtGCJPgmy8j7vNF6JRJREsrYVKxZ/qq708dq5si1XTcBhibkiODFDzUDu+VAzln3zspYE/x8u3P8476f+2Wyld4GWJlARbRyIJOr8/P2iPojSdnyz9sjjrftkUB/NtiE0jr1D5JHQnP1fxyaT+Rt4zKK5BsvkIMAvfnBRvJ/K0Azs2k7yS3IQTxmL0ZtIjxljVNhFZvkm1q9J3585K48YMFDwW6L/JiIikJpeaAoKDrOQ8BUTLrxYrKlk8l6dyJoBR/FhhybM26psr2dIhGN02IqyhBqP51MJFX2DGuVqsKhCamyk8Wl4Ftyr1sPWPDN+4oa370+oulxG4R7xkKXwk0ohlxgt9DPPl0Ut9PPTV+nEVsHDHzzccbXH3A1c1PQQTAFbiYXqJvhpn0a6XmC7hioGh+4A6kd5eqFZNfNP3U2whOcGBu66zQ4VDqGocaMThOgtEj31E6hF/xpZRvHETl7ptXPT9x9sHu53ZQNZrFs+gtZ+KaurQu/DPHbmf5+2y6NA7/dfADRQQhO/v3Pf51yo4pwvySpfAnc3AO9ZCWagmLPsCA3XNgxzXx7bpqrOL80njx40vmZtwtypAoztGFJL49zTZA5isuofQIIUhUq8EiHWlPoGhSrlYTaSgiUlcZqWyjyCZDBeQwwgqElaFqQjt0el1ucuOdKc9fHSrAJtsLA2zNb1VrF7jcmL7rnqGh09MfHYRHi7QnYSBWinRUaQ46HHq0yMp62DZy4qTErCS7T84OYL5fLFOPr1Lpi0sv6yd9n7+4+3N+dsUy7bSu3eWCgSps13I1uoMw12+Xr8vzyKv1LehE7KOtDhWbHHv60MG5e5JjUBiL+L38H6Qs40EuY1BqVYftjwNY9fX3pv47E6t5xYDr6qPGYiNL6wNvXa547PzvdtrzMg0mkzUQs0EWIdSynPD/LYUB9NSInn/rL5xRe/ehy1I8NOxmmpsgl3bTzzOQ1/ijTctvYExdb1225yTKqw47wwSXZ7rL+b3cPIhFMZGNufI7c2D/sfHAZG7ZPk50J/Hdn7BmL/MSYfE+rn4ft3ZtXBQZq3oSAHW/b/wAi7stK
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read individual</h1>

<MethodEndpoint method={"get"} path={"/config/individual/{individualId}"}></MethodEndpoint>



This endpoint is used to read an individual info defined for an organisation in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"individualId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Individual retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individual\": {\n    \"id\": \"64541a2e6e7569000145cd66\",\n    \"externalId\": \"user@example.com\",\n    \"externalIdType\": \"email\",\n    \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n    \"name\": \"string\",\n    \"iamId\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"pushNotificationToken\": \"string\",\n    \"deviceType\": \"android\",\n    \"mapperId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read data policy
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-read-policy

---
id: config-read-policy
title: "Read data policy"
description: "This endpoint reads a data policy with the latest revision info."
sidebar_label: "Read data policy"
hide_title: true
hide_table_of_contents: true
api: eJzlWW1v3DYS/isDfaldaOVdvyU1iuLcOE3cFklgJ3fAxQYyK85KrClSIaldbwx9u19yP+1+yWFIad+TOkg/3X2xtRQ5M3zmffSQCHK5lbWXRidnydtSOiAtaiO1B0soHCAI9Ai1UTKfw0z6EnxJoNCT4z1T6aTRIPXEZEmamJosMrlLkZwludETWVwRijfhfJImNVqsyJN1ydn7hw0B3mn5sSG4vAAzAdRgxn9Q7pM0kfy2Rl8maaKxIv4VKF6KJE0sfWykJZGcedtQmri8pAqTs4fEz2ve67yVukjaNt3keN4ziVeTYnGlQDnw/diQnS8Zr21Ysp6gcl/kfcu7XW20I8fvD4dD/pcb7Ul7fsS6VjIP8B384Vi+hxV6tWVwvYyn4/VX+Cyw8tIrXlhAvnHjXpeFmZLVLuoXtYAL9HheWKKKtAepg6Itoap6ddgCtXRBQPAlepAOLE3IkgBvAB3cJIEcX8oapcjeJLD34uLN1X5gYWaaLFOLp3QudQELno4t6H6gjR9IPWBCY3S0gHaJ9fuoizRprEpu0w1opNiGP00mxlbok7MkSRO6x6oOIJ2eHD8ZHR4e0tP8SX40Hh/lh/mTJ8PRFmxJ2xvAY0lf0AQb5Vf9Z4vqK6yI4WCkuy1tmkzJOhnV/zhWo2yYDbeI/z2SWacPe9JDjhomRikzC28cVVOyEGnvswSM66O5l97X7uzgoFvJclMd1FZOMZ8PPnPvN2Qr1Gxm765+B/QwK2XOkUU6mJKdw3Rd9mjLQe5xsEmRgitNowRo43kN+TbRDPMSdUHA5g1eVsQX+qOx0gmZ+6/C9fm7Lcl/XSXUcoQQjfN2fk25N/bxpF8SKl/maGmLxWVHElyk2abBqa6I44Q0+g1ZacQFzt0KO6k9FWQ/x+/o9GSTDbs72J4o1IEqu71gym2aFGQKi3Up8yvi23w7eC8WFMGukGzTxHljsaDfTQx/38TlOtIC1RNr08SX0oo3aP2cr31dYiC65DI2RhHqz7GJeWUrW1oBNdOMPu46qm3bposs8aUIfdXv2Y7R3xekycr8+2WKrYwgBTnWvrHkOse1EpV0JKBLIy6G6jnEvPGdAyd1oQismWUQErwMZzW4JiY+b2C0D7md136hHScLjcwnRO3DfcBGSC91kd3oG33upCCYWFMFKW4S1+Q5OWc42udGNZVOAZeSd546JpaSz3K+UCa/I/H4iC853cZbvYrBP+IZ0nB8ZNXyJrLyEyr5icS1xtqVxnercfElujJooSLnsar/+gxyerojg/TahsuLYPHLqzyal1jN0NtBlQE3jVNzVkkgf5PAuPEc2cFTXmqZo+Lw6Yx2q2pBpUgsTrFQN4GzbirGfpPvMqqvvrii3FiR3LYrqvkmGJ8e/3C4dcu3nA5+6xNDV7yFYmSGbsUjknbNLB4tyEOWZe1Orqu85CYr9hgS/5C+NI1/vX39PwkwncFvJQIuB4Ozo4ce1HBRRRMPY4X6jkP2DpOHGTt5jipvFLLrwroHZEt6Fc45Gjj62JD2as4mMZHBJKTOwu12uNQ3Itq7A4kYPfc4iqGDX69fv9rnBwROsxmc17Wah2V4htoEG5afYhF6zfZKvLsmC5fP3/4CV788g6dPnp5kAJc+hEWU2nF9EAxmIkkJ15tPtHeg+5xqD66JUeySq4s1sFZ/9wBkN7qHZiWuPBoVHI0P8yNxTCeT0y89bwHHbFj+XTrfu355PhiFEm4Z3h4t0uHw8HgwHA1GJ29Hw7Oj4dlw+M9tT+jpsgzBxvo4zzZWYl2TJpEx+MsAc3n9Gp6eDkfw7u0zVjctCjNsfGksX+LnOdv7VIoGVXSdbW+IbzmCppv91Tqp174k+1Xx5/jkeISHdEpPTk5/GA6Ho+MTHA+3q+qrrnOh0PFoQFFJDY3jYpO9tEQHuSX0XIyWoUHqsjwbS58oo2j3g8ndIOT19WpgU+QNICbrhDkYaQPK6CIIsdWdp7HdYoGld7AQgiWqLQmKP7/Ofh9nvfnRtgFhVZMdWHLScckCaL2cYO5jRVF3WQxsSCcp5KaWJOLLDWdbl/+6L1oef4lVUbMs+0ZZYW9GIIz+zsOdNjOQXeO1sSvkqZAuwFjuX/a5ZGzTjToxLO0o2bs+zpK3kqYken1OGqU4J5eEIoxXHpjAcZwyrNMZI0f2uvGwGMfsODj6qvHEaq1G1hr7zAiu0sLzxQr7282LblZfy9O72puF8o6Hw3YH+R26X+r75x0Xb9sdSL/Ty2iyA5rj/2NorsiZxuYUOu+JafQ2QCdfOdr63wLoUnuyGhVHK55BBDYbGIXCIW+s9PMwBz2v5W/Ej7c8J/RY8Hg0+ns3x7tNk4p8aXiuWlC4Oc9Dz5KDOGU9iHHh4KEfjLax6ZnuHrVeUGU6Abs52nKQI6gyA6xlJguL2mfSHEwPk+3h6bXHoissd5Fx8fUOSrfL28cKLuiux2ChBIwL3Rg2wrecw553Dhp7/K0W+s0l3NEc2I15whFtj1tggimqZjF2+7BG5wNENlA1LsyVaksTeU8izoc/RBnhA+xpw1VMSeAtShVgqDGn/RQoK7INsmfQHfxxbhrLiAzuaP7Th4xn0gkPz3t/wTz4C1UoGUvX1LWx/m8L/Jb3ly+WS+vALzdv2ebiEOz951//3ufSAeF6RkK6MtbhdN/Nz7jzn5KVkw67oGaZMyRmyk18qPEaR9wKqcnA8cCNZKFBCkbcz9PuPI4VcU0UllG5NNT2hfSoYMatpw/MnFFSQG1E7FWNMoUklwJpHAeAETTNQNGUFGuP/To4P46lkn4eiGDjTRX7ndxUtZLIpVpQnogDryL0Q9wASw0IIW3G+UaQs0KtyXIpoGRO2oVI0ptcjXlJcBiGreuYz2azDMPrzNjioDvrDn6/fPb81fXzAZ9pl6OfpR7YUIXJG+6ge1NeDIBDSZ4dZaNQ6hjnK9Qr8vCXlS/Nl1dC8F/xcadzS0/3/qBWKPXKqDgGo/fdJ5/VGcHZ4kvNbZqUxnne9vDAg553VrUtL8dPLCFKScdqELtb4tUL/cmnm53C3nF8Wf+CE4JBGPDf8g8brPUrRdm76hLYPnz2E9ZOefpAp+erkvRyLoBreabSxT+WLL4+z7lrXTm4lWTb1aTx4vnbJDZJ6yH2LoTY7oGp7xRqM9pGEfgv54WdR35k0/6N5j8ttsc3nz2wiPBxN0N027btfwFPHOAF
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data policy</h1>

<MethodEndpoint method={"get"} path={"/config/policy/{policyId}"}></MethodEndpoint>



This endpoint reads a data policy with the latest revision info.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"policyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with id revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data policy retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A policy governs data and DataAgreement in the realm of an organisation that is refered to as "data controller" (GDPR) and owner of referencing Agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"policy\": {\n    \"id\": \"65471222e8c7c3bb3c2c7701\",\n    \"name\": \"Default data policy\",\n    \"version\": \"1.0.0\",\n    \"url\": \"https://example.com/privacy-policy\",\n    \"jurisdiction\": \"EU\",\n    \"industrySector\": \"Healthcare\",\n    \"dataRetentionPeriodDays\": 365,\n    \"geographicRestriction\": \"EU\",\n    \"storageLocation\": \"EU\",\n    \"thirdPartyDataSharing\": true\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read webhook event types
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-read-webhook-event-types

---
id: config-read-webhook-event-types
title: "Read webhook event types"
description: "This endpoint lists all the webhook event types that you can subscribe to. Use these values in the `subscribedEvents` field when you create or update a webhook. The list is the same for all organisations."
sidebar_label: "Read webhook event types"
hide_title: true
hide_table_of_contents: true
api: eJztWM1uIzcSfpUCT0nQbjnO7EUIgp0dDwJjkk2wM7M5zBhWqVnqZsQmOSRbstbQLU+SR8uTBEV2S60frz05LvZit8j6//mquh+EJOepwkhSTBeoAxVCUqi8clFZI6biXaMCkJHOKhNBqxADoNYQG4I1zRtrl0ArMhHixlGA2GCEje2gQgOhm7OsOUG0JbwPxGyBYIW6owDKJDGzHZl8zZLCDBaKtIR1QybL8oSRwHronOQnHHSX8K6hZBaokKQFbAkW1icrra/RqIDsTCg/mo+Gya2X5MEuEv3eFsKqAfQeN1A1aGoKMKe4JjJQodahhGsLxkaQ5MhIsNn8JK38aEQhrCOfdN1IMRWVNQtV/4tQ/pKNTd694zCJQngKzppAQUwfxNXlJf+rrIlkIj+ic1pVSdjk18CpeBChaqhFfnKeVUWVuSuWY+KPaLCmlkw81Td9OMkrHeSNI9bLgXYnKIU39JQBbFV1PqcFDSgj1UrJDjXUakWB8+Np0QUKg6iCzzAsA0QLkjRFKkDatdEW5SifsSHlQWLEUhRCRWqTyWyamIoQvTK1KERUUVOO7FMOF4JM14rph4G4RK3tmqQo9iddtHd075TfiEIk7dnGUhkVVeqK/jzbeXo++FJWaCrS+oTj5HzHcSor6x5zDJZKFQbzb7fFEJdUq2Kb2X9Ev6ToNFb0F9PPxcySoN2LerwAUq+RX5Hv2zMAZnapQqVt6DwB1p5SgsBTZb18Vnaf9GafWyYdW8u/7/b673b677L+89FTtYqof0Gt6a+2TopdlgPrJOhs5GTHvgJyfxiqWGDBvzxJMlGhBhVCxwWQGmd8sSKvFj0ijFCPIQOVydh3fXP9yrbtgXVoZLr7yZG5uX7x71fj2+fl47/H53hivDwKxEhftntmHRkly69mA/iip2xjMvAm2TzY+/OBvVlAr6AP9F7OnLQ1NWNNAmbNMD/ExHkbbWV1OSqf3pB9lEu7WJC/457LcH722lNFapUa9JRk/3jHuXyaCqvlc4gqcvFpuowh58mG0rqTZNQjNNEuyZwY3qRQPqKSZ2EumOdQH3n7BO2x084T5yY3gadPHYWYslWuvnmCakja45TjH9nOZ9L2EWDqU3zZ8qj/1CnPK9aH542upzvuKYi83Zlh579SFcWWDTls1J/eiEI0hJI89z8TvLj8+rP2kLFn5L31r6wkbjB+vh5pO7GnONph9tx7JFImUk2e5d1j6xiMXlxebs+IP4NeOxbxD5SgjOsiOPTYUiTP4TgNyHuDXWysV/9JNXcYmr995or2vxWaGxPJG9TDyE9qjmK0LUSgqvMqbsT0w4N46dQb4sfbLfuIdeBY9LXKbrcUG8ubck3Ja4yNmIpJ3psn/YYfJgn/L2Jf+tmAkDQc2nhNre3tE4XovBZT0cTownQykdTaC3SqVLVHE0tlJ6srsS2OZbyNWPOEfkRMyNdnJN3unX/LNZBTN4RglwPMB4VQrC1HTxTCYMu3L/vySzV1Olh/voElbYCLlBFyvAukATi80swO5Mwgq4G2CxHmBM7TQt2ThLWKDcyyjTCDL4zNqzhEj0qnMDis6MsCqKzLI7FT6Bm/3djOc0QulrT5blYmyFNmYYd2wSq1C7WoOJahc876+Pdd/Pb+q+/3R4eB3xOflOaOCb7447ffv+T3QIS3a5IqNHkhpfv8Ppf2ivEeldKsKg6JXSkeRHATIb3ABNKLi2BX5EnVBlSaSXFT9Pw41zTazgJvcUdrDysLVisJzkqIVDXGalsrCgWQwbnOm6ChNWhakebscVun3se50ipukhB+TWkxMnllW6dV2g9T8pJ7nupO51dcfo1FWHRac5lIFZOdLRpDnhcfrSoyIQHJUHIOq4bgqrw8ifl6vS4xXZfW15OeN0x+uHn1+p9vX18wz3a/Ju7zwIUqbdW1w4QUheCezfm6urx6UX5Tfs28zobYohnZw6/L5z4sHHfDCIn//43ic75R9EAU6T5OnEZlOA8p8Q89An/ov1yIQgwYzENjhMK3hWhsiEz68DDHQO+93m75+FNHPkF+IVboU5ukATBMigTbS4ZE8TJtd1wa7F3CxqN5uh3PiO9fvxOFYOw7hNNlgtP+gaUPV2Yzkn2MrNkE/ssz4CzLt1zGb2jz3Y483zzKsEPzTM2Rvd1ut38CqKXudg==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read webhook event types</h1>

<MethodEndpoint method={"get"} path={"/config/webhooks/event-types"}></MethodEndpoint>



This endpoint lists all the webhook event types that you can subscribe to. Use these values in the `subscribedEvents` field when you create or update a webhook. The list is the same for all organisations.

The order of the values in each array changes between calls. Do not depend on the order.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"consentManagementWebhookEventTypes"} required={true} schemaName={"consentManagementWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`consent.allowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.update.initiated`, `data.download.cancelled`, `data.update.cancelled`, `data.download.initiated`, `data.delete.cancelled`, `consent.disallowed`]"} schema={{"description":"The event types for consent management. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","title":"consentManagementWebhookEventTypes","enum":["consent.allowed","consent.auto_expiry","data.delete.initiated","data.update.initiated","data.download.cancelled","data.update.cancelled","data.download.initiated","data.delete.cancelled","consent.disallowed"]},"type":"array"}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhookEventTypes"} required={true} schemaName={"dataMarketplaceWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"description":"The event types for the data marketplace. These events occur when the server creates a data disclosure agreement record.","items":{"type":"string","title":"dataMarketplaceWebhookEventTypes","enum":["datamarketplace.data_disclosure_agreement_record"]},"type":"array"}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhookEventTypes"} required={true} schemaName={"digitalWalletWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"description":"The event types for the digital wallet. These events occur during a connection, a credential issuance or a credential verification. The list contains the DIDComm event types and the OpenID4VC event types.","items":{"type":"string","title":"digitalWalletWebhookEventTypes","description":"A digital wallet event type. The `openid.*` values are the OID4VCI and OpenID4VP event types. The `digitalwallet.*` values belong to the older DIDComm protocol.","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentManagementWebhookEventTypes\": [\n    \"consent.allowed\"\n  ],\n  \"dataMarketplaceWebhookEventTypes\": [\n    \"datamarketplace.data_disclosure_agreement_record\"\n  ],\n  \"digitalWalletWebhookEventTypes\": [\n    \"openid.credential.offer_sent\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read webhook
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-read-webhook

---
id: config-read-webhook
title: "Read webhook"
description: "This endpoint reads 1 webhook of the organisation by its ID."
sidebar_label: "Read webhook"
hide_title: true
hide_table_of_contents: true
api: eJzlGdty27j1VzB4Snaoiy+bZtWdnaZWJqNJ0uzEzqbZxGNBxCGJNQgwAChZ9eitX9JP65d0DgCKpCRX3stT+5LI5Lnfz+E95VAZSJkDTicZkxYSysGmRlROaEUn9KoQloDilRbKEQOMW3JCVrAotL4lOiOuAKJNzpSwDHHIYk2Es2Q2HdKE6gqMfzzjdEJTrTKRvwfGPwYCNKEVM6wEB8bSyef7Pe5AZtOGTcPVaS8I0oc7VlYS6IQ+e85OstP0jJ/Dt9kz9qfF8/Q7PoYTmlCBpCrmCppQxUqEjqRmnCbUwNdaGLSAMzUk1KYFlIxO7qlbVwhsnREqp5uEWrf2zKzwXDfXiG0rrSxYRDgdj/G/VCsHyuFPVlVSpN4Eo18sKnXfYVAZNJATATsK5dGkfJd5g7TSfaYCxdUm92JXbC014x+MpEnD8QoFTqitF2jFBfCXS1DO0oRyYdlCAiJaSA2417DG37eiurTyJzAii2LShDpRgnWsrOh10hhBL36B1PmXztugdWHfZy+2fgrurkMAHIqVIUEHWzBLkQJhcsXWllhQ3BJYglmTTIDkAVNYEkRICNylUDkyt0zxhb57hwaZYzT0zSn4vg93hf2gxNcaiOCgnMgEmJ1Ye2SMbRq3/HaGvRxyBXNEr5Tty4IR2NH5d3CLZP6LN4IbvN2jF5Rck0wbwtpERDEXILXKLWYl29LlUEm9LkG5IWkDwkAKYgk20EI5wMcnSoU1Q68UsamuwKvaCfDjir5/E6TZsugWjEip78zCucpORqP4ZJjqcoTQdiRyw5RDEbppdVSGiwBMEGq3ZHUlUHWJybxXGZLeo7vBarUaZNqUg9pIUKnmwOn15kB2t5LtJemhSrBXYb0TvNg2GLEreWPQhAhFzkhudF1ZdGoplCjrEjU9adQ9I8wYTOKyto4UWnLC+oAtr364GchqC5Yw1QEJ0ghLlHbIHllIYV0TL16YPh2uIYAbKPUSCK+DSYEsmazB7peJFKu3cm+ZYjlgxH5sy3A0q1fqkL8RkZRbzK4lvVi2jfA0rQ1ZFaBQRaG4WApeM0nykBBma4EoT4LPmL31icVBgoOEcL1SGEf4rq44quUKEIZw5hiqJhyU9nioXm7DIsjXCUtPKdAeCiWc8MNB0nueMpWCDN0kijtkUupV7wm2nL2HrHb6Bu4qYdYN0aDcPrNG2QNvAkZXjD5G++Z6s8HmlwvH5EcmJTzavdOARFYeq+/al747vZtNz3+6iG+873y59FH5Zx+sc12BEnz4zTyGH2EGQrnHChif+ShnKtKboXPfVaDwrx+JUA7y2EIVAA+BReZRpyBdh0Eoxxg0no3kYMh0Nr3QZUkqo51OtRx+UV/UVUe+1IBvEUwipRiymUbveTLC2hoMsYL7ytaRFe7Sgqk8ZnNDr/B8j5INYJ5sH78ygNES2tI3w+XZLjZKsDVRI8OEzHFaAutuEHuetH/HKsbnhClO5l36Nyy9xRepLoFkRpdetKWfiKJwyQGsChQXKn80wa6uX9Qfkqr7ztNZBsYrH2bvg68bWxwEaX/eeKcfhfLKHgfCie04XEjsw2AoDqb1DQclHoBx+hbUnuD70dhhGf34SOgdbY/A7irdC+tuqA6XZ0egGqc9DLkfgo+EjRZA6FAtmWNvmbkFV0mWwqPrJXOMlC3e45qh6/Tu1ABzoRmGRmMJ852NcGFTqW1tgLDcQGi2BlJt+B/X9TqyD/Hvm5brzZbrTeCKlgqdJa5VLfOF1hKY2uP+EdWd44o5Tw5OWETpaDMOUmCHCRP/dl07rqAHJbewbue4xrihP2mSMpnWMk4OZP73wewVTruDS5Er5moDc1IA42FVAJYWrTQP7Qe+8+B8lkpghji489NaWOFaLcOenBCrfSOCNAjYvCDMkrWue+9uIdrgwJr6Gyy+NyT6Kh82kas3lyTFqTAL42KcaOPgTj68f+MlaVfj4zvJ1QVB8IcCnXejwI/X80+fPn0avH07mE6vimJSlhNrf57j0lUy98CcG1pf1xHaj5hxVOutPKfj02eD8fPB+Lurk/Hk5GRycvoz3WzwjLG/FRzc4ocUo757k2iOFnuXgpAfPbLvXtOEhujCdEWA8/HJr7qYdFmDMdpcaI4nD/972uF24HLRn/tb7NaTftgC0zXa+Xi8OUD+gPdbO/+VcSJUVTuyvW6hOfYN8kGx2hXaiH/4NrFrmvP/Y9O8B6trk4IP8kzXiocE6N1JCuarZhOqK+EKn1S4VCkym/olqltrhY27lO8bfXt/+yuPd/9b9p4pB0Yx6SsMGOLZ7NgodKPaCLf2t8kXlfB96fM1lhDHcrzhbg+D1wktwRUaL785eK3xBjuho1BSRtEpo/vtNXbjz5PI/9A1eAqljuLRhNZ4F9pecTiUesAqMQzHm6HQo+Up3SS7NC4dy4XKHyJjw+sDlK5b3S8xBILnGgu0s1F4EI/OwXjt2flFzPbm0LpzOf1x5ns31gScIdPOWS6W9tCU5j0624btjy4LIJWBTNwBD/kwDzKSOXmidGz7zjAhvRkqlsLThMAwH+6QnZCI+P1a1wYtMriF9Q/z0AKEynSTLSz12QIlE9LfnKpKG/eXrf1a/cWr9lHf8C3wXmRukciTf//zX08xhxm5XAEXtgjjYbMA+l1s2RkStu2yMnopcFQns7iqW5DZwOolGBC5iidSt04iPk51pB3mbYKjaP8igMysloKTSnPiIC2UljoXeCsDxRbewIwoWBEJS5D+aoVZ5j+KLIQUbu2J4E2kZA7BU11WUuCaE5zn1TOQ48QmtLI4JTCS1VJimHDhvJwlUwoMVjQpUlDW15Em5CqWFkBOh+M9m69WqyHzr4fa5KOIa0dvZhcv/3b5coA4m/aW2PoBA5XrtC6bHYImFHM2+Ot0fHo+PBv6q3ilrSuZ6siDX3+acrybAZ3i+3s/PMV0xFl0VEkmFEpTh1NyKEOf4+comtBWnEn7Yeg6oYW2DgHv7xfMwgcjNxt8/LUG46teQpfM+FAJ1Wq7DBz6lNZV7sn72DuekqOfuA5q0lQbhaXG1wY6oTSht1iMOl+3NngwjlUIRQzvX/jNtIO51+g23eL96uUVHqdrtFq30N36Qhd/IPWDUu3WvCAC/ovV+SDK9xhgr2H9wxY8vHkQYVtnAzTaCBe0/wAFpTcY
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read webhook</h1>

<MethodEndpoint method={"get"} path={"/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint reads 1 webhook of the organisation by its ID.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to read.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update data agreement
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-update-agreement

---
id: config-update-agreement
title: "Update data agreement"
description: "This endpoint allows the admin to update the latest data agreement defined earlier in an organisation. It also returns the updated revision number."
sidebar_label: "Update data agreement"
hide_title: true
hide_table_of_contents: true
api: eJztXetyG7eSfhXU/LGUIqmLJdthnTq1tGTHdOyYq0tcG8uVgDNNEhEGmAAY0YyK/86T7KPtk2w1gLkPadJW9vicZcqVosiZBtDobvTl65n7IAIdKpYYJkXQD65mTBMQUSKZMIRyLueamBkQGsVMECNJmkTUgP2OUwPakIgaSuhUAcQgDIlgwgREBKjiDBRhglBBpJpSwTTFcXpkiLS1JApMqoQbwRGOiII7ppkURKTxGFQv6AQyAWXvHEZBPwilmLDptb18kA0bdIKEKhqDAaWD/of72sKuBfsjBTI8J3Ji5zP+HUK8i+GvCTWzoBMIGkPQD3BBOeFhFHQCBX+kTEEU9I1KoRPocAYxDfr3gVkkeIs2iolpsFx+dBeDNs9ltMArQikMTrB/H9Ak4Sy0Kzn4XeO87kukEoXrNAw0/lWZhL2Z83cTuzI/Zr4EwwzHL84rt3RqHBiI0ibhpCjznNcJhGziJ2b5QzQTUw4kSVUiNe42NSSkgowBb9UgcKeM7BEyIJVhCdMkFewOlKacUBG13UbGC/JdTMXiO8JExO5YlFKOc1Eync4IrZK8gFCqqHcjgk7wqSuk6TLRRfaMqYagP6FcQ3mLPgR+2igT7tN5iRMduyNKcg7qWvHK3z+hAHSCRHIWLoJOwOl8kvLnVDMddIIYzExG7ybXljQNDbvDDxOppmAMHXP8i7MJhIuQQ/CxU9tST7Zfl82R/Z6kIgJF5jMWzohBPawyVs8o58jJqbwDJSDqEfJ+BoKECqhhYkpoTRU7ZS11g2e7kWq3ERPGub0qgglNuSF3lKfQIXbnyjrrDQDeHkHIIsC7wxkVUyDMoJJbKlVTwOEOuNu4VTI7yli92c4Kt0Gp4k32sqipkHZ3YmqCfhB0AvhE48QO++T05OnR8fExPAufho/H48fhcfj06eFRQ2uCZWYWNiV97jlpeZFLUpUqyhkqGvLMX7LsBKg0zFmFzYY66h32DhvEf3ZkqvTJHnMaPJFo1J3eQ3wHijja+zgD5OvGo8+MSXT/4MB/0wtlfJAodkfDRXfFukegYipQNK4v3hBqytJ+B2pB7qpzH1WEVgGNOkTPZMojIqTB7+wR5WTZSyNqBzEsBlzQ76liOmKh2YqvL64bM39dJrTEYyNKtVGLSwiNVJuTfgWUm1lIFTSGGHqSRDuay449BC4Ajw8mxQgUk9E5XejScEwYmIJaNd7jJ6f1YdCq4MHriJLEUkUFjpDyshNMQU4VTWYsvABczdcz74ecIlElkstOoI1UdApvpDt8vmqUS0eL8IzYshOYGVPRiCqzwGVfzqglWowylpIDFauGcad9w0VSEUmQptNx7akul37HBsYoNk4NlDeKKkVRIZiBWK8/z1v2i+Yks6O7empr1Bj4REPDF2SOpzXDKzmH0EDU29a+lmfw4Hb22WmLna2ukgzPtze8PzXnXrW0OfkO2jzChDZUhEBu7EA3AZGK3AR0CjfW7FcIbTqJlynnRJQGLRyc5pqLvxpTtMoBQjPD7phZbC6yflNrqlFQwpGiCrNxqJAamEq12HyhI1BaipZVnXlS7QPpUCZb7Cma/KaiIw2Sia3dy/pAy2WnqVdVMS5ZorV6ul473zBtcKUVauu0rTqJUEF0DpPhFir16vH5+6O31+9/WTy/HZ2++eFEXf3Xxav+4/7Zm/6zw7535JrboiBCk0+5i9CYFTunZy4GeYBJHPfPcG3WKgF5NyEXMGXauOCt/6TVXbm0g9uZ2P8+1lXvQSzgjT0OssCgZZ3F2t5SdQvWoQ5lHKciG2ClbcmoLlvjjbVjnbkJ4mCpBi/HKNCJVy+GjnqczehzJqQ0k3LosvG2+iCtKeWWGBkjtdxU5W5+NwvuyAHhMKX8VznmbOrihgO7XYqG+OsdM5T/ij4L6gs5IEk65iz81VB9625mhsXUQH4NTk+kMZ5NxeTqg2QxHLUKWh3EBoH5IO7mxiAoc+XobmOG4X79qmWqwubR89YSRHalGkiXCDwaDkjpluyvFMPtXzWoO2bp+BXjDZ36EM3rrcIkjJ5Ts8XMjw+PT7qHR92j06vDw77990tjCVcupgMiRe6qAzkfDQdEQSKVVbIpCEzPQEToxIDC8H00HAR+VpdpHFO1uG6PLJrDXV9wkih5xyJUitJwGoMqN6ruEO3IEjBhJTtxB4pNGESYYqBiQbItBueyodlFg8emgppUWX596k5uu7GMgKM1yn9p2KnsF5shSc1MKob74F1BOanF63v5DZrEdGFzIDNqU2M+Wg6ptsTilBuWcCD5tPT+2qC5PMkNMyJ0waU9SnXpXscsZ96ctNa+HOW3tXz7iupZ7RecGETPF3auMWhD4+ThHcjTNgfynWVSzuqEarScYxreoihoGQMZjIZ5blOTOTMzmRpMBrKI7I1+3O+QCIQ0Tu6owT1aEKqAUHITRIpOzE3QIawHPUJJIQ7GHzYYkS7AEIxpik3OtsVlVARfEPjEtNH2d0XRL+vZk8OzemPO3Pd6vWWrCk2YoJx4gvn0tN2bjrXVRqWhVVhNKHl9+e4nokExPG3yHOCEAY80uW/Z+D7p9XodskIkWn51stXywwCdBRqalp8yUWr56fVcvwIageqQXMr8ZW6R793WOpG4gAkoECH4S5w2XS2S6hfVy5Y9cuk5UmETZgB6ZOhOwFyVqlZwDBOJQiMWZoayhLxvF4k9lImZpW7Fz2A6D6+oTSnLeYyByJgZHGSiZOzSO36bx6mx2Tw3jLXEc6oi3WvYu83ECxavZ+MfQvaOvX75y4uLq/+8fP19r9dbbxazycyonrnsoyOe+QwFx4oVeS/OmWxgZgaqRXgwNmuVAZ84q9uxzRMJ0fHp6dH3+TKOD4+bPuqAzIHz7q2Qc0EcwcJWuIPRuQ82/a0xN/sz5Sxy6VTdJ1fPz3vEFldiNp3ZzBV8SqiIILKGiOg0wZMNosoqPVWN94KCzLhREjPBYsqJBsvb4m5/AxEQgtZULXp1Bo0extAM8WAVlPNFSfR1oTO1TF7ksk5eoO1eF4robGNN5rtWHj5Zr85mt0VB37sGLAv8tNXOFSu159TGq6VH4+PwcXQCp5MnbfLeuu5QLRKT57hQ+rN1WwGwJQ/ILbA9QYof5aTNlNYXk5nKzVfSIsUV2aKeYmaWkIqv/oRUoJ/itqRDWEyn0ClpL5iwPr/86N/cd2ZR/xYW/T+fvL2dtLH6OYQ0tScnYTZ2nTBQj/DkdAStgtBFI/FrLY+zypQIcNlha4L9YVi63x3z9jarSGwqmJj2yLDqotHaFues6LjktT0tM6OWx6fodBQzt3Edl/LWRntJbtEWmaPr4hRyC4uyvcxdzJZJCSm6m0wsrMyLEnsJ5aXk1CNts1a6k0eevv7aIRBTxgmNIgVagyZdz0tKtKCJnknj2DpmItLI6qqlfyAOe9NnnH8zBZUoLFE3smyPdIWPtv5sNwIH0h1CiZG3IIoDFOPuRxorwxo0mqyGxXSiPdgijl6X9LsYvLwiL4cv3pz3yaU/+1wdVgF3mYYZS8gYzBy8O1CONkqMFZFfuxuqFKFl53AoRQhKaH/2MI1jwB0VxgrjmQ/bXYVV98hIas3GHPJz66a0lJuAHKAjDBh+G7gJGowqDuWvMFLc2lesrWay1Dzeq/4gGnjLjfqmefmZIi1KXr+/LB9QzriRvYuXZ09Pj05t/asIWr4kjj467D9eEUdndDMN8DMLU6VAYMaqpKxMi0fGqnxewvPbqSVh5pGLNJAaqG6ipJxkLt4qz/crs8dDEdmEnnZ6Xj+o51QTDhNDxpyK2+w0aXEF7N14tZsrzrrwAbbJCTuAyNpcv0tpEhvWt0/bh4EIYvg5l/Z8b7JqQDbYTVDKRJVmUHjWH/PltPH9C8LcJ09awtwB0Ys4Bsw15/aCHLg4N3evMsUpeVg13vfIe7ChbSGBv6faOH7xzM44t0tal7ywO3vUJTL2kUP5ZeQiw+3sOTvkEzK0APQ4K+9tjrI2p4OHewmw4IvVYML9niuoeZjFV5XsGggVR9TaDAHzNriJznEriK5wwloGenydRrUMmB1waF7RpZxbaIdnFnPpikjRueigu8uMdnkEu90++ZD7/Na40zRiho4ZZ8YFAaGME2rQvKOV8CiBzyf9K+mx9RCj98NR35003pJVDYfN4xf7kDE6O9kxGTIBpYrolmlCilmTBCVJproiUVbZUfErU3PpfgwOrvHUvHSp0jV1ns3KsKk7gh21Kj4GWd6EwGxbePWl/06QF7Eb2bPtiqJrjWS0fk2uBrkdvqGlQoFwQO1BDdnI9WH41gCAlQNlpFYN5SEq51TPxpKqaEVmestRPVUSZWRJqnj7FFyJSyYgBgm7LNewPl9uvCr79B7C9w4pjYY1GF8kw9TjMZHAOAsyBqPhowLiqTvO5KNjjDF4BrR0aSOUj0tbefhqzfEFj38PlWlZzE5X/jJdaa3lt2JeX2C2SAdVMcEde/HJ5QiaolH59bPqZ0UZ/OUkAkMZ1w1kQZnmSMkJ463St4504m8rfM7BcHSEicl3w/OTn8+st9leR2nhuav1MweVcAScIDfG+wwYoLVyX2Q4LDBOv0C/BA/dOki68JRq8YXO3HXwtwbo+ZU3sUG1NE+UkI8taGcf4KFcoQdcdV3qA1Th1h/rtbfl0t2gE/TI7C4fHx7u4N07ePcD4uJOvj9uxR8/EC74yqVSCscZC1MV2TDS55AwaAuBJVaScAztAoiMkZtYB9dqYVN8+X1VKhthAhAonCHJilvJno8asnoYmxAh3VVM3El+B9F+dbSfVjgB7Wf9l463w/jvMP47jP8O47/D+O8w/juM/w7jv8P47zD+O4z/N4LxfyD4/l8Kwd9h77+YU9824H4Hrt+B63fg+h24fgeu34Hrd+D6Hbh+B67fget34PoduH4Hrt+B63fg+h24fgeu34Hrv3VwfQum758Irf/MbHa4+r8KV1+AoD6bdbRTP3N6QN5k9xFtbOLTDVMZoUfql2mrSxmaJaYCC8DMRwpkLtXtxD6mFkWujhzQTiMRBkGFYSGJgaJKabeVTlbb+ecwLZlVshmqwG02CpJLAu/6C3b9Bd8kZnrXX/CvrDK7/oJdf8E/p79g47aCKgh0eJ4/9p0JMhiOrF+UoxGKJoRNgMPtKIZql8G30aTQCf5ohUKjQ8sUoGU5Xwgas/ANE7et1yUK0BO14njhHhzfJiab2Zs1ANTSMMQ/oP4zcNT1gNMV9PxHiFrxcSuk/i1NHLzG31vCgTzA0lvIupl+GTSoOp2vlMO10KBttWLZANW0AZfyU7GVL5YI+rgSEbylJdbhVP96rGmK5l+haDtp207allt3etnrfYqohWPZwX2xKpE1IN/Z2hILvysCXpfKCmniICW1HJvv8dLu3SELfxA80lkflZLzIgls68w6dQlQI8nR/qrku3WJj/ddRgHT9jfiRgw0Nl7kCfSbQKchph+kugkQ65bGmKkoZl7UejGpwSLAOJ/L8HYbSDCLcjZ7hK3jp335ifuIJ771hhX7k3L2J0SXvkDhv3VfetzKXwhQac3c5fmxMthxVcfP6ke5rk7BjHyOhC9wSyz5m8DhAlDCIZzhc4I59i9olPvStlCLG7gpTaqS76yPW7RVNJNZpTzoNkjOjbvNEOAy+jF3lb0M59nNXCOK7LIViweA1ZTHYvWhWtLvleU/WN59GLUk3FtE3mcRKQ9T7vqyqhrQK+hhFk6nY432z6aCx1BASRx+pEWlvpKjmTpA5ALKPQ+0wUL+vkPcOLDNIEn4wqFvzqiQVobZn86ts/YXc2hYtSTDF1cvycXLM/Ls6bPTHsFXOOUZAuobzDysqVolgE8hJIbo1FmxIbb3VJhV/jtjgMfy1uzKF+EM1n1uMO6VRxe07fne5atB9+j/rpRlZSyz8yhjM5okYOsLQ1MyMMPLd+TZk8Mjcn115gClWWeUL23+idCBYV5qdKrT1AZf6ByeF+DIIk4pk3qHNYut7M/J6ckRPYYn8PT0yfeHh4dHJ6d0fNiEAl2Uiyw0a0i0T0a3WopwLl81cGns3BNAYckOSje1Sn695A18pmt1UiXsagCES6yKl3stsws6rjKEE8biQT4JH9xF4P7cTn43k97wcVOAXOFSgbY1DFPgUKxHUcr0uwJRKBOW1QVqylad/+X2ILfyVNsQKNvNlezNgUQSq7eIFMMGXB+IVq4qqnBYQBMSex6tj9no5/9MSmMPnSUElVr9On56+uRwP39Hnd/lSco5ntQzW5dH7wbJnrgHA1Spjyna+yS1tWf3mrqWG4+CbZ4oUPbgQCmpzmRkUzr4udzD0HicQd0nK+5u6zrMt/Tk8HDZQr5FIgopeN6ycO/21xq9RWFjWlhz8v+YNRfgM8JY1prIVDQZdLrl0yj+vRiU4QZtmQkUscPUeOQS6KmynXYf7oNBwn4E/PgRnx5i6BRrDUG1Foirjz3mNUhS95ZJMwv6wYF7C+UBulfd3Goc3NfeHbl0wdFd+0spzyGWfsq+4b3ouI4gll2asB6bKipMj8mDu+MAU9X1jlg6zQpsLWS0+7mF0seCH87Ts7uZcaVIUbgv/IsyHUOLV2UOvMpmrUC1UHs0tEAxVGzMHDhptHjbAp6JVvy3Cp3fiBuGxIiaGFsjP2GfMjTvb26O5DeyJ6R/FalRlDlkRUJD2O8Q6E17NbJ94m/820KmCjnSvYXF33/r2YfBoIpcFG/ufJEJYcujWopnPGAsu+45A55L7Y8LyHOveY9/devW9txXm95dq3S9X73WiL6qz9z2j69oCHeEGx3c7usVjdfYUN3SJf1hDbt8u7BnV2uT7/qm20obrY/3in7XciOrb07Nuk6ribkPlW7Nzdswi8Tc13RNLq0lyvsX172IqK1R8QteJlTpUCw1+VX68eoNcXnn28p3yNQ60wrTXmmVWCkNvgUpb9rJg9zS7WtaKNoaFlZ1IrRi9/PxVuLdW4Ds7XDyYFUPVytCux0XWwW8roCEBpWk28pwcz2Q0StOGTdYhuM1AHir83MlbJl7vkIF4JUp6CrgVCk4ayJsbJfmx5UAhzqsILu8XohtLaLmT1ljlVmU1Dv/rllCtHZvaZ8bMpGZM+abCizMG293vST/kR/FhdVjPxRfVQ+C4uKG45PfRPb+5x//ve9Q+ZdziJie1R7xVsfw5pAc1xAKyqYVUm3xAXzS1Qj5BzbN0v5mkQGDcRNJUd21uO+ITbH1l8wx22lcP4nEJp1ERi49KrmcMgSJg6Bj7mCNiBC0DxBCo24hXRYh4sB1lghNjYxpZgQTzuzTHKwf4LtepqkHdtvWLGJjsgykx7GrRwj3FnHOQhCuwTjzXhIazoActxy+8/m8R+3PPammB/5effBmePbip8sXXbxnWVQbin1AnyfDxmReUXHSo1r2HveO3KOitImpKM3HvdO8iVepPaUid/K/0de1e8/RwCdzkHDKROmxQ859/uBf4u41vFtebL/++vWPnWAmsSz+Ibi/x6j8WvHlEr/+IwVlPfhOcEcVc8YFvWym8XPUnvotM3DvwsdB+2TlG+Jbl5N5x8J6cujLOht8C4uWN8jbqpX3nXGC7qozN42utbQFlUbghk6/u2MQYi517bXliGV0fRV0grF/EX1sY7RA0Tn6PXQe9IObwJYiZJIXJu339wGnYppStJSBI7v0OcBqZHBrIwP/oYTUqrKlHiS4teD/S8ib6i1/QzX6ERZ/zy93v6y8IQ9M3NW4SVgt/F9qEtq+
sidebar_class_name: "put api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update data agreement</h1>

<MethodEndpoint method={"put"} path={"/config/data-agreement/{dataAgreementId}"}></MethodEndpoint>



This endpoint allows the admin to update the latest data agreement defined earlier in an organisation. It also returns the updated revision number.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data attributes contain specifications of exactly what is collected.


</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Marketing communications","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Collecting user data for personalised marketing","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"consent","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"data_source","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T00:00:00Z","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataExchange</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data exchange details

</div><SchemaItem collapsible={false} name={"dataExchangeProfile"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AIP10`, `OID4VC`]"} schema={{"type":"string","description":"Data exchange profile","enum":["AIP10","OID4VC"]}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Definition id for OID4VC data exchange profile"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"isExistingSchema"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is schema existing"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data attributes contain specifications of exactly what is collected.


</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataExchange</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data exchange details

</div><SchemaItem collapsible={false} name={"dataExchangeProfile"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AIP10`]"} schema={{"type":"string","description":"Data exchange profile","enum":["AIP10"]}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data agreement ID defined in AIP"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential definition identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"isExistingSchema"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is schema existing"}}></SchemaItem><SchemaItem collapsible={false} name={"qrId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"firebaseDynamicLink"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the presentation request"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the presentation request"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requestedAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Map of requested attributes

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the requested attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of restrictions for the requested attribute

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential definition identifier"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreement\": {\n    \"id\": \"65471222e8c7c3bb3c2c8492\",\n    \"version\": \"1.0.0\",\n    \"controllerId\": \"string\",\n    \"controllerUrl\": \"string\",\n    \"controllerName\": \"string\",\n    \"policy\": {\n      \"id\": \"65471222e8c7c3bb3c2c7701\",\n      \"name\": \"Default data policy\",\n      \"version\": \"1.0.0\",\n      \"url\": \"https://example.com/privacy-policy\",\n      \"jurisdiction\": \"EU\",\n      \"industrySector\": \"Healthcare\",\n      \"dataRetentionPeriodDays\": 365,\n      \"geographicRestriction\": \"EU\",\n      \"storageLocation\": \"EU\",\n      \"thirdPartyDataSharing\": true\n    },\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\",\n        \"restrictions\": [\n          {\n            \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n            \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n          }\n        ]\n      }\n    ],\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"\",\n    \"methodOfUse\": \"\",\n    \"dpiaDate\": \"\",\n    \"dpiaSummaryUrl\": \"string\",\n    \"signature\": {\n      \"id\": \"65471222e8c7c3bb3c2c5501\",\n      \"payload\": \"{...}\",\n      \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n      \"verificationMethod\": \"Ed25519Signature2020\",\n      \"verificationPayload\": \"{...}\",\n      \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n      \"verificationArtifact\": \"\",\n      \"verificationSignedBy\": \"did:key:z6Mkf...\",\n      \"verificationSignedAs\": \"individual\",\n      \"verificationJwsHeader\": \"\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"signedWithoutObjectReference\": false,\n      \"objectType\": \"revision\",\n      \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n    },\n    \"active\": \"\",\n    \"forgettable\": \"\",\n    \"compatibleWithVersionId\": \"string\",\n    \"lifecycle\": \"draft\",\n    \"dataUsingServices\": [\n      null\n    ],\n    \"openApiSpecification\": {},\n    \"dataSources\": [\n      null\n    ],\n    \"dataExchange\": {\n      \"dataExchangeProfile\": \"AIP10\",\n      \"id\": \"string\",\n      \"credentialDefinitionId\": \"string\",\n      \"schemaId\": \"string\",\n      \"isExistingSchema\": true,\n      \"qrId\": \"string\",\n      \"firebaseDynamicLink\": \"string\",\n      \"presentationRequest\": {\n        \"name\": \"string\",\n        \"version\": \"string\",\n        \"requestedAttributes\": {\n          \"name\": \"string\",\n          \"restrictions\": [\n            {\n              \"schemaId\": \"string\",\n              \"credDefId\": \"string\"\n            }\n          ]\n        }\n      }\n    }\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update data attribute
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-update-data-attribute

---
id: config-update-data-attribute
title: "Update data attribute"
description: "This endpoint updates an existing data attribute defined in a data agreement. If updated, the associated data agreement revision is incremented automatically."
sidebar_label: "Update data attribute"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zYU/isHfGoB2U7cdi2MoliadIOxoSia5CkxkGPqWGJDkSpJ2fEMve2X7KftlwyHki+ynV7eiqEvhkzy3C/fIVciJS+dKoOyRozEVa48kElLq0yAqkwxkAc0QA/KB2UySDEgYAhOTatAkNJMGUpBGcB2L3NEBZnQh/GsZZEmEHIC9N5Kxf/3joKjufLKGlAelJEurlIKWAVbYFAStV72RSJsSQ5Z2XEqRkJaM1PZdZRxgQHP1nqJRJTosKBAzovRzWrPzmujPlcE4wuwMzbPTj+RDCIRindLDLlIhMGCxEiku4zHqUiEo8+VcpSKUXAVJcLLnAoUo5UIy5JJfHDKZKKuJ81h8uGtTZd8QloTyAT+xLLUSkZrBp8867XaYVU6tjUo8vyvo8SOpI3iXfsuOlHywFJRGfAlSTVrhXo2nh5QBr2ERY6BvS+t1iQDpezth56xoadMj8VP0ZMYzVB72nXBTeOnrgaTZE9/lR66JxEz6woMYiREIugBi1Lz9i8vnr88HQ6H9Eq+lM+m02dyKF+9ODn9ipUwvhD1OmrfKuv9oe7NIvsm5uyafQIz60AZH9BIgtso6FaAdXArMKNbwdI7jL5Vid8qrcHsCFUmVXOVVqgPbd7+O1CRFfBkvApqrsJyR4GptZrQPKZBG9SupMstJ5bULXwWJTFQZt3y2w39QM5bc8Sq85bVcUFe2vI7YuoI0wMJl8wD1mkbY7kvqK7rbmJ3i26S7BXdmsCX1vgmzYcnJz+L/GeR/yzyH7vID+r4K0nXTjHgKynJ+1ml9VIkIidM43yxYg7Pm9rvMpoiz0ZlFWAzjxwhPP2uprFbluScdec25fyO3xfdAt3vIN2C3VJv/a5MoCxquXH285OT+gj7I7HaxuftEcPr+oirrw1WIbdO/UXpgWtefGc//X+5ZmwCOYMaPLk5OYhi9nwUu4GsXGwFNytxVqo/iD8nPHwGzHj8bfK5A2UFhdzyDF1W0XgeeUdi0EzUA66a3mY89+3/Nf1gtTcT14K1YB2PDdsXVNjWBJGIymkxEnkIpR8NBikVtoel6qvMoQl9ZQfzoaiTfR6XATO+fjzCxjfbRzhNtv655DRporv20iZM2Cy0F4DGwdsrwFmboTHtDrrO2Ycx3NOSLys5mdBmZx+ucoI56mrT8e86fO6gEQNF5QNMCUpHM/VAKSxUyOGu0RHu4ImxgSKD4FDp6IYSJT1NgPpZf4/tCFrC10tbOfZI756Wb+76gnOFS+bj9kbybp2UR4YPRvMvwXTrm6Pg+mWw68BXC0tbnNkFkBYUmm7P+iszs+uOgDJ2BCpQcS74qiytC79u4r/VUf2+XeomzvbwQfVtiODJv3//85TnJoTLBaXK5w2s0IPM0WQEaFKYk9sMXTFNleSQ2rlKyfVhHKDy5MGTnvW8nZMjlRlQKWdMWCYtPU41gXQUl1H7hK/VKlMBNSxQawpRmLdapVDaFALJ3FhtM0U+ATI4jQmCYGgBmuakOQTcuWJ7w6nSjPXMZH25NhlIW5RaxZknJl80z1FW6XaIjPf7iHuAVapC1LNAY8jxDKmVJONj2qxLpkSZEwz7Jwc+XywWfYzbfeuyQUvrB3+Oz9+9v3zXYxoGaRV0J3jAhZZaWXFPWpci95wmXsOT4fP+s/4p05bWhwLNjj7NI8H+OHAwy22Q5sd/Cmk7V6CHMCg1KsOGR0+v2nZ+0z6QsJndhr5Z2fHEaP+hY5KI3PrAfFYrvhhcO13XvPy5IhcxJhFzdDFpm76vPH+nx4fNXe8++dgi9VN49C3mqIHrfm24Wcfu2kyG99zOD95q6km9hsuoYHPqvFGjd8W8tlwORguGoYbiTEoqwxfP7mLqh+srkYhp++RTxClCOFzw2xEuxEjcilsRX7NidcXJhddXQqPJKsz4fMOWmx4DSxer7iNWtR9s2FG37MNWYwv/smVHSV5zjf1Byzeb483OowQbqGxOc5AmdV3/B3deDsQ=
sidebar_class_name: "put api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update data attribute</h1>

<MethodEndpoint method={"put"} path={"/config/data-agreements/data-attribute/{dataAttributeId}"}></MethodEndpoint>



This endpoint updates an existing data attribute defined in a data agreement. If updated, the associated data agreement revision is incremented automatically.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAttributeId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttribute</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data attributes contain specifications of exactly what is collected.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data attribute updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttribute</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data attributes contain specifications of exactly what is collected.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAttribute\": {\n    \"id\": \"65471222e8c7c3bb3c2c8501\",\n    \"name\": \"Name\",\n    \"description\": \"Full name of the individual\",\n    \"sensitivity\": false,\n    \"category\": \"Personal\",\n    \"scope\": \"read\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update individual
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-update-individual

---
id: config-update-individual
title: "Update individual"
description: "This endpoint is used to udpated an individual for an organisation defined in the consent building block."
sidebar_label: "Update individual"
hide_title: true
hide_table_of_contents: true
api: eJztWc1uI7kRfpUCTzbQlmzHM0GExWI9tjcQJpg1xvZpbMClZknNNZvsIdmSFaNveZI8Wp4kKHarfyR5Zueyh8QXo01VFYvFr6o+ki9Ckk+dKoKyRkzEbaY8kJGFVSaA8lB6khAslLLAQBLQgDJSLZUsUcPcOh6xboFGeWQjIGmuDElQBkJGkFrjyQSYlUpLZRYw0zZ9GolE2IJcVJlKMRGpNXO1uCskBpq2M4hEFOgwp0DOi8mXly1/74z6WhJML8HOoyez3ykNIhGKfy0wZCIRBnMSE9H5PZUiEY6+lsqRFJPgSkqETzPKUUxeRFgXLO+DU2YhquqhFiYfPli5ZonUmkAm8CcWhVZpXMf4d89OvfRMFY5XGRR5/q/zIGpq/ds8rqmZsHU+qKB5YBCH4cJvMtTarvQacitJe158Jw6rTKUZ5LgGR3NyZFICb3MCZXxA/k8ZVqHnQM6gBr/2gXI4cLRQPtT70gwmMC9NygOoYXqZwNyWRmI7ABTSwxGcDxxo57FzCAyq6CYjytjAgJoR5MoHfCIDKxUyQCjrzTQYShdNbKyNYFqDsWBNRlXjrl0ZcjwmKVWSQDWTOUqtk1CQy1XwkGNRMPSCBdxjHtDIsXWsjeCVWWjqL8XZFaRo2Apb8LQk1t8AGxeOKCcTPIP6+cjYcKTMkcSAM/QkJnPUnpJtKMhdpCVibl2OQUyESAQ9Y15EGLw/e3d2gqf0nv767v3fjo+PT87epfL9+x1Q3Ga0CWKbEcOFjETFlutNn/6AD6Un90vz7yi1+c7cn1uccZSNDRm5AVLGWyiqIao8aPVEeg3X0+nQudvo2B91kHJUu2lytcH39BLYDviCUjVX5EZwDrXJEfzKm78B7H1t6l6AdXAvtsB+L0ZwgYbhG0ujMqAxkIOvJTlFPgZYSTJBhfW1s0slyf1IoPdtNs5OTvdstvKQ2lJLdgYN/PoxgVkZYlE2dgUrAmljumW4JMA2DewcNh5C0bjoRzC9/PAhlowonltH0NTIBt1VVSV/pFhdPQeHflBiv9RFOGm3qcisIfGwnRZ1qd6N1XDpnzBvCgv10jhGHvP9wR4auHCEgUPCsOY9fKJ1qi0+cSkAz+tn249KPgJ6eIxmHyM8o//fneCKxWB6ySr1Ur+rch3FWL702Scb1LxpK7f2icz39S9pqWL2cUXdGxwZJV5Lq/3W1gUd/HZzuMdgIsiUOW8tGums4p6qrBcPVSIYaa/BfnseZgs+Gq+1QMl97sc2PNQ93/T7KM/ZPe0rDPHXs/WQbIG4qmppX3BNj0A8PT5+a/Rvjf6t0b81+rdG/9bo3xr9n9nouRvvdOhtg716V8ZbAwm+TFPyfl5qvRaJyAhlvDZ4Ye2zuqMPjcyQM7soA7TXDHsUT36ICvSTgZyz7sLKmBH8fdmbfoeHbCdJp92FV5lAi+hlW0rOjo+rPeb3bElXfT7sWXhV7QnzncEyZNapf5LcE5qz/+PQfCZvS5dSLL2xfewE6N0P0sj/rQBNzYZ0kluSgzjNVoyqRHhKS6fCOlLk80J9JP58YMIfcMHXfn2C/JCInEJm+dKwKOPC+ZpvIsb1FeK4Kybjl/6dXyV4KnZk303iJeW28VMkonRaTEQWQuEn47Gk3B5hoUZq4dCEkbLj5angHrnF1QMuuO++YsbXP++x9NAF4YaxUG/hJhTtXmA90Nxu1lHs7jfPmzyN2Nqpv+fXU25+wNnMlKCG4AiYSi5Rl22ffRzYeYR6GshLH5h/FI7m6plkzeUfax/hEQ6MDXUzDQ6VjmEoMKXDBGi0GG2ZnUCj+NPalo4jcvRE658fR/Hcxnnxubtxvdogb/tgxdz6W6S5z3/3EdttCtqSln287luErdmBNlcadtJLnppNdAMNV+gN7CcD/XbaNfVeJ+46cHdhzQCZ203hwTQWntaFsiisC7+0COzdkP+9GxpCtxPeSfJWCQ7+869/HzLRR7hZkVQ+Az4cAT2nGZoFRc61JNeuMSYKs48NOY3nv9KTB096fuTtkhyphWlpbNLo40wTpI7iMGqfAIJUCxX4SIxaU6gJntVKQmElBEozY7VdKPIJkMFZhCiCoRVoWpKObJkLVnyXmCnNrJmNYBlsjoHFU5sXWsXTQ4R/XJ6jRanjenw8bEPkH4ClVCH6maMx5PjQqFVKxlNHgMV5gWlGcDo63on5arUaYfx5ZN1i3Oj68T+mF1efbq6OWKfqaHm3D5zq0qYls/lNMeCqV+/X6fHp2egvo5PIQK0POZqeP/UDzJD+yWFjaJvZn/pa1JTAQM9hXGhUhv2PAXtpGsCX5g0p1see+5PBw89DIjLrA4u/vPC5/c7pquJhPtjFxpOIJboIsbpPKM/fsj3gvxqPg89N+z6EVx+m9q5jU98NF/dYjevT4hOX/+HDVcW0uyn97F0tclH7cBTLQ2dih2xwz6o1ztOUivBN2X6nvb67FYmYNe9feeQVwuGKD3+4EhNxL+5FfNSLiRC5DI+/CI1mUeKC5WuzXJ+4Cw0b21NsbM1H765sGJPtHlevhf/2TqxDlZ84HT7S+udWvP7lVYW2r26izzGvqv8CVdYbmw==
sidebar_class_name: "put api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update individual</h1>

<MethodEndpoint method={"put"} path={"/config/individual/{individualId}"}></MethodEndpoint>



This endpoint is used to udpated an individual for an organisation defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"individualId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Individual updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individual\": {\n    \"id\": \"64541a2e6e7569000145cd66\",\n    \"externalId\": \"user@example.com\",\n    \"externalIdType\": \"email\",\n    \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n    \"name\": \"string\",\n    \"iamId\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"pushNotificationToken\": \"string\",\n    \"deviceType\": \"android\",\n    \"mapperId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update data policy
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-update-policy

---
id: config-update-policy
title: "Update data policy"
description: "This endpoint is used to update and existing data policy. It updates the existing and returns the updated version info. Updating a data policy does not affect existing data agreements."
sidebar_label: "Update data policy"
hide_title: true
hide_table_of_contents: true
api: eJztWltv3DYW/isHfKldaOSZ8SXpoCjWidPGbZEYvuwCGxsIRzwjsaZIlaRmPDX0tr9kf9r+ksUhpbk76yD7st28DDQUeXjO4bl+1CMT6DIrKy+NZiN2XUgHqEVlpPYgHdQOBXgDdSW4R+BaAD5I56XOQXDPoTJKZvMUzn07x4EvcDmJVlj0tdXxRZwkYIrWSaNB6olJ4YZGw/RVqiAMOtDGA59MMPMbW/PcIpaovUtZwkyFlpMY54KNWGb0ROaBLF4EYixhFbe8RI/WsdGHxw3Rb7T8vUY4PwMzAa7BjH/DzLOESXpbcV+whGleIv0LFM8FS5jF32tpUbCRtzUmzGUFlpyNHpmfVzTXeSt1zprmLk5G518ZMacZmdEetadHXlVKZoH/g98cMfS4QqqyJJ2X6MK/KM9yiwWrXnpFAwuJ10U87fSamynSgUQ1agFn3PPTTp0gdTgqi1yVnTZszrV0gUHwBQ/GYXGCNtoHd3DLAjkSyhql0N4y2Pvp7OJyP2xhZhotUYurdEbneLp2hA89bXxP6h4RGnOHbDThyuGqlj/EM0hYbRW7SzZUI8W25hM2Mbbkno0YSxg+8LIKSjo5PnoxGA6H+DJ7kR2Ox4fZMHvxoj/YUhtruoN/LukznPBa+VVb3qL6jpdI6iBNt1OahLVu8fytBmk/7W8R/2vrXWv0YU96yLiGiVHKzMIbh+UULUTa+8QB6fXZuxfeV250cNCOpJkpDyorpzyb956Q+wJtyTWZ2c3lr8A9zAqZFeAp8kzRzheRoeU92nLgexxsUiTgClMrESLDGIGTNNEMs4LrHIHMG7wskQT6rbbSCZn5z9Lrm5stzn9eJdRQYBC183Z+hZk39vmk3yJXvsi4xa0tzluS4CLNJglOdYkUJ6TRF2ilEWd87la2k9pjjvap/Q5Pjje3IXenqByJQhWoktsLotwkLEeTW14VMrtEkubLlffTgiLYFZJNwpw3luf4q4nh74t2uYq0QHXEmoT5Qlpxwa2fk9hXBQ9El7uMjVHI9VPbxLC+lSatgIpoRh93LdWmaZr1aNV6wV2yEay7ma4y2sXgNez3v2aFr1nha1b4mhW+ZoU/WVagYDWVG068FaEvuznbMfrbHDVamX0LHSEojUAFGa98bdu2y6GVXElq2to04mKonkPMG984cFLnCsGaWQqh35NhrQZXB37IYwb7kNl55Ren42SuOe0TovZwH3gtJLVi6a2+1adOCoSJNWXg4pa5OsvQOUPRPjOqLnUCfMl566ljJC5pLeULZbJ7FM+P+JLaryjVuxj8oz5DWxYf6WhpElr5B1fyDxRXmleuML4djYNvuSvCKZToPC+r/34GOTnZkUG604bzs2DxS1GevZdYzdDbQZUUbmqn5nQkgfwtg3HtKbKDx6zQMuOKwqcz2q0eC1cKxWIVMXUbdtZ1Sbrf3HcZ1VdfXGJmrGB3zcrRfJEaXx59N9yS8prSwS9dYjCtDVMxMuNuxSNYs2YWz2bkMU3TZueuq3vJza3IY1D8TfrC1P79tvj/IcC0Br+VCKgcDM7OPXRKDYIqnHgYK67vKWTvMHmYkZNnXGW1imDLugekS3oln1M0cARXaK/mZBITGUxC6jRIt8OlvlCjnTugiNFzj6IYd/Dz1ft3+/TAgdJsCqdVpeZhGF5zbYINyz9iEXpF9oo0u0IL52+uf4TLH1/Dyxcvj1MgkIrCIpfaUX0QDGYiUQnXmU+0d8CHDCsPro5R7JyqizVlrf7vFJDe6k41K3Hl2Vrhg/EwOxRHeDw5+dTzluJoG+J/15nvXb097Q1CCbcMb89madgfHvX6g97g+HrQHx32R/3+37c9oaNLPAQb6+I82VjBqwo1ioAQLgPM+dV7eHnSH8DN9WsI0GJXmPHaF8aSEK/mZO9TKWquoutse0N8SxE02ZBpg9R7X6D9rPhzdHw04EM8wRfHJ9/1+/3B0TEf97er6su2c8HQ8WjgopSagFMbvbTgDjKLAfUM9eyiEiBj6RJlZO2hN7nvhby+Xg1ssryhiMk6YQpG2oAyOg9MICgKGn4xIYntFjEsvYMFE8RRZVFg/Pt59vs8680Otw2IlxXankUnHZUswK2XE575WFFUbRYDG9JJApmpJIr4csPZ1vm/6oqW5wuxymqapl/IK+zNEITR33i412YGsm28NmaFPBXSBRhL/ct+Cw9sQQY7S/a2j+uQ9fY0J7VSlJEL5CIg3o+0/ChiDOtUxpzielV7WCDkOxYOPgucWK3U0FpjXxtBNVp4PlvZfgsZ2ay9lqt3NTeLozvq95sd5Hec/PK0X+0QvGl26PlGL2PJDtUc/R+r5hKdqW2Goe+emFpvK+j4M4GtP5eCzrVHq7miWEUIRNhmQ0ehbMhqK/08XE2dVvIXpMc7ujbyPKcbq+jtFwtAsURfGLrsquogOV1RjdhBvPo6iFHh4LG7q2piyzPdfft1hqVpGWxRtCWMI7A0PV7JVOaWa59KczAdsibZpHHled6WlbvIuPh6B6W7pfSxfgtn1+lgcQg8DrQ3clF9yzu509ZBY4e/1UBfnMM9zoHcmPCNaHvUACNMuaoXoNvHNTofIW4DZe0CqlRZnMgHFDCTvoCPkUf4CHvaUA1TIHjLpQpqqHiG+wlgmqcbZEfQLvx+bmpLGund4/yHjykjSyCHuFzeFL7pTG4V46WG9FNYZauU3ZDjAk5c4ITrJ/VJ3G4dOItwyybmtQFmPYVVBQzqCVApEt5CgeLwE+ANgTJNgOAmpgs4PAsBB0suSURXV5Wx/i8LA1zqSv60HFrXx3LylnMvFsHev/7xz32qvDhczVBIV0St40MLPxJwMkUrJ63xBT+RGdmUmRIGEi/RHVInqSY9R3glylyDFKQ7P0/a9XyskErKMMyVS0JrlEvPFcyoc/dhM2eUFFAZEVt9o0wu0SWAmo9VvGzXOAOFU1Rk/hQYQ/TkY6mknwcivPamjO1iZspKSU6VbrB+EfHCPLSThB9IDRxC3RHhocBnybVGS5WUkhlqFwy589mKZwXCcIcNzmazlIfXqbH5QbvWHfx6/vrNu6s3PVrTLJGz5TmQpwuT1QRAdLFgafDU0aSH6SBUisb5kusVfuL3Ap8C6Fey2P/yxxJtRPX44A8qxaVewfhjHvnQfkKxCu6MFt893CWsMM7TtMdHQuhurGoaGv69RhsSV8Km3AZTjelGOnoWu5GNVbXuXbbpfx+e/CZjJ/9dmtAhxlFQj9X9PWWR5TcbDeFRbfYgzuLr13H/3jURWS7fKlQo7cUVpxlhBJ+cu5qkL26uWcLG7acfZahJmOUz+oaEz9iI3bIAsZmgkpABw/gjU1znNc9pfiTbtL3tem68D7mxfSDBdupjM01GWeiXJNu55HtyqV9w/sNienzz5IJFao6z6XTumqb5N9IPj5Q=
sidebar_class_name: "put api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update data policy</h1>

<MethodEndpoint method={"put"} path={"/config/policy/{policyId}"}></MethodEndpoint>



This endpoint is used to update and existing data policy. It updates the existing and returns the updated version info. Updating a data policy does not affect existing data agreements.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"policyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A policy governs data and DataAgreement in the realm of an organisation that is refered to as "data controller" (GDPR) and owner of referencing Agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data policy updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A policy governs data and DataAgreement in the realm of an organisation that is refered to as "data controller" (GDPR) and owner of referencing Agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"policy\": {\n    \"id\": \"65471222e8c7c3bb3c2c7701\",\n    \"name\": \"Default data policy\",\n    \"version\": \"1.0.0\",\n    \"url\": \"https://example.com/privacy-policy\",\n    \"jurisdiction\": \"EU\",\n    \"industrySector\": \"Healthcare\",\n    \"dataRetentionPeriodDays\": 365,\n    \"geographicRestriction\": \"EU\",\n    \"storageLocation\": \"EU\",\n    \"thirdPartyDataSharing\": true\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update webhook
Source: https://docs.igrant.io/docs/consent-management-admin-api/config-update-webhook

---
id: config-update-webhook
title: "Update webhook"
description: "This endpoint updates a webhook. The request body replaces the payload URL, the content type, the subscribed events, the disabled flag, the secret key and the SSL verification flag of the webhook. The payload URL must start with `http://` or `https://`, and no other webhook of the organisation can use it. Subscribe to a minimum of 1 event type."
sidebar_label: "Update webhook"
hide_title: true
hide_table_of_contents: true
api: eJztW1tz2zYW/isYPLUdSr4kzbbaTmddO9t4m9SZyGk2TTwWRB5RqECABUDJqkdv+0v2p+0v2TkHoEjqEjtp+1S/eEwQl3PDwXc+Qrc8g9JCKjxkfDARykHCM3CplaWXRvMBv5xKx0BnpZHas6rMhAfHBFvAeGrMrM8up8As/FqB82xssiWzUCqRgmN+CqwUS2VExl6/ep5QQ2q0B+2ZX5YQWlw1xgXHkDGYg/YuNGfSibGCjE2UyGNPSC14NoMlEzqjpuHwOZuDlROZCpSYejMzoZcdGVuSsKJynjkvrGcL6adsNPW+HBwcjJix4cHhU0LLaMOMn4Ktp6tnNzYXWrqwbCo0qxww6ftsWCvEvGGCFVLLoipw2FHQkJTvv9fvNVlXoj0nlVK16QrQPmHaeCZYKayXQkXL99kQNNnJLtlEgsqY0fExFUrFSdFUdi5TYDOAMnhiJLNRMOPI2Px8/eCEzsbm5oLa1nYdeVmA86IoR7W+zhsLWdeo7W7Oi2VYKrUQrIJv++81T7gpwVLbecYHPDV6IvPXpNKbMB9PeCmsKMCDdXzw7nYrDoGdn214Fg0cDcMTDjeiKBXwAX/ylTiaHKePssfw5eSJ+Nv4q/Tr7BCOeMIlTlYKP+UJ16LA3nGy84wnHCNZWtwN3laQcJdOoRB8cMvRZ3zAnbdS53yVcOeXtJiTtOrqKowG578z2RKHxFjHf0VZqhiiB7841Oi2NXdp0T5egsOnKA8NU+piQtZoBHvHYyi/toon9SKXKF7Cm830lPYSNtGu+QGW/CqptTDjXyD1POFeelLiFF0GF3bTJ9tOqE0ffFjZ6GkTvI7bouUV1o5FmWtjwcVIXEfhjghsh5WcsKWpmIMQmUWfnXvmxSwmmM4unFhTrENcaPlbDLkRm4LIwGKUdG3dMuWWj3dp/+zy8uUQdcR/KJf4qfDMQgpyHkWqLRTnDkaYC1XBfRMPGYH6joFVWv5aAZugYTcU7kZ9PTy29FNTHKAg7kDmVmiPQduOlnsp3M7Xm7tvreA/Ufp2iN/0FotFb2Js0ausAp2aDOqM86/hxY/rbCwdetYzqZlgTupckaZFTG64QzM2ir1HpK+uCtwEWzsq4XdKwK9WO7ZIY4etbbFjO22bqMnpLkRD20Z1ZCSo4iOWW1OVrs9OusdCNOwjJqzFLEq+nxqVfeD86OwtC5PK4cGsW12CNNLRUSI1LaGk8ziV9C4I050nMxC6WyjMHFhWBZPGAHbbOyg1Gj34QmiR08n1pklf0ayk1JbpTsNAVqxHti1JYrloXMdMmlaWLaagUUWpMzmXWSUUy2nbGbu2QJQnwTbhZg6zUQYKPCQsMwtNYWdszFBoE2lZJrxA1aSHwt29MYYbkKUVljRTzH5SSy8JWyWd9lToFJSi9ihuXyhlFp0WBEBbjaLy5hpuSmmX9aRBue3FamV3vAkj2mJ0RzRvrlarhGcyl16oN0IpuLd7z8IgtqBRXdc+JcBycX72+KfT+IZ85xEOUVT+PabxErTM+l+MYvgxYSFkQa2WdRtFudBxvnN07kUJGp9eMqk95PGQ0gCZi8Al6hSkay0wBmV0jkFDy6gMLDs7Pzs1RcFKa7xJTYOyavlSCxloxGk4UwzZiUHv0TTSuQosczKjHNqSFW7SqdB53M31fFNa985pQzeatju+tIDREs6IL/rzR5ujUYK1iWoZBmwUAcw1jsajuX6OWaw+ntvzX4t0hi9SU0BzAAdMHoVLdowqQWdS5/eesK0rIcrfv1W3nWcmE7CkfICsO1/XttjZpfn3mpx+Zy9S9u5OKZT+7n5hY+/uhuLgtr7OQMs9fbyZgd4SfDsaW0tGP96z94a2d/TdVLoT1u1Q7c8f3dGrdtr+ntsheM++0QLYO2RL4cULYWfgqZi7d74UXrCiGXe/w9C3zu4AwF1zuGFdidJgLZ0q4yoLTOQWwmFrITU2++NOvZbsfXy+bla9Xq96HVZFS4WTJRT5rcXHxigQemv1N6juCKuyiCNrhNWCLOTjaLgMlMQshNa7oEmE6rMzmIhKeUIFIyI8CFRmoTlyIKt20XS3WRpWonKQUSlkirIK4IKN/t07/x7hd28ocy18ZWHEnr04Oe0Nn50cf/kkliaE70Gk01rwZU2tkFI2HJDS0/RTSGc0uaj8FLdLKv2yBpFrVH5myCxIS4hYf5gJcyWRM3iADjrhE/YbrTGuCMRqqrrQuMzVsq8rKTTSTJZDp35q8S+f4kgUAGzjRzo7lvTq8vmQpYg1JwGEdlXE+uvjnbvCSn0bxWtY7K5t+xwjtV1/1wX6Vj0dYvpjpt5kHGglVyLaox15fHj4ZzIJkrIrFt7Ev3wMrbDeuu3NsjsmsJ6K9fyHOIh9rMPJHs5hBw/XLWYQ3i1dDOIOZzYJUDOIkCACgtJvMBHbpY7M7s4Gr0O1LukUIwS0QUbej6ha1W759AU7zAhhZLPQrisLbuKWzr9jtTjNB7wR3EB2r5lLtaS0Jxo+D8UMENwF9rSeN4NSmSUeIVg8b1bXYS4/bY7IUOGahWYuNSWQqh9D9tyP2vlz+ZfTe3AvD4zIAyPywIg8MCIPjMgDI/LAiDwwIg+MyAMjsoas2nTJkGVA/J/EbaxxXG3ccD4ZvHeQVkp8iO6IFIeZ7GI4dtQHgayQmqUKhGUebgithRKu0TLUyQlzhg4iSIOA9QsmHH06br+bwfKPpi46IPHjuAuUpCmN765JLk/pSsW+QM/aUUDwevT27du3vRcvemdnl9PpoCgGzv08oi+swu/BueHoazvCEMTcddHi+PD4Se/wq97h15dHh4Ojo8HR8c98H8NSO05MPIRv2fWUv4dgufiBJzwEGO5Y7PD4I0mT9tJgrbGnJkPWg/4/a622g7zoQv9mdONMwltg23Z7fHi42jH9jgBoTP0dfi3XZeXZ+p4MmmPbINgxJvnGwwgUmv1FK+PNCsyvOhPerKkR6VghHX6JT7DDRsQ2UXKf21O0QCYRI2ASqv0fgS1yBsXGDbH6skf7BtU6iYUrY1HwTlVHHELnpkIs8eZCSUromwFy9BcOkNcaaWNj5W8EJTZN8/gvbJpX4ExlU6DgmZhKx9s7HS5tKuhkrcOZ9gCGMxbemp2fUYy2z2PpYr29IxS//EvnqnPtwWqh6hxFy2zYKCCWykq/JP76pJSEXd5d4THjRY7XBdfk8VXCC/BTg9cMy4q0xst+A34QyOOD6JSD2/W1vxVR2Lj+rouHZ1CYKB5PeIXc4Zrpy6AwPVHKfiD4+tIczI/5KtmcY+hFLnW+bxoXXu+Y6arRfYghEDxXW6DBz6Eh3m4MxmvuN57E3V6T8Rvs+svzcKO2/pTUom7XH40I2XXmWYO6+ppaaWEib/CCKJ0JQUY2Yp9pE6Ght0IqMgN+gvo8YdDP+xvTDlgc+M3SVBYt0pvB8ttRwAi4HV41dyyf1gHX+dLRZnnv5mQ3KNldJOouenQ/x7eP8LraxxrdUXZf7a+fPqnKaJcY8cZ3qyBodvNOhBy/oGGgTUydt0RKeQsKIRUxxGVprP/HOpKbSJTfN03dLdB03soR60Hss//957+fh+vSwwVk0k1DMVfTNcScdG6D1+C2tGYusbDGy6OEPxyoSc+ZOViQuY4fNPwyiePRQKxxiEsIyXT4O1zMGSUzVpqMeUin2iiTS2S2QYsxhbqgj38K5qCIY8Z8R3ehx1LhN1ucBBnMQnjsjh+OlURSImwjUs9CjvWVNNqFe5J4Vxw3bCY9yVkIrcPlViVT0I52RL35S5FOgR33D7dsvlgs+oJe943ND+JYd/D8/PTpj8OnPRyzapj/xg+YMjKTVkVd8fOEY/YM/jo+PH7cf9Snb1ilcb4QuiVPuGBcH42b2ah1ED788uDhlwd/xC8P4hGJHMJBqYTUGJdV+AQYoMG7+HsEnvAmLAfNrwKuEj41zmPH29uxcPDaqtUKm3+twBISSfhcWEoaAUFsZti9Qf7Zq4jnPmf3+IXDTl1qDKARANCJzQecJ3xG+bxRY4W5P2IDFDK8j98Ye/FDfz1+6xhEUBNGnBAL+cG+bRD28vUlT/g4/iSiILzJrVjg1Qex4AP+nr/nxCpShiOMi+23XAmdVyLH/mFaPHgQpnSRz4yQT/wHFdtpkE0QFHTBv6jZziHfYJ77AZbfrruHN3sHrIFX6I3uQVbv/8HqCqY=
sidebar_class_name: "put api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update webhook</h1>

<MethodEndpoint method={"put"} path={"/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint updates a webhook. The request body replaces the payload URL, the content type, the subscribed events, the disabled flag, the secret key and the SSL verification flag of the webhook. The payload URL must start with `http://` or `https://`, and no other webhook of the organisation can use it. Subscribe to a minimum of 1 event type.

This is a full replacement, not a partial update. Send every field on every call.

The service keeps the `id`, the `orgId`, the `sandboxOrgId` and the `timestamp` of the stored webhook. The `timestamp` stays the creation time.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to update.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The new webhook configuration.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The webhook configuration to create or to update. The service ignores `id`, `orgId`, `sandboxOrgId` and `timestamp` if you send them. It takes the organisation from the `organizationId` header.

</div><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTPS or HTTP URL that receives the webhook payload. The value must start with `http://` or `https://` and must be unique for the organisation.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"The content type of the webhook payload. For `application/x-www-form-urlencoded`, the JSON payload is sent in a single form field named `payload`.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook does not receive event deliveries. Optional. Defaults to `false`.","default":false}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key used to compute the `X-IGrant-Signature` HMAC-SHA256 header for each delivery. The receiver uses it to check the authenticity of the payload. Do not use a value of spaces only: the service accepts it but then sends no signature header."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the server does not verify the TLS certificate of the payload URL. Optional. Defaults to `false`.","default":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The server sends this error if a mandatory field is missing, if the payload URL does not start with `http://` or `https://`, if a different webhook uses the same payload URL, if you subscribe to no event type, or if an event type or a content type is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all webhook content types
Source: https://docs.igrant.io/docs/consent-management-admin-api/get-webhook-payload-content-types

---
id: get-webhook-payload-content-types
title: "List all webhook content types"
description: "This endpoint lists the payload content types that a webhook can use. Use one of these values in the `contentType` field when you create or update a webhook. The server posts the payload as a JSON body for `application/json`. For `application/x-www-form-urlencoded`, the server makes a string of the payload and posts it as a form under the `payload` key. Note the capital `C` in the `ContentTypes` response field. The order of the values changes between calls."
sidebar_label: "List all webhook content types"
hide_title: true
hide_table_of_contents: true
api: eJztVs2O2zYQfpUBTwkgy842vRhB0O0mDbYJkgC7QQ+LBTQWxxKzFMmQlL2KoVufpI/WJymGkn93gyLoLejFFkjOzDffDOfjRkhynkqMJMV8iTpQJiSF0isXlTViLq5rFYCMdFaZCFqFGCDWBA47bVFCaU0kEyF2jngHIyCsaVFbewclGmgD5fApEFhDYJdsHAhWqFsKoExyVoxerjtHBSwVaQnrmgx0toXSE0YC66F1kr92/nO4rgkC+RV5cPYUGgZA+P3qw3tYWNnB0noo0DmtSuTkpp+DNUUOv52u30/W6/VkaX0zab0mU1pJssiS7zFYg3fE3kP0ylRjWvvARo5wVBxQsDNojSQ/5DueLOCOuhze20hpvUSnImooLoodNRd7akIBnoKzJtBA0kCA9ex3xDASW9ZoKgqwoLgmMlCi1iEXmbCOfErzUoq5qCj+MXD5cUB0GE1kYhsuiPlGnM1m/DfWij9P2eS1UNbUIH85z8GiGqyPPM83D9rsO1tKZILusXGaxPzmIZBM/GtFxW0mVKTmETTnj2JJMU3b/JeA7EfMxdA3ot8toPfYib5nyr+0yvN9vDnmbG9tF5+pjKLn48fAP7wVmagJJXlOiw88nz37rqodxifvrb+wkjhz/n51EO0Bnuyk4nvr+WZ7VJlIFfnD6j2fzfpH3O9tRrIOTMSvKEEZ10Zw6LGhSJ7peEjIJ4NtrK1XX0k+oObn72zoH4uaSxPJG9TbmZbCnHDUZyJQ2XoVOzG/2Yhzp94Sf972nCNWgbkYRwin3VCs7ThZOGuMtZiLaWnNUlXT8RKH6Xi9piP1kzjOmwFKSLGO0b6ixo5IRSZar8Vc1DG6MJ9OJTV2gk7lqvJoYq7sdHUm+uzUx1XEisf1N9yEYfsRT7d7Gq64G4YibsnYVQOHhUwojjbwKDJhsOHd87ERU3eJ02qcf7xkMQBuVzJxbMJhwKeZvh3wxZGfAoYw0LQhwoLAeVqqe5KwVrGGYsAIBTwxW5GJHpVONDgs6WkGlFf5ids5jIYvOtt6ZmRyR93LIk8jSpml3V4cLNPFoQYVcxla56yPv+z42+ev3uyXjonfH37QpDsjePL3n389BcVqerUmqUINEiMC3Q9al1R3RV4tR+5SmVXJlNiVkuRzuIysHQEC6eUk2BV5UpUBJZnx2GWjPS408bMjLaMOGSBIVSVpXqPWFFOwYLVioZcQqayN1bZSFDIgg4tEMIKhNWhakebq8QVPUwAXSqvYJSfYRttg5OOlbZxWaEoaipfS81S1OuWTXksIy1ZrbhOpYsLZoDHkWZu0KsmENFK2LeewrAnO8tkDztfrdY5pO7e+mo62Yfru8uL1+6vXE7ZheVJRHxUPuFGlLduGTNy2Mt/ZoV5ns7Pn+U/5M7blJ1CD5gDPOxUioNZ7NT+U+tM7cTCZ/3+G/mDP0HFiRrqPU6dRGW6Y1KGbUTRuxCAaIhNb2UiCkhCLTBxLx20mahsim202Cwz0yeu+5+UvLfmkWJlYoU93O+nXVuiS1tzxHBfnZUmOZSuhTwP95DnQH0rcm9fX/OxrGe2hBtwlDRg/2Pt2y3QHvk/lYIDAvyxcj5q84Lv3lrqXu+PDzjcNdhI0nGaWb/u+/wcUsusJ
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all webhook content types</h1>

<MethodEndpoint method={"get"} path={"/config/webhooks/payload/content-types"}></MethodEndpoint>



This endpoint lists the payload content types that a webhook can use. Use one of these values in the `contentType` field when you create or update a webhook. The server posts the payload as a JSON body for `application/json`. For `application/x-www-form-urlencoded`, the server makes a string of the payload and posts it as a form under the `payload` key. Note the capital `C` in the `ContentTypes` response field. The order of the values changes between calls.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ContentTypes"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"description":"The payload content types that a webhook can use.","example":["application/json","application/x-www-form-urlencoded"],"items":{"description":"A payload content type.","enum":["application/json","application/x-www-form-urlencoded"],"type":"string"},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"ContentTypes\": [\n    \"application/json\",\n    \"application/x-www-form-urlencoded\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# iGrant.io API documentation
Source: https://docs.igrant.io/docs/consent-management-admin-api/igrant-io-api-documentation

---
id: igrant-io-api-documentation
title: "iGrant.io API documentation"
description: "iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 2024.3.1</span>

<h1 className={"openapi__heading"}>iGrant.io API documentation</h1>



iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner.

<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}>

API key authentication. The value of the `Authorization` header must be prefixed with `ApiKey ` (note the trailing space), e.g. `Authorization: ApiKey <your-api-key>`.

<div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>Authorization</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>iGrant.io: <a href={"mailto:support@igrant.io"}>support@igrant.io</a></span><span>URL: <a href={"https://igrant.io"}>https://igrant.io</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3><a href={"https://www.apache.org/licenses/LICENSE-2.0"}>Apache 2.0</a></div>
      

---

# Create individual
Source: https://docs.igrant.io/docs/consent-management-individual-api/config-create-policy

---
id: config-create-policy
title: "Create individual"
description: "This endpoint creates an individual for an organisation in the consent building block. This is used to onboard existing or new users."
sidebar_label: "Create individual"
hide_title: true
hide_table_of_contents: true
api: eJztWc1u4zgSfpUCT92AIifZdBZrNAaTv154e9AdTDLYQydAymJZ4oQi1SRlxxvotk+yj7ZPsihKtmXZ6Z6+DRa5GDZdVSzW3/dRehaSfOZUFZQ1YixuC+WBjKysMgEyRxjIAxpQRqq5kjVqmFnHK9blaJRH1gRlIBQEmTWeTIBprbRUJoepttljCtGs8lB7khAsWDO16CTQk/KB5awDQwv+3/lUJMJW5KLliRRjkVkzU/lF9ObaapUtRSIcfa3Jh3Mrl2L8zDKBTOCvWFVaZVF99Lvncz0LnxVUIn+rHBsPijz/2pwramr9eSbGX55FWFYkxsJOf6csiEQEFTQvTDbyySB2NwVqbRd6CaWVpGPYNuKwKFRWQIlLcDQjRyYj8LYkUMYH5F/KsAo9BXIGNfilD1TCG0e58qENR7eYwKw2GS+ghsllAjNbG4nrBaCQvU3hbMuB9T52BoETEt3ktBgbOCtTglL5gI9kYKFCAQi1UV9rAoOhdtHEyloKkxAzWrEm575z1y4MOV6TlClJoLrNHGXWSajIlSp4KLGqOPHBAu4xD2jkyDrWRvDK5Jr6R3F2ARkatsIWPM2J9Vflh7kjKsmEWEtPB8aGA2UOJAacoicxnqH2lAxLQfJnl3gfnDK5SMTMuhKDGAuRCHrCsoplcHry7uQIj+mU/vru9G+Hh4dHJ+8yeXq6UxS3Ba2COLnkyG8XhbOLVDRsuU365Ad84Gb5ufuZZrbc2fvXdZ1xlI0NBbmtShkNqqgtUeVBq0fSS7ieTLadu42O/VEHqUS12yZXq/qeXALbAV9RpmaKXApn0JpM4QMnf1Wwd62pO8Fz4k4Miv1OpHCBhss3zhdlQGMgB19rcop8DLCSZIIKy2tn50qS+5FA70s2To+O9yRbechsrSU7gwY+fExgWoc4Mo1dwIJA2thuBc4JcN0GdgYrD6HqXPQpTC7Pz+PIiOKldQQ89pRbVXfTNMkfGVZXT8Gh76amciTF+IswWBIftEtTVVhD4n7YFlFqT6y2j/4Jy26wUK+NY+Sx3B/sbQPtdOeR44lTD4+0zLTFRx4F4Pn8bPtByQdADw/R7EMsz+j/dze4YjGYXLJKe9TvqlxHMZavffHJBjXrYOXWPpL5vv4lzVXsPp6oe4Mjo8RLbbXf2rKiN59v3u4xmAgydcmpRSOdVVIkQlkv7ptEcKW9VPbDfWbKkI/GWy1Qcp/7TXM/1D0z0FZhlOfunvQVtuuvZ+s+GRRx07TSvuKZHgvx+PDwFehfgf4V6F+B/hXoX4H+Fej/1EC/A+dDC73h2D5nkODrLCPvZ7XWfMMvCLk7xPiZtU9a+N82MkUeA1UdoEKHJQVyexSPfog39DuHnLPuwsrYPvz9srf9DmkZdtRGe5MLZQLl0cv13Dk5PGz2mN+Tv82oOt9z8KbZE+bfDNahsE79i+ROaN79IKX6/wrNxKwIGLk5OYjbDGLUJMJTVjsVlpEunlXqI/HXe+6JgLnnWEy2mGxJobD83KqyPp4cQyHGYsTbqIxGW43c7u2j8WF7lrZzTSSidlqMRRFC5cejkaTSHmClUpU7NCFVdjQ/FgwRA6oaMGfYecGMb//eY+l+c+4bTn+btdXp1+HHdiERindrAyeSDkrEWVd5sZx2xs/Z9YRnP3B9MiK2VccPCwnmqOs1zDxs2XmAdhsoax8YfitHM/VEsqWyD62P8ABvjA0tlgSHSscwVJjR2wQozdOB2TF0iu+XtnYckYNHWv70EEnFOaEjx/J89mn89WFFIf7xz9vdsxnAOMtewoQkUoWuaAcPWKNK0nre166cmmO2BIm+aJ+fapsrkzBZwk505mzZbjVkGSsr/ee2KdyQkaBCRNpBPNpDw/tomAORtJOAM9uGQKy7nAsqjn2eGb9unsxerbpyeAFjDv4tct3nyfsI8JCqrsnNPv73LWLXlep6jnQspjdYWtaxWeg4RW9hP2now+4G/HuIvUHqlShHUJmZXQ1lzOJQXrtQV5V14ed1q278V3/fLG33+EZ4ZwCuleDNf//9n7d8IUC4WZBUvgC+RAE9ZQWanCI3m5NbnxG6YbYur3hPrD158KRnB97OyZHKzboQk04fp5oY8eMyap8AglS5Cnx1Rq0ptETQaiWhshICZYWxXOrkEyCD09jLGN8YaJqTjqyah3l8bTBVmuuejWAdbInxDUNmy0qreMuIcyIez1Fe63geHy/lEKkHYC1ViH6WaAw5Ln2tMjKeNkRZnFWYFQTH6eFOzBeLRYrx79S6fNTp+tEvk4urTzdXB6zTbOj7Jg88E6XNamb9q6nJ8NDm6/jw+CT9S3oUmar1oUTT86cj1urFBxc9oP/TvOjp5kegpzCqNCrDZ4vBfO5w84voSi2iTB9nC4bX8Rfx/MyX/d+cbhpe5ttgROhEzNHFeot4vQL2CLWPDGPioo3HQWxNFtd1i2oDEsTA2mqcZRlV4ZuyfQZw/fmGwWHavaQqI+ERDhd8Q8OFGIs7cSfiC69YhZFk8fqz0GjyGnOWb+3ycMAOgjbw+xjht/vSe6CFZtnzcojE7WH4s3et3FZ5z7X4kZY/rcXbf15UWKN/K82pvG+a5n90CtmC
sidebar_class_name: "post api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create individual</h1>

<MethodEndpoint method={"post"} path={"/service/individual"}></MethodEndpoint>



This endpoint creates an individual for an organisation in the consent building block. This is used to onboard existing or new users.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Individual created successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individual\": {\n    \"id\": \"64541a2e6e7569000145cd66\",\n    \"externalId\": \"user@example.com\",\n    \"externalIdType\": \"email\",\n    \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n    \"name\": \"string\",\n    \"iamId\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"pushNotificationToken\": \"string\",\n    \"deviceType\": \"android\",\n    \"mapperId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read individual
Source: https://docs.igrant.io/docs/consent-management-individual-api/config-read-individual

---
id: config-read-individual
title: "Read individual"
description: "This endpoint is used to read the individual's information as defined by the organisation in the consent building block. This is used in privacy dashboard where the individuals can mark their consents, sign data agreement etc."
sidebar_label: "Read individual"
hide_title: true
hide_table_of_contents: true
api: eJzlWN1u2zgWfpUD3mwCKHKSTbNYoxhM2qQDbwedokmxF22AHIvHEscUqZKUHa+hu32SfbR9ksWhZFn+CTq93blJZJLn8Px8549rIclnTlVBWSPG4qFQHsjIyioTQHmoPUkIFhyhhFAQKCPVQska9V88KDOzrkQmBvQgaaYMSZiu4lHrcjTKt9vKxLXMGk8mwLRWWiqTw1TbbJ5CvHhznzJQObXAbAUSfTG16CQsC3K0J4KHDA2U6Oa8odyGvU/Aq9yAxICAuSMq+VIKWSoSYStyUaiJFGORWTNT+SdCOen5ikRU6LCkQM6L8Zf1npk+G/WtJpjcgp0BGrDT3ykLIhGKdysMhUiEwZLEWGylnUiRCEffauVIinFwNSXCZwWVKMZrEVYVn/fBKZOLpnnkw75ijTzvX56f87/MmkAm8CdWlVZZVGX0u2fJ1gN+lWNFg2qpt2JESq1/m0XFult7DYIKmhd2jLGr/X2BWtulXkFpJWnPFtgeh2WhsgJKXIGjGTkyGYG3JfvNB+RfyjAJPQdyBjX4lQ9UwomjXPnQuqZbTGBWm4wXUMPkNoGZrY3EfoFdeprCzY4A/T12BoFxFcVkdBkbGMxTglL5gHMysFShAIS69ajBULvIYsMthUkbCBVTMvw6ce3SkOM1SZmSBKq7zFFmnYSKXKmChxKrinEeLOAR9oBGjqxjagSvTK5pqIqzyw7i8XpPC2L6TRT10PaM6+czY8OZMmcM+yl6EuMZak/JPhTkIdwS0UayGAuRCHrGsoowuL56dXWBl3RNf3t1/ffz8/OLq1eZvL4+AMVDQRsj9mGxq0gqGubcOn3yAzLUntzP3c80s+XB3Z96nLGVjQ0FuR2kjPZQ1EJUedBqTnoFHyeTXeEeomB/VEAqUR2Gyd0G35NbYD7gK8rUTJFL4QZalim8Y+dvAPu1ZfVVgHXwVeyB/atI4S0ahu8mTWoM5OBbTU6RjwZWkkxQYfXR2YWS5H7E0MecjdOLyyPOVh4yW2vJwqCBd+8TmNYBZtaBsUtYEkgbw63ABQH2YWBnsJEQqk5En8Lk9s2bmDLi8dI6gi5Rduhumib5I8nq7jk49Dt59kubiZPeTVVhDYnH/bBo8/WhrXZV/4Bll1iGhShaHsvjxt5l8NYRBjYJw5p9OKdVpi3OORWAZ/2Z95OST1xTnyLbpwjPKP93L7jjYzC5ZZJW1e+SfIzH+Hztiw82qFlXVh7snMz36W9poWL0cUY9ahwZT7wUVse5rSo6+e3+9AjDRJCpS3YtGums4sKqrBePTSIYaS/Bfv8ebld8ZN5SgZLHxG+ax6ZJ9tDHiNxjOMx3FJyiBUnwdZaR97Na65VIREEoY1OxZvqrtqbvspkix3ZVB+ibkCOEFz/UDAzDgZyz7q2VMSb4+3Zw/eO+nvthsqXeGliZQHmUsk8mV+fnzRH2R5yyzT9vjijeNEcM/dlgHQrr1L9IHjHN1Z/YNJ/I29plFJNvLCAHBnr1g43k/5eBJmbTdpJbkIN4zZ6NmkR4ymqnwio2yTeVek/8+chV6A2hI3dThyKusNaY85gwbJofE1FSKCyPGDlFU/BYMBYjvldlNNpmmNF6OCQ0gm9n2Y6NHrdU2k50kYjaaTEWRQiVH49Gkkp7hpVKVe7QhFTZ0eJSsMh7DXzAnIvxC2x8u32E0+PWLvcMj9arG+v07sF2oRuHWsNuB6KbLnQj3A6S8s3HCVdE4ADnPqFFJQ+IBAvUdV98n3b4PEF7DZS1D9yUVI5m6plk2+A/tTLCE5wYG9oKGxwqHc1QYUanCVCap3tsx9ARvl7Z2rFFzua0+ukptlpDHKzFNP56t2ms/vHPh0PdDGAsBi9VyiQ2UB2oua8aDAqRJGklH1IfTsra5sok3EJid3TmbNletd97bbgMZ/UU7slIUCH2H3v2aJWG15ExG6IbYdmzrQlEnwUYUIKDid8JNikHs5hyumZG+LqqrAs/90AbTM6/bJd2Ebo9fBDePRGc/Pff/znlJh/hfklS+aJ9D6DnrECTU+y3FuT6Zge6yOyNE2e/2pMHT3p25u2CHPG7wsaMSUePU02QOYrLqH0CCFLlKvA4jFpTaJs7q5WEykoIlBXGsqPIJ0AGpxGJCIaWoGlBOnbKnKria8VUafYaM8E6WH5yMTlktqy0ipNDRHlUz1Fe66iPj4M2xM4DsJYqRDlLNIYcO06rjIynbfMrbirMCoLL9PzA5svlMsW4nVqXjzpaP/p18vbuw/3dGdM025Z86weOaGmzmjv5Tcxzcmv9dXl+eZX+Nb2I3af1oUQzkIefZXYbP7lbEPoi9ud4uuoCK9BzGFUalWGzRT+tu/ryRXQojul3YLjxzkPUYyIK6wOfX6/5reCz003DyzxMxlKXiAW6CO22DCnP37J/VHjREyefuobhFF58KDuqyKZ8GK4dMdm3E+qcq8vuQ1rDrX5XWVi69shNllEVBsQHjU0zrMu/3HGOxi6Bb4vXPBav7mPwSLYr2H4da0Xgv4NRdZfkNcfCe1r91B9vd14k6GvnxgSseNP8D0ERktE=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read individual</h1>

<MethodEndpoint method={"get"} path={"/service/individual/{individualId}"}></MethodEndpoint>



This endpoint is used to read the individual's information as defined by the organisation in the consent building block. This is used in privacy dashboard where the individuals can mark their consents, sign data agreement etc.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"individualId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Individual retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individual\": {\n    \"id\": \"64541a2e6e7569000145cd66\",\n    \"externalId\": \"user@example.com\",\n    \"externalIdType\": \"email\",\n    \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n    \"name\": \"string\",\n    \"iamId\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"pushNotificationToken\": \"string\",\n    \"deviceType\": \"android\",\n    \"mapperId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update individual
Source: https://docs.igrant.io/docs/consent-management-individual-api/config-update-individual

---
id: config-update-individual
title: "Update individual"
description: "This endpoint is used to udpated an individual for an organisation defined in the consent building block."
sidebar_label: "Update individual"
hide_title: true
hide_table_of_contents: true
api: eJztWc1u4zgSfpUCTx1AsZNsuhdrNAaTv154e9ETdBLsoRMgZbFscUKRapKy4zV0myeZR9snWRQlS/JPuqcvc9jNxZApVrFY/KrqY2klJPnUqSIoa8RI3GbKAxlZWGUCKA+lJwnBQikLDCQBDSgj1VzJEjVMreMR62ZolEdWApKmypAEZSBkBKk1nkyASam0VGYGE23Tp4FIhC3IRZGxFCORWjNVs7tCYqBxu4JIRIEOcwrkvBh9WW3Ze2fU15JgfAl2Gi2Z/EppEIlQ/LbAkIlEGMxJjERn91iKRDj6WipHUoyCKykRPs0oRzFaibAseL4PTpmZqKqHejL5cG7lkmek1gQygR+xKLRK4z6Gv3o2atVTVTjeZVDk+V9nQZTU+pdp3FOzYGt8UEHzwIYfNjd+k6HWdqGXkFtJ2vPmu+mwyFSaQY5LcDQlRyYl8DYnUMYH5H/KsAg9B3IGNfilD5TDG0cz5UN9Ls1gAtPSpDyAGsaXCUxtaSS2A0AhPRjA2YYB7Tp2CoFBFc1kRBkbGFATglz5gE9kYKFCBghlfZgGQ+miirW2AYxrMBYsyahqzLULQ47HJKVKEqhmMUepdRIKcrkKHnIsCoZesIB71AMaObSOpRG8MjNN/a04u4AUDWthDZ7mxPJrYOPMEeVkgmdQPx8aGw6VOZQYcIKexGiK2lOyDQW5i7RETK3LMYiREImgZ8yLCIN3p29Pj/GE3tFf377729HR0fHp21S+e7cDituM1k5sI2JzIwNRseb60Mc/YEPpyf3c/B2kNt9Z+3OLM/aysSEjt4GU4RaKaogqD1o9kV7C9Xi8adxtNOyPGkg5qt0wuVrje3wJrAd8QamaKnIDOINa5QA+8OGvAXtfq7oXYB3ciy2w34sBXKBh+MbUqAxoDOTga0lOkY8OVpJMUGF57excSXI/4uh9h42T45M9h608pLbUko1BAx8+JjApQ0zKxi5gQSBtDLcM5wTYhoGdwtpCKBoT/QDGl+fnMWXE6bl1BE2ObNBdVVXyR5LV1XNw6DdS7Jc6CSftMRWZNSQetsOiTtW7vtrc+ifMm8RCvTCOnsd8v7M3FVw4wsAuYVjzGT7RMtUWnzgVgOf9s+5HJR8BPTxGtY8RntH+7y5wxdNgfMki9Va/K3Idp/H80mefbFDTpqzc2icy35e/pLmK0ccZda9zZJzxUljt17Ys6M0vNwd7FCaCTJnz0aKRziquqcp68VAlgpH2Euy312G24KPyWgqU3Gd+LMObsmfreh/nc3SP+wKb+Ovpeki2QFxV9WxfcE6PQDw5Onot9K+F/rXQvxb610L/WuhfC/2fWei5Gu9U6G2FvXxXxq6BBF+mKXk/LbVeikRkhDK2DVYsfVpX9E0lE+TILsoAbZthj+DxD1GBfjCQc9ZdWBkjgp8ve8vv8JDtIOmkO/cqE2gWrWxTyenRUbVH/Z4j6bLP+Z6NV9UeN98ZLENmnfo3yT2uOf0/ds1n8rZ0KcXUG8vHjoPe/iCN/N9y0NisSSe5OTmIy2z5qEqEp7R0KiwjRT4r1EfixweuQeeEjtxZGbI4wrvGGTcC+5T5IRE5hcxyG7Eooyu48TcSQ15XpTTs8stw1W8DVoJXZ9v2NRcvKbeN6SIRpdNiJLIQCj8aDiXl9hALNVAzhyYMlB3OTwSbvEXfA864FL+gxtev92h66Pxyw/CoT3XtnfZ4sB5oGp61Y7uW51kTuhFuOyn57HrM9RA4wJkl1KgcALPLOeqyLb2PG3oeoV4G8tIHpiSFo6l6JlnT+8faRniEN8aGur4Gh0pHNxSY0kECNJgNttSOoBF8v7SlY48cPtHyp8dItPo4WIlJ/PdhTav+8a/b3b0ZwFgMXqqTSaRPDai32tpRJKkt70sXTs0xXYJEn00sOgnazpRJmEBiM3XqbF4vtc281lr63fIB3JCRoEJkH1v+qDcN76NidkTTpOaTrV0g2izAgIp3Xs4pn7tu9dU6arcvpXwv+daFo3932Hcp2KbvLeHbx4m/RXYbqLZ5pmF2vcRTM7FuoOFZvYH9RKpPRTpC1GMxHXvpmv0cSVO7TtqYxqTdmlAWhXXh5zZUe18X/t4NbcZ4N3knQbZC8OY/v/1+wJckhJsFSeUz4Isl0HOaoZlR5Ktzcu0eocltLbzi3bn05MGTnh56OydHamZaICaNPE40QeooDqP2CSBINVOB2wmoNYWaHFutJBRWQqA0M5ahTj4BMjiJsYxgaAGa5qTjTYOTffymM1Gacc9KsAw2x8DTU5sXWsWbV8wTcXuOZqWO+/GxUQGRuwGWUoVoZ47GkGPoa5WS8dRdHsRZgWlGcDI42vH5YrEYYHw9sG42bGT98J/ji6tPN1eHLFN1V5ruHDgnSpuWfBNaZ00uD/V5nRydnA7+MjiO7N36kKPp2VN/vNqkznKzqLZE4E/90tbkiEDPYVhoVIbtjw5bNaXyi2jgFCtJz/7Rxlezh0Rk1geev1px0+PO6ariYb4Vx6qdiDm6iLG6oirPz7LtjrzokDefG+5zAC9+1du7kXUlNFwGY92qr9pPXCg3v/pVfGdpiiRbV0+5qG04jPmhU7HD1Li61xJnaUpF+ObcPim5vuMCNWk+HuaRlAmHC74540KMxL24F/GLaIyESAR5fCU0mlmJM55fq+UEhU0Z7CjAU6QAzUOv0bjpk202UO+Ff3vX/U2R9xwPH2n5Uzu9fvOiQMtA1t5nn1fVfwGVb4uh
sidebar_class_name: "put api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update individual</h1>

<MethodEndpoint method={"put"} path={"/service/individual/{individualId}"}></MethodEndpoint>



This endpoint is used to udpated an individual for an organisation defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"individualId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Individual updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individual\": {\n    \"id\": \"64541a2e6e7569000145cd66\",\n    \"externalId\": \"user@example.com\",\n    \"externalIdType\": \"email\",\n    \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n    \"name\": \"string\",\n    \"iamId\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"pushNotificationToken\": \"string\",\n    \"deviceType\": \"android\",\n    \"mapperId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# iGrant.io API documentation
Source: https://docs.igrant.io/docs/consent-management-individual-api/igrant-io-api-documentation

---
id: igrant-io-api-documentation
title: "iGrant.io API documentation"
description: "iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 2024.3.1</span>

<h1 className={"openapi__heading"}>iGrant.io API documentation</h1>



iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner.

<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}>

API key authentication. The value of the `Authorization` header must be prefixed with `ApiKey ` (note the trailing space), e.g. `Authorization: ApiKey <your-api-key>`.

<div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>Authorization</td></tr></tbody></table></div></TabItem><TabItem label={"HTTP: Bearer Auth"} value={"BearerAuth"}>

An access token of the individual, for example an individual token, the token of the privacy dashboard login, or a token from the identity provider of the organisation. Send it as `Authorization: Bearer <token>`.

<div><table><tbody><tr><th>Security Scheme Type:</th><td>http</td></tr><tr><th>HTTP Authorization Scheme:</th><td>bearer</td></tr><tr><th>Bearer format:</th><td>JWT</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>iGrant.io: <a href={"mailto:support@igrant.io"}>support@igrant.io</a></span><span>URL: <a href={"https://igrant.io"}>https://igrant.io</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3><a href={"https://www.apache.org/licenses/LICENSE-2.0"}>Apache 2.0</a></div>
      

---

# List data attributes
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-agreement-data-read

---
id: service-agreement-data-read
title: "List data attributes"
description: "This endpoint is used to read the data attributes defined in a particular data agreement revision."
sidebar_label: "List data attributes"
hide_title: true
hide_table_of_contents: true
api: eJzdWN1u20YWfpWDuWkC0JKsJNtCCIJ147RQ2zWCOsFeJAZ8RB6RUw9nmJmhLK3Au32SfbR9ksUZ/kkUncQBthe9sSly5pzv/H8ze5GQi60svDRaLMS7TDognRRGag/SQekoAW/AEibgM4IEPQJ6b+Wq9OQgobXUlIDUgFCg9TIuFdpmXWqJctIeLG2kk0ZPRCRMQRZZ4TIRC+HIbmRMF+3SS/T4O2EiIlGgxZw8WScWH/YDqO+1/FQSLC/BrAE1mNUfFHsRCclfC/SZiITGnMRCMJhOwZJFW/pUSkuJWHhbUiRcnFGOYrEXflfwFuet1Kmoqmio+KrMV2RZq6XY2MSxf9ydLGBtLBSYSh2sm8AFaErRyw2BsVBqdiKuFMEGVUmwRqUcrDC+Ywm3s9tJi/5TSXbXwzfrtSN/hHqNyo3BltpTSlZEIqE1lsqLxSwSudQyL3OxmAV7GrFK5tIPVR7b+g/c8kbQYzZb8qXVUFCwmibfCvB8NuLlizaicC99xmFuUyjEb8xNRwu+jKSL8A2vdoXRjhx/n89m/C822pP2/IhFoWQcojr9wzG+/YG8wnJGe1nvDrnW1Qe/kZ5yd6C4y9Rjiy8HlcX6UWpwBcVy3ah3HAPaYuzVDu4zDEUaG6Uo9pRwCLZn2vgzqc8YyAoddR7oXfKhdtkxgptoYIlMTr0VibWxOXqxECIStMW8UPz5by+ef38+n8/ph/j7+Nlq9Syexz+8mJ1/wUpYXoqqDeDX6ro6xV6/ZN9wj+rER6EkpXYedUzwMSj6KLgaPwpM6aNg7UeCvhbET6VSoA+USp3IjUxKVKc2979OIDIAR9pJLzfS7w4ArIxRhPohBE1QjzVd95JY03GzZlUxekqN3X29oW/JOqNHrHrdiBpX5GJTPCKmtu74A2tYBrRpG2I5VFRVUasBrcUdq+5b8FjReelru/pVw8SPS2tJ+7eY0gOd68gP9erQA5tGeWjaOSM0HtVy0AYekveOFx903NA+ADcoFQ+PQ9nzF61wxvotwhk0zyAe80ZDOxI6Dc+qqJkTX5Z9NYDcDoYjb8yqSGTo3nKzNqUbzfdjsUudcPMjBzLUjqXvHHONRsKJilAYtZYr2vpv16Bp60+kM12oDtOuSazw6vMNvc/fjhYp6Twl4Mo4JufWpVI8zzLCJJCePQt9Xo+jY9krZMpVlAywIUkjG88fNccO5wNZa+xrkwTb+fnyeFIMq+q4gPrdY1nT+fL5jLPhRPxI0+gbxY8jhlfViPffayx9Zqz8FyUnrnnxyBH/13LNUnuyGhUw9yYLQc3AR2EsxaUNM+nDXlwU8lfixxvmaj8SWrIXpc/CG7YaU2bpddJ3XJv9kZPPDDP9NHDYwMwXYtrw/ilXxFlXEdP9gKtXzYKeUUWihj12KLik3DRWiUiUVomFyLwv3GI6TSg3Z1jIiUwtaj+RZrqZi1Pmee15MqQPiXH15xFJN73Lrjlz6oC3jusih/WLhsPWPu9J7EWTtO1kGrDit0u4ox1wapP2TcJO4F3WHioafnF7JOcWajWQl87Dirh5ruWWkppc39YY4RaeaOMpCPAWpQpuKDCmpxHQJJ0MxC6g2fhyZ0rLHjm7o92r2wlP4cMU2YtV+PVTO/t/+ee7U9s0YGiD4M0d6VNeVbO5Jt/5yNd/qrdENfLD3YWVG4x3kKDLVgZtAsqkUkdMAbFZurYmr1Ul7FO/g8KajUzqWcYfjE1RS9c4+5p0AtIDuhN/1EbDyyD4VTjQhSYSpk/4JroGwQnF50sh9dq03Qjj0I0oR8lJ58qiMNb/vUu0PlHkz/2r4wztF59UfrcJnvz33/95yocHhOt7SqTL6tlE2zhDnbJ/E9iQ7U4e0BRs55wJLD3fDzhwpNZnzmzIkkx158ao2R+OvLGl8BqViwAhkalkJnKPSpEPypxRMoHCJOApzrThQJGLgDSuQibyRL4HRRtSgWRwFwt3CSupOGosBEtvcvS8PDZ5oWQg/iHLg3mW0lI1J6lwZRFmLmCZSB9w5qg1WQ6ckjFpF/p0W5sFxhnBfDI78fn9/f0Ew+eJsem02eumvy1fv7m6fnPGe6qefPZx4IpOTFxyt2trnptbHa/5bP588mxyHmitcT5HfYDnN+n88EJmWFYHQ+7Pud1pstvT1k8LhVIz9uCsfdP7P7R3Poz1qPuLSCxO72qGA+AmEplxngXt90xd31tVVfy6vhAIY0E6Dmcyfk46dMr/9zpn1Bt3PA/6W52wnQ9EYRZ9NfDH3s18BkpL+78RyRfuaj6j+Ghdr/2Gf9jQOB4ZzSe/N0ztKTx4QTiKpx3OeneIpMU5TMrqpmrpUgBYr7qIYyoO/XhCKqtDPvTzGx6C2EzInh3cBXbQPLD0UWxDolBD4L8cvNEtL7nZ/Eq7V93y+suDGzpyUq9mT91UVfU/WMW12w==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List data attributes</h1>

<MethodEndpoint method={"get"} path={"/service/data-agreement/{dataAgreementId}/data-attributes"}></MethodEndpoint>



This endpoint is used to read the data attributes defined in a particular data agreement revision.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data attributes for data agreement listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAttributes\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c8501\",\n      \"name\": \"Name\",\n      \"description\": \"Full name of the individual\",\n      \"sensitivity\": false,\n      \"category\": \"Personal\",\n      \"scope\": \"read\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all active data agreements
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-agreement-list

---
id: service-agreement-list
title: "List all active data agreements"
description: "This endpoint is used to list all active data agreements by the organisation in consent building block. The results are returned with pagination."
sidebar_label: "List all active data agreements"
hide_title: true
hide_table_of_contents: true
api: eJztO9ty3LaSv9LFF8unKOpiy06mUqkdW3YyjmPPSnJcG8tlY8jmDCIQ4AFAjeao5u18yX7afslWA+BthpIl26dq69TmwdGQRHej0fduXEcZmlTz0nIlo1F0tuAGUGal4tICN1AZzMAqENxYYEIASy2/RMiYZcDmGrFAaQ3MVmAXCErPmeSGETjgElIlDUoLs4qLjMs5zIRKLxI4WyBoNJWwBpimv22lJWaw5HYBJZtz6WAkURypErX7McmiUWRQX/IUxzXq19zYKI5KplmBFrWJRh+uN3Y1lqBmf2FqPfjJMWi85MaDjCNO3/y9Qr2K4kiyAqNR1PtA498rrjGLRjkTBuPIpAssWDS6juyqpM+N1VzOo/U63sT9pipmqEHloDFVOjPETXPBS8iV7u4UxiBxzhx3lYZKamQZmwmESyYqhJwJYWDG0guC8Hn/c3ID6SrPDdo7kc2lxTnqKI4yzFklbDTaj6OCS15URTTad/sJYAUvuN1E2d/r7+yKFoIc2rM/YijR7RqTryXwYH+9/khrTUnCZejrw/19+l+qpEVp6U9WloKnjrN7fxmi7roDvdQkVJb71STLjTy5J9xiYTpkeOmJ4shyK+jBcXfJFh/GslUNUgHLuDROP0yJKc8DYcQgBobLuUAoK10qg2AXzELKJMyw1h6ngQnAGHponXpKfonaMAFMZkPLSDH/VjC5+htwmfFLnlVMEC1aVfMFsD7IE3dcybmM4uhqVyq7y+UusWfGDDan1B7bhyiQTRro/zrucCJ2J6KVEKjfadH7/YakKo5KJXhKkiTYMq/EM2a4ieKoQLtQ2dv8nQPtbU4UR7nSc7SWtIKW8BzTVSow+hhvHCnPtpXTLS+YjUZRFEd4xYrSneWTo8dPDw4PD/GH9Gn6aDZ7lB6mPzz+8XDrWKN1HBG3uRenu0E/SPaT/S1QZP8CKJICS2a3LxtWwXLBUzoijSny0kkS4TBER8vIyeBW++gmxx6Lk42wrg+FjueLYN6dvCY4zva3S2GnYCuSO1VwS1LHc5DKf8XlpRKXmD3sY3OH/0V09NW34AuyNdo0yVP3HCqZoQ5MdgfQ1y6zIHc3Q5irSyTflAC8X6CEVCOz5MvYhheMHYcFs2gseOS1StZuNOdCuK+COfO2PQanvj3nybKC/CeTkGHKM6TV6YLJOQK35FodlB5+EHiJwmvvTYZrWuvb3dRbei2ttPj+Ovb06f7BoI7JG6RjGPRx4KTjRWNOhiWJeBY++X66/EdXj2v4sMO9Gc+VEGrpjT8Wl6jBw3YSWg1r3TD2hbWlGe3thSdJqoq9UvNLlq52b9j3FHXBJIkGqS6zXWm/RL3q2yCEaU9oKQCJwSxUJTKQytIzRrvxshykkbQDLC+QNvRXpbnJeGrvxdcX77Yof9UFtKaoI6uM1atTTK3Sdwf9KzJhFynTuG0UA0gwHuY6dpHACVIMwZWcouYqO2YrMxiQDOJ79ORoEw1ZFQp+PFCKf7jKSIEzgryOozmquWblgqcnSLv5dub90kCkILsBuY4jY5Vmc3ytvJf5JiynHhaIGtg6juyC62zKtF3Rtk8XzAFtscyUEsjkTWisrnDbVXKdQUkwvY6bAHW9Dic2tlbzWWWxe1BMa0YK0YRyTIi3uUsONm3jwHmxBmQdv/XdsyGNwSuWWrGCJYVsnL4UAlOLWXJf+9ql4PvHMkcDdra/S5gc39/wvtmmvW9pG/Cxy3W4NJbJFOHcITqPKM05j9gcz53Z7wG6KxEvKyFAdpC2Ue72nttfWyQ65UBpuOWX3K7uLrLhUDdUo4XUBDA9VCmzOFd6dfeNTlEbJQd29TyAGkZkUlXe40zJ5G8rOsGAWmzdWW4iconipl71xbhjiW7V09u1k9J9n1h2oN2mbX0iUo3ZMebDMfMNHuTR8fuD39+9/3P17GJ69PqXx/rsv05+HT0aPX89+mF/VOelW8eiMSOTzwTFelxyJ3Zez3wi+h2IOBw9p705q4TwNocTnHNjfblk9GQwXDl1yB0l7r+Pm6r3XSzguXMHdXZ451C/XrAezCe/CGZDwzvQuunlnbm+LX0OCswITGNCmvB7tyl37YHAOROf1EzwuY/n93wGw1J6e8ktE58oliA5hj0oq5ng6SfLzIVfzC0vmMXmG6JLUk3mQxSQUAK8gaROsJlTnD4Sl6E3SPziLSQkC93U++s59buDQjyqDMIuSLLTe85ufDKq0inWvyoqgHwKZb12m7TAu/fwfRR+9b930ltydszst5B75pMpBCWbGBnheDoZg8ZSaSfdc5RUicQMWG5RU/FkOhlHgYLTqiiYXt0pkSZ0704ElFpdclcX7aCjqmjAamIwHiygTXu1oUvUPOeYUYGHyRXUZ4g+ViJ7R5aGzyWzlXa8udrNL3YLlaEgM9C82TIQ9RtXn6rsQmlOPA8xmMo3EuWdZoGBkJmnC8apmhvS1JQZB6yohOWlQGjIMg9vzVa7RN6xHsVWQjkfZjprPbO84fKSufFw2iwbePorM4uNN0QYZs9WjtYCjWVF+f0jt6OhyO2tY1LD6pIZqi24uvBsBUYVCOPppCniG1fzVpUFJoFnsDP97WEMGUplvdwxS2e0cmV4BudRplluz6MYeIIJMGjFwQYrT6ngCi1QMtEecn0svpQhxQrwihtr3HvNKCBKnF0PrL4zZ66TJFkPqlDOJRMQADbkGXc2sTPGVlepU1gDDF6dvn0DBjVnoq6yqBxyjiIzcD1w8CNIkiSGG0Ri4K2XrYEXY/LSLLUDr2pRGnj1aml+RZahjqGRsvCZ3+R7f7ReJE4wR40yxfCJ16azVdl/0P9sncBp4EiPTZR6JzDxLq5Rpb4VnGGuSGjkyi5Iloj3wyKxQzKxcNCd+Fmqo7l+UZ+kutjQKe7lWhW+rhKOeVZZV0bzaJwlXjKdmWTL3t1NvHD1ajH7JeVv+auXf744OfvP01c/Jklyu1msiVkws/BlPw+8DgpajrU7CuGTN9nI7QL1gPBQUjQoA6FitWnH7p7BZ4dHRwc/Nts43D/cDg7HsEQhdi+kWkrwAFtb4R2jjw/q3mACfzDBM1/HNCM4e3ZM3T1uoODzhSsZ4VXJZFb39kxVkmfDrLfLANW4zqDG2rgxcL0oJsCg4227OiwAiSkaw/Qq2WTQ9PsYmgk5VsmEWHVE37Q6s1FCy3y5Jwi0O+tWEb1t3JD5XScPVy5sc2Vl2cIPoQGvMy7jtPOGnTo/defdsoPZYfooe4xH+ZMheR/cd6pXpW2KSyT99b59k5IaTthYYOdB2pcqHzKlm5upTeU3RHPjvmyxALE2SwQl9N5SJilO8UcSAy/YHOOO9qJNN+lrXP+d6ct4NrrA1egfT36/yIdY/QxTVjnPCdwljTlH/YA8pwfoFISttiquzvJ4q8xAoi/LOhMcnGFnvXfzbplTJD6XXM4TmPRDNLZxxA0rYl81dt6yNmpNYkhBR0u5qxAIpS5IequysWirOtD1iQhc4KprL5sQc4AoqeTuXQhLe3QxcJ8w0akKPTCuXGRiqsS6ikpoV8eABeMCWJZpNAYN7AZeMjCSlWahrGfrjEvf0u5b+u/E4WD6rI9v5qhLTbMYW+WtB6bHR6qv+YMgRCYGBlZdoGwdaGWcUE2OwaAxbrhiULTH98iQb6u2nYxfnsHLyYvXxyM4Db7Pd8E1Cl9DWPASZmiXGMKBbrbRYazMwt49qk6GVvvhVMkUtTTB93BDOPCSSeuE8XnIy31/2yQwVcbwZrbCjOC8s5XzCPYoEEbKry2eR1uMap3yNxgp4eyrm/cIsrTt3vvxIBl4x43NQwvyMydYDF69P+06qDD6snPy8vnTo4Mj13hqk5Y7b+Bw//Dx7v7B7sHR2cH+6NH+aH//z+2ovIZba0CgLK20Rkmloo6yciMfWKfyTe8sHKdRwO0Dn2kQNNS7pVYqr0O8myLfbyzbTmTmKmnG6/mmo14yAwJzCzPB5EXtTQZCAbeavva0EtVtDHCfYqyfQbq1yO5rieDS+mGyQxpIIyR/NNLenE1dhq+RnUedUlOHgjay/thsZ4jvX5HmPnkykOaOwayKAqnI29gL2PN5bhNe1YrTibA2eJ/Ae3SpbSuBf1XGen6J2s74sEu5kLy1OzvMFzIeEoeaz+AkMAV2vB0KBRnWDJUFKx9sjh+Bism5dyYFQpcYbfow8Z2sMORyZwnetihb00FhVo8shsTl0KiPaWaGaKjBi2p3yOZ7UeOx1b6NLCtFk0s3ThH4xH2lItNsKWOKdLk1voTgTjrUHZpw39l1VmXcshkX3Pr4P1VFySxZdjIQoTP/5UJ7rzJ2+2zX+8l05J1MMGJ9m+Fq5+0h1FyunTrVQXLUuk1suQFoqYaShEhVpidMTs9J53uk+RJ7OwT1xaqjI/251wN4Xa8DY13h06PpYUhg8zM/rVlPsxRMUgOYh0wBlkpf5EItjRO5zckB4zWSxiCYtDyFAhmplPFH6WV1mH9+pqW2Sq5CFfnDJkHyRWBm2TsKHE59ZfiWHtPdWsCVj0I8tP5sDtG7PX5z36ZvGDuIo6aBvlVAvF9D9lY/kd2+J9//vN9sxUD7JecSTRioqDFvohH3Hj64EVEN6iZUYTzmmJnFTDGd3VCcvyfWABWyGixUWgyT4NtrqkQ5Lvlpt3/25VbnWTetCTOkbwnSdLIxK5iptHLq4gHM6jxrPJ08aMe5Tey9HuUGVIaox6p95Yzk49Q1Wr5Zc0J/599DZQY28/+68i/TFQqEeqLnGgb1jPxtE9nT9qutpr93eVM270pGd7S817gPDpKG1ENpoLvVA6JQWSYmGwMLN8E7o487I/FOlYBdMi7CHHMD+/CoBk60fg1wIpouCbi8T0I9s9/Op7mIgR5+GfabDZLryf0eN/bXcbRgZhrClsGA8aYki+e+fvWAyldN4LOJwlkDj+UNXtmvxyDxym5Bp4mzdVfsgmD54bJ+RjJ882Wn4fbk9C0cPj16sv/QXZehUKdKKVzNKyHIii5czYCYRNAf+0sLfSQzRiFlWbm82N9oGVh4cK/bDl1Dilor/Vxljgn0d3e+4uN2J7avSe3qIfFpmPp4n8RiC/yANWktyLOBja/XA8fwToYq0T8w22LN0T0vgvx7saYu2bsIDzU4NBs88r6r0m7I7cN1NC75b0h/fqQRrmfINOpxZRfuCe2azcnxR/3AnPhRhAZUNEd/A4sWRXshutwjPdlt9cR5b6Jq6ILWMRYqEB2mzdtx5wwLtctKnvC5ZtImXO1dHkbbF61OLXmA+U1gjH89AOljyxE3G+XPs+ZLGwr5B+EClGdpe+lqHGSy9kAbpmM6cVVaklyqkqfhytdZtzdCHvFzD85n8GigoJLFzGWHOb+qW2mfPY3wGXaksr5kbDXjvqxRshQfxoDJPNkAO4Kw8KeVqjRxZPcCVz9/dnFgVwKuo5n79bL2+a/enw1ednJWLtSbtwrVfvoziLPrcTSv/BLfQO2t3g4bhJpzGVMlZquw7TsPdhXGaXAwmqI+t8zo7gQzW/zwm4afHOCf3c06ZyOcl3Hv2iEVEii66BdRd6U2NqFf5ToIpMS+TfkfjaC1gsJ/aR/1JbT9eEuxm0Ww8z///O+HvuFzusSMm4V3SHgVmkOb5eEm26uZk8DEUgZPoafIdw11k5DPZcPGuubs7h6mzRijaylkfE5TZbBkQqD1rUpF/d9SZWAxXUhFB0X9B5RsJnzFjIpP7m6KCybISLnkw9dtHBBWWVX4WzUuq+duUNhJeWiozqvQM3Bdf3Auta7/CGoYS4k6cbfCUpR+dq3WzZKlC4RDNwzZ5/lyuUyYe50oPd8La83e68nzF29OX+zSmnUbZLbnQBpdp121zjf3SVytPHmUHPhbSMYWTHboeX37XdpNDeu4s/+T93ODXli8snulYFx2brZ4p/Ahasf7Nt3CxzhaKGPpo+trCqXeabFe02N/x9Q5C27okLPhsn2XP1+46TtI6gWZ+f6FX2eT/W2k+2D/1971vYX45srvVxJ+34u7t5BSpxwtJR/ph+a+nkxhRu086Wj9onGaYtldtRW1rbsBxy8vyA2x4KNa/3zh/HP4o1OsYHLVgb3pqj0J9G9niL2/5CdS999w9XPzuX9z44ImPPBfE4Mouf1fSUIbZg==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all active data agreements</h1>

<MethodEndpoint method={"get"} path={"/service/data-agreements"}></MethodEndpoint>



This endpoint is used to list all active data agreements by the organisation in consent building block. The results are returned with pagination.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Active data agreements (based on ISO 27560) listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreements\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c8492\",\n      \"version\": \"1.0.0\",\n      \"controllerId\": \"string\",\n      \"controllerUrl\": \"string\",\n      \"controllerName\": \"string\",\n      \"policy\": {\n        \"id\": \"65471222e8c7c3bb3c2c7701\",\n        \"name\": \"Default data policy\",\n        \"version\": \"1.0.0\",\n        \"url\": \"https://example.com/privacy-policy\",\n        \"jurisdiction\": \"EU\",\n        \"industrySector\": \"Healthcare\",\n        \"dataRetentionPeriodDays\": 365,\n        \"geographicRestriction\": \"EU\",\n        \"storageLocation\": \"EU\",\n        \"thirdPartyDataSharing\": true\n      },\n      \"dataAttributes\": [\n        {\n          \"id\": \"65471222e8c7c3bb3c2c8501\",\n          \"name\": \"Name\",\n          \"description\": \"Full name of the individual\",\n          \"sensitivity\": false,\n          \"category\": \"Personal\",\n          \"scope\": \"read\",\n          \"restrictions\": [\n            {\n              \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n              \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n            }\n          ]\n        }\n      ],\n      \"purpose\": \"string\",\n      \"purposeDescription\": \"string\",\n      \"lawfulBasis\": \"\",\n      \"methodOfUse\": \"\",\n      \"dpiaDate\": \"\",\n      \"dpiaSummaryUrl\": \"string\",\n      \"signature\": {\n        \"id\": \"65471222e8c7c3bb3c2c5501\",\n        \"payload\": \"{...}\",\n        \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n        \"verificationMethod\": \"Ed25519Signature2020\",\n        \"verificationPayload\": \"{...}\",\n        \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n        \"verificationArtifact\": \"\",\n        \"verificationSignedBy\": \"did:key:z6Mkf...\",\n        \"verificationSignedAs\": \"individual\",\n        \"verificationJwsHeader\": \"\",\n        \"timestamp\": \"2024-01-15T10:30:00Z\",\n        \"signedWithoutObjectReference\": false,\n        \"objectType\": \"revision\",\n        \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n      },\n      \"active\": \"\",\n      \"forgettable\": \"\",\n      \"compatibleWithVersionId\": \"string\",\n      \"lifecycle\": \"draft\",\n      \"dataUsingServices\": [\n        null\n      ],\n      \"openApiSpecification\": {},\n      \"dataSources\": [\n        null\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read data agreement
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-agreement-read

---
id: service-agreement-read
title: "Read data agreement"
description: "This endpoint is used to read the data agreement defined by the organisation in consent building block."
sidebar_label: "Read data agreement"
hide_title: true
hide_table_of_contents: true
api: eJztXN1yG7eSfpWuubGUGlE/tmSHlTq1tGTHdJxYq5+4NpErAWeaJCIMMAEwpBgV786T7KPtk2w1gPnlSJaOdc7F2c2FQ3IGjUaju9H9dUO3UYom0Ty3XMloGF3MuQGUaa64tMANFAZTsAo0shTsHCFllgGbacQMpYUUp1xiCpOVe6r0jEluGJEDLiFR0tBrk4KLlMsZTIRKrgdRHKkctXttnEbDyKBe8ARHJd0zZGkURznTLEOL2kTDX287vF5K/meBMD4BNQUmQU3+wMRGccTpac7sPIojyTKMhhFxXREfE2mNfxZcYxoNrS4wjkwyx4xFw9vIrnIaYqzmchat15/pZZPTSgw9P9jbo/8lSlqUlj6yPBc8cavZ/cMQc7cNetxi5gbmmhZtuSfTYqkxb7UMy62gH05aL8YdKYxkYzeIJ8alcXthckz4NPDlZASGy5lAyAudK4Ng58xCwiRMsNwpt9sDgBG0pnWqIPkCtWECmEz7hpESfJMxufoGuEz5gqcFE8SLVsVsDqxN8gwTpdPBlYzi6GZHKrvD5Q4JZcIMRsMpEwab2/RrFNgmvfCfThqSiN2GaCUE6kstWt9/IiWIo1wJnqyiOBJsOS3Ea2a4ieIoQztX6cfppSPNEssX9GGq9AytZRNB3wSfYrJKBEaf485G8nRTa9zwjNloGEVxhDcsy91eHh2+eLl/cHCAr5KXyfPJ5HlykLx68e3BxrZG6zgiaXOvTQ+jvj/YG+xtkLqYIwRSpAWWTLytG1bBcs4T2iKNCfLcaRLNYYiPWpDj3qW2p/P2SApYj2tToe35IpnLsw9Ex7mbeihsZWxFeqcybknr+BSk8m9xuVBigel2eza3+V+cjt76mvmCbg27TurU/Q6FTFEHIbsNaFuXmTMhaJqZWqCWmA4APs1RQqKRWfKbrON4YydhwSwaC37y0iRLlz3lQniXjVNWCAsLJgqMwZlvy1GzNCNfzSSkmPAUaXQyZ3KGwC258R7HL3CBwlvvXY7rtLS3h5m39FZaaPH0Nvby5d5+r43JO7Sjn/RJkKSTReVO+jWJZBZeeTpb/rlpxyV92OLejU+VEGrpnT9mC9TgaTsNLfqtrn/2ubW5Ge7uhl8Gicp2c80XLFnt3LHuU9QZk6QaZLrMNrV9gXrV9kEIpy2lpfgiBjNXhUhBKku/MVqN1+WgjWQdYHmGtKA/Cs1NyhP7KLm+udzg/H2T0Jrih7QwVq/OMbFKP5z0O2TCzhOmcdMpBpJgPM117M7/M6QQgit5ipqr9IStTGM6Li3OUN813/Ojw+405FVAl0Qhd1TJgFOivI6jGaqZZvmcJ2dIq/l64X1fUQTdILmOI2OVZjP8oPwp81WznHtaIEpi6ziyc67TU6btipZ9PmeOaD3LRCmBTN41jQ/7NsJfnUJONL2Nm0B1vQ47NrJW80lhsblRTGtGBlFFekyIj1MXsnZ9Y89+sYpkGb+1j2dDFoM3LLFiBUsK2Ti9KQQmFtPBY/1rk4Onj2UOe/xse5UwPnm84/1pk/e2p63Ix+TzgEtjmUwQrtxEVxEoDVcRm+GVc/stQg9l4m0hBMjGpHWUu7nm+tsGi844UBpu+YLb1cNVNmxqxzRqSlUA05oqYRZnSq8evtBT1EbJnlUdB1L9E5lE5Y/YU+1zvM5qiAaUauv2sjvReh1v2lVbjRue6F47vd86P3BjaaUtavdZW5uJRGN6gtP+mPmOE+T5yaf9Hy8//bJ6fX16+OH7F/riv87eDZ8Pjz8MX+0NQyC3uS0aU3L5TPh8nDu183bm89AnYOJgeExrc14J4eMUznDGjfVJ/PCoN1w5d5M7Ttx/n7um9yQe8ModB2V2+OBQvxyw7s0nv0imY+ENas308sFS39Q+RwUmRKZyIVX4vVNBK7sgcMbEb2oi+MzH87s+g2EJPV1wy8RvFEuQHsMu5MVE8OQ3y8y1H8wtz5jF6h3iSxYZnRlhEkqAO5OUCTZzhtOexGXo1SR+8MYkpAvN1Psfl9SPjgrJqDAIOyDJT+86v/GbUYVOsPxWEADyWwCb6mXSAH+8h/ej8K39vtPenLMTZr+G3QufTCEoWcXICCen4xFozJV22j1DSfgYpsCmFjWBJ6fjURQ4OC+yjOnVgxJpmu7yTECu1YI7DK4xnaFsxs9qYjCeLKBNWtjQAjWfco/yMbmCcg/Rx0rk78jT8JlkttBONjc70+udTKUoyA1UTzYcRPnE4VOFnSvNSeYhBlPTTqK8VQ0wEDLzZM4cAhnS1IQZRywrhOW5QKjYMtv3ZqtNJh+IR7GVUO4MM42xXljecXnN7Px4Wg3r+fUdM/POE2IM09crx2uGxrIsf/rI7bAvcvvohFSJOmeGsIUJS65JFYzKEEan4wowNrDkdq4KS3AsT2Hr9IftGFKUynq9Y5b2aAVMIzC4ilLNpvYqioEPcAAManWwwctTKrhCC5RM1JtcbouHMqRYAd5wY417rhkFRAPn14OoHyyZ28FgsO41oSmXTEAgWLFn3N7EzhlbXSTOYA0weH/+8ScwqDkTJcqipjDlKFIDtz0bP4TBYBDDHSrR89TrVs+DEZ3SLLE9j0pV6nn0fmneIUtRx1BpWXjNL/KT31qvEmc4RY0ywfCKt6aLVd7+of3aegDnQSItMVHqPYCxP+IqU2p7wQlOFSmNXNk56RLJvl8ltkgn5o66Uz9LOJqrTbRZKsGGBrg31SrzuErY5klhHYzmp3GeeMl0agYb/u5h6oWr9/PJ9wn/yN+//eXN2cV/nr//djAY3O8WS2bmzMw97OeJl0FBLbF6RSF88i4buZ2j7lEeSop6dSAgVl0/9vAMPj04PNz/tlrGwd7BZnA4giUKsXMt1VKCJ1j7Cn8w+vigrEMN4GcmeOpxTDOEi9cnA3AVq4zP5g4ywpucyRRT54jAFDmdbJi2VhmoGhqLGkvnxiDjkmdMgEEn23p0GAASEzSG6dWgK6DTp3E0YzpYJRNi1VB9U9tMB0JLPdwTFNrtdW2I3jd2dH7H6cONC9scrCxr+iE04GXGZZx13rFSd049eLVsf3KQPE9f4OH0qE/fe9ed6FVuK3CJtL9ct1MAV3DCygO7E6R+qKZ9rrS7mNJVfkU0N2rrFgsUS7dEVELtLWGS4hS/JTHwjM0wblgv2qTLX3X0P5i/lKfDa1wN/zr68XraJ+rXmLDCnZzAXdI45aif0cnpCToDYasNxNV5Hu+VGUj0sKxzweEwbIz3x7wb5gyJzySXswGM2yEa62xxJYrYo8butCydWpUYUtBRc+4QAqHUNWlvkVcebVUGuj4RgWtcNf1lFWL2MCWV3HkIY0mLLwbuFSYaqNAz4+AiExMS6xAVkEU2oTMWM8YFsDTVaAwa2AmyZGAky81cWS/WCZepIVG3Pf0TSTi4PuvjmxnqXFPdfwPeemZaciR8zW8ETWRiYGDVNcr6AC2MU6rxCRg05LI2PKZX7dEjMuT70Laz0dsLeDt+8+FkCOfh7PNVcI3CYwhznsME7RJDONDMNhqClWlYu5+qkaGV53CiZIJamnD2cENz4IJJ65TxOOTlvr5tBnCqjOETgdW5ddVYylUEuxQII+XXFq+iDUHVh/JXOCnh/CtVtktd2jze2/EgOXgnje6mBf2ZES0G7z+dNw8o79xg6+zt8cvD/UNXeKqTlgcv4GDv4MXO3v7O/uHF/t7w+d5wb++Xzai8pFtaQOAsKbRGSVBRw1i5kc+sM/mqdha20yjg9pnPNIga6p1cKzUtQ7y7It+vhG3HMnVImvF23j2ol8yAwKmFiWDyujxNekIBN5re9rwS13UM8BgwdsGNh3XuBtk9lggure9nO6SB1ELyc6Xt1d6UMHw52VXUgJoaHNSR9edqOX1y/wfS3KOjnjR3BGaVZUggb+UvYNfnuVV4VRpOI8LqyH4An9CltrUG/lEY6+UlSj/jwy7lQvLa72wxD2Rsk4Sq1+AsCAW2vB8KgAxFfeGB9/LB52jnc2I63BudAqFKjDbZHvhKVmhyebAGb3qUje4gT9J5DInLvlYfU/UMUVODV9Vmk81TceNnK8828qwUTS5dO0WQE/dIRarZUsYU6XJrPITgdjrgDlW47/w6K1Ju2YQLbn38n6gsZ5Y8OzmIUJn/MtDeQsbu7+36ND4d+kMmOLG2z3DYeb0JpZTLQ51wkClqXSe23ADUXENOSqQK01ImZ+dk8y3WPMReN0F9EXV0rB97O4AP5Tgw1gGffprWDAPovmacLZXdLBmTVADmIVOApdLXU6GWxqlct3PAeIukNggmLU8gQ0YmZfxWel3tl5/vaSm9kkOoIr/ZpEgeBGaWXVLgcO6R4XtqTA8rARc+CvHU2r05xO9m+81ji76h7SCOqgL6BoD4uILsvedEev+afP3zcb0VPeUXajw1oaGinLk7jXh088GdE5Wk7poqtMecMDOfKKbTO8D5R84aqEJakoVCi34WfHlN5ShHOT9v1s++XOq8aKY1oYf0I1E6HXd6BVOVFKHzlwhMyjxrdDp+VrcOm9ifepQbEAxRNvt65Iz049wVWr7ackJ959/DZHoW8/+28k+zFQqEqqDznv7rs7tC4xF849AqnnxTH6E+OE5Y7otUnag9NI0b37K+ChH1M1N2Zmu1rNNKh1ybwqdUVsH+9l3pvDOyg20foxAQcCWv5MhQK2eVkl9FpkgooFH6KqLqeZFR7FNzXqPHFCbxFClyoHb9xzQZcVcOc6sKPTtenq7n3n8ku3X2pflfTPC/MD0PkEf41f8YKmH/xJJXby5QRdzN9om7eojvwODuDepOQ9QlVrQljvxV5CsN5LcwmUueMEEdkYZaHxrbwlwl4qrBVCuD6s5bN2puhseNzOoxvSEP7l+nktnpD5XxBR2u8qXKIup81anFExTqmnPx7lQ9CX1r+U+WyY/TnhS+R+VDXsJEUgjf6d22gEFNj+J6U0wM/ln45HKCdXHKV6R6TOorJVqaA6b+iNoKpTsqDWz7Gp4v343yXKx8Pe+YSeV0mP/lTwHXBkRROeGgMH5z8RbO3h7Dq5evDgcA48a9FRZa1kOhtI074E2CuQVTeC82pobhlrCa30sBhO6gjl/5hyoX933eENy7UK/o2/Ot83ejnf1/HTjmdKz086Rjc5bn6BCLsW04mPH5R3h1tLcPlxfHvkWl7LUOYOlfVIwYV+ClN51NawjQ6fikbrcob1O1SX0kFORR/ufF4Yt9doBH+PLw6Nu9vb39F4dssrdZXDxrwjasvOJAsLS3UioQBxzCJ8ZVJEDKUh6UnrVWxt6IBr5wD2baJuxRBRCKcPbm7Y3yhdhjTcQwwREVEz5gwhT918fp78O0N3m+qUAeCtVoHCpi68qWiyga2IGHnBKV8xJp6Bhbm//zx5fNm6z21bQexytsLRFSRXgw1Z7pSo/Dgztv1bgeQXJS0S0KFzO248T6B5+/+E7xnh7HuoeJgidqW3H2dvDy8Ghvm5r2NccFQRZ+36eFEHR2zx32T/EOEX7h7x626U8YnQB54fBtf1+yZ+D+oy4tNmM61FrpY5W6jjn63OyT/LzZUdWO0urRfTcbqk1+sbe37iHfoyO1XrzuWfh63bMDl7L2Oj2iefF/WDRnGLJOgs6mqpCbAjp85IXXfy8Blb0JDspCDW6ajox8kl5o183/6200yvkPSB8/U6/6a2Qa9aiwc/cLrZrNCOGI2ggkySMLnTbRDJ046BbzMNoNMNouxWA7lSvZve3ca177DGrRf2H6BDMVVhHu2dUXvVLM1A7L+YDPNJN2wNXu4iAi7rsXcdisxPV6yBj/uIfS51pEPhx0G1wKqgaB/A/hEreXcX2NexSsuOxA7uTjp2NXnyZbp/4Ar6CuzafuCiFX/3uLzu/gp4GMijUTdxJM+U3ZRPS75xF+hy2prC+WW824L+jkLMHtGHAwG3TIDiEM/G6lCk0S2bnG1d9+d5F6UyVuo4n79rY8+95/uui95u3OhVBp3yjR+3svQb9dd0cdiLkhvnWsNXoTMBFqxmVMB95GSd/3XNhVaCTGXhyJOvxkSrdGmdmQh180fOcIkyBCeu3iFPesDqpIoaK1u4w3VaX3CZ06rneCrNo3aP1HpWi1ovDv65/aGlq/vGHp1SDY+p+///e2b3U5X2LKzdxnP3gT2mK6hfEK5y6F4yLrwjjQTUx3DPXRIJ/JSoxltZ1KXxSJhgscrpki5TPqp4clJfzWN2kp6nzLVeoRAkUbRZ0XKNlE+Fohld3crVzaGFcncbCrr1g5IqywKvNZpqtncHdFyml5aCWbFaFbwvU7ggtCysqXoFY5KVEP3H34BKXv2i9tM2fJHOHAXQNpy3y5XA6YezxQerYbxprdD+PjNz+dv9mhMesacKv3gSy6BJxLm69u0rpEaPB8sO/vXxubMdngh/6ExCYE3Ln4VZ1p/8K/fBE03OKN3c0F47JxO9f7+1+j+opC2+NHcTTs/i2Lz3E0V8bSsNtbii0vtViv6ec/C9TuFIqjBdPcV1npWOCGPqf9gEZTKltn4Szfhjv/3Ebvekp3LsmXO+frg/pr8vYbf47DVS6CsycG/VujhPL9xviNsGPdPDG/f0NukwWfWp8n1+48CR8aZYU2b92jxbNA/zaum7WHfEfq+QOu/la97p/cOaA6zvzbJCmCof8Xh0sq2g==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data agreement</h1>

<MethodEndpoint method={"get"} path={"/service/data-agreement/{dataAgreementId}"}></MethodEndpoint>



This endpoint is used to read the data agreement defined by the organisation in consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  {\n    \"dataAgreement\": {\n      \"id\": \"65471222e8c7c3bb3c2c8492\",\n      \"version\": \"1.0.0\",\n      \"controllerId\": \"string\",\n      \"controllerUrl\": \"string\",\n      \"controllerName\": \"string\",\n      \"policy\": {\n        \"id\": \"65471222e8c7c3bb3c2c7701\",\n        \"name\": \"Default data policy\",\n        \"version\": \"1.0.0\",\n        \"url\": \"https://example.com/privacy-policy\",\n        \"jurisdiction\": \"EU\",\n        \"industrySector\": \"Healthcare\",\n        \"dataRetentionPeriodDays\": 365,\n        \"geographicRestriction\": \"EU\",\n        \"storageLocation\": \"EU\",\n        \"thirdPartyDataSharing\": true\n      },\n      \"dataAttributes\": [\n        {\n          \"id\": \"65471222e8c7c3bb3c2c8501\",\n          \"name\": \"Name\",\n          \"description\": \"Full name of the individual\",\n          \"sensitivity\": false,\n          \"category\": \"Personal\",\n          \"scope\": \"read\",\n          \"restrictions\": [\n            {\n              \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n              \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n            }\n          ]\n        }\n      ],\n      \"purpose\": \"string\",\n      \"purposeDescription\": \"string\",\n      \"lawfulBasis\": \"\",\n      \"methodOfUse\": \"\",\n      \"dpiaDate\": \"\",\n      \"dpiaSummaryUrl\": \"string\",\n      \"signature\": {\n        \"id\": \"65471222e8c7c3bb3c2c5501\",\n        \"payload\": \"{...}\",\n        \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n        \"verificationMethod\": \"Ed25519Signature2020\",\n        \"verificationPayload\": \"{...}\",\n        \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n        \"verificationArtifact\": \"\",\n        \"verificationSignedBy\": \"did:key:z6Mkf...\",\n        \"verificationSignedAs\": \"individual\",\n        \"verificationJwsHeader\": \"\",\n        \"timestamp\": \"2024-01-15T10:30:00Z\",\n        \"signedWithoutObjectReference\": false,\n        \"objectType\": \"revision\",\n        \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n      },\n      \"active\": \"\",\n      \"forgettable\": \"\",\n      \"compatibleWithVersionId\": \"string\",\n      \"lifecycle\": \"draft\",\n      \"dataUsingServices\": [\n        null\n      ],\n      \"openApiSpecification\": {},\n      \"dataSources\": [\n        null\n      ]\n    },\n    \"revision\": {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    }\n  }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create consent record and signature
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-create-individual-consent-record-and-signature

---
id: service-create-individual-consent-record-and-signature
title: "Create consent record and signature"
description: "This endpoint is used to create a consent record and signature object. This returns the same objects with the PK defined."
sidebar_label: "Create consent record and signature"
hide_title: true
hide_table_of_contents: true
api: eJztXOtuGzmyfhWCf2IvWrLsxLkIg93jS7KjZHbitZ0zi40DhOouSRx3k70k27Ji+N8+yXm08yQHVWRf1fLYOznnAAvlRyB381osVn31VaHveAI2NjJ3Uis+5pcLaRmoJNdSOSYtKywkzGkWGxAOmGCxVhaUYwZibRImVMKsnCvhCgNMT3+F2A0ZDWPAFUZZ5hbArMjKt5YtpVvQ07MPLIGZVJAMecR1DkbgOiYJH3ML5kbGcELzTlQib2RSiPTET39Osx+p5KKcm0c8F0Zk4MBYPv58xyVuaAEiAcMjrkQGfMz/NggjHB8P6lEnCY+4gX8U0kDCx84UEHEbLyATfHzH3SrHvtYZqeb8PuoIrR6HTU75/Rc/FFh3rJMV9o+1cqAc/hR5nsqYtrn3q8Xud42JcoNCcBJs6FbvtbEOL0cecSddig9aQuHd5R11zwxucwPWgq1e7AhbngSTijk8vmkh00SqOZumOr5+ZpnNIZazsPhdVArBrFTzFNipcOJobgAyUHT8YIBlhXVsijrz6efJXz+9pdmcEahZWrGdRDjBRNmLGbiRVmoVMVnJc5dH/HagtBtINcD2U2GBj2citdA8sM9c4r6rwc7DWD8Ku+ARt0444F+ijnxlsn64EZ9pkwnHx5xHHG5FlpOIXx6+eLV/cHAAr+NX8fPp9Hl8EL95M9pfk/bHoOSZWOHmc2HxBk1FfM2mK2Z1BuzobFLdMX8bdOGYUGxyynbOPuxGLAGlHcreLYTDq7JiwqAkr3hixMxd8YjJIQyZYK2z9+2lZUo7tgLHrNOmPFNgpQTp1mqVrhjcSuvotRHKSjdkpzh+e1TLEk0jLsQNLuK8Oqlp4ZicsVzgMbAi91dbsOpWRkywG5HKpOrE7EIXaYKymYPCG4+3H+9UU4cmvUdzO5hdDzKdQMrHvKVza8dwuehoJerrciHjRaX0C2HZFECxubwBtbaEcsGPWErZtHcV1cb1rDqEhto/tCbm9MZlkWo/Wn3F/vQgfp68gMPZy+FwuLbQE52vygWWFxEXs6DLTL9QrfC1VHFaJLVS1dYftQqULQxYJuZCKuuYE1kOuLTa6msj51KJtBYCnb9sWuPfknhtcntl3rDIy4UmqeIy0ZWhaWvbQ5xc526iGrNOtU5BqE3y9A6iM68pYEzSqndCM+faSidvIF0xnTsS3JC9QxPW2xxu0UNIl66YFTJhSrMdbUh8iRFLxQTL8Yh0UW1klwTordyjVcILpFd8NBKbSUiTJgYI7sO/jRdCzfGgZw7MwC1gMBPo+idkfzK08oL8yXRFpx4sCjs+ZtJZSGdD9p9kGGg4O2aF8ivay0GR38m0aWiX3asWDKrI0OaXPdDC+x9f7v1P6vEINWqih67TrPWajCpeAdxumtJ2bkRagC2vTA8oauicdLXyX0N1zybqRiayEGnEMnGNO5aO3YCRMymmqb9O/voMcqP1bMguj0/H7BxS8sDeAVc7YB5F/Ik0AWKnzZmBGRhQsfd2QRDCGLHiEZcOMtsHKtpyCE4f/N3PaUi09X4KloATMrWPdtO+G494qj2OWPfKocmj9XhtyT8T1vQyDoM9eMPbvU8JBtlyg9JWl5Zpg16QbJX9SVj3KU/Qez1h0I6ezLTxBqmeLBXWsSIMfE//Gir9EAh8SJfJ08q4odMISdFCI6I3q9zpuRH5Qsbe1OuZRyqk5RFjTs/BLcCU/r0xDuHzpMI2uZE3aB5Qz6ViQmnqZ1fWQTZk7DwoAw1BtxzcQid23PCTtDOUdtn7ohtgXKlHa1wuVqkWpY0oBeSvmVfBv9AKOg/Pqm49TwOsbL65oKt+vKIDycDixf3+iPPw8DsjTpk8HXFetA3jU9GmbcJNvEzlCT1aMnfD4fC+13HNCFeEAavleTMchfijiFFfBWr++4uPPzMLRopUWm9U9cz7Pcvueg5+zIbDYcQ2qETPW69bPS+OjJPoMHtelarU8+r90v5IAW3EKi0Lzfwmf/FH61XivLT/oYm/PJervP2g3ex+yC6CRFpiSiR591kH80lbw3g2hZkmHLhyC/JndpNK7JQuUjBSP7cA36KzpEa0oDPpcJKZ0Zl3RuGYMQiZyTT10xAeWQqTWA+Kekznb6gXrN4vpn+O5Uf5/t3f355f/vXi/Zs+zNywSrNqMWg+aTvMD145otpPVzsqfStZT5Bk6taVBw1hrw7g9nrs2KP3+TY5ODzcf1Nt42B0MOrxHUtI08G10kvF/IC1rfCxi7fgJVAsYZ0HSGPELIEPyuR8QYQA3OZCYQRB3sQWea4NnmxzM6VfqMgEb9wEy6SSmUiZBZJt3Tt0YApisFaY1bAroLPvY2gmyoFRIk1XDdW39Z25AbMW71VQjM66vojeNnZ0fkD6cOuMiEnMxLGF8b2JBmlCHGnpdm7Y6feNEXv33Q8eKoSMIHUKlQUmD1K/1LM+U9rdTGkqfwckPGrrlggjlmYJR8HFCGZjoRCy+yOJmMzEHKLG7QUXd9dXuf5Hry+RyfgaVuNvL/9yPesT9THEoiDPyWQCyqGVMM/Qc/oB6YKIVQjCmL4BQw6BLI+3yoIp8GEbmeDgDBv9vZunbnSRPB4bsomXSYxmmmTSPmJbUzsEXX2UGIxaQJUedNQrJ6Cbak1BTpFXFm0VtJnlxTSVcTM4KuFhLoxb9SxKaTV4zMLi1roEoyYibQTdzyxDbthGLAdjNQIIVWRT9LGQCZkykSSBLh0EWQpmlcjtQjsv1qlUiUVRd/iQ7yPhYPqcxzdzMLkhCnUW6JjGRppyNKw8CJzIIhPn9DWo2oEWlpRqcsosWDRZaxbTq/aRfbxqy83EzOn50btL9m7y9qfTMbtoxZUmxLR2IXM2BbeEAAdE4RbaeLPXJpr83iuSBx1RExTEWsVglA2+h9IRKdwI5UgZSzYiEJxDdqatlRh1l37rqrGVK872EAhDCnPh4IqvCap2yr/DSKVkX5EqKnVp3b238SAaeJJG99CC/iCLiADul4umgwoB1s75u5NXh/uHu7iZOmh59AYORgcvBqP9wf7h5f5o/Hw0Ho3+vo7Ky3HLGxBWFhfGgEKSq3FZpVXPHF35UrvL47SaSffMRxpNTqSEeJuQ7+MpvRA6rmd2YqSn/D3vOuqlsCyFmWPTVKjrihBdhwLUe1kxQsRHVBjg8RI3m3jmFuVBPBAjiqt/2SEMdJqwWtD26myuONqOq2qyK96g3BorqJH1l2o7fXL/F8Lcly97wtwjZldZBg55jNJesD0f51bwqrw4DYTVkf2Q/QIU2tYa+CsmqkheaWlnPOwK3EVld3YEelypdlFCVbOaudgJZL5QHquaBvXfzZxG6NwrBjxiuU5lvEJ8gWwu0T5NGiPupPga0o86lFDZ2ebYh2z3wWi0zUNu85DbPOQ2D7nNQ27zkNs85DYPuc1DbvOQT81DVuj/AQy40QcdsT+ENOQfatPuo5RY5HS1uuFTwKuk3kKtgmohBPRwz+hlHd9TCsEWPrZ1mu3vbuJVSKMPdpkoEonoZnilrtSRlQnU3MgVt0WMRLI2V5zFOi0yFTUhfQ0fUJgyAdRGRKi+mPEJaNHvCrWFl3EU1SP6nwgesBEY+U2k8hskF4F7Ck/9w4Aw/xdzj71BWQUqsPCxtZXHk6EP4qez4GLSFR4JDX/FfcoHlRbihZKxSJkBYbWyzWMRlBK6aiyqFcp25/UBGF+DOeSa6xC335o/XoyvX7w56HV2Zx9KYxH4mTpwrW5ETRyQWnyHjGlzLtmdqodZmfSbmd9JqUySHi6lR+XZEi95LNK4QOeDwXrrBgzr8TDuscXUYiUuRflTqLOEHqf0XKnfKdHyOkDi4fVOyKFijmbXJ1N9HvUoz9OVT6yeCKVJh+U3708vUF8BW+dg2OTt5Tt2/u6EvX71+nDIENfUtRsBBISMdZsAgtsYcsds4a3YJIk6wmr+XQoAKyvu1+zKvwTvH/q9Jrgfy6qTnjPfufjxaLD/f8dSko6Vdh51bCHyHIg6mriGgZlcfGSvX4722afLEzxuz/TjMgNr/Q2zQpNOOPFQ6XjU2VNnqI9IRz3J/rw4fLEvDuAlvDp8+WY0Gu2/OBTT0XqW97zJnyEvlWRSUX6gAp1VpY/ztf3By6OylI7SL21TRNpdckcQs/bAnjxgqcaEB6l1ikajSc8QBsQFS2dZtQiqKDGQgP/zafr7OO2Nn68rkMfHBqy0CFnqFCMhiipQKrm/WOeyrGXoXLb2+i+eXr/QXGpfjP20tbKdJbBEIzGPRQBIswQE3mpVE6wBnu7ybenatnRtW7q2LV3blq5tS9e2pWvb0rVt6dq2dG1burYtXduWrm1L17ala9vStW3p2r9v6dpaRdp6occDnxEpmZlA6s2KNEV2wn/LAy06jvfC17S1h50KjKTygq6i/xhIT8f9JxXDNSkZMEabE50gEUO/TxvTr1XidTmUunetY1I5mNMqK8V6MRrd9wzfo5e1Lh73bDxkbdsS+qRqSnlNNIdPrBP89xJNGSWgGURYStN0ZOSrGgoj3Yo+MnOUyw+AP7/cR3f8GIQBc1S4BT3BXYs5fo2Gt702yuN20CpkHMSmSNKKOOfrDXIpB9oMLChfxxNqfXpa2hiUMFLzMd8fHvQ0KCzExDryTyeDk8HZ5GQwGYxGByQ3hxNo5T+ic42be3CtESfcgWtGEfR3WFt73Yv2sLlntZe6B+5pc4dyb3X7zh7xWLJAOPBcW1JGgUfG98JXh/ZqALXnLdReMIEDU1XgkpJ4KXWrLDIddIhHvDB4ngvncjve20sg0wORy6GcG6HcUOq9G7+bDkPjxDzkN/uGsf51z0hfagX1iUS6XqWa1uU3/kHU/5Wko2AifGnMmjs7mxBOR0OCcZIXvK/Qq6JjdGVfW+N8ZX6aqiAXq3jkbUmmfPVrZF/ZjtLOBw1YpesdWy5i2I0YDOfDzrBjFjr+sNKFQYkMrmH1x68EdJsX8o5P6a93pTN//8vl+t4UE+R0QsSxFqpEBMKDdaEot07hURdPobV6U2YhXrFE2MVUC4OFInOpIkoUdEMbH3u6FcuNvsG6kqoswMyFCmQvMp2KKrqEXZOH3zT7gQZGQYTCDIKS9K5Ox6FCcbRqaNzP689WvS3NZ0/5N6YCHixE7lbQNpJ+mypbf6OJp4N6eJ52tWY9SiizCl/y8hWJdalhqzav7tRTr/a5LgTj3WE71Vf48P5Ll7jdKKyQEKlSCBVl1+j+AKHbR59u4kV7mcRqvo3sW4+4+8ktvimj1MsX9Ufp7fB7Q4DKWzmqjXHcw2FVCJeaUUwzOFgLBzbj/HsqF57pEjMFpo+4F9QrT/D+R2WgawMr/1w/alv2uvEaPqk6sZ3//ud/7Xqq7GIJibQLz6nCbaDVuoE1C46tMipUy1BYKjBMZwOLPBzIuarMT9QsAY0xIa2cFCmRMYmcS4fcBZZYOQ/eNTLnuU58TZZGA4fMDSgxTX2soWDJUriBFA0aYjsCgGIqU7R2OIgonM58XU+sszyVgkJV9A6Bip4XgW2hfAmjyMDX8dE6M6RADSpZKmNQlm5g6dNyES+AHQxHazJfLpdDQa+H2sz3Ql+799Pk5O3PF28H2Oe+TlfX54CeMNFxgaaq9JUhcA7aOXw+3KdMobYuE6qxHv9lwwe/p9j1Tg1k/v/6pcbgOxzcur08FZLKQEikdwFJfS6/39gy0fSRxQCfOnjqS8QXCMXGn/ndHebZPpn0/h4f/6MAQwAbAZ0hffRwu0QtBMCkxRdJPxnSlNtOmcbfZRuKb9rb8iDzgc9G9qDfEz/bgIxL3WItlqp7HMVYrPVg2yZqPft4gdBlGr4vmVHcxI1YooTFko/5Fb8K/spD+Tv//I6nQs0LMcf2ftz7UGXUBofXBA7DD5Rw+UqtGqvs4kS/Gfwft9bb5Qe8Mx9g9cequX+zsUOFTX1rPJUv9/f3/wP/to2n
sidebar_class_name: "post api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create consent record and signature</h1>

<MethodEndpoint method={"post"} path={"/service/individual/record/consent-record"}></MethodEndpoint>



This endpoint is used to create a consent record and signature object. This returns the same objects with the PK defined.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecord</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A generic signature contains a cryptographic hash of some value,  together with a signature created by some private key in another system.  Required signing methods: Revision object or another Signature object.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent record and signature created successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A generic signature contains a cryptographic hash of some value,  together with a signature created by some private key in another system.  Required signing methods: Revision object or another Signature object.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecord\": {\n    \"id\": \"65471222e8c7c3bb3c2c9901\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n    \"individualId\": \"string\",\n    \"optIn\": true,\n    \"state\": \"signed\",\n    \"signatureId\": \"string\",\n    \"sectorPreferences\": [\n      {\n        \"sector\": \"\",\n        \"optIn\": true,\n        \"isLastUpdated\": true\n      }\n    ]\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  },\n  \"signature\": {\n    \"id\": \"65471222e8c7c3bb3c2c5501\",\n    \"payload\": \"{...}\",\n    \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n    \"verificationMethod\": \"Ed25519Signature2020\",\n    \"verificationPayload\": \"{...}\",\n    \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n    \"verificationArtifact\": \"\",\n    \"verificationSignedBy\": \"did:key:z6Mkf...\",\n    \"verificationSignedAs\": \"individual\",\n    \"verificationJwsHeader\": \"\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"signedWithoutObjectReference\": false,\n    \"objectType\": \"revision\",\n    \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create draft consent record
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-create-individual-consent-record-draft

---
id: service-create-individual-consent-record-draft
title: "Create draft consent record"
description: "This endpoint is used to create a draft (unsaved) consent record and signature object (without a PKI) for a data agreement."
sidebar_label: "Create draft consent record"
hide_title: true
hide_table_of_contents: true
api: eJzdWt1y3LixfpUu3liq4lA/trzZqa3kSJadjHezq0hy9lRWqjKG7BlixQEYABxpopq78yTn0fIkqW6Av0PZ8sZVqcpeeEckAXQ3ur/+uoHHKEObGlk6qVU0ja5zaQFVVmqpHEgLlcUMnIbUoHAIAjIjFg72KmXFGrN9SLWyqBwYTLXJQKgMrFwq4SqDoOe/Yupg7166XFcOBFx8P9uHhTY0k3ACxNIgrlC5JIojXaIRJMksi6aRRbOWKb7hlWcqk2uZVaJ44xe85PXOSZoojkphxAodGhtNf3kcKHWqakFIDpidg2xmm2VRHEn66u8Vmk0UR0qsMJpGg08M/r2SBrNo6kyFcWTTHFcimj5GblPS99YZqZbRdht/fnnS/LRW/EkJdr/6qkIYXEvrbT2+fu+DdumFKOzn1ubpchQZmna+/52ErTs7m8x+o3XjgVrtPDA7j7a3NJUtaRlLo48PD+l/qVYOlaOfoiwLmbKTHfxqaY7HzmqlIRd00o9Ou57WEcYbMoojJ11BD3ouGQ1lPB3GCD6UBq1F27zYExYyXEiFGUgFjqJwXskik2oJ80Kndy8s2BJTuQjC71NQCrBSLQuE866rJHCdo0FYVdbBnGL2w4+zv3x4y6s5IyiytYK9fvw1/hB3omM/iqOHidJuItWEvp8Li40LtLv2SyRJ72ayyzDXn4TNoziyTjiMbuOBfWW2u8NxtNBmJVw0jaI4wgexKtnEr09efXN0fHyMv0u/SV/O5y/T4/Tbbw+Pdqz9E2+OhZXYkPKlsIRgc5HewXwDVq8QTi9mDcZZaLBJUVTsXXy/H0OGSjuyvcuFA5fjBoQhS95EjH83UQwywQQE9Pbefy8tKO1ggw6s06beU4TagoySWhUbwAdpHb82QlnpEmBE689qIdM8Yy7WJMRls1PzyoFcQCloG6AqfXALuKoROAYBa1HIrBkENtdVkZFtlqgIbzFLOLAGcDOyNQ+Txd1kpTMsomnU87mdbbjOB15J/nqfyzRvnD4XFuaICpZyjWpHhMsWfj4nSv3pqBSN4nrRbELH7T8lEzj9pFjs2s92X3E0P05fZq/wZPE6SZIdQd/oclMLWAciCZNzMPMvcit6LVVaVFnrVG22Ja9CZSuDFsRSSGUdOLEqkUTzrkEDtJFLqUTRzb3buJ/wPmfxFndHbd6B5ftcs1VJTKISBG19PKTFdelmqrPqXOsChXrKnj5LDNY1FU7ZWq0mvHKprXRyjcUGdOnYcAm8Iwgb/RwfKENIV2zACpmB0rCnDZsvM+JegYCStkhXjSL7bECPcs92CW+QUfPxTLCQWGRdDhbSh3+b5kItaaMXDs3E5ThZiNQlMGP8WRHKC84n8w3vekAUODsD6SwWiwT+ysDA09kpVMpLdFCi4ryz0qbjXfagERhVtSLMr0cQwvsft1v/k0c8w40anBpJmq1fM6hSCJC6RcHqrEVRoa1DZoSEdnxOutb577CJs5lay0xWoohhJe5IY+lgjUYupJgXPpx8+ExKo/Uigeuz8ylcYsEZ2CfgRgPwLOIP7AmYOm0uDC7QoEp9tguGEMYIIlnS4cqOkYq+HULSRx/7JU9JWO+XgAydkIV9dpr2w6I4KrTnEbtZOXzybD/eEflHscLaxmGyT0Z4f/Q50yBbKyhtE7SgDWVBxir7g7DuQ5lR9vqCSQd+QnUIA1K7WCGsgypMvOX/Oi79KRL4KV/mTCvTjk8TJSWEBgGp2ZROL40oc5l6qNcLz1TYy2MAp5focjR1fu/Mw9VR1nCb0sg1wQP5uVQglOZxdmMdrhKAy+AMPAVHObpcZ3bayZO+TqAaLYy+GhR0yY16tseVYlNoUWNEbSAfZt4F/8wSDB5eNMNGngZa2X1zxaF+tuENWaGlwP36jPPk5CszTpl9OeO86gPjl7JN26WbFEz1Dj3bMo9JkmxHE9eCeUWYsBHPw3Ac6o8qJX8V5Pnvr376ESwaKQppPajqhc97Fh5HNn4KSZLE8IRLjLz1vjXy4tQ4SQlz5FXtSiOv3t/bP3FVG0PjZeEzr+TPfmu9S1zW+B8+8cFzvSn7D/qfbRO4ChbpmSmTnN0XA84nbUvjYY4LzTxw43LOZ/Ypl9irUyR1ZPZjeum/GIjUqRb0SjpaZGH0yiejsM1UhCxkUfhlmI/cC5NZT4pGoPMz7oWb9/n8j6n8Sb5/97e3l9d/uXr/7Rhn7qDSohGG4JPVAT95k4jaPN1oVOdWRk+UDHW7zkNAOOoDpN4Ijj1bz7fZ8cnJ0beNGseHx4cjueMei2Jyp/S9Aj9hixW+dvEIXhPFmtZ5gjQlzkI1BHFCucy5IYAPpVBUQXA2sVVZakM721WmzgtNM8GDm4CVVHIlCrDItm1HhwGgMEVrhdkkQwNdfB2gmSmHRomi2HRc37Yxs0azU+81VIz3ug1Ej40Dn5+wPzw4I1I2M/c0w/weolGaUEdajs4nNP26NeKo3uPkoWHIRFLn2CAwZ5D2pV6MQelQmRoq/w1KeNr3LRFmrGGJZiFhBNhUKKLsfktikCuxxLgTvejSoXxN6n+2fJnMpne4mf7j9Z/vFmOmPsNUVJw5QWaoHKGEeUGZ00/IASI2oQgDvUbDCYGRx6OyAIW+bGMIDsmwM96neR7GgeT5WAIzb5OUYJpt0t9i27Z2mLr6KjGAWmCVnnS0kjPRLbTmIqcqG0TbBG+GspoXMu0WRzU9LIVxmxGhlFaT5wiW9uQSwJ+IolN0v7BADWIbQ4nGaiIQqlrNKcfiSsgCRJaFdukk2FKAVaK0uXberHOpMkumHvRDvo6FA/Q5z2+WaErDLdRFaMd0FOna0UC9EbSQpU6c03eo2gRaWXaq2TlYtARZO4jpXfvUPt+15dONmfPL03fX8G729ofzKVz16koTalqbyxLm6O4x0AFRuVwbD3v9RpPXvWnyUCLqkoJUqxSNsiH3SEtr4Foox85YdyNCgzOBC22tpKq7zls3HVVuIjggIowFLoXDm2jHUG1S/jdAqmB8pVZR7Uu76b3PBwng2RrDTQv+Q11EInA/X3UTVH0qdvnuzTcnRyf7pExbtDxbgePD41eTw6PJ0cn10eH05eH08PBvu6y8nreOgCBZWhmDippcnWCVVr1wHPK1d9fbaTVI98JXGt2eSE3xnmK+z2/phdJx93gnpfaUj/Nhor4XFgpcOJgXQt01DdFdKsCj75uOEPcjGg7wfIubp/rMvZYH94GAW1zjYocy0GnmasHbm725iQg7bprFbqJOy60jQcusbxt1xuz+G8rc169HytxTsJvVCh31MWq8gANf5zb0qg6cDsMa2D6Bn5FL29YDf6WDKrZXUeOMp12hd9Hgzp6gjCvVPlmo+aztXOyFZr5QnquaTutfDJo/MSX3pgMeQ6kLmW6IX1A3l9s+/U4PPxogKp/VDJpKdUfGVikR4UVVFNSV8KehhOQ0zyt/MNmfbi6ogiorDkF/nD0y8OiLTjS7rRg0Rps3OqMGDP8+7yx/O9R32DtpR7e+JZXDJUvZONSrw8PtyPQj/tj64NmI4qH11rfQBxUS0j+469w3zckXHvb+d5mmrg4I/oiO8jIDG/nWdGWk2/A1idNSfo/085YO7c9QGDSnlcv5CWktlnSfIupna7LHKtS6Uamtv39Bo6KDcGfjoM3dBz4sDkKUTMKfWbi44aUdu7VxjisdlIniqDJ0XpA7V9rpwUGGKz0RpUzk0gjlEqkP1sfR7q2HKyeWDCnj01j/emSm29ZSV+Qwfp9re7XNfP8gHr/wcBp81Tfad/D0YsZEkTyaiLr3U3/e15RnhKUfe/N8BL9Mc7xPZwLyoa7mP3oZ4SPsKe08a6Uzf4+spUhxPwZMlslg2imEgd9tdGXIIpM73Pz+IzOtrmc8RnP+612dTd7/fL2rmwLB6Bco7w5XjpkFBjfnMqs9hOMhvofTG82t7XQDmbD5XAuTQaGXUsXcqR5ya1/8uA2URq8l2SvMos1SqNBtpFab4vMhYXfs4ZWG73hiMkS4lsJcht9FDS6QQ9HNl4gKvBqEQsnMRQwFt++U/E/jaJ27Rn9sH/U9tP14J+CbQbD3z//7/31fc17dYyZt7psT+BDq0yFDhRCmjXH42LCyfOxSLCaWClqUS9WYMe4ejKUG+bEouKrJ5FI6KgJEUaDz3RJNLahSZ+AwzZWmjaISCJWYFz5pK7yHAtdY0MYQWDKiirksaNdoElE5TbWyWkKqV2UhBXM+8vLQ01lWoWzhxiNwqgVRZdKxnCvqJRjauEKmqCzDcx2bpUhzhOPkcMfm9/f3ieDXiTbLgzDWHvwwe/P2x6u3Exqzbc992n2giM50WhGhqGM+MNBA15OXyRG33LV1K6E68vhbbuF23eB8fLDznRT3H76vF7zf4YM7KAsh+RIHG/MxZIRf6lt8UdwvTRvV+nmBdOXMcBtHOaWW6S/R4yO1rD+YYrulx/6WGucLaWmfs/HioWumvfrYax8+exlwVKk7gv3hnUBGaeLTnHi+jjC7l/4+Ic/ux79RpM/cDvyECL3v2tVv6Q/DcOHpRZ0cf/O+9W/6fVKmT1w07NnHf32apli6zrsd1rjtEp6Ln64o34mQDFsicMdEIPwgNetXatOZfMgJvAz0L0k0OuQ7wpXvcfP75nP/5skBDQ+pvTba3m63238BhiFdCw==
sidebar_class_name: "post api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create draft consent record</h1>

<MethodEndpoint method={"post"} path={"/service/individual/record/consent-record/draft"}></MethodEndpoint>



This endpoint is used to create a draft (unsaved) consent record and signature object (without a PKI) for a data agreement.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with ID individualId","in":"query","name":"individualId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"An object with ID dataAgreementId","in":"query","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Draft consent record created successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A generic signature contains a cryptographic hash of some value,  together with a signature created by some private key in another system.  Required signing methods: Revision object or another Signature object.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecord\": {\n    \"id\": \"65471222e8c7c3bb3c2c9901\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n    \"individualId\": \"string\",\n    \"optIn\": true,\n    \"state\": \"signed\",\n    \"signatureId\": \"string\",\n    \"sectorPreferences\": [\n      {\n        \"sector\": \"\",\n        \"optIn\": true,\n        \"isLastUpdated\": true\n      }\n    ]\n  },\n  \"signature\": {\n    \"id\": \"65471222e8c7c3bb3c2c5501\",\n    \"payload\": \"{...}\",\n    \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n    \"verificationMethod\": \"Ed25519Signature2020\",\n    \"verificationPayload\": \"{...}\",\n    \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n    \"verificationArtifact\": \"\",\n    \"verificationSignedBy\": \"did:key:z6Mkf...\",\n    \"verificationSignedAs\": \"individual\",\n    \"verificationJwsHeader\": \"\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"signedWithoutObjectReference\": false,\n    \"objectType\": \"revision\",\n    \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Creates blank signature
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-create-individual-consent-record-signature

---
id: service-create-individual-consent-record-signature
title: "Creates blank signature"
description: "This endpoint is used to create a blank signature object for the consent record for an individual in an organiation defined in the consent building block. Creates and returns a blank Signature object for the consent record."
sidebar_label: "Creates blank signature"
hide_title: true
hide_table_of_contents: true
api: eJzlWdty3DYS/ZUuvFiq4nAk2XKSqVRqJctORrlYKynrrViqMoZsDhGRAAOAIzGqedsv2U/bL9lqALzMDLWrZPO0ebFHJNHoy8HpCx5ZiibRorJCSTZj17kwgDKtlJAWhIHaYApWQaKRWwQOi4LLOzBiKbmtNYJa/IyJhUxpsDlCoqRBaUFjonTqHnMJQqZiJdKaFyAkPVB6yaXgtCukmAmJKb0ZSljUokiFXMKiUMldDG+cBga4TEGjrbU0nTpXz1MnZhFTFWq37zxlM2ZQr0SCXva80/KNX3bpVnXCWcQqrnmJFrVhs4+PW877UYpfaoT5GajMGel0YRET9LbiNmcRk7xENmPJcId5yiKm8ZdaaEzZzOoaI2aSHEvOZo/MNhUtMVYLuWTrdfToJebIU9S9zL9Pgt6np5Pelt8mPNqyqZcD8zO2viVRpqJtDK0+Ojig/xIlLUpLP3lVFSJxHp7+bEjG42C3SpP/rfCrOxQNFOmcZoUt6MHQ/Zu6ncASJWqRDOBImnDhoJHoprJqqXmViwRybnKKi1ElwooXNUYAVi3R5qjhXtgc+FCOQ0QKi8avqLRY0QG4w8ZDWLl1pjEWyxjgMjjYiSDUlmhzlZoZXOJKGMJ5gKY7EX71NmzjG8ki9jCRyk6EnKTc8gU3yGYZLwwOo/iRVbwpFKfYmoGDVqhFFtz/vdNg6+FFt2zk6Tfc5FtvSEVMTxsXkBKN5WXFbqOtQIp0F0oRy5QuuWUzxiKGD7ysXDxfH7/67PDo6Ag/Tz5LXi4WL5Oj5Pj44HAnvO+dTwyUvIEFQsUNcdGCJ3ddVE4u5h1bGRdEVVtHOCnsXXy7H0GKUlmKh825JUpogGvisRuWap7ZGxaBiDEGPoiG+1YYkMpCgxaMVbonqDYsjomULBrAB2Gsce81l0bYmA5SG6Fne+YxjuP1jhuuc4RMSF5AENipZ1xsIkdyVtcJ4ZUT8s+v3v8ABrXghTCeZFUGmcAiNfA4EvgZxHEcwROQGHnrsTXy4kRbkfHEjrxqoTTy6vzefOPILIIOZeEzb+QHH1oPiUvMUKNMMHziD891U20+2PxsHcNV8MiGm1KR2BjmmQttf/6F8eTiSQAzRaCRjc0JS+T7cUjsESZyJ93Bz+bov9hSCUyu6oIkgyqFpU0yrUr3aRvmRW0hE0Xht+GZRX3PdWocuMao87/AC5vzfPF1It6L83c/vb28/uvV+RdxHO8AbsBKWacM0aczB7xwerfpsd4iU2EiMuHZE4Wjul3wEBGOYoDMG+GxZ9v5Nj06Pj78ojPj6ODoYCR33GNRTO6kupfgBfZccZ+LJA8M3hZBMfyNFyL1qcPM4Pr0LAZXLpVimVuyGx8qLlNMfTYxdVUpTZEdGtPmBVqLGlty41AKKUpegEHn2351WAASEzSG6ybedtDFH0M0c2lRS14UzQD6pj8zK9QmUEmLedAtoF2s+4PouXEL8xOHhwereeLcTN+08j1Fo9BeLjfudD5hqctTz7aWHy6OkpfpKzzOXo/hfdTu8eKB7HYAoJJ4gR0DuwzSv1TZGJVuG9NS5fMtGUHxBrZ4kNjSEklxtSiYhEuqsX1IIhAlX2I0OL1ok239utT/bP1Skc7usJn9+vr7u2zM1aeY8NplThApSkssoV9Q5vQC3QHhDSQ5l0sEtULtEoJjHs/KHCT6lsRRcEiGg/U+zbtl7iD5eiyGeWgviKadTzZD3LmC9hLGZ8uW1EJV6YuOXnPXZhRK3RF666pjtCagGap6UYjEFY0DvqS3Fde2GVFKKjl5jmLJhl4c3CeuvWrr9RcGqC8wEVSojaICQtblgnIsllwUwNNUozFoYBJ8ycFIXplcWe/WhZCpIVdvMv0f5OFAfdbXN0vUlaamMzhqw5ChHzW0gaCNTAQcrLpD2SfQ2jhQzc/AoCHK2mFMD+0T83xo9+rsgPrs8uTdNbybv/3ubAZXIfcZp4nGwu1nclHBAu09hnKA1zZX2tPewLEyDbaHlssnomFRkCiZoJYm5B5haA9ccel73tAAgu8rTQwXyhixKLDLWzcDU24YTKkQxgKX3OIN23FUn5T/B5IqHL9ascIWS7vpfbMeJIJ33tgOWsDPkmRxOP9wNUxQocHau3z35rPjw+N9MqZvWp5twNHB0avJweHk8Pj68GD28mB2cPDTblXeym1PQNAsqbVGaYtmeFiFkS+sO/ItuttwGgXCvvCdBklDPam0Ullb4j1V+Q6sWShVIJdPmRNax92uPnHTFHfOtxP1PTdQYGbDdCVkk5FSwK2mr72upHVfAzzf4zq0yDte/oF7inHbuyEClCrFYlzt0AZa5Wq1gPYuNjeMuOOm2+zG6SDrkrrpgQZ9ZX3bmTPm99/R5r5+PdLmnoBpyhItzTFavoCp73O78qo9OIMKa8v3MXxA19r2CPy5Ntb7q2h5xpddYXbR8c4ep4wr5D55qPusn1zseR5KuPS1qu5GGo7lN2ZsESV3vtSIJUobQaUKkTRUX+zHbL1e05ncmPS4R5suebM5RNydypg6oWI4q4uCJhN+EEZsTrJe+ZnUpsgFpy6qqt0x9CO8kYWHv2mYNRzHoNZKv1EpDWHc77PB9rfbNm/PT/rVPb6EtLh0WnagenVwsB4RP4LJHoenI4av1yNO/1GGpPQrpiOuefUnds0lGlXrBB1NZ6qWuw46/o2D0P8vB7UtFOUIqtndNls+ooyGSa2Fbdzs/KQS3yL9vKWB9ilyjfqktrl7QlbzJQ3Z2WZJQ/4ow0CAVco4f9BkfcamYZg/7QucqWeQaaCoSfjzcWv6vp4OZ6jehrEB/xmWKpjIIlbrgobw1lZmNp2mWKoJr0QslppLGws1XR0xMm1rumL50rHxuBjjX49Iuu39d0Uw8tFvvdiFkfsH0fgVwUk44g6Wu6noYu5qbCIC6nE8et2oou9sKQ192pDzCfw2UFLCoVGtxkw8tIOQT15H+AR7Ullf8FvNhU9KFU9wPwKMl/GW2BmEhV82qtbkkckdNl99ckXqEC+PbOH+etcm4vMP17u2SeAuaYRuYafNiFwBHcC/dWnllvjx18ZqdyuQNJByky8U1ykUailk5Ib8222J7xttA5VWK0H+ClL8ZZgJzr5CmYKwNALZ9oc3Gr50gskR4SLHlYHuHevYggBFd0WMeuOWmsK0wfV/dOT9kOkvHdB6oIiv+0ebCO0/3qGBbhHs/esf/9z37frVPabC5H6ugw+htd8u7iEc3s45McwtdXIGDBbZxNAsAMVSdm5sOwZO3U2i0T3mhWsIU7EUlvonXhRo/aBJ0fSuUilYTHKpKFDUPaLki8LXOxLvocAVFhQYolDHs3whCooaCeG1VTRmkEtIVFkVgrtymVAexmHLOnR8bmYLrkIBXqfCOj1LGsNoClwhEpTGkXZ7Niue5AhH8cGOz+/v72PuXsdKL6dhrZl+N3/z9oertxNas+6vzPo40IlOVVJTLdae+VC8h04nfhkfutsKZWzJ5UCf9sJ168Z3+2QNkt6f4Po4nC6LD3ZaFVxI8p0L1mPIQx/bS2XHwYOpgRfCIraZjVjEZru3wYMuJGI55bnZR/b4SJcMP+pivabHv9SoXQKN2IprdxB80hKGfqfjzd8wXnvtteU+PHl5PWpxm2wkZRqXGnz/c0e5aOdye02dVEhFv1vBzZvoJ/Ty+/+Hi/BOV8rM/uuTJMHKDt7tVG7rYdFx8f6KsgsPqadPu3cu7YYfZOaok7YzsNeB/iWNRpd8Saf4W2y+6j73b55c0GV9/zW55na9Xv8bM1noNA==
sidebar_class_name: "post api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Creates blank signature</h1>

<MethodEndpoint method={"post"} path={"/service/individual/record/consent-record/{consentRecordId}/signature"}></MethodEndpoint>



This endpoint is used to create a blank signature object for the consent record for an individual in an organiation defined in the consent building block. Creates and returns a blank Signature object for the consent record.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"consentRecordId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent record signature created successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A generic signature contains a cryptographic hash of some value,  together with a signature created by some private key in another system.  Required signing methods: Revision object or another Signature object.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"signature\": {\n    \"id\": \"65471222e8c7c3bb3c2c5501\",\n    \"payload\": \"{...}\",\n    \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n    \"verificationMethod\": \"Ed25519Signature2020\",\n    \"verificationPayload\": \"{...}\",\n    \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n    \"verificationArtifact\": \"\",\n    \"verificationSignedBy\": \"did:key:z6Mkf...\",\n    \"verificationSignedAs\": \"individual\",\n    \"verificationJwsHeader\": \"\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"signedWithoutObjectReference\": false,\n    \"objectType\": \"revision\",\n    \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create consent record
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-create-individual-consent-record

---
id: service-create-individual-consent-record
title: "Create consent record"
description: "This endpoint is used to create a consent record when an individial records their consent (e.g. in the privacy dashboard) against a data agreement."
sidebar_label: "Create consent record"
hide_title: true
hide_table_of_contents: true
api: eJzdWtty3MYR/ZUuvJh0YcElReqy5XLCixyv5ZIUkYpTEVmlXqB3MSYwA80Mdrlm7Vu+JJ+WL0n1DG6LhSTSzkMqeqBAYC493ae7T/fwPkjIxFoUVigZTIKrVBggmRRKSAvCQGkoAasg1oSWACFW0pC0oClWOoFVShJQgpCJWIpEYFZ9MWBTEroZv0fRIgIh+TUUWiwxXkOCJp0p1Mk+4AKFNBYQErQIuNBEOUkbBWGgCtLIEk6TYBIY0ksR07mTaOr3LTE79xu9c7sHYVCgxpwsaRNMPtz3zvleik8lwfQC1JzFV7NfKbZBGAj+WqBNgzCQmFMwCVie01qcKS+t6VMpNCXBxOqSwsDEKeUYTO4Duy54irFayEWw2YT9jU/rvWAlbMoCaFoK489Wbf+pJL1u998a0G49x8x8bW+3XEqYkG7X+/uoUtXZ2ahV3+MOFvaO1a4D04tgc8NLmYK3MTz7aDzm/2IlLUnLj1gUmYidUQ9+NbzGfWe3QrPJrfCz4y3LtsI0RrPCZvyiD4Ge6vvYpbtCkzFkWpCigYTmQlLioSoMzEqRJUIuYJap+PYbA6agWMwr4ffZORCMkIuM4KILlQiuUtIEeWkszNh33r+e/vX9S7eb1cgepiTsbeO9wUNY+1SJ2X4QBncjqexIyBGPn6GhBgKt1T4Egs/dLPauWutHNAxoY9FScBP29CuSXQuHwVzpHG0wCYIwoDvMC6fipyfHzw6Pjo7oefwsfjKbPYmP4hcvxoc72n7jjGMgxzUfvkDDkWSG8S3M1mBUTnD6dtrEGuP8QZWWvXF6AXtvX+2HkJBUlnVvU7QcOdaAmjV5HSQa5/Y6CEFEFAHClu39eGFAKgtrsmCs0rVNCWoNAsoElMzWQHfCWPdZozTCRnDB62+vaiBRbsUUlyzEu8ZSs9KCmEOBbAYoC+/cCJdiIdGWmkJAWGImkmYSmFSVWcK6WZDk+EZJ5ByrF24GTHM3mt+OcpVQFkyCLcztmOEq7aGS8bpKRZw2oE/RwIxIwkIsSe6I8K4NP18TpR46KEVzcDVvjNCB/ZdkAqs+K5aD9oPhi4ezo/hJckwn86dRFO0Ieq6KdS1g7YgsTOqc2T0xrPizkHFWJi2oTG1rhyqSptRkmrRmMS+IRfPQ4AlKi4WQmHVz3YZTQCckf03jbdwd1HknLK9S5bTKYnJK59C2HQ95c1XYqezsOlMqI5Sf06fPEr19dUkTp632JG7nQhlhxZKyNajCOsVF8AOHsMHhdMcZQthsDQZFAlLBntJOfYnGlQSEgk2kyuYg+06BPso9GBJeIYPqcyvBXFCWdLlQlT781zhFuWBDzy3pkU1pNMfYRjB18SfnKI8un8zWzupVRIGzMxDWUDaP4G8uMLjlzARK6SU6KEi6vJMr3UGXOWgEJlnmHPPrGRzh/cPNxj+6GQ+AUROnBpJmi2sXVNkF+LhZ5o6zxKwkU7tML8GyI3QwJ2wL/ltq/GwqmTiWmIWQ4y2fWFhYkhZzgbPMu5N3n1GhlZpHcHV2MYF3lLkM7BNwcwLwLOJPDgkUW6XfapqTJhn7bFcpArVGJlnCUm6GSMW2HqqkT6bir7wkx3q/BSRkUWTmwWnaTwvCIFOeR+xm5WrIg3G8I/JrzKnWcbXYFz18e/aFo0GmPqAwjdOC0pwFXawyP6Ox74uEs9cjFu3hZK60D0jtZhkaC2W18Mb9Cxsm/CUO+NkcdArfukQr4m/b0O4cAGIsnGtVqtICM8G+XvFV44uEdQUtpoCe7mm14rwgTJUTJJjSk3ur4HAfYr0urFpoLFIR9xLE0T5gmQhmN9G1vJanRiQEc61yJ8V1YMo4JmOUvg4gVlmZSyYRepc+sDJFQoxGZqhMIx7FFv2pGC1cajn5XTHgH5k88CDS4jfMxG+UXEosTKps9da/rBimFTkZdtb/Pst8+nSAZTakgquOraM8eK/ki/zpbZVisjWbxC1/HTi+50BLcSpF7IpeNEqarlkwyyhpZrFQ10Enavf3LVQmYo5IPZrjUjMH9MY0f0iNz49fHA0mu7ev6mBRFagu3K84fDceEWy2YPFgQe6jKNoM7trdS/S38nnjF18YvNk9/lfYSQX43Uo15kzr96yV6g6a0dzCLEN5y2FuAPK+3RFjFpecfOQCtj0gatfjuseUM0OfSpJMYmbMJBwkhPQ8ZcCl/qBGa3egxNPrPY5iaOCnyzev9/kBIRHMTk6LIlu713COUjkMi998Pr1kvBKPLkjD9OXVD/Duh3N4/uz5SQTMazgsMqttSIBjSA0J8HgHuoupsGBKH8WmSdhTVvf3WgHRtaxV04krv4vef+l5R3G8Dcs/ZPO9yx9PR4f7LFcb3h4s0tH46Hg0PhwdnlwdjidPxpPx+B+7nlCvyzI4jNVxnjGWYlGQpMSRyjbATC/fwPOn40N4f3XO5iZg8VhMLG2qNB/ibD3tlRNf6tuEu22e7lJvbEr6UfHn+OT4EI/oKT07efpiPB4fHp/gbDwewG3F0ByZk4BJLiTzbd2QzqoDWVUuDRNgsNSJ0ov2uYq0L3JPEfPthX3zADIlF04IgoyDRrc94zggCyysgUYIlqjQlJD/9XH4fRh64ye7APL8WJMRhikLoLaCCxHPKJpCyROuEGJVCEr8x56zbcvfVgYPPkRX1KEa+3Gywt6KIFHyGwu3Uq24zVIx8K1Rq7bM8PR0P/CccZsnulf9kn+Li9Ywqww6L7OMk7JvojKR4RWOfT9ze6EZcmgvSgtN63lg4uGjGqFdskZaK32uEqZp7vmis/1N/6R9+tXObg0ppKWFk7Kx3vF4vBlYfsD4rcHPBg5eMfZ+170NJzuqOXlkj/j/SzVTaUlzM4hvN0iD26anI1/RllrYtbvSOC3EK+LHG+71nxFq0qelTd0bPjUu+O6jQXjNJcMgJ5sqvksplHH64AuPSXBQXa0ctK2YA+8WB0wnRk2j6uC+16Xc+GJgOXzbckG5qg4WhEGpOTKn1hZmcnCQUK5GWIhILDRKGwl1sDwKdi9OLi0uKsI1tIzxnwdWumm15pmNs3mtu7Yf4F+Ew3cmpxVufa2+U1q+nbqGBqObpK0w61uGrkFSU6OPW+t8BL9Nc0PAbQVxR4lvk3z0MsJH2JOKs3tK3J4WmVNDgTHth+Bu1baXnUA18bu1KjVrZHRL6+8/OtLZRcl9MHO//VCH8Z9+udo9mwR0kRCsuqWme9siJHSVUAX5zlUgcwo3JfSSd2fv3P9BphZChhy7sRralMIiYZ3aNRRaLbnQbeoUvUApTKXsS5KuxYRmRx/+0PCdW5gVUVWKLuW6by0/YEDx5Vkg5FzVAQljF5AoR8GgM2VRKG3/3ACtBYr4S/tqG6Ht4B3nbybB3r//+a995h4IlytKhEk9kac732d0rQPfG/Mgg8plG+U4klga17nJ5iOjlqRJLGSjxrDbW4s500srMDOhKw4WwnKzmGtX6zYzipuThUp8savYUGRCIIkzh0QESSvIaEkZG4YDp4uuOBMZW40XwdKq3BdMscqLTCBzPYdydzxNi9J38wxXXggu7foGiZMzRylJs+EyEZM0LlTXvllgnBIcReMdna9Wqwjd50jpxUE11xz8PD1/+fry5YjnbNreUWsH9uhExSVHt9rnObh5ezGnj55Eh44rKWNzlB15/MV0v7nes3kn0f2PXrpX/mDpzh4UGQrHtZ1676t88aG+ig+6txbuGrk+8lbWCMJg0r/dugmDlHPQ5ENwf899qvc622z4tb8Fd8lEGAZBMlzRdzX5ldv1wSPdchrYvmR3MZtpLSePJWrnK48UZe9dxU/24bN/bDAoT52P5LorSS1nX38b7gxV2ep3C/iZKnBIT1/444FWa+F9Nfo05h5A59sOpdt02cjbN5ecgLDKTm1mvnWZuXrgYw4qqZ+kvQz8kyUanPIdO/orWn/fDPdfPjuhIQZ+NKvmZrPZ/AdH0z8r
sidebar_class_name: "post api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create consent record</h1>

<MethodEndpoint method={"post"} path={"/service/individual/record/data-agreement/{dataAgreementId}"}></MethodEndpoint>



This endpoint is used to create a consent record when an individial records their consent (e.g. in the privacy dashboard) against a data agreement.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent record created successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecord\": {\n    \"id\": \"65471222e8c7c3bb3c2c9901\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n    \"individualId\": \"string\",\n    \"optIn\": true,\n    \"state\": \"signed\",\n    \"signatureId\": \"string\",\n    \"sectorPreferences\": [\n      {\n        \"sector\": \"\",\n        \"optIn\": true,\n        \"isLastUpdated\": true\n      }\n    ]\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete all consent records
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-delete-all-records

---
id: service-delete-all-records
title: "Delete all consent records"
description: "This endpoint is used to delete all consent records for an individual belonging to an organiation defined in the consent building block. This could be used, for example to exercise digital rights (Right to be forgotten) and deletes all consent records that shall not be retained and have a 'forgettable' data agreement. This may also delete an unsigned consent record, for instance in cases where the user exits the signing process."
sidebar_label: "Delete all consent records"
hide_title: true
hide_table_of_contents: true
api: eJztVttuGzcQ/ZUBn2xgLTlu+iIEQe3YLdQERREnaIHEgEfL0S5jLrkhZyWrgt76Jf20fkkx5OpqOe9FqwdpteTczlzOLJWmWAbTsvFOjdSH2kQgp1tvHIOJ0EXSwB40WWICtBZK7yI5hkClDzrC1AdAB8ZpMzO6QwsTst5VxlUiiQ58qNAZFBugaWocaTAOuKaNsklnrBaJifXlwwCSI6XvrIYJJS+KZIgesWktiWJ6pFCaSKBNZRgtBFPVHOHkvfzKjQmJTOWZyZ0COt2HEY/GwTUyxFqOnGcRDsSYnBXRGmcECJ+VqCRmnFj6rEAjI2AViBpy3Dve4ALQxi1sDjoXTSW69s3mqIyLjK4kQaXESBHmNQVKCHWRJGzDMf0VLYJTG3xJMQ5UoXxLIYE71mqkIoWZKek6Wb609n0OTxWqxYANMYWoRp+WykjCa0JNQRXKYUNqpH4/e5P9u7o6G28yOtaqUIG+diaQViMOHRUqljU1qEZLxYtWZCMH4yq1Kg6KaqsHxtdqdSeqYitmokhfnJ/Lz77M5TOFtlNlGVsNsSsFiWln7UIVfUSiebUq1Mtjyico9dd2DBtIjgi+EMHSOybH8ohta02ZgB5+iaJouYPBFp1PikLw4Y3XpIr8fL1j/q5Y4+UnX6hkSUyQFLLJeGylt9Aax1QlL/sGUKOX5+erI+qfpGNHRF0dCXwln8OUfXTYce2D+YP0E2i+z5j+R6EZO6bg0II0mrSmmDnAaFWoSGUXDC9Sq1225i3J492qWKorwkDhsuM6vZGosZKeVH3vQe5ZwaMhrr20da721MUip4Z9nw+3HTHMjaIKlV3Lbb7v/TU1vvdcFaoLVmYAcxtHw6Gmxp9hawamCuh4YPxwdqHE430dt4xpuD+jJubjI5rutrDcSnXkpK7B2WQH84vi+IS67AszVZs6zM7lr2N4oAVI+ZLjvihlLBPM0HYEfprm6P2ennvIZqDpYhr9baCpeSQNc8M13Gcf4R5OnOc8lzmgsQmGFks6LYAG1eBA7Qh6wVcL3wVB5OyBFq/vBzIkd8tgqSbp348+NMhqpH7+7cPT2BxgGnXA/oHcOpJtAexT5D4nJ5Eie74r3QYzw3IBGmM98Rg0WF8ZV4Cwen91GnyTTWnBlBfCPjMjePVaMsPHHuxbchoMA8YneOSg4VVSLED0PCKZzRCozRCQglLSS8ZN/XriYJkmDjVopOhi17Y+8A+bQtsWivlp+2q/QreXn3T3RghO/v7zr1NZgRBu56RNrDPX02NZo6soLQUzCmbaFxn0HbkBZwBjFvqOEMlOz6KfUSBTuQ2MRS8vqwSUgdJrtLEA3Cw1c7SWOBmL3hoNrdfAVNbOS6IoFkAOJ6kSERzNwdKMrCRGJmManzgxVrImSrBj3yDL9dI3rTVp70hVnsILVHU2xRNlG0FIvArYaZNWHmjQOQqSOGtKcjHN4nVvtljWBBeD8yeYz+fzAabjgQ/VsJeNw3fjNze/3N6cicyqUGzY7iUPpKO1LztZr9Y9L8Mt5+vi/OLl4LvBC5FtfeQG3Y4/189urYfNtUNn/y/B/8YluJ8ZTI88bC0aJxWRSnDZU+an9WqcmGWdp7TYrtm29pHl4nI5wUgfg12t5PXXjkJi70LNMKR2zVy+JqfEsybKgVajKdpI36ivk/f9QnQK+6vxM1E8CDt+azNPxKZGKnF1vn1ZltTyztmTFW21u11c37y7+XCjCoU9HW2p+CFRcf8gga6P3GJH/SErZy/kW3w6KvJKOvstLV5vrueTZwU2m0C+LeDcrVarfwAcAC8A
sidebar_class_name: "delete api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete all consent records</h1>

<MethodEndpoint method={"delete"} path={"/service/individual/record"}></MethodEndpoint>



This endpoint is used to delete all consent records for an individual belonging to an organiation defined in the consent building block. This could be used, for example to exercise digital rights (Right to be forgotten) and deletes all consent records that shall not be retained and have a "forgettable" data agreement. This may also delete an unsigned consent record, for instance in cases where the user exits the signing process.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

All consent records for individual deleted successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List consent record history
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-list-data-agreement-record-history

---
id: service-list-data-agreement-record-history
title: "List consent record history"
description: "This endpoint is used to list all consent record history existing for an individual in an organisation defined in the consent building block. The response is paginated."
sidebar_label: "List consent record history"
hide_title: true
hide_table_of_contents: true
api: eJzdWN1uG7sRfpUBb5oAq1/bir0wjDpOmuokzQliBy0aGPBod7TiMZfcQ3Jlq4LuzpOcR+uTFMPdlVY/To4D9KK9sVckZ/jND78ZcilSKiwl6CkV8RSVo0ik5BIrCy+NFrG4mUkHpNPCSO1BOigdpeANKOk8oFKQGO1Ie7CUGJvCTDpv7ALoUTovdQZTYwE1SJ3KuUxLVCA1DxiboZYOeSNIaSo1pTzlZ7TWOSmlSlnJRJnkvgs3MwJLruBpBlNgJjWj74pImIJs0DZORSwc2blM6IN0/g16vMwsUU7afw4w/1qhFJEo0GJOnqwT8dfljvUfy3xCFsy0ts6x5e5eFsGqendpdBcuQVOGXs4JjIVSW8IUJ4pgjqokmKJSDiaY3LOGu/4dA5a8xa8lBRwacxKxMNOpIy8iYenXUtpWXFwyoxxFvBR+UfBSqT1lZAWHbIql8iLuRyKXWuZlLuL+ahUtG7VK5tLvbrlt69/wkQVBH7LZki+thoKC1dT9UYCDClWAMSNMw2yN8R+dqyrsr193xutsGadbe3lbHtrKeSt1Jla7Rm30wPiNWN2yqip9HEsP+33+lxjtSXv+xKJQMglB7f3iWMeytVthOcm8rKTrLN3OqHjZQvtVSIbfTvVgT9rOyDCiTCYi4WVOzmNeiNuoMc1MfqHEh0mveODq0LbRDjaZ7ntn1zl8LgAbGLsHmP21B/27On9un+pKxa6xz8VVaWEHfVfyg8lgkwobb35X8KZZygw0vv4ZTkf9AaToCVgLH/ccvVitIkGPmBcciMrJYnRMZ4OTswENpyM87ff7g+NhMhqd7Mc9FqP+EY1Oj5LRWZq+GvLa5NXx9OzoQErEYjSgwenRYPgqOR2MTnjx9OxVenxUZ0ssvhQMMF2zZUU13sD5pVLm4SKQFNNpUdrCOILzq9J5k5OFD2aByi/gCm0KY+dK1AldsPFbtHzOhPuZPEoFVyYvUC/gxTuyOerFy4uthI3FsD886vRPO8OTm2E/PhnFx2f/DB7b8GQrEHtp/WmzajeZk9Ja0v4TZvQEvbRjeVWtDkRVs5lohW3AmWE8qrGn3P0BfTe8uEWLkuUA5ygVM3xb9/CkUc5Yf0Q5g+ZCwVXWaGh4e73DER+FMPh93R93IDfsveWN/ioSM3SfLM2lKduQJ8YoQr2nljmVWwYHcsrpZelPDhCKWsPeFqE8VLt8pEf/4ztoevR72rkgrFacZtuJFYZ2uOm9iOqqw3byguP+4FkFoE3tZK2xVyYNcPj7TWu3A/y9ndMb6UOBXJt33OcA7ak/QGhrEfEauZEqSnZW3dywO/Yd8kVj6WfGyn9Ruueak2fWxv8v14y1J6tRAfeRZCFss+OjVSQcJaWVfhF6x8tCvif+vOUe5zWhJXtZ+lkYYasx4yazKeBQVXD2R05+Zpjzs9D7FchColf3sL1N79yrinSvpvxO/XO27gIquId62TeUm9oaEYnSKm7BvC9c3OullJsOFrIrM4vad6XpzYeCrdjWce2ZpLOn1Lhq+oCm242rrjljqkA3DltHDKuB6HCDeFkna1MktrFdfhrDPS2AU5q0rxO1ujNUldEEMoG7LT13UG0Deek8TIh5bCofKYUH6WdwV2GEO3ihDXcDMwJvUarghgITehkBdbPujtoYasHzhSkte6RzT4uLuy43Ju3UWIpJ+PWXqsOIxU9/v9m3TQMmCTnuxe9JN5Zs8iIKtb7O853rVhCJKuRt6cLKOSYLSNHNJoYbAWUyqSO+wGC9dGpNXm2Vsk/9Agpr5jKtygpPtPuFLlyTTkF6QLfnj8poOA+KL8IFKJBHKARhTqyJgRMqtA5ST03DQpgEFqIcJSedK4vCWP/ndaJtEkW+2wxtZ+hm8d6JXwvBi3//9vtLvl4iXD9QKt2MO0EEekxmqDP2bwpzsnJaJxnUB3XtnC6MPd+UHThS044zc7IkM712Y1TLhytiYikMo3IRIKQyk9wUPKBS5MNmziiZQmFS8JTMtOFAkYuANE5CJnJxfABFc1Kh3jN7hfvwRCqOGivB0pscw508MXmhJPd8VZYH8yxlpQr2uHBFh2mpFJ+nVPqAM0etyXLglExIu8DPzdksMJkRDLv9PZ8/PDx0MUx3jc16tazrfRhfvf14/bbDMqtNH7iJA5/o1CQld8TNmWdyq+I17A+Pu0fdAcsWxvkcdQsP3/ufeJrYPV2tGve/9NxRHxVPj75XKJSaHRE8v6wLyNfmESQQaoMnXKdD4YnEdhnh8la76DYSM+M861guuRv9YtVqxcPV40EoL9JxWjzxctT26n/3GeWgI+65rmxeU4K4iEVV0/4w8Oe+iXwDStPJb5Dc8g8bKKDqGZqC9zznvvhcN14vYfu145twvvHYsuWravVlklDRRr/XCq7aXcy7t1zCsK5vm9p+H2p7/cFWNlN60dK9W+YrCPyXAR0UOWeqeE+Li/XyauZJgXVrUa1mz9yuVqv/AE/VTic=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List consent record history</h1>

<MethodEndpoint method={"get"} path={"/service/individual/record/consent-record/history"}></MethodEndpoint>



This endpoint is used to list all consent record history existing for an individual in an organisation defined in the consent building block. The response is paginated.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecordHistory</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data agreement record history ID"}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Organisation ID"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data agreement ID"}}></SchemaItem><SchemaItem collapsible={false} name={"log"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Log string"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp in ISO 8601 date time format"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecordHistory\": {\n    \"id\": \"64e91591e2f6a8000142c665\",\n    \"organisationId\": \"603e683c69dd720001c74f93\",\n    \"dataAgreementId\": \"61e183127c81650001f97d43\",\n    \"log\": \"Updated consent value to <Allow> for the purpose <Customer Loyalty Card Issuance> in organisation <The Retail Company (Germany)>\",\n    \"timestamp\": \"2023-08-25T20:56:49Z\"\n  },\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all consent records
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-list-individual-agreement-consent-record-list

---
id: service-list-individual-agreement-consent-record-list
title: "List all consent records"
description: "This endpoint is used to list all consent records existing for a data agreement for an organisation defined in the consent building block. The response is paginated."
sidebar_label: "List all consent records"
hide_title: true
hide_table_of_contents: true
api: eJzdWdty3LgR/ZUuvKxUxeFI8i075dpEsrybiR2vYtlJqryqUg/ZHGJFAjQAjjRRzVu+JJ+WL0k1wNtwRl7ZVXlI/GCPSaDRl9OnG817kZJNjKyc1ErMxIdcWiCVVloqB9JCbSkFp6GQ1gEWBSRaWVIODCXapBboTlon1RIybQAhRYeAS0NU8ir/UIE2S1TSIp8CKWVSUQpSgcupE7ioZZGyoEWhk5sYPuQEhmzFr1mTCpdSoaM0FpHQFRkvbZ6KmbBkVjKht9K6uUrlSqY1FqetEq/CAe+9wrxGRKJCgyU5MlbMPt2PnPBRyc81wfwcdOa1X/xKCe+S/LZCl4tIKCxJzATb2500T0UkDH2upaFUzJypKRI2yalEMbsXbl3xFuuMVEux2UTjg9/V5YIMn9p612mwN7LyfmwcILWK4RQULdHJFYE2UCtDmOKiIFhhURNkWBQWFpjcsITro+u41f5zTWbdq6+zzJLb0jrDwu5TWypHSzIiEillWBdOzI4iUUoly7oUsyNvTyO2kKV04yO3bf0z3vFGUPtsNuRqo6AibzXF36rgcdDKq5ETpv5to+PfJw0wzs4mPWq+LoRjo3o5MD8XmysWFRBseffJ0RH/k2jlSDn+iVVVyMQHdfqrZRn3g9Mqwzh3MuxOhjj2T6Sj0g7U6oDqpCv4wRb0d0JwOkpmoLvKkLVkuxcHaLfzVdpRon5nwVaUyKwx45Djh2ClWhYE58P08DltCMraOlgQIHx8N//Lx9f+NGeQKUcrOBhxiKGVtFKrCGTn3kMRibuJ0m4i1YTXL9BSB40+fp+EZLs7Ye8bWX9Ey0lsHToSV9HI0zLdjXUkMm1KdGImRCToDsvKu/j5s6cvjk9OTuh3yYvkyWLxJDlJvv/+6HjH2z/74Fgocc3GV2iZWn2OLtZgdUlwejHvyNfCrXS5rh0z0PwcDi7eHEaQktKebV2OjulzDWjYk7+I1GDmfhERyJhiQNiKfVgvLSjtYE0OrNOm5+DWg4AqBa2KdaB1/9qgstLFcM7yt6VaSLWXmOOKlXjfRWpRO5AZVMhhgLryxgDCpVwqdLWhCJC5SqbdJrC5rouUfbMkxfTOVM8pNqLYPaG5m2Q3k1KnVIiZ2MLcThi4rGytYLze5jLJO9DnaGFBpGApV6R2VGgVfoQq7dK9WnSG66wLwgD2X9IJnH5QLQ/tR8MXjxcnyZP0KT3LnsdxvKPoK12tWwXbRGRl8lCg+RfDil9LlRR12oPKtrH2qCJla0MWcIlSWQcOy4pYtQAN3qCN5ApX9E7w8ZdDcv4tj/cMvNfnA4K+zbX3KqvJPQ5T2zYf8uG6cnM1OHWhdUGoHvJnqBejc01NM++t3hJ/cqWt5BJerEFXzjsuhh+ZwvYupzuuFdIVa7AoU1AaDrTx7ksN3ipAqDhEuu4MOfQODCz3aEgEh+x1n5cEmaQiHTaHTfkIb5Mc1ZIDnTkyE5fTJMPExTD3/FMyy6OvJ4u1j3rDKHB2BtJZKrIY/uqJwYuzM6hV0GhakfJ1p9RmgC477RQmxZ3IJ9HuYIYPP6424aff8QgYdTy1p2j2uPakyinA5haFN8c3YLZNmVGB5UQYYE66Hvw31OXZXK1kKmssIijxhi2WDlZkZCZ9j8dSQvpMKqN1FsOHs/MZvKciNNi+AHcWQOgnfu+RQInT5sJQRoZUQsPmAY1BbtMebCq2/dAUfQq5X3mRzPXhCEjJoSzso8t02CYiUejQR+xW5WbJo3G8o/I7LKn1cSPsixm+vfvct0G2NVDaLmm5BVfaea6yb9G6j1XK1esrhI5wwu2+J6T+sAKtg7oRvPF/ou3Qbfha014RvtQVXvSrxj5OamNIuQtc0gOd9VZxCKt9j9408sMIHLOG2mExH0HqIXkfePHgRuChCLhCWTDwh7JPnrXCWddvEc5K8x2JOUwraK8s3QlPNlFzj/lt2e9GKrcXly1vHG0ikaO9aDj6EejgapUwCXIv5bh3/s4OWX58hM+rcMo7unPffoKiO7cjnWvbFuwaYPlH465he0jAeB61Nwed5+eXP8PJi2fPjw79lIE5pE4Ssjari4IZKdzc2GF80tNwido+cIGciFXNWjc3+z0bj7/q9jWkJzJGm1c69Q7h3+eD46/GHhlnVb97H5Q6Bz89YojsiN9DeD3Jne0xvCGH8VADa5drI//h6+K2a5595cX0/8s1c+XIcN/JcyQy4I8Z+SgUz9pIt/YTo9NKviH+ecUDhjNCQ+a0drl/wlbjkkdLXSY0V/CrSJTkcs1TqyWFSRRvEtNmhjXtm75pyJ4pJ86kS5zp/eg+tJliwc1uUH7fPOucSt3YJiJRG25wcucqO5tOUyr1BCsZy6VB5WKpp6sTsTuaunRcNJYPibHh9R5JV73jLhk/Ieyt+/ruIzyI9s9qThvotkVr1JJdzH37xAAn5RrYhgtKmIc1Rf96S841hGO6eQQ3MfKO0tCUXQcd4RoOlHbkBfCQovBuqDChwwgoXsYjsTNoNr5c69qwRyY3tP7h2rfiQ6Dci4X/349t9/Knv33YtU0BejIEp2+ouyv2KIk8uTao51nB4Nbgt0RB8+HuysgVJmtI0eYLjSaFQi+lisCPcMPSzOgyHJWyT90aKqNXMg1lLlzX+qFuDJekfEOLdscfwWh46QX/4GeRnkp8YfLvREcTDCgejQqpMt1yEiaek6hEyaCzdVVp4/7QAa0Hivypf7SN0H7xTv53m+Dg3//81yF3WwiXt5RKm4eyRXfhVuNb79CJB5BBk7adc/w9p7a+TyyyidUrMiSXqnNjNOzkE0P+MRaWByKpXEpuUm6xKMj5w6zmq1ClU3CU5EpzoMhGQAoXHolcrG+hoBUVvv9gLvPT8YUsOGosBGunS/Rzo0SXVSFRJRRQ7s0ztKzD3cFyO4vgKy9gnUrn9SxRKTIcuEImpKxn6zY3K0xygpP4aMfnt7e3MfrXsTbLabPXTt/OX71+d/l6wns2fV/ax4EzOtVJzQzX5jyTW4jXydHJ0/hJfOw7Xm1diWqgz9sHvlSMU2tQ7v5nPns0SeLozk2rAqUfTnmf3zeF5FP7MUQMByd+pt3OgLfKiYjEbPcbBleUq0jk2joWeX/PzdpHU2w2/DgM9H2dkZbx0Q/lH/Twf/fTxl6/3HCB6b9w+O18LfTF7dGKf+13ii+o0l4xek2u+D/Gc8FX+vPgfdOCHcKDn6v2qtLWW7UeatKqOIbChgcnTTX+ZgW3v4p80UVf+CizFb+w+jRJqBp6dKdr3Qwbrp9ec33Fpvj2jceNbzyaH2zlXh+Ne5CgAv/NCu3d8pJ57A2tf+iWhzcPbuj6nrCaPXO12Wz+A5UTV3k=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all consent records</h1>

<MethodEndpoint method={"get"} path={"/service/individual/record/data-agreement/{dataAgreementId}/all"}></MethodEndpoint>



This endpoint is used to list all consent records existing for a data agreement for an organisation defined in the consent building block. The response is paginated.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent records for data agreement (based on ISO 27560) listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecords</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecords\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c9901\",\n      \"dataAgreementId\": \"string\",\n      \"dataAgreementRevisionId\": \"string\",\n      \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n      \"individualId\": \"string\",\n      \"optIn\": true,\n      \"state\": \"signed\",\n      \"signatureId\": \"string\",\n      \"sectorPreferences\": [\n        {\n          \"sector\": \"\",\n          \"optIn\": true,\n          \"isLastUpdated\": true\n        }\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all consent records for individual
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-list-individual-consent-record-list

---
id: service-list-individual-consent-record-list
title: "List all consent records for individual"
description: "This endpoint is used to list all consent records for an individual belonging to an organiation defined in the consent building block."
sidebar_label: "List all consent records for individual"
hide_title: true
hide_table_of_contents: true
api: eJzdWeluHMcRfpVC/zEJzO6SlGTHC8MJD9neWFEYHUkAmQBrZ2p22uzpHnf3LHdD7L88SR4tTxJU91x7kKYMBAiiH9Jqpqu67vqq5kFk5FIrKy+NFlPxoZAOSGeVkdqDdFA7ysAbUNJ5QKUgNdqR9mApNTZzkBsLqEHqTC5lVqOCOSmjF1IvmA41GLtALZFvgIxyqSkDqcEX1DGb11JlTDFXJr0bi0SYimwgmWViKhzZpUzpjXR+1l10GYnfBUH4lUhEhRZL8mSdmH562FHubV3OyYLJO+G9AXcnq6BEhQupw5VjOAdNC/RySWAs1NoSZjhXBEtUNUGOSjmYY3rHHG5PblliyVf8UpNdi0RoLElMhclzRyyXpV9qaSkT0xyVo0S4tKASxfRB+HXFR6X2tCArEpFRjrXyYnqSiFJqWdalmJ5sNslDy1bJUvrdK7d1/ROumBD0IZ0t+dpqqChoTePfKuBplCqIURBm4W0j499HjX8uLka9z2bZ1l3e1oeuct5KvRCbXaV6PjC7EpsbZuUqvsYx9dnJCf+TGu1Je/6JVaVkGpw6+dkxj4fBbZXlKPMyUqfDcApPpKfSDcQy858pZbt76RU/2IrAPRec7+QK0Kqy5By57sURuu2UkG4nF75w4CpKZd6ocRySCpzUC0VwhR7PF5aoJO3H8KEgS1DWzsOcAOHj29lfPr4Ot3mLnNFGw1GGHgFbKrC0lE4anQxy+FgkYjXSxo+kHvH5OTrqQqP33ychWe+O2buG1w/oCpEI59GTuEl2LC2zfV8nIje2RC+mQiSCVlhWwcRfvnr51enZ2Rn9Lv0qfTGfv0jP0q+/Pjnds/afg3MclLhm5St0XLlCjs7X4ExJcH4962qbg3vpC1N7rlCzKzi6/vE4gYy08aFyFei5Qq0BLVvyJ5FZzP1PIgE5pjEgbPk+npcOtPGwJg/OG9uXudaCgDoDo9UaaMX1lF9b1E76MVwx/22uDjITOBa4ZCHedZ6a1x5kDhWyG6CugjKA8F4uNPraUgLItUpmHRG4wtQqY9ssSHNxpWwcUmwYQ7ODrlmN8rtRaTJSYiq2Ym7PDR+KnajkeL0vZFp0QV+ggzmRhoVckt4ToRX4GaK0Rw9K0Slu8s4Jg7B/Sibw5lGxQmg/O3zxdH6Wvshe0qv8y/F4vCfopanWrYBtIrIwRUjm8IvDil9Lnao664PKtb4OUUXa1ZYc4AKldh48lhWxaDE0mMBYyR1O9UYI/pfD4vxrFu8r8EGbDwr0fWGCVVlMhhBc2rbrIV9uKj/Tg1vnxihC/Zg9Y7/YudfWNA3WGmAQvrkyTnILV2swlQ+GG8N3XMIOHqcV9wrp1Rocygy0gSNjg/kyi/caECp2kak7RY6DAWOVe3ZIRIMcNF/gBLkklQ2xV9M+4tu0QL1gR+ee7MgXNMox9WOYhfpTcpXH0E/m6+D1pqLAxQVI70jlY/hrKAyBnZtCraNEk4p06DulsYPocpNOYNKMRD6JloIrfPxxs4k/A8UzwqirUweaZh/XoahyCrC6SgV1AgBzbcrsNFhOhEHMSd8H/x11eTbTS5nJGlUCJd6xxtLDkqzMZcB4zCWmz6iyxuRj+HBxNYV3pCKGDQ240wAinvh9iARKvbHXlnKypFMagge0FhmmPQoqtu3QNH2KuV8Fllzr4xWQkUep3LPbdCQTiVAm4oj9rtwceXYc74n8FktqbdwwezLDt6mvAgxyrYLSdUnLEFwbH2qVe4POf6wy7l6fwXQnThjuh4LUX6bQeagbxpvwJ9l23Yani3ZEeAoVXvendm2c1taS9te4oEeQ9VZziKcDRm+A/NADpyyh8ahmOyH1GL8PfHgwEYRQBFyiVBz4Q95nr1rmLOtvYc5C84zENcxoaEeW7oYXm6SZY36d99sdkdvBZcsaJ5tEFOiumxr9jOjgbpVyEWQs5Rk7f+GGVX73ipBX8Za3tPK//QZNK7/HnXvbVtg1gRUe7aKG7Rmch3OuDXWaknN5rRRXmjiRsSGYw8s4HG0zmiMnWFWzNM3gfIDw9LOmqmHZIWuNvTRZUJR/Xw2uv9nVdDdbeupDIdIZ7uUJu36P/YFC1heviwOKN0m/baGPGmtfGCv/EfrdtmlefebA+f9lmpn2ZBlP8naGLIRrdmwUm2JtpV+Hhcx5JX8k/nnDi4MLQkv2vPZFeMJa44I3N12EN6P1Dfe5rTl4lNo6Ux2gEPsHKilHxo4c6QgDG6h44KRLSaOV5jCf2lEa2qr4eDm6HF3PLkez0UmYQGnlmbvRcdt0x5o9KWgiAn7hi1j/wwR7gvdUQYHHKTtFnnVPq1h/eEdBdkhJvjC8gltQ3K+xr8SkWchNegw9icVo0rTakW2XIjE6Du3jrqg0TfCIRNSWHVl4X7npZJJRaUZYybFcWNR+LM1keRaU2ebx3mNYNT7CxsXXBzjd9JH5nhM05lUbnz1siw+Sw0uu86Y2tN1+B8tezwLu5ApC2jd2j5NdXCQ2aOl2i88txGu6RQ6jP7miLKLZ2ygj3MKRNp4CA97uqGCGClM6ToDGi/EO2yk0hN+sTW3ZIqM7Wn97G2aYYSY+iHn433ct7Pvj3z7s66YBQ7cBb+6oG7L7eEgCymrKys6GOJAkUfIhdWXlEtM1ZOiKuUGbgTILqRNGgNgcza0p41UZ29SvobJmKbOID+Kcy/tm1xj7PekwCaDbs0dUGr4JjL8NS9xQq0NHD+9EV4c5oMQmjMu5aYs+pqHoU4mSg87VVWWs/0MXaH2gyO/7R9sR2h/eK7AdERz9+5//OmaYivD+njLpirjOoFUcB8PMEkeYGGTQJGhnnDAg1i4AbJWPnFmSJbnQnRmT4QiUWgqPUTneJGVyIRnd3aNS5MNlzvAMWZkMPKWFNuwocgmQxnmIREY596BoSSoAN24WYak/l4q9xkyw9qbEsHBLTVkpiTqlGOVBPUuLOg5djucAhABtAOtM+iBniVqTZccpmZJ2oR22uVlhWhCcjU/2bH5/fz/G8Hps7GLS0LrJm9nl67fvX4+YZtMD+t4PnNGZSWtenrQ5z8Ut+uvs5Ozl+MX4NIwKxvkS9UCeN099QZGP7lUG8OJ/5+tMkxSeVn5SKZRhixds/NC0iE/tNxsx3DCF5X/TF3YaxU0iCuM8Uz488Njw0arNhh/HDxyhfUjHbu8/Ujxqqf/up56D6scm233x2WrAzxf8c7/bPCFKO3L1ktzwf2xI8QjB2ob2ecY9etfg2GPY/iLzpDhPfBA6AFbO05SqofR7yHoLnXz/mlsUNv2r7913oXc3P1jL9pVeD3jvtvEoAv/NAh0k+YZLwY+0/rY7Ht88StBBh3iaLXOz2Wz+A0uXSsw=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all consent records for individual</h1>

<MethodEndpoint method={"get"} path={"/service/individual/record/consent-record"}></MethodEndpoint>



This endpoint is used to list all consent records for an individual belonging to an organiation defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent records listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecords</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecords\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c9901\",\n      \"dataAgreementId\": \"string\",\n      \"dataAgreementRevisionId\": \"string\",\n      \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n      \"individualId\": \"string\",\n      \"optIn\": true,\n      \"state\": \"signed\",\n      \"signatureId\": \"string\",\n      \"sectorPreferences\": [\n        {\n          \"sector\": \"\",\n          \"optIn\": true,\n          \"isLastUpdated\": true\n        }\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all individuals
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-list-individuals

---
id: service-list-individuals
title: "List all individuals"
description: "lists individuals in the system This endpoint is used to list all individuals in the organisation defined in the consent building block."
sidebar_label: "List all individuals"
hide_title: true
hide_table_of_contents: true
api: eJzdWF9v2zgS/yoDvlwLKLaTTXNYoyg2bdKFr71ucMniHtoAHosji2uKVEnKji/Q232S/Wj3SQ5DSbb8J5dtgQMO95JIMmc4nPnNzG/4KCT51KkyKGvEWGjlgwdlpFoqWaHmZwg5gV/7QAXc5coDGVlaZQIoD5UnCcECCwJqfUzWujka5ZH3AEmZMiS731JrPJkAs0ppqcwcZtqmi4FIhC3JRZGJFGPhyS1VSh+VD5PtDiIRJTosKJDzYvz5ce84n6piRg5sBo5S66RnU/1ClZBZByXOlYlbDOASDM0xqCWbC5VxhBJnmmCJuiLIUGsPM0wXrGE6mrKFirf4WpFbi0QYLEiMhc0yT0EkwtHXSjmSYpyh9pQIn+ZUoBg/irAueakygebkRCIkZVjpIMajRBTKqKIqxHhU18ljp1arQoX9LXfP+ld8YEEwx87sKFTOQEnx1DT4XgNPR3V9z7K+5MB5Xn02GvG/1JpAJvAjlqVWafTs8DfP1j32tJeOQxtUI93DS3wNVMQH1PqXLIa0tcbOfqOUfRBU0Pxhi4MDX9zmqLVd6TUUVpL2gAa2y2GVqzSHAtfgKCNHJiXwtiBQxgfkN2VYhB4COYO6Q/8LR3PlQwPL9mMCWWVS/oAaJlcJZLYyEjcfgEL6cgCXOwZs9rEZBE6paCbnk7GB4zUjKJQPuCADKxVyQKiM+loRGAyVw36eDWDSpGLJkr1ktStDjr9JSpUkUO1mDS4YDIUKHgosS868YAGPqAc0cmgdSyN4Zeaa+kdxdgUpGtYSk4uWxPJdXuPcERVkgmfMPZwYG06UOZEYcIaeNuDbA4XswdAHp8xcJCKzrsAgxkIkgh6wKCMMLs5fnZ/iGV3Qn19d/DgajU7PX6Xy4uIAFHc5dU6cXLHnd0Hh7GogatbcBH3yDTZUntxP7esgtcXB3n/b4Iy9bGzIye0gZbiHogaiyoNWC9JruJlMdo27i4b9UQOpQHWYJtcdvidXwHrAl5SqTJHjgtioHMB7Dn4H2C+Nqi+Cy+QXsQf2L2IA79AwfGNjUAY0BnLAJUuRjw5WkkxQYX3j7FJJct/i6GPBxtnp2ZFgKw+prbRkY9DA+w8JzKoQC7+xK1gRSBvTLcclAW7SwGbQWQhla6IfwOTq7dtYMuLywjqCtoK26K5jvX6+WF0/BId+pwB/bsp8sglTmVtD4n4/LZpmcOirvaaHRVtYqJfG0fNYHHf2roJ3jjCwSxjWHMMFrVNtccGlADyfn3VPlZwCephGtdMIz2j/sxtc8zKYXLFIc9RnRW7iMl5f+fyTDSprG8ydXZB5Xv6KmD5A4NXHnSPjiqfS6ri2dUkvfrl9eURhIshwF/8s0EhnleTmbb24rxPBSHsK9vv7MFnyUXkjBUoeM7+uWXGrDJ3DdfTVhuD0tjqA5s121T7g0so5MuEG5/QEL9jBTbM6MoyWhvST95QttAH1pOvxz+i748U9PhO5AeASlWZq1td99qpTzrZ+j3I2mhkely1roCNcmx1+qJOWhT2v+9OeyR3t2vHGqE5Ejv7G0VLZqm/yzFpNaA7Ucg1JMZBvOjk5+pMHhLLVcLBFbK3NLp/oIXz/DoYewoH24CqquejtASt+OlTbzQQ8KJAEX6UpeZ9VWjOVzQllpPCPLH3eMMpdJTPkflJWbElL+Y8Inn4TFe2XYHLOundWxkPy81Vv+/v9U+5nylb6GDw2TjsfcdgP1B8pBNue9/bIwev6iJt/NViF3Dr1D5IHrnn1jSz9/8s1E9MxeXJLchC32fNRnQhPaeVUWMe547JUH4gf77mxvyV05C6rkMcvfGqc88zZn0PuE1FQyC1PrPM4BpbIAmLYzq9DtTO8NtYcm1yvqLCtsSIRldNiLPIQSj8eDiUV9gRLNVBzhyYMlB0uzwQbuTcFBa7s86fU+ObnI5rut564ZUA0cez8sQkINh/aqbRx5XYSvmyx2HWWXdsubyZMK4ARy2QrbedwJunNyN12uemOnik020BR+cDMrnSUqQeSzZQ0bWyEKbwwNjQ0JThUOrqhxJReJkCD+WBP7RhawddrWzn2yMmC1m+mka/2I/8oZvHtfcdO//L3u8OzGcBY3Z6iG0lkoS2MmZz2pq0okjSW96VLp5aYrkGiz2cWnQRt58okzMOxXZo5WzRb7RPYTkv/KmYAt2QkqBBJ3J4/mkPD66j4TbzuiLUhdo/4m9jkPQNKcPook9muyGAai0zLCIWvytK68NMGaFugqJ+3n3YRul18kNAbIXjxr3/+/pInJYTbFUnlc+DpEughzdHMKZLWJbkNY4Q2FzfOiQN05cmDJ52deLskR2puNm5MWvl4IZQ6ip9R+wQQpJorZhIr1JpCw5CtVhJKKyFQmhvLgSKfABmcRSRyR12BpiXpSBK4OMXrrpnSHDVWglWwBQZentqi1CqOXxHl8XiO5pWO54n3bAixlQJWUoVoZ4HGkOPAaZWS8bSdIMRliWlOcDYYHfh8tVoNMP48sG4+bGX98OPk3fWn2+sTlqm35HEbB85oadOKx6Eu57m4NfE6G52dD34YnEZaan0o0PTs+Xjk9nA/rXq963/pmrLNgUAPYVhqVIZPGF362Bb/z93lZayU2/PdJyK3PvCCx0cmnr86Xdf8ubngi01BeQ7m9pLuSZf8d686j55ywd1ge+MZxXlgj53oDxv+rfeW/8GUjrRvLbnnFxcTt2nkXZti5zZCl2lKZV/qgBfV/bb+8zUXfGy7wbYTLmInbB9615Zo1j3d+02xMYH/9i4PdkVec2J9oPWbzfLmlycFNo24Wc0Ouq/r+t/dAlQ1
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all individuals</h1>

<MethodEndpoint method={"get"} path={"/service/individuals"}></MethodEndpoint>



lists individuals in the system This endpoint is used to list all individuals in the organisation defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Individuals listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"individuals"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"items":{"allOf":[{"type":"object","title":"Individual","description":"Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.","x-not-in-database":false,"properties":{"id":{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."},"externalId":{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"},"externalIdType":{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."},"identityProviderId":{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}},{"type":"object","title":"IndividualExtras","required":["name","email","phone"],"properties":{"name":{"type":"string","description":"Name of the individual"},"iamId":{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"},"email":{"type":"string","description":"Email ID"},"phone":{"type":"string","description":"Phone"},"pushNotificationToken":{"type":"string","description":"Device token of the individual"},"deviceType":{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]},"mapperId":{"type":"string","description":"Defines the mapper id of the individual"}}}]},"type":"array"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individuals\": [\n    {\n      \"id\": \"64541a2e6e7569000145cd66\",\n      \"externalId\": \"user@example.com\",\n      \"externalIdType\": \"email\",\n      \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n      \"name\": \"string\",\n      \"iamId\": \"string\",\n      \"email\": \"string\",\n      \"phone\": \"string\",\n      \"pushNotificationToken\": \"string\",\n      \"deviceType\": \"android\",\n      \"mapperId\": \"string\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read data policy
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-policy-read

---
id: service-policy-read
title: "Read data policy"
description: "This endpoint is used to read latest version of data policy defined in the organisation in the consent building block."
sidebar_label: "Read data policy"
hide_title: true
hide_table_of_contents: true
api: eJzdWetuGzcWfpWD+VO7GMmSb0mNoljXTlK1RWLY8RbY2kCOhkca1jPkhORIVo35t0+yj7ZPsjjk3HRJ6iALLLB/7BGHPDee6zdPkSCbGFk4qVV0Fr1PpQVSotBSOZAWSksCnAZDKCBDR9bBgoyVWoGegUCHUOhMJisQNJOKBEgFLiXQZo5KWmTKzVqilSXlYFrKTEg1h2mmk4dhFEe6IOO3TkR0FlkyC5nQlSd8TSiiOCrQYE6OjI3Ofn/akPtWyY8lweSShUIFevoHJS6KI8lvC3RpFEcKc+JfnuqEaRr6WEpDIjpzpqQ4sklKOUZnT5FbFbzXOiPVPKqqeJPjecMEltKlzNnQQtqgQc33Y0lm1TFe29CxnmFmP8v7nnfbgm1n+f3haMT/Eq0cKcePWBSZTLz9Dv6wLN9Tj15h2LpOhtNB/R6f1lZOuowXgtmjeFPj5qLnekFG2XD5qARcosPzuSHK+XLruzaEWd5cR98XXIretQzNyATvQgt3kSfHShmdZWTuIth7c3l1ve9Z6KUiw9TCKZWw97Q8LbvQ40BpN5BqwISmaKk1bWfr38NdxFFpsug+3jCNFNvmj6OZNjm66CyK4ogeMS+8kU5Pjl+MDw8P6WXyIjmaTo+Sw+TFi9F4y2xR1TjAc0lf0gzLzPWDa4vqW8yJzcGWrrdUcVRH5vNZjYej4WiL+N+7AO/ow550kKCCmc4yvfRvLOULMhBo77MEbNdnc0+dK+zZwUG9Mkx0flAYucBkNfiE3ldkclTsZrfXvwI6WKYyScFx3lqQWfWTE0sYfNnLPfU+KWKwqS4zAUo7XkPWJrhhkqKaE7B7g5M5sUJ/lEZaIRP3RXZ9dbsl+c99QhVnCFFaZ1Y3lDhtnk/6J8LMpQka2mIxqUmCDTSr2AfVNXGekFpdkZFaXOLK9thJ5WhO5lP8jk5PNtlwuINpiELhqXLYC6ZcxdGc9Nxgkcrkmlibrzfem5YimB7JKo6s0wbn9KsO6e+ruNwEWpA1xKo4cqk04gqNW7HaNyl6oh2XqdYZofoUm1BXtoqsEVAwzRDjtqZaVVXcVonPZejrZs92jv52ToqMTL5t6xHkWlAGCRauNGTrwDUSM8nFvS4jNqTqFYS68Y0FK9U8IzB6OQTfF0h/VoEtQ+FzGsb7kJhV4drbsXKukPn4rH24D1gK6aSaD+/UnTq3UhDMjM69FHeRLZOErNWc7ROdlbmKATvJ60idhs5BCl8vuGUg8fyML7ncBq3ehuQf7OnLcHjkq+VNZOSfmMk/SdwoLGyqXb0aFn9Cm/pbyMk6zIv/fgU5Pd1RQZrbhsml9/hOlWfzEv0KvZ1U2eC6tNmKr8STv4tgWjrO7OAoSZVMMOP0abWy/WvBLCPRnmKh7jxnVeZs+02+XVbvv7imRBsR3Ve9q/kqM748/u5wS8v3XA5+aQpD3bz5ZmSJthcRUbXmFs8W5Gk4HFY7ufZ5yU1WHDEkfpMu1aV7t63+XySY2uG3CgG3gz7Y0UFjVK9oRjMH0wzVA6fsHS4PSw7yBLOkzJBDF9YjYNjRy3HF2cDSx5KUy1bsEjPpXUKqodduR0h9pUWbcCARsuceZzG08PPNu7f7/IDAZXYI50WRrfwyXKDS3ofln6EJvWF/Jd5dkIHJq/ev4fr1Bbx88fJkCDBxPi2iVJb7A+8wM0mZsI37BH8HekyocGDLkMUm3F2sGav/uzHA8E41punllWdbBcfTw+RIHNPJ7PRzz1uGYzYs/64737v56Xww9i1cl96eLdLh6PB4MBoPxifvx6Ozo9HZaPSP7Uho6LIM3seaPM8+lmJRkCIxZON3CWZy8w5eno7GcPv+gq+b2sYMS5dqw0r8uGJ/X0hRYhZCZzsawlvOoPHmfLVO6p1LyXxR/jk+OR7jIZ3Si5PT70aj0fj4BKej7a76up5cyE88ClDkUvGAbUKUpmghMYSOm9HUD0h1lWdnaQplEO1xMHsY+Lq+3g1sirxhiNk6YU5GSkOm1dwLQc2E32yIw7jFAktnoRWCJSoMCQo/v8x/n+e9ydG2A2FekBkYstJyywJonJxh4kJHUdRVDIwvJzEkupAkwsuNYFuX/6ZpWp6vRF/U4XD4lbLC3pJAaPWNgwellyDrwWtjl69TvlyANjy/7HPLWMUbfaJf2tGy13OcIWckLUg09zkrs4xrckooPLzyxASOA8qwTmeKnNmL0kELx+w4OP4ieKLfq5Ex2lxowV2af77ssb/fVHSz++pO7xpv2ss7Ho2qHeR33H133z/uULyqdlj6VnXZZMs0J1+I3Px/mWaiHBmFGQcjj9iezYaNfF1MSiPdysN854X8hfjxniG4HwkNmfPSpX6FtcY544HBwWvg6p4nA1tQIme1aQeJKUXWJswW4NrcVkg50GZgSVnp5IK1e8391Y6tNiGFRuqQGDbflpYSP49EtxeDi8HV5GJwPhiNjrzhHJPXKuCYD6zdZ+WNowVmZQ+YY0vsPrYlf3c26PHpo60+3ZHP7G706zZv6Ml3k5NLNcO5c/IOySjsWXRQg7sHIR0dPDV4bBVmrcVuhPeScl07Tg3fdfiRoFwPsJBDOTeo3FDqg8VhtI3Z3jic1/3sLjI2vN5B6b7zytA4+phqfLMNDgwLNfob3LqDf8/rvBCgha3J/WoCD7QCzh4MrARD8+RN4G3cdJ4f1uh8gMAG8tJ6OKswNJOPJAIs/SHICB9gT2lunlICZ1Bm3gwFJrQfAw3nww2yZ1Af/H6lS8MWGTzQ6ocPvqfvR+FTNPW/XjdV8uff3m/rpgB9pQGnH6jF5mTbl8V+0KxTCvdG3atwJA6S90/XQCEItOlUo2FgYC5VzKUR660t0iAF29StoDB6wThCOwb2kOkh3JASIB2PBZv2CErD954wG6IexH1H49917Rc7FH8ziKSa6SbhY+ITPuUo2elsWRTauL+1jtY5inzTLa17aLd5K7m2h2Dv3//81z63dgg3SxLSpmFOosca32RkZkGmjWaoI7I1ju/BS0s8qmazgWVAlORctWaM6/M4zYh7Vr+MmY397DWXDjNYMjTgPDOrMymg0CJgCZovimwMpHDqPRFB0RIyWlDGF8OFyVcvnMqMb42JYOl0HubRROdFJpFbae/lIgCScz+vMkAhFSD4tibgT17OHJUiwxeXyYSU9aWwic0Ck5Tg0IPh6zZfLpdD9K+H2swP6rP24NfJxau3N68GfKbqoLnuHjiihU5KRjiamG8Bej8yDY+GY9+KautyVD15+JvX5/D/Xg/xv/tmV3u7o0d3UGQoVe8DQEj2vzdf8vrQz1n7Ae4+jlJtHe97emL87tZkVcXL4cuZrwLS8u2J3UhH3w5/8UVup7Shuq3t66rfPf8w3sm/UJS967px24dPfpncKU9TSNSqL0kjZ2u4iqGyur50TcR5wmBE7+BWc7lWld+84kyNdRrvStiDL2H1A1PfKdRmNQsi8F+uuzuPfM8R8Qutfmi3hzefPNBW0LCbTXRfVdV/ADqSlys=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data policy</h1>

<MethodEndpoint method={"get"} path={"/service/policy/{policyId}"}></MethodEndpoint>



This endpoint is used to read latest version of data policy defined in the organisation in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"policyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data policy retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A policy governs data and DataAgreement in the realm of an organisation that is refered to as "data controller" (GDPR) and owner of referencing Agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"policy\": {\n    \"id\": \"65471222e8c7c3bb3c2c7701\",\n    \"name\": \"Default data policy\",\n    \"version\": \"1.0.0\",\n    \"url\": \"https://example.com/privacy-policy\",\n    \"jurisdiction\": \"EU\",\n    \"industrySector\": \"Healthcare\",\n    \"dataRetentionPeriodDays\": 365,\n    \"geographicRestriction\": \"EU\",\n    \"storageLocation\": \"EU\",\n    \"thirdPartyDataSharing\": true\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read data sharing UI
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-read-data-sharing-ui

---
id: service-read-data-sharing-ui
title: "Read data sharing UI"
description: "This endpoint is used to render the data sharing UI during a data exchange as defined by a (data source) organisation in the consent building block."
sidebar_label: "Read data sharing UI"
hide_title: true
hide_table_of_contents: true
api: eJzlV81uG0cMfhViLrWBteS46WURFE3iNFAbJIF/0INhwNQOtTvx7MxmZlayIuytT9JH65MUnF39WpIdu4cC9cWSZkh+JIcfyZmQ5DOnqqCsEam4KJQHMrKyygRQHmpPEoIFR0aSg1AQSAwIvkCnTA6XA5B1/ITtAd1lBZqcAD1IGilDEoZTQDho5WztMjoE63I0yiPbBWWi4swaTybAsFZassqhttltTyTCVuTi1YEUqfDkxiqjM0J5igHPWyiXSiSiQoclBXJepFezDecGpzCyroWJuSMqyQSRCMWHX2tyU5EIgyWJVPCl1/M7AykS4ehrrRxJkQZXUyJ8VlCJIp2JMK1YxAeGIZom2TT8OsvIewj2lkyEgHUoyASVRad2QMAodcFCa+ZHqP132v88gFuaLkxb10V+l+VK/U7TZxrtos2JVUaqsZI16h0Glxc2Qv39Zj9iSWBH0W4olJNHFbowXXtwO1DE65/59ieXs57nZf3y7MMiAruQ/OBB29yCKjGnx8D6YHM74MuXTj8zUmcklaMswBzoRmHvqYxFyc11bKL5/hJpn+W3lhDeWrkrGll79K86/qiaWL2zy+0HsVzzbV8x0Xk+Pzk+5n/r+D7dikQUhDLS2KxpEvFy270hSlCmqgMsaG+L4AsWzKwJTHbpTGBV6Y54+l88K5qtAF76ciXIOeu6VMTPpyvmr5O5c3b4hTLm0coxTwfVuraUXsZBmUB5REl3WFaaRPry+LjZov5e7FZExJstjjf8l2yWoOnS9o3kvdD81Mb0fxqagQnkDGrgbkoOopmNGDWJ8JTVToWpSK/YLcy5sQpuu9CRALtbUigst+acorcYCpGKfteo+0wZRx2xiES0Frd16FMqbQdIJKJ2WqSiCKHyab8vqbRHWKmeyh2a0FO2Pz4R96v7PGDOBLZDjW+Pt2i6Xnp7zklvc/W67YXLoC+aY2SJNlxLmljjMbEZ9HkjXu//PbgoCMao60XnulnTcwOtGShrH2BIUDkaqTuSMFGhgJsWI9zAgbGB2objUOkYhgozOkyAenlvQ20KneCrqa0dR+TolqY/3/REk4g3hI4c32ffh/Hbr9aVGEQqfvvj4r5vBnB1zuk8Wbb2JHJt91QBzcpRK5K0yFelK6fGmE1Boi+GFp3kdqlMAsza84HK2bI1JTmmYQqVs2PF8eq0rHbcHpyTkaACD6ib8WidhldRMQei43LObBsCsahtflDcXYQyIzsnEswikVCJih+dr6vKuvDL4qGtjDzvlz+tv9Dl5XtFuxCCg7///OuQB3SE8wlJ5YvN8dtIGJNTo+6RQVeMi+D0YBB4vPfgSY+OvB2TI5WbRRiTTh6HmiBzFH9G7RMe9VWuAmqYoNYUojFvtZJQWQmBssJYThT5BMjgULcLgqEJaBqT5sQw4UVWxKHSnDVWgnWwJQa+ntmy0gpNRu0rj+45ymsd/fG8NSCMaq25nqQKEWeJxpDjxGmVkfGRYue1WWFWEJz0ju/FfDKZ9DAe96zL+52s738YvH338fzdEcs0iQgq6LXkAVe0tFnNa8K85pnc2nydHJ+87P3Ye8GylfWhRLOChxeYLUOXXOf6RX/6ry5nXT0Eugv9SqMy7G0M76zrBFfzlY29W+0F14korA98YzYboueptmn453b6ih1Cec7scrraGZ+Ds65DH8KuVW8r1lvm9y0bX2RkkYq2yTwaxsPb3h4U60vfUxHs2ff22Z53tiea3bXx7TG5sfg90fBK4h+5/u2BtG0LfCKup2yAj0W2sQg+P3KPWAcfqJ4dW+FTH/G2jXAPgm4xfKK1B3fCfXWzezVcornmLy42U56lm/mkHTmu1cPEUYUVqXv7SLM6a79/dyGa5h+CSeJF
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data sharing UI</h1>

<MethodEndpoint method={"get"} path={"/service/data-sharing"}></MethodEndpoint>



This endpoint is used to render the data sharing UI during a data exchange as defined by a (data source) organisation in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"ID for data agreement","in":"query","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Access token for authentication","in":"query","name":"accessToken","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"API key for authorisation","in":"query","name":"apiKey","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"ID for the individual","in":"query","name":"individualId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Name of the third-party organisation","in":"query","name":"thirdPartyOrgName","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"URL for the third-party organisation's logo image","in":"query","name":"thirdPartyOrgLogoImageUrl","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Redirect URL for data sharing UI","in":"query","name":"dataSharingUiRedirectUrl","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Authorization Code","in":"query","name":"code","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Redirect URL for authorisation","in":"query","name":"authorisationRedirectUrl","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Ok

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read IdP details
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-read-idp

---
id: service-read-idp
title: "Read IdP details"
description: "This endpoint is used to read the IdP details configured by the organisation in the consent building block."
sidebar_label: "Read IdP details"
hide_title: true
hide_table_of_contents: true
api: eJzdVs1uGzcQfpUBTwmwlhw3vQhB0SROA7VFYcQ2ejAMeLQc7U7MJRmSK1s19tYn6aP1SYrhrqS1pKDIpYeetCLn95vhN/OkNMUysE/srJqpq5ojkNXesU3AEdpIGpKDQKgh1QRzfQGaErKJUDq75KoNpGGxzrcuVGg5opgDtvmsdDaSTbBo2Wi2FSyMK+8nqlDOU8iic61mKlJYcUmfCPVce1UojwEbShSimt087UV6bflLSzA/B7cEtOAWn6lMqlAstx5TrQplsSE1U6z9XKtCBfrSciCtZim0VKhY1tSgmj2ptPYiGFNgW6muuxXh6CXyKPdnp6fyUzqbyCb5RO8Nlzn66ecoIT2N7PkguSXutVn7kZNtpI8n1qUTticaEy4wkpot0UQaB3qjWCI3rnJtug5GFao0TDbNtbotDvwc5lKopQsNJjVTqlD0iI031P95Duj8/ALm56obOzti7bnSr1kURLYbRfaveu+zZPbXdV2xB00+2otOX0CgFJhWpCG2ZUkxLltj1qpQNaHOXfIkiq/7Wj3XX6AGtr5NsO2qI4qvvqnI4ypRCC68d5oEZPk+H7m/3U9wv3A77R1ybBNVOcpt0V6fnnZHzB9Be1fnd0cS77ojCF9bbFPtAv9B+gCa77+x//9f0MxtomDRgFAUBchu9jDqChWpbAOntZrdSFpYCW+puSabOK3hIrgVawqSc0OpdkJ6FeWUha5majpQ4JS1nzpP9iQ//t7rMRI8p8YNQalCtfJiVZ2Sj7PpVFPjTtDzhKuANk3YTVdnqiv2bVwmrISVv2Im9tdHLN3uMr6Uwvf1euv5F1qPgMf+YCDmHrIdNb8dei430gFNvL2Ywz2tQTpTUOz7bQJXNcEKTUtC/jJj7p7ZuYPeDTRtTLAg8IGW/EgaHjjVcNfHCHfwwrpE2UAKyCbD4LGklwXQpJrsmZ3BoPhm7dogiJzc0/qHu4lw3zvCQEHkJfdF/vfThnl//v3qMDcLmFkMkrsnu8mEreYV6xZNAUsXYGhXGXG7q16l6CMfa/vAKyzXoDHWC4dBg3EV2wJcABxEl8E1vatNZ/qhMzdWxlN8ApdkNXACjAd49EnDm2xYgBhmqlS2h0Bt37c0lJJnwnbpNmSCZSYTapCl6WLrvQvpx22jjWb4x93R8w7dCR883K0SvPj7z79eykKDcPlAmmMNMnWBHssabSX4alhR4OXQZDC8xS04E5gnWYciRDLLk+hWFIgru4WxGPRxYQjKQPkYTSwAQXPFCQ08oDGUsrPoDGvwTkOisrZOCkWxALK4yJ2IYOkBDK3ISGGE9DIz4oKNVE2MYJtcg0nES9d4w2hL6rs8pxeoak3OJ8o6hpBHJmCrOeU4G7SWghTOcEk2ZprdvE2PZU1wNjk9wPzh4WGC+XriQjUddOP01/n7D79dfjgRHRnrnMyz4oG8aO3KtiGbNm9eyK2v19np2evJd5NXoutdTA3aUTyyGY73z/0nNZpP//EiO7R4osc09QbZSgJtv0D13H6zWW+FCPN2u+H320LVLiYReXqSLfA6mK6T4y8thWGYrDDkvupnAEf51tt18asovPg0zOGX8NV9+WjsG+62QtyZafuV8V6ofdinu9tuMwJzWP3d27Ikn0ZaB4tCN55/Hz9cqa77B0MZW0M=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read IdP details</h1>

<MethodEndpoint method={"get"} path={"/service/idp/open-id"}></MethodEndpoint>



This endpoint is used to read the IdP details configured by the organisation in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"idpId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

IdP retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idp</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"IDP ID"}}></SchemaItem><SchemaItem collapsible={false} name={"logoutUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Logout Url"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client ID"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"idp\": {\n    \"id\": \"\",\n    \"logoutUrl\": \"string\",\n    \"clientId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read consent record
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-read-individual-record-read

---
id: service-read-individual-record-read
title: "Read consent record"
description: "This endpoint is used to read a consent record for an individial for a chosen data agreement. There should be one unambiguous consent record for an individual."
sidebar_label: "Read consent record"
hide_title: true
hide_table_of_contents: true
api: eJzdWNty3LgR/ZUuvESq4nBk2d7NTrk2kSzvZuItryPJSaq8qnIP2SSxIgEaAEeaqOZtvySfli9JNcDbcEaOnLdEDxJFoht9Od2ngQeRkk2MrJ3USizEdSEtkEprLZUDaaGxlILTYAhTQEi0sqQcGEq0SSHTBlCBVKlcy1RiGd5AUmhLClJ0CJgbooqUi+G6IENgC92UKawItCJoFFYrmTe6sV/W3mAZi0jomgyytctULIQls5YJXRKmy37ZpRfndyISNRqsyJGxYvHxYeLuByU/NwTLC9AZb6VXv1LiRCQkf63RFSISCisSC8HOnHW+LFm1oc+NNJSKhTMNRcImBVUoFg/CbWoWsc5IlYvtNnoIGgvClMyg8++z18Hl8/PZYP/XKY8mPg16YHkhtjesyta8jWXp05MT/pNo5Ug5fsS6LmXiYzr/1bKOh9FuteGIOxmk2wyFCI+M6QPnpCv5xeudhVMbz6appvvakLU0YOAILaSUSUUpSAWOgblqZJlKlcOq1Mnt7yzYmhKZtcYfM04RrFR5SXAxTlcHvaqxjoGH8OHd8i8f3vjdnEEGu1ZwtAtYMLSWVmoVjTB4LCJxP1PazaSa8foVWhKLDEtL46x9FJL97pVdtrr+hJZBZR06EjfRJL4y3c9wJDJtKnRiIUQk6B6r2of4m5cvvn12enpKv0++TZ6vVs+T0+S7706e7UX7Z58cCxVu2PkaLRf1CpNbWG3A6org7P2yL3sLd9IVunFcEcsLOHr/9jiClJR2HHtXoANX0AbQcCR/EanBzP0iIpAxxYCwk/uwXlpQ2sGGHFinTZdTgi6CgCoFrcoN0L20zn82qKx0MVyw/l2tFlLtNRa4ZiMu+0ytGgcygxo5DdDU3hlAuJK5QtcYigBhjaVMe6FRR8pJcXuhNPaFNSn5A6m5n2W3s0qnVIqF2MHcXhquiwkqGa93hUyKHvQFWlgRKcjlmtSeCZ3BTzClW3rQit5xnfVJGMH+SzaB04+a5aH9ZPjis9Vp8jx9QS+zb+I43jP0ta43nYFdIbIxhS9m/8Sw4s9SJWWTDqCyXa49qkjZxpAFzFEq68BhVRObFqDBAtrIXCosR2TFXspxS/5PER/67sGYj9ryXaF9VNlMZldubbv9kDfXtVuq0a4rrUtC9Vg8A0tM9jUNLXy0Bk/8zrW20sk1lRvQtfOBi+EHbmEHl9M9M4R05QYsyhSUhiNtfPhSg3cKEGpO0YjDj30AQ5d7MiRCQA6Gz2uCTFKZ7o4lvseEr0mBKudEZ47MzBU0yzBxMSx9/6m4y6Pnk9XGZ73tKHB+DtJZKrMY/uobg1dnF9CoYNG8JuV5p9JmhC477w0m1VTc8zsJ7vDh4WYbHr3EE2DU96kDpDng2jdVLgF2tyy9O2ssG7JdyUwIlgthhDnpBvDfUl9nS8VjXINlBBXessfSwZqMzCSuylBOoXxmtdE6i+H6/GIBl1R6Bg4E3HsAYYr4g0cCJU6b94YyMqSSwHZtINAY3PDQ5aiyh4aK3Ti0pE+h9muvknt92AJScihL+2SaDmIiEqUOc8Q+K7dLnozjPZPfYUVdjFtlX6zwXekLPwbZzkFp+6IFbZgFfa+yP6F1H+qU2esrlB6YuX1DGjYr0TpoWsXb8BNNcuRfTfv3nuJRWzHkjKQ1p61JErI2a8qSQRBGZA47q3wRptVdzStk3+vGQT/cHxB89lVj7hgRZIw2r3XKJeifL0bb30xdn4JlkB6SIJWj3FvZg+TFycn2gPoDGBtwdX7A8TYd03MNNq7QRv7Dt6Ld0Lz8yhPA/1dolsqRYarnoyMZ8NtMYhT6VWOk2/hD41kt3xI/3vBJ7pzQkDlrXOHfsNeY8+myh3x76rmJREWu0HxQzcmHg0+UCzFvj63zoSDmoUzm3Kpm/RQyf5iMoFsmFm/4oePsBVW69UtEojHMJ4VztV3M5ylVeoa1jGVuULlY6vn6VLA/uzquHObc+B9RY8PnA5puhqBdMXZCyrvQDc0+vIgOH4jPWtiGRrzHgO+Xnq0Y3KRcC9kwD3r263rspx09nyBs0x//mDPkPaWBAz8FG+ETHCntyCvgM2Hpw1BjQscRUJzHE7ULaAVfbXRjOCKzW9p8/8lPPmOQPIiV/++Hjiz+/Lfrfd8UoG+E4PQt9aP5gJDIt9AW8bv3IkEkCpaPpWsj15hsIEVbrDSaFEqdSxWBv6UJSzOjq7BVyjF1G6iNXkuOV6tFmxyVtG2wr0j5+QHtXjyC0/DKK+ZAtNcWnof8N9G3CAYU34wIqTLd9SNMfD+iCiWDzjZ1rY37Yw+0ASjyx+HVLkKHxXu13wvB0b9+++cxkxvC1R2l0hbhEET3YYj0k04YfALIoC3ZPjh+rGysp+Uym1m9JkMyV30Yo/HglBjyr7G0fP5MZS4dnwSwLMn5zazmybPWKThKCqU5UWQjIIUrj0QERXdQ0ppKTgz3Td9ccSVLzhorwcbpCv0xPdFVXUpUCQWUe/cM5U0Y1SxPDwiedQGbVDpvZ4VKkeHElTIhZX2n7mqzxqQgOI1P9mJ+d3cXo/8ca5PPW1k7/2n5+s27qzczltkOl0NDHriiU5003N26mufmFvJ1enL6In4eP2PZWltXoRrZwxd803PTJOMjlvsfuNpsK8PRvZvXJUp/AeAD/dAyx8fuwlOMD6f+trBzf4c/RCQW00uMm0gU2jpW9vDAU/EHU263/PpzQ8azXCTWaDxwA8lIy89pPz4/GuOjy3ZWOIZHr1YPetmRg2Jm8K08jNG3zB179zBbPlS11PFfG7h7T/qIXWH/L1zT9rYyk4bVZ0lCtRt92xuvtuPJ4Mc3TAbYMsXAkreeJdsH9vJgjKaEGUzg32zQQZFXXHRvafN9vzx8eVSgJ+mwmiNzs91u/w0o03eT
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read consent record</h1>

<MethodEndpoint method={"get"} path={"/service/individual/record/data-agreement/{dataAgreementId}"}></MethodEndpoint>



This endpoint is used to read a consent record for an individial for a chosen data agreement. There should be one unambiguous consent record for an individual.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent record for individual retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecord\": {\n    \"id\": \"65471222e8c7c3bb3c2c9901\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n    \"individualId\": \"string\",\n    \"optIn\": true,\n    \"state\": \"signed\",\n    \"signatureId\": \"string\",\n    \"sectorPreferences\": [\n      {\n        \"sector\": \"\",\n        \"optIn\": true,\n        \"isLastUpdated\": true\n      }\n    ]\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read organisation cover image
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-read-organisation-cover-image

---
id: service-read-organisation-cover-image
title: "Read organisation cover image"
description: "This endpoint is used to retrieve the existing cover image for the organisation. The cover image is used to display in the privacy dashboard."
sidebar_label: "Read organisation cover image"
hide_title: true
hide_table_of_contents: true
api: eJzlVsFu3DYQ/ZUBTwkgazduehGCoo6TBm6LNqgd9GAY8Kw4K01MkQxJ7Xq70K1f0k/rlxRDaW15nd4LdC8rkZwZzps3b7RXmnygGhNpVa3RRCqUplgH9omdVZW6ajkCWe0d2wQcoY+kITkIlALThiC1BHTPMbFtoHYbCsAdNgRrF/KmCw1ajigeS7hq6cmpmUvN0RvcAdts5wNvsN6BxtiuHAZdqkI5TyF7utCqUpHChmv6jVD/OotyLv4vxL0qVKDonY0UVbVXp8ul/LWEmoKsDEOhXi9fyWLtbCKb5BG9N1xnX4vPUYDYq1i31KE8BfrScxDIrhWF4MK50xIpP7+bwXdTqLTzpCrlVp+pTqpQPkgGicfrPFpX+8NRtokaCuLvHjtvSFWvl8vhK+4fbWIKbJu5iXqLGtj6PoHHgB0lCmqQ33GFP1nsU+sC/0FaFUfQfDvi9T+F5sImChYNCM8oQA5zhNFQqEh1HzjtVHUtaWETJf05ISXdjlLrhLQN5WwxtapSi4nCi3mXLHKD8ETgMbj43B/d7x11brqbKlQfjKpUm5KP1WKhqXMn6LnkJqBNJbvF5lQNxbGPy4SNdO6/uInj9lc83Twmfin1H8t25vkn2s3wx3GhUCzRRuRUoSx2sns2UW9E6Rj/s48XcEc7EIKSTRPtRg3ZoOkJ3DpLxe0TP7cwhoGujwlWoiS05nvSsOXUwu14R7iFF9alUcBSQDYZBo81vSyAyqY8clvBZPhm5/ogiJzc0e6721INhXpLGCjIecl9ld9+cKHDpCr14+9Xz3OzgHVNMUJyd2QPmbDVvGHdoymygE6sBbSzrdGkGG8+t34mmWBcw7YAFwCno+vgujGUFkzTDnxwGxa8Ji9PBfuSrAZOgPEZHmPS8CY7FiCKUQqksiME6qHNhVBKuoXt2h00BeusKdQhC+li770L6fsHoj0ShT88Lj1l6OPhZ/37YAQv/v7zr5cyaxAut6Q5tqAxIdB93aJtBF8N0nPriWQw9eUDOCVcJJlUESKZ9UmUDiVu7AOMxWSPK0NQB8rLaGIBCJobTmhgi8ZQysGiM6zBOw2J6tY6KRTFAsjiKjMRwdIWDG3ISGFE+7JA4oqNVE2cYJ9ch9Pk7bxhtDWNLM/pBWp6k/OJMlUR1r0x0k+aU75nh9ZSkMIZrsnGrLaH3vRYtwSn5fIZ5tvttsS8XbrQLCbbuPj54vz9L5fvT8RmKFTiZJ4UD6Sjtav7jmw69LyI21iv0+Xp6/Kb8pXYehdTh3Z2H5nyT7g5/4447q/ZzPrPfcNMHZHoPi28QbaSbwZ4P42F68OXjXzxzOdIoWaj4aZQrYtJju/3K4z0KZhhkOUvPYVpHG0wZErK23AYXXmW3IlOq7O6Ji8DKQtqFuyjAT/Mh9eH91dqGP4BV1uZog==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read organisation cover image</h1>

<MethodEndpoint method={"get"} path={"/service/organisation/coverimage"}></MethodEndpoint>



This endpoint is used to retrieve the existing cover image for the organisation. The cover image is used to display in the privacy dashboard.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div></div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read organisation image
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-read-organisation-image

---
id: service-read-organisation-image
title: "Read organisation image"
description: "This endpoint is used to read an organisation image as defined in the consent building block."
sidebar_label: "Read organisation image"
hide_title: true
hide_table_of_contents: true
api: eJzlVsGO2zYQ/ZUBTwmglZ1tehGCoptkG7gt2qC7QQ+LADsWx9JkKZIhKXtdQ7d+ST+tX1IMJa+93u2xp/piieQMZ968eaOd0uQD1ZhIq2qFJlKhNMU6sE/srKrUdcsRyGrv2CbgCH0kDclBINSAFlxo0HJEOQ/cYUOAETSt2JIGtpBagtrZSDbBsmej2TawNK6+K1WhnKeQbRdaVSpSWHNNvxHqX4/8LsStKlSg6MVTVNVOnc/n8tcSagqyMgyFej1/JYu1s4lskkf03nCd3cy+RMlpp2LdUofyFOhrz0Gyv1EUggvvnJab8vP7IyQ+FyptPalKueUXqpMqlA8SfOIxnIN1tdsfZZuooSD+7rHzhlT1ej4fnnF/sIkpsG2OTdRbFCB9n8BjwI4SBTXI77RYnyz2qXWB/yCtihNovh3x+p9Cs7CJgkUDQjEKkK85wWgoVKS6D5y2qrqRtLCJkv4xFyXdjlLrhK8N5WwxtapSs4m9s9wFs13+W+hBFWq8VHztTuJ6T52bYlKF6oNRlWpT8rGazTR17gw9l9wEtKlkN1ufq6E49XGVsJGm+hc3cdx+xtPnQ8JXUvexXBeef6LtEe44LhSK5bYRMVUoi53sXkyUG9E5xf3i4wLuaAtCTLJpolsJ1y3BGk1P4FZZIm4f+bmF8Rro+phgSeADrfieNGw4tXA7xgi38MK6RNlBCsgmw+CxppcFUNmUJ24rmAzfbF0fBJGzO9p+d1uqoVBvCQMFOS+5L/PbDy50mFSlfvz9+mluFrCuKUZI7o7sPhO2mtesezQFrFyAia0iloet0aQYIz+29oHXWG9BY2yXDoMG4xq2BbgAOB1dBdeNV2nBNG3BB7dmwWvycqzKJVyR1cBJhPkUjzFpeJMdCxDFKAFS2REC9dDeQiglXcJ25fZagnXWEuqQhXSx996F9P0D0Q5E4Q+HpccMPRx+0rcPRvDi7z//eikTCOFqQ5pjCxoTAt3XLVoZO1bDmgKvJpLB1I8P4JSwSDK/IkQyq7Po1hSIG/sAYzHZ49IQ1IHyMppYAILmhhMa2KAxlPJl0RnW4J2GRHVrnRSKYgFkcZmZiGBpA4bWZKQwonlZGHHJRqomTrBPrsMkx2vXecNoaxpZntML1PQm5xNlmiKsemOknzSnHGeH1lKQwhmuycassvve9Fi3BOfl/Anmm82mxLxdutDMJts4+3nx7vKXq8szsRkKlTiZR8UD6Wjt6r4jm/Y9L+I21ut8fv66/KZ8JbbexdShPYpHBvszXwynnXU0pf7zD5CJ24nu08wbZCuRZ6h2k7Df7D9LRAGncKtJ3GUatC4mObXbLTHSp2CGQZa/9hSmObLGkDklb8N+5uRhcCdCqy7qmrxMkqyIWXFPJvNwPHU+XF6rYfgHl2Np8g==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read organisation image</h1>

<MethodEndpoint method={"get"} path={"/service/image/{imageId}"}></MethodEndpoint>



This endpoint is used to read an organisation image as defined in the consent building block.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div></div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read organisation logo image
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-read-organisation-logo-image

---
id: service-read-organisation-logo-image
title: "Read organisation logo image"
description: "Read organisation logo image This endpoint is used to retrieve the existing logo image for the organisation. The logo image is used to display in the privacy dashboard as well in data sharing UIs."
sidebar_label: "Read organisation logo image"
hide_title: true
hide_table_of_contents: true
api: eJzlVsFuGzcQ/ZUBTwmwlhQ3vSyCok7iBmqDNqgd9BAY8Gg52p2YSzIkV7Iq7K1f0k/rlxTDXVlrOe0HtL54RXJmOG/evOFeafKBKkykVblGE6lQmmIV2Cd2VpXqV0INLtRoOaKsgXG1A26xJrhuOAJZ7R3bBByhi6QhOQiUAtOGIDUEdM8xsa2nlmsX8t7U8wyuG5oemjjUHL3BHbDNZj7wBqsdaIzNymHQgBG2ZIwc0JgQYoNBYn5cxpkqlPMUcpClVqWKFDZckeT2y+QC713tlhJZFSpQ9M5Giqrcq/PFQv41hJqCrPR9oV4uXshi5Wwim+QTvTdcZVfzz1Hg26tYNdSifAX60nEQoD8pCsGFN05LpPz9dgL6TaHSzpMqlVt9piqpQvkgCSQernO0LveHo2wT1RTE3z223pAqXy4W/VfcH21iEoimJuo1amDruwQeA7aUKKhe/k558dFilxoX+HfSqjiB5tsBr/8pNEubKFg0IDSjADnMCUZ9oSJVXeC0U+UnSQvrKOlP+SjptpQaJ5ytKWeLqVGlmo8Mnk/7Zy6twyN/h9jicn9yvbfUuvFqqlBdMKpUTUo+lvO5ptadoecZ1wFtmrGbb85VX5z6uEpYS3f9g5s4bH/F080x7ysp/1C1C88/0W4CPw4LhWKJNgCnCmWxld2LkXkDSKfwX3xYwh3tQPhJNo2sG8Rlg6YjcOssIreP/NzCEAbaLiZYicbQmu9Jw5ZTA7fDHeEWnlmXBmFLAdlkGDxW9LwAmtWzE7cljIavdq4LgsjZHe2+u52pvlCvCQMFOS+5r/KvH1xoMalS/fjb9dPcLGBVUYyQ3B3ZQyZsNW9Yd2iKrKwjaQHtZGswKYabT62fiqlxNdsCXAAcj66Da4dQWjBNO/DBbVjwGr08VvIrsho4iSyf4jEkDa+yYwGiGJRAKjtAoB66XAilpFnYrt1BUrDKkkItspAudt67kL5/INqRKPzuuPSYocfDT9r3wQie/fXHn89lCiFcbUlzbIbZQvdVg7YWfDVsKPB6JBmMbfkAzgyWSWZYhEhmfRbdhgJxbR9gLEZ7XBmCKlBeRhMLQNBcc0IDWzSGUg4WnWEN3mlIVDXWSaEoFkAWV5mJCJa2YGhDRgoj0pf1EVdspGriBLvkWswTuXKtN4y2ooHlOb1AdWdyPlHGKcK6M0b6SXPK92zRWgpSOMMV2ZjF9tCbHquG4Hy2eIL5drudYd6euVDPR9s4f798c/nz1eWZ2PSFSpzMo+KBdLR2VdeSTYeeF3Eb6nW+OH85+2b2Qmy9i6lFO7nPv71fTttrMrH+K++esY8S3ae5N8hWUMpl2Y+z5NPhNSSvpOnwKdRxntwUqnExyen9foWRPgbT97L8paMwjrANhsxj+dUfxl0eQHci7uqiqsjLEMsqnFX+5FHQTwfeu8tr1fd/A/BPvxo=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read organisation logo image</h1>

<MethodEndpoint method={"get"} path={"/service/organisation/logoimage"}></MethodEndpoint>



Read organisation logo image This endpoint is used to retrieve the existing logo image for the organisation. The logo image is used to display in the privacy dashboard as well in data sharing UIs.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div></div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read organisation
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-read-organisation

---
id: service-read-organisation
title: "Read organisation"
description: "This endpoint is used to read the organisation information as configured by the organisation in the consent building block. This is used, for e.g., in the privacy dashboard."
sidebar_label: "Read organisation"
hide_title: true
hide_table_of_contents: true
api: eJzdWM1u20YQfpXBnhKAlhw3vRBBUSd2AzVBasQxcggMeMQdURsvd5ndpWTF4K1P0kfrkxSzS0kUpcBOCxRofbEozv/fN6N7Ial2VGAgKfIZak+ZkOQLp+qgrBG5+DBXHsjI2ioTQHloPEkIFhyhhDAnsK5EozwyAygzs65Kn9FDYc1MlY0jCdPVIer4XWGNJxNg2igtlSlhqm1xO4Kou1OZwcw6oFE5ytZstVMLLFYg0c+nFp0ciUzYmlwUPpEiF57cQhX0nlD+1lMsMlGjw4oCOS/yT/cDp6+M+tIQTM7AzgDNjtEiE4pp5oSSnMiEwYpELhLN17XuTDj60ijHgQ2uoUz4Yk4VivxehFXNHD44ZUrRttdM7GuOguf3J8fH/K+wJpAJ/BHrWqsiyh5/9mzjfU9e7djroBL3jrH5vVCBqvgCtf5tFr3tDLDTz1SEHVM/JXcyoW2xdrcfm0zUVqtideW0yAQ2YU4mdJaJ62xgipL77g4LrJ8XmJyJdh3RhxjfYUWcn2FVsYQdygctWHCV0DJW2CFpnopg3cOCLhNd24vegzxv15RtP7QPsl1EUmDadi8P+X6Gd7lPd+ihojC3ctutmx7ZSWaN3i+tk4fE71KSwammPuHUWk1oRNu2mbBKFhedME3e/yOBHOtSmQtHPEKi5Wc0U0atZ8BDkZycbfJe94SA3EjhaTelNPiYNCqEBTk1U9vkaWVulSn/VUOSyshyfnU2gY+oNYVBRVj3ypHkB9R/26JiI6JvzxoLlPcNRTr12qEJI2XhtG9Bj59rgP+y/aQHFTQNRsL5XXDo9yqisAtykwpLeowjr5gaFJN3I2bL/6h26wtoUs9pW9pHG/DWlnZH/4b7Uep77FF7217HTurP7Z2hdZ0NghvJB2Pvjcg6FOOQMsHz42ffBTx9/eScda+sZPCIn8962vbs2evwDfc2GMoEKiPE0h1WNZfG8+Pj9oD4AwHcsIiXKEGZugmwwfxUg8OAXBnuGuvUV5J7ofnxOzH5/xWaiQnkDGrghYocRDWDGCWgbJwKK5F/Yrew5OVqp53Z3QQ3IhclRW8xzEUuxt2uNh4sW0njoS3tjCrbGSQywY2Ri3kItc/HY0mVPcJajVTZDaTx4kTw0BlAdsCSR+g3xPj0+oCk6623l5z0lKvTWr2hVS/omL74xs542tXboU0rF6cXE7ilFeyiO6/FBAvUzWb7udmRcwNJDVSND4wXtaOZuiMJSxXmcJNshBt4YmxIUzs4VDqGocaCnmZxzx6IzaFjfLGyjeOIHN3S6qebEY+zl4SOHNOz79P49Es8BEQufv34Yd83A1gU5D0Ee0tm7YkyUi2UbFB3+34qVd7Bt68SS5Ys73PvHQQJqjOwDrAjnTlbJVURj8IKamcXiuN1YJccwSUZCSrwMTOMR3IaXkTBHIhux4/7SXwnNr3NBSW4RfhAWg8SLOIgoQoVF51v6tq68POm0LaFsoHVvQrdEu817RaLn/z5+x9P+ZJCuFySVH4OEgMC3RVzNCXHV+4sNNA14yY4I5gEhnsPnvTsyDMekirNJoxZx8+LWg/tfQYIUpUqoIZlXE+iMm+1klBbCYGKubGcKPIZxE2PKxHB0BI0LUhzYnjgxamIU6U5aywEm2D51jQlFLaqtUJTUKry6J6jstHRH883I8Ks0Zr7SaoQ7azQGHKcOK0KMj6O2HVv1ljMCU5Gx3sxXy6XI4yvR9aV447Xj99OXp2/uzw/Yp52u870dqKLCUhbNNV6uROZ4OGW8nVyfPJ89MPoWToFfKjQ9OzhG3Z4iA7OnA04/eeu9q5LAt2Fca1RxY26SatRwodP61ueb/wBoMytD0xxfz9FzxtV2/LXXxpyHRQt0MXK5Kd2DVsJUpTvbotDP3/0Y/rkfQfpT+GB3wcOenPLuLD/K0Ec5CIXEZsSzWlRUB167/Y2jbaPoq/PP4i2/Qv1Q0dr
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read organisation</h1>

<MethodEndpoint method={"get"} path={"/service/organisation"}></MethodEndpoint>



This endpoint is used to read the organisation information as configured by the organisation in the consent building block. This is used, for e.g., in the privacy dashboard.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an organisation","in":"header","name":"organizationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"organisation"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"items":{"allOf":[{"type":"object","required":["name","location","description","policyUrl","authentication"],"properties":{"id":{"type":"string","description":"Organisation ID"},"name":{"type":"string","description":"Name of the organisation"},"description":{"type":"string","description":"Overview for the organisation"},"sector":{"type":"string","description":"Sector"},"location":{"type":"string","description":"Location"},"policyUrl":{"type":"string","description":"Policy Url"},"authentication":{"type":"object","description":"Authentication methods configuration","properties":{"password":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"oidcPasswordless":{"type":"object","properties":{"enabled":{"type":"boolean"},"loginPresentationDefinitionId":{"type":"string","description":"ID for the presentation definition to be used for login verification"},"linkingPresentationDefinitionId":{"type":"string","description":"ID for the presentation definition to be used for linking the EUDI Wallet"},"authenticatorCredentialDefinitionId":{"type":"string","description":"ID for the credential definition used to issue the iGrant.io Authenticator credential"}}}}}}},{"type":"object","title":"OrganisationExtras","properties":{"coverImageId":{"type":"string","description":"Cover image ID"},"coverImageUrl":{"type":"string","description":"Cover image url"},"logoImageId":{"type":"string","description":"Logo image ID"},"logoImageUrl":{"type":"string","description":"Logo image url"}}}]}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"organisation\": [\n    {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"description\": \"string\",\n      \"sector\": \"string\",\n      \"location\": \"string\",\n      \"policyUrl\": \"string\",\n      \"authentication\": {\n        \"password\": {\n          \"enabled\": true\n        },\n        \"oidcPasswordless\": {\n          \"enabled\": true,\n          \"loginPresentationDefinitionId\": \"string\",\n          \"linkingPresentationDefinitionId\": \"string\",\n          \"authenticatorCredentialDefinitionId\": \"string\"\n        }\n      },\n      \"coverImageId\": \"string\",\n      \"coverImageUrl\": \"string\",\n      \"logoImageId\": \"string\",\n      \"logoImageUrl\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update consent record signature
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-update-individual-consent-record-signature

---
id: service-update-individual-consent-record-signature
title: "Update consent record signature"
description: "This endpoint is used to update a signature object for the consent record for an individual in an organiation defined in the consent building block."
sidebar_label: "Update consent record signature"
hide_title: true
hide_table_of_contents: true
api: eJztW21z47YR/is7+HK+GYqWfedLo8lkap/vEjlvru3rdRLfzEHkSkRMAgwAWmY8+tZf0p/WX9JZAHyRRF2dNB86rb54ZOJtd7F4dvch+MhSNIkWpRVKsgm7yYQBlGmphLQgDFQGU7AKqjLlFoGDEQvJbaUR1OxnTCzMlQabISRKGpQWNCZKp+4xlyBkKu5FWvEchKQHSi+4FJzWgxTnQmJKLf0ZZpXIUyEXMMtVcheziKkStRsyTdmEGdT3IsF3TqRpu8BrP/zKrX/diMkiVnLNC7SoDZv89Lih8TspfqkQpueg5k4+pxWLmKDWktuMRUzyAtmEJf0VpimLmMZfKqExZROrK4yYSTIsOJs8MluXNMRYLeSCrVbRo58xQ56i7ub82yjIfXY26nT5bZNHGzp188D0nK0++KnQ2DOV1jQ+UdKitPSTl2UuEmfcw58NDX/sLVRqMr0VaNzz1qidDK29rLA5Pehbfl2sU1igRC2SnhORJFxIAxwSXZdWLTQvM5FAxk1GW2JUgXDP8wojAKsWaDPUsBQ2W3PGRCO3mMKs9iNKLe7JYe+w9o6n3DhTG4tFDHAVbOumIF8r0GYqNRO4wnthyDuDfzs/9qOvN3w/vpUsYg8jqexIyFHKLZ9xg2wy57nB/gb+xEpe54rTtpqege5Ri3kw/3dOgo2Hl+2wgadfc5NttJCImJ7VbkMKNJYXJfsQbWykSLe9KGJzpQtu2YSxiOEDL0q3n69OXn52dHx8jH9KPktezGYvkuPk5GR8tLW9PzibGCh4DTOEkhvCjhlP7tpdOb2ctuhi3CaqyjqYSOHg8pvnEaQolaX9sBm3hAo1cE24c8tSzef2lkUgYoyB93bD9RUGpLJQowVjle5gpdkW4DIFJfMa8EEYa1y75tIIG9MZanboyZZ5jON4tWWGmwxhLiTPIUzYimfc3kQO56yuEvJXTp5/cf3D92BQC54L46FRzWEuME8NPA5s/ATiOI5gh0sMtHrfGmg41VbMeWIHmhpXGmi6WJqvHY5F0HpZ6OaVfO+31rvEFc5Ro0wwdPGH56Yu1x+sd1vFcB0ssmamVCQ2huncbW13/oXx4OJBAOeKnEbWNiNfItsPu8QB+UTmZnfuZzP0PTZEApOpKqeZQRXC0iJzrQrXtdnmWWVhLvLcL8PnFvWS69Q45xqCzn/jXlhfZLOvEvGDuHj745urm79cX3wex/GWw/VQad4KQ/Dp1AE/ObWtW6zTyJSYiLnw6InCQd228xAQDvoAqTeAY0/W8016fHJy9HmrxvH4eDwQO5aY56M7qZYS/IQdViwzkWQBwZukJYa/8lykPnSYCdycncfg0ptCLDJLeuNDyWWKqY8mpipLpWln+8o0cYHGosYG3DgUQoqC52DQ2bYbHQaAxASN4bqONw10+ccAzVRa1JLned1zfdOdmXvUJkBJ4/OgG4d2e90dRI+NGz4/cv7wYDVPnJmpTzO/h2gU2s/LjTudOzR1cerJ2vKj2XHyIn2JJ/NXQ/4+qPdw8kB6OwegFHaGLQK7CNI1qvkQlG4q00Dl0zUZ8OI13+JhxgaWaBaXhoJJuKTM2G9JBKLgC4x6pxdtsilfG/qfLF8q0skd1pNfX313Nx8y9RkmvHKRE0SK0hJK6GcUOf2E7oDwGpKMywWCukftAoJDHo/KHCT6EsJBcAiGvfE+zLth7iD5fCyGaSgKCKadTda3uDUFrSWMj5YNqIWs0icdneSuKMmVuiPvrcoW0ergzVBWs1wkLmns4SW1llzbekAoqeToKYIla3JxcF1cUdSk6s8MUElgIihRG0UJhKyKGcVYLLjIgaepRmPQwCjYkoORvDSZst6sMyFTQ6ZeR/o/yMIB+qzPbxaoS01FYjDUmiJ9O2poNoIWMhFwsOoOZRdAK+OcanoOBg1B1hZietc+NU937U6cLac+vzp9ewNvp2++PZ/AdYh9xkmiMXfrmUyUMEO7xJAO8MpmSnvY6xlWpkH3UG35QNRPChIlE9TShNgjDK2B91z6wjnUfuBLShPDpTJGzHJs49ZtT5VbBoeUCGOOC27xlm0ZqgvK/wFI5Q5frbjHxpe2w/t6PkgA76yxuWnBfxY0F4eL99f9ABUKrIOrt68/Ozk6eU7KdEXLkxU4Hh+/HI2PRkcnN0fjyYvxZDz+cTsrb+ZtTkCQLKm0Rmnzun9YhZHPrDvyjXc322kUCPvMVxo0G+pRqZWaNynersy3p81MqRy53KVOKB23C/qEW+ellMttBOolN5Dj3MIs5/KuiSYDqYAbTb29rCR1lwM83eI6lMhbVv6ee4hxyzsSAQqVYj4sdigDrXK5WvD2dm9uGWHHbbvYrZNBVgVV0z0Jusz6Q6vOkN1/R5n76tVAmXsKpi4KtMRjNHgBh77ObdOr5uD0MqwN28fwHl1p23ngz5Wx3l55gzM+7QrcRYs7B5wirpDPyUJtt465OPA4lHDpc1XdUhoO5deIuoiCO19oxAKljaBUuUhqyi+ex2y1Wq3WaYyetaMNCqjpbEpawGH18Xi8p5v2dNOebtrTTXu6aU837emmPd20p5v2dNOebtrTTXu6aU837emmPd20p5v2dNM63bTFKm2a5PX6TbNOUH9JLQVTJZQMz6s8J2bCX7kiNKe5XnpOan3KGacqqqzcMfSXxQYGHv0mMqtPx6DWSr9WKZEw7vd5b/ktJm2TP+lGd/4lpMWFk7J1qpfj8Wpg+gGf7PzwbEDx1WrA6O9kCEq/Yjpgmpf/x6a5QqMqnaCD6bmq5LaBTn4jEfq/ZaCmhKIYQTm7W2bDRhTRMKm0sLW7pXlaim+Qfn6gq5NnyDXq08pm7glpzRd0nZOtpzRkjyIQAqysnDnoCueEHYZbo4ddfnPoAeQwINQo/Pu4cc1zddinUL0KQzdJz7FQQUMWsUrndNvT2tJMDg9TLNSIlyIWC82ljYU6vD9mpNkGuWL5woHx8DTGNw/M9KEz3zV5kd/8xojtLnL/IBq+i3oaTrjzyu1IdDl1KTbhAJU43nkdU9EVthSFPq7N8xH8MlBQvCGmVuNcPDQ8yEcvI3yEA6msz/et5sLHpJIn+DwCjBfxxrQTCAO/qFWlySKjO6y//Ohy1L67PLKZ++9tE4cv3t9s6yaBu5gRioWtKiNy+XPw/Y2LzW6IZ7/WRruXAkkNKTfZTHGdQq4WQkaO49+sSnzZaGsotboXZK8wi78wbYKxr1GmICwxIJv28ErDF25iMkS4MeyyQNfGWrAgh6JLyYyg56q7HPymOdwbb1+Iwf8UNd+S2S151Bv+CWpxiMjbxdANclrtejt5oAGCZ5hmYbvebQwyF8P14nohuKNUYmtvS3ZWFJ9O8EPi3s+n+2nqVmK6O+MkNyCGpAlQgXNyLAABv6ca/9ziTYcX4qvu0TpQdZ23gkE7CA7++fd/PPekzfUSU2Eyz+7hQyB4Nks8CBjenpEYppbqeQMG8/nIECOEYiHb09TUjZxq3ESje8xzRwukYiEsVdE8z9F6ulERh1uqFCwmmVR0XolDQMlnuc96JS4hx3vM6XxSIHXRls9EToeXJuGVVUQ2yQUkqihzwV3RRGAXSNFFFep+x9yDy1OBV6mwTs6CyDhNTpaLBKVxJ7CB6JInGcJxPN6y+XK5jLlrjpVeHIax5vDb6es331+/GdGYVffitNsHAvZUJRVl5A30hxIueGf8Ij5y76yUsQWXPXn8RxibH3+YXS9leynQf+u3JgEhLT7YwzLnQpLiztKPIZf4qfkCxcXR3nn34rCIrWcULGKT7U9H1t6kZ8pYmvjxkd4TvdP5akWPf6lQuxwoYvdcOy/2iYcw9Dsdrt/7Rj5o3jw/h51fugxq3CQMkrIFF949cN1RPrH1JcyKiuGQTvxuAdc/W9khl1//E1/NtLJSduV7v/arjRxMdj22UvBuxGmSYGk/2befaV6+o5RiFr6uKVy2zTRfkk/wJZuwW+b4BOUM4FIz9/yR5VwuKr6g/n5aQmMeEpcuabtzSVv4QQYe3J7N/M3rQn9Js8EhX9Dh/wbrL9vuvmXngDZn9L1pUz6sVqt/AXXaAjE=
sidebar_class_name: "put api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update consent record signature</h1>

<MethodEndpoint method={"put"} path={"/service/individual/record/consent-record/{consentRecordId}/signature"}></MethodEndpoint>



This endpoint is used to update a signature object for the consent record for an individual in an organiation defined in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"consentRecordId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A generic signature contains a cryptographic hash of some value,  together with a signature created by some private key in another system.  Required signing methods: Revision object or another Signature object.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent record signature updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A generic signature contains a cryptographic hash of some value,  together with a signature created by some private key in another system.  Required signing methods: Revision object or another Signature object.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"signature\": {\n    \"id\": \"65471222e8c7c3bb3c2c5501\",\n    \"payload\": \"{...}\",\n    \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n    \"verificationMethod\": \"Ed25519Signature2020\",\n    \"verificationPayload\": \"{...}\",\n    \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n    \"verificationArtifact\": \"\",\n    \"verificationSignedBy\": \"did:key:z6Mkf...\",\n    \"verificationSignedAs\": \"individual\",\n    \"verificationJwsHeader\": \"\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"signedWithoutObjectReference\": false,\n    \"objectType\": \"revision\",\n    \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update consent record
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-update-individual-consent-record

---
id: service-update-individual-consent-record
title: "Update consent record"
description: "This endpoint is used to update an existing consent record for a given data agreement for an organiation defined in the consent building block. Note that updating a signed consent record invalidates its earlier signature."
sidebar_label: "Update consent record"
hide_title: true
hide_table_of_contents: true
api: eJzdWttyGzcS/ZUuvERKDSlKlnxhpbKri50wTtleSd5sbaQqgzNNDqIhMAEwpBgV3/ZL9tP2S7a6MTcOKVly/JQXFTUDdDf6eroxdyJBF1uVe2W0GIrLVDlAneRGaQ/KQeEwAW+gyBPpEaQGvFXOKz2F2GiH2oPF2NgEJsaChKmao4ZEeglyahFntIJfaTB2KrWSxAoSnCiNCSgNPsWa1rhQWULEx5mJb/rwzngEn0ofBKA3Epya0tYOf6XnMlMkpQPlHaC0mULLq6UvLPZFJEyOlgUYJWIoHNq5ivEjn22kEzVXSSGz00D4nOmKSOTSyhl6tE4Mf73raOyjVr8XCKMzMBM+5Pg3jL2IhKK3ufSpiISWMxRDEbcJj4i0xd8LZTERQ28LjISLU5xJMbwTfpnTFuet0lOxWkVdxscVL1gon5IAqj4B02YBfi/QLhsJOku+Knsy+nFl83sl2Fz1VYWwOFcu2Hc7/7UFDeuJzNzneDO5FGWCtqH3r17pLicnvdEXajfqHKuhA6MzsboOpND5E5MsaX9stEft6afM80zF7NN7vznaftdiZDS+n7DXlixL96TjdJ5cr1arFXFyOR3I0faDweBJ7HJLAeZV2L3m7q1j1yHilc/oQTfgOkbuRjre5hadQ1e/2JFuPaMo10kl3zhwOcZqUgq/S0mNUomeZghnbafsw2WKFmFWOA9jBAkf343+8fE1c/NWUmY0GnY6Sa5yrKgVh7siErc9bXxP6R6tH0uHtbM1/vGrUHTumth5SetH6Sh9OC89iuuoo1+VbPpSJCbGzqQXQyEigbdylrOKnx8dvtg/ODjAl/GL+Nl4/Cw+iF+9GuxvaPs9G8fBTC7p8Ll0VAHGMr6B8RKcmSEcfxjVNcJx5JnCU+4bncHOh7e7ESSoDSdrTt0+xSVIS5q8EomVE38lIlB97IOENduH9cqBNh6W6MF5Y5sqUWkQpE7A6GwZihG/tlI75ftwRvTXqTpIDFNM5ZyEOK8tNS48qAnkkswARR7SiISLqmZEIIHLSr0JXGqKLCHdTFFTNcGkzyHcSWxbTHPbm9z0ZibBTAzFms9tmOEy7Xgl+esiVXFaO30qHYwRdai5GyKcN4nuc6JUS7dKUR/cTGojtNz+IZnAm3vFYtd+tPvK/fFB/Cw5xKPJ836/vyHoqcmXlYBVIJIwKQcz/yK3otdKx1mRNE5V4wP2KtSusOhATqXSzoOXsxxJtOAatMFYNVVaZo0S2P5rpfVzGm8y/FadtwrAIjWs1RL0cGpbz4fE3OR+pFtcx8ZkKPV9+gz1qMPXFjhkbTUnYc65ccqrOWZLMLlnxfXhDaWwrcvxliqE8tkSnFQJaAM7xrL6EisXGiTkZCJT1AfZZQWGLPdolwgK2ao+pgQThVnSxrBl+Qhv41TqKRl64tH2fIq9iYx9H0acf2aU5SXXk/GSrV5mFDg5IXSJ2aQP/+TEwOTcEAodJNrLUXPdmRnb8i63VwuMuphRzq92UIYPP65X4SfveIQb1XlqS9Fs/JqTKoUAHTfL+DhzmRXoqpDpFFgKhJbPKd84/w3WcTbSc5WoQmYRzOQNnVh5mKNVEyXHWQinED693Boz6cPlydkQzjELLQAX4PoEEFDE39gTMPbGfrA4QYs6DtWuVIS0VhKcUx5nbhuoWNdDWfQxxH7OJCnXBxaQoJcqc48u02GbiERmAo7YrMrlkkf78YbI7+QMKx2XxB6M8PXdZwyDXHVA5eqgBWOpCnKucj9L50PfkzyB6JaWjxNSwyyTruzVMBGrVYUpy/ryAAa8twYdw7dcaFX8bZPaOQAgljmHVqkqq2SmXOgMCa+60JItS9ciCBjgnjULqgvKlTVBgytCG+EN7O9CbJe5N1Mr81TFnQJxsAuySBShm/6VvtLHTiUIE2tmLMWVcEUco3PGXgmITVbMNIEIuwkfSJkqQfJGQqgEI56EFsOpyFuosWX5ue0IPwk80CK06g+ZqT8wudAyd6nx5dPwsESYXs3QUbB+fZT5/PkWlFmDCupv1o7yaF7Jg/jpQ1lisiWZhMlfCcZ77LQYp1rFMgOL0hnt2maRWYZJvYuEuhKtrN3lm5tMxZSROjCHSzMl9No0f0qNLw9fHWwtdh/eVsmibIU53S8ofdcRIVZrbvFoQe76/f5qK9c2L9VlFerGL6ExeL95/M+gk9LhN3vimIc7zLNSKh80w4mHcSb1DaW5LS4PCwryWGZxkYUp0noE9Bt61Pe4Yuyo4dYEYsaEJNgllA44ZUtI/UmNVuGASYDXO5TFpIOfLt6/26UfEhJF6OQ4z7MlP4ZTqQ37sPoj1NML8lek1TlaGL2+fAPnb07h5YuXR30gXENpkVBtDQIYIdUgIPg74G2MuQdXhCw2SqKOstr/VwroX+lKNa288kXw/qHfG4ojNiT/NpvvXPx43NvfJbma9PZokQ4GB4e9wX5v/+hyfzB8NhgOBv/ejISKLsnAPlblefKxVOY5akwYVDYJZnTxHl4+H+zDx8tT4KkqiUdiysKnxtIhTpajTjvx0IQo2hwotUm99ynaJ+Wfw6PDfXmAz/HF0fNXg8Fg//BIjgeDLX5bIjQGcxpkMlOa8LatQSfEFgkMBKBQIwFylqpQBtHu60i7IncUMVknHIYHkBk9ZSEQMkoa7fEMY0ASmKbEtRAkUW4xwfDv0/z3cd4bP9t0oICPLTrlCLKAtF5RIxIQRd0oBcAVQWxyhUl42Qm2dfmbzuDRh2iLuq3HfpqssLNASIz+xsONNgsas5QIfG3VomkzAjzdFQEzdqaTq40h6ek6Fi0xZ2XQSZFlVJTDuJaADFE4DPPMdUJjSak9LzzUg/4tG/efNAhtgzW01thTkxBM499nLfbX3ZN24VezuzGk0h6nLGVtvcPBYLWF/BbjNwY/2XLwErF37ziadLKhmqMnzoj/WqoZaY+WhkF0l4QWmE1HR6GjLazySx7FH+fqLdLPaxrDn6C0aI8Ln/ITOrWc0k1T7eEVlozEDH1q6OYqL1gddLs0FHvlPdZeM4nZC1GxVzZsvfLfu84N1Cr0AvPtV1tnODPluUQkCkuJOfU+d8O9vQRnpidz1VdTK7XvK7M3PxCbNzQXXk5LvLWNjAuvt1C6bpQWgA2bvFJdMw4ID6LtlzPHpduGVn2js/ww4nkGOTdqX7psmBjyfKRCRp/W6HyCwKa+IKCpgrrFJExJPgUZ4RPs6HB7iTSdVhmrIZcx7kaA/Wm/Q3YI5cbvlqawpJHeDS6//8SYs+0kd2LM/72psvhPv1xunk2D5EQI3txgPbxtPCTiRqj0eKrdrTEeb4mC5O3duVVzGS8hkS4dG2mpcZ0qHQFf/YaldSesEtKpX0JuzZz63LpN4WtgVyr7AjVPmKTb0Ec4NHzHhEkRZaPIFZffNfCAHIpu6QQlnPPmtux1FdJ31QRFhGHtxFRZS8actXAmFbmmK/LcWP/32h1bt6c/NI/W/bhZvJEh6k2w87///HeXAIqEiwUmyqUB7eNtGEbyfCEM0IIrQhnYtQoZSRaOxzvZpOfMHC2qqa6VHbUHcDHBAe2VzFzEHcRUeZooU4PrmZkzNMHMTRI6YkPmRBcBajnOwmW7xgVkOMeMzEfZlVOwHKuMbEtEZOHNTJafBMzyTEkChBwLfDyL0yKM/By1ZxK4NocpCss5k1qjJfNmKkbt2FpVBOcyThEO+oMNnS8Wi77k131jp3vlXrf38+j09buL1z3as2oGTI0dKO4TExfUp1eZgVJgsBcB//6z/j4DKuP8TOqWPGFm1p3Ad2zeqoZ/+S8qyvjzeOv38kwqhvZsqLuyPv1afWch2pckfD9eKm+9SolIDLtfSlxHIjXOE7G7OxqLfbTZakWPw/U+Fy/lyJ2S7QOEtk12zksMsguf/Ypi6/luqAZ1P6bgkhHyy1cTZvNriQfk2Vz8hSJ95rOKB0RYW9dwv6Z/LGelLzfVvV/abJWnwgd62ZakkrPrXysa1JXo4YsFvKcp36anB74aWbNZWH0auPUuiWCzYgNnNzuOYxriPLi2DSc/fCQEMS6/LpkxpBZWLihI5UIMxZXgGahhBTAS4+d3IpN6WsgprQ9kV+XwYR2j3TBGK3+0PkdZN08XroWz0N/W9yrrW76jZP4Wl9/Xy8ObezfUELGK4fDly/8BsySQdw==
sidebar_class_name: "put api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update consent record</h1>

<MethodEndpoint method={"put"} path={"/service/individual/record/consent-record/{consentRecordId}"}></MethodEndpoint>



This endpoint is used to update an existing consent record for a given data agreement for an organiation defined in the consent building block. Note that updating a signed consent record invalidates its earlier signature.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"consentRecordId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with ID individualId","in":"query","name":"individualId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"An object with ID dataAgreementId","in":"query","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"header","name":"X-ConsentBB-IndividualId","required":true,"schema":{"type":"string"},"description":"Individual ID"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent).","example":"","format":"","type":"boolean"}}></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreference</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"sector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem></div></details></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent record updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecord\": {\n    \"id\": \"65471222e8c7c3bb3c2c9901\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n    \"individualId\": \"string\",\n    \"optIn\": true,\n    \"state\": \"signed\",\n    \"signatureId\": \"string\",\n    \"sectorPreferences\": [\n      {\n        \"sector\": \"\",\n        \"optIn\": true,\n        \"isLastUpdated\": true\n      }\n    ]\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read latest consent record
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-verification-agreement-consent-record-read

---
id: service-verification-agreement-consent-record-read
title: "Read latest consent record"
description: "This endpoint is used to read the latest consent record for an organisation in the consent building block."
sidebar_label: "Read latest consent record"
hide_title: true
hide_table_of_contents: true
api: eJzdWtty28gR/ZWueVlpC4QoWZJt1tYmsmTvcr1lK5a8W5WVqtwEmsRE4Aw8MyDFVfEtX5JPy5ekegYXEoQcOZvKQ/wgQ8Bc+nK6+0yPHkRKNjGycFIrMRLXmbRAKi20VA6khdJSCk6DIUzBZQQ5OrIOEq0sKQeGEm1SmGoDqECbGSppkVcDqfyEeuSklHkq1QwmuU7uYhEJXZDxQ8epGAlLZiET+oWMnMrEvz+bGaI5KXce1vjgN/tAmIpIFGhwTo6MFaPfHjp6fFTyc0kwvgA99YJN/kaJE5GQ/LVAl4lIKJyTGIlkc/ExL23ocykNpWLkTEmRsElGcxSjB+FWBU+xzkg1E+v1LQ+2Ba9g+fvRcMj/JVo5Uo4fsSjySp2Dv1kW7mFjvcKwEZwMs7ck2diukd5Jl/OLLXuIqKP8Wdc7dF8YspZs82EPLaQ0lYrS4CdpOw76xoItKGl8sc8oQLBSzXKCC3TYeCeG64wMwby0DiYECB/fjf/y8bXfzRlkKGkFeyk6BKxngaGFtFKrCKRK5UKmJeb7IhL3A6XdQKoBj5+gJTGaYm5p0y+/Ccl6N4t9qNb6ES171jp0JG6jjn1luuvDSEy1maMTIyEiQfc4L7yJT0+Onx8eHR3Ri+R58mwyeZYcJS9fDg93rP3eO8fCHFesfIGWQ2aCyR1MVmD1nODsctwElYWldJkuHcNyfAF7l2/3I0hJace2dxk6DpsVoGFL3ojU4NTdiAhkTDEgbPk+jJcWlHawIgfWaVP7lKC2IKBKQat8BXQvrfOfDSorXQwXvP72qhZS7VfMcMFCfGg8NSkdyCkUyG6AsvDKAMKVnCl0paEIEBaYy7SZBDbTZZ6ybWakOOIpjcU6Eukmhsa9rrkfTO8Gc51SLkZiC3M7brjOOqhkvC4zmWQN6DO0MCFSMJMLUjsi1AI/QZR6aK8UjeJ62jhhA/ZfkgmcflQsD+0nwxcPJ0fJs/SYTqancRzvCHqui1UtYB2ILEzmg9k/Maz4s1RJXqYtqGzta48qUrY0ZAFnKJV14HBeEIsWoMETtJEzqTBvjeD930b9Eyw+bgb32rz9DMtMe6uymFy7OLVt50PeXBdurDZ2nWidE6rH7BnqQGdfU9LIW6vVxO9caCudXFC+Al04b7gY3nAK6x1O91whpMtXYFGmoDTsaePNlxpcKkAo2EW6bBTZ9wYMWe7JkAgG6TWfXwmmkvJ0u+j7HBO+JhmqGTt66sgMXEaDKSYuhrHPP3PO8ujryWTlvV5lFHj1CqSzlE9j+MUnBr+cHUGpgkQHBSlfd+babKDLHjQCkyrnnPPrGZzhw8PtOjz6GU+AUZOneopmi2ufVDkEWN089+osMC/J1iHTKbAcCBuYk64F/x01cTZWC5nKEvMI5njHGksHC893cJKHcArhMyiM1tMYrl9djOAD5YFQ+QLcaACBRfzJI4ESp82loSkZUkmodpUh0BhcMfNxNLd9pGLbDlXRpxD7hV+Sc33YAlJyKHP75DIdpolI5DrwiN2qXA15Mo53RH6Hc6ptXC32xQjfnn3haZCtFZS2CVrQhqugz1X2Z7TuY5Fy9fqKRXtosk9I7WY5WgdltfDa/2MLVvXlCxzw0Rp0Bt/6QiuTb9vU7gMAEix8aFWmMhJzybFe8VUb2PKqghZTwED3jF5yXZC2qgkKbOnlYUwe7kNiVoXTM4NFJpNOgTjaByxTyewmvlE36szKlGBq9NxLcSNsmSRkrTY3AhKdl3PFJMLs0gc2pkyJ0cgMlWnEV7HFoBWjhQ8fXn5P98MjkwceREb+jrn8ndIrhYXNtKvehpcVw3RyTpaD9b/PMk9Pe1hmQyrGFz7gW1WevFf6Rf50WZWYfMUu8cvfCM/3PGgpyZRMMOeDoNXKbroF85zSZhYLdSM2snZ330LnMuGM1KE5vjRzQm9c84fM+OL45VFvsbt8WycLXWGY0/2S03cTEWK9BYsnC/IQx/G6d9fNvWR3q1A3fg0Hg/e76v8bdlIBfntTpkQJV9qwZ21Ur2hOUweTHNUdp7keyMOSgzzBPCm5+KgZbEdA3K7H5x5bTix9LkkxiZkwk/CQkCrwlJ6Q+oMWrcOB0kCv9ziLoYWfrt6/2+cHhFQyOzkrinzlX8M5Ku0xLH8P9fSK8Uo8uiAD49fXb+DDm3N48fzFSQzMazgtMqttSIBnSA0JCHgHuk+ocGDLkMXGadQx1ubvtQHiG1WbZiOv/Ef0/kvPO4bjbVj+Pp/vXf14NjjcZ7na9PZkkY6GR8eD4eHg8OT6cDh6NhwNh3/djYR6XZbBY6zO84yxDIuCFKWeVLYJZnz1Hl6cDg/h4/U5u5uAxWMxsXSZNqzEq9W4c5zYjYaKc48vOH9vN3K2l3rvMjJflX+OT44P8YhO6fnJ6cvhcHh4fIKT4bAHtxVD82ROAaZzqZhvm4Z0QmKIyUAgCg0TYLDUhTKI9tiJtCtyxxDT7YVD8wByrWZeiKbD17ZnPAdkgaWz0AjBEhWGUgq/fh1+n4be5NkugAI/NmSlZcoCaJzkg0hgFM1BKRCuCBJdSErDx06wbcvfngyerMSmqH1n7K+TFfaWBKlW3zi4U3rJbZaKgW+NWrbHjEBP90XgjNs80b/qHvl3uGinNbHH/IkbRT7kjp6fnA73wZAzkhZ8BAiun5Z5zuU7I0x99/WB9zoOnc/tLSfIRaAoHTTd2p6Jh1/VMt2kdWSMNuc6ZULnny82tr/t2qRL1NrZrculcjTzUjZ+Ph4O1z3L98CkhcarHsUrbt9tVLeJZ8c0J1/ZTf7/Ms1YOTLcNuKbATLgt+nYKJx9SyPdyt8CnBXyLfHjLbfmHc74ckBs3imw7veDrdb2IDFlmjepVOwOKKQcaDOwpEJnR4yE7+f0DLUJKTRSi5E4jI96BpSWEn9MER/PB+eDy/H54GwwHD7zRnK8g1bhSuOONfmisJHwbQkWeh09NmFH+HZWUOLxqY0y7RRW6vEJtXLt+I6S7JY5uUzzlc+MPPL4NmYkDqoLoIPFhrcOqgP0ICStg4fOZc06nM0W/bdAFzTXFXpEJErD3s2cK+zo4CCluR5gIWM5M6hcLPXBImi2vcaVw1nFf/uWseFzz0q3LTQD0fSBVQO0bc+EF9XNVMB2ezd1ViWHAN2dk/7l2PeXOIWQcpXNQgfX279mqp+21vkEYZvmwoa7PPKe0tC1+hRkhE+wpzSTrYz4tkDm3gwFJrQfAcWzuLPsCKqJ3610adgigztaff/JnwFeERoyPJ51n/jf3tRV9adfr3d1U4C+3IDTd9Q009veaeQrWJVXmEtttFX9lChIvjm7MHKByQpStNlEo+FGwkyqiEspVkObzoRM2aZuBYXRC+47NMfGjVvOGK5I+Y4f2h17BKXhO78wG6I6uHsG5L+1dI0BJda+LT7VddbHxGd9mqNk0NmyKLRxf26A1gJF/tC+2kZoO3gnwzaTYO+ff//HPlNBhKslpdJmgRvQfWj7+k7OZmBCFa2NcTxnL61vpOXTgdULMiRnqjFjtNnqTJh4KScxt5E/q82k4949txKc38xq7hUXOg29B82OIhsBKZx4JCIoWkJOC8rZMVydfAnDiczZa7wIlk7Pw/k10fMil8jU26Pcq2doVobmquWDMILnNqFf5eWco1Jk2HG5TEhZXw/r2CwwyQiO4uGOzZfLZYz+c6zN7KCaaw9+Hp+/fnf1esBz1m0rr/UDR3Sqk5LpWB3znNyCv/iIFT+LDz111dbNUW3Iw/fi/dfz3eDaoBT/2xv/CuuO7t1BkaP0xxpvuoeqDPxW/x1AULwt25HYLgUiEqPuzf1tJDJtHa/y8MBc9qPJ12t+/bkk42kBFybjMRjqhbT8nPb3UDbttPehIlf78OgfF/SqV+d5tdos11FVQLsqrLkBVlWBlgOcJdxi2Ji/wwO36uoPrzmfYpVs20Jz5wtN9cCr98rWrTlBBP7J1bF3yneM27e0+r4ZHr48OqGpc2E0W+p2vV7/C/2h/zI=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read latest consent record</h1>

<MethodEndpoint method={"get"} path={"/service/verification/consent-record/{consentRecordId}"}></MethodEndpoint>



This endpoint is used to read the latest consent record for an organisation in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"consentRecordId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent record for data agreement (based on ISO 27560) retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecord\": {\n    \"id\": \"65471222e8c7c3bb3c2c9901\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n    \"individualId\": \"string\",\n    \"optIn\": true,\n    \"state\": \"signed\",\n    \"signatureId\": \"string\",\n    \"sectorPreferences\": [\n      {\n        \"sector\": \"\",\n        \"optIn\": true,\n        \"isLastUpdated\": true\n      }\n    ]\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all data agreements
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-verification-agreement-list

---
id: service-verification-agreement-list
title: "List all data agreements"
description: "This endpoint is used to list all data agreements available for an organisation defined in the consent building block. The results are paginated."
sidebar_label: "List all data agreements"
hide_title: true
hide_table_of_contents: true
api: eJztO9ty3LaSv9LFF8unKOpiy06mUqmVLTsZx7FnJTmujeWyMWRzBhEI8ADgjOao5u18yX7afslWA+BthpIl26dq69TmwdGQRHej0fduXEcZmlTz0nIlo1F0PucGUGal4tICN1AZzMAqENxYYEJAxiwDNtOIBUprgC0YF2wqEHKlgUlQesYkN4wgQoY5l5gBl2DnCKmSBqWFacVFxuUMpkKllwmczxE0mkoQQI1QshmXzGKWRHGkStQO2jiLRpFBveAp/oGa5zx1z49ral5zY6M4KplmBVrUJhp9uN7Y4ZuqmKIGlYPGVOnM0O7MJS8d/QExVzKBY5A4Y5YvEJSGSmpkmdvogokKIWdCGJiy9JIgfN7/TLRyQvH3CvUqiiPJCoxGkcpzg0SXxr9XXGMWjXImDMaRSedYsGh0HdlVSZ9yaXGGOoqjDHNWCRuN9uOo4JIXVRGN9tfr+LoGK3jB7SbK/l5/Z1e0EOTQnjXaSkso0e0ak68l8MBT1cd8LEFN/8LUwpLbOYxPQOOCG3+Iw2zqffBlSozVXM6i9fojfW1KkixD7w/39+l/qZIWpaU/WVmKICp7fxmi77oDr9QkYJb71STejTy5J9xiYTqI/b6iOLLcCnpw0l2ydQbHstUWkn/LuDROGUyJaSPDdDgMDJczgVBWulQGwc6ZhZRJmDaq47QxATiGHlqnqpIvUBsmgMlsaBlMV/C3gsnV34DLjC94VjFBtGhVzebA+iBPnagkFzKKo6tdqewul7vEnikz2JxLe1AfokA2aaD/66TDididiFZCoH6nRe/3G5KAOCqV4ClJhGDLvBLPmOEmiqMC7Vxlb/N3DjRLSSOjOMqVnqG1pJG0hOeYrlKB0cd440h5ti02bnnBbDSKojjCK1aU7iyfHD1+enB4eIg/pE/TR9Ppo/Qw/eHxj4dbxxqt44i4zb043Q36QbKf7G+BIuMXQJEUWDLBfdmwCpZzntIRaUyRl06SCIchOlpGjge32kc3PvFYnGyEdX0odDxfBPPu9DXBce6gXQo7BVuR3KmCW5I6noNU/isuF0osMHvYx+YO/4vo6KtvwRdka7RpqCbuOVQyQx2Y7A6gr11mTq5vijBTC9QSswTg/RwlpBqZJUfGNhxj7DgsmEVjwSOvVbJ2qTkXwn0VTKn3KzE49e15UZYVXLrlGaY8Q1qdzpmcIXBb+9Y+fhC4QOG19ybDNan17W7qLb2WVlp8fx17+nT/YFDH5A3SMQz6JHDS8aIxJ8OSRDwLn3w/Xf6jq8c1fNjh3oznSgi19MYfiwVq8LCdhFbDWjeMfW5taUZ7e+FJkqpir9R8wdLV7g37nqAumCTRINVltivtC9Srvg1CmPSEloKfGMxcVSIDqSw9Y7QbL8tBGkk7wPICaUN/VZqbjKf2Xnx98W6L8lddQGuKHrLKWL06w9QqfXfQvyITdp4yjdtGMYAE42GuYxcJnCLFEFzJCWqushO2MoPB0CC+R0+ONtGQVaHAywOl2IsrFxxnBHkdRzNUM83KOU9PkXbz7cz7pYFIEXYDch1HxirNZvhaeS/zTVjOPCwQNbB1HNk519mEabuibZ/NmQPaYpkqJZDJm9BYXeG2q+Q6g5Jgeh03Aep6HU7s2FrNp5XF7kExrRkpRBPKMSHe5i452LSNA+fFGpB1/NZ3z4Y0Bq9YasUKlhSycfpSCExDBnMv+9ql4PvHMkcDdra/Sxif3N/wvtmmvW9pG/Cxy7O4NJbJFOHCIbqIKMW6iNgML5zZ7wG6KxEvKyFAdpC2Ue72nttfWyQ65UBpuOULbld3F9lwqBuq0UJqApgeqpRZnCm9uvtGJ6iNkgO7eh5ADSMyqSrvcaZk8rcVnWBALbbuLDcRuXRwU6/6YtyxRLfq6e3aSem+T2o70G7Ttj4RqcbsBPPhmPkGD/Lo5P3B7+/e/7l6djk5ev3LY33+X6e/jh6Nnr8e/bA/qnPirWPRmJHJZ8IXRLgTO69nPhH9DkQcjp7T3pxVQnibwynOuLG+dDJ6MhiunDnkjhL338dN1fsuFvDCuYM6O7xzqF8vWA/mk18Es6HhHWjd9PLOXN+WPgcFpgSmMSFN+L3b1Lr2QOCMiU9qKvjMx/N7PoNhKb1dcMvEJ4olSI5hD8pqKnj6yTJz6RdzywtmsfmG6JJUD/oQBSSUAG8gqRNs5hSnj8Rl6A0Sv3gLCclCN/X+ek797qAQjyqDsAuS7PSesxufjKp0ivWvigogn0KJr90mLfDuPXwfhV/97530lpydMPst5J77ZApBySZGRjiZjI9BY6m0k+4ZSqpKYgYst6ipeDIZH0eBgrOqKJhe3SmRJnTvTgWUWi24K4p20FFJNGA1MRgPFtCmvdrQwhVDMaMCD5MrqM8QfaxE9o4sDZ9JZivteHO1m1/uFipDQWagebNlIOo3rj5V2bnSnHgeYjCVbyTKO80CAyEzT+esVwJmxgErKmF5KRAasszDW7PVLpF3rEexlVDOh5nO2kWncuwlc+PhpFk28PRXZuYbb4gwzJ6tHK0FGsuK8vtHbkdDkdtbx6SG1SUzVFtwNenpCowqEI4n46agb1w1VlWW6vQ8g53Jbw9jyFAq6+WOWTqjlavBM7iIMs1yexHFwBNMgEErDjZYeUoFV2iBkon2kOtj8aUMKVaAV9xY495rRgFR4ux6YPWdOXOdJMl6UIVyLpmAALAhz7iziZ0xtrpKncIaYPDq7O0bMKg5E3WVReWQcxSZgeuBgx9BkiQx3CASA2+9bA28OCYvzVI78KoWpYFXr5bmV2QZ6hgaKQuf+U2+90frReIUc9QoUwyfeG06X5X9B/3P1gmcBY702ESpdwJj7+IaVepbwSnmioRGruycZIl4PywSOyQTcwfdiZ+lOhp9sUFSXWzoFPdyrQpfVwnHPK2sK6N5NM4SL5nOTLJl7+4mXrh6NZ/+kvK3/NXLP1+cnv/n2asfkyS53SzWxMyZmfuynwdeBwUtx9odhfDJm2zkdo56QHgoKRqUgVCx2rRjd8/gs8Ojo4Mfm20c7h9uB4fHsEQhdi+lWkrwAFtb4R2jjw/qPmECfzDBM1/HNCM4f3ZCrT1uoOCzuSsZ4VXJZIaZbwuZqiTPhllvlwGqcW1BjbVxY+D6YEyAQcfbdnVYABJTNIbpVbLJoMn3MTRjcqySCbHqiL5pdWajhJb5ck8QaHfWrSJ627gh87tOHq5c2ObKyrKFH0IDXmdcxmnnDTt1furOu2UH08P0UfYYj/InQ/I+uO9Ur0rbFJdI+ut9+wYpNZywscDOg7QvVT5kSjc3U5vKb4jmjvuyxQLE2iwRlNB7S5mkOMUfSQy8YDOMO9qLNt2kr3H9d6Yv49noElejfzz5/TIfYvUzTFnlPCdwlzTmHPUD8pweoFMQttqquDrL460yA4m+LOtMcHCGnfXezbtlTpH4THI5S2DcD9HYxhE3rIh91dh5y9qoNYkhBR0t5a5CIJS6JOmtysairepA1ycicImrrr1sQswBoqSSu3chLO3RxcB9wkSnKvTAuHKRiakS6yoqoVUeAxaMC2BZptEYNLAbeMnASFaaubKerVMufTu9b+m/E4eD6bM+vpmhLjXNZWyVtx6YHh+pvuYPghCZGBhYdYmydaCVcUI1PgGDhkzWlsX0on18jwz5tmrb6fHLc3g5fvH6ZARnwff5LrhG4WsIc17CFO0SQzjQzTY6jJVZ2LtH1cnQaj+cKpmilib4Hm4IBy6YtE4Yn4e83Pe3TQITZQxv5jrMCC46W7mIYI8CYaT82uJFtMWo1il/g5ESzr66WZMgS9vuvR8PkoF33Ng8tCA/M4LF4NX7s66DCkMZO6cvnz89Ojhyjac2abnzBg73Dx/v7h/sHhydH+yPHu2P9vf/3I7Ka7i1BgTK0kprlFQq6igrN/KBdSrf9M7CcRoF3D7wmQZBQ71baqXyOsS7KfL9xrLtWGaukma8nm866iUzIDC3MBVMXtbeZCAUcKvpa08rUd3GAPcpxvrpmFuL7L6WCC6tHyY7pIE0QvJHI+3N2dRl+BrZRdQpNXUoaCPrj812hvj+FWnukycDae4xmFVRIBV5G3sBez7PbcKrWnE6EdYG7xN4jy61bSXwr8pYzy9R2xkfdikXkrd2Z4f5QsZD4lDzGZwGpsCOt0OhIMOacadg5YPN8eNXMTn3zqRA6BKjTR8mvpMVhlzuLMHbFmVrOsiDdBZD4nJo1Mc0M0M01OBFtTtk872o8dhq30aWlaLJpRunCHzivlKRabaUMUW63BpfQnAnHeoOTbjvRw+rjFs25YJbH/+nqiiZJctOBiJ05r9caO9Vxm6f7Xo/noy8kwlGrG8zXO28PYSay7VTpzpIjlq3iS03AC3VUJIQqcr0hMnpOel8jzRfYm+HoL5YdXSkP/d6AK/rdWCsK3x6ND0MCWx+5kc162mWgklqAPOQKcBS6ctcqKVxIrc5OWC8RtIYBJOWp1AgI5Uy/ii9rA7zz8+01FbJVagif9gkSL4IzCx7R4HDma8M39JjulsLuPJRiIfWn80herfHb+7b9A1jB3HUNNC3Coj3a8je6iey2/fk+5/3m60YaL/Q5K8JAxU15k004t7DBzciqkHdhCqMx5wwM58qprMbivP3xBqgQlaDhUqLYRJ8e02VKI9Lftbtn3251XneTWvCDOlbgjQZb8wKZiqtnLp4ANM6zzqejB+0o90m9l6PcgMqQ9Qj1r5yRvJx5hot36w5ob/z76EyA5v5f135l+kKBUI90XMNg3o+/7aJ7En71VbT37u8CZt1JaM71t5r3AcHSQPyoTTQ3eoBUagsE+ONgYWb4J3Tx51xfKdK7RWKLuzDoxo40fo1wIlouqDg8j4J9X2Bdj7NRQz08Muw32yQXN8a6HFjfx1Hc2YmIWwZDBhvSrJ47utXD6h81QQ+myicNfBY3uCV/XoMEq/sFnSaOFt3xS4Ilh8uGxiLaG/B7DRsHp+9hcOnR0/2H7o7MxTjVCnFqXklBJnPuSsWEHcI7GN/W6EPfcooliwrlxD7qywDCw/udc2ha0FRa6Wfq8ztnv7uDlZ83G7B9lWoXT0kNw03H++TPGyBHzAjrel4NrDx9XqA/+9kKA/9A7Mt1hzd8wbIvxdr6lq9C+1Qg0OzwSPvtCrtpts+XEfHJf8N6c+PdJ3Gshn596h7x4r2XoQuUzRDf83KzqNRtBdCyL1uIWqP/OVuqyDOXxM5Q1eyTrBQgdowX94OOGdYqF1W8oTPNJM24WpvcRhtXzg6s2TzZzeBMf71AKSPLSvcNJQ/yJohbfDjH4SrS56X7d2l4yCMtc/ZKF9Mxq4uSyJLdfE0XDA773ZDyAd+7sH5DB4NFFSkmLp8MOdXdfPss6cRPsOOVNYXia1m3BcySpbiwxgwmSUbYEcQFv60UpUmjuxe4urnzy7ye4ZMo6bvae9T9+tl7eVfvT8fvN7kzFuoMG+Vpv28Z5Bj19VoXvklvmXaW70dKAg14zKm2stWKdv3GuwqDNDgYPxEnW2Z0W0JZrb44TcNPznAP7t7fM44OL/i3rVjKSRQ0doNoeeqtjKhQ+V6BqS9vjH5H42gtYLCf2kf9SW0/XhLo5tFsPM///zvh77Fc7bEjJu5D0zxKrSDNgvCTX5XMyeBsaWcnYJNke8a6h8hn8mGjXWV2d10TJvBRddEyPiM5shgyYRA65uTijq+pcrAYjqXig6KOg4o2VT4GhmVm9xtFBc+kHVy6Yav1DggrLKq8PdoXB7P3Wiwk/LQQp1VoUvg+vzgfGld8RHUIpYSdeLugaUo/bRarZslS+cIh278sc/z5XKZMPc6UXq2F9aavdfj5y/enL3YpTXrNqxsz4E0uk60ap1vbpC46njyKDnw946MLZjs0PP6hpu0m6rVcWD/J6/lBoWweGX3SsG47Fxi8a7hQ9RO8nWFMkzvdd3DxziaK2NpzfU1xVLvtFiv6bG/JeqcBje0oWy4YN9l17/2ju/gxi/JW7RXfd1yf4XpPoTf98LuLaTU4f5XUvKFC7y3IO5912L/SD8095XkD1QJCU6UjtavPE5TLLs0b4Vt624U8ssLckcs+KrWT186Px3+6JQpmFx1YG+6bE8C/dsZX+8v+YnU/jdc/dx87t/cuKAJE/zXxCVKa/8XVkceRA==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all data agreements</h1>

<MethodEndpoint method={"get"} path={"/service/verification/data-agreements"}></MethodEndpoint>



This endpoint is used to list all data agreements available for an organisation defined in the consent building block. The results are paginated.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreements (based on ISO 27560) listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreements\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c8492\",\n      \"version\": \"1.0.0\",\n      \"controllerId\": \"string\",\n      \"controllerUrl\": \"string\",\n      \"controllerName\": \"string\",\n      \"policy\": {\n        \"id\": \"65471222e8c7c3bb3c2c7701\",\n        \"name\": \"Default data policy\",\n        \"version\": \"1.0.0\",\n        \"url\": \"https://example.com/privacy-policy\",\n        \"jurisdiction\": \"EU\",\n        \"industrySector\": \"Healthcare\",\n        \"dataRetentionPeriodDays\": 365,\n        \"geographicRestriction\": \"EU\",\n        \"storageLocation\": \"EU\",\n        \"thirdPartyDataSharing\": true\n      },\n      \"dataAttributes\": [\n        {\n          \"id\": \"65471222e8c7c3bb3c2c8501\",\n          \"name\": \"Name\",\n          \"description\": \"Full name of the individual\",\n          \"sensitivity\": false,\n          \"category\": \"Personal\",\n          \"scope\": \"read\",\n          \"restrictions\": [\n            {\n              \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n              \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n            }\n          ]\n        }\n      ],\n      \"purpose\": \"string\",\n      \"purposeDescription\": \"string\",\n      \"lawfulBasis\": \"\",\n      \"methodOfUse\": \"\",\n      \"dpiaDate\": \"\",\n      \"dpiaSummaryUrl\": \"string\",\n      \"signature\": {\n        \"id\": \"65471222e8c7c3bb3c2c5501\",\n        \"payload\": \"{...}\",\n        \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n        \"verificationMethod\": \"Ed25519Signature2020\",\n        \"verificationPayload\": \"{...}\",\n        \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n        \"verificationArtifact\": \"\",\n        \"verificationSignedBy\": \"did:key:z6Mkf...\",\n        \"verificationSignedAs\": \"individual\",\n        \"verificationJwsHeader\": \"\",\n        \"timestamp\": \"2024-01-15T10:30:00Z\",\n        \"signedWithoutObjectReference\": false,\n        \"objectType\": \"revision\",\n        \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n      },\n      \"active\": \"\",\n      \"forgettable\": \"\",\n      \"compatibleWithVersionId\": \"string\",\n      \"lifecycle\": \"draft\",\n      \"dataUsingServices\": [\n        null\n      ],\n      \"openApiSpecification\": {},\n      \"dataSources\": [\n        null\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all consent records
Source: https://docs.igrant.io/docs/consent-management-individual-api/service-verification-consent-record-list

---
id: service-verification-consent-record-list
title: "List all consent records"
description: "This endpoint is used to list all consent records available for an organisation defined in the consent building block. The results are paginated."
sidebar_label: "List all consent records"
hide_title: true
hide_table_of_contents: true
api: eJzdWdtuG8kR/ZVCv6wNDEeUZO9mCcOJLHk3jB1HsazNg1eAijNFTq96ume7eygyAt/yJfm0fElQ3XPjRY68QIAgfrDpma7qutepmgeRk8usrLw0WkzEp0I6IJ1XRmoP0kHtKAdvQEnnAZWCzGhH2oOlzNjcAS5RKpwpgrmxgBqMXaCWDpkj5DSXmnKQGnxBHfGsliqXegEzZbK7FD4VBJZcrbwDtAQVLqRGT3kqEmEqsoHbNBcT4cguZUY/kZVzmYXn55HrxyDRe+m8SESFFkvyZJ2YfH7Y0fJDXc7Igpl3WngD7k5WQYfmcml0CmegaYFeLgmMhVpbwjwou0RVE8xRKQczzO6Yw+34luWVfMWvNdm1SITGksREmPncEctl6ddaWsrFZI7KUSJcVlCJYvIg/Lrio1J7WpAVichpjrXyYjJORCm1LOtSTMabTfLQslWylH73ym1d/4wrJgR9SGdLvrYaKgpaU/pbBTwebzY3TOsq9oXj0yfjMf+TGe1Je/6JVaUalx394li6hwH3yrKjvYzU2dCn4Yn0VLqBGGb2C2WsvJde8YOtMNizw9lO5AKtKkvOketePEO3HbDS7UTqNw5cRVkXec/ZiAhO6oUiuECPZwtLVJL2IagtQVk7DzMChOsP079evw23eYucX0bDsxw9ArZUYGkpnTQ6AalzuZR5jeq5SMRqpI0fST3i8zN01Pmnd9hnIVnvjtnHhtcf0RUiEc6jJ3GT7Fha5gOjOm+lXohEzI0t0YuJEImgFZZVMPG3L198d3xyckK/y77LTmez0+wk+/778fGetf8SnOOgxDUrX6HjOhISZbYGZ0qCs8tpV2kc3EtfmNpzAZlewLPLd88TyEkbz7b3BXquH+tQHBB+FrnFuf9ZJCBTSgFhy/fxvHSgjYc1eXDe2L4ItRYE1DkYrdZAK65u/NqidtKncMH8t7k6yE3gWOCShfjYeWpWe5BzqJDdAHUVlAGEK7nQ6GtLCSAXDJl3ROAKU6ucbbMgzfWNa90mEfkwhqYHXbMaze9GpclJiYnYirk9N3Bd3TrB8XpfyKzogr5ABzMiDQu5JL0nQivwE0Rpjx6UolPczDsnDML+SzKBN4+KFUL7yeGLx7OT7DR/QS/n36ZpuifouanWrYBtIrIwRexQ/IvDil9Lnak674PKtb4OUUXa1ZYc4AKldh48lhWxaDE0mMBYyW1G9UYI/u+z/gkWn3aHD9q8fw33hQlWZTG5oXNp266HfLmp/FQPbp0Zowj1Y/b0tqa9e21Nk2CtXpNwc2Wc5D6q1mAqHwyXwg9cwg4epxX3CunVGhzKHLSBZ8YG8+UW7zUgVOwiU3eKPA8GjFXuySERDXLQfIETzCWpfIiEmvYR32YF6gU7eu7JjnxBozlmPoVpqD8lV3kM/WS2Dl5vKgq8eQPSO1LzFH4KhSGwcxOodZToqCId+k5p7CC63FEnMGmGA59FS8EVPv642cSfgeIJYdTVqQNNs4/rUFQ5BVhdpYI6AQW5NmV2GiwnwiDmpO+D/466PJvqpcxljSqBEu9YY+lhGdBdAFrMJabPqLLGzFP49OZiAh9JRYQZGnCnAUQ88fsQCZR5Yy8tzcmSzmgIHtBaZKz0KKjYtkPT9CnmfhVYcq2PV0BOHqVyT27TkUwkQpmII/a7cnPkyXG8J/IHLKm1ccPsixm+TX0RYJBrFZSuS1rGwdr4UKvce3T+usq5e30F0504YcwdClJ/mULnoW4Yb8KfZNt1G4b4LU7/Eiq87E/t2jirrSXtL3FBj8DbreYQTweg3KDpoQeOWULjUU13Quoxfp/48ACWh1Dsx6kh75OXLXOW9bcwZ6F5UOEaZjS0c0N3w+kmaYaJ/8z7w47I7fSwZY3xJhEFusumRj8hOrhbZVwEGUt5xs7fuGGV370i5FW85QOt/G+/QdPK73Hn3rYVdk1ghUe7qGF7IuZRmWtDnWXk3LxWiitNQZiHafSBObyIw9E2oxlyglU1S9NMrwcIj79qqhqWHbLW2HOTB0X598Xg+ptdTXezpac+FCKd4V6M2fV77A8Usr54vTmgeJP02xa61lj7wlj599Dvtk3z8isHzv8v00y1J8t4khckZCFcs2Oj2BRrK/06bEXOKvmO+OcNT+8eF7wsEcPVCuu+Gm3NvKPM1rnqwIPYP1BJOTJ25EhHyNfAwgMnXUYarTRiIk7T4wSO05MDp2pHWWil4vp8dD66nJ6Pzkbj8WkwlOdbjI5rnjvW5osCJyJgFhac9yiHCfYU6KmCIo9Tdgr1FJ1ij1O1CvZEO4qye0ryheEN2ILigssXYiKOmn3Y0XLgtaOmw46aksTQMETFoWXYBZWmCRqRiNqyUwvvKzc5OsqpNCOsZCoXFrVPpTlaRkW2eVx57rKLx9i4+PoAp5s+Iq84MWM+tXHZw7X4oFl0xZDul2tnTU1ou/wOhr2cBrzJlYO0b0wUJ7q4xWtQ0u0Wn1uI13QLHEZ9ckV5RLG3UUa4hWfaeAoMeKujghkqzOh5ApQu0h22E2gIX61Nbdkioztav74Ns8sbQkuWz7Pus/C/H1q496e/fdrXTQOGLgPe3FE3XPezVBLQVVNOeLkyGLMCSRIlH1JXVi4xW0OOrpgZtDkos5A6YeSHzdG5NWW8Kmeb+jVU1ixlHnFBnG/7NXAKV6TDBIBuzx5RaXgVGL8OG9RQo0MnD+9EV385oMQmjMlz0xZ7zEKxpxIlB52rq8pY/4cu0PpAkT/2j7YjtD+8V1g7Inj2r3/88znDU4Sre8qlK+Iag1ZxDAyzyjAPoUnOzjhhMKxdANZqPnJmSZbkQndmTIajT2YpPEbleIOUy4VkVHePSpEPlznDs2NlcvCUFdqwo8glQBpnIRIZ3dyDoiWpANi4SYR9+kwq9hozwdqbEsOiLTNlpSTqjGKUB/UsLeo4bDnG/wgB0gDWufRBzhK1JsuOUzIj7UIbbHOzwqwgOEnHeza/v79PMbxOjV0cNbTu6P30/O2Hq7cjptn0QL73A2d0brKalyZtznNxi/46GZ+8SE/T4zAiGOdL1AN53j/yHWM3tQY44n/yo0iTEJ5W/qhSKMPmLtj3oWkNn9tPJdE6fUtPxG57uElEYZxnmocHHhKurdps+HH8phCahnSsUP9d4FFz/Xe/rhxUPLbV7iPLVot/uuBf+6nkC6K0A1YvyQ3/x4bEDoCrRWYD3HKWZVQNqfbw6xYO+PEtNwRsukXfKe9Cp2x+MPf2lV4PeO82zSgC/81GO0jyihPvHa1fd8fjm0cJukYdT7OBbjabzb8B3Evtbw==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all consent records</h1>

<MethodEndpoint method={"get"} path={"/service/verification/consent-records"}></MethodEndpoint>



This endpoint is used to list all consent records available for an organisation defined in the consent building block. The results are paginated.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Consent records listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>consentRecords</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c9901","description":"Objects may be passed back by some API endpoints without an ID (PK), denoting that they are a \"draft\", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"DataAgreement","description":"The DataAgreement to which consent has been given"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Revision","description":"The Revision of the data agreement which consent has been given to"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Individual","description":"The Individual who has signed this consent record"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`unsigned`, `signed`]"} schema={{"type":"string","format":"","example":"signed","description":"The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed","enum":["unsigned","signed"]}}></SchemaItem><SchemaItem collapsible={false} name={"signatureId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-fk-model":"Signature","description":"A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sectorPreferences</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Name of the sector"}}></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines sector is opted in or not"}}></SchemaItem><SchemaItem collapsible={false} name={"isLastUpdated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Defines consent record for this sector is last updated"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentRecords\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c9901\",\n      \"dataAgreementId\": \"string\",\n      \"dataAgreementRevisionId\": \"string\",\n      \"dataAgreementRevisionHash\": \"a1b2c3d4e5f6...\",\n      \"individualId\": \"string\",\n      \"optIn\": true,\n      \"state\": \"signed\",\n      \"signatureId\": \"string\",\n      \"sectorPreferences\": [\n        {\n          \"sector\": \"\",\n          \"optIn\": true,\n          \"isLastUpdated\": true\n        }\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create webhook
Source: https://docs.igrant.io/docs/datamarketplace-api/config-create-webhook

---
id: config-create-webhook
title: "Create webhook"
description: "This endpoint creates a webhook. The webhook sends the events that you subscribe to, to an external IT system. The payload URL must start with `http://` or `https://`, and it must be unique for the organisation. Subscribe to a minimum of 1 event type."
sidebar_label: "Create webhook"
hide_title: true
hide_table_of_contents: true
api: eJztW9tyGzcS/RUUnpLUkLr4sgnXca0jeRMlceSK5HgdWyWCM80hIgwwATCkGJXe9kv20/ZLtrqBuZGURTvJy4YvKg4GaHQ3+noGuuEZlBZS4SHjo6lQDhKegUutLL00mo/4+Uw6BjorjdSepRaEB8cEW8BkZszVkJ3PoH5gDnTmmJ8Bgzlojz+FZ0tTMVdNkOoEmDcJ84YJzeDag9VCsZNz5pbOQxGolWKpjMjYqx+/Z0XlPHNeWM8W0s/YeOZ9OdrbGzNjw4PDp4QJnTHpw/wJsErLXytgU2OJHWNzoaUTKNSQnXWYYYIVUsuiKpiZsoPAOPPLEobv9DuN/Diwc5lClA5EOouzhEMxvjk/f8lenp6dIzXf5z8INDHZks2Myhx7xKYSVOZGbJyBknOwy5PjccLGUYXhwcsCnBdFSQ/LEsYk3zgTXowDzThM1CLtA5QAGWiUnXXEcUFH+D7Q6a1tzoyZyS+Q+iH7p7Eo3enJ8cOfjsK7pF4Z1oy7Wj3J6BCYIcMRio2d0NnEXJ/aPL4Lm6cWMtBeCsXi4ZQWHGhPZJiF1NhsXfcy11H3td6CQZA8/xqcfG2F9oMzmWvhKwtjNgORgQ3KmgtVAZOOjf2XTxrlPk2czL98MoPrp+OELWZggY3DI85FysoswKbCAZvBtcgglYVQ7JsXz44GZ988O3z0GFU+7pAcPvnFGT2IJvB03DLpILXg2RUsA0+1ZEItxNJFAXHit2enP9Q2lDChnEHedFCe0b4+UJJHlKWSKalu73qwWCwGU2OLQWUV6NRkkI2H7EQHP0Q5EvKqDPBd0F3caYy+UkSbmMDUWCDHTWeQXgUBat2uHU4hrgDNrzkZ4T0UpSf3a/2F5LbEtzZMVN4UwsuUWfB22RC14EqjHaDX+8ox4pQMWzpmSrDBTlD4w/39ccK08fjzIDpGs7417Fb1TGqWKhCWebj2w3eaJ7yheZLxEU+Nnsr8iOLc6+CTPOEWfq3A+a9MtuSjGx6PAX92DwCPHsdcOoNC4K/SInUvweFT9HFaptTplI/e3hBpaTH+vuXxLF5ZxZN6k/NlCTzhrU8/p9CKQyTWd7DkFwlHi+AjHryXJ9xLr3AgSHJqX5VZT6LVKN8G8aCBKurZmxj0yVsNq4hO34Rlro0Fx8YSHR3DAnl8PwKECNZGNianITNACAzFkJ145smUVkM2m1pTBHMNw7/VMad2c56s6LqjytFNrR3nrdT5Rukxip+hjBTO0UnIZyykIOeRpVpDkXY3tmyZp0gJ2+QonnC4FkVJZ1gvjyPD1BR7yIjbkzmGPX7bt5atBO6Fkpg41gTEJLBFjEnWAhf6JwZ1dDjBnNS5gm6E0aKArA0+JK+uCnSCNY9K+L0c8IvbDS7S6mHNLTa407qKOskzWENXR7VlJCjiA5ZbU5VuyJ71y4mo2AdMWIthns4eI9N76o6eb1mYVg6o0GinBG4ojpKGKVVJ55GU9C4w06eTGQjTLRRmDiyrgkqjAbt1D0oximr/QmiRQwHav27DV1QrCbWmuqOwkBXNyq4miS3XVIgmTSsbEpzQTOpMzmVWCcVycjtjGw1EfhIcE+7KYTTKQIGHhGVmocnsjI0RCnUiLcN6BUWTHgp3v2OcrVROHbMkSjH6SS29pKI56Y2nQqegFI1HdodCYRHRHcmkWx/EdHgJ16W0y5poEG59s1rYDW/Cii4b/RXtm4vb24RnMpdeqNdCKdj6eI/DIragVf2jfU7pv1szMjo7St5klX+PYbwELbPhZ+NofkzYUI8YrZb1GFl5U4Oe4OGelqDx6SWT2kMek5QGyFysi6NMgbvOBhNQRud1jW5UBpYdnxwfmaJgpTXepEY1RUjNX1usIqVoslODp0dkpHMVWOZkqFE6vMJ1OhM6j95c05vRvveSDdOIbH99t1QefjacP1hdjRw0Kqp5GLFxLGAucTWm5vo5RrE6PXfpX4r0Cl+kpoA2Ac/ByqmMzCUbVpWgM6nzrQl2ZaV67Pe76vrhmekULAkfCr6Nr2tdbJzS/rykQ793Fgl7/6QUSn//vODYm6chO+jWlxloecccb65ArzG+bo2dLeM5bjl7Rdp75q4K3TPrrqkO5w/umVUf2t0z101wy7lRAzg7REvhxQthr8CXSqSwdbwUXrCiXbddMvSd3F2jLk1yQwAGuWGZdKkyrrLARG4hJNvYQv9hWa/D+xCfL9tdL5tdL8OuqKmQWZyYYJ5pN58Yo0Dotd1fo7hjbyuIdWRdYXVKFjrjqLjYZUrU3mlEG4bsGKaiUp6qgjEhWVRUZmE4glu33abpfrW0bWPlIKNWyBRl5eFu1KELDYTWpG2C6/a47lNJKBsSpPREvmm2ReVn6C6p9Mu6iGyq8mNDaqkcMBH7DzNlrhQpGolWy1HPfIK/0R6TiopYHbEsbdquvumkUElXsjxz6ieK9aHu/piDRAbAtudIuWNJr86/P2Mp1prTUIT2RQzQ2Yce7u3txUf0tUOO9trtwus2fa2rDpa93QZD3iWKSqFdAjZBPnm4v/9nYgmS4iu23ljZfxCw0Dhv1102WwV2VLGjfx8KcRfu8OyO04nm0IdtN6FmAZKlqjM0lg1SRCwkWANB6VewiPVmR2b3x4NXoV+XlMeoBuq3zf2m/fHn4mB6mD7IHsKj6WPxt8nn6RfZPhygf4Vj+fgNe9gIVclmoV2fF3Tjjsy/Y7dI5j2nUeP+0tWngFU8Br7mQ0FgMxThLuDuNd0MSmWWBSGEz9b660Cr800h9rhmoZlLTQkk6ofAPduBO38uAnO0Bfqyw0R2mMgOE9lhIjtMZIeJ7DCRHSayw0R2mEhTsmrTh0OWoeL/KHSjqeNq5Yb8ZFgqVFop8T7AI4IcZroJ49jQH8SrGN3P8PgUWrhWytAnJ8wZSkSQBgabj/vC0cfj7ju8WfEHgxe9IvHD0AvkpG2N7+9Jzo8YTr/L0LOuFVB5PX7z5s2bwYsXg+Pj89lsVBQj534OtziEv6PODamvexCGSsxYqvVansP9w8eD/c8H+1+cH+yPDg5GB4c/8/swlp4lga2Zb9nBrAY+dFzhukD9Vb++IkDPnWsC4b7U70NpTr/jCQ+Wiq6PEx5+IPrS3RqsNfbIZAif0O/jzm4bUJB+D9Gubq2CCjew3QN4uL9/u4H8Bktqz+wr/PCuy8qzUlhRgAeL6lhXCE6M2WLlbBpHpZ3xkgYGap0JbxqMRTpWSIcf9ROcsGL6rbltc2+PNqjNp70sJYo+TbiWzrukuTTSvcHXhEJUDLVCcrrSGxISsXp5ipxaKElpYdU6Dv7C1vFKI/xsrPyNCpK+ah79pR3nRMc7q9FhaJsVHYU8XFnpl4TKPislZeS3Fxg8vcgd6uJ1G78K8DODl89K40hs4Wd8xPfmh3sBFt1bNPhp2NcR4ZWaCgoT2eIJrxAJa3CrDAozEKUcBrhqKA2/TVYJnHmRS53fRcOF16tkLlppz/DQw1nVMrd1YBhIuMStgrp4wvEeEOLA0d5qUHkFJX55QnVK81GkA0E2nz8ob/ToNMVJfeGqtDCV15DFkBR4ZGP2iTaxxPFWSEU6wI8pnyYMhvlwheyIxYVPlqayqI7BFSyfjkOKQgf4sb0t+Lw2sR5i30Ur78cWV6DFTWDgJpjvbqzqLuDm4i7045728eLuPuCjquVuqRwvpXcK29Z/N1Z68VsQGtrU1JFKpBSpoBBSEdJZlsb6f7Rm3Fii/Lod6tt/13VWDLRZxD7577//8ykmF8HOFpBJNwtNSQ07UIkz7zDcFGmlNXNJN5ZPIkDkQE0HzszBgsx1BOb9MonrUUGd29R4v5tlfRwKN3NGyYyVJmMe0pk2yuQSEVrQYkKmLpiGBVMwB0VYKUY4uhM7kQq/PiKR+rKuzukTqJLYXAc3IvEs5NgnSKNduPE3rZRCh82kJz4LoXW4pqlkCtqRR9TOX4p0BuxwuL+m88ViMRT0emhsvhfXur3vT46e/3D2fIBrblsEuz0HDBmZSaui7lx5wjFuhvM63D98OHwwpG8xGHMLoTv8hCuzbLH5m1Un9e3+OWL3zxG7f47Y/XPE//E/R8TqDQf2SiWkxpBZha+soUx9y+eHoUSZSkzKnb58huXs6C2/uZkIB6+sur3F4V8rsFQOJ3wuLOUxKo7rKppq2ytK9fEz6SDeVSBT3VQBYTEbVjwjIPW9c7sVN4YmnvBJ/MeOgroLbsUCr2+IBR/xd/wdJ2SUsht1NDh+w5XQeSVynB/oYtGBJWq/6r2iqjf+QMnqV3rZ4XK1AA7C4F8UbeOSJ5jjvoPl02Z6eHPngqboDrPxLBGZ/B9fI//e
sidebar_class_name: "post api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create webhook</h1>

<MethodEndpoint method={"post"} path={"/v2/config/webhook"}></MethodEndpoint>



This endpoint creates a webhook. The webhook sends the events that you subscribe to, to an external IT system. The payload URL must start with `http://` or `https://`, and it must be unique for the organisation. Subscribe to a minimum of 1 event type.

The service sends each event as an HTTP POST to the payload URL. The body holds 5 fields: `deliveryID`, `webhookID`, `timestamp`, `type` and `data`. The `type` field holds 1 of the subscribed event types, and the `data` field holds the event object. For an OID4VC event, `data` holds `organisationId`, an optional `sandboxOrgId`, and the credential or the presentation record.

The service signs each delivery with the `X-IGrant-Signature` header. The value is `t=<timestamp>,sig=<hex>`, where `<hex>` is the lowercase hexadecimal HMAC-SHA256 of `<timestamp>.<json-payload>` with the secret key. The service always signs the JSON payload, also when the content type is `application/x-www-form-urlencoded`. In that case, URL decode the `payload` form field before you check the signature.

The service makes 1 delivery attempt for each event. There is no automatic retry.

The response status code of this operation is `200`, not `201`. The response holds the secret key in clear text.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The webhook configuration.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The webhook configuration to create or to update. The service ignores `id`, `orgId`, `sandboxOrgId` and `timestamp` if you send them. It takes the organisation from the `organizationId` header.

</div><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTPS or HTTP URL that receives the webhook payload. The value must start with `http://` or `https://` and must be unique for the organisation.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"The content type of the webhook payload. For `application/x-www-form-urlencoded`, the JSON payload is sent in a single form field named `payload`.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook does not receive event deliveries. Optional. Defaults to `false`.","default":false}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key used to compute the `X-IGrant-Signature` HMAC-SHA256 header for each delivery. The receiver uses it to check the authenticity of the payload. Do not use a value of spaces only: the service accepts it but then sends no signature header."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the server does not verify the TLS certificate of the payload URL. Optional. Defaults to `false`.","default":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The server sends this error if a mandatory field is missing, if the payload URL does not start with `http://` or `https://`, if a webhook with the same payload URL exists, if you subscribe to no event type, or if an event type or a content type is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete webhook
Source: https://docs.igrant.io/docs/datamarketplace-api/config-delete-webhook

---
id: config-delete-webhook
title: "Delete webhook"
description: "This endpoint deletes a webhook. The server disables the webhook and marks it as deleted. After the delete, the webhook sends no more events, and the other webhook endpoints do not find it. The response contains the webhook in its final state."
sidebar_label: "Delete webhook"
hide_title: true
hide_table_of_contents: true
api: eJzlWVtzG7cV/isYPMWZ5UWXuA6bydQVNRmO7TpjyXEdWyOCi7NchFhgDWBJsRq+9Zf0p/WXdA6AvZFUpaR5al5savdcPpxzcG57TzmUBlLmgNNJxqSFhHKwqRGlE1rRCb3OhSWgeKmFcoSDBAeWMLKBRa71akiucyAWzBoM4cKyhQRLXA41AWGKk4KZlSXCEWajCD4kLzMHxpOGR0mPzYLilihNCm2AwBqUs4kXhlTa5WAa2hqeJVwTpR3JhOJEuADOgC21skBSrRwTqg9PKCKcRQ4miXXMwZAmVJdgGFpgxumEplplYjn1KD8EPprQkhlWgANj6eTT/YHZgMymRGc9ZU7Hs6IOuGNFKYFO6PMX7CQ7Tc/4OXyTPWd/WrxIv+VjOKEJFSisZC6nCVWsQOoobMZpQg18qYRB5zlTQUJtmkPB6OSeum2JxNYZoZZ0l1Drtl6ZFV7r7ga5g2UsMpyOx/gfGgmUw5+sLKVIvRlGv1g81n1HQWnQSE4E7gjKs0n5NvMmadF9ogLharP0sEu2lZrx90bSpNZ4jYATaqsF2nEB/NL7nCY0hhUyWkgNuFewxd8rUV5Z+RMYkUWYNKFOFGAdK0p6k9RG0ItfIHX+pfM2aJ3Y99rLxlPB5VUIgtqN2iyZEtY/awNfpECY3LCtjUELazBbkgmQPHAKSwKEhMBdCqUjc8sUX+i7t2iQOUZD35yCH/pwH+x7Jb5UQAQH5UQmwOxF2xNjbFe75bcr7NqFuJw5ojf9azb0Edg58/+gLYr5L94IbvB2j15Qcksybdq8FWAuQGq1tHgvWSOXQyn1tgDlhqQNCAMpiDXYIAtxhJyEqDCB6I0iNtUl+KN2Avzxg757HdA0KropI0rqOzN3rrST0Sg+Gaa6GCG1HYmlYcohhO61ehTDRSAmSLWftLoIVFXgZT7IDEnv0d1gs9kMMm2KQWUkqFRz4PRmd+R2t8gOLumxTHCQY70TPGwbjNhFXhs0wSx/RpZGV6VFpxZCiaIq8KQn9XHPCDMGL3FRWUdyLTlhfcJWVz/cDGSVxaKoOiQBjbC+HgnlVUhhXR0vHkxfDtcQyA0Ueg2EV8GkQNZMVmAP00SK2Vu5N0yxJWDEfmjTcDSrP9QxfyMjKRrOriU9LNtGeJpWhmxyUHhEobhYC14xSZbhQpjGAhFPgs+YXdm24CWE643COMJ3VcnxWC4HYQhnjuHRhIPCPh6qV01YBHydsPSSguyhUMIJ39ckvecpUynIUE0i3CGTUm96T7DkHDxkldO3cFcKs62Fxmp+oKw+7JE3gaMLo8/RvrnZ7bD4LYVj8gOTEp7s3mlgIhvP1Xftpa9Ob2fT858u4hvvO58ufVT+2QfrXJegBB9+PY/hR5iBkO4xA8ZnPsqZivJm6Ny3JSj860cilINlLKEKgIfAIvN4poCuoyCkYwwar0ZyMGQ6m17ooiCl0U6nWg4/q8/quoMvNeBLBJMoKYZsptF7XoywtgJDrOA+s3Wwwl2aM7WMt7mWl3u9j4oNZF5sn780gNESytLXw/XZPjciaExUY5iQOXZLYN0tcs+T9u+Yxfjcd7/zrvxblq7wRaoLIJnRhYe29h1RBJcc4SpBcaGWTxbYPetn9btc1UPn6SwD4w8f+u+jr2tbHCVpf956pz9K5Q/7OBF2bI/TxbnmKBnCwWt9y0GJB2icXoE6AH4YjR2V0Y9PpN477SO0+4fuhXU3VIfrs0eoaqc9THkYgk+kjRZA6pAtmWNvmFmBKyVL4cn5kjnmh9TI97Ri6Dq1OzXAXCiGodDgjIxocChOpbaVAcKWBkKxNZBqw3+/qtfBPsS/b1utt43W26AVLRUqSxyrWuULrSUwdaD9Ax53jiPmPDnaYeGgHmzGQQqsMKHjb8a1xw/oSckKtm0fVxs31CdNUibTSsbOgcz/Ppj9gN3u4EosFXOVgTnJgfEwKgBL8xbNQ/OBrzzYn6USmCEO7ny3Fka49pRhTk6I1b4QQRoANqsFZslWV713K4g2ODKm/gaLHzSJPsuHSeT69RVJsSvMQrsYO9rYuJP37157JO1o/PhMcn1BkPyhQOfdKPDt9fzjx48fB2/eDKbT6zyfFMXE2p/nOHQVzD3Q54bS13WE9i1mbNV6I8/p+PT5YPxiMP72+mQ8OTmZnJz+THc7XGMcTgXN7mlvxdT0HyHy53E8FLYe4IPFhxTvR3d7Ua83DnYK4Sb1ALx9RRMa4hAvNhKcj09+1W6lqxqM0eZCc1yO+N/TjrYjO47+hNBytz73bRmYrnnPx+PdEfFH4qT1yF8ZJ0KVlSPNJgzNcWiQ94pVLtdG/MMXlH3TnP+BTfMOrK5MCmFrqSvFQ4j2Nio58/m1DuqNcLmPaRy/FJlN/bjV22m2W9YDe3/zK9d8/1/2nikHxm96w8baq9mzUahblRFu67eYL0vhK9inG0w2ji1x39usEG8SWoDLNe6Jg9H9ftPldEJH69NRWCSOomtG9832dufXmYji2P54CoWOIGlCK9wjNVsfDoUesFIMw7JnKDTdJfsCrhxbCrV8SIYNr/fF3LRnv8IQCJ6rLdB2UeFBXE8H47UL6pfxttcr2b0d648zX+UxJ2C3mXYWeLEIhPI178lpSrtfzyyAlAYycQc83Id5wEjm5CulY4PgDBPS26BkKTxLCAyXwz2xExIZv9vqyqA5BivYfh9LgFCZrm8LS/1tgYIJ6bdTZamN+0trvOb84of2Ud/qXYftmaVhIl/9+5//euZrErnaABc2D41kPSr6qW3daSeawloavRbY1JNZHOotyGxg9RoMiKWKy1S3TSI/VkHStv34gYXw/u4AlVktBSel5sRBmist9VLgVg0UW3gDM6JgQySsQfr9Ft4y/wllIaRwWy8EtycFc0ie6qKUAgei4Dx/PANL7O2EVhb7CUaySkoMEy6cx1kwpcBgRpMiBWV9HqlDrmRpDuR0OD6w+WazGTL/eqjNchR57ej17OLyb1eXA+TZtVvH1g8YqFynVVFPGzSheFuDv07Hp+fDs6Hfn5fauoKpDp7wrahOyPt3oJN+/6Df12IewXZ7VEomFJqxCtvykDw/0fVp2L1lApN9a8pJ+wHsJqG5tg6p7+8XzMJ7I3c7fPylAuNzdkLXzPhAD1m2GXqOfe3sOuard7HyPSNP+Jh39EB1tlSYKn1uoxNKE7rCZNr5jrfD1XjMoggyvH/pZ/AO50Gh3nWLz/Ty9eX1JW7iK7RfN1evfK6OP1DBUWD7aTugwH+xuhxl+Q7vyCvYft+QhzcPMjSlIlCjmXAa/Q+ejdAz
sidebar_class_name: "delete api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete webhook</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint deletes a webhook. The server disables the webhook and marks it as deleted. After the delete, the webhook sends no more events, and the other webhook endpoints do not find it. The response contains the webhook in its final state.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to delete.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all webhooks
Source: https://docs.igrant.io/docs/datamarketplace-api/config-list-webhooks

---
id: config-list-webhooks
title: "List all webhooks"
description: "This endpoint lists all the webhooks of the organisation. Each item in the list also gives the result of the last payload delivery to the webhook. The server does not list deleted webhooks. Use the `offset` and `limit` query parameters to page through the list."
sidebar_label: "List all webhooks"
hide_title: true
hide_table_of_contents: true
api: eJztGttyG7f1VzD70iSzoijKcR02k6kreTIay5eJ5LiOoxHBxdklIiywBrCkWA3f+iX9tH5J5xxgbyQVKU77kumLLe6e+zk4N+xdIqCykHEPIpnmXDlIEwEus7Ly0uhkmlwupGOgRWWk9kxJ5x3jSjG/ALaC+cKYG8dMTr+NLbiWjiPqiL3g2YJJDyWTml4jMuPKGVbIJTh6ZsHVyjcEFHeeVXytDBdMgJJLsGvmTZ/biF0ugDmwS7BMGHBMmyAYYoAH0co1Yu8cEO7M5LkDP2NcCzZTspR+xj7VSL3ilpfgwTpkVPECMaypi0Ur9Ohn/bNGrhpW4HxDn2WmBMdyaZ0fSGWhUjwDx7juOPsF90w6psCh6lyzMUnDW3kaiDEzNoCtpA9SCMg52mnJVQ0kTmfdhVEiGNNBZsGzG1g3Bm0klZplCrhlHm5RnSRNTAWWPHUmkmmSGZ3L4lw6/z4aL0mTzjTJ9OPdVmC8rss5WGRkITNWkPncjaxYbizaUeoYCM+ZhoJ7ucQIYbW2wAWfKwjasJwr5dicZzdIYTaejZI0kciCHJSkieYlJNMkWDJJEwufaml7IeuyBZQ8md4lfl0hqNQeCrAJRjNZLpmO06SUWpZ1mUzHm01615Al62+zHOr6it8iItP7dLbga6tZBaQ1jD5XwKPxZnOFuK4y2oFD6Ml4jP9lRnvQHv/kVaVkRpY9/MWhdHc96pVFt3oZsDsnEKZSb3JyZJTBzH+BDDX30it88LaDT7dIZbW1oP1bXsA9WvTtdRKgw2kKRkvSBG55WSGjo02aeOO5OvNQukfQu0TgnvUx7h3jSy4VBlKf9uTrhjjK+jnEUWiMRweCGc2a8Gg5HG/SGDMP0369JXITJANrjDdpsuDurYWlNHVf5LkxCrjeIXumBcYAOCbpnFv4k2OcVZHCDguKwsDlNdz6z+eg4dbvUPe2hg3F7nbpgF4eYIJ7TrmhTavJJk2aXI0y7aJ3FUbHcvGpBoc5vjlqsgmhLry70/cxkQJTnS3OBOUzqizvrErS5kxdoh3SxNVz5D0H8WIJ2mP2E9JhcCFiSKwvATMDprgLp34EK/N4EOkIleA8L6vkKr33fMXUumPs572Kgmm4Dol5f1lt6ozMgHG14mvHHGjhGFCxzCUoETClY0GElMFtBpVnM8e1mJvbN2gQyrPDUy5FLzSct1IXO8K+0/JTDUwK0F7mMkR3vz73QyN5+owf5ZPsWDyBr/On/M/zZ9k3YgxH6Prgls9n2LdLKJ5mpd1Qlk2a9HX+HdwimV/xRnAD2T16Qas1RTxvHUxizkEZXVDx4C1dAZUy6xK0x4rZwFvIgJolooVyAMVnSCkONWYuMxWQqr0Af1jRH86DNC2LfsMQKQ2dufC+ctPDw/hklJnykI7noSws1x5F6B+rB2U4CcAMobZblr4EGov2x93alw4e3R6sVquD3NjyoLYKdGYEiORqs+d0T+8vgvsywU5eIieQ2C4YsS95Y9AU265jVlhTVw6dGvsP1PSoUfeYcWvxEJe189TLMT4E7HgNw81CXrvQZHYgbROJTXG/747xQsIM6bQ9tIXSLIGJOpg09mduN01k2J9o/4prXgBGbJPYOrOSUvv8jYisbDH7liSxXBfhWVZbtlqARhWlFnIpRc1VnB6MbS0Q5UnxGXc3dLDCLJAyYVaaxglsPSuBavkFSEvlaFBAfj1UL9qwCPL1wpIoBdojqaWXNE6lg+cZ1xmoUE2iuCOulFkNnmDJ2XnIa2+u4baSoTFFokG5XWaNsnveBIy+GEOM7s3VZoPFr5Ceq/dcKXi0e08DElsR1tC1L6g6vTk7ffLjSXxDvqN0SVH5lzipVaClGH01i+HHuA0zHGXA+IyinOtI7wyd+6YCjb/eMmrGYgnVACIEFptFnYJ0PQYhHTdjplECLDs9Oz0xZckqa7zJjGpHwEa+zAKVCK6QUgzZ3KD3iIx0rgbLnBSU2Xqywm224LqIp7mhtyC+D5INYER2iF9ZwGgJZemr0fJ4GxslaE3UyDBls9hSXSP2LO1+xywm4szcp3/Nsxt8gfMvy60pSbQldURRuHQPVgVaSF08mmBfVxpZf/9R3XWeyXOwpHyYife+bmyxF6T785qc/iAUKfswEHZsD8PFncdeMBQHj/W1AC3vgfHmBvSO4LvR2GMZ/fhI6C1tH4DdVnoQ1v1QHS2PH4BqnHY/5G4IPhI2WgChQ7bknr/i9gY8LX4enS9xIio7vMcVQ9+r3ZkFGtLa4oZDGg1aQrpMGVdbYLywEIpt2Fr896peT/YR/r7uuF63XK8DV7RUqCxxrHp4CH2P6s5wvJylezsspk20WbMsDB1/O649rGC3Mmv7uMa4oT4ZlnGV1Sp2Dmz294Oz77HbPbiQhea+tjBjC+AijAqAe7lWmvvmg7D5Gmzl8FcY4TotwyYoZc5QIYLMN0tTesG4Y2tTD97dQLTBnjH1Myy+0yRSlg+TyOX5BcuwK8xDuxg72mZ/++6Hc5KkG40fnkkuTxiC3xfooh8F1F7PPnz48OHg1auD09PLxWJallPnfprh0FVyf0+fG0pf3xGGWszYqg1Gnsl48vRg/Oxg/M3l0Xh6dDQ9mvyUbGh9uDU6u3Pu/Gl0/EWdZeDuWWp87s47Bo2LDoqbmUCgRZTYDqPwHqjO0sjYrO+p+ebMee5rhBOx2k7GY+Q4GT+jHnoyebrFkbb2Q7Zx111yAXgM75Gc1dpLxbRZjbZXRul2MGJ2GOxu9pp0Z7+yu3jqxud2gd7ZHKegvTYf7W5q3ku/GMhAhqOg7uf1bcFX/RV6u1LdFZzS4UDyNy+TNAnJBIMHAZ6Mj37TCrgvCFhr7IkRtK7Dv0973PYsqoYh3WHvW3S2vnwyxgXmDvk9h707Vn/jgkld1b67fkFz7Brknea1Xxgr/0FdwdA0X//G7fgfyzRn2oPVXDUnkdhs2SgUw9pKv6bV6PNKUln8eIWnxvMCb3baveRVmpTgFwYvhAq6aam4XyTT5HA5OQyrycNebAe+++6GTqE0UawkTWpcR7XLIwGlOeCVHIWd0UiaBLPpVln2eG6K+2i48HqbzFWn7QU6Pfiq0blrxsKDeOMTzNXdMj2P8dZsdrdSy9szahYwKrFpzXp7wFhLQnqcDei0HQJteeaAq/pc3uJdJWaoWZCRzdgX2sQ+w1suFdmg4hl8mTIYFaMtslMWEb9dm9qiOQ5uYP3dbEQpSercNOeDZ3Q+oORS0ZKrqoz1f+2M1+ovv+8eDa3ed9iWWVok9sW///mvL6lksIsVCOkWoR9tJk4qSsteV9LW58qapcTZgJ3F3YADlR84swQLstBxJ+vXacSnO8RuenAp9r7DFQQyc0ZJwSojmIdsoY0yhcTlHGg+JwPjtcaKKViCogKB54puR+dSSb8Ot7S1NyX3CE7lVeJcFZxH6lkosEWURjtsSzjLa6UwTIT0JGfJtQaLNUbJDLSjzNGEXMWzBbDJaLxj89VqNeL0emRscRhx3eH52cmL1xcvDhBn09Wtzg8YqMJkddkMLUma4GkN/pqMJ09GxyNaw1fG+ZLrnjzn4aJesd5hF8P81ebc/38g8Ef9QCBmS3xwWCkuNQZLHa4WQl34mCwnYVGZSyxibbhcpcnCOI8Qd3d4k/rOqs0GH4f7daoY7Ry477uTfoT9b7802KvmDRaM7oMDQk+mSahUjxb8t3428CuiNLfQnSRX+MNSEqR63hR+Mm5Aek7rlB7WTnu06Zf8719c4o1Kja7tF8sbKpbxj973A1yve7S362YQAf9Fo+1F+RaT1EtYf9eChzf3IrS1OkCjgXCr8B9fkgoc
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all webhooks</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhooks"}></MethodEndpoint>



This endpoint lists all the webhooks of the organisation. Each item in the list also gives the result of the last payload delivery to the webhook. The server does not list deleted webhooks. Use the `offset` and `limit` query parameters to page through the list.

The newest webhook comes first. The server replaces an `offset` that is less than 0 and a `limit` that is 0 or less with the default value.

Each item holds the secret key of the webhook in clear text.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"webhooks"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"description":"The webhooks on the requested page.","items":{"allOf":[{"required":["id","orgId","payloadUrl","contentType","subscribedEvents","disabled","secretKey","skipSslVerification","timestamp"],"type":"object","title":"Webhook","description":"A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.","properties":{"id":{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"},"orgId":{"type":"string","description":"Unique identifier of the organisation that owns the webhook."},"sandboxOrgId":{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."},"payloadUrl":{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"},"contentType":{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]},"subscribedEvents":{"type":"object","title":"subscribedEvents","description":"The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.","properties":{"consentManagementWebhook":{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}},"digitalWalletWebhook":{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}},"dataMarketplaceWebhook":{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}},"disabled":{"type":"boolean","description":"When `true`, the webhook receives no event delivery."},"secretKey":{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."},"skipSslVerification":{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."},"timestamp":{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}},{"properties":{"isLastDeliverySuccess":{"description":"The result of the last payload delivery to the webhook. The value is `true` if the last delivery is complete and the endpoint sent a status code from 200 to 208, or 226. The value is also `true` if the server made no delivery to the webhook until now.","example":true,"type":"boolean"}},"required":["isLastDeliverySuccess"],"type":"object"}],"description":"A webhook with the result of its last payload delivery.","title":"WebhookWithLastDeliveryStatus"},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"webhooks\": [\n    {\n      \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n      \"orgId\": \"string\",\n      \"sandboxOrgId\": \"string\",\n      \"payloadUrl\": \"https://example.com/hooks/igrant\",\n      \"contentType\": \"application/json\",\n      \"subscribedEvents\": {\n        \"consentManagementWebhook\": [\n          \"data.update.initiated\"\n        ],\n        \"digitalWalletWebhook\": [\n          \"openid.credential.offer_sent\"\n        ],\n        \"dataMarketplaceWebhook\": [\n          \"datamarketplace.data_disclosure_agreement_record\"\n        ]\n      },\n      \"disabled\": true,\n      \"secretKey\": \"string\",\n      \"skipSslVerification\": true,\n      \"timestamp\": \"2026-08-09T10:11:12Z\",\n      \"isLastDeliverySuccess\": true\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read webhook event types
Source: https://docs.igrant.io/docs/datamarketplace-api/config-read-webhook-event-types

---
id: config-read-webhook-event-types
title: "Read webhook event types"
description: "This endpoint lists all the webhook event types that you can subscribe to. Use these values in the `subscribedEvents` field when you create or update a webhook. The list is the same for all organisations."
sidebar_label: "Read webhook event types"
hide_title: true
hide_table_of_contents: true
api: eJztWM1yGzcSfpUunJLUaKgozoWVcq3XcqVUzo9rba8PtkpsDpozCDEADGBIcVW85UnyaHmSVAMz5JCUVnKOW3uRZgb9//N1g3dCkvNUYSQppgvUgQohKVReuaisEVPxrlEByEhnlYmgVYgBUGuIDcGa5o21S6AVmQhx4yhAbDDCxnZQoYHQzVnWnCDaEt4HYrZAsELdUQBlkpjZjky+YklhBgtFWsK6IZNlecJIYD10TvITDrpLeNdQMgtUSNICtgQL65OV1tdoVEB2JpSfzCfD5NZL8mAXiX5vC2HVAHqPG6gaNDUFmFNcExmoUOtQwqUFYyNIcmQk2Gx+klZ+MqIQ1pFPuq6kmIrKmoWq/0UoP2Rjk3fvOEyiEJ6CsyZQENM7cXF+zv8qayKZyI/onFZVEjb5LXAq7kSoGmqRn5xnVVFl7orlmPgzGqypJRNP9U3vTvJKB3njiPVyoN0JSuENPWUAW1Wdz2lBA8pItVKyQw21WlHg/HhadIHCIKrgbxiWAaIFSZoiFSDt2miLcpTP2JDyIDFiKQqhIrXJZDZNTEWIXplaFCKqqClH9jGHC0Gma8X040BcotZ2TVIU+y9dtDd065TfiEIk7dnGUhkVVeqK/nu28/T74EtZoalI6xOOk+87jlNZWfeYY7BUqjCYf70thrikWhXbzP4z+iVFp7Giv5l+LmaWBO1e1MMFkHqN/Ip8354BMLNLFSptQ+cJsPaUEgSeKuvlk7L7qDf73DLp2Fp+v9nrv9npv8n674+eqlVE/QG1pr/bOil2WQ6sk6B7Iyc79hWQ+8NQxQILfvMkyUSFGlQIHRdAapzxwYq8WvSIMEI9hgxUJmPf5dXlS9u2B9ahkensV0fm6vLZv1+OT5+Wj/8en+OJ8eIoECN92e6ZdWSULL+ZDeCLnrKNycCrZPNg75sDe7OAXkEf6L2cOWlrasaaBMyaYX6IifM22srqclQ+vSH7KJd2sSB/wz2X4fzeY08VqVVq0FOS/eMN5/JxKqyWTyGqyMXH6TKG3E82lNaNJKMeoIl2SebE8CaF8gGVPAtzwTyF+sjbR2iPnXaeODe5CTx97ijElK1y9d0jVEPSHqYcv2Q7n0jbR4CpT/Fly6P+c6c8r1gfnza6Hu+4xyDyemeGnf9GVRRbNuSwUX99LQrREEry3P9M8Oz82y/aQ8aekffWv7SSuMH4+XKk7cSe4miH2XPvkUiZSDV5lneLrWMwenZ+vr1H/D3otWMR/0QJyrgugkOPLUXyHI7TgLw32MXGevWfVHOHofn+C1e0/63QXJlI3qAeRn5ScxSjbSECVZ1XcSOmH+/EC6deEz9eb9lHrAPHoq9Vdrul2FjelGtKXmNsxFRMVheTvDpP+iU/TNIIOIt99WcbQlJyaOYltbY3URSi81pMRROjC9PJRFJrz9CpUtUeTSyVFdviWMDbiDVP6AdkhHx8LOZ67/lbLoCct8H/XQIwfyiEYlU5dKIQBls+fdHXXiqo06n65gqWtAGuUIbH8SKQpt9wn5kdyJlBVgNtFyLMCZynhbolCWsVG5hlG2EGXxmb93CIHpVOMXBY0dcFUFmXR2Kn0DP+sLGd53CcLWnzfFYmvFNmYYdewSr1CrWoOJChc876+I998Hb+qx/3nw6jPk7YUVh2TPDVn7//8TVfAhHerkmq0ORtlG7zZS4tFeMlKuVYVRwSu1I8heAqQrq9BNKLs2BX5EnVBlQaSHFT9Pw41zRazQKvcEc7DysLVisJzkqIVDXGalsrCgWQwbnOa6ChNWhakebscU+nxse50ipukhC+o7QYmbyyrdMqLYcpeck9T3Wn8/2W77AIi05rLhOpYrKzRWPI89ajVUUmJBQZSs5h1RBclOcnMV+v1yWm49L6etLzhslPVy9f/fL21RnzbPc74j4PXKjSVl07jEdRCO7WnK+L84tn5Xflt8zrbIgtmpE9fFe+71eF424YwfD/f6D4kh8oeiCKdBsnTqMynIeU+Lsefj+K1UW+eC4Uz4oBgnlsjED4uhCNDZHp7+7mGOi919stf/7ckU+gX4gV+tQraQQMsyKh9pJxUbxI+x3XB7uYAPJoom7HU+LHV+9EIRgADzF1mTC1f2Dpw5HZjGQfw2s2gf/yFLiX5Qeu5de0eb4jzycPMuwgPVNzeK+32+1f8uPutw==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read webhook event types</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhooks/event-types"}></MethodEndpoint>



This endpoint lists all the webhook event types that you can subscribe to. Use these values in the `subscribedEvents` field when you create or update a webhook. The list is the same for all organisations.

The order of the values in each array changes between calls. Do not depend on the order.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"consentManagementWebhookEventTypes"} required={true} schemaName={"consentManagementWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`consent.allowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.update.initiated`, `data.download.cancelled`, `data.update.cancelled`, `data.download.initiated`, `data.delete.cancelled`, `consent.disallowed`]"} schema={{"description":"The event types for consent management. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","title":"consentManagementWebhookEventTypes","enum":["consent.allowed","consent.auto_expiry","data.delete.initiated","data.update.initiated","data.download.cancelled","data.update.cancelled","data.download.initiated","data.delete.cancelled","consent.disallowed"]},"type":"array"}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhookEventTypes"} required={true} schemaName={"dataMarketplaceWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"description":"The event types for the data marketplace. These events occur when the server creates a data disclosure agreement record.","items":{"type":"string","title":"dataMarketplaceWebhookEventTypes","enum":["datamarketplace.data_disclosure_agreement_record"]},"type":"array"}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhookEventTypes"} required={true} schemaName={"digitalWalletWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"description":"The event types for the digital wallet. These events occur during a connection, a credential issuance or a credential verification. The list contains the DIDComm event types and the OpenID4VC event types.","items":{"type":"string","title":"digitalWalletWebhookEventTypes","description":"A digital wallet event type. The `openid.*` values are the OID4VCI and OpenID4VP event types. The `digitalwallet.*` values belong to the older DIDComm protocol.","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentManagementWebhookEventTypes\": [\n    \"consent.allowed\"\n  ],\n  \"dataMarketplaceWebhookEventTypes\": [\n    \"datamarketplace.data_disclosure_agreement_record\"\n  ],\n  \"digitalWalletWebhookEventTypes\": [\n    \"openid.credential.offer_sent\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read webhook
Source: https://docs.igrant.io/docs/datamarketplace-api/config-read-webhook

---
id: config-read-webhook
title: "Read webhook"
description: "This endpoint reads 1 webhook of the organisation by its ID."
sidebar_label: "Read webhook"
hide_title: true
hide_table_of_contents: true
api: eJzlGdty27j1VzB4Snaoiy+bZtWdnaZWJqNJ0uzEzqbZxGNBwCGJNQgwAChZ9eitX9JP65d0DkCKpCRX3stT+5LI5Lnfz+E9FVBa4MyDoJOUKQcJFeC4laWXRtMJvcqlI6BFaaT2xAITjpyQFSxyY26JSYnPgRibMS0dQxyyWBPpHZlNhzShpgQbHs8EnVBudCqz98DEx0iAJrRklhXgwTo6+Xy/xx3IbNqwabh6EwRB+nDHilIBndBnz9lJesrPxDl8mz5jf1o859+JMZzQhEokVTKf04RqViB0TWomaEItfK2kRQt4W0FCHc+hYHRyT/26RGDnrdQZ3STU+XVg5mTgurlGbFca7cAhwul4jP9xoz1ojz9ZWSrJgwlGvzhU6r7DoLRoIC8jdi1UQFPqXRoM0kr3mUoU19gsiF2ytTJMfLCKJg3HKxQ4oa5aoBUXIF4uQXtHEyqkYwsFiOiAW/CvYY2/b2V56dRPYGVai0kT6mUBzrOipNdJYwSz+AW4Dy99sEHrwr7PXmz9FN1dxQA4FCtDgg52YJeSA2FqxdaOONDCEViCXZNUghIRUzoSRUgI3HEoPZk7psXC3L1Dg8wxGvrmlGLfh7vCftDyawVECtBephLsTqw9MsY2jVt+O8NeDvmceWJW2vVlwQjs6Pw7uNVk/os3ohuC3WsvaLUmqbGEtYmIYi5AGZ05zEq2pSugVGZdgPZD0gaEBQ5yCS7SQjkgxCdKhTXDrDRx3JQQVO0E+HFF37+J0mxZdAtGTanvzNz70k1Go/rJkJtihNBuJDPLtEcRuml1VIaLCEwQardkdSXQVYHJvFcZkt6ju8FqtRqkxhaDyirQ3AgQ9HpzILtbyfaS9FAl2KuwwQlBbBeN2JW8MWhCpCZnJLOmKh06tZBaFlWBmp406p4RZi0mcVE5T3KjBGF9wJZXP9wspJUDR5jugERppCPaeGSPLJR0vomXIEyfjjAQwS0UZglEVNGkQJZMVeD2ywTH6q39W6ZZBhixH9syXJs1KHXI34hIii1m15JBLNdGOOeVJascNKootZBLKSqmSBYTwm4tUMuT4DPmbkNiCVDgISHCrDTGEb6rSoFq+RykJYJ5hqpJD4U7HqqX27CI8nXCMlCKtIdSSy/DcJD0nnOmOajYTWpxh0wps+o9wZaz95BV3tzAXSntuiEaldtn1ih74E3E6IrRx2jfXG822Pwy6Zn6yJSCR7t3GpHIKmD1XfsydKd3s+n5Txf1m+C7UC5DVP45BOvclKClGH4zr8OPMAux3GMFrJ+FKGe6pjdD574rQeNfPxKpPWR1C9UAIgYWmdc6Rek6DGI5xqAJbJQAS6az6YUpClJa4w03avhFf9FXHfm4hdAimEJKdcimBr0XyEjnKrDESREqW0dWuOM501mdzQ29PPA9SjaCBbJ9/NICRktsS98Ml2e72CjB1kSNDBMyx2kJnL9B7HnS/l1XMTEnTAsy79K/YfwWX3BTAEmtKYJoyzAR1cIlB7BK0ELq7NEEu7p+0X9Iqu47z6Qp2KB8nL0Pvm5scRCk/XkTnH4UKih7HAgntuNwMbEPg6E4mNY3ArR8AMabW9B7gu9HY4dl7cdHQu9oewR2V+leWHdDdbg8OwLVOO1hyP0QfCRsbQGEjtWSefaW2VvwpWIcHl0vmWekaPEe1wx9p3dzC8zHZhgbjSMsdDYipOPKuMoCYZmF2GwtcGPFH9f1OrIP8e+bluvNlutN5IqWip2lXqta5gtjFDC9x/0jqjvHFXOeHJywiDa1zQQoiR0mTvzbde24ggGU3MK6neMa48b+ZAhnileqnhzI/O+D2SucdgeXMtPMVxbmJAcm4qoAjOetNA/tB6Hz4HzGFTBLPNyFaS2ucK2WcU9OiDOhEQGPAjYvCHNkbareu1uobXBgTf0NFt8bEkOVj5vI1ZtLwnEqTOO4WE+09eBOPrx/EyRpV+PjO8nVBUHwhwJddKMgjNfzT58+fRq8fTuYTq/yfFIUE+d+nuPSVTD/wJwbW1/XESaMmPWo1lt5Tsenzwbj54Pxd1cn48nJyeTk9Ge62eAZY38rOLjFDylGffcm0Rwt9i4FMT96ZN+9pgmN0YXpigDn45NfdTHpsgZrjb0wAk8e4fe0w+3A5aI/97fYrSfDsAW2a7Tz8XhzgPwB77d2/isTROqy8mR73UJz7Bvkg2aVz42V/whtYtc05//HpnkPzlSWQwjy1FRaxATo3UlyFqpmE6or6fOQVLhUaTKbhiWqW2ulq3ep0Df69v72Vx7v/rfsPdMerGYqVBiwJLDZsVHsRpWVfh1uky9KGfrS52ssIZ5leMPdHgavE1qAzw1efjMIWuMNdkJHy9NRrCqj2i+j++1BdhMulCjCoYPwFApTS0gTWuFpaHvIEVCYASvlMN5vhtLQTbJL4NKzTOrsIRouvt4lc90qfon+j25r1G8Ho/igvjhHy7U35xd1qjdX1p2z6Y+z0LixIOAAyTs3ubqux44079HZdutwcVkAKS2k8g5ETIZ5lJHMyRNt6p7vLZMq2KBkHJ4mBIbZcIfshNSI369NZdEcg1tY/zCP9V/q1DSpwnhIFSiYVOHgVJbG+r+0xtvqL1+1j/pW7zpsxyxbJPLk3//811NMYEYuVyCky+Ns2Gx/YRFbdiaEba8srVlKnNPJrN7THah04MwSLMhM1/dRv05qfBzpSDvJuwTn0P45AJk5o6QgpRHEA8+1USaTeCgDzRbBwIxoWBEFS1DhZIUpFr6ILKSSfh2I4EGkYB7BuSlKJXHHic4L6lnIcFyTRjscERhJK6UwTIT0Qc6CaQ0Wy5mSHLQLRaQJuZLxHMjpcLxn89VqNWTh9dDYbFTjutGb2cXLv12+HCDOpj0ktn7AQBWGV0WzQNCEYrZGf52OT8+HZ8NwEi+N8wXTHXnw009Ti3czoFN5f+9XpzodcRAdlYpJjdJU8Y4ca9BnujyNV6lUYsFsZZq0n4auE5ob5xH6/n7BHHywarPBx18rsKHuJXTJbIiXWKy268Chj2ldDZ+8r7vHU3L0I9dBdZqSo7HehAJBJ5Qm9BYrUuf71gZPxnUpQhHj+xdhN+1g7rW6Tbd8v3p5hefpCk3XrXa3odrVP5D6Qal2C18UAf/F+nwQ5XuMstew/mELHt88iLAtthEabYQr2n8AZGA3WQ==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read webhook</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint reads 1 webhook of the organisation by its ID.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to read.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update webhook
Source: https://docs.igrant.io/docs/datamarketplace-api/config-update-webhook

---
id: config-update-webhook
title: "Update webhook"
description: "This endpoint updates a webhook. The request body replaces the payload URL, the content type, the subscribed events, the disabled flag, the secret key and the SSL verification flag of the webhook. The payload URL must start with `http://` or `https://`, and no other webhook of the organisation can use it. Subscribe to a minimum of 1 event type."
sidebar_label: "Update webhook"
hide_title: true
hide_table_of_contents: true
api: eJztW9ty2zYafhUMrtoOJR+SZlttp7OunW28TepM5DSbJh4LIn9KqECABUDJqkd3+yT7aPskO/8PUCR1iJ20vapvPCaIw38+fIRueQalhVR4yPggF8pBwjNwqZWll0bzAb+cSsdAZ6WR2rOqzIQHxwRbwHhqzKzPLqfALPxagfNsbLIls1AqkYJjfgqsFEtlRMZev3qe0EBqtAftmV+WEEZcNcYDx5AxmIP2Lgxn0omxgozlSkziTEgteDaDJRM6o6Hh8Dmbg5W5TAVSTLOZyellh8YWJayonGfOC+vZQvopG029LwcHByNmbHhw+JTQMdow46dg6+3q3Y2dCC1dODYVmlUOmPR9NqwZYt4wwQqpZVEVuOwocEjM99/r95qkK1GeeaVULboCtE+YNp4JVgrrpVBR8n02BE1yskuWS1AZMzo+pkKpuCmKys5lCmwGUAZNjGQ2CmIcGTs5Xz84obOxubmgsbVcR14W4LwoylHNr/PGQtYVanua82IZjkotBKng2/57zRNuSrA0dp7xAU+NzuXkNbH0JuzHE14KKwrwYB0fvLvdskNg52cbmkUBR8HwhMONKEoFfMCffCWO8uP0UfYYvsyfiL+Nv0q/zg7hiCdc4mal8FOecC0KnB03O894wtGSpUVv8LaChLt0CoXgg1uOOuMD7ryVesJXCXd+SYc5SaeursJqcP47ky1xSbR1/FeUpYomevCLQ45uW3uXFuXjJTh8ivTQMqUucpJGQ9g7Hk35tVU8qQ+5RPIS3jjTU/IlHCKv+QGW/CqpuTDjXyD1POFeemLiFFUGF3ZTJ9tKqEUfdFjZqGkTtI5u0dIKa9uinGhjwUVLXFvhDgtsm5XM2dJUzEGwzKLPzj3zYhYDTMcLc2uKtYkLLX+LJjdiUxAZWLSSrqxbotzS8S7un11evhwij/gPxRI/FZ5ZSEHOI0m1hOLeQQhzoSq4b+AhIdDcMbBKy18rYDkKdoPhrtXXy+NIPzXFARLiDuTECu3RaNvWci+G2/F60/vWDP4TqW+b+E1vsVj0cmOLXmUV6NRkUEecfw0vflxHY+lQs55JzQRzUk8UcVrE4IYemrFRnD0ifnVVoBNseVTC76SAX612uEgjhy232OFO2yJqYroL1tCWUW0ZCbL4iE2sqUrXZyfdtBAF+4gJazGKku6nRmUfyB8d37KQVw4Ts25NCdRIR6lEajpCSedxK+ldIKa7T2YgTLdQmDmwrAoijQbstj0oNRo1+EJoMaHM9aYJX1GsxNSW6E7DQlasV7YlSWS5KFzHTJpWli2moJFFqTM5l1klFJuQ2xm7lkCkJ8Ex4WYOo1EGCjwkLDMLTWZnbIxQKBNpWSa8QNakh8Ld7RjDjZKlZZa0U4x+UksvqbZKOuOp0CkoReOR3L5Qyiw6I1gAbQ2KyptruCmlXdabBua2D6uZ3fEmrGiT0V3RvLlarRKeyYn0Qr0RSsG91XsWFrEFreqq9ikVLBfnZ49/Oo1vSHceyyGyyr/HMF6Clln/i1E0PyYshCio1bIeIysXOu53jsq9KEHj00smtYdJTFIaIHOxcIk8BepaB4xBGT1Bo6FjVAaWnZ2fnZqiYKU13qSmqbJq+lILGWis03CnaLK5Qe3RNtK5CixzMqMY2qIVbtKp0JPozfV+Uzr3zm3DNNq2u760gNYScsQX/fmjzdVIwVpENQ0DNooFzDWuxtRcP8coVqfn9v7XIp3hi9QU0CTgUJNH4pIdq0rQmdSTe2/Y5pUqyt/vqtvKM3kOlpgPJevO17Usdk5p/r0mpd85i5i9e1IKpb97XnDs3dOQHHTr6wy03DPHmxnoLcK3rbF1ZNTjPWdvcHvH3E2mO2bdNtX+/NEds2ql7Z+5bYL3nBslgLNDtBRevBB2Bp6auXvHS+EFK5p190uGvpW7QwHumuSGfSVSg710qoyrLDAxsRCSrYXU2OyPy3ot2vv4fN2cer0+9TqcipIKmSU0+a3Dx8YoEHrr9DfI7gi7slhH1hVWq2QhHUfBZaAkRiGU3gVtIlSfnUEuKuWpKhgR4EFFZRaGIwayajdNd4ulQSUqBxm1QqYoq1BcsNG/e+ffY/ndG8qJFr6yMGLPXpyc9obPTo6/fBJbE6rvQaTTmvBlDa0QUzYkSOlp+ymkM9pcVH6K7pJKv6yLyHVVfmZILAhLiNh/mJy5ksAZTKCDjvkEf6MzxhUVsZq6LhQuczXt604KhTST5dCpn1r4y6coEgkA2+iRcseSXl0+H7IUa808FKFdFrH/+njlrrBT367iNSx297Z9jpba7r/rBn2rnw42/TFbbyIOdJIrsdojjzw+PPwzkQRJ0RUbb8JfPgZWWLtu21l22wT2U7Gf/xAGsQ91ONmDOezA4brNDJZ3SxeNuIOZ5aHUDCQkWAFB6TeQiO1WR2Z3R4PXoVuXlMWoAtoAI+8HVK1qtXz6gR1khGpks9CuSws6cYvn33Fa3OYD2ghqILnXyKVaUtgTDZ6HZIYS3AX0tN43g1KZJaYQbJ43u+uwl582KTJ0uGahmUtNCcTqx4A994N2/lz85fQe2MsDIvKAiDwgIg+IyAMi8oCIPCAiD4jIAyLygIisS1ZtumDIMlT8n4RtrOu4WrghPxm8d5BWSnwI7ogQh8l3IRw7+oMAVkjNUgXCMg83VK2FFq7hMvTJCXOGEhGkgcD6BROOPh23381g+UdDF50i8eOwC6SkaY3v7kkuT+lKxT5Dz9pWQOX16O3bt297L170zs4up9NBUQyc+3lEX1iF31PnhtTXVoShEnPXRYvjw+MnvcOveodfXx4dDo6OBkfHP/N9CEutOJF7CN+y6y1/D8By8QNPeDAw9Fic8PgjQZP20WCtsacmQ9SD/j9rnbYDvOiW/s3qRplUb4Fty+3x4eFqx/Y7DKAR9Xf4tVyXlWfrezIojm2B4MQY5BsNY6HQ+BedjDcrML7qTHizhkakY4V0+CU+wQkbFttYyX1uT9EBmcQaAYNQrf9Y2CJmUGzcEKsve7RvUK2DWLgyFgnvdHWEIXRuKsQWby6UpIC+aSBHf2EDea0RNjZW/kalxKZoHv+FRfMKnKlsCmQ8ual0vL3TwdKmgjJrbc7kA2jO2Hhrdn5GNtrOx9LFfnuHKX75l45V59qD1ULVMYqO2ZBRqFgqK/2S8OuTUlLt8u4K04wXE7wuuAaPrxJegJ8avGZYVsQ1XvYb8IP58UHAjw+iXg5u1zf/VoRiIwm77h6eQWEihTzhFcKHa7Avg8L0RCn7AePrS8NXyeYGQy8mUk/27eHC681trhrGh6j/oLaa/aZ4DgPxamOQXHO58SS6eo3Eb0DrL8/Dddr6O1ILt11/MaKyrrPPuqKr76iVFnJ5g7dDKSEEGtmIfaZNrAu9FVKRDPD70+cJg/6kv7HtgMWF3yxNZVEcvRksvx2FAgF94VVzwfJpbW2dzxxtiPduQHYDj92FoO7CRvcDfPvQrqt9kNEdPffV/ubpk1qMdn8Rr3u3uoHGlXeWx/HzGRpabuqgJVIKWlAIqQgeLktj/T8aM15bovy+Geraf9t1Ngx0vYh99r///PfzcFd6uIBMumno5GqshmCTzlXwurItrZlL7Krx5igVHw5U3nNmDhbkRMevGX6ZxPUoINYoxCVUxnTAOzzMGSUzVpqMeUin2igzkQhrgxZjMnVBX/4UzEERwIzBji5Cj6XCD7a4CcKXhfA4Hb8aK4mIRHAjYs/CBJsrabQLlyTxojg6bCY90VkIrcPNViVT0I48onb+UqRTYMf9wy2ZLxaLvqDXfWMnB3GtO3h+fvr0x+HTHq5ZNbB/owcMGZlJq6Ju93nCMW4GfR0fHj/uP+rTB6zSOF8I3aIn3C6u8+JmNGplwYefHTz87OCP+NlBTJEIIByUSkiNdlmF73+hLnjH58chD+QSI19jm4PmdwFXCZ8a53H27e1YOHht1WqFw79WYKkWSfhcWIocoYDYDLN7Lf2zV7Gi+5zd4zcOOxmqCwGNVQClbT7gPOEzCuoNGytMALFAQCLD+/iVsRc/9dfrt3IhljVhxQnhkB+c2y7DXr6+5Akfxx9FFFRxcisWePlBLPiAv+fvOeGKFOaoysXxW66EnlRigvPDtph9sFbplj8zKn/iP8jYToFsVkKBF/yLnO1c8g0Gux9g+e16enizd8G6+gqzUT2I6/0few8K5w==
sidebar_class_name: "put api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update webhook</h1>

<MethodEndpoint method={"put"} path={"/v2/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint updates a webhook. The request body replaces the payload URL, the content type, the subscribed events, the disabled flag, the secret key and the SSL verification flag of the webhook. The payload URL must start with `http://` or `https://`, and no other webhook of the organisation can use it. Subscribe to a minimum of 1 event type.

This is a full replacement, not a partial update. Send every field on every call.

The service keeps the `id`, the `orgId`, the `sandboxOrgId` and the `timestamp` of the stored webhook. The `timestamp` stays the creation time.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to update.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The new webhook configuration.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The webhook configuration to create or to update. The service ignores `id`, `orgId`, `sandboxOrgId` and `timestamp` if you send them. It takes the organisation from the `organizationId` header.

</div><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTPS or HTTP URL that receives the webhook payload. The value must start with `http://` or `https://` and must be unique for the organisation.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"The content type of the webhook payload. For `application/x-www-form-urlencoded`, the JSON payload is sent in a single form field named `payload`.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook does not receive event deliveries. Optional. Defaults to `false`.","default":false}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key used to compute the `X-IGrant-Signature` HMAC-SHA256 header for each delivery. The receiver uses it to check the authenticity of the payload. Do not use a value of spaces only: the service accepts it but then sends no signature header."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the server does not verify the TLS certificate of the payload URL. Optional. Defaults to `false`.","default":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The server sends this error if a mandatory field is missing, if the payload URL does not start with `http://` or `https://`, if a different webhook uses the same payload URL, if you subscribe to no event type, or if an event type or a content type is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create Base Configurations
Source: https://docs.igrant.io/docs/datamarketplace-api/create-base-configurations

---
id: create-base-configurations
title: "Create Base Configurations"
description: "Creates Base Configurations related to a Data Marketplace."
sidebar_label: "Create Base Configurations"
hide_title: true
hide_table_of_contents: true
api: eJztV81u20YQfpXBXpoAFKU46UUIgjp2UAhJ2yBOTo4Bj8kRufFyd7O7lKwKvPVJ+mh9kmKWlEhRctGfQw/txaD355u/b74dbUVOPnPSBmm0mIsLRxjIw2v0BBdGL2VRO+RND44UBsohGEC4xIDwA7p7ClZhRqlIhKOvNfnw2uQbMd+KzOhAOvAnWqtkFnGmXzxb2gqflVQhf1lnLLkgyfN/Mue/h24tLkUiwsaSmAsfnNSFaBJxh54+OXV8/NOHd2CWEEo68vMbDxUFzDHgKchMSdJhccKFi7gDi8vHkB+Hu6LMUXgUst3+87BNm2npKBfza85Xn4pBBCPrN3scc/eFsiCapkXy1mjfpv5sNjv2cuzQSW5kkTfR6N+rOgdwiPk/M/49ZhzinKjNTSRPSZiTi7W5aMs++RiRhnXusCMBEkEPWFnFC0fsaJJxFgaY0NoS0e6L2bO/JDDDYMg54y5MzumL35cDm0epSEYU7G/3kUkdqCA3DO7FbNacgO/vdBUb5uM15iC1rQNYdFhRaKNtjtLySWMdSuPkz7Hh+iLw0W/bFv6PpmahAzmNCjy5FTmIZkY5ahLhKaudDBsxv96KcyvfEn/eNBwjFp5zcULkOAUVhdLkYi6s8TEFGEoxF9PV82kWD09ZPybeYkZT7ptJdojBxtk1H22PlJYq03kuElGzfokyBOvn02lOlZmglaksHOqQSiOaZAxwFbCQungMw7fbY5ibPiFXzIu2nLu07OuC7UIiJJvq2jERGivePe8oGcMU47qcv1/APW2AiUs6dHRM4WNJsEJV007jbg9wbruuh6r2Ae4IrKOlfKAc1jKUcNv6CLfwRJtAESA4lCrmgEvwNAFKi3QEO4fu4suNqR2nY3JPm1e3aVQ+7pEP/STzZsfC9v3p6bl/Y/ql/o0Yr+2EfvACSL00u1bFLLYqVSgjYG2tceG7vkj7PMvv+6XD6g6JMUr//hI8+e2XX5+C9IBwtaZc+hKYsEAPWYm6IECdw4qcXHY1ilySGaferGROLoVFgNqTB09qOfFmRY5koUHmXNmwSbr7eKeI54K4jMongJDLQgZUsEalKERj3iiZgzU5BMpKbZQpJPkESONdLCSCpjUoWpFilrCkRN3BO6lk2EQQrIOpMPDxzFRWSdQZtSSJ4TkqatWNKlIDwrJWiumYyxD9rFBrcjzEKpmR9rHeO2pbzEqCs3R2lPP1ep1i3E6NK6bdXT99t7h48+PVmwnfaRIRZFAHxQNuiNxkdUU67FqGVaGt19ns7EX6PH3Gd1loKtQDf9oZ/dQYNu67wTvwzyb7TgICPYSpVSjjY123A1Yrgddi9byd/paSad/LYNcqYyG8SUTJGjq/Fttt10tNw8tfa3JRjxOxQhd5FNV5J+NROe9Zmw6nDj6u6kdGi92N8ywjG/7w7FDm3/909ZED6H7SVPF5Ew7X/HMH12IuPovPQiTC2P3QGte3QqEuaiz2s098eVgADzX1Pmpq98GR7bb0ZuDlWF7bYPgvh3byykvm2FvavNofb3cevbCX9PY0F5nHvN8BHzbpdQ==
sidebar_class_name: "post api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create Base Configurations</h1>

<MethodEndpoint method={"post"} path={"/v3/config/data-space/base-configurations"}></MethodEndpoint>



Creates Base Configurations related to a Data Marketplace.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"baseUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"URL of the Data Marketplace's metadata","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client ID of the Data Marketplace","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Secret of the Data Marketplace","type":"string"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace Base Configurations created

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>baseConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"baseUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"URL of the Data Marketplace's metadata","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client ID of the Data Marketplace","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Secret of the Data Marketplace","type":"string"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"baseConfigurations\": {\n    \"id\": \"string\",\n    \"baseUrl\": \"string\",\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create Data Disclosure Agreement Template
Source: https://docs.igrant.io/docs/datamarketplace-api/create-data-disclosure-agreement-template

---
id: create-data-disclosure-agreement-template
title: "Create Data Disclosure Agreement Template"
description: "Creates a Data Disclosure Agreement Template."
sidebar_label: "Create Data Disclosure Agreement Template"
hide_title: true
hide_table_of_contents: true
api: eJztW21zG7cR/ivb+yK7Q1Kk3uxo0kxlKWmUeCyNKNUztTxj8G5JIsIBZwBHitHwW39Jf1p/SWeBe7+TScVx25n4k8gjsLtY7Muzu6eHIEITap5YrmRwHJxqZBYNMDhjlsEZN6FQJtUIJzONGKO0cI1xIpjFQdALNH5M0dhXKloFxw9BqKRFaekjSxLBQ0Z0d38xRPwhMOEcY0afEq0S1JajoW8Rs6xkVXDKGbklNTGv8GPKNUYw5SgiA1ZB6CTfSvCgF9hVgsFxoCa/YGjpO7eCHpxtkMSfmFgHx+8CweQsZTN6TEc4VdJqJQTqoBewfO8laq6ibMl4zjSXsys0VvOQTmOCXhCqCC+mp0pGqZOGVha8z6PmkytccMOVfPyXH5mZB70g0WhQWncJZzjlktt8GwstX2Dwvte4iuJIxw+5kkhUOSNWtTs4H1/A0f43/RHke4DOAc9wMBvADsodUBp2zGLnedAL8J7FiVMxymDd0lfJrbiSOrcTCUrPmOTGnQZCJY3lNrUYASN7FThjQqwgonNiBCgttyvgEphcwS+p5ibyGm9cYsRJH5LFdI2OilNQqkXQC7iMUmP1aoyhVbqtriSdCB7+jKvN+nJ2GRZHBr8V7nBF+nD8O2jE7P41ypmdB8eHw00kHZF1eYony+Q2Ao9IeVOOmoiRIjoITZWOmQ2Og1TzjXRvrl4TqYY2P/e4OTkwnt56vW77XcmES4sz55sxlzxO4+B41GaxMjBVGpZzHs7BzhEKgsANLJhw5lKY8/7R4fpx195o1tXVoCTM1dIxJYLEz8yZxmgAF6/Gf4ILRwPMXKUiggnCziN8d26bRp4owcPVjbPphi8QjSuksM2VLILVDNVMs2TOwwrhoBcYqzSb4WvlQ3uHRxScnmo0b+eokUL5lMvIacHTIsupybzRrH+qrIalJ5sr1Xh1ga5qnpLVKg9LTWU8zYJ+VEuIKeREZEoF25BJurE7TCzx6VbvxoO9rZ8lI+qNBKwiys0LeipNMjqryGycOyWpTpTZFJpGw5azFimaT8Enm79YnWIPUinQGMhyEzChkUUrmGoVeyk0m1pYoKZEFpQinFXJb4gcX1AawZbTVLxihpsuMVCSVbxzSEiz0JKDfClR6rDhqe52c/Xa4SbK2WpKcdWRWbfhx2YocEYUSMZQSYkhJWUXrAsqLbIVDPM7kIec3KN8HCLayIlWPYnXowjrNx3qskINSnLEKMNrJdmJUgKZbNG9JFhh5sDjGCPOLIoVWRqZGHn0ugF+NuDd902onJMwiZLGR/y94bCN0Dej8AyxRw7/fqmyYQOoBJsLo1IruKTKR1Yy/gTtElHmVcVYpTpEYDIC/+DGUCoZo17wkGIos0VM5jNCoZMVTJSdD1oJ2R35nkRyeMLJ2asWFLmf94JcRgdL8y9/L37+rMojD++dUbYe7DLHslbzSWrx/6xuyfVZ3jnTmq1IvxbjjlC9bhkDrSefvLk6N/T3p/HFm/7rM8hIG4dgt/DsG8k/prhFHdoA2p7qE+QvQOi7x+rWdva5nn9KMmLhE06uz3XvC5WE69LEN9IlobPFPmhys02Zv675zhe5N3gWoeYL6kSQ1nZ45I/WdNMvdMQm+4yCl+Frif21xP6fldifLKs7SuqvRfTXIvqPWEQ3wbtbmFcGjyaA7cvihh+W37bi8dnF7mtHACZEwQWAjSwbIHMzHnokKDgmrCDkghrjEkyCIZ9mJYbDeXjPQitWsCT4zmmlEK4eowHHfV8q2+eyT3JNGF3ilAmD9ciQpbaqBC2f7oaOhTPXeuRHhwcvRnt7e/gyfBHuTyb74V748nA42nBKOD/7VKLr5vWmLbt/mFtIQb7nbpBLY5kMEW4do9uAMN1twGZ4G7RQ9bZC/JAK4XJrzpTLiC94lDKxjREXIjrnRWm45Qtuq5ChrJc7Jcgutc5pXFIiTlFN2a4DwyzOlO6EJt0HvURtlOw41WlGqpuRCVXyhDulzlGLw5hogC5GZ0q3GLlotbGt9LWP9Lv3kbZu77ydo53jhjhKUSzxfSCMyD2lsv/VbpVKUJ4kfFyNtZtD9gXtujyvh+hanipO2PNFCGEQtmBcsIlAOLk890mm3ZsxQda3ylTeIUs+Ai6upd0t+vMMJWoe/hlyQhCrCAWELLGpRg9VDGrOBDcYQdbYcmmG4IzvZO0YINkEglbLAVxTrcfdXgkm9fjUKhg9h1CvEpuDHNdTYsTHdaD2ngNLI265nA1u5a08MTzCslt8G5g0DNEYpW8DymlpLHvASslLBEyFHo+QgoJQ4d1TEp8r7Pypsjzi9enqO/+RLoMWoea/MsF/xWgsWWLmymZP/cOs9WN5jMayOPn9E+jRUUcCzW87S52Vo2zNqxYn2pCOFK5SI1Z0JY78bQCT1Ho4hOFc8pAJ0MgMAZLKtTAhMCp2vXHJtoK6mnwzoN8KXKHSUfB+Xbmaz8MhB9/sdbYvLn/OfVVlNkyAaslMxSOCdc0sthbkYTAYrDu5VnnxJivfhX3L7Vyl9qJ9/N8CCs5lRKHJOTuzkCvVHVTg1MJEMHlHXZEOk6dCStLNhqlg5LpQ94BBSS9mK4oGht6wkYRPJwhT7kyCy4EHOm2X+kyN5u6AkccGz4xv/lAv9LnvAlFJOIATKvbcYzhlUjkb5r/6iD0me0VanaCG8++vf4CrH07h5YuXhwOAc5tjcQNMCGcw2Ws8mfl4ewe8DzGxYFIfxc6jXkNZ1e+5AqjTvm7Fla21wkaTvXA/OsDD6dGnPj+a8bvu/Nn4x5P+yPcFi/C2tUh7w72D/nDUHx1ej4bH+8Pj4fAfbU/I6ZIMzsbyOE82NmdJgpJaIOfVzge1a18eDUdwc31K141A4jk4ktq50nSIV6vzAol712l7g/+VImivcaYGqQuCLk+KPweHByO2h0f44vDom+FwODo4ZJPhsMNup6iRqhKr3AgnirmE1DikxCzMmcnnTb63qivgq0iUXrT7/vSu7/J6HQ1sQEjTOmEKRlKBUHKWwTVq2BpbLOiBJqFJYG4NFEJkQC1C//Vp9rud9Yb7bQNicYK6r9FwY934WVs+ZaH1iCLJshhol056EKqE523nhrPV5R/noGX7Q1RFHQwGnykrPFsiREruWLiTaumGodQWa6xyecoP7Txgfp6VQ02c+JTxaQVxvnfE5sgi1A7OnHps2L/Oxj7llDPj6MafteDUnI22ZlhVmuB5eeB7MBw96f3M6iFRa6VPVUTHcZ/P6m2OpoLqqK3c3dUCLA53MByuO8h3NZ0KfbxilAqT1ELCNIvR+tOuW2q5kWUUCqqXQEsP/fj6D6qac2lRSybIiReowbFp6Mjl0zDVrqHy7iE4Sbgbx7x7v6YzspnJR5Cd1aghTcRo59QGDhJlnCYYDSCC3cX+bqjklM92yZf6UbG/zyrQ1gtnHPdmMyhWmezZROk4mFubmOPd3Qhj1WcJH/CZZtIOOPV2mwTGls0yHNZFw/ifm2TelyrxaMddaK6YsmfpH9BYhmh6h8wbdMFJZpTMdpabl+c0uQIyXWqle4OkchFpZpIWrbIPNTofMr+HODX0AgMFuim/xwiW3M7hg5cRPsAzqaxvWVvNuHA6SFiIz3vgxrV1sseQbfx2pVJN6ujf4eq7D4OAzIO85Kp8Ffz73A63ekejnC/Tu8Fdc8vKCLA09kyJxfdiIlc+8ldZfG3OxqoopTnS2j86/OREqjKhKRnUBywVpNA1EBk+OsAoN7bmEBWRi6FCubxrJFBRULWZX/bsWw2/uty1Bt4jP1WbcBuWeDhTEfnRllS5Jm+O0TtMazfjnKo8ZDPfosSYcXcVaZIobf9aumphKPxv5aO6j1fDQ8MJi03w7N///NdzAnUMxkuM6BUrVyHhfThncuZ7MgvUZePKZK8FJVotqL3i0HdqkIpUMe0btUCNfCazYbBd9bL9rpkVEoSSljNheq7qmnHLBCypKWAdM6MEjyBRke8iKKFmHE0PULKJc2cGEpcgcIGCYgWlFpd/2IQLamkTEZZaFftKNFRxIrhr7btQ4Y6nceYqVWpN0KAfpim9AuA6T07OmEmJmkCa4CFKP+XKA1zCwjnC3mDY0vlyuRww9/NA6dluttfsvj4//f7N+Ps+7VmXTbnyHigsRipM49xqKu9K+WJpsD8YOQdRxsZMVuTx/92y3X+INMYYBTx48r/IZKmA3qbZTQTjsjLx91nwXbDY92/BTXnuON2Z8H0vmFP+PH4XPDxQU+5Gi/WaHn9MUbuU3AsWTDsTcgk6z+Qudd65CFoDnrRcpI+gy3zHSUiV+CfXVlP85cX4OugFk+yfgmKHcALNloSH2TI4Dm4D18lSSRFP3fNaLvB011kJWU+qdy6pZh/oZPlPclWRsplf/WH82yCPbPmWzOtnXH1XLPe/PLqhyOl+Nd0uIf3/AIXgsz0=
sidebar_class_name: "post api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create Data Disclosure Agreement Template</h1>

<MethodEndpoint method={"post"} path={"/v3/config/data-disclosure-agreement"}></MethodEndpoint>



Creates a Data Disclosure Agreement Template.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplate</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Required fields to create a Data Disclosure Agreement Template

</div><SchemaItem collapsible={false} name={"language"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO 639-1 language code (e.g. 'en' or 'sv')","example":"en"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataController</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An organisation constituted as a legally defined entity in any jurisdiction

</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller public key"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller name"}}></SchemaItem><SchemaItem collapsible={false} name={"legalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller legal identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Data controller URL"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller industry sector"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"agreementPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"Days for which the agreement is valid","example":365}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSharingRestrictions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'


</div><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Where to find the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Jurisdiction where the data sharing restrictions apply"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"How many days the data can be kept"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data can be shared to"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data is stored"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Required if active=true, unless present already from the draft version"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 500 characters`"} schema={{"type":"string","maxLength":500,"description":"Required if active=true, unless present already from the draft version"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`contract`]"} schema={{"type":"string","enum":["contract"],"description":"Required if active=true, unless present already from the draft version"}}></SchemaItem><SchemaItem collapsible={false} name={"codeOfConduct"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL to code of conduct"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hash of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Presentation Definition"}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Publish immediately if true"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Template created

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplate</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A template outlines an agreement between a Data Source and  Data Using Service that can be signed by both.


</div><SchemaItem collapsible={false} name={"context"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of URIs of JSON-LD contexts"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["DataDisclosureAgreement"],"description":"The Data Disclosure Agreement type from context"}}></SchemaItem><SchemaItem collapsible={false} name={"language"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO 639-1 language code (e.g. 'en' or 'sv')"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template"}}></SchemaItem><SchemaItem collapsible={false} name={"templateId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier (derived from 'id')"}}></SchemaItem><SchemaItem collapsible={false} name={"templateVersion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template (derived from 'version')"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataController</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An organisation constituted as a legally defined entity in any jurisdiction

</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller public key"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller name"}}></SchemaItem><SchemaItem collapsible={false} name={"legalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller legal identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Data controller URL"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller industry sector"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"agreementPeriod"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Days for which agreement is valid"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSharingRestrictions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'


</div><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Where to find the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Jurisdiction where the data sharing restrictions apply"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"How many days the data can be kept"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data can be shared to"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data is stored"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Purpose of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`contract`]"} schema={{"type":"string","enum":["contract"],"description":"Lawful basis for the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"codeOfConduct"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to code of conduct"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hash of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Data Disclosure Agreement is published or not"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Presentation Definition"}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"OpenAPI specification of the Data Agreement, defining available APIs for Data Using Services"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementTemplate\": {\n    \"context\": [\n      \"string\"\n    ],\n    \"id\": \"string\",\n    \"type\": [\n      \"DataDisclosureAgreement\"\n    ],\n    \"language\": \"string\",\n    \"version\": \"string\",\n    \"templateId\": \"string\",\n    \"templateVersion\": \"string\",\n    \"dataController\": {\n      \"publicKey\": \"string\",\n      \"name\": \"string\",\n      \"legalId\": \"string\",\n      \"url\": \"string\",\n      \"industrySector\": \"string\"\n    },\n    \"agreementPeriod\": 0,\n    \"dataSharingRestrictions\": {\n      \"policyUrl\": \"string\",\n      \"jurisdiction\": \"string\",\n      \"dataRetentionPeriod\": 0,\n      \"geographicRestriction\": \"string\",\n      \"storageLocation\": \"string\"\n    },\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"contract\",\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\"\n      }\n    ],\n    \"codeOfConduct\": \"string\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"string\",\n    \"active\": true,\n    \"presentationDefinitionId\": \"string\",\n    \"openApiSpecification\": {}\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create OAuth2.0 Client
Source: https://docs.igrant.io/docs/datamarketplace-api/create-o-auth-2-0-client

---
id: create-o-auth-2-0-client
title: "Create OAuth2.0 Client"
description: "Creates an OAuth2 Client for use with a Data Marketplace. Use an API key with the scope `data-space:create` (an older API key: `config`)."
sidebar_label: "Create OAuth2.0 Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV81u20YQfpXBnhKAohQnvRBBUMcJAiFtEtTOyTGgETkiN17uMrtLyYqgW5+kj9YnKWaXkkjJLuKihwK9GPT+zM588803o40oyOVWNl4aLTJxYQk9OUANH89bX53BhZKkPSyMhdYRrKSvAOENeoRf0d6SbxTmlMJnR3zr/NMUbmkdz/mKwOWmIZgV6HHkGswpy8MbM3iCGowqyO4uZTDLjV7IcvY0FYmw9K0l51+bYi2yjciN9qQ9f2LTKJkj+zz+6tjxjXB5RTXyV2NNQ9ZLcuFa8P8D1sT/HUUbY+NNMIvg7iBqkQi/bkhkwnkrdSm2SWfvTd/OA2Z7Z37Q+jYGLS0VIrvuu36zP2vmXyn3YruNp11jtIuRnk0mp74cJwosKfRUHKU35qQQyT+F2SCb6wLLNkfeJvcmZVqc+jt988hMXFJuyZ8aiuuPNHY/Tf5tfjyeGIkoLWp/tW4ifkN773gPwiagUmZFRajXHzLsZU3OY92c2r3abd3rZeRMiMGCQuehNoVcdIQ5PCW1f4DZ08C3fhYHeRgE3Xf0hs0dE8zSN9l25gdkvAmVUhEWZAN4F5Hho6tgoU/pzmbgeiLoDutG8cJJIWyT45Lv2YT4lgjvvpg8e5R49VEia429MAVDEb77rDpRhOMaO9w+RCa1p5JsP7gXk8n2HvOHOx1V+ni8xgKkbloPDVqsycdotyewfNacCWPl96AthyTw0Z+iXv1PoZlqT1ajAkd2SRbCM0cYbRPhKG+t9GuRXW/EeSPfE3/ebDlGLB1j8RodwUVonK0N4DmGoCZfmUJkojEuQIC+EpkYL5+PY5cdH3ryOFbMKN/JRHTKhVePxas2nc8iEa1VIhOV943LxuOCajPCRqYyVG4qjdgmJ8LssZS6fMiGi9vHZm4OUFwyI2Iid4DsM4JxIRGSn+oKMRE66Lo478i4U6ihY7vRhaEg7TsipnBVESxRtfseMBvYmXX1DnXrPMwJGksLeUdFnIFm0UeYwRNtPAUD3qJUAQMG/2kClJbpkdkMuosv16a1DMfoltavZmkQU66O3w7z0dsd/4bzzoGg93SlXg+QemF2pYh5KEWqUXJaXNs0xvqfD6nYoynfHZaGOeyn/wjk/SV48ufvfzwF6QDhckWFdBUwIYHu8gp1ydNkAUuy+5YSGCNzBtgsZUE2hannodSBI7UYObMkS7LUIAvOn18n3X2cK+J2FZZRuQQQCllKjwpWqBT58JgzShbQmAI85ZU2ypSSXAKkcR7ShaBpBYqWpJgLLBlBV3AulfTrYARbb2r0fDw3daMk6rwbm0N4lspWxSoFqQFh0SrFpCukD37WqDVZHoCVzEm7kNUdgRvMK4KzdHKC+Wq1SjFsp8aW4+6uG/8yvXj74fLtiO+Edu/VIHlh+C5M3tak/a4wuPZjvs4mZy/S5+kzvstCUqPu+RN/LnRzQTo5jBnFUC/3Gv+f+oHRaYanOz9uFMrQ1wOqm04tr8XyeZyJF5LL6PCISMRQM28SUbHQZtdis5mjo89Wbbe8/K0lG0Q7EUu0gYxBwndaH0T2lmVsOJrwcdU+MH/sbpznOTX+b8/2e8Gnj5dXIhHz7jdVHXqgsLjiCQpXIhNfxBfBwTWxkXDf5fWNUKjLFsv9gBTaE0MwlN/bIL/dB0e229LrnpfHShyD4b8c2r1XXnIS39P61f543Hnwwl7942lOL8+CfwHLGTAr
sidebar_class_name: "post api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create OAuth2.0 Client</h1>

<MethodEndpoint method={"post"} path={"/v3/config/data-space/oauth2-client"}></MethodEndpoint>



Creates an OAuth2 Client for use with a Data Marketplace. Use an API key with the scope `data-space:create` (an older API key: `config`).

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Name of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Description of the OAuth2 Client","type":"string"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace related OAuth2 Client created

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>oauth2Client</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Secret of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"grantTypes"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Grant Types allowed for the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"int"} qualifierMessage={undefined} schema={{"description":"Timestamp of the OAuth2 Client creation or last modification","type":"int"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"oauth2Client\": {\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\",\n    \"clientName\": \"string\",\n    \"clientDescription\": \"string\",\n    \"grantTypes\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete Base Configurations
Source: https://docs.igrant.io/docs/datamarketplace-api/delete-base-configurations

---
id: delete-base-configurations
title: "Delete Base Configurations"
description: "Deletes Base Configurations related to a Data Marketplace."
sidebar_label: "Delete Base Configurations"
hide_title: true
hide_table_of_contents: true
api: eJzlVk1v20YQ/SuDvTQBKEqx3YsQBHVsoxDiFkWdnAwDHpMjcuPl7mZ3KFkxdOsv6U/rLylmSX2YkoEAPfYiEdydN7vvzTzOsyopFkF71s6qqbokQ0wRPmIkuHB2rqs2oCxGCGSQqQR2gHCJjPAbhkdib7CgXGUqUPTORopq+qxOJhP5G8APoo7mKdMZVKYKZ5ksCwx6b3SRNoy/RsF6VrGoqUF58sF5Cqy7zA8Y6SXk4R5dHh5udqkyxStPaqoiB20rtc4S2pdgDrd/+fMa3By4pgMyforQEGOJjMcgC6PJ8uzIES7SCswuX0N+He6GikD8KmS3/OOwa5HzW6sDlWp6K3ztqNi7wSD73RbHPXylgg9wjmhzt5ZNNWFJIWlz0ck++pyQ9nXusVMBZIqesPFGXhxUxzobsrCHCV0ulfKeTd4J8g+X2v5lKAQXLlwp9KXny72cB1RkgxLcRe9upi1TRWH/cmeTyfoI/C6mV2yfj49Ygra+ZfAYsCHubrs+oOWLxZZrF/R3Ei13IsjWn7sO/p9SM7NMwaKBSGFBAVKaAUfrTEUq2qB5paa3z+rc608kj3druSNWUbg44nFCQUNcu1JN1dbvPHKtpmq8OB0XaftYHGQUPRY0ls4ZFS9RJL0cLqbsQydvXH92lalWHEzVzD5Ox+OSGjdCr3NdBbSca6fW2RDghrHStnoNI3bLQ5i7HSU3UhmdoBtitspg9yJTWlL1DZkpi42snvdFma6phsqc/zGDR1qBlC5Z7gsyh881wQJNSxuXu3+Bc9/3PTRtZHgg8IHm+olKWGqu4b47I9zDG+uYEgAH1CZxIBK8zYDyKh/ATqEPfL9ybRA6Ro+0+nCfJ+/Tdu42TYRFaiJqUAuRsfXeBf5lR972/vrX3auXrO8LNqBlGwRv/vnr77egIyDcLKnUsQYpJKCnokZbEaAtYUFBz3vuksa6EErcQpcUcpgxtJEiRDLzUXQLCqQrC7oUxnmV9fH4YAiKQOk1mpgBQqkrzWhgicYQp2TRGV2CdyUwFbV1xlWaYgZk8SERjGBpCYYWZEQ9afbkCPigjeZVAsGWXYMs2wvXeKPRFtSJl64XqGpNP0NoCwjz1hgpk1JzOmeD1lKQScXogmxM9rIpOY9FTXCSTw44Xy6XOabl3IVq3MfG8fXs4ur3m6uRxKwzxZrNC/FACrV0RduQ5U0pS7d2ep1MTs7y0/ydxHoXuUG7d55uEDs2Hw37Yc+h/9v41rcm0xOPvUGdPqNtN/p01nSrFqfdXDbXYqs7e+qng6FB3WWqdpEl8vm5Hx/Wa3n9raWQnDJTCwypjpJvbgw2OdqjeIY6Lwry8pFIzX30c79vp5dX11efr1SmxB9eWs5jspz+QRJsluxqD37oPt0p5FdM8mjIe5H6E60+bLd3K68GbB2v2y1cyxz0L4d1Biw=
sidebar_class_name: "delete api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete Base Configurations</h1>

<MethodEndpoint method={"delete"} path={"/v3/config/data-space/base-configurations"}></MethodEndpoint>



Deletes Base Configurations related to a Data Marketplace.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace Base Configurations delete

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>baseConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"baseUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"URL of the Data Marketplace's metadata","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client ID of the Data Marketplace","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Secret of the Data Marketplace","type":"string"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"baseConfigurations\": {\n    \"id\": \"string\",\n    \"baseUrl\": \"string\",\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete Data Disclosure Agreement Template
Source: https://docs.igrant.io/docs/datamarketplace-api/delete-data-disclosure-agreement-template

---
id: delete-data-disclosure-agreement-template
title: "Delete Data Disclosure Agreement Template"
description: "Deletes a Data Disclosure Agreement Template."
sidebar_label: "Delete Data Disclosure Agreement Template"
hide_title: true
hide_table_of_contents: true
api: eJzlWG1v2zgS/isDftlkISu289KusVhcNsne+rpoiybFAdcE6FgaW9xQpEpSdlzD3+6X3E+7X3IYSrJl2b2m6Mf9ksgSOS/PPDOc4Uqk5BIrCy+NFiNxTYo8OUC4Ro9wLV2ijCstweXMEuWkPdxRXij0FItIFGgxJ0/WidGHldCYkxiJFD1ut252NhvHqYiEZHUF+kxEHRvea/mpJBhfg5keMKSRIiJh6VMpLaVi5G1JkXBJRjmK0Ur4ZcGGOG+lnon1+oEXu8JoR46/D/t9/tdx/qsuQ4UP258Y7Ul7loJFoWSCLOXkT8eiVi1TCmsKsl5Wii3NpZPVmtpIM/mTEi8i4aVX/OJds6aLzCX8OCNNViY/QiMIcpOSggQLX1py4DMCR1aiko5SqM10AUu9hMquHxw4qWeKwJpFDHeZdCDDXg2uDPaANzA4hsQuC29mFotMJuDkTCPrAdQpDI8By1R6qWfxvb7Xl06mBFNr8mDFvXBlkpBzxt4LSIwqcx0Bbi13mSlVChNiK3mvpRSUSR4pZW499bTxPal7TKcJOhKjKSpH7bh/EJKDUXn1mtkX1XgGklWPHFdeRFZ+RiU/U3qrsXCZ8fXb6uXv6LIQhZycx7wQD1EneDLd51Ykpsbm6MVIiEjQE+ZFCOLF+dmLwXA4pJfJi+R0MjlNhsnFRX+wF9Qm2jC+FusdV56tiwHakHVPwVsG3JROLTkkQfy9gEnpYWoseEoyLRNUYAmd0a4dFlSK0s0uNuo+aNZlzth39RZGyWTJBrQ/vKPE2FQ8rFuh+S4YX579NNzz8i4jePuKac7cMzWHM/SwQNfKCLHeocWzDVnFcbw+qLWtS3ZVccZQ+k/pM1P6N/vuT4xRhPpLamvC7yod65TLTUh29NCAGhxVNPUwUagfQWo4QHlYcJInqJJSIacu7GZAvJWX45KrgaNPJWmvlkyJqQyUkDoO3h1Iqe9EtEkHSoFZBEdcxdDBP27fvD7mB4RUJj6Gy6JQy/AarlCbwGH5OVRhuGW+Eq8uyML45u43ePfbFbx88fI8Bhj7UBZRageoVCDMVJJKXUOfiu9ATwkVHlxZVbFxGnXAav9uAIjvdQNNq648GxUcTIbJaXpG59OL//e8BxyrYfsPxfzo9vfL3uCY7dqWt2ebNOwPz3r9QW9wfjfoj077o37/X/uZ0MhlGwLHmjrPHMuwKEhTGjP42wIzvn0DLy/6A3h/d8XhJmDz2EwsfWYsO/Hrkvk+l2mJqkqd/WyovnIFjbpH/66oNz4j+0315+z8bIBDuqAX5xc/9fv9wdk5Tvr9A7ydkiWdEB+cqAHTXGooHdkqSzN0kFhCTyl4Pm83nQCTpTkoK9OeetPHXjjXd7uBrskdIKa7grkYaQPK6FkwgoBbGOc3CyKwbDQbLL2DjRFsUWEppernt/H3eexNTvcJhHlBtmfJScctC6D1coqJrzqKoj7FwIbjJILEFJLS6mMn2Xbtv22aluc70TY1juPvtBWOFgSp0T94eNRmAbIqMt1V4ZwKxwUYC9r4Y7Fer9fRXp/Ybn82LHoISzPCNDTjK3FVdX69u7B7td8ch1Z1p/R0+9h11++2TKh0iaD3rD9gyc9uitsukLXGXpmUe7fwfN3S+bDv/m5Ptt299UxqTzOybefO+v31AfEHGLHF41fkg64oPWzGnBCRPVje622NEe0gVNCc/YWheUfOlDYh5jNMTan3ATqvZrG/KEBj7clqVFzD5mQhqOlgFNqJpLTSL8OYfVnIV8SPDzzYepzx9P3l8dUxEjn5zKQ8LIQRNszuPhMjcTI/PUmMnsrZCTdcvXQjoYeNhJPVV0f6dTVLzZurgO69Qm5qD0UkSssHW+Z94UYnJynlpoeFjOXMovaxNGIddQXcepzVzeohGa763BXzsAWuaglD2Bv4NvHD6kV9KVHXtai5zbisczvwcX8mfzuGR1oCVwDSvqYtz9QEc1QlNT3lxx05H+vyCXnpPLdChaWpfKIUFtJn8LGyET7CkTbcFmUE3qJUAYMCEzqOgOJZ3BE7gnrjz0tTWoaj90jLXz7Ggkkk9dQ0qYZJSDXKUTKQriwKY/3ftuBt/Jd/377aRb0dsA4sm01w9N9//+eYexGE2wWl0mVVY09PSYZ6Vl0lzMnKaY1diLFMGBIz51uB0DSWjni2UtOeM3OyJGcaZMqI+2VU78eJIm6ywmtULgrDwkx6VLDgWdYHZc4omUJh0mr4NcrMJLkISOMkAIygaQGK5qQ4elwSQt3AiVTSL4MQLL3JqwEqMXmhJHLvF4IX3LM0CwMWT9RSA8K0VGpZXZgEO3PUmiz3FkompF0oQg3lCkwygmHc38N8sVjEGD7Hxs5O6r3u5I/x1c3r25se71lv75K2cWCipiYpOW0bKnO2VvHiHj8+jQehdzLO56hb9lTXXs+4E+ymR6usf/PdYp2cnp78SaFQhn4kgLGqa9cHMT+truKmclZfOxysXyISo69fSj5EIjPOs9zVii+c3lu1XvPrTyXZUG8jMUcbeFYVOen4OT08qLedP3pXn1rH8Pz7zYMINDVLc8EKFabqXh+5pD3j6nX9sOkTgw/VvsuER92WxP1msH2IXN/8cXN3I6rhareSPoZKWj+wgoMGd4tqZQX/5dp/cMvPzOBXtPxls7z68sUNm0JerWb4uEv+H4VW84Q=
sidebar_class_name: "delete api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete Data Disclosure Agreement Template</h1>

<MethodEndpoint method={"delete"} path={"/v3/config/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}"}></MethodEndpoint>



Deletes a Data Disclosure Agreement Template.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateId","in":"path","description":"Unique ID of a Data Disclosure Template","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Template Deleted

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete OAuth2.0 Client
Source: https://docs.igrant.io/docs/datamarketplace-api/delete-o-auth-2-0-client

---
id: delete-o-auth-2-0-client
title: "Delete OAuth2.0 Client"
description: "Deletes a Data Marketplace related OAuth2 Client. Use an API key with the scope `data-space:delete` (an older API key: `config`)."
sidebar_label: "Delete OAuth2.0 Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV8Fu2zgQ/ZUBTwkgy26avQhFsWkSFEG73UWTnAoDnkhjiw1FqiRlx2votl+yn7ZfshhStiU7XaS3BXpJFJLzOPNm+GayEQW53MraS6NFJq5IkScHCFfoEX5D+0i+VpgTWFLoqYDfLxpfnsGlkqR9CveOADVc/HEDj7SGlfQl+JLA5aYmmBXoceRqzCkrAvYMTlCDUQXZrVEGs9zouVzMTlORiBotVuTJOpF92QiNFYlM5OG+m0IkQrKnNfpSJMLSt0ZaKkTmbUOJcHlJFYpsI/y6ZjvnrdQL0bZTPuxqox053j+bTPjXQfwvihpiKOxLbrQn7RkJ61rJHBlp/NUx3KbnTm1NTdbLeLlBhotoPWfNw1fKPXMwOL2L/cjfmysw88D3wEGRHIafdCC3lFvyx0Bx/QfBPoXUHELx6g8CXfUBjnKy/+vFsAuL2t+t68jfEO8970HYBFTKrKiAubEvA/ayIuexqo9x77Zbz3oJuSWMMVhQ6DxUppDzrmD2V0ntRdv2C/tLv/YHWRzkYRB039Epwx0WmKVvsungB8U4bfl4SViEB7gRl7HCR3cBYXP8wkKtJ4KesKoVLxw9hDY5oKqPCfEuEe49n7wKBf/SV9Vniaw19tIUTEX47lfV9JiC4RvbW+8jk9rTgmw/uPPJpH0G/khv+ny8wwKkrhsPO2njaNsjWu41Z8JY+WfQln0SIjXnPzE1n8mZxuYE2niYm0YfE/RLFPSflKAb7clqVODILslCuOaAozYRjvLGSr8OrfWilh+IP6fcHT0uuOOKd+gILkNDbmwgzzEFFfnSFCITsfmFRu1LkYnx8vU49u/xvtuPo6iMokCNN1sJawX7wB7G7n4o9ZXpAhCJaKwSmSi9r102HhdUmRHWMpVB51JpRJsctTGPC6kX38NwcfsQZrrn5ZbLI2Z1y84uPRgXugGkk61kO6BcdE93q+dDx7bzEbNC2ndVmcJdSbBE1ew65myAM+vUEarGeXggqC3N5RMVcdCaRR9hBifaeAoA3qJUgQPOw2kClC7SA9gMOsM3a9NYpmP0SOu3szS0HqnnZvuSMA8viSqUTKRr6tpY/+uevF388v1+ach6P2EHtOyM4OSfv/4+Bcmj5+2KCulK4GoCespL1AseMgtYkt21zJBjmTMlZikLsinceGgcOXCk5iNnlmRJLjTIghn366SzxwdF3I7DMiqXAEIhF9KjghUqRT5c5oySBdSmAE95qY0yC0kuAdL4EAhG0LQCRUtSnD1+8UEW8EEq6dcBBBtvKvR8PDdVrSTqnGLyQniWFo2KjwykBoR5oxSXSSF98LNCrcnyXKxkTtoFjdmWXI15SXCWTo44X61WKYbt1NjFuLN14483l9efbq9HbBPGGa8GyQszeWHypiLtt6XMrzXm62xydp6+Tl+xbW2cr1D3/In/PXRzTzrZj1HFUO52Ev2/+H+je92envy4VijDvBLY3HQS90UsX8dZfy5ZnveXiEQMhE4kIttNa9NElMZ5tt9sHtDRvVVty8vfGrJBdxOxRBsKMqqhdPxdiGyOytF/EHfyuetep/C9ELaqpVmygsaITIhEPLKo7WfKdrqb94IPcfsiz6n2PcPjoa7fE66uP17fXYtEMBlDyXwMktl98AXP+nWontEL/ski/6zJG07nB1q/3R2PO9812Cl2PM0s8bT7L3rlM3E=
sidebar_class_name: "delete api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete OAuth2.0 Client</h1>

<MethodEndpoint method={"delete"} path={"/v3/config/data-space/oauth2-client/{clientId}"}></MethodEndpoint>



Deletes a Data Marketplace related OAuth2 Client. Use an API key with the scope `data-space:delete` (an older API key: `config`).

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace related OAuth2 Client deleted

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>oauth2Client</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Secret of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"grantTypes"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Grant Types allowed for the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"int"} qualifierMessage={undefined} schema={{"description":"Timestamp of the OAuth2 Client creation or last modification","type":"int"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"oauth2Client\": {\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\",\n    \"clientName\": \"string\",\n    \"clientDescription\": \"string\",\n    \"grantTypes\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all webhook content types
Source: https://docs.igrant.io/docs/datamarketplace-api/get-webhook-payload-content-types

---
id: get-webhook-payload-content-types
title: "List all webhook content types"
description: "This endpoint lists the payload content types that a webhook can use. Use one of these values in the `contentType` field when you create or update a webhook. The server posts the payload as a JSON body for `application/json`. For `application/x-www-form-urlencoded`, the server makes a string of the payload and posts it as a form under the `payload` key. Note the capital `C` in the `ContentTypes` response field. The order of the values changes between calls."
sidebar_label: "List all webhook content types"
hide_title: true
hide_table_of_contents: true
api: eJztVs2O2zYQfpUBTwkgy842vRhB0O0mDbYJkgC7QQ+LBTQWxxKzFMmQlL2KoVufpI/WJymGkn93gyLoLejFFkjOzDffDOfjRkhynkqMJMV8iTpQJiSF0isXlTViLq5rFYCMdFaZCFqFGCDWBA47bVFCaU0kEyF2jngHIyCsaVFbewclGmgD5fApEFhDYJdsHAhWqFsKoExyVoxerjtHBSwVaQnrmgx0toXSE0YC66F1kr92/nO4rgkC+RV5cPYUGgZA+P3qw3tYWNnB0noo0DmtSuTkpp+DNUUOv52u30/W6/VkaX0zab0mU1pJssiS7zFYg3fE3kP0ylRjWvvARo5wVBxQsDNojSQ/5DueLOCOuhze20hpvUSnImooLoodNRd7akIBnoKzJtBA0kCA9ex3xDASW9ZoKgqwoLgmMlCi1iEXmbCOfErzUoq5qCj+MXD5cUB0GE1kYhsuiPlGnM1m/DfWij9P2eS1UNbUIH85z8GiGqyPPM83D9rsO1tKZILusXGaxPzmIZBM/GtFxW0mVKTmETTnj2JJMU3b/JeA7EfMxdA3ot8toPfYib5nyr+0yvN9vDnmbG9tF5+pjKLn48fAP7wVmagJJXlOiw88nz37rqodxifvrb+wkjhz/n51EO0Bnuyk4nvr+WZ7VJlIFfnD6j2fzfpH3O9tRrIOTMSvKEEZ10Zw6LGhSJ7peEjIJ4NtrK1XX0k+oObn72zoH4uaSxPJG9TbmZbCnHDUZyJQ2XoVOzG/2Yhzp94Sf972nCNWgbkYRwin3VCs7ThZOGuMtZiL6epsWlqzVNV0vMdhOt6w6cj+JI4jZ0ATUrhjwK+osSNYkYnWazEXdYwuzKdTSY2doFO5qjyamCsr+uzUwVXEisf1N3yEYfvUze2egytuhaGCWyZ2pcBhIROKQw0kikwYbHj3fOzC1FritBTnHy9ZCYB7lUwcO3CY7mmgb6d7ceSngCEMNG2IsCBwnpbqniSsVayhGDBCAU/MVmGiR6UTBw5LepoB5VV+4nYOo+GLzrae6ZjcUfeyyNN8UmZpt7cGy3RrqEHFRIbWOevjL3vydvmrN/ulY9YPC3ZCy84Invz9519PQbGUXq1JqlCDxIhA94PQJcldkVfLkbtUY1UyJXalJPkcLiMLR4BAejkJdkWeVGVASWY8dtlojwtN/OZIy6hDBghSVUmX16g1xRQsWK1Y5SVEKmtjta0UhQzI4CIRjGBoDZpWpLl6fLvTCMCF0ip2yQm20TYY+XhpG6cVmpKG4qX0PFWtTvmkpxLCstWa20SqmHA2aAx5FiatSjIhzZNtyzksa4KzfPaA8/V6nWPazq2vpqNtmL67vHj9/ur1hG1Ym1TUR8UDblRpy7YhE7etzLd1qNfZ7Ox5/lP+jG35/dOgOcDzToUIqPVeyg91/vROHIzl/9+gP9gbdJyYke7j1GlUhhsmdehmVIwbsToTmRg0Q2RiqxpJUhLsYfdAOW4zUdsQ2XazWWCgT173PS9/acknzcrECn264EnBtlKXpOaOh7k4L0tyLFwphTTVTx4E/aHIvXl9zQ+/liEfCsFdEoLxg71vt0x34PtUEwYI/MvS9ajJC76Ab6l7uTs+7HzTYKdDw2mm+rbv+38AeAbrSg==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all webhook content types</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhooks/payload/content-types"}></MethodEndpoint>



This endpoint lists the payload content types that a webhook can use. Use one of these values in the `contentType` field when you create or update a webhook. The server posts the payload as a JSON body for `application/json`. For `application/x-www-form-urlencoded`, the server makes a string of the payload and posts it as a form under the `payload` key. Note the capital `C` in the `ContentTypes` response field. The order of the values changes between calls.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ContentTypes"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"description":"The payload content types that a webhook can use.","example":["application/json","application/x-www-form-urlencoded"],"items":{"description":"A payload content type.","enum":["application/json","application/x-www-form-urlencoded"],"type":"string"},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"ContentTypes\": [\n    \"application/json\",\n    \"application/x-www-form-urlencoded\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# iGrant.io API documentation
Source: https://docs.igrant.io/docs/datamarketplace-api/igrant-io-api-documentation

---
id: igrant-io-api-documentation
title: "iGrant.io API documentation"
description: "iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 2024.3.1</span>

<h1 className={"openapi__heading"}>iGrant.io API documentation</h1>



iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner.

<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}>

API key authentication. The value of the `Authorization` header must be prefixed with `ApiKey ` (note the trailing space), e.g. `Authorization: ApiKey <your-api-key>`.

<div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>Authorization</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>iGrant.io: <a href={"mailto:support@igrant.io"}>support@igrant.io</a></span><span>URL: <a href={"https://igrant.io"}>https://igrant.io</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3><a href={"https://www.apache.org/licenses/LICENSE-2.0"}>Apache 2.0</a></div>
      

---

# List all Data Disclosure Agreement Records
Source: https://docs.igrant.io/docs/datamarketplace-api/list-all-data-disclosure-agreement-records

---
id: list-all-data-disclosure-agreement-records
title: "List all Data Disclosure Agreement Records"
description: "Lists all Data Disclosure Agreement Records for the organisation, depending on  the role of the organisation for the record, 'data_source' or  'data_using_service'."
sidebar_label: "List all Data Disclosure Agreement Records"
hide_title: true
hide_table_of_contents: true
api: eJztW21v2zgS/isDfWmykBU7L203WCwuTdvddHfbokmvwDVBS0tjixuJVEkqjjfwt/sl99PulxyG1LuU2Gnv9nC4fElsihwOZ555o8Y3XoQ6VDwzXArv0PuVa6OBJQk8Z4bBc67DROpcIRzNFWKKwsA7DKWKNMykAhMjSDVngmtGJHyIMEMRcTEHKcA+VzJBkLPe3IqAsgR9OPciZtgnLXMV4rkHUkE5lmsu5p80qitOj4Jz4flexhRL0aDS3uHHm85JXufpFBXtqwp+jQR9yTO7bcbmXFguAjgCgXNm+BWxB7lQyCI2TRCuWJIjzFiSaJiy8JIofB5/Djzf47TFlxzV0vM9wVL0Dj05m2k0nu8p/JJzhZF3OGOJRt/TYYwp8w5vPLPMaCoXBueoPN+LcMbyxHiHY99LueBpnnqH49XKvynJJjzlprtl+6y/sWtaCGLozApNrgRkaE+NwdcyOGlx1VTkO5ng3Qy+5IlBBdMlvGkCgBZWKOgC7t3tqBgGRetgRuVD59JGcTH3mifRfC5ODTO53vQMixhNjI5rbVeW8B4+A3AN53afkv1cFN+2MJgHwMISfVy4z9sbaak6zQXN1pkUGjU93x2P6V/7AOssGsj4Pd8LpTAoDBFgWZbw0Cpr53dNVG4aXGRKZqgMd3uSSmrqFfHCWzS4ZkoxEi83mDbH5fR3DE1P7kcFmEFhplCjIAclGtxP0SwQBTAn/lMLFGAict/fE0rg1KGEPBIzEDIBUwRSAkak0qk0sQ9TpjEiv0W6zLOIGYzgJwnaqDw0ucIAzmKEN5kZnYjCPUTkgFIuULdwoSrNF8olfkhE1d4xUxiRgVbAaXE6sBXXIEWypG88snZTmjmpjHFBy+kk9mCMGNbOU9ZQ+ujxiHTMhBQ8ZMkJfbtFdWeYZgkz+A6vuCZluJlOwKflFsWoZb7gvflMZuaEVhqeojYszWis4QQsA0PeRD/HBA1G3oXfQRqP+jbQRc17wb/kfYPsYZ5HKAyfcVSBt2rLZe0epKBQSa1HTf5Z0iDaiXF2j02lPWAZhpuEBpoa6RjLd3MUqHj4HahiEqQywgRClllEOLeFirOEE9wLc7c+jIklOPt+pIEUmlD4XhAWuSb8mRgF6NzyQ9idbEOolpmRc8WymIc18izgd7eB5RE3XMyDc3EujjSPEGZKppaLc0/nYYhaS3XuQSiTPBU+sJpzHcs8ichcQiloLZlMIsNLjCiOXY+ENCMuRiRSMt7KVfYA7071mly+X8jTIc9+JJjQJFT8D5bwPzA6FSzTsTTFqBv8mem4BeUNoTmTKmXGO6QQhdcszawSHx/sP5ns7u7i0/BJuDed7oW74ePH40lPqaW24eQ54adxlI33IgFVSOtt8JYELnOdLEkllvy5B9PcOPhiGFubAIVMS6GbamFJglG1ipiygRgF5TEfe/tmMuHhsnAZnRjhXawaqvkmMT7d/3530Fzf/lJlogWGKRwsmG5YhLdqwWJjRm6CIFgN7trci3e3ckHoAzexzM2b/vGnUibIxG3bFoBvb3oiIgrb1tiZgVKo9qAJzgxMEyYugQsYgDzFMUGaDfOEkelC2wKCml7KluQNNH7JUZhkSZCYcQsJLqyzGzKpb5RoaQ5YBNQt8mJMw6vTN6+36QODiIcmgKMsS5Z2GI5Lv87/cKnnKeEVaTYlxicvzl7Cu5fH8PTJ04MA4MSUIdUVQwSYGcckqjI9h3fA6xAzAzp3Xuwk8jvCan4vBUAxedXzKxtLhU2mu+FetI8Hs8d3fe4JjrYh/od0vnX689Fosk181e5tY5Z2x7v7o/FkNDk4m4wP98aH4/Hf+pZQ0iUeLMZKP08Yi1mWocAoIOHXDubk9A08fTyewPuzY1I3ArFHbLLcxFLRIZ4tCe9XPMrLuN23BveUPKjfzZ7bpN5QCncv/7N/sD9hu/gYnxw8/n48Hk/2D9h0PB7A7QwVihApcDIBLEq5gFzbjJEZiJmGUKFNOg3F21I8FixloHSsXY9mlyMb19vZwN0Jy8msTZickZCQSDEv0lZKQLSpJvigiGlimBsNFRPEUaYwQvf1fvjdDL3hXh9ALM1QjRRqrillAaYMn7HQuIwiK6JYdZ8Qyoxj5B52jK3Nf52vbnyIJqtBEHwjr7C1QIikeGTgUsgFcOdkurNsnHI1i1QgpNn2VqvVcFbeswIKRHV2lil5xSNX/FQFiKMR1DjqJZ7NzP4e2VfGlolkNg9rEKg+P8dQRkiPr1DxWVFx/oYmlt3BtxWlgdEiP2s+ObXierYcHD7SneFXC/0zsshefDQLloEYXVlzlUSekczKL/Xjbylfan3VJYXFbiGFjUqUtTXQlo2ZjgJtEbmY6Q6yXeYotxpIe8dXH85qtltrSy2vrfiLiTUZv1nghgnjqSa/GdWVRC2oVx/OaNcBIK1l/QgWmCQjskBRiAMiFNLmQIuYhzGklhT5Tdo/gL/aUtyW5/oQHl3icsrt7een3xfmUZeRt/dRW02LzgSFyhsJq3MERpItRzmFlaYgbtn7NlfdjZgGlWBJsgRbTtqY1C704iKZoE3d9YSR9Z2KDzzAoPFQzmBIEqtbrHUth88wZLmmKrNhGo80cOH8ta172RLCmIk5gryiKMZT9IknZe9SGAh0AtRGKizS88Z6ZuwBaJlNm/icABjAibsgCpm24+y2Eth30dYmjmVKUwAZtEyxe0+QSHlJ6s4zcu9WLkv6bkNBPk14SKCoMlDHDmRMmWUwLMkjvV6SL7i9tCrgZF3BwJVrc7x/79os94plRY3XnmxLvGGHu946E4tJe5lW3Jr1jdxvjdmEl+4hupIp1DO3F3Pw6sNp80KkqNa23r08fnIwOVifE9+R5vY84a1RZKjg26Coq5PKfm3Xuei5QmWTvo4H8YElC7bUYIO3BeLaiFHfL9bFsg1/a6VDNwSdGspdTw2eKZOcbqaM9N15uHZWVwAxqlj8xEoWP7lcqQ/LOyY3bh6GFHKrk+y4gXXbFP7AXaPByfNSDkV219FLndoNX61+TYLXvmF+yPMe8ryHPO8hz3vI8x7yvIc87yHPe8jz/nt5nntNvh4cH/6tPQb3hXzhJdu3+I174zo80/lYFKF75d154b/RRrXcWk1jxQW2PfkU6eradjlt2b6H1sxLxIyctsyW2z0ubJfBRnzc2r5WIrVSv+vm8aHhHbeD+3rNuu9hA08x6+AgcksDwpRNH8sut7uaCd7Ws7opbJgrhcK8ZfOmsJrNYU12jt1s22ZW9KI178wnBDZpWHLSafy5jd4ZTW40tdmGIWBXjCfUn9ekvXtQEidev4Y4Ma3rDqCy667aYW/lF61462m/7rBc9t61pDFe+V7MdPnu/V6Bwb0fUPiIonX1lqC7hXX0bpfXeG2+fgeB16ZHnTrsHMy6wGqWhWu6wloYvbDUYpsnWHkcu9aUURlyeg1wtiet9W6027C26oG0QRPcXs4D748nFvKbdr81T4lKSXUsIysg+vy8sedFX0JtK6tXD0GrOtz+mCDTIz/gxGp5PGP0Jj7LSX1Fs6z1DT2xvBf1S1CvqQSaeuDaCf9PRVMWSZRjUXlht+nIyL7OD3PFzdL2Ih9l/BekjxfUm2nYnFqU13ZgahJIWlSx3tw2E2fMxN6ht3O1txNKMePzHTKpUZ1+jKr4s6Mqq3KsDvVFP8dUFifxfC9X9AI5NibThzs7EaZyxDIe8LliwgRcetQo2yZwashi57fR0O5xl8xFLSDXemHVW4qp7g11A0Ujblze0RStukcFRMtg1Skc3p7YuomATPVWWPR3nzWLU4qXn1t0PhdeANJcUzMp+dMZv8YIFtzE8NnxCJ9hS0jjim+jGE+sDDIW4rYPtou3TfYQioU/LGWuSByjS1z++JliMx1vJkuTYqE1KUwZJ0HqPMukMn+phVedn/9UD7Wl3lRYRyzVItj659//se0q4tMFRlzHLlvE66J67pZQUCQm5WWiss0ZuUbqYUpmI03lNvJ5WZubZVmX2f75kN6wC8NZon3blDPnFHMX1DNm7GZa0rVKJiPXZCYTOeeofUDBplbAFHsWkOAVJjackimSf2BTnnCztERYbmTqGpVCmWYJZ7ZMIuXZ4ymc20Ym6lzj1CY8y+nCwzYmWj5TJgT1f1KAD1Fo62xKyGUsjBF2g3FP5ovFImD2cSDVfKdYq3d+PTl+8fr0xYjWrOo0q9YDATWSYU42W0K5KNqKXppgL5jY+z+pTcpEgx/q0d7s9xld+2j47/+tn3kUrsHgtdnJEsZtULequCm840fvas81rs/4vEitBz2kTU4qTxtLbWjxzQ2lfe9VslrRsGv/t56TawJINNxl1xTof/bXJoMSuCTHWf/oxC6nLhXrsTdm/L4/HbmDlTJl/kpOtt4VWcM2/Fk/F7lLrv2O9K8815/+u5E7TtX6rUt9ngv6oqzTtilLmdtYI3Arj0JqdGys6mfazdzlpxdnnuurawf3Sxvciw9EvXwklg3a3TjvWKC/JPrBJT+QU/0Flz9W092TWxdUuYWbTVKi+uNf7wZpvw==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all Data Disclosure Agreement Records</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreement/records"}></MethodEndpoint>



Lists all Data Disclosure Agreement Records for the organisation, depending on  the role of the organisation for the record, "data_source" or  "data_using_service".


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"organisationRole","in":"query","description":"Filter by Organisation Role for the Data Disclosure Record, \"data_source\" or \"data_using_service\"","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"signStatus","in":"query","description":"Filter by whether the status of the Data Disclosure Record is \"sign\" or \"unsign\" (e.g. active or inactive)","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Record List

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementRecords</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Record identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"canonicalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The cross-organisational identifier for the record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplateRevision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSourceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Source.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataUsingServiceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Using Service.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the record is active and data can be shared to the Data Using Service."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The timestamp of when the latest signature was added."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation this record belongs to (both organisation keep a copy)."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationRole"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"The role of the organisation in this agreement (e.g., data_source).","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"isDeleted"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the record is deleted."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementRecords\": [\n    {\n      \"id\": \"string\",\n      \"canonicalId\": \"string\",\n      \"dataDisclosureAgreementTemplateRevision\": {\n        \"id\": \"65471222e8c7c3bb3c2c6601\",\n        \"schemaName\": \"dataAgreement\",\n        \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n        \"objectData\": \"{...}\",\n        \"signedWithoutObjectId\": false,\n        \"serizalizedSnapshot\": \"{...}\",\n        \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n        \"timestamp\": \"2024-01-15T10:30:00Z\",\n        \"authorizedByIndividualId\": \"string\",\n        \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n        \"successorId\": \"string\",\n        \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n        \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n      },\n      \"dataSourceSignature\": {\n        \"id\": \"string\",\n        \"payload\": \"string\",\n        \"signature\": \"string\",\n        \"signatureDecoded\": {},\n        \"verificationMethod\": \"string\",\n        \"verificationPayload\": \"string\",\n        \"verificationPayloadHash\": \"string\",\n        \"verificationSignedBy\": \"string\",\n        \"verificationSignedAs\": \"data_source\",\n        \"verificationJwsHeader\": \"string\",\n        \"timestamp\": \"string\",\n        \"signedWithoutObjectReference\": true,\n        \"objectType\": \"data_disclosure_agreement_record\",\n        \"objectReference\": \"string\"\n      },\n      \"dataUsingServiceSignature\": {\n        \"id\": \"string\",\n        \"payload\": \"string\",\n        \"signature\": \"string\",\n        \"signatureDecoded\": {},\n        \"verificationMethod\": \"string\",\n        \"verificationPayload\": \"string\",\n        \"verificationPayloadHash\": \"string\",\n        \"verificationSignedBy\": \"string\",\n        \"verificationSignedAs\": \"data_source\",\n        \"verificationJwsHeader\": \"string\",\n        \"timestamp\": \"string\",\n        \"signedWithoutObjectReference\": true,\n        \"objectType\": \"data_disclosure_agreement_record\",\n        \"objectReference\": \"string\"\n      },\n      \"optIn\": true,\n      \"timestamp\": \"string\",\n      \"organisationId\": \"string\",\n      \"organisationRole\": \"data_source\",\n      \"isDeleted\": true\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all revisions for all Data Disclosure Agreement Records
Source: https://docs.igrant.io/docs/datamarketplace-api/list-all-revisions-for-all-data-disclosure-agreement-records

---
id: list-all-revisions-for-all-data-disclosure-agreement-records
title: "List all revisions for all Data Disclosure Agreement Records"
description: "Lists all revisions of Data Disclosure Agreement Records, optionally filtered  by organisation role and/or DDA Template Revision."
sidebar_label: "List all revisions for all Data Disclosure Agreement Records"
hide_title: true
hide_table_of_contents: true
api: eJzlWetu3MYVfpWD+RMr4FK7q4udRRBUkZxGTWoblowCtYToLHlITjScoWeGK22E/dcn6aP1SYozJHe5FymygxYF+sdekTPn+p0rH0RKLrGy8tJoMRE/S+cdoFJgaSadNNqByeAMPcKZdIkyrrYEJ7klKkl7eE+JsamLwAQSqNQcMqk8WUoBpnMwNkctHfJbsEYRoE73jYWzsxO4pLJS6Anet9ziKy0iUaHFkjxZJyYfHzZEfFOXU7IslW14gzfgbmUFmbFQYS51YBbDCWjK0csZgbFQa0uY4lQRzFDVBBkq5WCKyS1TuBnexCISkll8qsnORSQ0liQmwmSZIy8iYelTLS2lYpKhchQJlxRUopg8CD+v+KjUnnKyIhIpZVgrLybDSJRSy7IuxWS4WEQPHVklS+k3Wa7r+le854ugd+lsyddWQ0VBa4q/VMDRmlR9f703ip4W8Ifgavbz276f+WJwhy9oCzwNZCK4Eil6/MWZ2iZ0JdhH7aPaSZ3/4sjOJL9ZU8zbepdezlupc9HXhEmt2C4h22Gug9x5+rSKH7T8VBOcn7H5cUubLQg/yw1Lca/5tKuMduT4/Xg45P/WRfi98FvyBo5fEYnEaE/aMyWsKiWT4Jb9Xx2Te+iJU1lTkfWyYb6M+Z6kaC2yUaSnsv/cTH+lhHl56RU/6Om/Lv0JfJ2TJiuTr5dZBUqTkoIEK19bcgEnjqxEJR2l0Mofcg/qOTQCf+WAgaEIrLmL4bKQDmS4q8HVQR6Oi9EeJHZeeZNbrAqZgJO5RubDqQfGe4B1Kr3UeXylr/SJkylBZk0ZpLgSrk4Scs7YKwGJUXWpI8CV5K4wtUphSiwl3+VMp0xySymH4P1AGz+QesDwm6KjJQhWqPgoJIOu0eoNozVq7RnA2Pxkp/MhsvI3VPI3Si80Vq4wvn3aPPwRXRG8UJLzWFbiOtrwqky3gReJzNgSvZhwdNE9llVw4vHR4cvReDymV8nL5GA6PUjGyfHxcLTl1CXizs/EYk2VZ/NiAy2RvMXgHRvc1E7N2SWB/JWAae2bvEJJoWWCXKfQcZXquQWVonR5i4UKOYQ0p+CPW3wro2QS4r7/ookscb3oueYPmfHV4TfjLS0vC4J3PzHMGXumxXCBHu7Q9SJCLNZg8WxBHuI4Xuzk2uclN1lxxFD6N+kLU/u32+pPjVGE+jG2LeDXmZ7rlPNQCHb00Bk1KKoo8zBVqG9BatgBebjjIE9QJbVCDl1Yj4B4Ra/EOWcDR59q0l7NGRKZDJCQOg7a7QipP2jRLhwoBUYRvOAshg7+cvH2zR7/QEhl4mM4qSo1D4/hFLUJGJa/NVXzgvFKfJpr+vnryx/g/Q+n8Orlq6MY4NyHtIhSNw0aAyaTpFLXwafBO9B9QpUHVzdZ7DyNNozV/7szADdei6288myr4Gg6Tg7SQzrKjp/6vWU4ZsPy7/L5i4sfTwajPZZrld6eLdJ4OD4cDEeD0dHlaDg5GE6Gw79vR0JHl2UIGOvyPGOswKoiTWnMxl8lmPOLt/DqeDiCD5en7G4CFo/FxNoXxrIS388Z7zOZ1qia0NmOhuYtZ9Bosy9YJ/XWF2Q/K/8cHh2OcEzH9PLo+JvhcDg6PMLpcLgDtxlZ0glx4UQNmJZSQ+3INlFaoIPEEnpKwXO97cwTwNIVyka0+0F2Owh1fb0b2BR5wxDZOmFORtqAMjqnpn/k7sr55YEILAvNAkvvYCkES1RZSqn58/Pw+zz0JgfbAMKyIjuw5KTjlgXQeplh4puOomqrWNu3R5CYSlLavNwItnX5L7qm5flK9EWN4/gPygov7ghSo7/ycKvNHcgmyWyeCnUqlAtu4LXxe2KxWLAuy0nsqa7x3erUZt+S1NaS9u8wp0cGmL5yp83pMAq181LfOCNOIsajOt/oYx+jd8mHe4NX6H8BZygVz5B92uOjjjjL+iXEWWgeRblqGA3dZLjkcLCI2nHx92m/2RC5mw/XrDFcRKJA1zVZO0v7Y+W7AYKlr7iqLeGwySL0AA2XN3Tvv5yDpnu/RZ2nwAZmm8Dqd9mreWYNjtfhYkGYhg3Dgzhtxo3BZaD1sD2uhcFprd5tTlWLLTz2aELDSwS+h8NRQPdzR7S+QmStsacmDbbg32c9ntfbxlgPqNXtXShaKnc4ZHRskd+Rhlb2+B65u6pq9lS7uwlpYMssH/SqsIm+E/joUTP8/p+a5lx7shoV14UZWQhsNmwUWrSkttLPw2rspJI/Ef+85k2Cx5w3Zo/vCxxboiRfmFRMRB6WWhX6QkzE/uxgPzE6k/k+d7CDdHl9gN31/Xb7tN8PrEbaXZu6MypNq4yIRG25Lyi8r9xkfz+l0gywkrHMLWofSyN4dbNO4MJz0OaP0XDN600y1ysbNR118HBnqdVio3nQ7n7aCF3u/E5alHalaWOl8e4cbmkOjGXSvkUoryS65WLbkt+s0blpEwGUtfPcSVaWMnlPKdxJX8BNIyPcwAttuKssCLxFqYINKkxoLwKK83iD7ATai9/OTW3ZHINbmn93E/M6TEidmS6qMAlRRSVKNqSrq8pY/6eV8Zb6yz+vHq1bve+wDbMsL8GLf/3jn3vcyiFc3FEqXdHMRXSfFKjzZhMzIyuz1nbQbvugsmbGS5XQc9eOeDRV2cCZGVmSuQaZssX9PGrvh41uwo2T9hKVi8KslUuusHe8CvCBmTNKplCZtNkdGGVySS4C0jgNBuZKcweKZqRC8eRo5BSBU6mknwciWHtTNvNnYspKSeTWOTgvqGcpD/MpLySkBoSs5oV42DcFOUvUmiy3ZkompF3INx3kKkwKgnE83LL53d1djOF1bGy+3951+z+fn75+c/F6wHcWq6Zq5QcGamqSmqO3gzJHa+MvHpHig3gUWk/jfIm6Jw/vEjc+BfDqhZ/87veAzYjpJfX/kW8MbRbwdO/3K4UylPBg9Yc2JX4Us4Nml5rJvF0P7UyLoevo1F6lxutIFMZ5JvTwwL3dB6sWC37cLJpDwpSOcZHu3pn0rfaf/eyx0xq3nC9XXz/CdZ45QqJ+tuCf+w3jCVG6vvgLJXnxvu0X9uC/9d3iKbtuf2j5Qr2+4AvFE3J9zmeTlcDX/IcNyTh0I13bElDeED5JeC/Vu7XdRPe7kz+/vhTNGmS9aN+Got3+YOrdKz3v0d6s340I/C/bdueVbzlZ/kTz75bHmzePXlj2DM1pNiKPFv8GMi0uaQ==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all revisions for all Data Disclosure Agreement Records</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreement/records/revisions"}></MethodEndpoint>



Lists all revisions of Data Disclosure Agreement Records, optionally filtered  by organisation role and/or DDA Template Revision.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"organisationRole","in":"query","description":"Filter by Organisation Role for the Data Disclosure Record, \"data_source\" or \"data_using_service\"","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateRevisionId","in":"query","description":"Unique ID of a Data Disclosure Template Revision","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Record Revision List

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revisions</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"revisions\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List Data Disclosure Agreement Record Revisions
Source: https://docs.igrant.io/docs/datamarketplace-api/list-data-disclosure-agreement-record-revisions

---
id: list-data-disclosure-agreement-record-revisions
title: "List Data Disclosure Agreement Record Revisions"
description: "Lists Data Disclosure Agreement Record Revisions for a specific record."
sidebar_label: "List Data Disclosure Agreement Record Revisions"
hide_title: true
hide_table_of_contents: true
api: eJztW19z2zYS/yo7fIl9Q9GS/yX1dDrnOGnrtE0ysXOZudiTQOBKRE0CDABaVj16u09yH+0+yc0CpEiRtC0nvbmH6iWxSGKxWPz2L7C3QYyGa5FboWRwFPwqjDXwglkGL4ThqTKFRjieasQMpYV3yJWO4R1eCyOUNDBRGhiYHLmYCA7avY+CMMiZZhla1CY4+ngbSJZhcBTEzLKa8JLuOWZ5yixWdE/jIAwEMZQzmwRhi8v3UnwpEE5fgJoA67BbUVuyGYSBxi+F0BgHR1YXGAaGJ5ix4Og2sPOcODNWCzkNFovwIWa9DL6NRU/jsXytTvG6yMaoib6XugGrwFyJ3G1KzqZCMvo0gmOQOGVWXCMoDYXUyGI2ThGuWVogTFiaGhgzfkUUPg8/R9XSvhSo50FYCURNJgbtCtcTlpo+toW0OEXt5DJhRWqDo2EYZEKKrMiCo2FTzqnIhG1PubrW39gNDQTZt2aNttAScnSrxuhrGRwNF4tLGmtyJQ0a+np3OKT/VrlZWz+A9CkIA66kRWmJEsvzVHC3MTu/GyJ322Au1ypHbYWf/F4ANtaixr8jtx2hHZdCAo25RoPSGmCywe0Y7QxRVvg8U4XmCEzG/vd7I+QUzlBfC44ANmEWOJMwRjBiKjGG8RzGyiYhjJnBGJQEmyAUecwsxvCTAmN1wW2hMYLzBOFNbgensoRdTNYhExINzBK0CWo3uuRZGGDcQZb4IUks506Yxpg2nj7vctozlTCgZDqnXyJ26lHBh3aGCUnDaSVuYYwYNtHFqt34GAhSWM6kkoKz1BmANe1Z+aUX8Fk1RfnUMV/y3nyncntKI63I0FiW5fRMT5kUxsHHMdB88E6lNE6YF5iixTi4DFuAEnHXstxhuR7EuIhRWjERqKNgsSqXB+egDeJaGTNo8s/SBlG3SzUe3BzrSrtHM6ywKT1o7khLWf42RYla8L+BrtQ3UzGmwFnuEOHYMagFSwXBvdRq40y8nINX4ycGaENTBK1mhEVhCH82QQmmcPwQdkfbwPU8t2qqWZ4IXiPPAX53G1gRCyvkNLqQF/LYiBhholXmuLgITME5GqP0RQBcpUUmQ2A15yZRRRqTunAlaSypTKr4FTrvfDOQyg6EHJBISXmXhrIDeL+q12Sqw1KeHnnuT4IJfYRa/MFS8QfGZ5LlJlG2fOof/sxMsgLlNaE5UTpjNjgKgjDAG5blbhMPD/afjnZ3d/EZf8r3xuM9vssPD4ejzqYu7fDpC8JPYylrz0UCWiKtM8FbErgqTDqnLXHkLwIYF9bDF3nidAI0MkPhUmNbWJpivBxFTF24mSX5x4+deXOVCj4vTUbbFVwuGlvzTWJ8tv/dbq+6vv2FYE7YUyWGyR3MmGloRLBYgcXajNxGUbTonbU5l2hP5Z3QB2ETVdg33eWPlUqRybumLQG/OumpjMk7O2VnFiqhuoWmOLEwTpm8AiGhB/LkxyTtLC9SRqoLqxoQ1fQyNidrYPBLgdKmc4LERDhICOmMXZ9KfaNEK3XA0qFukRVjBl6dvXm9TX8wiAW3ERzneTp3j+GksuviD2ek4YzwivQ1BVynL89/hHc/nsCzp88OIoBTW7lUAyxNHWAmAtPYVPDxeAe84ZhbMIW3Yqdx2BJW83clAPLJi45dWVsqbDTe5XvxPh5MDu/7uyM4mob479vzrbOfjwejbeKrNm9rs7Q73N0fDEeD0cH5aHi0NzwaDv/Z1YSKLvHgMFbZecJYwvIcJcYRCb82MKdnb+DZ4XAE789PaLsRiD1ikxU2UZoW8XxOeL8WcVH57a42+LdkQcN2TrJK6g2FcI+yP/sH+yO2i4f49ODwu+FwONo/YOPhsAe3E9QoOZLjZBJYnAkJhXERI7OQMANcows6LfnbSjwOLJWj9KzdDCZXA+fXV6OB+wOW08kqYTJGUkGq5LQMWykAMXb5QQiamCaGhTWwZII4yjXG6H8+Dr/roZfvdQHEshz1QKMRhkIWYNqKCePWRxR56cXKWCsErnKBsX/ZUrZV/ut4de1FNFmNougbeYWtGUKs5BMLV1LNQHgj0/7K+SmfsygNUtntYLFY9EflHS0gR1RHZ7lW1yL2yc8yAfE0ohpHncCzGdk/IvrK2TxVzMVhDQLLv18gVzHS62vUVIFxNvo3tIlqP3y7pNTztIzPmm/OnLiez3sfH5vW41cz8zOy2CXUzYSlx0cvtXkZRJ6TzKof9etvSV/q/apTCofdUgprpSgP5kBbzmd6CjRF7H2mX8h2FaPcqSCrM776cF6zvTK22uUHM/7yw5pM2ExwecpEZshuxnUmUQvq1YdzmrUHSA+yfgwzTNMBaaAsxQExSuVioFkieAKZI0V2k+aP4B8uFXfpuTmCJ1c4HwsZCzn99PvMPmkz8vYx21bTojVBueWNgNUbAqtIl+OC3EpTEHfMfZepbntMi1qyNJ2DSyedT1pN9JIymKBJfXnCqrqmEoKIMGq8VBPok8TiDm19kMPnyFlhKMtsqMYTA0J6e+3yXjYHnjA5RVDX5MVEhiHxpF0thYFEL0BjlcYyPG+MZ9YtgIa5sElMCYARnPoCEWcGfV30jhQ49N7WBY5VSFMCGYzKsF0nSJW6ou0ucjLvTi5z+u1cQTFOBSdQLCNQzw7kTNt51C/JY/OwJF8KV7Qq4eRMwYXzKJ+McwcXAXHTfF5QZeCT8bWeTrpXDitzvNWPXYrXb3Af1s7UYdIV08qqWVfJw5VnLuClOkRbMuX2TF1hDl59OGsWRMpsbevdjydPD0YHD8fE94S5HUt4pxfpS/jWSOrqoLKb27UKPdeoXdDXsiAhsHTG5gac83ZAfNBj1PXFOll27u9B6VCFoJVD+fJU75pyJagyZVXo1yOM17oSiPGSxU+sYvGTj5W6sLzn40bloW9D7jSSLTPw0DSlPfBltPJQpVErbu1LHdr1l1a/JsBbrTBv4rxNnLeJ8zZx3ibO28R5mzhvE+dt4rz/X5znj8kfBseHP/WOwWMhX1rJ1Sp+o25cu2daH4tj9EferQP/tSaq5dYcXRWw3crHSKVrd3tmy917WPnyCjEno63y+XaHC3fLYC0+tEqxl5MKqcvthy2MplEIDeu4HT3Watb3HtawFJMWDmI/NPKYqqr4TefAtGYUJAuLmekL0TZXDDZXDDZXDDZXDDZXDDZXDDZXDDZXDDZXDDZXDBauFFndxL8vanxbf9WOW3ihNUr7lk2bMmheYG8u7sR/7a7Cl/flm8IZkRFRlqWnrTj2Lnrn9HHj4r2Lf4FdM5FSD0GT9u5BRZx4/RrixLSpb5NXnQHLGfYWYdku8DDt1y2Wq/6AFWkMF2GQMFMFWY8qMnggaHxCXm0Jh/YULgbws7zGG/v1M0i8sR3q1DXiYdYGVjPKvr+RoJnvrMD10hFOXPnJiebEpyODqpLR6apwHQ0r/rDd7rDo4LVBE/xcPgnbH44c+tftnWguGLVW+kTFTlb094vGnJddYa0qXD26D2XLxe0PCT0d8j1mqpbHc0bRV17QTpYNUs5MdMTyXtaOL2hughfN/l9YNO/QlwLIyMJEFbIroAPftvMXFVB1OEGOlcr6bpqWjFyMywst7Nw16B3n4hekPy+pB8qyKfXt3d3pZEgSWXlsFExdV5hrhDsKdq73driSEzHdIbszqOt9g2XBZ+d27U7AxY53sHcOqfrx6MPajPml++bD9uFZpkrJBGFQaIrSEmtzc7SzE2OmBiwXkZhqJm0kVNBtvDuzZCKnd9Ew/nWbzGUtcJ/fOLhUYq/LTP5B2Q2XVGetZavccWkTqkChVWB6e+rOP8hy0LkJL/v/zpuHTBS7fF6h87k0u5AVhprCyJdNxA3GMBM2gc+eR/gMW1JZf4hmNROpk0HOOG6HQPW7FtkjKAd+P1eFJnEMrnD+w2eqsdHyJqpSUcadimLGBAnSFHmutP17Lbzl+sVP9aNVqTc3rCWW5SDY+s+//r3tT7bOZhgLk/gsFW/KU7D2UQiUBcbqUoB2GVBhkAoF6WRg6NgMxbQ6Y7Pz6nzF9VdyCmOlFSw1oct8p4LinRkVZqybzCg6Hs1V7Cs5KlVTgSYElGzsBEx+fwYpXmPqQhlSbbI3bCxSYeeOCCusynw1gKssTwVzxx20eW55GqeuWkDlIUHtfpOCDi5d9c/xmTEpqY+LgiuO0jjjVUEuZzxB2I2GHZnPZrOIudeR0tOdcqzZ+fX05OXrs5cDGrOoQ9x6HwioseIFqW8F5fLwpUxYo71o5BIBZWzGZIMfaql8RIdyW0kaTuFP7HYuldfijd3JUyZcnOOEdVuaxY/B9Z7vBJ2IaVlj6zWNQRgcPaZNWldB3F2jGv3KtYG8DINEGUt83d5SvP1ep4sFPfYNuM5sCkPoiPvrWE1B/m9bkXuFe0VWs+5IdsMpD3Tmem3GH9tXfA8rVa5Sc3JJP7SzBI+U59a7Mh7Zhq/ode9lsnIvct7ksWJ+fcA9Tr7rL2SZi/x53C+Bv7hcpjFuI/yoY07lwQa9bq7SjHF+enke+GrUqre+ct66/IOo9/LadtyeBfqXBNo75Huykr/g/Ifl5/7NnQOWwYL/miRHGdx/ASxrJzw=
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List Data Disclosure Agreement Record Revisions</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreement/{dataDisclosureAgreementTemplateRevisionId}/record/{dataDisclosureAgreementRecordId}/revisions"}></MethodEndpoint>



Lists Data Disclosure Agreement Record Revisions for a specific record.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateRevisionId","in":"path","description":"Unique ID of a Data Disclosure Template Revision","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementRecordId","in":"path","description":"Unique ID of a Data Disclosure Record","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Record Revision List

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementRecord</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A record represents an Agreement between a Data Source and Data Using Service  that can be signed by both, based on the updated Go structure. The Opt-In value determines whether the record is active and data can be shared to the Data Using Service. The Opt-In value is only valid for records containing both signatures.


</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Record identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"canonicalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The cross-organisational identifier for the record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplateRevision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSourceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Source.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataUsingServiceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Using Service.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the record is active and data can be shared to the Data Using Service."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The timestamp of when the latest signature was added."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation this record belongs to (both organisation keep a copy)."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationRole"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"The role of the organisation in this agreement (e.g., data_source).","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"isDeleted"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the record is deleted."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revisions</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementRecord\": {\n    \"id\": \"string\",\n    \"canonicalId\": \"string\",\n    \"dataDisclosureAgreementTemplateRevision\": {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    },\n    \"dataSourceSignature\": {\n      \"id\": \"string\",\n      \"payload\": \"string\",\n      \"signature\": \"string\",\n      \"signatureDecoded\": {},\n      \"verificationMethod\": \"string\",\n      \"verificationPayload\": \"string\",\n      \"verificationPayloadHash\": \"string\",\n      \"verificationSignedBy\": \"string\",\n      \"verificationSignedAs\": \"data_source\",\n      \"verificationJwsHeader\": \"string\",\n      \"timestamp\": \"string\",\n      \"signedWithoutObjectReference\": true,\n      \"objectType\": \"data_disclosure_agreement_record\",\n      \"objectReference\": \"string\"\n    },\n    \"dataUsingServiceSignature\": {\n      \"id\": \"string\",\n      \"payload\": \"string\",\n      \"signature\": \"string\",\n      \"signatureDecoded\": {},\n      \"verificationMethod\": \"string\",\n      \"verificationPayload\": \"string\",\n      \"verificationPayloadHash\": \"string\",\n      \"verificationSignedBy\": \"string\",\n      \"verificationSignedAs\": \"data_source\",\n      \"verificationJwsHeader\": \"string\",\n      \"timestamp\": \"string\",\n      \"signedWithoutObjectReference\": true,\n      \"objectType\": \"data_disclosure_agreement_record\",\n      \"objectReference\": \"string\"\n    },\n    \"optIn\": true,\n    \"timestamp\": \"string\",\n    \"organisationId\": \"string\",\n    \"organisationRole\": \"data_source\",\n    \"isDeleted\": true\n  },\n  \"revisions\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List Data Disclosure Agreement Template Revisions
Source: https://docs.igrant.io/docs/datamarketplace-api/list-data-disclosure-agreement-template-revisions

---
id: list-data-disclosure-agreement-template-revisions
title: "List Data Disclosure Agreement Template Revisions"
description: "Lists Data Disclosure Agreement Template Revisions."
sidebar_label: "List Data Disclosure Agreement Template Revisions"
hide_title: true
hide_table_of_contents: true
api: eJzlWtty4zYS/ZVevtjekmTJt5moUqn12Lko8Y5dlr2p2rGrBiJbJGIS4ACgZMWlt/2S/bT9kq0GSIoi6ZE0kzzlybIEdDcafTnd6BcvQO0rnhouhTf0rrg2Gi6ZYXDJtR9LnSmE81AhJigM3GGSxswg3OKMay6F7nkdL2WKJWhQaW/44cUTLEFv6AXMsBWRkkZBYhR4HY8T05SZyOvUJLkX/FOGMLoEOQXWEKmg4nU8hZ8yrjDwhkZl2PG0H2HCvOGLZxYpCaKN4iL0lsvOS43J+yyZoCIOCn2pAg1Ggn7iKUylgpSFXDBa2oNzEBgyw2cIUkEmFLKATWKEGYszhCmLYw0T5j8RhY/9j73icJ8yVAuvUyhFTqcazZrUUxbrNrG5MBiispqZsiw23rDf8RIueJIl3rBvz5OTjXnCTZ3l+ln/yZ5pI4i2Mys0mRKQoj019r5UwEF/uXykvTqVQqOm1Uf9Pv1Zl2YXEwOySq/j+VIYFIaIsTSNuW/v5vA3TRRfKvKlSqaoDHf8N9hh5UBy8hv6pqG5czCFTDIzMReogQlgpcgTNHNEUZjpWGbKR2AiAPfFveYihDGqGfcRTMQM+EzABEHzUGAAkwVMpIl6D2JN8R/ckZ/tzZK7WDk7XsxEmLGQPs5QkY7ot6pfFf/8q/yZtHAhhVEyju2dleLfoOIyyJeMI0bOcovkND4pQJODZyqVGlefLisKInnm0yx+xzTXOZlzYxSfZAa1vbcAr6cXUgSZ0y4tKLiPgvo3xb2//stPTFPASBVqFMZawSVOueCm2MZ8clXvsVOzhUKfqztnSjFyFm4w0S1Bo2EMtJ685/52pOnvz+Pr992rS8hJa9rCgyalVwLcFo7AAxSGTzkqou2o7iA/PrMkjZHM6bLdFUhP68LdRZ+TjFjAVMmkODSxKY1y48lH42s4O/6mO4BiD5CJwD72wh7sodijGLunZ3sHRLgw8Y10Seh8MV2Mifg2qczqdOU7f8q9wX6Ais8wcFrb44E7Wt1N/6Qj1tnnFJwMtcCwORoKkCpkgmvreGQC2nCTGQyAaWAQY8jieAEBuSQGQEowC+ACmFjAb5niOnChpRbsAhvjbEbreJaK9eVMxTazBZk2ajFG30jV9Ow0m8Tc/wUXm5VoFeaXRwa3FZ5wQfpwGbVJI2HPVyhCE3nD0/4mkpbIcnWKnWWyG2ueT4poITSVKmHGG3qZ4hvp3t9e2QC1rs2vPW5BDrSjt1wumwmmHTisk11oi7zmEfejSoLlmnAWDwp7bctSGw23uhqkgEjOwUQIRJA46IgpDHpw/W78N7i2NEBHMosDytR7r/Dda+TsVMbcX9xbq61ZO9G4RQIxXIoy74YoQ8XSiPsVwl7H00YqFuKVdECnxeZLTruaxa8RKiTgN+UisFpwtEjBazJvNNyfK6th7sgWStVOXaCqmifotigusq6MNhspEe+gzvsnOYeEgkpAhlOyzbHVE6Y2MbWrd+PBfl0/SwHYrJGAkUS5fkG70iSjM5LMxjpMgbI2krlxC10G+Ewq8patgG1zMFr9txWPKv5rIY6Cbs+BWcX8FrhxZQnAhCjYALCRZQ1kbsZDrwQFy4SVhGxQY1yATtHn07zEsDgPn5lv4gXMCb5zWhnH6BsMqFh67gppulx0Sa4Jo0vMq6ZqZMhTW1WChk+3Q8fSmb0KnvPOTk/eDI6OjvCt/8Y/nkyO/SP/7Wl/sOGUMLr8XKJr5/W+Kbv7srCQknzH3iAX2jDhIzxYRg8eYboHj4X44DVQ9bZC/JDFsc2tBVMuAj7jQcbibYy4FNE6LwrNDZ9xU4UMEyljZOI1CfJLXec0XlEiTsGasomVzwyGUrVCk/aD3qDSUrSc6iIn1c5I+zLd4U6pidHgMCYaUJitvcs6Ixut1qu6zbD59oryjQX6ckp+Zvctm+Xg5vrhsrhQXwphfdAFi2aEaKkp/wDyZWviVT62Qt3IiVbtxCsva9vMtZFoTIQb4ihFMYt9dYQBuaeQLmW8Vld/kepuKtRgRY4YyRTFecrH1Vi7OWRf066b0XqIXstT5Qk7rgghDMJmjMe2Y3d+M3JJptmb0S4Rq6LztEteMdxYpyrvq9lG+nuIAhX3/w4FB0hkgDH4LDWZQodhNCrOYq4xgLzjZfMP4RzX4trTQELHCErOe3BHRSC3ewXozAFXI2FwAL5apKZAP7bZxIiPbU0dHQDLAm64CHsP4kGcax7kVT1J8eDpzPdRa6kePEp2WSI6wFaSr6AxVYA8QIoWsfSfdsmItuJzp8oTjNOnLfzcR7olWoSK/85i/jsGY8FSHUmTf+u+zHtChieoDUvSPz6znp21ZNbitvOcWjnK1rzWAkgT65HCZabjBV2JJf/gwSQzDiehHwnusxgUMk1IpXItLI4xKHe9t1m4AsfqfPMKoBHRqEnsPS4rV/N1AOXkm6PWvsbNL4UTy9yGCWnNma54hLdcM4utBXnp9XrLVq5VXrzOyrVnf+Umkpm5bh7/S9DCSAQUs6yzMwOFUu1BY5wamMRMPFG7pMXkqcISdLN+FjNyXVj3gN6KXsIWFA00fspQEHCdIEy5NQkueg4BNV3qKzVauAMGDjTsa9cVoibpgWsPUa3Yg3OqAu3XcMGEtDbMf3ehfEz2irSa3iNG39/9ALc/XMDbN29PewAjU4B0DSyOrcFMOcaBLszH2Tvgs4+pAZ25KDYKOjVlVf8vFEAt+GUjrmytFTaYHPnHwQmeTs8+9/lVKNB25/vjn867A9cwLMPb1iId9Y9Ouv1Bd3B6N+gPj/vDfv/fTU8o6JIM1saKOE82FrE0RUG9kVG1JUJ93Ldn/QHc313QdSOQeBanZCaSig7xbjEqIbpznaY3uF8pgnZqZ6qRuiZMs1P8OTk9GbAjPMM3p2ff9Pv9wckpm/T7LXY7RYVUrhhp33aChAvItIVQzEDENPgKGQEa23RVFVRWJkon2nN3+tS1eX0dDWyATtN1whSMhIRYijDHcdTJ1aZc0AFFQpPA3GgohcgRXIDu393sdzvr9Y+bBsSSFFVXoeaaIAswZfiU+cYhijTPYvmbYwd8mfKiH11ztnX5xwVo2f4QVVF7vd5Xygr7c4RAij0DT0LOgbsgU19l85R7zXNI+iCvk1avyJ9DjTerVY03q0wp6qKuv6281kO9cKvtM27+1ltVzoCCiDQsHtVw7Gv07mhx5dHY4t8Vmq7SPjotiJOsX0KchKZndMoaUkDxql1yOKZmk/1yM+33NZGLt+01bfSXHS9iugBZW1RWq/TtDEHhHmW10hzqLCwGcFzer7887shB4LNpUKeJB2dmdcNae1jZ8AJerXjWDPbRko6QBXa248W7cAVJ9y5/hGzMBNjH+LWMWH+pb7yoVmmC4+XKsJP+oHyz3ebZv3pkVEqqCxlYbdHnagP0samudZdb7W6zs/JwJ32ynwb5thZoqY93jPBXmtFd5lMzNlA01HIvVqnPq16CU83JX1g1t6jdiIWQVAZloqmgUzd08hdV0EgYVILFlFpnqMCyqenIolw/U7b/+eHFO0+5fT398EgTPIaFupgYaG0eadJEgiaiVxsvtDNNdpBr6B3Ojg99KaY8PKTI0w3K7d3ySe/wZeN42PKwGpXcSdyAWb3Rm8j8oPlr8dCLjEn18PAwwER2Wcp7PFRMmB6nd5s6gbGhiBe+RkO7n+tkHlf6cwWLvf1Ci6u+kfsiH83Kw1s5Dnaeu3iR+Wsdo5sRvUoDBQJ6JvPzYTQ7BWDnzvKK5+ManY95FIUk0zScRMlpyp8xgDk3EXx0MsJH2BfSuOcooxiPrQ5S5uNBB+woxjrZIeQbv13ITJE6uk+4+O5jjybrPC6msvA45hrCmDBOitRZmkpl/rFSXnl+/uPqq3WtVy+sppZyE+z/7z//PSCkzGA8x4DryJWd+OxHTISu0TVDtWoT6nwIK1VyRj0rW9JkGqnyj6ddLWeokIcif3o3i06+37YOfcKlwnAW644tZUNOAGZOnRZjmWkZ8wBSGbjWjIxlyFF3AAWbWAVTIp9DjDOMLTYhT6XwwSY8pgcEIsIyIxNX3vsySWNuH1Ls5dnjKQxt+U/9HhqrgGlGAxe2nWflTJgQqAj5xtxH4d4UC5NLmR8hHPX6DZ3P5/Mesz/3pAoP87368Gp08f378fdd2rNcYdbVPZChBtLPkqLRW5lMcxVo77g3sMheapMwUZGHhvt2mjitu0klyn/h/GruqjTJdJjGjIvKtIWLaR+82bGbQJzyMG+RtcY1r+MNtxl8XYW2x44XSW2Ix8sLQd97FS+X9LWb47QBj2u616C9pVRVwJ870dqqKJqbqQy22u1UktlAu7Xgu46nfkaUomxYSfJI/yjrwzvqc/82BwYHsP1EcqtsRT4Qi6pohcybbWb5WEJxewa379ynJleFYhNvV/P0j9/fea6nsp6inmyKyj8Q9VZp69nKieDmpl7Z8i2Fhl9w8V253P3y6oYyQ7rVpDuqQv4PwRpIWg==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List Data Disclosure Agreement Template Revisions</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}/revisions"}></MethodEndpoint>



Lists Data Disclosure Agreement Template Revisions.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateId","in":"path","description":"Unique ID of a Data Disclosure Template","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Template Revisions List

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplate</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A template outlines an agreement between a Data Source and  Data Using Service that can be signed by both.


</div><SchemaItem collapsible={false} name={"context"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of URIs of JSON-LD contexts"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["DataDisclosureAgreement"],"description":"The Data Disclosure Agreement type from context"}}></SchemaItem><SchemaItem collapsible={false} name={"language"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO 639-1 language code (e.g. 'en' or 'sv')"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template"}}></SchemaItem><SchemaItem collapsible={false} name={"templateId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier (derived from 'id')"}}></SchemaItem><SchemaItem collapsible={false} name={"templateVersion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template (derived from 'version')"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataController</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An organisation constituted as a legally defined entity in any jurisdiction

</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller public key"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller name"}}></SchemaItem><SchemaItem collapsible={false} name={"legalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller legal identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Data controller URL"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller industry sector"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"agreementPeriod"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Days for which agreement is valid"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSharingRestrictions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'


</div><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Where to find the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Jurisdiction where the data sharing restrictions apply"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"How many days the data can be kept"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data can be shared to"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data is stored"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Purpose of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`contract`]"} schema={{"type":"string","enum":["contract"],"description":"Lawful basis for the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"codeOfConduct"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to code of conduct"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hash of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Data Disclosure Agreement is published or not"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Presentation Definition"}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"OpenAPI specification of the Data Agreement, defining available APIs for Data Using Services"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revisions</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementTemplate\": {\n    \"context\": [\n      \"string\"\n    ],\n    \"id\": \"string\",\n    \"type\": [\n      \"DataDisclosureAgreement\"\n    ],\n    \"language\": \"string\",\n    \"version\": \"string\",\n    \"templateId\": \"string\",\n    \"templateVersion\": \"string\",\n    \"dataController\": {\n      \"publicKey\": \"string\",\n      \"name\": \"string\",\n      \"legalId\": \"string\",\n      \"url\": \"string\",\n      \"industrySector\": \"string\"\n    },\n    \"agreementPeriod\": 0,\n    \"dataSharingRestrictions\": {\n      \"policyUrl\": \"string\",\n      \"jurisdiction\": \"string\",\n      \"dataRetentionPeriod\": 0,\n      \"geographicRestriction\": \"string\",\n      \"storageLocation\": \"string\"\n    },\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"contract\",\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\"\n      }\n    ],\n    \"codeOfConduct\": \"string\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"string\",\n    \"active\": true,\n    \"presentationDefinitionId\": \"string\",\n    \"openApiSpecification\": {}\n  },\n  \"revisions\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List Data Disclosure Agreement Templates
Source: https://docs.igrant.io/docs/datamarketplace-api/list-data-disclosure-agreement-templates

---
id: list-data-disclosure-agreement-templates
title: "List Data Disclosure Agreement Templates"
description: "Lists Data Disclosure Agreement Templates."
sidebar_label: "List Data Disclosure Agreement Templates"
hide_title: true
hide_table_of_contents: true
api: eJzlWm1z2zYS/it7/OKkI8mSX5LU0+mcYyet2lzsiezrzMWeCUQuSdQkwACgZNWjb/dL7qfdL7lZgG8i6UhO2k/3ybIE7C4W+/Jgdx+8ALWveGa4FN6J945ro+GcGQbnXPuJ1LlCOI0UYorCwBWmWcIM6pE38DKmWIoGlfZOPj60KL3P0zkqkCEo9KUKNBgJ+o5nEEoFGYu4YLR0BKcgMGKGLxCkglwoZAGbJwgLluQIIUsSDXPm3xGFT+NPxJoTi885qpU38ARL0TvxZBhqNN7AU/g55woD7yRkicaBp/0YU+adPHhmldFSLgxGqLyBF2DI8sR4J+OBl3LB0zz1Tsbr9eChJJvwlJs2y82z/oPd00YQfWdWaHIlIEN7ahx9rYATJ9Um57c8Mai4iCCgOwvqO2PVnZnyzmC+gkCx0Oxn+TzhOsYAtGEm149olPl0KzsJPJcyQSaaAhdLNwWehmBUjgOQIllBLUctJFNY6AyD0Y3w1utbEkBnUmjUxPJgPKY/m4S32yyQcXsDz5fCoDBEgmVZwn1rh/u/a6Lz0DhapmSGynDHlRRc06/IVx7RUAZTipEaucG0+b2c/46+6ZjPaXV6kLlJuCAtiMYNztEsEQUw55kzmSsfgYkA3BfXmixghmrBfQQTMwM+EzBH0DwSGNDFz6WJSZ3Ny/zodHFvzTvwBk7OgZcwEeUsoo8LVJqkHHiljNOg8c8/q59JPWdSGCWTxBpuJf4lKi6DYsksZmSuH1AbxX1SABlflqtMaqw/nTcURPIswzx5zTTXBZlTYxSf56R2utAAL8IzKYLcaZcWlNynQfubD7jgJPTjv/zMdEyyKNQojDWPcwy54KbcVnjG7aBlJKU+t9sCnV9E3rpjDLSeQsj1h6mmv7/MLt4P351DQVrTFh50KbUJXQv+OccdYjnwAIXhIUdFtB3VJ8iP9yzNEiRzOu/3EdLTpnBX8ZckIxYQKpmWhyY2lVFuPfl0dgEvDr8fTqDcA2Qi8AxH0Qj2UOxRotnTi73nRLg08a10SehiMV2MifkuqdLqtPadv+Te4FmAii8wcFrb44E7WttN/6IjttkXFJwMrcCwPRoKkCpigmvreGQC2nCTGwyAaWCQYMSSZAUBuSQGQEowK+ACmFjB77niOnChpRXsAhvjbG4beJaK9eVcJTb/Bbk2ajVD30jV9WybqvxfcbVdiVZhfnVkl+V8uMMV6cPl1i6NlN2/QxGZ2Ds5Hm8jaYms61M8WSa7seX5pIgeQqFUKTPeiZcrvpXu9Yd3NkBtavNbj1uSA+3ordfrboLpR0+bZFfaws9lzP24kWC5JrDJg9Je+7LUVsNtrgYpIJZLMDE6ZMY16JgpDEZw8Xr2N7iwNEDHMk8CytR7j/Dd6+TsTCbcX11bq21ZO9H4gIRuuBRV3o1QRoplMfcbhL2Bp41ULMJ30iGgHpuvOD3VLH6LUSGh35CLwGrB0SIFb8i81XB/aayGpSNbKlU7dYFqap4w3aq8yLYy+mykgv2TNu+f5RJSCioBGU7FtsBWd5jZxNSv3q0H+23zLCVgs0YCRhLl9gU9lSYZnZFkNtZhSpS1lcylW+gywBdSkbfuBWzbg1H93048mvivhzgKuj0HZhXze+DGO0sA5kTBBoCtLFsg86uxvWXCKkI2qDEuQGfo87B4e1ich/fMN8kKlgTfOa1MEvQNBvRivB8KaYZcDEmuOaNLLJ5XzchQpLamBB2f7oeOlTN7DTznvTg+ejk5ODjAV/5L/3A+P/QP/FfH48mWU8L0/EuJrp/X+67s7svSQiryA3uDXGjDhI9wYxndeITpbjwW4Y3XQdW7CvE2TxKbW0umXAR8wYOcJbsYcSWidV4Umhu+4KYJGep3cq8EvW/mWU2JOAUbyiZWPjMYSdULTfoPeolKS9FzqrOCVD8j7cvsCXdKlZwOhxnRgNJs7V22Gdlotfmq2w6bP7yjfGOBvgzJz+y+dfc5uP39cF5eqC+FsD7ogkU3QvS8Kf8E8lCSe5SPfaFu5USrnsSreNb2l3VaicbEuCWOUhSrKzxSgZAuZTz2rv4q1V02qEFNjhjJDMVpxmfNWLs9ZF/QrsvpZojeyFPVCQfuEUIYhC0YT2zZ8vRy6pJMtzZjH++qUPiTsorhxrpUdVvdItJ3EQpU3P8OSg6QygAT8FlmcoUOwWhUnCVcYwBFIcxmH0I5rvK1p4FEThCUXI7gip6A3O4VoHMHW42EyXPw1SozJfaxpSZmbOlRBHDwHFgecMNFNLoRN+JU86B405MUN57OfR+1lurGo1SXp2IArJa8Bsb0/uMBUqxIpH/3lHxo33vuVEV6cfq0zz73ke6IFqHif7CE/4HBTLBMx9IU37ovi4qQ4Slqw9Lsz8+rL1705NXytouM2jjKzrw2wkcX6ZHCZa6TFV2JJX/jwTw3DiWhHwvuswQUMk04pXEtLEkwqHa9tzm4AcbafAv834lnVCf3bteNq/k2eHL0/UFvVePy19KFZWHDhLOWTDc8wltvmMXOgjyMRqN1L9cmL95m5Yqzv3ETy9xcdI//NVhhKgKKWNbZmYFSqfagCYYG5gkTd1Qs6TF5el8Julk/Txi5Lmx6wKiml7IVRQONn3MUBFvnCCG3JsHFyOGfrkt9o0ZLd8DAQYZn2tWEqET63BWH6KU4glN6A9qv4YwJaW2Y/+EC+YzsFWk1tWSmb67ewoe3Z/Dq5avjEcDUlBBdA0sSazAhxyTQpfk4ewe89zEzoHMXxabBoKWs5v+lAmw/oxNXdtYKm8wP/MPgCI/DF1/6/CgQ6LvzZ7OfT4cTVy6swtvOIh2MD46G48lwcnw1GZ8cjk/G4391PaGkSzJYGyvjPNlYzLIMqdlDyq8DDFVxX70YT+D66oyuG4HEsyglN7FUdIjXq2kF0J3rdL3B/UoRdNA6U4vUBSGaJ8Wfo+OjCTvAF/jy+MX34/F4cnTM5uNxj92GqJAeK0bazk6QcgG5tgCKGYiZBl8hIzhjS66qgcmqROlEux+Gd0Ob1zfRwBbgFG4SpmAkJCRSRAWKsz0sUy0YgCKhSWBuNFRCFPgtQPfv0+x3N+v1D7sGxNIM1VCh5pogCzBleMh84xBFVmSxou06AF9mvKxGt5xtU/5ZCVp2P0RT1NFo9I2ywrMlQiDFnoE7IZfAXZBpr7J5yvXyHI5+7ko63e696z4XCLOodezYp3BFoqoz/yUYelmv6rTAcqWoKLvZqnmsJHvmVtvWeNE/b2p7QlFJGpZMW8D4MXpXtLjRiLeAugbnTdoHxyVxkvVriJPQNJpAaUgKKCcFKg6HVLuyX26n/b4lcjkvsKGN8XrgxUyXqG2Hh1qNB5xlKdyjNFnZV5uFBRWOy/vNRuYTOQi8Nx3q1Pp3ZtY2LIWfeV72abZ12jes9NbSi5EFdhDlwTtzz5rhVdHI7Mwq2E7/Rl5tjwF0PKtJExwv54BH40nV991lpqD5PEGlpDqTgVURfW4WUW+7Otr0s3p3n3FVhzsak9F0yPeVUSt9vGaE4rKcLrAY8bHRoaOWa1EnUK95CbT02I1p/J+qZioMKsESyj8LVGDZtHRkoaCfK1si/PjgnWbcNhg/3tLMi2GRLpvqvaFbkyZSNDE1NrzIzj5ljDpq3v7icN+XIuTRPnnTsB4MGrJ6u0Wii/75rXNMZSF70SM98WJjMn2yvx9gKocs4yMeKSbMiFO3ok1gZshHo8doaPdzm8xtrRIH1O2Floqp6yXui2JsqXDIam7ptDDKMkG1KiWXU+rFApkuNYf8Yg7N9r7tyFmB9D9t0PlU+D2kuaaRHIqhIb/HAJbcxPDJyQif4JmQxjVhjGI8sTrImI/PB2AHEDbJnkCx8YeVzBWpY3iHqx8/jby17aOGsnQi5sqgmDJOitR5lkll/l4rrzo//6n+alPrzQtrqaXaBM/+++//PCeEyGC2xIDr2D238N6PmYhcgWeBqi6O6WL0KFNyQbUaC+VzjfTiTcKhlgtUyCNRNJzNalDstwUzn/CYMJwlemCfcBGnPLukCoOxzLRMeACZDFxJQiYy4qgHgILNrYIp3ywhwQUmNoWS81FEYHOeUNmciLDcyNQ9a32ZZgm37QN7efZ4CiP77CXcRMMEEOY0ZmDLWFbOlAmBihBfwn0UrpNWmlzG/BjhYDTu6Hy5XI6Y/XkkVbRf7NX776Znb97P3gxpz7qGVvU9kKEG0s/TsrzZmMdyL6/R4WhiEa3UJmWiIY+FgjvMcba9oxGvnzYMWjgmTevsZwnjojFR4ILSR29x6MbvQh4VhaBHAtPtwIulNrTn4YHw1bVK1mv62k0o2nDFNd1K0F8IaZ7jrx1F7T04zXo0JlLtdnpI2DC5s+BPnSv9giglNv1KSf68OdMvyFiNm9ZC3tI/yoYJmxbL/GktwO069akQ09jVRXPNNPnTmyvPvfs308mdTSfFB6Je/iRWDdrtzOJEcJM9j2z5gdz4V1z9WC13vzy6ocpmbjVpiDDu/wC4Ju72
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List Data Disclosure Agreement Templates</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreements"}></MethodEndpoint>



Lists Data Disclosure Agreement Templates.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filtering data disclosure agreement templates by draft/published status","in":"query","name":"active","required":false,"schema":{"type":"boolean","default":false,"description":"If true, only published templates are returned.\n"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Template List

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplates</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"context"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of URIs of JSON-LD contexts"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["DataDisclosureAgreement"],"description":"The Data Disclosure Agreement type from context"}}></SchemaItem><SchemaItem collapsible={false} name={"language"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO 639-1 language code (e.g. 'en' or 'sv')"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template"}}></SchemaItem><SchemaItem collapsible={false} name={"templateId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier (derived from 'id')"}}></SchemaItem><SchemaItem collapsible={false} name={"templateVersion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template (derived from 'version')"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataController</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An organisation constituted as a legally defined entity in any jurisdiction

</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller public key"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller name"}}></SchemaItem><SchemaItem collapsible={false} name={"legalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller legal identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Data controller URL"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller industry sector"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"agreementPeriod"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Days for which agreement is valid"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSharingRestrictions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'


</div><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Where to find the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Jurisdiction where the data sharing restrictions apply"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"How many days the data can be kept"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data can be shared to"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data is stored"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Purpose of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`contract`]"} schema={{"type":"string","enum":["contract"],"description":"Lawful basis for the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"codeOfConduct"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to code of conduct"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hash of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Data Disclosure Agreement is published or not"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Presentation Definition"}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"OpenAPI specification of the Data Agreement, defining available APIs for Data Using Services"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revisions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of revisions for this Data Disclosure Agreement Template

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementTemplates\": [\n    {\n      \"context\": [\n        \"string\"\n      ],\n      \"id\": \"string\",\n      \"type\": [\n        \"DataDisclosureAgreement\"\n      ],\n      \"language\": \"string\",\n      \"version\": \"string\",\n      \"templateId\": \"string\",\n      \"templateVersion\": \"string\",\n      \"dataController\": {\n        \"publicKey\": \"string\",\n        \"name\": \"string\",\n        \"legalId\": \"string\",\n        \"url\": \"string\",\n        \"industrySector\": \"string\"\n      },\n      \"agreementPeriod\": 0,\n      \"dataSharingRestrictions\": {\n        \"policyUrl\": \"string\",\n        \"jurisdiction\": \"string\",\n        \"dataRetentionPeriod\": 0,\n        \"geographicRestriction\": \"string\",\n        \"storageLocation\": \"string\"\n      },\n      \"purpose\": \"string\",\n      \"purposeDescription\": \"string\",\n      \"lawfulBasis\": \"contract\",\n      \"dataAttributes\": [\n        {\n          \"id\": \"65471222e8c7c3bb3c2c8501\",\n          \"name\": \"Name\",\n          \"description\": \"Full name of the individual\",\n          \"sensitivity\": false,\n          \"category\": \"Personal\",\n          \"scope\": \"read\"\n        }\n      ],\n      \"codeOfConduct\": \"string\",\n      \"dataAgreementId\": \"string\",\n      \"dataAgreementRevisionId\": \"string\",\n      \"dataAgreementRevisionHash\": \"string\",\n      \"active\": true,\n      \"presentationDefinitionId\": \"string\",\n      \"openApiSpecification\": {},\n      \"revisions\": [\n        {\n          \"id\": \"65471222e8c7c3bb3c2c6601\",\n          \"schemaName\": \"dataAgreement\",\n          \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n          \"objectData\": \"{...}\",\n          \"signedWithoutObjectId\": false,\n          \"serizalizedSnapshot\": \"{...}\",\n          \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n          \"timestamp\": \"2024-01-15T10:30:00Z\",\n          \"authorizedByIndividualId\": \"string\",\n          \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n          \"successorId\": \"string\",\n          \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n          \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n        }\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List OAuth2.0 Clients
Source: https://docs.igrant.io/docs/datamarketplace-api/list-o-auth-2-0-clients

---
id: list-o-auth-2-0-clients
title: "List OAuth2.0 Clients"
description: "Lists OAuth2 Clients for use with a Data Marketplace. Use an API key with the scope `data-space:read` (an older API key: `config`)."
sidebar_label: "List OAuth2.0 Clients"
hide_title: true
hide_table_of_contents: true
api: eJzlV8Fu2zgQ/ZUBL9sCiuyk7cUoik2TojDaZgMkPRUBPJbGMhuKVEnKidfQbb9kP22/ZDGUZMlSsk0LLLDA5uDYEufN8HHmzXAnUnKJlYWXRouZ+Cidd/DbaenXJ3CmJGnvYGUslI7gTvo1IJyjR/iE9pZ8oTChGD47AtRwejmHW9rW6/yawCWmIFik6PHIFZjQzBKmC3iGGoxKybYmM1gkRq9ktngei0gUaDEnT9aJ2ZfdIMSLMl+SBbMCS4mxqQNvwN3KIsRZYCY18tIYTkFThl5uCHgHmp3jUhFsUJUEK1TKwRKTW0ZYTBfsWrKLbyXZrYiExpzETJjVypEXkbD0rZSWUjFboXIUCZesKUcx2wm/LXip1J4ysiISKa2wVF7MppHIpZZ5mYvZtKqiXQurZC790OXhXj/hPRuCfmjPlnxpNRQUdk3xzwZ4PK2qG7Z1hdGOHK8+mU7532E0w4MHSwo9pcN8UdJ5SkUkEqM9ac9IWBRKJuFgJl8dw+16wRXWFGS9rJ0bZLgGrRc7WovMkfSUu7FZEgzm6Tjw+TlTxxl5EKmIWmTnrdSZqKIG5IoSS34MVD//QbCLcNyjNMacfhDovA8wOpzu15NhM4vaX2+Lmr9DvPf8DsJLQKXMHaWhwJ4E7GVOzmNejHGv21cPRgmJJaz3YEGh85CbVK6azOlcSe1FVfUT/kt3/oNTPDiHg033A73ZY5vlV0pq+E5NemnYvGdjr/jBZbcqGuZkaS1pf4kZPVKEfW7O6tWhnJuaF5Gge8wLdnTMzBqPat4WwHfwrnlxTzxC4QBuUCrWwT72yasWnGP9GXAOmuXUUQpGQ6tuew8vqqiRvO9jXwxCbjXugI1pFYk1uktLG2nKfshLYxShHsHOdcqZRA5kyD1LvzhAKBqEkYsgorWXC7r3P+9B070foXtbUlX/RWJNmIZ+txNntWoeXQdXu7GGB/3sAY3FtRplVg8Tal8i+H05PQ55+lSl7hccWWvsmUnDrvh7X6BG9TQsjc76oXzYb+7llM95BN/ZNKrT5+MtpiB1UTLnzSQhGp4PafmsudUYK38P/ao7BF76qu6B/1Nq5tqT1ajAkd2QheBmwFEVCUdJaaXfhkHttJAfiL/e8EDhMeP5TbxFR3AWxrvSBvIcU5CTX5tUzEQWNLpAvxYzMdm8mNSj4KQbGyf1RHCUNCMBu+WgHhoPzyk3TcwiEqVVYibW3hduNpmklJsjLGQsQxOIpRE8jw16vGc5zx7DcPXrIcxNR8UVZ0R9kC0h3QhTP2iGvqYQ94PmaZOMbS85DKwdr5kL0r5JxBiu1+1E23TUxQHOoql3yEvnYUksdyt5T2k9py/qGGEBz7TxFAC8RakCB8z+8wgozuIB7Awaw9dbU1qm4+iWtm8WcWicUq9MWzyYhOKhHCUT6cqiMNb/2pG337983z06ZL1/YANa9kbw7K8//nwOkgX36o5S6dbAOQR0n6xRZ3xHSWFDdj9PhDOWCVNiNjIlG8Pc81XHgSO1OnJmQ5ZkpkGmzLjfRo19uEYklsJjVC4ChFRmklviHSpFPjhzRskUCpOCp2StjTKZJBcBaVwGgrk13IGiDanQ7bjoWAlwKZX02wCCpTc5el6emLxQEnXSXMbC9ixlparrCqQGhFWpFKdJKn2IM0etyfL9QMmEtAuy0qZcgcma4CSejji/u7uLMbyOjc0mja2bfJyfvbu4enfENlU3BXXnwImamqTMSfs2lbla6/M6mZ68jF/Ex2xbGOdz1L14+ALajITxtL1RDEuhJ8r/kRtrU96e7v2kUChDCw507hpl+yI2L+or0UqyJHcuRCQG+nYTibVxno12O56oPltVVfy4viYG1ZOOD7e76j3K0L97YX5w57cset29OZiLmajV9smB/+jt9x9CaafRLpIb/mFDIYeG1Xa2QG5tdJokVPStxnNWv4+9f3ctIsEneSj4t0Hwmy+M3r7S2x72UPvrEPiTSXvQ5DXn4gfavtkvr988arDvN/VqJuimqqq/ATB9PwA=
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List OAuth2.0 Clients</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-space/oauth2-clients"}></MethodEndpoint>



Lists OAuth2 Clients for use with a Data Marketplace. Use an API key with the scope `data-space:read` (an older API key: `config`).

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace related OAuth2 Clients listed

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>oauth2Clients</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Secret of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"grantTypes"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Grant Types allowed for the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"int"} qualifierMessage={undefined} schema={{"description":"Timestamp of the OAuth2 Client creation or last modification","type":"int"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"oauth2Clients\": [\n    {\n      \"clientId\": \"string\",\n      \"clientSecret\": \"string\",\n      \"clientName\": \"string\",\n      \"clientDescription\": \"string\",\n      \"grantTypes\": \"string\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List Pull Data Records
Source: https://docs.igrant.io/docs/datamarketplace-api/list-pull-data-records

---
id: list-pull-data-records
title: "List Pull Data Records"
description: "Lists Pull Data Records, optionally filtered by Data Disclosure Agreement  Template (Revision ID) and/or Data Disclosure Agreement Record (Revision ID)."
sidebar_label: "List Pull Data Records"
hide_title: true
hide_table_of_contents: true
api: eJzlWM1u40YSfpVCXzID0JLGM7kIQbDe8SQQkgyM2HOaNeASWaQqbnYz3U3JWkG3fZJ9tH2SRTVJiRJlx/YiwALxQZbI+uuvquur7o3KyKeOq8DWqKn6mX3wcFVrDZcYEH6l1LrMJ2CjBGq9hpx1IEcZzNeN0CX7VFtfO4KLwhGVZALADZWVxkDw5ldasmdrYHb5FtBkY+ueUGxcHmqN/mFUoip0WFIg59X06+Yo8s91OScHNgfXxAzBgr/nCnLroMKCDYroCC7AUIGBlwTWQW0cYYZzTbBEXRPkqLWHOab3YuFucjdSiWJx8XtNbq0SZbAkNVU2zz0FlShHv9fsKFPTHLWnRPl0QSWq6UaFdSWibAIV5FSiMsqx1kFNJ4kq2XBZl2o62W6TTWdWc8nh2OXhWn/BB1EEc2rNjkLtDFQUV02j1wb4ronq0PMPMfdPZ36X+F4GH4Eww4B7GzsTnYXOwCx71iJ8cGwK9cqw27p7ddCN/mtDvhVpX1njycv788lE/h0uY7AvQbMPJK5SawKZIDpYVZrTWOzj37wobnqOK2crcoEbN1WttRhs7fUiQ+dQFs2BSj8MpUXL5oC9diELJi/Ve+iGs6GF2aVohwUN2g3MKayIDGDz9NrWLiXpHM3vL55NAdfklpySSo6xTF5QVk9E9ZICDwsMkFHOhjyId1ihBwGXMsAC2URQnhvooJReFeZxQR8EKaq4E+0A3xl8MeTGmpROlAmazJZ6DQUZchgog0byhInUkQhchKGZGy7JByyrR0smKotw0mtpYjXYezInLC4ILtKUvIcbkYDaU9ZQRa21LFZyMwxz29/VX6WwX1Juz894h2gflm4xt7uo7Pw3SkOMas9wvU3cvk9U4KDlwdVe6niPprVzZMIVFvQIMfTx+9hIR4ppeUglih6wrMTRu4h8QD3r2scf2LsR4R6hxbYDuETWws192+ffdsYl1tcYl6CF4iXl1kDHuDsP77dJS8N/bPvzUcgd7x6gMdkmaoH+ytGSbd0PeW6tJjQDszOTSQ8nDxwr3tE3HhCq1sLARSSYxstnegiv92DoIQysB1fTtvlL1IIwizPYRn1sWOfsJrraDPkt8k/P0JCctoPK6tmExpeKfj9M3sU6fS7T9fcpOWfdR5vFVcn3y57PwX463hp77VP1sFvch4nkeWB+wPZ9PP6OGbCpasG8nW5Vi/MhLF8M1mFhHf8z8v0+CSL6bTMt/EWhmZlAzqAGT25JDqKbI4y2ifKU1o7DOh4eLir+ieTrrYxeAQs5U6hrLgxlew71AkBJYWEzNVVFnPYrDAs1VePl+3FqTc7FWHr6ma8wpbGQx1n83U7kSvxKVKfOLJdU2jZolajaaTVVixAqPx2PMyrtGVY84sKhCSO2ajjXXgfp58VjNnzz+tjM7R6LaymJJpMdIvsJsHnQDsHtTtxNwRdtNXZkchjYxdUM7mkNUrNkQluJIxDabY5ZLZHfHdi5azc8lLWXqUT6Xc4PlMGKwwLumhjhDt4YGygaCA458nVMwNsEaFSMjsxOoVX8bm1rJ3Cc3dP6+7tRZE42ue12D6Zx91CJLED6uqqsC3/bg7dbP/+4f3SIej9hR7DslODNf/7177fA0nGvV5SxXzRzIz2kCzRFM3otyXHeYhdzzKlAYpeckRvBLMjU4sGTzs+8XZIjLgxwJoiHddLqx7Nt6ig+Ru0TQMi4YOHEFWpNITrzVnMGlc0gULowVtuCySdABucRYOGGFWhako50J7tOWgHOWXNYRyNYB1tiEPHUlpVmNCk1ycuaA0JR67geDywDfl7LlQLWGYcYZ4nGkJNDq+aUjI99pSu5CtMFwfloMsB8tVqNML4eWVeMW10//nn28dPn609norPdj0H7PEihZjatZbd3pSy7tcnX+eT8w+j96J3oVtaHEk0vHrksGd6VHO+FXlv+/75eabd9oIcwrjRy5OYI86Ztel/V8n1z1sy5aIfZpvFJXxy0vttELawPorfZyLT1xentVh43J+rYENlL3vdH5Eex+3MveE4u/l764f6eJ6qrqWoa8bMDf+ltzROhdJPqKyP5H25vngjqJcefPzHwk/c3Lw/7xElsH/St/HCxo8bRoZsxYik3ZuVQWfVzNJx4+zPFj59uVKKEJg+Z9z4yb/tFrHevzLpn+5iEmxDkU/A9qfKddLyfaP39Trx586jCjvgbaYHwdrvd/hdf/cXc
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List Pull Data Records</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-space/pull-data-records"}></MethodEndpoint>



Lists Pull Data Records, optionally filtered by Data Disclosure Agreement  Template (Revision ID) and/or Data Disclosure Agreement Record (Revision ID).


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by Data Disclosure Agreement Template Revision ID","in":"query","name":"dataDisclosureAgreementTemplateRevisionId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by Data Disclosure Agreement Record Revision ID","in":"query","name":"dataDisclosureAgreementRecordRevisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Pull Data Records listed

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pullDataRecords</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the Pull Data Record between a Data Source and Data Using Service","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementTemplateRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the Data Disclosure Agreement Template Revision that defines data was pulled against","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the Data Disclosure Agreement Record Revision that defines the agreement between the Data Source and Data Using Service","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Randomly generated nonce","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"int"} qualifierMessage={undefined} schema={{"description":"Timestamp of the Pull Data Record creation","type":"int"}}></SchemaItem><SchemaItem collapsible={false} name={"token"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The Access Token used for pulling data","type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pullDataRecords\": [\n    {\n      \"id\": \"string\",\n      \"dataDisclosureAgreementTemplateRevisionId\": \"string\",\n      \"dataDisclosureAgreementRecordRevisionId\": \"string\",\n      \"nonce\": \"string\",\n      \"token\": \"string\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List Validate Access Records
Source: https://docs.igrant.io/docs/datamarketplace-api/list-validate-access-records

---
id: list-validate-access-records
title: "List Validate Access Records"
description: "Lists Validate Access Records which show every time an access token was checked at the token verification and authorisation endpoint (validate access)."
sidebar_label: "List Validate Access Records"
hide_title: true
hide_table_of_contents: true
api: eJzlWM1u48gRfpVCX2IDtKTxzOYgLBZx7MmusrMTY+1JDh4DbpNFstbNbk53U7Ji6JYnyaPlSYLqJkXqb+wxsECA+GBJZNdP1+9X9SQydKml2pPRYio+kPMO/i4VZdIjnKUpOge/Ymps5mBRUlqCK80CcI52CZ4qBKlBxnPePKCGhXSQlpg+YAbSgy+xfTFHSzmlkmWB1BnIxpfGkotPUGe1Ie3haN7Jj3yPR5+1SEQtrazQo3VievO0pfjHprpHCyYH2yrrDbgHqiE3FmpZkA5SRnAGGgvpaY5gLDTaoszkvUKYS9Ug5FIpB/cyfWAOd5O7kUgEsYgvDdqlSISWFYqpMHnu0ItEWPzSkMVMTHOpHCbCpSVWUkyfhF/WfJS0xwKtSESGuWyUF9NJIirSVDWVmE5Wq+SpY6uoIr8tcvOuv8hHJgS9784WfWM11BhujaPXKvhmslrdMq2rjXbo+PTpZMIfm9ocChZFzmMmEpEa7VF7ppR1rdoAGP/mmPxpoExtTY3WUxTWBUFk23Id6CytlWwb8li5XbUiARtnOz5bxvuDUHqPVc0O2NSGsoFo5y3pYscvnzR9aRAoQ+0pJ7Qh9jj+ByKjq8QqugXZRhfSywtyqTKusXhWWMQKtY83mL1A8OyC78mCmBX0vGDNrHULpEZrTD1mHCtMMTTNjlbnSjq3ztnnFQni0w0iWDOEIxwVowQ+i5ros+AvUhu9rEzjPotjIL2rUCJQc4rcMI1IegJxO9T1/aNHq6WaZddBv+f05FNsMmzpYHYx1NNotQy+u5zNtq5zLPbLfV7m+4GsWGq+QeLabWuHzjaSwdz/hqnfkfmTUVwVSgRXY8osweKcHPtldrEOT/uC2EhAOligUvzJL/vTh4PuGqtacW34dSCVk44ZNDpDq5aki8hhGKvr023p38jF7Gv50tF+W96szfNsAq116/saNzyLCqXDjG3KDjugY2eQ303LXYv7sm3CrZdZW0eF3tR1YMXXaPYCXwY9MsxJYwwgFsuRdo/gSmkxg3v0C0TdV7Ir09gUQ8SE358cS7hCO6cUxWrV5+LzuXBdcsMnBgJqsyBHBttRFoP/OpSh5wtKifDXf1x3PTBQxRuzubtWFsp+6X39C/rSvMDAzPan6+tLqAJBz3FdOphjLX35Ml5nlzPg03sZrYZI4Wbj/htatwJjAY7ogKUbjX/LAzL7uh+umsA4b9TBtrxmu6lRxI8BU2S7zYkhU0ZzyhqpXJCamgyzcyWpCu3iOcX+IkkxZH21UhYlY5pbxk27tt/DCo5cNAYj0VySaiyGcs+42nlZ1XsxWm5sJX189Md3+2DII6w5wKJsM2qggEnTxto9TqdMfAMw+TpaONS1+pwdBNDwzrfJlqdWIcg7CL8v1T15xQ8u+1Pb+RxurP2lLPAA8h0a8TyeDhi6BdoMRh5lVbOgN+wk46WadejzGX7XfHiA2ANqBTmXpHj4GPI+/a5jzrq+hjkrzTMM9yOjoRsp1hLerpJ2znie98ctlbvBYsMaE65r0l0yuGBw1rO9N0ah1LutQ2ccJ+iAQgex+AcHEuqWw46IMLlEKR/x0b9egsZHv8Pd2wZX8S8RJcosDJlP4jyOLicdqtwZnMIQM2C0O+GsdiJrwBOirNjJ3k3ehDh96bg0zFu01thzk4Vb8feLgcydfNpOjZ56XzysL/duwn7eYb+n8/T2+LPMgHTdsM3b8V20dt6uWu0g9s9QS3sn8NHv4uD5f2qamW4nB4d2jhaCmC0brRLhMG0s+WXowWc1/Yz8NXQjLwtemogWnnwwheOrVy0MEUVYZEQcIcbzt+PU6JyKMbfZE1fLFMcdhjmJ/fGkXTkIlsta7VvKXGBlWqVFIhqrxDQACTcdjzOszImsaUSFldqPyAhu0VtYwXM9Lw7xcPH1Npvb3hZXHBLRk51F+gVCfNCuWtpMXK93ztpo7JrJpmIMpB5wGZYHPO2n7XKpbfQNdsD4boPPXZvwUDXOM/CtLeb0iBksyJdwF3WEOzjSxmMcMawkFWzAbjhOgIfoLbZTaAm/X5rGsjlOHnD5w90odE7SuemyR6Yhe7CSxIZ0TV0b6//UG299f/qxf7Rp9aHDtsyyJoKj//zr38dAXHGvFpiRKyPex8e0lLqImH5jIegiqofamjllaEcw89A4dOBQ5SfOzNEiFbrdr/hl0tKH5V1qMTyWyiUgIaOCuCcupFLogzBnFGVQM4rGtNRGmYLQJYBa3gcDc29YgMI5qtDuOOu4FMh7UuSX3bLIVNLz8dRUtSKpU4zOC9ezWDQq3MfxPkNC3ijFYZKRD3pWUmu0vJVTlGILnbuQq2VaIpyOJjs2XywWIxlej4wtxi2tG3+Ynb//ePX+hGlWPQzq/cCBmpm0YfDVhTJna/TX6eT03ejt6E2YIozzldQDfXgZfGgXvJ0Rg+L8P71EbnPf46Mf10pSaNDB1k9t/bsR87cRu+ZUtKNGrIFsugNV8DYRpeEp9EY8PTHw+mTVasWP4wo31EZyHAL9GvagAX/fZfZeEzxwaex32oFcTEWsyS9W/Fs3019RpQOtvSa3/MOGdA99rWuAwbiRiEOtHlLtwrFh2/vx/TXvFJuN8VnW9BDaQvtlMNFKvRzw3u4QUQX+P5g1N0m+53T8GZc/rI/HNwcJ1l0pnmYD3a5Wq/8Cy/IOkw==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List Validate Access Records</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-space/validate-access-records"}></MethodEndpoint>



Lists Validate Access Records which show every time an access token was checked at the token verification and authorisation endpoint (validate access).


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Validate Access Records listed

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>validateAccessRecords</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the validation record"}}></SchemaItem><SchemaItem collapsible={false} name={"requestedDataDisclosureAgreementRecordId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the Data Disclosure Agreement Record connected to the access token"}}></SchemaItem><SchemaItem collapsible={false} name={"requestedDataClassification"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`pii`, `anonymous`]"} schema={{"type":"string","description":"Data classification requested (e.g., \"pii\", \"anonymous\") in the access token","enum":["pii","anonymous"]}}></SchemaItem><SchemaItem collapsible={false} name={"requestedExternalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of external ID requested (only for PII classification)"}}></SchemaItem><SchemaItem collapsible={false} name={"requestedExternalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External ID value requested (only for PII classification)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>connectedAgreementIds</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Holds the specific revision ID for the record connected to the access token, as well as the connected Data Disclosure Agreement Template Revision ID and the underlying Data Agreement Revision ID.


</div><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the specific Data Disclosure Agreement Record Revision the token was released for"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementTemplateRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the specific Data Disclosure Agreement Template Revision that the record was signed for"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the underlying Data Agreement Revision that defines the data to be shared between the Data Source and Data Using Service"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>request</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The original validation request

</div><SchemaItem collapsible={false} name={"accessToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JWT Access Token that was validated"}}></SchemaItem><SchemaItem collapsible={false} name={"httpMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTP method that was requested"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The API path that was requested"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>response</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The validation response (success or failure)

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={"**Possible values:** [`true`]"} schema={{"type":"boolean","description":"Whether the access token was verified and authorized","enum":[true],"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"dataClassification"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`pii`, `anonymous`]"} schema={{"type":"string","description":"Data classification of the validated access","enum":["pii","anonymous"]}}></SchemaItem><SchemaItem collapsible={false} name={"individuals"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of individuals associated with this access","items":{"allOf":[{"type":"object","title":"Individual","description":"Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.","x-not-in-database":false,"properties":{"id":{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."},"externalId":{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"},"externalIdType":{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."},"identityProviderId":{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}},{"type":"object","title":"IndividualExtras","required":["name","email","phone"],"properties":{"name":{"type":"string","description":"Name of the individual"},"iamId":{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"},"email":{"type":"string","description":"Email ID"},"phone":{"type":"string","description":"Phone"},"pushNotificationToken":{"type":"string","description":"Device token of the individual"},"deviceType":{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]},"mapperId":{"type":"string","description":"Defines the mapper id of the individual"}}}]}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedClaims</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The decoded JWT claims. The fields listed below will be present; additional claims are allowed.

</div><SchemaItem collapsible={false} name={"aud"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The audience of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"dataClassification"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`anonymous`, `pii`]"} schema={{"type":"string","enum":["anonymous","pii"],"description":"The data classification of the requested resource"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the Data Disclosure Agreement Record associated with this token"}}></SchemaItem><SchemaItem collapsible={false} name={"exp"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The expiration time of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"iat"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The issued at time of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"iss"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The issuer of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique identifier for the JWT"}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The decoded JWT claims. The fields listed below will be present; additional claims are allowed.","properties":{"aud":{"type":"string","description":"The audience of the JWT"},"dataClassification":{"type":"string","enum":["anonymous","pii"],"description":"The data classification of the requested resource"},"dataDisclosureAgreementRecordId":{"type":"string","description":"The ID of the Data Disclosure Agreement Record associated with this token"},"exp":{"type":"integer","description":"The expiration time of the JWT"},"iat":{"type":"integer","description":"The issued at time of the JWT"},"iss":{"type":"string","description":"The issuer of the JWT"},"jti":{"type":"string","description":"The unique identifier for the JWT"}},"required":["aud","dataClassification","dataDisclosureAgreementRecordId","exp","iat","iss","jti"],"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={"**Possible values:** [`false`]"} schema={{"type":"boolean","description":"Whether the access token was verified and authorized","enum":[false],"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason why validation failed"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Unix timestamp when the validation occurred"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"validateAccessRecords\": [\n    {\n      \"id\": \"string\",\n      \"requestedDataDisclosureAgreementRecordId\": \"string\",\n      \"requestedDataClassification\": \"pii\",\n      \"requestedExternalIdType\": \"string\",\n      \"requestedExternalId\": \"string\",\n      \"connectedAgreementIds\": {\n        \"dataDisclosureAgreementRecordRevisionId\": \"string\",\n        \"dataDisclosureAgreementTemplateRevisionId\": \"string\",\n        \"dataAgreementRevisionId\": \"string\"\n      },\n      \"request\": {\n        \"accessToken\": \"string\",\n        \"httpMethod\": \"string\",\n        \"path\": \"string\"\n      },\n      \"response\": {},\n      \"timestamp\": 0\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Pull Data Endpoint
Source: https://docs.igrant.io/docs/datamarketplace-api/pull-data-endpoint

---
id: pull-data-endpoint
title: "Pull Data Endpoint"
description: "The Pull Data endpoint allows a Data Using Service to Pull Data according to a  specific Data Disclosure Agreement record signed by themselves and a Data  Source, either anonymously or for a specific individual."
sidebar_label: "Pull Data Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJzlVs2OGzcMfhWCpwQYj51NejGCoJvsojDSnyDenDYLLD2iZ5TVSIqksdcxfOuT9NH6JAU1/lsnaVKgp/ZijCWR4veR+sg1Ko5V0D5pZ3GMVw3Dm84YuKBEwFZ5p20CMsYtI1C//C5qW8OUw0JXDMkdWVBVuaBkOzkggOi50nNd9bsXOlbGxS4wnNeBuWWbILCYQNS1ZQWzFaSG28hmwRHIqt2lMHVdqLgA1qnhAGSdXbWui2YFLsDcBaDDddoqvdCqI1O+t1hg4I8dx/TSqRWO11g5m9gm+STvja5I8A8/RCFhjbFquCX5SivPOEY3+8BVwgJ9cJ5D0hxlV1GiA6Y9pLcZ0UQdOYgpaFtjcUL311npfcDkAjcFHtB8j9PJ/nQ23/TodWCF4+tvxnyz2fQm0Tsbe5xno1GG++CaaVdVHOO8M3Cev+DK3bGFwIYpMhb/FsuUvWfn3wa/DSXlUJKDGUMXWQEJpTGXUK5cDrjZ9FCfjZ78o5o4ZpNDcOGVUwI3f18cRXNTfAPZwfqAS9vENQfxd0+tN4zjZ6PR5gvuv8DF3gRfkgJtfZfAU6CW0w7wKWHvLHWpcUF/YoUFNkyKg0QnR3/oE/8/pWZiEwdLBmIuGMjXnHC0KTBy1QWdVji+XuO5169ZPm82gpHqKFzkd/4LhTtO3lDFgr/l1DiFY/QuZvyUGhzjcPF0WDk71/VQnuogeqp46DtjBvIf5T6JJubrTuSEW7cNFgvsgsExNin5OB4OFbduQF6Xug5kU6kdborP3nSiWsT7Kz5iv33q5ubAwVRKoc/gjol9KqhfEDkTn5lELNBSK7vn2yrMpfX5s34zgTtegdQq27StwBKkXy3IdAxuLo0Dbh/4uYX+Gmi7mEQLfOC5vmcFS50auO1jhFt4ZF3i7CAF0iZzIMQ/LoDLujxxO4at4fOV64LQMbjj1YvbMqutPIu3h35zuSu87+gXh3J9KPm79dwL5m73JqnKb5Jb0pKm2HnvQvrxkJo9u/qnw9LDnB6XwwnpeyN49OfvfzwGLRPAdMlKxwZUHhDuq4ZszblRLzhI780M5QqS6cAHt9CKQwmTJEocIbKZD6JbcGBdW9BK8plWxdaeZoahCpyXycQCCJSudSIDSzKGU74sOqMVeKcgcdVYZ1ytORbAlmY5fQSWl2B4wUZqQ7QjCwzNtNFp1Y8WXXItJTleudYbTbbivjQyvMB1ZzKeCNoCwbwzRopQ6ZTjbMlaDiUWaHTFNuYs7wraU9UwnJWjzzhfLpcl5e3ShXq4tY3DnyevLn+dXg7EZlNg0sk8SB7IM1Cu6qRqdg9FtKDP19no7Fn5tHwitiIqLdmjeA5D2uV2rDt9ZUdC/58dBLdalPg+Db0hbYWsnJ31VoGvcfG0H17mOs8XexUWkd7r8E2BjQj3+BrX6xlFfhfMZiPLHzsOuQMUuKCQCzr3g13jyMJ9J9KIr3q+B1cSlRw3Xa+UJ01WlLq3kPnGp789e9xb3vw2vcICZ9u5t80NFQMtZSamJY7xPb5HLNDlGsjCndfXaMjWHdVyvvcr2ib6+1DS77Kkbz8E2W7Lro6iPFX3Hoz8CrQvmjyXYn/Nqxf74/3OVw32HaU/LamVYfYvZYSBIQ==
sidebar_class_name: "post api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Pull Data Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/config/data-space/pull-data"}></MethodEndpoint>



The Pull Data endpoint allows a Data Using Service to Pull Data according to a  specific Data Disclosure Agreement record signed by themselves and a Data  Source, either anonymously or for a specific individual.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data Disclosure Agreement Record ID"}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Individual ID"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Successful Access Token release

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accessToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access token to be used at Resource Server"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"accessToken\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Access Point Configuration
Source: https://docs.igrant.io/docs/datamarketplace-api/read-access-point-configuration

---
id: read-access-point-configuration
title: "Read Access Point Configuration"
description: "Reads Access Point Configuration of the organisation."
sidebar_label: "Read Access Point Configuration"
hide_title: true
hide_table_of_contents: true
api: eJzlVsFuGzcQ/ZUBTwmwWim2exGCoI5jBEbaIqidk2HAo93RLmMuyZCzklVBt35JP61fUgx3Ja1kpS167UVakJw3M29mHrlWJcUiaM/aWTVVvxKWES6LgmKEz05bhitn57pqA8oRcHPgmsCFCq2OaS1XmQoUvbORopqu1dlkIn+HyB+QEX7G8ETsDRYE7zHSIXiEQFiqTBXOMlkWEPTe6CJtj79GQVqrWNTUoHz54DwF1p1fTGGnqK9t6eX/ZRx3NUF3ENIJKP4pP5UpXnlSUxU5aFupzUYS/tbqQKWa3p/0+7CRUzVhSSEFd9XlNLpLUMMkevCUXaboGRtvZOFF6pvsKJchJnS+VPJ7MXkjyP+ax2E2FIILV64kCUa+Pwx8Puy4cLOvVLDKjmqwt95npi1TRWGY3MVksjkBv7fpqR7y8R5L0Na3DB4DNsRdtpsXtHyx2HLtgv6NpJv2RZCjP3TN+T+l5sYyBYsGIoUFBUhujjjaZCpS0QbNKzW9X6tLrz+RfD5sJEesonBxYnyFgoa4dqWaqooSA8i1mqrx4nzczdm4RMZR9FjQuJubURqYEW0nR7xLbDE5PxIRalwfuspUG4yaqprZx+l4XFLjRuh1rquAlnPt1CY7BrhlrLStvocRu+1jmIc9I7fSGF09t7zsCoPdQqa0uOrnMVMWG9m97HtyqymHgV1+voEnWoF0Llnu+zEHkasFmpa2yvR4gPPYjz00bWSYEfhAc/1MJSw11/DYxQiP8Mo6pgTAAbVJHEgRXmdAeZUfwU6hN3y7cm0QOkZPtHr3mCft03butjOERZohalALkbH13gX+cU/eLn/9cb90yPqwYEe07Izg1Z+///EadASE2yWVOtYgrQT0XNRoKwK0JSwo6HnPXaqxLoQSt9AlhRxuGNpIESKZ+Si6BQXSlQVdCuO8ynp7nBmCIlBaRhMzQCh1pRkNLNEY4uQsOqNL8K4EpqK2zrhKU8yALM4SwQiWlmBoQUaqJ7OeBAFn2mheJRBs2TXIcrxwjTcabUFd8VJ6garW9LejtoAwb42RNik1pzgbtJaC3MFGF2RjUpdty3ksaoKzfPKC8+VymWPazl2oxr1tHP90c3X9y+31SGw2mWLN5qB4II1auqJtyPK2lWVau3qdTc4u8vP8jdh6F7lBO4hHXhd/87g4HoqBSv/nh0k/mkzPPPYGdbpFExXrXpzu1eK8e3PMtajqXqBUpk5L1EOmahdZbNfrGUb6EsxmI8vfWgpJKjO1wJA6KQnnVmGTpj2JaijJxYvcpfE+ed8P9fTj9Z3E00rIQ8V5SorTfwj6dsuuBtjH4tOFIL+ikSdN3kqlP9Hq3e54t/Ndg53gdaeFankF/QWNjaFZ
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Access Point Configuration</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-space/access-point-endpoint"}></MethodEndpoint>



Reads Access Point Configuration of the organisation.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace Base Configurations read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accessPointEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The access point configuration of the organisation","type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"accessPointEndpoint\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Base Configurations
Source: https://docs.igrant.io/docs/datamarketplace-api/read-base-configurations

---
id: read-base-configurations
title: "Read Base Configurations"
description: "Reads Base Configurations related to a Data Marketplace."
sidebar_label: "Read Base Configurations"
hide_title: true
hide_table_of_contents: true
api: eJzlVk1v2zgQ/SsDXrYFZNlNshejKDZNgsJod7FoklMQIGNpLLGhSJUc2XEN3/aX7E/bX7IYSv6SHaDAHveSCCTnDfnezPOsVE4h87pm7awaq6+EeYCPGAiunJ3povEoWwE8GWTKgR0gXCMj/I7+mbg2mFGqEuUp1M4GCmq8Umejkfw7BO9HvZIHc5WozFkmywKCdW10FreH34IgrVTISqpQvmrvavKs27xTDHQIeHxG58dXm1yrRPGyJjVWgb22hVonEe3em+Pj91+/gJsBl3RExS8BKmLMkfEUZGY0WZ6cuMJV3IHJ9WvIr8PdUuaJX4Vst38edi1ifm+0p1yNH4SvHRV7L+hlf9ziuOk3yvgI54Q2j2s5VBLm5KM2V63sg7uItK9zhx0LIFH0glVtZOGoOtZJn4U9TGhzqZj3YvROkH+61PYfQ947f+VyoS9+X+/lPKIi6ZXgLnr3Mm2ZCvL7j7sYjdYn4HcxnWL7fHzEHLStG4YaPVbE7WvXR7TcW2y4dF7/INFyJ4Ic/bXt3/8pNRPL5C0aCOTn5CGm6XG0TlSgrPGal2r8sFKXtf5M8vm4ljdiEYSLEw4nFFTEpcvVWBUUGUAu1VgN5+fDLJ4din0MQo0ZDaVtBtkhhOSWm4WYuueyVLnu4ipRjdiXKpnrMB4Oc6rcAGud6sKj5VQ7tU76ALeMhbbFaxih3e7DPO74uJWyaNXcsLKVBduFRGlJ1XVjoixWsnvZVWR8purLcvnnBJ5pCVK3ZLmrxhTuSoI5moY2Fvd0gPPUNT1UTWCYEtSeZvqFclhoLuGpvSM8wRvrmCIAe9QmciASvE2A0iLtwY6hC3y/dI0XOgbPtPzwlEbj03bmNh2EWewgqlALkaGpa+f5tx152/frT7ulQ9b3BevRsg2CN//89fdb0AEQbheU61CCFBLQS1aiLQjQ5jAnr2cdd1FjnQklbq5z8ilMGJpAAQKZ2SC4OXnShQWdC+O8TLp4nBqCzFNcRhMSQMh1oRkNLNAY4pgsOKNzqF0OTFlpnXGFppAAWZxGghEsLcDQnIyoJ50e7QCn2mheRhBs2FXIcjxzVW002oxa8eLzPBWN6cYHbQFh1hgjZZJrjves0FryMqQYnZEN0Vs2JVdjVhKcpaMjzheLRYpxO3W+GHaxYfhlcnXzx+3NQGLWiWLN5kA8kELNXdZUZHlTytKtrV5no7OL9Dx9J7G1C1yh3buPTGCnBqN+N+yZ83+Z2rq2ZHrhYW1Qx9/Ppp15Wlt6UPPzdiCbafHTnTV1Y0HfnB4TVbrAErladXPDei3L3xvy0SITNUcfayga5sZZo5s9i1+oyyyjWrwxNvbJ3/l9H/10c6cSJcZw6DXP0Wu6D0HfbNnlHnbfdtoryF9xx5Mh70Xjz7T8sD3e7rwasLW69rQQLdPPv5VKAMo=
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Base Configurations</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-space/base-configurations"}></MethodEndpoint>



Reads Base Configurations related to a Data Marketplace.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace Base Configurations read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>baseConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"baseUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"URL of the Data Marketplace's metadata","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client ID of the Data Marketplace","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Secret of the Data Marketplace","type":"string"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"baseConfigurations\": {\n    \"id\": \"string\",\n    \"baseUrl\": \"string\",\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Data Disclosure Agreement Record Revision
Source: https://docs.igrant.io/docs/datamarketplace-api/read-data-disclosure-agreement-record-revision

---
id: read-data-disclosure-agreement-record-revision
title: "Read Data Disclosure Agreement Record Revision"
description: "Reads a Data Disclosure Agreement Record Revision."
sidebar_label: "Read Data Disclosure Agreement Record Revision"
hide_title: true
hide_table_of_contents: true
api: eJztW19z2zYS/yo7fIndoWjJ/5JqOp1znLRVetdkbOcyc7UngciViJoEGACUrHr0dp/kPtp9kpsFSJEiaUtumrmH6sWmSGKx2P3tXwL3XoQ6VDwzXApv6F0gizQweMUMg1dch4nUuUI4myrEFIWBCwyliuACZ1xzKQLP9zKmWIoGlfaGv957gqXoDb2IGVZRWBG4wjRLmMGSwCjyfI/T3Bkzsec3GHov+OccYfQK5KSDr5Laih/P9xR+zrnCyBsalaPv6TDGlHnDe88sMuJMG8XF1Fsu/U3MusV+GYuOxtfg688RYUOhT2L0hl7WmRQaNT0/7Pfp3/r8W2MJCH2e74VSGBSGKLEsS3jIiNLBb5rI3dfYyZTMUBnuJn9UVjXu5fg3DE1LTGegHDsKM4UahdHARI3bMZo5oihFeClzFSIwEbnf7zUXU7hENeMhApiYGQiZgDGC5lOBEYwXMJYm9mHMNEYgBZgYIc8iZjCCHyVoo/LQ5AoDuIoR3mamNxIwY0mOEJGBpVyghnmMJkZlRxc8cw0sNHzm+CFJrOaOmcIIjLSvtzntmIprkCJZ0C8ewUSqYhYNpBnGBQ2nldiFMWJYB9fryPnV41aVTEjBQ5ZYjG7pEoo3nYAvyymKu5b5gvf6M5mZEY00PEVtWJrRPTVlgmsLH8tA/caFTGgc168wQYORd+M3AMWjNuYfMK6NGOcRCsMnHFXgLdflsnEOUlCopNa9Ov8sqRG1WqrwYOfYVtodlmG4SdCGg0ojDWP5ZooCFQ+/AVWabyojTCBkmUWEZUej4izhBPfCqrX1QmIBzoyfaSCFJghKzgmLXBP+TIwCdG75IewO9iFUi8zIqWJZzMMKeRbwh/vA8ogbLqbBtbgWZ5pHCBMlU8vFtafzMEStpbr2IJRJngofWMW5jmWeRGQuoRQ0lkwmkeEtRhTg7npCmh4XPRIpGa83nLBEYwfg3ap+Ie/tF/J0yLOXBBN6CRX/nSX8d4wuBct0LE1x1938iel4DcpbQnMiVcqMN/Q838M7lmZWiacnx88Hh4eH+CJ8Hh6Nx0fhYXh62h+0lLryw6NXhJ/aUraeiwS0QlprgnckcJnrZEEqseSvPRjnxsEXw9jaBChkWgpdVwtLEoxWo4ipazuzyFOSfXPeTCY8XBQuoxkKbpY11XyRGF8cf3vYaa7vfiaYE/ZkgWEKB3OmaxbhLddgsTUj90EQLDtnrc/Fm1O5IPSBm1jm5m17+WMpE2TioWkLwK9POhIRRWdr7MxAKVS70AQnBsYJE7fABXRAnuKYIM2GecLIdGHdAoKKXsoW5A00fs5RmGRBkJhwCwkurLPrMqkvlGhpDlgE1D3yYkzDm8u3v+zTBYOIhyaAsyxLFvY2nJd+nf9unTRcEl6R3s5Qwej11Q9w8cM5vHj+4iQAGJkypGpgSWIBM+GYRLqEj8M74F2ImQGdOy82ivyGsOq/SwFQTF62/MrWUmGD8WF4FB3jyeT0seuW4Gga4r9L53uXP531BvvEV+XetmbpsH943OsPeoOTq0F/eNQf9vv/altCSZd4sBgr/TxhLGZZhgKjgIRfOZjR5Vt4cdofwPurc1I3ArFHbLLcxFLRIl4uCO8zHuVl3G5bg3tKHtRvZsvrpN5SCvck/3N8cjxgh3iKz09Ov+33+4PjEzbu9ztwO0GFIkQKnEwAi1IuINc2Y2QGYqYhVGiTTkPxthSPBUsZKB1rd73Jbc/G9fVs4PGEZTRZJ0zOSEhIpJgWaSslINqsXvBBEdPEMDcaVkwQR5nCCN3Pp+F3O/SGR20AsTRD1VOouaaUBZgyfMJC4zKKrIhiRa7lQygzjpF72DC2df6rfHXrRdRZDYLgC3mFvTlCJMUzA7dCzoE7J9N8y8YpV7NIBUKafW+5XHZn5S0roEBUZWeZkjMeueJnVYA4GkGFo1biWc/sn5B9ZWyRSFtD6hqB1fUrDGWE9HiGik+KwvIfaGLZvPluRanjbpGf1Z9cWnG9XHTePtON22/m+idkEapGwdIRo1fWvEoir0hm5Y/q8ZeUL5W+qpLCYreQwlYlysYaaM/GTEeBpohczHQL2S9zlAcNZH3GNx+uKrbXxpZa3ljxFy9WZPx6gRsmjKea/GZUVRKVoN58uKJZO4C0kfUzmGOS9MgCRSEOiFBImwPNYx7GkFpS5Ddp/gD+aUtxW57rITy7xcWYi4iL6cff5uZZk5F3T1FbRYvWBIXKawmrcwRGki1HOYWVuiAemPshV92MmAaVYEmyAFtO2pi0XujFRTJBk7r2hJFVT8UHHmBQeygn0CWJ5QPWupHDlxiyXFOVWTONZxq4cP7a1r1sAWHMxBRBziiK8RR94knZXgoDgU6A2kiFRXpeG8+MXQANs2kTnxIAAxi5BlHINLrW3QMlsO+irU0cy5SmADJomWKzT5BIeUvqzjNy71YuC/ptQ0E+TnhIoFhloI4dyJgyi6Bbkmd6syRfc9u0KuBkXcG1jSgftQ0H1x5xU7+fU2fgo3a9nla5Vwwrarz1l22J1+1wN1tnYjFpm2lF16xt5P7aPZvwUh+iKZlCPVPbmIM3Hy7rDZGiWtu7+OH8+cngZHNO/Eia2/KED0aRroJvi6KuSirbtV2j0TNDZZO+hgfxgSVzttBgg7cF4saIUfUXq2LZhr+N0qEOQaOGcu2pzjVlklNnykjfrYdrZ3UFEKMVix9ZyeJHlyu1YfnIy7XOQ5dCHnSSDTewaZrCH7g2WtH3r/WKG3qpUrvu1uofSfDWO8y7PG+X5+3yvF2et8vzdnneLs/b5Xm7PO//l+e5z+SbwfHhT91j8FTIF15yvYtf6xtX4ZnWx6II3Sfvxgf/rSaq5FYfXTaw7crHSK1rwg3s2X0Pa2/eImbktGW22G9xYXcZbMWHkgl2clIidaV+2MNgGvhQ8477wVO9ZrXvYQtPMWngIHJDA4cptdtJsNtJsNtJsNtJsNtJsNtJsNtJsNtJsNtJsNtJ8NhOgmW7IVxPfx7fyF3LN28sqdgW/DaZOXeZYa+sHVs71+0e8jXX1NxgvmzKpU4T3Fwu7T3uD4jy1rvV60tEpaQ6lxHldvb6VW3Om7Z41nO2anS1Mi4MTm2jebW4435/2UG+AzGVPF4yCoRZbmB1qsNqrCWW96LyQV5dCU40x39h0VygK74I7zCRuWgL6MQdlPiLCqhsB5OPo0aqnaYhI5tuhLniZmFPFZ1l/Gekyxs6dWLYlA4bPXy2RJMk0qJR703RCoJOxwy9g9nRQSjFhE8PyNP0qg5Lb1ViH9xvfXxpeeB83YNDykNE9KIbtOHVGm1XzM3Ko1XN7xqpLETo+V6uKLLGxmR6eHAQYSp7LOMBnyomTMClR8eK1glcGjYtsuUuGto9bpK5qTTjclKLq1I/K4Awd6M4mRSXn8GKg01nhfOwgG83Bd6NbGuaXAy1tJ1duKMqq/4/xZtPa3Q+Ff4Z0lzTeR0KRxN+hxHMuYnhk+MRPsGekMZ93zCK8cTKIGMh7vtArZUG2SEUA79byFyROHq3uPj+E7U/aHkTWdoyC60tY8o4CVLnWSaV+VslvNX6+Y/VrXWp1xXWEMtqEOz999//2XcfHS7nGHEdu8oC74oPFM0uNRS9n/J7rbJZa66Rirtk0tP0RQP5tPz8YRZl65uNEzp+gvY2S7Rvq5UpNyyBORXTxk6mJX25ymTkqm+ZyClH7QMKNrYCps8jc0hwhglpj3yOdUxszBNuFpYIy41MXQUXyjRLOLOdaFKeXZ7Cqa3wqKTndBJrktM3JduxsXymTAg6YuN7CQ9RaOvlSshlLIwRDoN+S+bz+Txg9nEg1fSgGKsP/j46f/3L5esejVlWzaxKDwTUSIY5GW8J5aIvXhQZwVEwsMmb1CZlosYPnXbb/qBl00ZqweOPndoszNTgnTnIEsZt6mPFcl94yl+92ZE7jjfh06ID0uktPd8bPuW4pyozuYdG1c5dqmr9j79dm+HG92KpDa3g/p66bO9VslzS7c85KhtEfG/GlMW2c6xc03XU3Z2oy3rvogjF+/AHzqZ2Cr10mMLuKiD35nL3W/KnTzhHax38V1jIKvH+87hfKfjr8vx1RN/C2/JmVYZYNLnRZyF1Wmp027VGPUf58fWV5wr79SB6a4NocUHUO3luxlPHAv0lCXcO+Y6c18+4+H71unvy4IBVDHdvkwSpAvsf5aTpAQ==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Data Disclosure Agreement Record Revision</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreement/{dataDisclosureAgreementTemplateRevisionId}/record/{dataDisclosureAgreementRecordId}/revision/{dataDisclosureAgreementRecordRevisionId}"}></MethodEndpoint>



Reads a Data Disclosure Agreement Record Revision.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateRevisionId","in":"path","description":"Unique ID of a Data Disclosure Template Revision","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementRecordId","in":"path","description":"Unique ID of a Data Disclosure Record","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementRecordRevisionId","in":"path","description":"Unique ID of a Data Disclosure Record Revision","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Record Revision Read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementRecord</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A record represents an Agreement between a Data Source and Data Using Service  that can be signed by both, based on the updated Go structure. The Opt-In value determines whether the record is active and data can be shared to the Data Using Service. The Opt-In value is only valid for records containing both signatures.


</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Record identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"canonicalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The cross-organisational identifier for the record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplateRevision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSourceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Source.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataUsingServiceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Using Service.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the record is active and data can be shared to the Data Using Service."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The timestamp of when the latest signature was added."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation this record belongs to (both organisation keep a copy)."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationRole"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"The role of the organisation in this agreement (e.g., data_source).","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"isDeleted"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the record is deleted."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementRecord\": {\n    \"id\": \"string\",\n    \"canonicalId\": \"string\",\n    \"dataDisclosureAgreementTemplateRevision\": {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    },\n    \"dataSourceSignature\": {\n      \"id\": \"string\",\n      \"payload\": \"string\",\n      \"signature\": \"string\",\n      \"signatureDecoded\": {},\n      \"verificationMethod\": \"string\",\n      \"verificationPayload\": \"string\",\n      \"verificationPayloadHash\": \"string\",\n      \"verificationSignedBy\": \"string\",\n      \"verificationSignedAs\": \"data_source\",\n      \"verificationJwsHeader\": \"string\",\n      \"timestamp\": \"string\",\n      \"signedWithoutObjectReference\": true,\n      \"objectType\": \"data_disclosure_agreement_record\",\n      \"objectReference\": \"string\"\n    },\n    \"dataUsingServiceSignature\": {\n      \"id\": \"string\",\n      \"payload\": \"string\",\n      \"signature\": \"string\",\n      \"signatureDecoded\": {},\n      \"verificationMethod\": \"string\",\n      \"verificationPayload\": \"string\",\n      \"verificationPayloadHash\": \"string\",\n      \"verificationSignedBy\": \"string\",\n      \"verificationSignedAs\": \"data_source\",\n      \"verificationJwsHeader\": \"string\",\n      \"timestamp\": \"string\",\n      \"signedWithoutObjectReference\": true,\n      \"objectType\": \"data_disclosure_agreement_record\",\n      \"objectReference\": \"string\"\n    },\n    \"optIn\": true,\n    \"timestamp\": \"string\",\n    \"organisationId\": \"string\",\n    \"organisationRole\": \"data_source\",\n    \"isDeleted\": true\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Data Disclosure Agreement Record
Source: https://docs.igrant.io/docs/datamarketplace-api/read-data-disclosure-agreement-record

---
id: read-data-disclosure-agreement-record
title: "Read Data Disclosure Agreement Record"
description: "Reads a Data Disclosure Agreement Record."
sidebar_label: "Read Data Disclosure Agreement Record"
hide_title: true
hide_table_of_contents: true
api: eJztW91y2zYWfpUzvIm9Q9GS/5JqOp117LR1uttkbGczs7UngcgjETUIMABoWfXobp9kH22fZOcApEhRtCU33dmL6samQAI4OOc7vwAeggRNrHluuZLBMLhAlhhgcMYsgzNuYqFMoRFOJhoxQ2nhAmOlkygIg5xplqFFbYLhLw+BZBkGwyBhltUdF/2uMMsFs3iBd9xwJc+TIAw4TZkzmwZhi44Pkn8pEM7PQI07yKlGg2q4IAw0fim4xiQYWl1gGJg4xYwFw4fAznKizFjN5SSYz8N1xPo1fh2Jfoxn0XVDH5tcSYOG3u/3+/Rvedp1kgESYRAGsZIWpaUBWJ4LHjMaYO9XQ6M8NKjItcpRW+7nfJIjDaLV6FeM7QpTTkB7KjTmGg1Ka4DJBpEjtFNEWTHsUhU6RmAy8b8/GC4ncIn6jscIYFNmIWYSRgiGTyQmMJrBSNk0hBEzmICSYFOEIk+YxQR+UGCsLmJbaIzgKkV4l9veuYQ7JgqEhOCacYkGpinaFLXrXdLMDbDY8jtPD3FiMXfKNCZglft8ldKOqbgBJcWMfvEExkqXsxggyTAuqTutxC2MEcEmul4G8i8Bd6JkUkkeM+EQuaGClV96Bl9WU5StjviS9uY7ldtz6ml5hsayLKc2PWGSGwcfR0Cz4UIJ6sfNGQq0mAQ3YQtQPFmF+iOqtBbaPEFp+ZijjoL5Ml/WzkECirUyptekn4nGoE5KNR7cHJtyu0MzLLcCnU2tJdJSlr9MUKLm8V9Alx9BphIUELPcIcKRY1BzJjjBvdRq42yOnIFX4xcGSKACQaspYZEbwp9NUYIpHD2E3cEuxHqWWzXRLE95XCPPAX5/F1iRcMvlJLqW1/LE8ARhrFXmqLgOTBHHaIzS1wHEShSZDIHVlJtUFSIhdYmVpL6kMkLFt+jcxX1PKtvjskcsJeUNhmMmDHYA3q/qZ7LRYclPjzz3SDChj1Dz35jgv2FyKVluUmXLVt/4IzPpEpQ3hOZY6YzZYBgEYYD3LMudEI+PDl8O9vf38VX8Mj4YjQ7i/fj4uD9YEWolbTg/I/w0lrLxXMSgBdJWJnhPDFeFETMSiRv+OoBRYT18MU6dToBGZpQ0TbEwITBZ9CKirt3MssiI9+15cyV4PCtNRtsV3MwbovkqNr46/Ga/U13f/0QwJ+ypEsPkDqbMNDQimC/BYmNCHqIomnfO2pyLt6fyTugjt6kq7LvV5Y+UEsjkY9OWgF+e9Fwm5J2dsjMLFVPdQgWOLYwEk7fAJXRAnvyYJMnGhWCkurCsAVE9XsZmZA0MfilQWjEjSIy5gwSXzth1qdRXcrRSBywd6g5ZMWbg7eW7n3fpgUHCYxvBSZ6LmWuG08qu89+ckYZLwivS1zlqOH9z9T1cfH8Kr16+OooAzm3lUg0wIRxgxhxFYir4eLwD3seYWzCFt2LnSdhiVvN3xQDyyfMVu7IxV9hgtB8fJId4ND5+6nmFcTQN0d8l853LH096g12iqzZvG5O0398/7PUHvcHR1aA/POgP+/1/rmpCNS7R4DBW2XnCWMryHCUmETG/NjDnl+/g1XF/AB+uTkncCEQekckKmypNi3g9I7zf8aSo/PaqNvi3ZEHDdpC8PNQ7CuGeZX8Ojw4HbB+P8eXR8Tf9fn9weMRG/X4HbseoUcZIjpNJYEnGJRTGRYzMQsoMxBpd0GnJ31bscWCpHKUn7b43vu05v74cDTwdsJyPlwcmYyQVCCUnZdhKAYixiw9C0EQ0EcytgQURRFGuMUH/83n43Qy98cEqgFiWo+5pNNxQyAJMWz5msfURRV56sTLWCiFWOcfEv2wp2zL9dby68SKapEZR9JW0ws4UIVHyhYVbqabAvZFpf+X8lM9ZlAap7G4wn8+7o/IVLSBHVEdnuVZ3PPHJzyIB8WNENY5WAs9mZP+M6CtnM6FcDmkaAyyezzBWCdLrO9R8XCaWf0ebqnbj+8VIHa1lfNZ8c+nY9XrW2XxiWs1vp+ZHZAnqVsLS4aMX2rwIIq+IZ9WP+vXXpC+1vOqUwmG35MJGKcraHGjH+Uw/Ak2ReJ/pF7JbxSiPKsjyjG8/XtVkL/WtpLw24y8/rIcJmwluLBjPDNnNpM4kaka9/XhFs3YAaS3pJzBFIXqkgbJkByQolYuBpimPU8jcUGQ3af4I/uFScZeemyG8uMXZiMuEy8mnX6f2RZuQ988RWz0WrQlKkTcCVm8IrCJdTgpyK01GPDL3Y6a67TEtasmEmIFLJ51PWk700jKYoEl9ecKquqYSAo8warxUY+jixPwRbV1L4WuMWWEoy2yoxgsDXHp77fJeNoM4ZXKCoO7Ii/EMQ6JJu1oKA4megcYqjWV43ujPrFsAdXNhE58QACM49wWimBn0hbpHUuDQe1sXOFYhTQlkMCrDdp1AKHVL4i5yMu+OLzP67VxBMRI8JlAsIlBPDuRM21nUzckTs56Tb7grWpVwcqbg2nmUT8a5g+uAqGm2F1QZ+GR8rWcl3Su7lTne8scuxes2uOu1UzhMumJaWTVbVfJwqc0FvFSHaHOmFM/EFebg7cfLZkGkzNZ2Lr4/fXk0OFofEz8R5q5Ywke9SFfCt0FSVweVq7ldq9Bzh9oFfS0LEgITUzYz4Jy3A+Jaj1HXF+tk2bm/tdyhCkErh/Llqc415YpTZcqq0K+HG691JRCTBYmfWEXiJx8rrcLyiY8blYcugTxqJFtmYN00pT3wZbSyyt+oFbfkUod23aXV3xPgLVeYt3HeNs7bxnnbOG8b523jvG2ct43ztnHe/y/O89vk68Hx8Q89Y/BcyJdWcrmK36gb1+6Z1seSBP2Wd2vDf6OJar41e1cFbLfyEVLpmnADO+7cw9KXt4g5GW2Vz3ZXqHCnDDaiQyuBnZRUSF2IH3YwmkQhNKzjbvRcq1mfe9jAUoxbOEh818hjSm9PEmxPEmxPEmxPEmxPEmxPEmxPEmxPEmxPEmxPEjx1kmC+WhBuhj9PH+RuxJs3bqjUJfwumDn1kWGvyh1XDqy7M+RLpql9wHze5ktzTPBz+bD3sD+gkTc+rd5cImqt9KlKKLZzz2eNOW9W2bMcs9W965VxaXHiCs2LxR32+/OO4TsQU/PjNSNHmBcWFncknMRW2PJB1jYoaArBs+bwT8yaC/TJF+EdxqqQqww68vcj/qQMqsrBZOOokOqmafHIhRtxobmduTs6Jzn/Cenxhi6bWDahqzuPXykxxImsLNQHE3SMoLsww2Dv7mAvVnLMJ3tkaXp1haW3SLH3Hja+DDTf87bu0S7VlZy5z8zuqltH7U2KTJX8CMKg0OQmU2tzM9zbSzBTPZbziE80kzbiKqCbQMsDXFo2KUPfrjGMf90e5qZmsw8wHUgqZi+kzXxDeakorfa0yrtIJ6UlcOhdzfDfn7s6M9kLqk97kPt7J4tiPjmPz0vjfC6NLWSFocs35FvG/B4TmHKbwmdPI3yGHams36ywmnHheJCzGHdDoDpJa9ghlB2/nalCEzt6tzj77jPVMmh5Y1UpJoudYmLGODHSFHmutP1rzbzF+vkPddMy15sCa7Fl0Ql2/vOvf+/6HYTLKSbcpD5NwPtyt6FdcoaykFNtvmoXghYGKVMT456h7Qnkk2ovw86qOjYbCbpLgq6ZCRO61GPCLRMwpczYusmMom2oXCU+lVZCTTiaEFCykWMw7XVMQeAdCpIeGRBnZdiIC25nbhBWWJX5dCxWWS44c2VlEp5bnsaJS9coP+d0rWpc0AaRK784OjMmJd2XCQPBY5TGmawKcjmLU4T9qL/C8+l0GjH3OlJ6slf2NXt/Oz998/Plmx71mdeVqVoOBNRExQUpbQXlsshdZgzRQTRwkZgyNmOyQQ9dXVtb526rRsMBPOv6YqmUFu/tXi4Yd1GLY8JDaeR+Ce4O/E26MZ+UxYtOQxeEwfA59x51tZDHei0uIN6EQaqMJVoeHqjU9UGL+ZyavxSonSUPgzumHSa9QeSGnpPuEkGTWTsXpT/chd9x3bKTfZWhk25rn8ySD6BvyQ4+42qoM8z/g4UsEPTHUb8Q1fxmEUY7QfheJzFVChrjrcbKTR/7w5urwCemy37j1vmN8oFG76S17UI8CfSXGNrZ5VvS159w9t3ic//m0Q4Lt+W/Js5RBvFfhuwygQ==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Data Disclosure Agreement Record</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreement/{dataDisclosureAgreementTemplateRevisionId}/record/{dataDisclosureAgreementRecordId}"}></MethodEndpoint>



Reads a Data Disclosure Agreement Record.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateRevisionId","in":"path","description":"Unique ID of a Data Disclosure Template Revision","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementRecordId","in":"path","description":"Unique ID of a Data Disclosure Record","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Record Read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementRecord</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A record represents an Agreement between a Data Source and Data Using Service  that can be signed by both, based on the updated Go structure. The Opt-In value determines whether the record is active and data can be shared to the Data Using Service. The Opt-In value is only valid for records containing both signatures.


</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Record identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"canonicalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The cross-organisational identifier for the record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplateRevision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSourceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Source.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataUsingServiceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Using Service.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the record is active and data can be shared to the Data Using Service."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The timestamp of when the latest signature was added."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation this record belongs to (both organisation keep a copy)."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationRole"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"The role of the organisation in this agreement (e.g., data_source).","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"isDeleted"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the record is deleted."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementRecord\": {\n    \"id\": \"string\",\n    \"canonicalId\": \"string\",\n    \"dataDisclosureAgreementTemplateRevision\": {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    },\n    \"dataSourceSignature\": {\n      \"id\": \"string\",\n      \"payload\": \"string\",\n      \"signature\": \"string\",\n      \"signatureDecoded\": {},\n      \"verificationMethod\": \"string\",\n      \"verificationPayload\": \"string\",\n      \"verificationPayloadHash\": \"string\",\n      \"verificationSignedBy\": \"string\",\n      \"verificationSignedAs\": \"data_source\",\n      \"verificationJwsHeader\": \"string\",\n      \"timestamp\": \"string\",\n      \"signedWithoutObjectReference\": true,\n      \"objectType\": \"data_disclosure_agreement_record\",\n      \"objectReference\": \"string\"\n    },\n    \"dataUsingServiceSignature\": {\n      \"id\": \"string\",\n      \"payload\": \"string\",\n      \"signature\": \"string\",\n      \"signatureDecoded\": {},\n      \"verificationMethod\": \"string\",\n      \"verificationPayload\": \"string\",\n      \"verificationPayloadHash\": \"string\",\n      \"verificationSignedBy\": \"string\",\n      \"verificationSignedAs\": \"data_source\",\n      \"verificationJwsHeader\": \"string\",\n      \"timestamp\": \"string\",\n      \"signedWithoutObjectReference\": true,\n      \"objectType\": \"data_disclosure_agreement_record\",\n      \"objectReference\": \"string\"\n    },\n    \"optIn\": true,\n    \"timestamp\": \"string\",\n    \"organisationId\": \"string\",\n    \"organisationRole\": \"data_source\",\n    \"isDeleted\": true\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Data Disclosure Agreement Template Revision
Source: https://docs.igrant.io/docs/datamarketplace-api/read-data-disclosure-agreement-template-revision

---
id: read-data-disclosure-agreement-template-revision
title: "Read Data Disclosure Agreement Template Revision"
description: "Reads a Data Disclosure Agreement Template Revision."
sidebar_label: "Read Data Disclosure Agreement Template Revision"
hide_title: true
hide_table_of_contents: true
api: eJzlWl9z2zYS/yp7fLHdkWT5b1JNp3OOnTZqM7HHsq8zF3smELEiUZMAA4CSVY/e7pPcR7tPcrMASVEUHclN+tQnyxKwu9i/v13gKeBoQi0yK5QMBsE1Mm6AwQWzDC6ECRNlco1wFmnEFKWFG0yzhFmEa5wKI5TsBZ0gY5qlaFGbYPDxKZAsxWAQcGbZkkZFoqQw5EEnEMQ1YzYOOg1RbqX4nCMML0BNWiQqqQSdQOPnXGjkwcDqHDuBCWNMWTB4Cuw8I0GM1UJGwWLR2Va28nDfRsZKVy8S9p4Wm0xJg4Z+P+z36c+qBC8wFJBxg04QKmlRWqLFsiwRISNa+78bIvhUEyjTKkNthWe/QWO1E6jx7xjaNWWdgS1FUrlNhEQDTAKrJB6jnSHKUpEjlesQgUkO/otbI2QEI9RTESLYmFkImYQxghGRRA7jOYyVjXt3q4r+6I/8SCIJ0oCTsxMkTEY5i+jjFHVhH1v3zvKff1U/kxbOlbRaJQnqoBNU4l+hFooXS0YxIyteI1kzJAUYCpNcZ8rg8tNFTUEkz2ySJ2+YEaYgc2atFuPconF243g5OVeS5167tKDkPuTNb1ZcuPWXd8yQS2caDUrrvOACJ0IKW25joRVTDO47DV8o9bm0OdOazUm/FlPT4s1rzkDrKWpur4eG/v4yuvzQfX8BBWlDWwRfp/RMCG4RB4KjtGIiUBNtT/UF8uMjS7MEyZ0u2kOB9LQq3E38JcmIBUy0SstDE5vKKTeefDi6hNOj77sHUO4BchHYxV7Ugx2UO6A07Jjpzh4RLl18I10SulhMhrGxMFuo1+l0GTt/id1gl6MWU+ReazuC+6M1w/QvOmKTfUHBy9BIDJuzoQSlIyaFcYFHLmCssLlFDoxKcIIRS5I5cApJ5EBKsHMQEpicw++5Fob71NJIdtzlOFfnOoGj4mI514mrZTw3Vs9HGFql1yM7y8eJCH/F+WYlOoWF1ZHBb4UHnJM+fJ1dp5Gyx/coIxsHg5P+JpKOyGJ5ihfL5DY2Ip8U0UJoonTKbDAIci020r29fu8S1Ko2v/a4JTkwnt5isVgvMEsmQlqMXBFqkp0bmCgNs1iEca3ACgNTlghe+mtbldrouPXVoCTEagY2RiCCxMHETCPvweWb0T/g0tEAE6s84VSpd57hu7NWszOViHB+67y24e1E4xoJxAglq7oboYo0y2IR1ggHncBYpVmE75UHOi0+X3F6qVv8FqNGsAomQnKnBU+LFLwi80bH/aW2GmaebKlU49UFuq55gm7z0pBNZbT5SCqkSPM0GBw0eb9TM0gpqXBynIptga0eMHOFqV29Gw/22+pZSsDmnASsIspNA72UJjmdVeQ2LmBKlLWRzJVf6CvAF0pRsGgFbJuT0fK/rXjU8V8LcZRkPQ9mNQtb4MZ7RwDGRMElgI0sGyBzMx56Jik4Jqwi5JIaExJMhqGYFC2Gw3n4yEKbzGFG8F3QyiTB0CKnPvKxK5XtCtklucaMjDhhicHVzFCUtroEazHdDh2rYA5qeC44PTl+dXB4eIivw1fh0Xh8FB6Gr0/6BxtOCcOLLxW6dl4f1mX3X5YeUpHvOAsKaSyTIcKdY3QXEKa7C1iEd8Eaqt5WiJ/yJHG1tWQqJBdTwXOWbOPElYgueFEaYcVU2DpkGCuVIJPPSVAYdZXTaEmJOPEVZROrkFmMlG6FJu0HvUJtlGw51XlBqp2RCVX2Aptq31c3TkM0oHRbZ8smI5etVru6zbD5+j3VGwf01YTizO1brLeDm/uHi9KgoZLSxaBPFusZoqWn/Abkl2OR5/i4DnUjJ1r1Il5FW9vmrmuFxsa4IY9SFnPY18TIKTyl8iXjub76T6nuqkYNluSIkcpQnmViVM+1m1P2Je26Gq6m6JU6VZ2w45sQwiBsykTCxgnC2dXQF5n12YzxhViXKm+RxQrrYqc2GWtOi76LUKIW4XdQEoJUcUwgZJnNNXqoYlALlgiDHIrBliszBGf8JGvHAMmWIGg168EN9XrC7ZVgco9PrYKDPQj1PLMlyHEzJUZ83ATqcA9YzoUVMurdyTt5ZgQvmneS4i4weRiiMUrfBVTT8lR2gC0lXyJgavQER0oKiQofXlL4XGPnT1XUEa9P19/5j2QMWoRa/MES8QfykWSZiZUtvvVfFqMfK1I0lqXZty+gp6ctBbQaRfrSWTvK1rxW8sQ6pCOFq9wkczKJI38XwDi3Hg5hGEsRsgQ0MkOApGYWliTIq10fXLGtoa4m3wLoryWuUGke3C9qpvk6HHL8/WHr+OLq1zJWVeHDBKhmzNQiIlisuMXWgjz1er1FK9c6L9Fk5aewvwkbq9xerh//z4CCoeSUmlywMwulUt1BE5xYGCdMPtBUpMXlqZGSZNkwTxiFLqxGQG9JL2VzygYGP+coCZ+OESbCuYSQPQ901kPqKzVahgNyjw12jR/+0Cx0z0+BqCXswRk1e+5rOGdSOR8Wf/iMPSJ/RVqdoYbh25uf4Pqnc3j96vVJD2BoSyxugCWJc5iJwISb0n28vwM+hphZMLnPYkPeaSir/n+pAJq0L9byytZaYQfjw/CIH+PJ5PRLn5+t+G023x29O+se+Llgld62Fumwf3jc7R90D05uDvqDo/6g3//3eiSUdEkG52Nlnicfi1mWoaQRyLA++aBx7evT/gHc3pyTuRFIPAdHchsrTYd4Mx9WSNyHzno0+F8pg3YaZ2qQuiTo8qL8c3xyfMAO8RRfnZx+3+/3D45P2Ljfb/HbCWqkrsQqd4XDUyEhNw4pMQsxMxBqZIRb3GxV18BXVSi9aI/dyUPX1fVVNLABIU1WCVMykgoSJaMCrtHA1thqQQc0CU0CC2ugEqIAahz9vy/z3+28NzxadyCWZqi7Go0wBFmAaSsmLLQeUWRFFQPtykkHQpWJcuzcCLZV+UclaNn+EHVRe73eV8oKuzMEruSOhQepZiB8kmmucnXKX9p5wLxXtENNnLgy2N5wA1lDnPeOWIyMuzvpp+DcY8PuTXHts3bt6q4/V5JT82507Q6rThM8Lw98j/sH1S3ZNhet9UOi1kqfK07HcZ8vVsccTQWtorbl7rYRYHW4435/0UK+behU6eMNo1KY5Raq235nszW13MplFgrqRvCqOf4bq+Yajb/UlooQaS7XFXTib/n/pgoaSotasoSy3BQ1ODYNHTnAEebaTZw+PgVnmXD3VR/v6cmEZZEp72hb23VDmkjRxjQnDyJ0iqDHHYNgf3q0Hyo5EdE+5Zour7Z3q0uU/aeNz1oW+2Ue2rh4OVBZ+P5sWr6haU7hUlXopLjKGwSxtZkZ7O9zTFWXZaInIs2k7QkaqjcJjCyLCgDcRsP4n5tk7peq9jDTOUqp8OWw2H9RvJQpMmE5GQ3OimzAbGuffzWkK0OgnEF3GN7RqU9HuqzKqxnlpxU6n4qEC2lu6OUIVZiJeEQOM2Fj+ORlhE+wK5X1dwVWM5E4HWQsxL0OuHvyVbIDKDb+MFe5JnV0H3D+46cePR4KhJyoMjiZn9ZhygQp0uRZprT951J51fnFz8uvVrVeN1hDLdUm2P3ff/67R/iGwWiGXJjYNwv4GMZMRn48MUW9nOGY4oVMptWUJg0OiOYGqV9LJl2jpqhRRLK4F7XzTrHfzXVCQhPSCpaYjmtAImFZAjPqj61jZlQiOGSK+4ZaJSoSaDqAko2dghlInEGCU0zIepREXKZhY5HQdJeIsNyq1DdloUqzRLgptzOeO57GyDVt1KXTnTdMcroNd0MYJ2fKpERNeCURIUp/4VO6XMbCGOGw11/T+Ww26zH3c0/paL/Ya/bfD8/ffhi97dKexXI+tbQDOSpXYZ6WU7jasyHfN/SOegcOjyljUyZr8tDLq5e8qWtGSa0e/NknekWo0jOT/SxhQtauwn36+xhMj/zzsImIisFGawoMOsFgm7d9enmaTetrg+X7ThArY0mepycahd3qZLGgrz/nqF2e7wRTpp23+lQpDH3m7SOEuu52r4tquQfbPy9s1VyZ+SSlPZenPK6m1w/bvHx0GfovlBvWW6lveICauRb3FdB2xvD7z0KaJtQor6PpehX++e1N4JvX1ary4KpK8YGot0rdLDBeBP8O5ZktP1A0/4rzH6vl/pdnN1RFza8mHVKP8X9eCR7D
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Data Disclosure Agreement Template Revision</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}/revision/{dataDisclosureAgreementTemplateRevisionId}"}></MethodEndpoint>



Reads a Data Disclosure Agreement Template Revision.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateId","in":"path","description":"Unique ID of a Data Disclosure Template","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateRevisionId","in":"path","description":"Unique ID of a Data Disclosure Template Revision","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Template Revision Read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplate</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A template outlines an agreement between a Data Source and  Data Using Service that can be signed by both.


</div><SchemaItem collapsible={false} name={"context"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of URIs of JSON-LD contexts"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["DataDisclosureAgreement"],"description":"The Data Disclosure Agreement type from context"}}></SchemaItem><SchemaItem collapsible={false} name={"language"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO 639-1 language code (e.g. 'en' or 'sv')"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template"}}></SchemaItem><SchemaItem collapsible={false} name={"templateId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier (derived from 'id')"}}></SchemaItem><SchemaItem collapsible={false} name={"templateVersion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template (derived from 'version')"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataController</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An organisation constituted as a legally defined entity in any jurisdiction

</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller public key"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller name"}}></SchemaItem><SchemaItem collapsible={false} name={"legalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller legal identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Data controller URL"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller industry sector"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"agreementPeriod"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Days for which agreement is valid"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSharingRestrictions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'


</div><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Where to find the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Jurisdiction where the data sharing restrictions apply"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"How many days the data can be kept"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data can be shared to"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data is stored"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Purpose of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`contract`]"} schema={{"type":"string","enum":["contract"],"description":"Lawful basis for the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"codeOfConduct"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to code of conduct"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hash of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Data Disclosure Agreement is published or not"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Presentation Definition"}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"OpenAPI specification of the Data Agreement, defining available APIs for Data Using Services"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementTemplate\": {\n    \"context\": [\n      \"string\"\n    ],\n    \"id\": \"string\",\n    \"type\": [\n      \"DataDisclosureAgreement\"\n    ],\n    \"language\": \"string\",\n    \"version\": \"string\",\n    \"templateId\": \"string\",\n    \"templateVersion\": \"string\",\n    \"dataController\": {\n      \"publicKey\": \"string\",\n      \"name\": \"string\",\n      \"legalId\": \"string\",\n      \"url\": \"string\",\n      \"industrySector\": \"string\"\n    },\n    \"agreementPeriod\": 0,\n    \"dataSharingRestrictions\": {\n      \"policyUrl\": \"string\",\n      \"jurisdiction\": \"string\",\n      \"dataRetentionPeriod\": 0,\n      \"geographicRestriction\": \"string\",\n      \"storageLocation\": \"string\"\n    },\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"contract\",\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\"\n      }\n    ],\n    \"codeOfConduct\": \"string\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"string\",\n    \"active\": true,\n    \"presentationDefinitionId\": \"string\",\n    \"openApiSpecification\": {}\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Data Disclosure Agreement Template
Source: https://docs.igrant.io/docs/datamarketplace-api/read-data-disclosure-agreement-template

---
id: read-data-disclosure-agreement-template
title: "Read Data Disclosure Agreement Template"
description: "Reads a Data Disclosure Agreement Template."
sidebar_label: "Read Data Disclosure Agreement Template"
hide_title: true
hide_table_of_contents: true
api: eJzlWl9v4zYS/ypzfElS2I6df7s1iuKyybZ1G2yCOLkCtwmwtDSW2EiklqTsuIHf7pPcR7tPchhSkmVZWSfd9qlPcSRxZjh/fzPkEwvRBFpkVijJhuwaeWiAwzm3HM6FCRJlco1wGmnEFKWFG0yzhFvssQ7LuOYpWtSGDT8+MclTZEMWcstXS6uV5cJRyDpMELOM25h1GhLcSvE5Rxidg5q2CFJSYR2m8XMuNIZsaHWOHWaCGFPOhk/MLjISxFgtZMSWy3v62GRKGjT0/qDfpz/rjLdvGUg7rMMCJS1KSyR4liUi4ERi/zdDdJ5qcmRaZait8Fy36KUmuJr8hoHdUM0p2FISldtESDTAJfBK0AnaOaIs1TZWuQ4QuAzBP7g1QkYwRj0TAYKNuYWAS5ggGBFJDGGygImyce9Orun3o9/yI4kkSANOzg5LuIxyHtHPGWpDUnaYrdu5/Odf1WvSwpmSVqskQc06rBL/CrVQYfHJOOZkvGskIwakAEMOl+tMGVz9Oq8piOSZT/PkHTfCFGROrdVikls0zm4hXk7PlAxzr136oOQ+CptPrnEmSOjn3/zEDTlwptGgtM4LznEqpLDlMh5YMUN232n4QqnPlc251nxB+rWYmhYn3nAG+p5i5PZ6ZOjvz+PLD92LcyhIG1oiwk1KzwTcC9xfhCitmArURNtTfYX8+MjTLEFyp/P2UCA9rQt3E39JMmIBU63SctPEpnLKrTsfjS/h5PDb7gDKNUAuArvYi3qwg3IHlIYdM9vZI8Kli2+lS0IXH5NhbCzMC9TrdLqKnb/EbrAbohYzDL3WdkTot9YM079oi032BQUvQyMxbM+GEpSOuBTGBR65gLHC5hZD4FTDEox4kiwgpJDEEEgJdgFCApcL+C3XwoQ+tTSSXehynKtmHeaouFjOdeIqV5gbqxdjDKzSm5Gd5ZNEBL/gYrsSncKCasvgl8IDLkgfvppu0kj54wXKyMZseNzfRtIRWa528WqZ3MJG5JMiWghNlU65ZUOWa7GV7u31hUtQ69r82u2W5MB4esvlcrPArJgIaTFyRahJdmFgqjTMYxHEtQIrDMx4IsLSX9uq1FbHrX8NSkKs5mBjBCJIHEzMNYY9uHw3/gdcOhpgYpUnIVXqnWf47mzU7EwlIljcOq9teDvRuEYCMULJqu5GqCLNs1gENcKsw4xVmkd4oTzQafH5itNr3eLXGDWCVTAVMnRa8LRIwWsyb3Xcn2tfw9yTLZVqvLpA1zVP0G1RGrKpjDYfSYUUaZ6y4aDJ+yc1h5SSSkiOU7EtsNUDZq4wtat368Z+Xd9LCdick4BVRLlpoNfSJKezitzGBUyJsraSufIf+grwhVLElq2AbXsyWv33Ih51/NdCHCVZz4NZzYMWuHHhCMCEKLgEsJVlA2Rux0PPJAXHhFeEXFLjQoLJMBDTosVwOA8feWCTBcwJvgv6MkkwsBhSR/bYlcp2heySXBNORpzyxOB6ZihKW12CjZhuh45VMLManmMnx0dvBgcHB/g2eBMcTiaHwUHw9rg/2LJLGJ1/qdC18/qwKbt/WHpIRb7jLCiksVwGCHeO0R0jTHfHeIR3bANVv1SIH/IkcbW1ZCpkKGYizHnyEieuRHTBi9IIK2bC1iHDRKkEuXxOgsKo65zGK0rEKVxTNrEKuMVI6VZo0r7RK9RGyZZdnRWk2hmZQGWvsKn2fXVjN0QDSrd1tmwyctlqvavbDpuvL6jeOKCvphRnbt1ysx3c3j+clwYNlJQuBn2y2MwQLT3ln0AeSnLP8nEd6lZO9NWreBVtbZu7bhQaG+OWPEpZzGFfE2NI4SmVLxnP9dV/SHVXNWqwIkeMVIbyNBPjeq7dnrIvadXVaD1Fr9Wpaocd34QQBuEzLhI+SRBOr0a+yGzOZowvxLpUeYssVlgXO5VZNqdF30QoUYvgGygJQapCTCDgmc01eqhiUAueCIMhFIMtV2YIzvhJ1o4Bki1B0Gregxvq9YRbK8HkHp9aBYM9CPQisyXIcTMlTnzcBOpgD3geCitk1LuTd/LUiLBo3kmKO2byIEBjlL5jVNPyVHaAryRfIWBq9ESIlBQSFTy8pvC5xs7vqqgjXp+uv/M/yRj0EWrxO0/E7xiOJc9MrGzx1D8sRj9WpGgsT7M/v4CenLQU0NLaRemsbeXFvNbyxCakI4Wr3CQLMokjf8dgklsPhzCIpQh4Ahq5IUBSMwtPEgyrVR9csa2hribfAuhvJK5A6ZDdL2um+ToccvTtQev44uqXMlZV4cMEqObc1CKCLdfc4sWCPPV6vWUr1zov0WTlp7C/Chur3F5ubv+PgIKRDCk1uWDnFkqluo0mOLUwSbh8oKlIi8tTIyXJskGecApdWI+A3opeyheUDQx+zlESPp0gTIVzCSF7HuhshtRXarQMBww9Ntg1fvhDs9A9PwWilrAHp9TsucdwxqVyPix+9xl7TP6K9HWGGkbvb36A6x/O4O2bt8c9gJEtsbgBniTOYaYCk9CU7uP9HfAxwMyCyX0WG4WdhrLq/5cKoEn7ciOvvFgrfDA5CA7DIzyennzp97MVv83mu+OfTrsDPxes0tuLRTroHxx1+4Pu4Phm0B8e9of9/r83I6GkSzI4HyvzPPlYzLMMJY1ARvXJB41r3570B3B7c0bmRiDxHBzJbaw0beLdYlQhcR86m9Hg31IG7TT21CB1SdDlVfnn6PhowA/wBN8cn3zb7/cHR8d80u+3+O0UNVJXYpU7wglTISE3DilxCzE3EGjkhFvcbFXXwFdVKL1oj93pQ9fV9XU0sAUhTdcJUzKSChIlowKu0cDW2OqDDmgSmgQW1kAlRAHUQvT/vs5/X+a9weGmA/E0Q93VaIQhyAJcWzHlgfWIIiuqGGhXTjoQqEyUY+dGsK3LPy5By8s3URe11+t9paywO0cIldyx8CDVHIRPMs2vXJ3yh3YeMO8V7VATJ64NtrecQNYQ570jFiMP3enuEzvz2LB7Uxz7bJy2uuPPteTUPBvdOMOq0wTPywPfo/6gOiV7yUFrfZOotdJnKqTtuN/n62OOpoLWUdtqddsIsNrcUb+/bCHfNnSq9PGOUynMcgvVubmz2YZabuUqC7G6Ebxqjv7GqrlG4w+1pSJEmstNBR37w/2/qYJG0qKWPKEsN0MNjk1DRw5wBLl2E6ePT+w0E+686uM93ZSwPDLlGW1ru25IEynamObkLEKnCLrKMWT7s8P9QMmpiPYp13TDanm3OkTZf9p6QWTpW61ZebGkOVBLVbG94lRuyGJrMzPc3w8xVV2eiZ6INJe2J2g+3iQwtjwqsGwbDeNfN8ncr7TmEaOzeam71dzXPyiuuBRJrRxystMisLltbdmvRnT6BxT+dBzhfZZabqRzp7waN35ao/OpyJ2Q5oYugVCxmIpHDGEubAyfvIzwCXalsn7sbzUXidNBxgPc64A78l4nO4Ri4XcLlWtSR/cBF99/6rGlO7mbqjLOuB+8YcoFKdLkWaa0/edKedX+xY+rR+tarxusoZZqEez+7z//3SOowmE8x1CY2ON+fAxiLiM/aZihXo1jTHHZJdNqRkMDhylzg9R6JdOuUTPUKCJZHHHaRadY70Y0AQEDaQVPTMf1EpGwPIE5tbrWMTMqESFkKvS9sUpUJNB0ACWfOAVzkDiHBGeYkPUoH7ikwScioUEtEeG5VanvrwKVZolwA2tnPLc9jZHrv6jhpuNrmOZ0sO3mKU7OlEuJmqBHIgKU/uymdLmMBzHCQa+/ofP5fN7j7nVP6Wi/WGv2L0Zn7z+M33dpzXI1alrZgRw1VEGelgO12g0g3wL0DnsDB62UsSmXNXnoEtVLrkNsjOarjP7KW2pFYNL9kP0s4ULWzrB93vrIZof+XtdURMVEojV3sQ4bbr/edt9hsTKW6D490SzqVifLJT3+nKN2ibbDZlw7H/MJThj6Hbb38PWt714X5WoPXn5TrlUDZb6SlKxcdvHAlq4fvOQS3/K+AohuD37daUBdcI3iJgqsV48f398w33Stp9AHl0KLH0S9VdpmNvUi+PsTzyz5jlz3F1x8X33u3zy7oMrg/mvSHWHj/wPzv2MG
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Data Disclosure Agreement Template</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}"}></MethodEndpoint>



Reads a Data Disclosure Agreement Template.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateId","in":"path","description":"Unique ID of a Data Disclosure Template","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Template Read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplate</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A template outlines an agreement between a Data Source and  Data Using Service that can be signed by both.


</div><SchemaItem collapsible={false} name={"context"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of URIs of JSON-LD contexts"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["DataDisclosureAgreement"],"description":"The Data Disclosure Agreement type from context"}}></SchemaItem><SchemaItem collapsible={false} name={"language"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO 639-1 language code (e.g. 'en' or 'sv')"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template"}}></SchemaItem><SchemaItem collapsible={false} name={"templateId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier (derived from 'id')"}}></SchemaItem><SchemaItem collapsible={false} name={"templateVersion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template (derived from 'version')"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataController</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An organisation constituted as a legally defined entity in any jurisdiction

</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller public key"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller name"}}></SchemaItem><SchemaItem collapsible={false} name={"legalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller legal identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Data controller URL"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller industry sector"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"agreementPeriod"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Days for which agreement is valid"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSharingRestrictions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'


</div><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Where to find the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Jurisdiction where the data sharing restrictions apply"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"How many days the data can be kept"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data can be shared to"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data is stored"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Purpose of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`contract`]"} schema={{"type":"string","enum":["contract"],"description":"Lawful basis for the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"codeOfConduct"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to code of conduct"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hash of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Data Disclosure Agreement is published or not"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Presentation Definition"}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"OpenAPI specification of the Data Agreement, defining available APIs for Data Using Services"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementTemplate\": {\n    \"context\": [\n      \"string\"\n    ],\n    \"id\": \"string\",\n    \"type\": [\n      \"DataDisclosureAgreement\"\n    ],\n    \"language\": \"string\",\n    \"version\": \"string\",\n    \"templateId\": \"string\",\n    \"templateVersion\": \"string\",\n    \"dataController\": {\n      \"publicKey\": \"string\",\n      \"name\": \"string\",\n      \"legalId\": \"string\",\n      \"url\": \"string\",\n      \"industrySector\": \"string\"\n    },\n    \"agreementPeriod\": 0,\n    \"dataSharingRestrictions\": {\n      \"policyUrl\": \"string\",\n      \"jurisdiction\": \"string\",\n      \"dataRetentionPeriod\": 0,\n      \"geographicRestriction\": \"string\",\n      \"storageLocation\": \"string\"\n    },\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"contract\",\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\"\n      }\n    ],\n    \"codeOfConduct\": \"string\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"string\",\n    \"active\": true,\n    \"presentationDefinitionId\": \"string\",\n    \"openApiSpecification\": {}\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read OAuth2.0 Client
Source: https://docs.igrant.io/docs/datamarketplace-api/read-o-auth-2-0-client

---
id: read-o-auth-2-0-client
title: "Read OAuth2.0 Client"
description: "Reads a Data Marketplace related OAuth2 Client. Use an API key with the scope `data-space:read` (an older API key: `config`)."
sidebar_label: "Read OAuth2.0 Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV81u2zgQfpUBTwkgy26avQhFsWlaFEH3D016Kgx4Io0lNhTJkpQdr6HbPsk+2j7JYijZlux0kZ720EuikJyPM98Mv5lsRUE+d9IGabTIxEfCwgPCWwwIv6J7oGAV5gSOFAYq4PerJlQXcK0k6ZDCJ0+AGq7+uIEH2sBahgpCReBzYwkWBQaceIs5ZY6wWMAZajCqILczyWCRG72U5eI8FYmw6LCmQM6L7PNWaKxJZCKPt90UIhGSvbQYKpEIR18b6agQWXANJcLnFdUosq0IG8t2PjipS9G2cz7srdGePO9fzGb8axz782IGDkQkIjc6kA4Mg9YqmSPDTL94xtoOfLHOWHJBdjcbZKwOauCpuf9CeWACRqf3gZ84e/MWzDJSPfJOJMexJz3ILeWOwilQt/6dYL/FvBxD8ep3Ar0dApwk5PDXs2FLhzrcbWzH3xjvPe9B3ARUyqypgKVxzwMOsiYfsLanuHe7rSe9hNwRdjE4UOgD1KaQy75gDldJHUTbDqv687DwR1kc5WEU9NDROcMdF5ijr7Lp4UfFOG/5eEVYxNe3FdddhU/uIsL29HnFWk8EPWJtFS+cPIQ2OaJqiAndXSLeezl7EQv+ua9qyBI5Z9y1KZiK+D2sqvkpBeM3drA+RCZ1oJLcMLjL2ax9Av5EbIZ8vMECpLZNgL2ucbTtCS2fNGfCOPknca4PSeioufyBqflI3jQuJ9AmwNI0+pSgnzo1/0EJutGBnEYFntyKHMRrjjhqE+Epb5wMm9hXr6z8QPw559YYsOR2K96gJ7iO3bhxkTzPFNQUKlOITJRReWLzzcR09XLade7poctPO0WZdOo03e70qxXsALvX9fVjna9N771IROOUyEQVgvXZdFpQbSZoZSqjyKXSiDY56WEBS6nLb2H4bvsYZn4g5ZZro0vpjpp9brBb6EePXrOS3Why1b/bnZiPHdvNRcwK6dCXZAp3FcEKVbNvl4sRzqKXRqgbH+CewDpaykcqugFr0fkICzjTJlAECA6lihxwHs4ToLRMj2Az6A1fbUzjmI7JA21eL9LYd6Remt0zwjw+I6pRMpG+sda48POBvH388v1hacz6MGFHtOyN4Oyfv/4+B8kj5+2aCukr4GoCeswr1CUPlwWsyO37ZcyxzJkSs5IFuRRuAjSePHhSy4k3K3IkSw2yYMbDJunt8V4R9+K4jMongFDIUgZUsEalKMTLvFGyAGsKCJRX2ihTSvIJkMb7SDCCpjUoWpHi7PFzj5qA91LJsIkg2ARTY+Djuamtkqhz6pIXw3NUNqp7YSA1ICwbpbhMChminzVqTY4nYiVz0j4KzK7kLOYVwUU6O+F8vV6nGLdT48ppb+unv9xcv/vt9t2EbeIsE9QoeXEaL0ze1KTDrpT5tXb5uphdXKYv0xdsa40PNeqBP/w/Qz/ypLPDBFWMlW6vzv/7/xj9uw70GKZWoYxjSuRx24vbZ7F62Y34S8mqfLhCJGIkcSIR2X5ImyeiMj6w/XZ7j54+OdW2vPy1IRflNhErdLEUOx2Unr8LkS1RefoP0s4+9k3rHL4Vwk6vNItVVBeRCZGIB5azwyjZzvdjXvSh277Kc7JhYHg6yw1bwft3dyIRzMRYKR+iUvYfjP6kU8ei2bnAP1nbnzR5xbn8QJvX++PdzjcN9kLdnWaKeML9F5AxK/0=
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read OAuth2.0 Client</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-space/oauth2-client/{clientId}"}></MethodEndpoint>



Reads a Data Marketplace related OAuth2 Client. Use an API key with the scope `data-space:read` (an older API key: `config`).

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace related OAuth2 Client read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>oauth2Client</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Secret of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"grantTypes"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Grant Types allowed for the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"int"} qualifierMessage={undefined} schema={{"description":"Timestamp of the OAuth2 Client creation or last modification","type":"int"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"oauth2Client\": {\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\",\n    \"clientName\": \"string\",\n    \"clientDescription\": \"string\",\n    \"grantTypes\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Pull Data Record
Source: https://docs.igrant.io/docs/datamarketplace-api/read-pull-data-record

---
id: read-pull-data-record
title: "Read Pull Data Record"
description: "Reads a specific Pull Data Record."
sidebar_label: "Read Pull Data Record"
hide_title: true
hide_table_of_contents: true
api: eJzlV81u2zgQfpUBTy0g/zTNXoyi2GxTFEYXiyJOT4WBTMixxIYiVZKy4zV865Pso+2TLIaSbdlyixTbW3NwJIrzceYbzsfhRigK0usqamfFRNwQqgAIoSKpF1rCh9oYuMaIcEPSeTUUmajQY0mRfBCTT5sThOk1uAXEgnqmcE9xRWQBm9GZq70kQKua949B2xxm5JdaksiEZrgKYyEyYbEkfquN4bkN4FSJTHj6UmtPSkyirykTQRZUophsRFxXbBOi1zYX2+2cJ4fK2UCBv1+Mx/zv2P2e056Ql5HORrKRDbCqjJbIBqPPga02nVUr7yryUTdrHDvc8crdfyYZRdbjPy3qFoAd/jhGCjz7GF2rfgA/j/8T/jKhMOK1DtK4UHu6yj1RSTbeUlkZjHRDSx20s9PvepWWOqDAHgZ2OLADglhgBEULbSkArw4rDMCckgLMUdtEylMdbWj4v262ZJ53kk1xP3VH+B7whym3zkrq+3mDVrnSrCEnSx4jKWhmnoGQnnjCVezD3OqSQsSy+uaWScY8eQ+sbWTU6B7InkEsCK6kpBDglmdAHUjBwvmUNQ6Wc9N3c9st5E+8sX9kuz094ztGu7Tsgplv+S8TBaFK2rYRb5qqH9wmbzd9cUn1nwl6xLIyPNATh+1piXcxoVlLpHUvxy8Y+clK0yWMvHf+jVMcWXq+7qw5z3qqc6wjB+tDZNpGysl3g7scj7dn4HtS2+XjD1SgbVVH2J8aouX5mJaPFutYOK//Jk7TIQkNNZe/MDU3FBrdsC7CwtW2T9BvzVn2ixI0tZG8RQOB/JI8pGVOONpmIpCsvY7r1LVcVfo98eOcG4OIOTczYqZzS+qg9oEJKCkWTomJyCnFzy3JRIyWL0fS2YXOR6w+g1ChpBHL3CC9+6Q9o81pz7IV7An7ea59uqbStWGITNTeiIkoYqzCZDRSVLoBVnqoc482DrUT2+wUYBYxZ539BkZoPp/CzA/szHiTNLndcbRPEjYDbW/Wite+O7tqC3h3Yhw7dvVhCg+0Bi5zsrHdm0PgI2OJpqbdIXR3hHPXaiSUdeATFSpPC/1IClY6FnDX+Ah38My6SAkgetTprEkpeZ4BDfPhCewEWsNXa1d7pmPwQOvXd8N0Fmm7cLt6QpnqiUrUTGSoq8r5+PuBvH38+t1h6Jj1bsJOaNkbwbN/v/7zHDS337MVKR2KpuehR1mgzZu2YUme+/IUQ8qxlkyJW2pFfgjTyCdugEBmMQhuSZ50bkErZjyus9Ye7w3x2Z6G0YQMEJTOdUQDKzSGYlosOKMVVE5BJFlYZ1yuKWRAFu8TwQiWVmBoSYazx3WfxAHvtdFxnUCwjq7EyNOlKyuj0Upqkqea5javTYongObmdFEbw9tE6Zj8LNFa8nzxMFqSDUlpdluuQlkQXAzHPc5Xq9UQ0+eh8/motQ2jP6dv3v41eztgG25kdDRHyQPeqMrJmut/t5W5Wpt8XYwvLocvhy/YtnIhlmg7/vD9qddFnZZCR6efduFqqy/SYxxVBnXqKlK0m1aNPonly+aWstB52w81isSCdaJJIhOT3k1qnonChchQm809BvrozXbLw19q8kkoM7FEn/ZOI1w68LMSkwWaQN8J8tlNe9w8h59+PTkmZadTlkUqqYqYCJGJB5ax/vVxO9/3eymkZho3sFXsAPSbuu6p8O7trcgEy9qxUj4kpWwfGP2sc6ei2bjAv6ztZ01e8Q59T+vX++nNl28a7IW6mc1UcbP7H+zFkuw=
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Pull Data Record</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-space/pull-data-record/{pullDataRecordId}"}></MethodEndpoint>



Reads a specific Pull Data Record.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"ID of the Pull Data Record between a Data Source and Data Using Service","in":"path","name":"pullDataRecordId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Pull Data Record read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pullDataRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Record of a Pull Data request

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the Pull Data Record between a Data Source and Data Using Service","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementTemplateRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the Data Disclosure Agreement Template Revision that defines data was pulled against","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the Data Disclosure Agreement Record Revision that defines the agreement between the Data Source and Data Using Service","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Randomly generated nonce","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"int"} qualifierMessage={undefined} schema={{"description":"Timestamp of the Pull Data Record creation","type":"int"}}></SchemaItem><SchemaItem collapsible={false} name={"token"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The Access Token used for pulling data","type":"string"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pullDataRecord\": {\n    \"id\": \"string\",\n    \"dataDisclosureAgreementTemplateRevisionId\": \"string\",\n    \"dataDisclosureAgreementRecordRevisionId\": \"string\",\n    \"nonce\": \"string\",\n    \"token\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Validate Access Record
Source: https://docs.igrant.io/docs/datamarketplace-api/read-validate-access-record

---
id: read-validate-access-record
title: "Read Validate Access Record"
description: "Reads a specific Validate Access Record."
sidebar_label: "Read Validate Access Record"
hide_title: true
hide_table_of_contents: true
api: eJzlWM1u4zYQfpUBTwmg2Olu2oNRFE2TtHV/F0m2PWQDhBFHEhuK1JKUHdfwrU/SR+uTFENKsuSfdbZFT70kssSZ+Ti/H7lkAl1qZeWl0WzCrpELBxxchanMZAq/cCUF9wjnaYrOwTWmxooRS1jFLS/Ro3Vscrfc0DO9BJOBL3CPApYwSesq7guWMM1LZBM2a9bGpXHllNZafF9Li4JNvK0xYS4tsORssmR+UZGk81bqnK1W97TYVUY7dPT91ekp/Rui240JLHIylhrtUXsS41WlZMpJbPybI9llz3ZlTYXWy2hpF/geQvP4G6aeJVsOD6ZNBlwDj3C8eUINjT5pNHAtgNe+MFa65o33WFakbghCim2nbJp8q+X7GkEK1F5mEi1kxoZY9UzaiH8VfY/Oo7jknl9KlyrjaovnuUUsUfsuTAcNr5OCVMFaF3TK2lCkRmtMPQrwJkj0XbOF6kJx5yhdebR0CEgwnw6EoFMIRzjKRwm8Y5WU7xg9cG30ojS1e8eOQeptQAlDXZdsckcyLFkLsPs+1qtnj1ZzNRW3Ad8hnLSKXIaNHEwv+ziNVosQuzfT6cZ2jtluu4dtXvVszbiq8WMsdmHrAjoV7nARfGuUcMGrXd+xOJOO4jK97NLTviA3EuAO5qgU/aeP69X7k+4Wy0pRP7juWaWiIwW1FmjVQuo8aujnard69E5v1aL4UL20sh9XN517DhZQh43EYkOZcwcWFXKHgnxKAduDsXXIf4Zy2+O+4L4fZULrZK6HWHte/CfIXhDLgENgJjXGBCKzlGmPCK7gFgU8op8j6nUnuzG1TTFkTPj91pGFG7QzmSJbrda1eLgWbgsEY2UuqQYHDTkq2MyymPy3oQ0dbigFwne/3rZzL0jFHZO72wkW2n7hffUj+sK8wMGk9tvb2zdQBoG1xq51kMYw61+k6/zNFGj1TkWrPh24G+x/gLoxGBtwZARk3Wj8OQuM5cNxuKmD4qxWe8dyp3aIaIaWxiohENvDiYiPkDMpaq5csJoageJCcVmGcXEI2NdcKhT/ApRFTlTmnrjStu93qIIjF50BxkLGpaothnbvZYnO87LqhVVqjzlalrDM2JL7+Oqzs1005Bk6DTAvmorqATBpWlu7I+iyJYUvIiYfZgv7pta6ZnsJ1N/z/WoVSrtALgILXrKLSB1P2vG+xVMDiUwYPvOyUvRii2GuNv3U1wnRVmwpZ6efkOYX09W+A9FaYy+MoB2F58uezftkKwWHPWctvSvu3ebOTk9XO9TvaAFrf3zFBUhd1R668wVr/LyZPg0j/j0k9ToI0TVn/2PXXKOLA0kbD5mp9baDPo3Hov+pg6a64bgO7QwtBDMbPlolzGFaW+kXYVqcV/J7pMfQNz3P6djLmkH6g8kdbb1sBibL0bcDaMLGs9fj1OhM5mMaCCeu4imO22l7Ejv5SeQ94+XuQ/CKER5Cu+u4fYmlaTbDElZbxSZhFLrJeCywNCe8kiOZW679SBpGQ2Zj2nmeE2fZo8PFz5tq7tc+uqFUiRFuPdWFiscXzZG/aWHdof+8KeO2Gw+BERV4wkU4/tJ5NWboCJpRVWNL7R4Geh6aTgll7TxRt8piJp9RwFz6Ah4iRniAI208RpJsuVTBBxSe4wToGLihdgKN4OcLU1tyx8kTLr54GIUJJXVm2qriaagqLLkkR7q6qoz1X66d1+1ffrN+NfR6P2AbbumE4OivP/48BkmXNjdzFNIVkbHic1pwnUdWGqd/c9J1kZdCZc1MCrQjmHqoHTpwqLITZ2ZoUea6uSHwi6SR548KIbUYXnPlEuAgZC49VzDnSqEPxpxRUkBFPBDTQhtlcokuAdT8MTiYg8Y5KJyhouhR9YcWwR+lkn7RXneYkntanpqyUpLrFGPwwvYs5rUK+3F0IueQ1UpRmgjpA86Sa42WLqqUTLEhf23KVTwtEF6NTrd8Pp/PRzx8HhmbjxtZN/5henH1083VCckE5uPVIHiBswqT1kQf2lSmao3xenX66mz0evRJ4MHG+ZLrHh66ddt/USaG/a/r2R9zWddUosdnP64Ul4FnhJ0vmy51x2avIxfKZN5Q19ipaCM7exVL2GTPld19wgpDx507tlw+codvrVqt6PX7Gm1oo6TVhpyKDU06ehZsknHl8APbPrpuhtExvOCacefO28akF3FzNf1iCXuivrXvGnJ135G9gDgupkXhIq5Vs83o+oPhm6tbuh+qB0chXsmn0CCbh97pZAhxs1dGCPS3d24YinxOifk9Lr7ob6/G/QJdf46ryWHEdP8GTQXOaQ==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Validate Access Record</h1>

<MethodEndpoint method={"get"} path={"/v3/config/data-space/validate-access-record/{validateAccessRecordId}"}></MethodEndpoint>



Reads a specific Validate Access Record.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"ID of the Validate Access Record","in":"path","name":"validateAccessRecordId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Validate Access Record read

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>validateAccessRecord</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Record of an access token validation and authorisation attempt

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the validation record"}}></SchemaItem><SchemaItem collapsible={false} name={"requestedDataDisclosureAgreementRecordId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the Data Disclosure Agreement Record connected to the access token"}}></SchemaItem><SchemaItem collapsible={false} name={"requestedDataClassification"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`pii`, `anonymous`]"} schema={{"type":"string","description":"Data classification requested (e.g., \"pii\", \"anonymous\") in the access token","enum":["pii","anonymous"]}}></SchemaItem><SchemaItem collapsible={false} name={"requestedExternalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of external ID requested (only for PII classification)"}}></SchemaItem><SchemaItem collapsible={false} name={"requestedExternalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External ID value requested (only for PII classification)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>connectedAgreementIds</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Holds the specific revision ID for the record connected to the access token, as well as the connected Data Disclosure Agreement Template Revision ID and the underlying Data Agreement Revision ID.


</div><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the specific Data Disclosure Agreement Record Revision the token was released for"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementTemplateRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the specific Data Disclosure Agreement Template Revision that the record was signed for"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the underlying Data Agreement Revision that defines the data to be shared between the Data Source and Data Using Service"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>request</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The original validation request

</div><SchemaItem collapsible={false} name={"accessToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JWT Access Token that was validated"}}></SchemaItem><SchemaItem collapsible={false} name={"httpMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTP method that was requested"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The API path that was requested"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>response</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The validation response (success or failure)

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={"**Possible values:** [`true`]"} schema={{"type":"boolean","description":"Whether the access token was verified and authorized","enum":[true],"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"dataClassification"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`pii`, `anonymous`]"} schema={{"type":"string","description":"Data classification of the validated access","enum":["pii","anonymous"]}}></SchemaItem><SchemaItem collapsible={false} name={"individuals"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of individuals associated with this access","items":{"allOf":[{"type":"object","title":"Individual","description":"Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.","x-not-in-database":false,"properties":{"id":{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."},"externalId":{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"},"externalIdType":{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."},"identityProviderId":{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}},{"type":"object","title":"IndividualExtras","required":["name","email","phone"],"properties":{"name":{"type":"string","description":"Name of the individual"},"iamId":{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"},"email":{"type":"string","description":"Email ID"},"phone":{"type":"string","description":"Phone"},"pushNotificationToken":{"type":"string","description":"Device token of the individual"},"deviceType":{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]},"mapperId":{"type":"string","description":"Defines the mapper id of the individual"}}}]}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedClaims</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The decoded JWT claims. The fields listed below will be present; additional claims are allowed.

</div><SchemaItem collapsible={false} name={"aud"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The audience of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"dataClassification"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`anonymous`, `pii`]"} schema={{"type":"string","enum":["anonymous","pii"],"description":"The data classification of the requested resource"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the Data Disclosure Agreement Record associated with this token"}}></SchemaItem><SchemaItem collapsible={false} name={"exp"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The expiration time of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"iat"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The issued at time of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"iss"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The issuer of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique identifier for the JWT"}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The decoded JWT claims. The fields listed below will be present; additional claims are allowed.","properties":{"aud":{"type":"string","description":"The audience of the JWT"},"dataClassification":{"type":"string","enum":["anonymous","pii"],"description":"The data classification of the requested resource"},"dataDisclosureAgreementRecordId":{"type":"string","description":"The ID of the Data Disclosure Agreement Record associated with this token"},"exp":{"type":"integer","description":"The expiration time of the JWT"},"iat":{"type":"integer","description":"The issued at time of the JWT"},"iss":{"type":"string","description":"The issuer of the JWT"},"jti":{"type":"string","description":"The unique identifier for the JWT"}},"required":["aud","dataClassification","dataDisclosureAgreementRecordId","exp","iat","iss","jti"],"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={"**Possible values:** [`false`]"} schema={{"type":"boolean","description":"Whether the access token was verified and authorized","enum":[false],"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason why validation failed"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Unix timestamp when the validation occurred"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"validateAccessRecord\": {\n    \"id\": \"string\",\n    \"requestedDataDisclosureAgreementRecordId\": \"string\",\n    \"requestedDataClassification\": \"pii\",\n    \"requestedExternalIdType\": \"string\",\n    \"requestedExternalId\": \"string\",\n    \"connectedAgreementIds\": {\n      \"dataDisclosureAgreementRecordRevisionId\": \"string\",\n      \"dataDisclosureAgreementTemplateRevisionId\": \"string\",\n      \"dataAgreementRevisionId\": \"string\"\n    },\n    \"request\": {\n      \"accessToken\": \"string\",\n      \"httpMethod\": \"string\",\n      \"path\": \"string\"\n    },\n    \"response\": {},\n    \"timestamp\": 0\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update Base Configurations
Source: https://docs.igrant.io/docs/datamarketplace-api/update-base-configurations

---
id: update-base-configurations
title: "Update Base Configurations"
description: "Updates Base Configurations related to a Data Marketplace."
sidebar_label: "Update Base Configurations"
hide_title: true
hide_table_of_contents: true
api: eJztV81u20YQfpXBXpoAFKU46UUIgjp2UAhJiyCOT4kBj8kRufFyl9kdSlYE3fokfbQ+STFLSqIouWjTY3sx1rs7PzvfNx9Ha5VTyLyuWTurpuq6zpEpwGsMBBfOznXReJTDAJ4MMuXADhAukRF+QX9PXBvMKFWJ8vS1ocCvXb5S07XKnGWyLEusa6Oz6Gf8JUiktQpZSRXKqvauJs+agvx3h4GuvZHlILcP78DNgUs6iv5DgIoYc2RUieJVTWqqAnttC7VJVGY0WZ7lxz4v4gnMLh/z/Li7K8o88aMu2+O/73bT1k97ytX0064KveQHgW92LtzdF8pYbTatk1A7G9pank0mxwkOczkJdhOJEIN+P4yHPo/v6BOIzC5Plfx/UggptODxXcw4JtcAm5tInpIwJx+xuWhhH32Mnvo4d74jARJFD1jVRjaO2LFJhlXo+YQ2lopxX0ye/SPF6D+GvHf+wuVSvri+7MU8KkUyoODeev8ybZkK8v3HvZhMNifc7206xPr1eI05aFs3DDV6rIjb126OynJtseHSef0tNtweBLn6Y9vC/9HSzCyTt2ggkF+QhxhmUKNNogJljde8UtNPa3Ve67cky5uNvBGLILU4IXJSgoq4dLmaqrqJFUAu1VSNF8/HWbw7FvkYhRozGkvbjLJDFxJbMgsx9EBoqXJd4ipRjciXKpnrMB2Pc6rcCGud6sKj5VQ7tUmGDq4YC22Lx3yE9njo5mZfjyuhRYvmtio7WLDdSJSWUF03JspiJafnHSPjM9UQlvP3M7inFQhvyXLHxhQ+lgQLNA1tJe72wM9t1/RQNYHhjqD2NNcPlMNScwm3bY5wC0+sY4oO2KM2sQYCwdMEKC3SgdspdIYvV67xUo7RPa1e3aZR+KRFPuwnkzdbEvYmjT1F9x+F4d5W2XuSr+3cbXsTs9ibVKGODpu6dp5/2sOyq6z+eb91iGefCoOC74zgyR+//f4UdACEqyXlOpQgFAV6yEq0BQHaHBbk9bxDJbJHZ1Jst9A5+RRmDE2gAIHMfBTcgjzpwoLOBUteJZ093hmCzFPcRhMSQMh1oRkNLNEY4hgsOKNzqF0OTFlpnXGFppAAWbyL0CFYWoKhBRnhhWhIFBq800bzKjrBhl2FLNczV9VGo82opUV8nqeiMd1soi0gzBtjhIC55phnhdaSlzHU6IxsiAhvyVxjVhKcpZOjmi+XyxTjcep8Me5sw/jd7OLNr1dvRmKzSRRrNgfggbRA7rKmIsvbJhEdaPE6m5y9SJ+nz8S2doErtL182in71Nw17LSe8P+72bxreqYHHtcGdfw6N+1E1YreJ7V43o57cy203wtfN3QMpe8mUaULLJbrdddLm41sf23IRwFO1AJ95FGU461uR628FzU6HDPkumkemSW2FudZRjX/5d2+rr+//ij5d79Jqvg5Ux6X8nsFl2qqPqvPSiXK1bshNe6vlUFbNFjsZp34pRHFOxTR+yii3UIetj2yq16SQz1t3yJ/5WUnTV4Kxd7S6tXuenvyqMFOw9vbgrGMdX8CF7HVvw==
sidebar_class_name: "put api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update Base Configurations</h1>

<MethodEndpoint method={"put"} path={"/v3/config/data-space/base-configurations"}></MethodEndpoint>



Updates Base Configurations related to a Data Marketplace.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"baseUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"URL of the Data Marketplace's metadata","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client ID of the Data Marketplace","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Secret of the Data Marketplace","type":"string"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace Base Configurations updated

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>baseConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"baseUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"URL of the Data Marketplace's metadata","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client ID of the Data Marketplace","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Secret of the Data Marketplace","type":"string"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"baseConfigurations\": {\n    \"id\": \"string\",\n    \"baseUrl\": \"string\",\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update Data Disclosure Agreement Template
Source: https://docs.igrant.io/docs/datamarketplace-api/update-data-disclosure-agreement-template

---
id: update-data-disclosure-agreement-template
title: "Update Data Disclosure Agreement Template"
description: "Updates a Data Disclosure Agreement Template. Partial updates are supported.  If publishing (set active=true), purpose,  purpose description, and lawful basis must either be provided or already be present from the draft version.  If changing the Data Agreement, all three fields must be provided (ID,  revision ID, and revision hash)."
sidebar_label: "Update Data Disclosure Agreement Template"
hide_title: true
hide_table_of_contents: true
api: eJztW9tyI7cR/ZUOXiSlhhR19VrluKKV7Jj2llclruKqrFS14EyThDUExgCGFK3iW74kn5YvSTUw9xmJVNZrP3ifpBkCjUajL6e7MY8sQhNqkVihJDtjN0nELRrgcMkth0thwliZVCOcTzXiHKWFdzhPYm6xD1dcW8FjSPNZGsGkSaK0xagPMJxAko5jYWZCTmHXoAUeWrHAv1md4l4ASaoTZTCA/D+osBMAlxHEfDlJYxhzIwzMU2MBhZ2hhjFCotVCRBiB0sBjjTxa+ddoiNGJVnOwM4RI84mFBWojlPR8hTMup8QV/e72WmwwAB7HYGcaESYC4yhbt7rg7vAyANC4EEQS6ImYLV7MuJnt9W8lC1jCNZ+jRW3Y2ftHJvkc2RmLuOWldIu1c9kOIxYwQSeScDtjQfOYpPglRRhegpp0nFVOhQVM4y+p0BixMxJ5wEw4wzlnZ4/MrhJixFgt5JSt13d+MBr7WkUrGhEqaVFa+pcnSSxCTsvv/2yIh8cKqUSrBLUVaOhpw9bckNpuvvVCXs5EOIOQS5K0V6kIhNxKF1mQ70eNf8bQ0rOwMb243MBO0GA/5nKa8im2ZdQ8heHoLZwefdk7gHwOhCpC2MX+tA87KHdIMXfMYmePBQwf+DxxHKFk68CJ6UJJq1Uco66sVuygvtq5BKWnXArjjgFCJY0VNiUpcbLYGKc8jlcQ4URIjAClFXblJChX8HOqhYlE6KhV9eI9iwRpm1PMgDkqTv1SHTsljFJj9WqEoVWa3TXF5Qw8/AFXm+XljjEstux9Qwj3uCJ5eMNo05jzhzcop3bGzk4Gm0g6IutyFy/myU0EEZHwJgI1ESNBdBCaKD3nlp2xVIuNdG+u3xCphjQ/drs5OTCe3nq9DhjPVfwKtVBVGQhpcYqaVhFSzNM5OztoL7EyMFE6M0dyjwVBEAYWPHbqUqjz0elJps2jGadNXCNtxima2azW1dFAnlMtvc+mrQoDZsY1BZO3r0d/gbeOBpiZSuOI3MTOE+vu3DaVPFGxCFc3TqcbtkA0rpFcnVAyE1rApqimmiczEVYIs4AZqzSf4hvl3WGHRRQrvVRpfpqhRrAKJkJGTgqeFmlOjeeNav19ZTQsPdlcqMaLC3RV8uTgV7lbagrjZRr0nVrCnFxORKpULJs59ntMLK3TLd6NG/upvpeMqFcSsIooNw/opTRJ6awitXHmlCGTDbZ6MGgZ63WmfSAmVdgTQCpjNKaAKTly6YYrrGThskp+g+f4hNx4RPaaAFkXGyhJK9479KB5aMlAPhUrFG7fTi6UjNLQvtjcbq7fkLG5mK0m5FcdmcwICqSwTRjxSIx4DJWUGFJQbqJKMQEhwziNMAo8oszgZBVHOhhJ6LHFxnU26LdhB3Jyz/HVmJJxVwO5T7L5Hf24kVEa9XuwOrx0duQVy7mFS0JJwn6EQK8q1KAkRwt5ra6QHSsVI5ctulc+PaKNkQmQx1m3oWwNrG2As3eehEaTKGl8RDocDNqoezOozkE4Cz5hKrAB9ILNmVGpjYWkLFNWEMkY7RKxSBJGKtUhurP3L24MhboR6oUIycdzW8QMMSWUPF7BWNlZvwUY3JYfiCWHdxyfQZkdBCz3QwGz1awtf/hn8XMD6bcR2tPwqQw/nVGg7owzS7RWi3Fq0bCmg2w7tqd9zHNm/YwlFbrfgkW5PMsz51rzFcnX4rwjlKxbykDjyQ5vroeG/n4/evtj780lZKSNQ9hbWHOWPm9hAfVEwFN9Af8FSH7/VBrajo7vZs9xRkv4gJjLcx18opR1Xar4RrrEdDbYO0phtsna1zXb+STnBrsRarHAyEttR0R+a00z/URbbC6fUfA8fC4BfC4B/GElgGfT/o6U/3OS/znJ/zMm+U3A7vsUWTbwZADYPm1v2GH5tNUaH52Mv6n2V8gBbFyyATI346EnnIJbhBeEnFPjQoJJMBSTLMVwOA8feGjjFSwJvgsaGccuB+uzgD30pLI9IXvE15jTIU54bLDuGbLQVuWgZdPd0LEw5loN//Tk+IuDw8NDfBV+ER6Nx0fhYfjqZHCwYZdZIvpUoOte68c27/5lriEF+cCdoJDGchki3LqFbhlhulvGp3jLWqh6Wya+TePYxdZ8USEjsRBRyuNtlLhg0RkvSiOsWAhbhQxljtzJQXao9ZVGJSVaKaoJ21WIuMWp0p3QpHujV6iNkh27ushIdS9kQpW84EypstVaYUQ0IFdbd5bNhZy32lj2+gPrXL9X3er3LDy9qKTz0wxdf/pZP0peLGuN+/a1VPZ3rVCpBOV5IkZVX7vZZb+lWVfDuouuxalKvdMlIYRB+IKLmI9jhPOroQ8y7dqMYVndKhN5By95R7c4lna16K9TlKhF+Ney9DdXEcYQ8sSmGj1UMagFj4XBCLLClgszBGd8JWvHAPEWI2i17MM7yvWEmyvBpB6fWgUHexDqVWJzkONqSpzWcRWowz3gaSSskNP+rbyV54YqlUU1+5aZNAzRGKVvGcW0dE53HkrOSwRMiZ6IkJxCrML7lwQ+l9j5XWVxxMvT5Xf+XzoMGoRa/Mpj8StGI8kTM1M2e+tfZqUfK+ZoLJ8nv30APT3tCKDX9RpuZStbr1XzE21IRwJXqYlXdCSO/C2DcWo9HMJwJkXIY9DIDQGSyrHwOMaomPWjC7YV1NVcNwP6LccVKh2xu3XlaD4Ohxx/edhZvrj6IbdVlekwAaolNxWLYOuaWmzNyGO/3193rlpdSzSX8lXYn4SdqdS+bW///wEFQxmRa3LGzi3kQnUbjXFiYRxzeU9VkQ6Vp0RK0smGaczJdKFuAf2S3pyvyBsYujUjCZ+O6cKQUwkh+x7otE3qIyWamwNGHhvsGl/8oVronq8CUUrYh3NK9txruOBSOR0Wv3qPPSJ9RRqdoIbhN+++hetvL+DVF69O6HqUzbG4ya5CFRehMvXx+g74EGJiwaTeiw2joCGs6nMuAKq0r1t+ZWup8IPxYXgUHePJ5PS5/5+M+F1nvjv67rx34OuChXvbmqXDweFxb3DQOzh5dzA4OxqcDQb/altCTpd4cDqW+3nSsRlPEpRUAhlWKx9Urn11OjiAm3cXdNwIxJ6DI6mdKU2beL0aFkjcm07bGvyv5EGDxp4apN4SdHmR/zk+OT7gh3iKX5ycfjkYDA6OT/h4MOjQ2wlqpKzEKtfCieZCQmocUuKWmokQanSXvlxtVVfAVxEoPWsPvcl9z8X1OhrYgJAmdcLkjKSCWMlpBteoYGtsMSAATUwTw8IaKJjIgFqE/vFl+rud9oZHbQXi8wR1T6MRxrr2uLZiwsPsnmOSRTHQLpwEEKpE5GXnhrHV+R/loGX7TVRZ7ff7H8kr7C4RIiV3LNxLtXTN0Bm2Rrk45Zt2HjDv/Qbt0grivHPEZsgjd1fzkV14bNh7l7V9WncnXfuz5pyavdFWD6tKE/xaHvgeDw5edOeyuknUWukLFdF23P+X9TJHU0B11FbO7ioBFps7HgzWHeS7ik6FPF5zCoVJaqG4BevOrCWWG1l6IVY9BC+a4z+xaK7R+Ka2VIRIU9kW0Inv7/9JBTSUFrXkMXm5BWpwyzRk5ABHmGpXcXr/yM4T4fpV7+/o3rPlU5P3aDvTdUOSmKOdUZ2cJakTBF3MPmP7i6P9UMmJmO6Tr+lFxfRe0UTZf9x43XvtU61Ffk28WVCbq2x7WVfujM2sTczZ/n6Ec9XjieiLqebS9gXVx5sERpZPMyzbRcP4n5tk7kqpecTozjyXXVn39S+yC+uZU8uLnOw8M2xuO1P2qyF1/4DMn9oRXmcp5UbqO6VFufFDjc6HzHdWbubjRDxgBEthZ/DB8wgfYFcq68v+VnMROxkkPKSPD1zLu072DLKJX61UqkkcvXtcff2hz0iDyJCuyyvy3+SqutU9l7JHT/e/u3q/lTZqaQ+ZEIvnoqtZvvJHWTw2+4tVpNdsCx6dnjzb1at0ucoF6k2qCtrqaioNnmwClRNbvZwKy0Vjphze1VapCKjaECn7Hq2iaZ3vWhH0iZ+qhcwNQzwkrLD8ZFmvHJMXGOke2Nr1iScq9+rcl3lxzoU7Cv+Nzd9LUy0URfyjfFW38ap7aBhhMQl2//vv/+wRMOYwWmJEV9NclokP7oMZX9daoC6Lfya7WpVdxNMug0kNUqIfT3pGLVCjmMqsoW5XQTbfFQRDgqGSPiIygctcp8LyGJZUWLFuMaNiEUGiIl+JUbGaCjQBoORjZ84cJC4hxgXG5Cso+rgQxcciprYAEeGpVXOfzYdqnsTCtUecq3Db0zh12T6Vd9wXJ5OUrlG46p3jc86lRE1ANxYhSt8pzB1cwsMZwmF/0JL5crnsc/dzX+npfjbX7L8ZXnzz4+ibHs1Zl4XN8hzILUYqTOe51lTum/mEs3/UP3AGooydc1nhx3/Dtd1HM41WUIEgPn8I9tt/CJZFS7q0tZ/EXMjKxRIPJt6zxZG/bDkRuW/pBBQsYGebvyC7C9hMGUt0Hx+pQHyj4/WaXv+SonboJ2ALrp0petQhDP0fdRfWqvqxm1/i3oPtP0brlEAOIiQhCBfyfbZ57wLh5l2u74qsze3Bz6vlbiXdjgQtn3EeUjHr2bFVEHh1844FbJx9Kjd3EJhpvqSMki/ZGbtlrhaskiKauvc1JODJrrMiTB1S3TtIlf1DG+sUVBNd+b34+1RPTPmKnMsPuPq6GO5/eXJCgej8aDo2ypX/B4CWbKA=
sidebar_class_name: "put api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update Data Disclosure Agreement Template</h1>

<MethodEndpoint method={"put"} path={"/v3/config/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}"}></MethodEndpoint>



Updates a Data Disclosure Agreement Template. Partial updates are supported.  If publishing (set active=true), purpose,  purpose description, and lawful basis must either be provided or already be present from the draft version.  If changing the Data Agreement, all three fields must be provided (ID,  revision ID, and revision hash).


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementTemplateId","in":"path","description":"Unique ID of a Data Disclosure Template","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplate</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Fields which can be updated in a Data Disclosure Agreement Template

</div><SchemaItem collapsible={false} name={"language"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO 639-1 language code (e.g. 'en' or 'sv')","example":"en"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataController</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An organisation constituted as a legally defined entity in any jurisdiction

</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller public key"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller name"}}></SchemaItem><SchemaItem collapsible={false} name={"legalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller legal identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Data controller URL"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller industry sector"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"agreementPeriod"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"Days for which the agreement is valid","example":365}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSharingRestrictions</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'


</div><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Where to find the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Jurisdiction where the data sharing restrictions apply"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"How many days the data can be kept"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data can be shared to"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data is stored"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Required if active=true, unless present already from the draft version"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 500 characters`"} schema={{"type":"string","maxLength":500,"description":"Required if active=true, unless present already from the draft version"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`contract`]"} schema={{"type":"string","enum":["contract"],"description":"Required if active=true, unless present already from the draft version"}}></SchemaItem><SchemaItem collapsible={false} name={"codeOfConduct"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL to code of conduct"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement, if included, must provide revision ID and hash"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement Revision, if included, must provide Data Agreement ID and revision hash"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hash of the connected Data Agreement Revision, if included, must provide Data Agreement ID and revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Presentation Definition"}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Publish if true"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Template updated

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplate</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A template outlines an agreement between a Data Source and  Data Using Service that can be signed by both.


</div><SchemaItem collapsible={false} name={"context"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of URIs of JSON-LD contexts"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["DataDisclosureAgreement"],"description":"The Data Disclosure Agreement type from context"}}></SchemaItem><SchemaItem collapsible={false} name={"language"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO 639-1 language code (e.g. 'en' or 'sv')"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template"}}></SchemaItem><SchemaItem collapsible={false} name={"templateId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Template identifier (derived from 'id')"}}></SchemaItem><SchemaItem collapsible={false} name={"templateVersion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of this Data Disclosure Agreement Template (derived from 'version')"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataController</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An organisation constituted as a legally defined entity in any jurisdiction

</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller public key"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller name"}}></SchemaItem><SchemaItem collapsible={false} name={"legalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data controller legal identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Data controller URL"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 50 characters`"} schema={{"type":"string","maxLength":50,"description":"Data controller industry sector"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"agreementPeriod"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Days for which agreement is valid"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSharingRestrictions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'


</div><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Where to find the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Jurisdiction where the data sharing restrictions apply"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriod"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1,"description":"How many days the data can be kept"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data can be shared to"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where the data is stored"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Purpose of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`contract`]"} schema={{"type":"string","enum":["contract"],"description":"Lawful basis for the Data Disclosure Agreement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"codeOfConduct"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to code of conduct"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementRevisionHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hash of the connected Data Agreement Revision"}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Data Disclosure Agreement is published or not"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the connected Presentation Definition"}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"OpenAPI specification of the Data Agreement, defining available APIs for Data Using Services"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A *generic* revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from the "successor" column, a revision should be considered locked.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementTemplate\": {\n    \"context\": [\n      \"string\"\n    ],\n    \"id\": \"string\",\n    \"type\": [\n      \"DataDisclosureAgreement\"\n    ],\n    \"language\": \"string\",\n    \"version\": \"string\",\n    \"templateId\": \"string\",\n    \"templateVersion\": \"string\",\n    \"dataController\": {\n      \"publicKey\": \"string\",\n      \"name\": \"string\",\n      \"legalId\": \"string\",\n      \"url\": \"string\",\n      \"industrySector\": \"string\"\n    },\n    \"agreementPeriod\": 0,\n    \"dataSharingRestrictions\": {\n      \"policyUrl\": \"string\",\n      \"jurisdiction\": \"string\",\n      \"dataRetentionPeriod\": 0,\n      \"geographicRestriction\": \"string\",\n      \"storageLocation\": \"string\"\n    },\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"contract\",\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\"\n      }\n    ],\n    \"codeOfConduct\": \"string\",\n    \"dataAgreementId\": \"string\",\n    \"dataAgreementRevisionId\": \"string\",\n    \"dataAgreementRevisionHash\": \"string\",\n    \"active\": true,\n    \"presentationDefinitionId\": \"string\",\n    \"openApiSpecification\": {}\n  },\n  \"revision\": {\n    \"id\": \"65471222e8c7c3bb3c2c6601\",\n    \"schemaName\": \"dataAgreement\",\n    \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n    \"objectData\": \"{...}\",\n    \"signedWithoutObjectId\": false,\n    \"serizalizedSnapshot\": \"{...}\",\n    \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n    \"timestamp\": \"2024-01-15T10:30:00Z\",\n    \"authorizedByIndividualId\": \"string\",\n    \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n    \"successorId\": \"string\",\n    \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n    \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update OAuth2.0 Client
Source: https://docs.igrant.io/docs/datamarketplace-api/update-o-auth-2-0-client

---
id: update-o-auth-2-0-client
title: "Update OAuth2.0 Client"
description: "Updates an OAuth2 Client for use with a Data Marketplace. Use an API key with the scope `data-space:update` (an older API key: `config`)."
sidebar_label: "Update OAuth2.0 Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV1Fv2zYQ/isHPiWAIrtp9iIUxdK0KIJu3dAkT60BX6SzzIYiVZKy6xl+2y/ZT9svGY6ULcl2imbYw4C+CALJOx6/O373cS0KcrmVtZdGi0zc1QV6coAafrts/PwcrpQk7WFmLDSOYCn9HBBeo0f4Fe0D+VphTincOWKry9+v4YFWcZ2fE7jc1ATTAj2euRpzypqwxxROUINRBdmtUQbT3OiZLKenqUhEjRYr8mSdyD6uhcaKRCbyEM91IRIhOeIa/VwkwtKXRloqROZtQ4lw+ZwqFNla+FXNds5bqUux2UziYnL+lSlWvCI32pP2/It1rWSOjMbos2NI1j1XtTU1WS/JBbMQyfsQ1noPxxY1ngQzC0AM8BTJflxJ6+91388jbntrvtP7po/Qx37ok91ac/+Zci82m7ja1Ua7eNLz8fgwlv0SAEsKPRV7hROzzen6lzAbZHftwbp8ttEmR5NyXRzGe/36iZm4odySP3QUx5/o7HiZ/Nf18fTCSERpUfvbVR3xG/p7y3MQJgGVMksqAhN8l2MvK3Ieq/rQ7+126miUkFvCeAYLCp2HyhRy1hZMt5XU/pHKDvQwyOIgD4ND9wOdsLv9ArP0RTat+0ExTsJNmRMWgaPW4ipW+Nlt8LA+JKFQ64mgr1jVigcOLsIm2b/yPZ8Q9xJh34vxsyeRVx8lstbYK1MwFOG/X1UHjLB/xzrr7mRSeyrJ9g93MR5vjrg/oOQ+Hq+wAKnrxsOO/QMhHcBypzkTxso/Ard0SYjQXPzA0HwgZxqbE2jDfbvRhwD9FAn9BwXoWnuyGhU4sguyELbZw2iTCEd5Y6VfBfVxWct3xL8TFhAeSxYl4hU6gqugWRobwHMMQUV+bgoWJ01AgCVKJkaL56Oob0adGhpFRjmL7DRab/lrIzgADi+qn32er0wbvUhEY5XIxNz72mWjUUGVOcNapjKQXCqN2CQHPcxjKXX5mA8Xp/fdTDpQbrg2Ykq30Oxyg3GgFWgtZyVbAXfZ3tstmQ8D2+pHRoW0b0syhds5wQJVs2uX04GfaUuNUDXOwz1BbWkmv1IRheg0xghTONHGU3DgLUoVMOA8nCZAaZnuuc2gNXyxMo1lOM4eaPVymoa+w/fkQycl32wrcSgNu1I90sB77VLqmdleSszDpaQKJafFNXVtrP+5S8UOTfm2GxrmsJ/+PZB3RnDy959/nYJ0gHCzpEK6OXBtAn3N56hLlvQFLMjuum+oGJkzwGYhC7IpXHt+GThwpGZnzizIkiw1yILz51dJa4/3irizh2FULgGEQpbSo4IlKkU+bOaMkgXUpgBP+VwbZUpJLgHSeB/ShaBpCYoWpLgWmDwCw+C9VNKvghNsvKnQ8/LcVLWSqPP27RKOZ6lsVLyvIDUgzBqluOgK6UOcFWpNll8hSuakXcjqtoBrzOcE5+n4APPlcplimE6NLUetrRv9cn315v3NmzO2CcrIq0HywguoMHlTkfbbi8F3P+brfHx+kT5Pn7FtbZyvUPfiiW+2VkKl406RFUPm3LH9/+qV13KGp69+VCuUQQIFVNctcX4Ui+fx+TCTfI26TUQiBvQpEpHtBOAkEXPjPNuv1/fo6M6qzYaHvzRkA5UnYoE2FGbkWOn4vxDZDJWjbwB48qFtiKfw2BG2XKiZCANziUyIRDwwVXYydTPZScgQQ5weCMnO/Iha3Fpc5jnV/ptr+43p97tbkYj79gFchX4sLC5Z7uJSZOKT+MTRmjo2NdYAPL4WCnXZYLlTs6FVchKGDeAhNID2hw92FI/9XhDPwl8+2VGTF1xG72j1crc8zjxqsOs/cTVnh4X7P7cH43o=
sidebar_class_name: "put api-method"
info_path: docs/datamarketplace-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update OAuth2.0 Client</h1>

<MethodEndpoint method={"put"} path={"/v3/config/data-space/oauth2-client/{clientId}"}></MethodEndpoint>



Updates an OAuth2 Client for use with a Data Marketplace. Use an API key with the scope `data-space:update` (an older API key: `config`).

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Name of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Client Description of the OAuth2 Client","type":"string"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Marketplace related OAuth2 Client updated

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>oauth2Client</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Secret of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"clientDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"grantTypes"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Grant Types allowed for the OAuth2 Client","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"int"} qualifierMessage={undefined} schema={{"description":"Timestamp of the OAuth2 Client creation or last modification","type":"int"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"oauth2Client\": {\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\",\n    \"clientName\": \"string\",\n    \"clientDescription\": \"string\",\n    \"grantTypes\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Access Point Configurations
Source: https://docs.igrant.io/docs/datamarketplace-individual-api/access-point-configurations

---
id: access-point-configurations
title: "Access Point Configurations"
description: "The Access Point Configuration Metadata endpoint for an organisation's capabilities in regards to a Data Marketplace."
sidebar_label: "Access Point Configurations"
hide_title: true
hide_table_of_contents: true
api: eJzFVsFu4zYQ/ZUBL00AWU6zPQlF0WB3EQTdbRebbC+BkUyosTQbiuSSlB3X0K1f0k/rlxSkZEe2k3SLoujJhjgzfPNm5g3XoiQvHdvARotCXNUEZ1KS9/DBsA7w2ug5V63DaADvKWCJAYF0adP53DhADcZVqNknq288SLR4x4oDkwfW4KhCV3oIBhDexADv0d1TsAol5SITFh02FMh5UVyvnwB18QbMHEJNO1eJTHC0sBhqkQmNDYlCjC0uSpEJR19adlSKIriWMuFlTQ2KYi3CykYPHxzrSnTdLBp7a7QnH89PT07izy6ecwovkOS3LIlMSKMD6RBjoLWKZTKZfvYx0HoExDpjyUW+km2KfpMovtlwfYg32wP2QuW2Bfv08Z3oMoFtqI3j39LpjSe3IPf3F/xy1oYazsa+cJl8Y9zUDAcl6jJRUbhZkOP5kP9NLAj5f5Ja5PzXUQj42IfYSexJABksa3IECGMIMEAAiRruCFhzYAxURrzW+H8N+IPx/y1iR5J4EQF32QaLuftMMvQdz23q+OtnmumZFviaYn0VQbMu4qoJyzTUa/G6H4XJVYK6PhzCNBSZoAdsrIofDiam2yd5HBP6u0SXLg5YRSkRQ6/6ca+KWSYaCrUpRRHTTfoTalGI6eLVNBLBkqZxgifeoqTpeldRumm+JKUm99os9bSnd5Kynsjx0IlM9Kw+JWpvqDGwJb11ShSiDsH6YjotqTETtJxz5VCHnI3osv0AlwEr1tVzMXx/vB9mFjHJ1nFYXcYC9HpzZvknWo1qgf2HQV4HZrcCuyMAhyr04QLuaQWxv0iHoYI5RBlfoGppo+S3O3FuhwJC0/oQG9w6mvMDlbDkUMNtjxFu4UibQClAcMgqcRDLdJwB5VW+F7aAwfH7lWldpGNyT6sfbvM0N6znJqYddRplGmtqkCORvrXWuPDjI3nb/Pn88dMu6+OC7dGydYKjP3//4xjYA8Llkkr2NfRL9UHWqCsC1OXu6A89CdaZBZfkcrgI0Hry4EnNJ94syBFXGriMjIdVNvjjnSKQjtJnVD4DhJIrDqhgiUpRSJd5o7gEa0oIJGttlKmYfAak8S4RjKBpCYoWpGL1WAdKC6vf8qsUBNtgGgzRXJrGKkYtqS9eSs9R1aphRbIGhHmrVGyTkkPC2aDW5OJzQLEk7ZNMbFrOoqwJTvOTA86Xy2WO6Tg3rpoOvn767uL1258v306iT1QEDmqneBAbtTSybUiHTSvHae3rdXpy+l3+Kv92sxAa1GM8z+///YFYP74C/rf31TDWgR7C1CrkpKWJxvWgfddi8WoQLJYUc9jqn8hEcfCmGklg3CXPi+AsE7XxId6wXt+hp09OdV38/KUltxLF9SwTC3SpV3uhZB//l6KYo/L0Ap1HH4eX3TG8+Eh8Mv2N1Omoc0mYRCFEJu6jEu4/IrvZdpsljL1RLKUNI/fDlTXeNedvr0TX/QXhlRQ3
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Access Point Configurations</h1>

<MethodEndpoint method={"get"} path={"/v3/service/data-space/{organisationId}/.well-known/access-point-configuration"}></MethodEndpoint>



The Access Point Configuration Metadata endpoint for an organisation's capabilities in regards to a Data Marketplace.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Get Access Point Configurations Metadata

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"access_point_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access Point Configuration endpoint URL"}}></SchemaItem><SchemaItem collapsible={false} name={"authorization_server"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth Authorization Server URL for the organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"get_verification_request_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Get Verification Request endpoint URL for the organisation, where a verification request can be initiated"}}></SchemaItem><SchemaItem collapsible={false} name={"post_verification_request_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Post Verification Request endpoint URL for the organisation, where a verification request can be received"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"access_point_endpoint\": \"string\",\n  \"authorization_server\": \"string\",\n  \"get_verification_request_endpoint\": \"string\",\n  \"post_verification_request_endpoint\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Authorisation Server Metadata
Source: https://docs.igrant.io/docs/datamarketplace-individual-api/authorisation-server-metadata

---
id: authorisation-server-metadata
title: "Authorisation Server Metadata"
description: "The Authorisation Server Metadata endpoint for an organisation's capabilities in regards to a Data Marketplace."
sidebar_label: "Authorisation Server Metadata"
hide_title: true
hide_table_of_contents: true
api: eJzFVs1u20YQfpXBXuoAFOU6PRFFUSMJAqFJG8QOejCEeEyOyI2Xu5vdoWRV4K1P0kfrkxSzpGz9OE7TS0+ilvO333zzDTeqolgG7Vk7qwp12RCcd9y4oCPKGVxQWFKAt8RYISOQrbzTlmHhAqAFF2q0o/F3EUr0eKONZk0RtIVANYYqAjtAeCkB3mK4JfYGS8pVpjwGbIkpRFVcbR4pZ/YS3AK4ob1UKlNaLDxyozJlsSVVqF2LWaUyFehzpwNVquDQUaZi2VCLqtgoXnvxiBy0rVXfz8U4emcjRXl/dnoqP/v1vCZ+Gh6VqdJZJsvijN4bXSbD6acoETY7FfjgPAUBSv7pGDsKx5VlByXMkh3MKrKsF5pCaoTA85tUti3vj93yVJ8pdrdkP2679/U8l2L/0O0P79/8y0SBah05pONvyPd+x+2/pF2i0RUyffzWi/7eUCBh8nlZUowwXHwRXAsI7zpjJom2wiSKDCVauCFYUhD0K0BbAY6UoEr1AvWQz918opIHEuoukfBq2+ajfnwJty9fbN5LroawSrOzUS8G4k0uU/rNMdcTBTNFd9h6IwdH/OwPwdmNCUMu1afEjLVMrHpsHNQ8Uy1x4ypVqJo4jTk3qlDT5fNppLDUJU1lXibRY0nTzf7g9tN8RcZMbq1b2akTeCe42/dJHPJkanh4TDteUuvg3q4LRhWqYfaxmE4rat0Evc51HdByrp3qs8MAF4y1tvWXYsTh9WGYudRUdkHz+kIaMEz3ude/0HqnFzgcjCo2InuvY3skP2Ls+bsZ3NI60U5UYOhgDqKWSzQdbQXzei/O9dhAaLvIwmEfaKHvqIKV5gauhxrhGk6sY0oBOKA2CQNp07MMKK/zg7AFjI4/rl0XBI7JLa1/us7TLGi7cHJtUUUs0zhSi1qAjJ33LvDPD+Dd31+/fjjaR323YQew3DvByd9//vUMdASEixVVOjYw7K67skFbUxraYYIH7GDkJPjglrqikMOMoYsUIZJZTKJbUiBdW9BJd3mdjf54YwjKQOkYTcwAodK1ZjSwQmOIU7LojK7AuwqYysY642pNMQOyeJMARrC0AkNLMtI9bZnSehiW6XorM65FFvPStd5otCUNzasGiao7k+6TVi/CojNGaFJpTnW2aC0F2bpGl2Rjkokt5TyWDcFZfnqE+Wq1yjG9zl2op6NvnL6ZvXj168WrifiIImg2e80DIWrlyq4ly1sqy7QO/To7Pfshf55/L77eRW7R7tbzlTW71/vNw9b9Hz5hxpFmuuOpN6iTjiYIN6PuXanl81GsdElS/b32qUwVR58tO/KnMvWEAM4z1bjIkmGzucFIH4Lpezn+3FFYq+JqLhskJJ4OIqmjPFeqWKCJ9ASQJ+/Hj6dn8OR32KPX38qcXQ8rrJN/KlO3ooKH32n9/H6TpRoHI9nHnnfcj9fV7p55/epS9f0/zMTTyQ==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Authorisation Server Metadata</h1>

<MethodEndpoint method={"get"} path={"/v3/service/data-space/{organisationId}/.well-known/oauth-authorization-server"}></MethodEndpoint>



The Authorisation Server Metadata endpoint for an organisation's capabilities in regards to a Data Marketplace.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Get Authorisation Server Metadata

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"issuer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Issuer Identifier for the OAuth Authorization Server"}}></SchemaItem><SchemaItem collapsible={false} name={"token_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Token endpoint URL for the OAuth Authorization Server"}}></SchemaItem><SchemaItem collapsible={false} name={"registration_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Registration endpoint URL for the OAuth Authorization Server"}}></SchemaItem><SchemaItem collapsible={false} name={"validate_token_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Where an Access Token from a Pull-Data request can be verified and authorised"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"issuer\": \"string\",\n  \"token_endpoint\": \"string\",\n  \"registration_endpoint\": \"string\",\n  \"validate_token_endpoint\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Get Individual is Opted-In
Source: https://docs.igrant.io/docs/datamarketplace-individual-api/get-individual-is-opted-in

---
id: get-individual-is-opted-in
title: "Get Individual is Opted-In"
description: "Checks whether the individual is opted-in to the underlying  Data Agreement within the specified Data Disclosure Agreement Record."
sidebar_label: "Get Individual is Opted-In"
hide_title: true
hide_table_of_contents: true
api: eJzlWF9v2zgS/yoDPiWALDtpmsMZi8WmTbYwemiLpvvUBPBEHFvcUKRKUnZ8ht/uk+xH209yGEqWZdm5tHcvB+xLIkuc4fA3v/nHtZDkM6fKoKwRY/E2p+zRwzKnkJODkBMoI9VCyQo1KA+2DCQHykCw8WtlJDm9UmYOcI0B4WruiAoyAZYq5LwwJ/AlZWqmSNZrrpXPtPWVo87yz5RZJ9M7IxJRosOCAjkvxl/XwmBBYiwkBtyJtpK14ESKRCg+Q4khF0nvYL8Z9a0imFyDnQEemFHrEIlw9K1SjqQYB1dRInyWU4FivBZhVbIRPjhl5mKzSdb/cQsD9uF3ykLPquYoO1AnP7brPS/2pTWePH8/H4343xEvgopWTPbc9zG6bxLdt+8ukYjMmsBP47XAstQqQ9Y3/N2z0nXHqNLZklxQtQm2DBPTsfXBWk1oDlzAlmQYyLNlLzOrZ94m6YAWTdT64yzSo9m3xTuooKnZsFnft+U2R63tUq+gsJK07yG1zFWWQ4ErcDQjRyYj8LZgk31A/qUMi9BTIGdQg1/5QAWcOJorH1wErnmZwKwyGb9ADZPrBGa2MhLbF0AhO03hat9V230sQ6V8bSbDZGxghB4ICuUDPpKJgQYIVc0/g6FyUcVWWwqTwKJVucW2MdcuDQe5BUmZklT7RXlwMRqgJFeo4KHAsuQADxbwiHpAI4fWRb6BV2auqXsUZ5eQoWEtrMHTglg+YwqbALj1sE9FIp4GxoaBMgOO9Qf0JMYz1J6SHueUPAyORMysKzCIsRCJoCcsykiDy4vXF2d4Tpf0t9eXfx+NRmcXrzN5eXlAii8xn+0H8f5BUqbh1umTH7Ch8uR+aX6mmS0O9v7c8oxRNjam3y5Thj0W1RRVHrR6JL2CT5PJvnFfomHfayAVqA7D5GbL78k1sJ42kbsUrqBWmcKv7PwtYe9qVXcCrIM70SP7nUjhLRqmb+VJchhpDOTgW0VOkY8AK0kmqLD65OxCSXI/AvQxZ+PD2fkRZysPma20ZGPQwK/vE3ioAsysA2OXsCSQNoZbjgsCbMPAzmBrIZSNiT6FyfWbNzFlxOWFdQRNWm/YvYk14+VkdfMUHPq9qvC1rhtJ66Yyt4bEfT8s6upyiNX+0T9g0SSWbg6OyGNxHOxefXGEgSFhWrMPH2mVaYuPnArA8/lZ91TJKaCHaVQ7jfSM9r+4wQ0vg8k1i9RHfVHkU1zG6yuff7BBzZr69cU+knlZ/poWKkYfZ9Sj4Mi44rmwOq5tVdLJx9vTIwoTQaYq2LVopLMqti/Wi/tNIphpz9G+v89MGfJReS0FSh4zP3YOPVkusMx2NN1svswt5PhyPd4kPS5vmODiYnTGZn93L9ElOTln3VsrI9P5+bpj8H1/vz75d9I72JQJNCfXTREXo9HmiPojUO+yyhvkVFVWAdrONB53c9hmYhVy69Q/iR2aE8rYxK5raC7+wtB8Jm8rl1FMqbEsHAD0um5m/6IATcy2mSS3IAdxmx5Gm0R4yiqnwiq2vlelek/8eM/xHXDOA5N4dsjyjERBIbdSjMWcIhA8mIzFcPFqyBurjIbcfA1kKz9oe7Rh3RkO1y+MYpvhLqEM191hZyP4BHy+erTrp7PCNscXiaicFmORh1D68XAoqbADLFWq5g5NSJUVhzPYbcA51+hndPj6c1/N/Q7VWyZXzYkttq1zsX7RDHS1W3Yj3VUT+JGsB4n66tOEqyRweuDeoeZ0CtxzLlBXbUGe7umZQr0NFJUP3KiUjmbqiWTd9E9rG2EKJ8aGuuoGh0pHDErM6DQBSudpT+0YGsGfVrZyDMfgkVY/T9OY1pWZ2W0cYhbjsKnbwldlaV34ZQfebqR9t3u1j3rXYT1YWiE4+fNff5xyP4twuySpfA5MMqCnLEczp9haLMi1dR0atrY9WBxzKk8ePOnZwNsFOVJz03ZrSSOPD5ogcxRfo/YJIEg1V4GrH2pNoe5jrFYSSishUJYbq+1ckU+ADD5EgBEMLUHTgnRsCjl+Oangg9LcHLISrIItMPDyzBalVrFJjs6Lx3M0r3Q8j48zJcwqrZkmUoVoZ4HGkOPZSKuMjKddnyeuSsxygvN0dID5crlMMX5OrZsPG1k//Mfk7c2H25sBy2x23efOD0xUabOKw3lLZY7W2l/no/OL9FV6Fhst60OBpmPPOwrP3Df046GT5P9f7pyaIA/0FIalRmX4jBHUdZMjv4rFqyZ9qYzrzLN5MjbvzY3S+HuurTpt4Xjvbug+Ebn1gTdfr3kg/s3pzYZf88QUM38iFugiqeuMqjw/y3Zyfhb4k89N/TyF770eOwrSNj0azo0xmdVT2SNnzxdv7WIS/99t7ty3/RdG7mG+4R68Se+MaL3kKsuoDB3hg95k0y2u726+iERwut+vII+xgjQPndurfcP6xaQ2gf92Zsh9kZ84ct/T6ud2ef3lWYG2gG0h4INvNv8GAg2vJQ==
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Get Individual is Opted-In</h1>

<MethodEndpoint method={"get"} path={"/v3/service/data-disclosure-agreement/record/{dataDisclosureAgreementRecordId}/individual/{individualId}"}></MethodEndpoint>



Checks whether the individual is opted-in to the underlying  Data Agreement within the specified Data Disclosure Agreement Record.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementRecordId","in":"path","description":"Unique ID of a Data Disclosure Record","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"individualId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Check if an Individual is Opted-In to Data Agreement

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"optIn"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the individual is opted-in to the Data Agreement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email ID"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone"}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device token of the individual"}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`android`, `ios`]"} schema={{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the mapper id of the individual"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"optIn\": true,\n  \"individual\": {\n    \"id\": \"64541a2e6e7569000145cd66\",\n    \"externalId\": \"user@example.com\",\n    \"externalIdType\": \"email\",\n    \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n    \"name\": \"string\",\n    \"iamId\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"pushNotificationToken\": \"string\",\n    \"deviceType\": \"android\",\n    \"mapperId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# iGrant.io API documentation
Source: https://docs.igrant.io/docs/datamarketplace-individual-api/igrant-io-api-documentation

---
id: igrant-io-api-documentation
title: "iGrant.io API documentation"
description: "iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 2024.3.1</span>

<h1 className={"openapi__heading"}>iGrant.io API documentation</h1>



iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner.

<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}>

API key authentication. The value of the `Authorization` header must be prefixed with `ApiKey ` (note the trailing space), e.g. `Authorization: ApiKey <your-api-key>`.

<div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>Authorization</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>iGrant.io: <a href={"mailto:support@igrant.io"}>support@igrant.io</a></span><span>URL: <a href={"https://igrant.io"}>https://igrant.io</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3><a href={"https://www.apache.org/licenses/LICENSE-2.0"}>Apache 2.0</a></div>
      

---

# List all Data Disclosure Agreement Records
Source: https://docs.igrant.io/docs/datamarketplace-individual-api/list-all-data-disclosure-agreement-records

---
id: list-all-data-disclosure-agreement-records
title: "List all Data Disclosure Agreement Records"
description: "Lists all Data Disclosure Agreement Records for the organisation, depending on  the role of the organisation for the record, 'data_source' or  'data_using_service'."
sidebar_label: "List all Data Disclosure Agreement Records"
hide_title: true
hide_table_of_contents: true
api: eJztW+tu2zgWfpUD/WkCyIqdS9sJBoNNk3Ym7UxbNOkW2DZoaenY4kQiVZKK4wn8b59kH22fZHFI3aXETrs7i8XmT2JL4uG5fOdGHd94EepQ8cxwKbxD71eujQaWJHDCDIMTrsNE6lwhHM0VYorCwDsMpYo0zKQCEyNINWeCa0YkfIgwQxFxMQcpwN5XMkGQs96zFQFlCfrwyYuYYZ+1zFWInzyQCsprueZi/lmjuuJ0K/gkPN/LmGIpGlTaO/x405HkdZ5OUdG+quDXSNCXPLPbZmzOheUigCMQOGeGXxF7kAuFLGLTBOGKJTnCjCWJhikLL4nCl/GXwPM9Tlt8zVEtPd8TLEXv0JOzmUbj+Z7CrzlXGHmHM5Zo9D0dxpgy7/DGM8uMHuXC4ByV53sRzlieGO9w7HspFzzNU+9wvFr5NyXZhKfcdLdsy/obu6aFIIZkVmhyJSBDKzUG38rgpMVV05DvZIJ3M/iCJwYVTJfwpgkAWlihoAu4d7ejYhgULcGMyofk0kZxMfeakmg+F2eGmVxvKsMiRhOj41rblSW8h2UAruGT3adkPxfFty0M5gGwsEQfF+7z9kZWqqS5oKd1JoVGTfd3x2P61xZgnUcDOb/ne6EUBoUhAizLEh5aY+38ronKTYOLTMkMleFuTzJJTb0iXkSLBtdMKUbq5QbT5nU5/R1D09P7UQFmUJgp1CgoQIkG91M0C0QBzKn/zAIFmIjc9/eEEjhzKKGIxAyETMAUgYyAEZl0Kk3sw5RpjChukS3zLGIGI/hZgjYqD02uMIDzGOFNZkanoggPEQWglAvULVyoyvKFcYkfUlG1d8wURuSgFXBanA5sxTVIkSzpG4+s35RuTiZjXNByksQKxohh7SJlDaWPHo/IxkxIwUOWnNK3W0x3jmmWMIPv8IprMoZ70in4rNyiuGqZL3hv3pOZOaWVhqeoDUszutYIApaBoWiiTzBBg5F34XeQxqO+D3RR817wr3nfIXuY5xEKw2ccVeCt2npZuwcZKFRS61GTf5Y0iHZynN1jU233HJj2m+VJAqp4BJzL3BZ9amFL2rCIeRh3AFqinjJD1xUNNwldaEDgeiSkGXExIjlobRWfeihzoeI1xVm/oOnMbT8Su/QQKv4HS/gfGJ0JlulYmuKqu/gL03ELPxviYSZVyox3SHkBr1maWUEeH+w/mezu7uLT8Em4N53uhbvh48fjSc+4pcRwekJGa4iy8V6koMoGvQ3ekhVlrpMlJQdL/pMH09w4zGAYWyCCQqal0KBjmScRhY6QJQlG1SpiymY/FFQ8fOztm8mEh8vCTzuB2btYNUzzXWp8uv/D7qCPvH1VlX8OrzYGL5iGwsoaI2/VgsXGjNwEQbAa3LW5F+9u5SL/B25imZs3ffGnUibIxG3bFoBvb3oqIsqVqN2epVKtoAnODEwTJi6BCxiAPCUPQZYN84QZCuRtDwhqeilbgs6nGr/mKEyyJEjMuIUEFzbCDLnUd2q0dAcsstgWxQym4eXZm9fb9IFBxEMTwFGWJUt7GY7LYMr/cPXeGeEV6WmqRk+fn7+Ady+O4emTpwcBwKkp85jrQAgwM45JVJVXDu+A1yFmBnQeotZSnUZ+R1nN76UCKBGuenFlY62wyXQ33Iv28WD2+K7PPcXRNsT/kM23zn45Gk22ia86vG3M0u54d380nowmB+eT8eHe+HA8/lvfE0q6xIPFWJk8CGMxyzIUGAWk/DrAnJ69gaePxxN4f35M5kYg9ohNlptYKhLi2ZLwfsWjvEyWfW9wdymC+t2StU3qDdVN94o/+wf7E7aLj/HJweMfxuPxZP+ATcfjAdzOUKEIkSotJoBFKReQa1umMQMx0xAqtJWeibmu1GPBkoclxIi169HscpTKCJN2Rry7SjidtQlTMBISEinmRa1ImVmb6gEfFDFNDHOjoWKCOMoURui+3g+/m6E33OsDiKUZqpFCzTW1BcCU4TMWGpgpmUJWZLGqiQ9lxjFyNzvO1ua/LhI3FqLJahAE38krbC0QIikeGbgUcgHcBZnuUzZPuUZBKhDSbHur1Wq4FB4s2apiHDIlr3jkOo6qYHM07iq+muX0PaqvjC0TyWwd1iBQfT7BUEZIt69Q8VnR5v2GJpbdi28rSgNXi/qseefMquvZcvDyke5cfrnQvyCL7GlDs0sYyNGVN1dF5DnprPxS3/6enqG2V13HW+wWWtioL1jbeGzZnOko0BaRy5lOkO2yRrnVQdo7vvxwXrPdWltaeW2bXTxYk/GbXWWYMJ5qipuFa5sWsF9+OKddB4C0lvUjWGCSjMgDRaEOiFBIWwO5diW1pChu0v4B/NX2v7Yn1ofw6BKXU26PHD//vjCPuoy8vY/ZalokExQmbxSsLhAYSb4c5ZRWmoq4Ze/bQnU3YxpUgiXJEuYoUNmcFKplZuRcsSzmIWWruCyG3JmAkfVBhg88wKBxU85gSBOrW7x1LYfPMGS5prOMhms80sCFi9eU3ag6DWMm5gjyirIYT9EnnpQ9wGAg0ClQG6mwKM8b65mxAtAyWzbxOQEwgFN3KhMyba+zjmYasLXZ1haOZUlTABm0TLHbnCdSXpK584zCu9XLkr7bVJBPEx4SKKoK1LEDGVNmGQxr8kiv1+Rzbk+KCjjZUDBwztm83j/sbLZ7xbKix2s/bFu84YC73jsTi0l7glUcVfWd3G9dswUvnXZ1NVOYZ25Pw+Dlh7NGT1Z2a1vvXhw/OZgcrK+J7yhze5Hw1iwy1PBt0NTVRWW/t7MoqeW6QmWLvk4E8YElC7bUYJO3BeLajFEf6tXNsk1/a7VDJwSdHsqWscMyZZLTGauRvpOHa+d1BRCjisXPrGTxs6uV+rC84+HGycOQQW4Nkp0wsG6bIh5wbdednpR6KKq7jl3q0m74PPNbCrz2se5DnfdQ5z3UeQ913kOd91DnPdR5D3XeQ53336vz3Lvp9eD48G99sX9fyBdRsn2K3zg3rtMzyceiCN175s5b9o02qvXWmtQqDrCt5FOko2s7WrRlhw1aT14iZhS0Zbbc7nFhX+1vxMetM2MlUivzuxEaHxrRcTu4b9Sshw02iBSzDg4itzQgTNnysRwtGyrGylr/bf1Ut4QNc6VQmLds3lRWcyKryc6xe9rOdhUDYM0z8wmBTRqWnHambW6jd04PNybJ7JQOsCvGExqKa9LePSiJE6/fQpyYrgcQoBx1q3bYW/nF/Nt62q87LJcDby1tjFe+FzNdvnu/V2Jw7wcUPqJsXb0l6G5hA73b5TVem2/fQeC16VGnsTYHsy6wmm3hmlGsFkYvLLXY1glWH8du/GtUppze1JkdBGu9G+1Oia16IG3QBLeXi8D744mF/KYjZ00pUSmpjmVkFUSfTxp7XvQ11PayevUQtCrh9scEmR75gSBW6+MZozfxWU7mKyZUbWzoqeW9qF+Cek0j0KMHbobv/1Q1ZZNENRa1F3abjo7s6/wwV9ws7QDwUcZfIX28oIFIw+Y0F3z72KMmTaRF++rN7ehuxkzsHXo7V3s7RX7YIWca1YXHqMo8O6ryJ8fk0BjyCaaykMHzvVzRq+PYmEwf7uxEmMoRy3jA54oJE3Dp0Vxqm8CZIV+d30ZDu9tdMhe1atzQhTVsqaB6FNNdKOZe4/J0ppiMPSrAWaapTsvw9tR2TARh6rTCYpz6vNmWUqb80qLzpfB/SHNNs5sUSWf8GiNYcBPDF8cjfIEtIY1ru41iPLE6yFiI2z7Yodk22UMoFv64lLkidYwucfnTF8rKJN5Mls7EQutMmDJOitR5lkll/lIrr5Kf/1xfamu9abCOWqpFsPXPv/9j2/XCZwuMuI5dnYjXRd/cbZ6ggFx5jKjsWEaukaaXktlIU6ONfF525WZZdmR2XD2kd+vCcJZo347jzDll2wVNixm7mZZ0oJLJyI2XyUTOOWofULCpVTBlnQUkeIWJTaTkhBQZ2JQn3CwtEZYbmboRpVCmWcKZbZDIeFY8hXM7wkQza5ymcmlkkWAScWP5TJkQNG5JqT1EoW2YKSGXsTBG2A3GPZ0vFouA2duBVPOdYq3e+fX0+Pnrs+cjWrOqC6zaDgTUSIY5+WwJ5aJdK6Zogr1gYk/+pDYpEw1+aCR6s59DdP2jEbn/t35VUYQGg9dmJ0sYt+ncmuKmCI8fvau9IujxqqoeDJG2LnHqufC9WGpDq29uqOJ7r5LVii67cXsbOrkmhETDA3ZNjf5nf90xqIJLipz1jzzschpQsSF7Y8bv+1ONO1gpq+Vv5GTrXVEwbMOf9fOMu/TanwD/Rrn+9N9p3CFV67cltTwX9EXZqG2rlbKssU7gVh6FNOPYWNUvspvVy8/Pzz03UtfO7pc2uxcfiHp5SywbtLuJ3rFAf0n1g0t+pKj6Cpc/VY+7O7cuqIoL9zRpiVqPfwFNwzX2
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all Data Disclosure Agreement Records</h1>

<MethodEndpoint method={"get"} path={"/v3/service/data-disclosure-agreement/records"}></MethodEndpoint>



Lists all Data Disclosure Agreement Records for the organisation, depending on  the role of the organisation for the record, "data_source" or  "data_using_service".


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"organisationRole","in":"query","description":"Filter by Organisation Role for the Data Disclosure Record, \"data_source\" or \"data_using_service\"","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"signStatus","in":"query","description":"Filter by whether the status of the Data Disclosure Record is \"sign\" or \"unsign\" (e.g. active or inactive)","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Record List

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementRecords</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Record identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"canonicalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The cross-organisational identifier for the record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplateRevision</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The full revision object of the Data Disclosure Agreement Template which the record is based on.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSourceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Source.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataUsingServiceSignature</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The signature provided by the Data Using Service.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the record is active and data can be shared to the Data Using Service."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The timestamp of when the latest signature was added."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation this record belongs to (both organisation keep a copy)."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationRole"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"The role of the organisation in this agreement (e.g., data_source).","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"isDeleted"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the record is deleted."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataDisclosureAgreementRecords\": [\n    {\n      \"id\": \"string\",\n      \"canonicalId\": \"string\",\n      \"dataDisclosureAgreementTemplateRevision\": {\n        \"id\": \"65471222e8c7c3bb3c2c6601\",\n        \"schemaName\": \"dataAgreement\",\n        \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n        \"objectData\": \"{...}\",\n        \"signedWithoutObjectId\": false,\n        \"serizalizedSnapshot\": \"{...}\",\n        \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n        \"timestamp\": \"2024-01-15T10:30:00Z\",\n        \"authorizedByIndividualId\": \"string\",\n        \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n        \"successorId\": \"string\",\n        \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n        \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n      },\n      \"dataSourceSignature\": {\n        \"id\": \"string\",\n        \"payload\": \"string\",\n        \"signature\": \"string\",\n        \"signatureDecoded\": {},\n        \"verificationMethod\": \"string\",\n        \"verificationPayload\": \"string\",\n        \"verificationPayloadHash\": \"string\",\n        \"verificationSignedBy\": \"string\",\n        \"verificationSignedAs\": \"data_source\",\n        \"verificationJwsHeader\": \"string\",\n        \"timestamp\": \"string\",\n        \"signedWithoutObjectReference\": true,\n        \"objectType\": \"data_disclosure_agreement_record\",\n        \"objectReference\": \"string\"\n      },\n      \"dataUsingServiceSignature\": {\n        \"id\": \"string\",\n        \"payload\": \"string\",\n        \"signature\": \"string\",\n        \"signatureDecoded\": {},\n        \"verificationMethod\": \"string\",\n        \"verificationPayload\": \"string\",\n        \"verificationPayloadHash\": \"string\",\n        \"verificationSignedBy\": \"string\",\n        \"verificationSignedAs\": \"data_source\",\n        \"verificationJwsHeader\": \"string\",\n        \"timestamp\": \"string\",\n        \"signedWithoutObjectReference\": true,\n        \"objectType\": \"data_disclosure_agreement_record\",\n        \"objectReference\": \"string\"\n      },\n      \"optIn\": true,\n      \"timestamp\": \"string\",\n      \"organisationId\": \"string\",\n      \"organisationRole\": \"data_source\",\n      \"isDeleted\": true\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List Opted-In Individuals
Source: https://docs.igrant.io/docs/datamarketplace-individual-api/list-opted-in-individuals

---
id: list-opted-in-individuals
title: "List Opted-In Individuals"
description: "Lists individuals that have opted-in to the underlying Data Agreement within the specified Data Disclosure Agreement Record."
sidebar_label: "List Opted-In Individuals"
hide_title: true
hide_table_of_contents: true
api: eJzlWN1u47YSfpUBrxJAlp1sNkWNomh2kxbGFruLzfZqE8ATcWyxoUgtSdlxDd31Sc6jnSc5GEqW5Z8g6dW56E0iU5zhzMdv/rQWknzmVBmUNWIsflc+eFBGqoWSFWoPIccAOS4IbBlIDpSBYCHkBJWR5PRKmTlcY0C4mjuigkyApQo578sJfEmZmimSzZ5r5TNtfeWot/0LZdbJ9M6IRJTosKBAzovxt7UwWJAYC4kBt6KdZCM4kSIRiq0vMeQi2XPpD6O+VwSTa7AzwAMzGh0iEY6+V8qRFOPgKkqEz3IqUIzXIqxKNsIHp8xc1PU9b/alNZ48vz8fjfjfIZJ84qeI2sTAZAuqSERmTSATWA7LUqsMWW74p2fhde/w0tmSXFDNUb2b6VmGzuGKQQhUxHXU+tMsAtjusA9/UhZEIoIKmhe21hwAdpuj1napV1BYSdoD9o2HZa6yHApcgaMZOTIZgbcFgTI+IP9ShkXoKZAzqMGvfKACThzNlQ8uOtouJjCrTMYLqGFyncDMVkZitwAUstMUrnYM6M6xMwi58o2ZoDwYG5icDwSF8gEfyUQqAkLVkMBgqFxUsdGWwiSwaFVuaN2aa5eGHK9JypQkUO1hLvIFSnKFCh4KLEuOgGABj6gHNHJoHUsjeGXmmvquOLuEDA1rYQ2eFsTyGVPLBMAN0X0qEvE0MDYMlBlwNDygJzGeofaU7HNEHpI2ETPrCgxiLEQi6AmLMtLg8uLtxRme0yX98Pbyx9FodHbxNpOXlwek+BoDvh9JZs+RVNSsubn0yT+wofLkfml/ppktDs7+0vGMUTY25OR2mDLcY1FDUeVBq0fSK/g8mewa9zUa9loDqUB1GCY3G35ProH1dKnOpXAFjcoUfuXL3xD2rlF1J8A6uBN7ZL8TKbxHw/StPEkOI42BHHyvyCnyEWAlyQQVVp+dXShJ7p8Afeyy8eHs/MhlKw+ZrbRkY9DArx8SeKgCzKwDY5ewJJA2hlusDNiFgZ3BxkIoWxN9CpPrd+9iyojbC+sI2nTbsruu6+Q1yermKTj0O9n6W1Mkku6aytwaEvf7YdGUkkOsdl3/iEWbWKgXxhF5LI6DvavgvSMMDAnTmu/wkVaZtvjIqQA8+8+6p0pOAT1Mo9pppGe0/8UDbngbTK5ZpHH1RZHPcRvvr3z+0QY1a+vNV/tI5mX5a1qoGH2cUY+CI+OO58LquLZVSSefbk+PKEwEmargq0UjnVWxwFsv7utEMNOeo/3+OTNlyEfljRQoecz8WNH3ZLlLYLaj6WfzZW4hR3/QCu32P5HNB2TuM7Zfxu/ruP1idMYuvbov6Ksj56x7b2WMAn6+7jlzf2jKbmBspbeQKhNoTq6fPi5Go/qI+iPXsM0475DTWFkF6Po6BqeuD5s0rEJunfqL+LJzQhlbwHUDzcW/GJov5G3lMorpNpaMA4DeNg3ovxSgidk0muQW5CAes4dRnQhPWeVUWMW2+KpUH4gf7zn2A8553BDPjiiekSgo5FaKsZhTBIKHjbEYLt4M+WCV0ZAbs4Hs5Add/zZsusbh+oVBph6qnSmh8agZhfaTW2Fbh0UiKqfFWOQhlH48HEoq7ABLlaq5QxNSZQVX170uP+CcK/YzOnzzel/N/RbHW6ZTw4INmtuBpFlox7LmIkSymeau2lCP9DxI21efJ1wzgRMCdxINi1PgDnSBuurK83RHzxSaY6CofOC2pXQ0U08kmxFg2tgIUzgxNjQ1ODhUOmJQYkanCVA6T/fUjqEV/GllK8dwDB5p9fOUWxZ2b2Y3kYdZjLy2igtflaV14ZcteJ3/6rft0i7q/Qvbg6UTgpP//v2fU+5uEW6XJJXPgWkF9JTlaOYUG40Fua7KQ8vPriOLQ0/lyYMnPRt4uyBHam663i1p5fFBE2SO4jJqnwCCVHMVuBai1hSarsZqJaG0EgJlubHazhX5BMjgQwQYwdASNC1IxxaRI5bTCD4oza0iK8Eq2AIDb89sUWoVW+Z4edE9R/NKR398nDBhVmnNNJEqRDsLNIYcT0paZWQ8bbs+cVVilhOcp6MDzJfLZYrxdWrdfNjK+uHvk/c3H29vBixTb3vR7T0wUaXNKg7gDZU5Wpv7Oh+dX6Rv0rPYdlkfCjQ9e+LXgWc+DcjdDNll9f//x5k2ugM9hWGpURl2LqK5btPhN7F40+YtlXFJeTYlxo6o/fQyfs33nV7HlIjc+sCnrdc8CP/hdF3zMk9KMasnYoEu0rfJncrzs+wm5mcxPvnS1sZTeO2Ho6OobBKh4SwY01YzjT1ynnzxe1bNnW6bNtn+Ruoqy6gMPX0HVb7ul6nfbr6KRHAa3c3MjzEztw+9b0S7tu4n6cYE/tub1HZFfuKI+ECrn7vtzZtnBbrC0Oxm5Lgb/h8mlS2e
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List Opted-In Individuals</h1>

<MethodEndpoint method={"get"} path={"/v3/service/data-disclosure-agreement/record/{dataDisclosureAgreementRecordId}/individuals"}></MethodEndpoint>



Lists individuals that have opted-in to the underlying Data Agreement within the specified Data Disclosure Agreement Record.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementRecordId","in":"path","description":"Unique ID of a Data Disclosure Record","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

List of Opted-In Individuals

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"individuals"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","title":"Individual","description":"Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.","x-not-in-database":false,"properties":{"id":{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."},"externalId":{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"},"externalIdType":{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."},"identityProviderId":{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}},{"type":"object","title":"IndividualExtras","required":["name","email","phone"],"properties":{"name":{"type":"string","description":"Name of the individual"},"iamId":{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"},"email":{"type":"string","description":"Email ID"},"phone":{"type":"string","description":"Phone"},"pushNotificationToken":{"type":"string","description":"Device token of the individual"},"deviceType":{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]},"mapperId":{"type":"string","description":"Defines the mapper id of the individual"}}}],"description":"Data for an individual who has opted-in to the Data Agreement"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individuals\": [\n    {\n      \"id\": \"64541a2e6e7569000145cd66\",\n      \"externalId\": \"user@example.com\",\n      \"externalIdType\": \"email\",\n      \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n      \"name\": \"string\",\n      \"iamId\": \"string\",\n      \"email\": \"string\",\n      \"phone\": \"string\",\n      \"pushNotificationToken\": \"string\",\n      \"deviceType\": \"android\",\n      \"mapperId\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Pull Data Endpoint
Source: https://docs.igrant.io/docs/datamarketplace-individual-api/pull-data-endpoint

---
id: pull-data-endpoint
title: "Pull Data Endpoint"
description: "The Pull Data endpoint allows a Data Using Service to Pull Data according to a  specific Data Disclosure Agreement record signed by themselves and a Data  Source, either anonymously or for a specific individual."
sidebar_label: "Pull Data Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJzlVs2O2zYQfpXBnBJAlp1NejGCoJvsojBStEG8e9ossGNxLDFLkQpJ2asavvVJ+mh9kmIo+WedpEmBntqLIZOc4cw3H7+ZDSoOhddN1M7iFK8qhnetMXBBkYCtapy2EcgYtw5A/fJ10LaEOfuVLhiiO7KgonBeyXZ0QACh4UIvddHvXuhQGBdaz3BeeuaabQTPYgJBl5YVLDqIFdeBzYoDkFW7S2HuWl9wBqxjxR7IOtvVrg2mA+dh6TzQ4TptlV5p1ZLJP1jM0POnlkN87VSH0w0Wzka2UT6paYwuSPIffwwCwgZDUXFN8hW7hnGKbvGRi4gZNt417KPmILuKIh1y2qf0PmU0U0cOQvTalpidwP11VHofMLvAbYaHbL7H6Wx/Oplv++y1Z4XTm2/GfLvd9iahcTb0eZ5NJindR9fM26LgEJatgfP0BVfuni14NkyBMfu3UKbkPTn/dvJDKDGFEh0sGNrACkggDYlCibnscbvtU30xefaPOHGMJnvv/BunJN30fXEUzW32jcwO1oe8tI1cshd/D1Q3hnH6YjLZfsH9F7DYm+BrUqBt00ZoyFPNcZfwKWDXltpYOa9/Y4UZVkyKvUQnR3/oC/8/hWZmI3tLBkIiDKRrTjDaZhi4aL2OHU5vNnje6Lcsn7dbyZHKIFjMe3Hbv7YgANQcK6dwio0LCQCKFU5xvHo+Dr22juWxjkJDBY+b1piR/Ee5UeIJ6cITQeHaDeFihq03OMUqxiZMx2PFtRtRo3NderIx1w632WevOlIp8v0VH6HfPnVze0BhLmToa7jDYl8M6hdE0MRnghEztFTL7vnAw0Suzx/2uxnccwfCVrZx4GAO0rFWZFoGt5TWAXeP/NxBfw3UbYiiBo3npX5gBWsdK7jrY4Q7eGJd5OQgetImYSDAP82A8zI/cTuFwfBl51ovcIzuuXt1lye9lYfx/tBxLnfU+46OcSDsY9HfradusHS7V0lFepVck5YyhbZpnI8/HkqzR1f/dFh6XNNjOpyAvjeCJ3/+/sdT0DIDzNesdKhApRHhoajIlpxa9Yq9dN+EEAwchsa7lVbsc5hF0eIAgc1yFNyKPevSglZSz9hlgz0tDEPhOS2TCRkQKF3qSAbWZAzHdFlwRitonILIRWWdcaXmkAFbWqTyEVheg+EVG+GGqEeSGFpoo2PXDxdtdDVFOV64ujGabME9NVJ6nsvWpHwCaAsEy9YYIaHSMcVZk7Xsc8zQ6IJtSFXeEbqhomI4yyefYb5er3NK27nz5XiwDeOfZ28uf5lfjsRmm2HU0TwqHsgzUK5ohTW7hyJa0NfrbHL2In+ePxNbUZWa7FE8hzHtchjsTl/ZkdT/Z0fBQYsiP8RxY0hbAStVZzNI8A2ung8qqwtpXwcZFpneC/FthpVI9/QGN5sFBb72ZruV5U8t+9QEMlyRT4xOLWHXO5Jy34s24pse8NGVhCXHTdtL5UmfFanuLWTEaeLfnj3uLu9+nV9hhoth9K1TT0VPaxmLaY1T/IAfEDN0iQRJudP6Bg3ZsqVSzvd+RdxEgB9r+n3S9OFDMttt2e4oylN575ORX0ntiyYvhe1vuXu1P97vfNVg31L601JbmWf/AmGCgpk=
sidebar_class_name: "post api-method"
info_path: docs/datamarketplace-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Pull Data Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/service/data-space/pull-data"}></MethodEndpoint>



The Pull Data endpoint allows a Data Using Service to Pull Data according to a  specific Data Disclosure Agreement record signed by themselves and a Data  Source, either anonymously or for a specific individual.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data Disclosure Agreement Record ID"}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Individual ID"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Successful Access Token release

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accessToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access token to be used at Resource Server"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"accessToken\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Token Verification and Authorisation
Source: https://docs.igrant.io/docs/datamarketplace-individual-api/token-verification-and-authorisation

---
id: token-verification-and-authorisation
title: "Token Verification and Authorisation"
description: "The Token Verification and Authorisation endpoint for an organisation in  regards to a Data Marketplace. An Access Token issued as a result of a Pull-Data request can be verified here, and an authorisation decision can be made  against the requested resource (defined by OpenAPI method and path). The  resource is checked against the OpenAPI specification of the underlying  Data Agreement within the Data Disclosure Agreement Record's Template  connected to the Access Token."
sidebar_label: "Token Verification and Authorisation"
hide_title: true
hide_table_of_contents: true
api: eJztV81uGzcQfpUBL02AleQ46UUIgjp20LppaiNWmoNjwCNytMuYS25IrmTF0K1P0kfrkxTDXXl3Zad1cmx7sSmS88NvvvnZG6EoSK+rqJ0VUzErCGbuiiz8Rl4vtEQ+ALQKDupYOK9Ds0NWVU7bCAvnAS04n6PdHmoL4ClHrwJEBwhHGBHeoL+iWBmUNIYDCwdSUgitOR1CTQowAIKnUJsIbgEIp7UxoyTu6VNNIYJEC3OCZfKPFBTkKUseogUcOKlI6sCLVqZERQCYo7YhQixoq5QUG3W1lwSPFC20JQXzNZxUZA9Oj6GkWDiVjFQYi8djYKA6GR1AFiSv+AU97VvxUJHswHSLdFhbRd6stc2hwecg90Ql2QgrHQtt0610cqSDNC7UnnqX3pJ0Xn0XYEZlZTASgHTWkuTXRJek+xCPP1iRifbBL51ai+mNkM5GspGXWFWmdXHyMTAbbkSQBZXIq7iuSEyFm38kGUUmKu8q8lFTSLLJTjLTuxyi1zYX2T0c+/n9bBj/6AZBTeFsY0lKbDJRxFi9SWF4mIWfZrNTaARa5Q+OEJvjMD/MEN/8Fgt0LU2tiAN8aDCE7rAzO3fO3DH6vqBYkGebrY5kSDFT5EATLLwrW55zSiVVC+TVdIEmUOfGsVV6qVWNJnyjfd1p+Aq7RySdInVoUJffalk1OvjxunyA8U2TBtqTEtPzAXkHPGtZcLHZNCKhcjY0hN/f2+N/Q/daQsdE6GW/ft568uB8c5ZOFmJ6fjfz+q5v84XfeJdHmejFJMHQx/pikz1YuSdkDy82LRbP9p58VfXoqyXvnT90ikTWrI96IF5k/1BpOumOK9pGysmzvmssK0Ni+mxvb3OP+nsS+lZEvEQF2lZ1hAo9lhTJi03z3mGc39m2NH1O4BSEijx7x1e/b5jxH4Xm2EbyFg0E8kvykMzcwaj7JQ4bnEazZPuejnOPN3cAveNGXys01kTyNpCsvY7rlFkHlX5NvLzYMLiYBw7CcM45S+9g8Mu2+YjKhbitDVMxWT6d8GO1pAnn4ChUKGmyRKMVRho11UWwadYUkuWht0dUuhYwkYnaGzFNZShMJxNFpRthpcc692jjWDvBeTtUcBYx5zniCzpCc7yr5qKD44xRb1i0BeU2ANhscDFhnQ2YmbBY8mmL1udtxdmpiKfHcEXr1MrJxjZozfS0RFPTdhi6HOi5bGMGZR0iN9bK00Jfk0qTEVw2PsIlPLIuNj0getQmYcDwP86Axvl4R+0UWsHna1d7hmN0ResXl2PB1GAmve2mo1dbuu1MNx0h+xNJt9vSov29YdgWblsRUKaKQCVqDlCoq8r5+EMXlFtc9Y/d1jCafSLswH0rBI/+/P2PxzyWIpytSOlQNPMBXcsCbU5pwBq0qJbDUHm31Ir8GI4j1IECBDKLUXBL8qRzC1pxJOM6a+Vxbgikp7SNJmSAoHSuIxpYoTEUk7HgjFZQ8TRGsrDOuFxTyIAszlPgECytwNCSDLOCK1cqbzjXRsf1diR0JUa+Ll1ZGY1WUkMK1Xwj5LVJ7wn8EYKwqI1h+ikdk58lWkt+LDJhtCQbUny3VK5QFgT74707mK9WqzGm47Hz+aSVDZNfjg9f/Xr2asQym0xEHc0geMAJoJyseWLfpghXgSZe+3v7z8ZPx0/SwOlCLNH2/HnId9huxvUaz//fcv/2b7m2QEe6jpPKoE6NMBH3pi1D52L5tG09WlI7JTYdiom406MuMlFwb5uei5ubOQZ6581mw9ufavKpUbKQTymf2ua2laemdsVtY9jQk436Cz17K8EPq+Lf3u2339OTs5nIxLz9gi3TwCM8rnhOxZWYig/igxCZcCknUlNL+zfCoM1rzPl+o5frPtNs2O6uUrtrF70RHO265+Vu52sew397g/VQ5DkT6DWtX9xeb06+KHDbbZvbHGGewP8CAAQ4Ww==
sidebar_class_name: "post api-method"
info_path: docs/datamarketplace-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Token Verification and Authorisation</h1>

<MethodEndpoint method={"post"} path={"/v3/service/data-space/validate-access"}></MethodEndpoint>



The Token Verification and Authorisation endpoint for an organisation in  regards to a Data Marketplace. An Access Token issued as a result of a Pull-Data request can be verified here, and an authorisation decision can be made  against the requested resource (defined by OpenAPI method and path). The  resource is checked against the OpenAPI specification of the underlying  Data Agreement within the Data Disclosure Agreement Record's Template  connected to the Access Token.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accessToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JWT Access Token to be verified and authorised"}}></SchemaItem><SchemaItem collapsible={false} name={"httpMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTP Method to be checked against the OpenAPI specification"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The path to be checked against the OpenAPI specification"}}></SchemaItem><SchemaItem collapsible={false} name={"excludeDataClassification"} required={false} schemaName={"bool"} qualifierMessage={undefined} schema={{"type":"bool","description":"Whether to exclude the data classification from the result","default":false}}></SchemaItem><SchemaItem collapsible={false} name={"excludeIndividuals"} required={false} schemaName={"bool"} qualifierMessage={undefined} schema={{"type":"bool","description":"Whether to exclude the individuals from the result","default":false}}></SchemaItem><SchemaItem collapsible={false} name={"excludeDecodedClaims"} required={false} schemaName={"bool"} qualifierMessage={undefined} schema={{"type":"bool","description":"Whether to exclude the decoded claims from the result","default":false}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Access token verification result

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the access token was verified and authorised","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"dataClassification"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`anonymous`, `pii`]"} schema={{"type":"string","description":"The data classification of the requested resource","enum":["anonymous","pii"]}}></SchemaItem><SchemaItem collapsible={false} name={"individuals"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","title":"Individual","description":"Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.","x-not-in-database":false,"properties":{"id":{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."},"externalId":{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"},"externalIdType":{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."},"identityProviderId":{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}},{"type":"object","title":"IndividualExtras","required":["name","email","phone"],"properties":{"name":{"type":"string","description":"Name of the individual"},"iamId":{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"},"email":{"type":"string","description":"Email ID"},"phone":{"type":"string","description":"Phone"},"pushNotificationToken":{"type":"string","description":"Device token of the individual"},"deviceType":{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]},"mapperId":{"type":"string","description":"Defines the mapper id of the individual"}}}],"description":"Data for an individual, returned if the Pull-Data request was made for a specific individual"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedClaims</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The decoded JWT claims. The fields listed below will be present; additional claims are allowed.

</div><SchemaItem collapsible={false} name={"aud"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The audience of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"dataClassification"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`anonymous`, `pii`]"} schema={{"type":"string","enum":["anonymous","pii"],"description":"The data classification of the requested resource"}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreementRecordId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the Data Disclosure Agreement Record associated with this token"}}></SchemaItem><SchemaItem collapsible={false} name={"exp"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The expiration time of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"iat"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The issued at time of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"iss"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The issuer of the JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique identifier for the JWT"}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The decoded JWT claims. The fields listed below will be present; additional claims are allowed.","properties":{"aud":{"type":"string","description":"The audience of the JWT"},"dataClassification":{"type":"string","enum":["anonymous","pii"],"description":"The data classification of the requested resource"},"dataDisclosureAgreementRecordId":{"type":"string","description":"The ID of the Data Disclosure Agreement Record associated with this token"},"exp":{"type":"integer","description":"The expiration time of the JWT"},"iat":{"type":"integer","description":"The issued at time of the JWT"},"iss":{"type":"string","description":"The issuer of the JWT"},"jti":{"type":"string","description":"The unique identifier for the JWT"}},"required":["aud","dataClassification","dataDisclosureAgreementRecordId","exp","iat","iss","jti"],"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the access token was verified and authorised","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason why the access token verification failed","example":"Invalid signature"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"headers"} value={"headers"}><div></div><div></div></TabItem></ApiTabs></div></div>
      

---

# DCQL: Claim Sets (Selective Disclosure)
Source: https://docs.igrant.io/docs/dcql-2-4-2-claim-set-age-verification

---
id: dcql-2-4-2-claim-set-age-verification
title: "DCQL: Claim Sets (Selective Disclosure)"
sidebar_label: Claim Sets (Selective Disclosure)
description: DCQL claim sets for selective disclosure, requesting preferred claims with fallback alternatives.
keywords: [DCQL, claim sets, selective disclosure, age verification, OpenID4VP, credential query, EUDI Wallet, verifiable credentials]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcql-claim-sets` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcql-claim-sets
> ```


import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";

DCQL `claim_sets` allow a verifier to request preferred claims with fallback alternatives, enabling selective disclosure where only the minimum necessary data is shared.

**Scenario:** A verifier requests age verification from a PID credential, preferring a simple boolean `over_21` claim and falling back to the full `birthdate` if unavailable.

For the underlying DCQL query, diagram and example, see the **“Claim set for age verification (selective disclosure)”** use case in our [DCQL concepts article](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/#242-use-case-claim-set-for-age-verification-selective-disclosure).

![Fig 02: Verify age with minimal disclosure (Mandatory), for example by sharing an age-over-18 claim instead of a full date of birth.](../cDocs/articles/dcql-images/fig-02-dcql-eudi-wallet-age-verification-minimal-disclosure.png)

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the interactive block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in Step 3 automatically (and updated whenever Step 2 is re-run).

<DcqlStepTemplate
  initialJsonData={{
    label: "PID - Person Identification Data",
    cryptographicKeyFormat: "x509",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    credentialDefinitions: [
      {
        credentialFormat: "dc+sd-jwt",
        vct: "urn:eu.europa.ec.eudi:pid:1",
        display: {
          name: "PID - Person Identification Data",
          description: "Person Identification Data credential",
        },
        claims: {
          claims: [
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["address", "country"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["address", "locality"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["address", "region"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["address", "street_address"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["birth_date"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["email"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["family_name"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["given_name"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["is_over_18"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["is_over_21"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["is_over_65"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["phone_number"],
            },
          ],
        },
      },
    ],
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  extractJsonResponse={(result) => result}
  emitCredentialDefinitionIdsEvent="dcqlClaimSetAgeVerification:credentialDefinitionCreated"
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run Step 2 on this page, the `credentialDefinitionId` and `credentials[].id` fields below are autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained from Step 2. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Choose the credential format as needed. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, you can toggle the switch to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or by directly accessing the credential offer on their mobile device (e.g. via a browser).

<DcqlStepTemplate
  initialJsonData={{
    issuanceMode: "InTime",
    credentialDefinitionId: "<credentialDefinitionId>",
    urlScheme: "openid-credential-offer://",
    credentials: [
      {
        id: "<id>",
        claims: {
          address: {
            country: "Sweden",
            locality: "Stockholm",
            region: "Stockholm County",
            street_address: "Sveavägen 44",
          },
          birth_date: "1958-01-07",
          email: "alice.andersson@example.com",
          family_name: "Andersson",
          given_name: "Alice",
          is_over_18: true,
          is_over_21: true,
          is_over_65: false,
          phone_number: "+46 70 123 45 67",
        },
      },
    ],
    userPin: "",
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer}
  listenCredentialDefinitionIdsEvent="dcqlClaimSetAgeVerification:credentialDefinitionCreated"
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

Once a presentation definition has been created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

<DcqlStepTemplate
  initialJsonData={{
    label: "Claim Set for age verification (Selective Disclosure)",
    cryptographicKeyFormat: "x509",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    dcqlQuery: {
      credentials: [
        {
          id: "pid",
          format: "dc+sd-jwt",
          meta: {
            vct_values: ["urn:eu.europa.ec.eudi:pid:1"],
          },
          claims: [
            {
              id: "over_21",
              path: ["is_over_21"],
            },
            {
              id: "birthdate",
              path: ["birth_date"],
            },
          ],
          claim_sets: [["over_21"], ["birthdate"]],
        },
      ],
    },
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  extractJsonResponse={(result) => result}
  emitPresentationDefinitionIdEvent="dcqlClaimSetAgeVerification:presentationDefinitionCreated"
/>

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

<DcqlStepTemplate
  initialJsonData={{
    requestByReference: true,
    presentationDefinitionId: "<presentationDefinitionId>",
  }}
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode}
  listenPresentationDefinitionIdEvent="dcqlClaimSetAgeVerification:presentationDefinitionCreated"
/>

Users can copy the `presentationExchangeId` from the JSON response for use in Step 7 to read verification history.

## Step 6: Send and Receive Verifiable Presentation (Holder)

The holder wallet accepts (consents) to send the requested credentials.

- **Receive Verification:**
  - Use the `vpTokenQrCode`(step 5) with the API available [here](/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3/) to receive the verification.
  - Copy the `presentationId` from the JSON response received from **Receive Verification** for use in Step 6b.
- **Filter Verification:**
  - Use that `presentationId` with the API available [here](/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification) to find matching credentials.
  - Save the `<id>` and `<credentialId>` from the response.
- **Send Verification:**
  - Use the `presentationId`, `<id>` and `<credentialId>` with the API available [here](/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3) to send the credentials to the verifier.

## Step 7: Send and Receive Verifiable Presentation (Verifier/Relying Party)

- The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
- From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
- From the decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.


---

# DCQL: Credential Sets (Alternatives)
Source: https://docs.igrant.io/docs/dcql-2-4-3-credential-set-proof-of-identity-alternatives/

---
id: dcql-2-4-3-credential-set-proof-of-identity-alternatives
title: "DCQL: Credential Sets (Alternatives)"
hide_title: false
sidebar_label: Credential Sets (Alternatives)
slug: /dcql-2-4-3-credential-set-proof-of-identity-alternatives/
description: DCQL credential sets allowing a verifier to accept any one of several alternative credential types in a single query.
keywords: [DCQL, credential sets, alternatives, identity proof, OpenID4VP, credential query, EUDI Wallet, verifiable credentials]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcql-credential-sets` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcql-credential-sets
> ```


import Link from "@docusaurus/Link";
import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";

DCQL `credential_sets` allow a verifier to accept any one of several alternative credential types to satisfy a requirement.

**Scenario:** A verifier needs proof of identity and is willing to accept any one of:

- A `Passport`
- A `PID` (Person Identification Data)
- A `Photo ID`

For the underlying DCQL query, diagram and example, see the **“Credential set for proof of identity (alternatives)”** use case in our [DCQL concepts article](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/#243-use-case-request-and-share-alternative-identities).

![Fig 03: Accept any one identity document (Mandatory) – Passport, PhotoID or a PID.](../cDocs/articles/dcql-images/fig-03-dcql-eudi-wallet-identity-document-options.png)

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the JSON body using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in the matching Step 3 request automatically (and updated whenever that Step 2 block is re-run).

The issuer can define credential definitions for the following identity credentials:

- **`Passport` with credential format `dc+sd-jwt`**
- **`PID` with credential format `dc+sd-jwt`**
- **`Photo ID` with credential format `dc+sd-jwt`**

### Passport

The Passport credential is a digital representation of a physical passport, issued according to the **EU Digital Travel Credential (DTC)** specifications and International Civil Aviation Organization (ICAO) standards. As part of the [EU Digital Identity framework](https://commission.europa.eu/strategy-and-policy/priorities-2019-2024/europe-fit-digital-age/european-digital-identity_en), it allows holders to use their digital identity for secure border crossings and online identification by extracting verifiable data from the electronic Machine-Readable Travel Document (eMRTD).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlCredentialSetProofOfIdentity:passportCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Passport",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "version": "version_01",
  "credentialDefinitions": [
    {
      "label": "Passport",
      "display": {
        "name": "Passport",
        "description": "Passport credential"
      },
      "credentialFormat": "dc+sd-jwt",
      "vct": "Passport",
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "serialNumber"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "firstName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "signature"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "personalNumber"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "id"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "image"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "birthDate"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "lastName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "gender"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "expiryDate"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "nationality"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "issuerAuthority"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

### PID

Person Identification Data (PID) is a standardized European identity credential defined under the [EU Digital Identity Framework (eIDAS 2.0)](https://digital-strategy.ec.europa.eu/en/policies/eudi-regulation). It contains essential personal information including family name, given name, date of birth, and address, enabling secure digital identification across EU member states.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlCredentialSetProofOfIdentity:pidCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "PID - Person Identification Data",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "vct": "urn:eu.europa.ec.eudi:pid:1",
      "display": {
        "name": "PID - Person Identification Data",
        "description": "Person Identification Data credential"
      },
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address",
              "country"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address",
              "locality"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address",
              "region"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address",
              "street_address"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "birthdate"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "email"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "family_name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "given_name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "is_over_18"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "is_over_21"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "is_over_65"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "phone_number"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

### Photo ID

Photo ID is based on an electronic Machine-Readable Travel Document (eMRTD), is issued and verified as a digital credential under the [EU Digital Travel Credential (DTC) framework](https://ec.europa.eu/commission/presscorner/detail/en/ip_24_5047) and the EU Digital Identity Framework (eIDAS Regulation). For more technical details, please refer to [EWC RFC 013: Issue Photo ID](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc013-issue-photoid.md).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlCredentialSetProofOfIdentity:photoIdCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Photo ID",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "display": {
        "name": "Photo ID",
        "description": "Photo ID"
      },
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dg_content_info"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg1"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg10"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg11"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg12"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg13"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg14"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg15"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg16"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg2"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg3"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg4"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg5"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg6"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg7"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg8"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg9"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_sod"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_version"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "age_birth_year"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "age_in_years"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "age_over_18"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "family_name_latin1"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "given_name_latin1"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "issue_date"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "issuing_authority_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "name_at_birth"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "nationality"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "birthplace"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "given_name_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "family_name_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "birth_date"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "sex"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "portrait"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "portrait_capture_date"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "resident_address_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "resident_city_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "resident_postal_code"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "issuing_country"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "expiry_date"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "resident_country"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "birth_city"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "birth_country"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "birth_state"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "travel_document_number"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "person_id"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "administrative_number"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "resident_street"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "resident_state"]
          }
        ]
      },
      "vct": "eu.europa.ec.eudi.photoid.1"
    }
  ]
}`}
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run a Step 2 credential definition block on this page, the matching Step 3 request below autofills `credentialDefinitionId` and `credentials[].id` automatically (and updates whenever that Step 2 block is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values from the corresponding Step 2 response. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Choose the credential format as needed. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

### Passport

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlCredentialSetProofOfIdentity:passportCredentialDefinitionCreated"
  initialJsonData={`{
  "issuanceMode": "InTime",
  "urlScheme": "openid-credential-offer://",
  "credentialDefinitionId": "<credentialDefinitionId>",
  "credentials": [
    {
      "id": "<id>",
      "claims": {
        "id": "123456",
        "birthDate": "12-04-1983",
        "expiryDate": "30-12-2030",
        "firstName": "John",
        "gender": "Male",
        "image": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAIAAAAiOjnJAADn60lEQVR42qy9WZMlR3IuFhG5Z561qrp6AdDAAJgdM9zJS1J2aeKV7N77JDP9Rb3pSQ961Jt0JVImcR3aDMmZAQmgge6u7Sx5co8IuXtEZEaeagwlMxUK3dWnzpIZ4eH+ufvn7vx/+R//B6UV00xr/J8x+oH+1N4/6Utpregf8JjCv+A//JtxBr/Q5k04/R7fkZ6hvPehHzS+j3mxVorewfxK4U/0Nuafyr5UK/oV/VPRf5o+kvFAiJAHAY+SpFjm622+WOfFKs2KOI7DCL6jMAyDIITncaWkHJqmrk+708NNeXczdLXmAl4eplmQFmFaBEkWxBkXEefmAjn9wfGS6TMVp/vlZjXMTdkfBN2ZFvhP4X4FT8Rbgt8yEQYRXk8URwH+BZ8MtzPANcmubZu6qerq2De1WVB3AeZ/Nl6AW0laYGbXalxbWiy8TPpY5h43q6rdDtLVCgH3zeEPXEP4FmbT6Lcc7hh2KEpgLS8Xq22RZ1mchCEuJndXZJcAbqEfuq5v26o83D+8fXV486o9HRXj4bhI3AiIu6DxlUZw7I/ciJCa/cqImzYfij9zXFOuPTGZBIu7/bCrQAJG39zuxdkKwmPKLJT9PG4EG767Qbf0It4ed9XuLs4X6WKVLdZpXiQgXmmWxGkUJ7CXXMlhwPuHFYBtlH1vNnx8X3u/eOmas0l0QKCZ+1xu7tJ+cX/lUObcxSv3cjWKB2fjgppbFlYmcBG4XRV7BZNMj1c2/tq9inNzhP1dNhfplhd+pI/HHbPPVN7ztfenpzu40QmCzS6K22V/9Hn219xbEfdzqN1mMSsI7PzD2LilWs8uzj6HO6maxNHKJ+NstqDuNVZ6p5NotkE5kZpfPj1PPb4fs5N4yqTUKDV1ddgJUFFJGmc56LAMtNdynWeLJMnwmUPfg2DVZXM8yLrmWnF4Mug9I8+0DHYlOHeSwKdLMIeZz1aGc6egp+3n2t0Xvp06vxPNpm/7GGdOheOX+3A+bQy962xHrARys+7c7i1JGx2OUTjhEW0Ohebe9gr7/kYYOJ92XNsP1e4iUMK0kzPunQHzem5vge7WbC7+Izzb98fqSjvL821fmntn8ewPu/14CkYF5d57EqNxQbUeV9i/jElAfeUHz1ekrkCz45mQYDwHCVrpVFbwGKjuJI2yIgXxKlagt+DdVd/1TTU0FWjwAMwgPAekOQxZMojYXIpZIG4+h7u11TO18EhRGJvH9dmhNq92f45Qw0qi1jMLNimluWJ0inQ63MwTKSMWnszZG9AGb4zKdvrWZ9pitrV6dmjHBxTj1j5pz7i5f9KOcT57MyNY6kzxvuOK6S8xroAvbcZgnFkIT3Ob/ZqMn/cm3kGexHq+jW5/HAJgWj/Wx8b2CgIucDOIp/q+7+qK73fH8I2IsyiKAU7gfsqeayk4F2GMqAdgDghomLCgYUGoRQSwA97HHWNvUXB7tdVn9o6YpwDUXPbschslxZ1KfLyLnHlHydhFMsZOMSgna05GBP3TbZBdTz2qT2NfSW8Z5av9zeVsLvt0iPijU+O9D+P8XWpFew9yun/aGu5MOQvZ/4cv/S1G9nybHx1xPqmc2Zvo/58+0d9lXHsRGD2JX7KpZVXVCKoFrTgDXQWwVQRxBF+APLWSPFQgXnDOlIiURsQfhExwd+Xi376MGdCYXZI7yvbdfpPyf/c7a+tCaPc5M6HmZzevzX9w9aC0ZkrqTLxARPnjjXu8AXj/DnfquSk8+/Jwkg4nn+PRds91g0V/2nkO7rd6um53kLU7v9zJ/FzW+OghTsZgMnAO1U4W89Hd6hnOG9+KblxNVhSuEhweQjrkWUr4QyrWow4ZOO/BX4yapgO/RupWqVyypNfJ0MXgHqJHieLFQYFZpem0/wTlPX0xqgtvC7k1jpx/2wG0HrGvsWcKwq4f/1ZTPFM+2qL2yaF0HoWe+WYewDL4TnA2PlGPNtwhbwsu+blLOB0ii66YVdD4rNC3XvrcXfD9BT3hqcndGXX56HeTSufmirUHjM6UsPY/7V3AbvQm2dyhngVBfBzGnLM4PsezYxyPHMiYNicexEwNSvXD0HZd3ff1MOTD0MGfHfxR9P0QJUmMAYsYJEyQdBq9oUkVTNfO+Qh29bTrtFejoHG7MZ7RcHf6yMxoNrdMkz/pYVMbyBjxF9dsjizcIeeTomNWjDy9pY0aFVZklBPPSRa5ETlUfaNbaJQW1x4OtC4qPejUaugfAaNxZqeDG1FUHiKfzA/Xj3EfHxWViR/oUUn6Mu3E8QxPOSirJ3im2bdpLO3J4IRTCC/y0V/wtZkRAa7NZnGMbSk9gCHsZL/vuhaErGu7vmvTvI+zrEuzJJGJUmEYqkCY8I+26JV7MkTrqq21Q89ZOezCp2XkfHyVh6nnfpEaFQG3fzkbwK2TyaQDwcaquoVwGG+0WHw88BohNNcEP91n+X7nDCsxh6l8QeQ2HjmiMTykvk02ylLPjF9I96vR3GqhuPIu2Qfa2tPCnsLgVnlyG7fi01tr7et7ZtwgpscdoVijfmTd+Ln0fgu4sXZzsuv2s829w9aq0SvV3LceqDT45HWKQBg4JpuuZSUf1NDWfdfk/QrgGalAlkiJodg4EaEYIzKg9NDSGpfXszsc9aJyIQDjuXKHk+1eTU4SOw8iwNPUGDDT9kXWZXb3p8+WZQqOWB1nAwAWvBuEaK2ktmFAG8X1Y2ST98Sd28f1zIzzCdMproUfKuaMTTYGHwmtuzNKsFVR2vfI+KRpXeTCYSw+E3gvUGMNuotx2WWiD1KTHzPauHdgBgdYcXOU8h3V0WED+RljMH5QeoxFeCjQnRNzfGlxBH3d3e+aps2KxWKBxpHcRJQWDgBfB6DSZAz6K4OdGJQOyMah74nhfJAzyRCFwS+1NNEs/7SACQk482OLk1l0QuHF8oQ7AfwRwp/O3bhy45HyQvNc29WegY9Jj1gV62vTcxQ9h+3WXtqQN9k67rSt1o/A/3RjoR8z1c4Ual8URvSgp+D0uxTJaOvNyin1COlMjrJ3Jj0UqKYo4nlIyF2J1mfg9x2+GZ+FMH1XyGIOOK+BiJO4bYdvvrm9ubkH/C71TRQGm+36yfU1gPmuu+3lkOQLOPBSyhy+igW8lFIyYZKA9orSNF1fbpebLbiXwngkUqIKdKfTgC0/pjUeJSNb/JEx4pqPMXx+5hvareSTbHknx+Cux4Eazb0Y9OQTTaEyC4ApUm9xpA9e7W6MoVCXK6Irtd6iM1Tae/vw3E8Zr1eP6QDuxzVJx3IXzXEZj8loC2vNxqyE5zVOC8znuolN96KnS9ePw7bzYOC7XX4vNMs8x4hxCk+h9IdMalbV/XFf397sykP5cDzWbZNnqZQqElFbD2VZNVUpKVwPopEmOWxa1zVJloLoLJarKEriJFk/ubp6/mKxWsMjF08usyKHT9E9JtBAs4Vx5BDtqMsfRRxsFIJ76mg0MROe4PO42XSmxlPJ596QwV96jFGPJoSfI1ruHIb5odSj2Z7ZzJk4KE9ez8xzaJ17PYI6bgKmjH3bBvJviWUQRjS5HWPtjMHRDu2hb6GcD621p7LOTOB5cOZbMJYnZ/qd8RjuHVa6Ft11Ek2dZvtj/fZ2F/AIMFGAuVi2WuTX108vt1dRGB4OxySKVRjd39+EgsdpVh0OdV3VXVM3DUjMxXZ7AYoqSe/fvv7in/4xyfIkLz789JOrZy8wuytEtsiz5TLFHLe9FDXac+HZock6vSOQoM9d+29BnJPZ406/8Clyq+UYwvXenxLVRpuO1+LUufdyK/TO6cLYlx+1035Qg433RSkdABV+dFiP2R4/rKa96ACfw213NXw6YDPLyUf/kPtui68YfVvn+y3al4x3mMLpQe9CvFc7BWsPC7x3P+jy1Jan5uHhtD8dr7bbOA75crHZrIpFsVqvk7hoQUUF/GK9/ubrNs+yzXoFbk3dvA2jMA0X97s9LO5yGLq+D+JIDOq42932rRDBm3/9dVosozjeXly8+OijZx9/fHl9nSaCfAQuuRLgYI76lJ8dBesIjSH/x0EjNiXv3LvwxyL4OADp9IByq+LUzyykO99hPsYg/RAK549P8Cxv6P0cVk1ttmKMw5qdEHrSwLM0H9e+Gmaz69MT+mQUlZyQs3P4fYWt3+34GT0/pQ69NKIvUkqpRzeoveAkR1KOBoQeSEwjciXhTaKub46nDp7y7PIyjcJ+CHm+AOlJ4qhu2vK4BwO3LfKuad/evFkusjAIjseTBA+Rs0CzRVEIAb5keHP/EOx3m+02SVKwj0kUffnVV/vjP6+Wi8PF1cPd7fFUhr/9O/HTF+SFjmZ6Lle0gdw7ZGIWjRjV2aSDffd2wr1Ke6FGPvky3E+Oe/DWis1cCm3QhPvhSesTzPyB2S6MrA/OZvSCsKyq8RmBC7UYR3pKfHuZfDFG088cuSkrqM9Cy2PakI+Ru9n6KM8ePIqk/aYkipUtd09mVYRHwTB4EPTNAB4b2MG66eumg2fGcbDMUkBCV5eXdde3gJ4aUFV9BEsg2cCi3f39AIavlPB2LcB4iTQdUFNpmgF473vZg/bTQdV0WVY8v76+ub3bV02PIcWgbZr7r1/1baP7/sd/+O82T57EItIolibJBK6iEp4I+afiLEA6PzB87q5zz2/nFGhifgDGRHS4dbaUjb0q90Zn+coxsKQnadRTxIPrR5F3NpEI/Miu9QVAsOoxzSgwCENRao7HUhDctfEyYcyrDSDTb1xGewqu8DFO6Uc2vUi49gPp7wYN/Dxm/s7E80hYG2XLmUIfrYKjo9pa3T8ARtqD06cVb7s2j4LLi4soyo51BdIEWmq/eyjLE7z26mr77OpJA+KSpnmaVvBiAPkUoA8DcSwP6/UFgLSug9d1UkcLppNA7O7uvn71pQR9GEa4gGHIgrA8HH7593+rZP/JZ7+9vHyS5sVmvV4UMWrQQcIhnkUDxkjXGcTR9n8kcGhuWWv63ZhyYiHxM+/FURMwSq/4iDkn+zVbdO3isW7/J+PI5sQLxwUxDpvn4oKDdGpb8wtu80FWbxFXAAWIxItEyyk282/zP7eZJ5Lo0fkk7TwFc8ZYOjujzrAx0j6RaLz0hFPq+p3qilxSNXcVtYlAcdqHdhgeDqB2hjdv33Im0/UWbFZe5ADPQWscjsdBDvvd/nB4eHN7V9Wny8065JfHsrp7uH96/aRYFoB767o5VSc1DGkc5TEAc12daq0keIsRgPQ44lre7fYDXS1YRPhoNAJCpFEEz/mnn/3smy++GrjIl6v3vvPJD377d7/7vR8uF4uhawfUeT5imhGQOOd+mMLBa3ugzoNObJ6t8dNcY9DBemazQLu1cCZtKL04OHe43c/zPSbYcE/Pcp/QokLwqLly2oZ+G7gEGBdGaK0bw92n0YNWsFw+U3jibYNp1jaPuU096Vft8SdHe658V8HP7rybKjNhL89DHPOCXCpWVsPDrgIFEwQR4CDQJEhlgHuO4iTOqtPN7dtvGBgpKSPOQrQZkoi2h93DXRzwIs/zLC8PZXM6RSBSPAw4X2ZZ13e6UwOTsWAgpHoYbh52gwLZG0KRgYk8lKWUcrNabTdbcCNP+y8bjD6IX/7D3//1//G//uh3//CP/uzPP/nk0yDUqldj9Id8aS3cJpm7m7Ioep5w5jPe0cjwMUF4PaFMZXMN1g3U+l0e/ZTndGEMPtd6o62csKGfIuE+C9H+HQZhOG4y4AkxxTjtpkvtzDM6zczqJquxnMNKClZQCmlMJI0OqOcOOodRKe9KnQA5+DeLxOt/k13jh0ApaMdU1w3HQ/2wK8GEweOr1YqhjsE8YNtUgH7SFx8Ui2W1vzuWR8FUFocRT/I4oud0XPb7uxuuLvG0qFbonmgRAyAtePNVlreA5SORxgF8WK9U3TS742GBgpgcjqemqUGMwFhKuC6ktfdZFIHQNHX95vNfHW5v725v/qv/8J9++tlnSHEjeYInKSlNXpq/Iz7K2VyRM88TYo9JMY9Oo0sZ829dTY/SakmhM4j/KFLvYnLa4xf7G4fVBi7PPvEAwTcPpsTnFDpwem9CeWp0KBzBh2svI2YUn7c2liKvx7SdiZ1RAEx5gFQbM6fHFeQzp+ZbSURguZta7vf1qWyQ1z5I/AgVATaHDeYoILLa3d+Bqcry1WqtelA+JzADaRSkAZcAqkDDwTvKTralCBOAVkUSwYW2gPGHPtrvLlabZFkA/AdX8XjYiSgNmAKBvViv0jB+U9/1UuVp3LTdqSpDLuIwALmFZUjiFIxjVZX/8Jf/ZWibZ9dXz5+/r3t+LMvqtAc05iAybSkl88S7WI2eETyn0PBHgGEWKvKy3eLbxGtOQXwXf4z71NLHsQZL9DMOozBgifxNYZwrIyTC+IhGk9lEn2+wRuqwu2LNfQiuyKxOCXpDbVFWqtBZYAEJni/9RFKAE6yUVvosbK/5RH+YJ6OIycdBft7cHo/7KgiQdQwaKgnDmzffwL7CEYqCMIliARbotO+HVosAzCLXJYOPYxrgWBD0YCcHkCauEgEXBcos0aDEBtB8OgrE6VTmcVikGaC1uj415UHyMmBylWdwweXpBLheStUPEuQQzOKqyNaL5f3uEEZhURRxmoI41vv9v/78737+s7/lIgKH4ObNq1CovEhhjbASJgjHEIF+RO3UpvDAJj/8WDk/02KzGI1mM9If99N6M67WnKjC57qKz2P51pLNYmKO8HGe0hFTeIKIIibuYKMV0phLhGHMbbkr2hlRotIjq8wmhK2GVCYDJIk9jBoRw0EYmw74SC8njxzDTgMW1XQDGghzcxQgF9ylP6cMvnZUWg0+PC/LbrevwbAEWp5OJ0RUYbA/7tM4FlmumMqT+MlyBfppVzc39/umPgktl0nU46cNYJOSkMOv4YNRkw9NzFktgrZXgLDiOOoGuTvsuqYBnzFBN3M4VRV89iKJD+UhhI9DzDrUoPiUPpRHpdZgQcFWFstFnCTwc3mqYUXBsfyr//1/u7/bw13K7vT8xbM8f0YFJZIOCDmC+swgagdsRsit/Mgy95mW8xAQ8wKMozmdQknci3dpL4jF/MiEl0KeXnIeP9SOIhZOjCLLWnOWjbuyJxAjZbWRC0ZJe1BGTDSx7LwwvauS0JaAYgpqKFgJKJUcAypsCwX37l5iek7Knqq1wLHr4TpBpKIYy/FQvETALaNMG9thaw01awcJ27QuFnDXx/IEUlxkAJ/Cq6un5WEH1mudpZsivlitejU81D14dFGgY1BaLBhkXLVDCXa0by+ypQjjGglaAxymHFy9PD5UzWnoA9K0jRy4HqI4BsHNw0i1fT0AFBuYAmvLQNxALWHdI2cg3MfTCcR6I5YgxPsjIrxFnsFC/NPf/fWbr16Bt7go0iQOttcXaVG46jbNPVeL+8EE7vI2eh4wndKRek4TcnUQXt5HTFvNz5L22vqbgj9KtlFgjLw1oUbYprll6POJaYOXEKqRGO14odzUXCpLi7ZFfXRT4/u5wkBtdZYTIMuqUwRJlS06ReI5/gDaBwULdJEmLhxSz7FcEpWXIoYQMtlIsBBqg2BRuAguO4qiJEnSNAV3LqAIW2DAolL2fgQK6PFUnU51GCXI91MyB+8/DE6nCly6dZY93SyuN0vOg1OvAEdfhMPlOurbDLAYXFEQxdssVjpLYiG1qPthESbBZrmr2kNVwWe2LT8AyGKozwA2gQup+haXFG4OnT6dRaCtNGjVKAraulFaZHFcgb/QD1EYgpgeQXE1TRqFYJXBMh/3D3e3d4Dzrl88v3r+rGuHvGB4aui0UyRVID+fTzm1kRFqqzTYO+EPHzlzZ2ky3w3XXrTVAjvKVHDn5amJ3mWiAXwiWNlYmPdr9+SRhBHKbuDzhKDHHLPRD/OfZB5fmJC1VDaUrKwESWVLSakWi8iU0nxj6Br+pLMse3Og0YtErR/Q+ypX20je1zC0sCVN28seRA9ECgDKQqpMsySOGGE+YZWcEnRIwbHf3x/x3VEdCvjheNhzKqcAb+07z68+ut4u07gdVN+3SZGvw7wso1MFuIqDPQJJKbIEkBBH2CU68h6OTXtqUHHeHMqvo+Nl15bo7MlAA4YA2UY2WCR0HLIcNdzQqw7uKAOkEIlWwhXKVRyWpFgqAPOIveCcaPQueRBFMfqgff/VF1/CRywW+dW/+wMKjggDXHAVtQzo+PFzlq5nlc55KeoxsueeNR2NonZO+znV0DpTeqTgO08djq+hbM65Xuy8nhQDpODOGJlSemToCRQV44e5RzXJx2jb4Nm4+9KIFYgNWThUR1bAFFaRguWjx+gZ+JCiJ9Cfyig6Q0An1WYSRRTh56DWQKpQuNQgomC5WKwB8IhARbFC9gDdOUgnyrfC489DLgXAJNiVOI7btgfoA+9RJOCIqW04fHKZff89eA+2K8ESXTy7WDaHY32K01CQqlYk57DbQZSkquslvHsvD2V9RFZDc1GELy6KsukeyrpqQEJwlUGQDqcaINpFnjSD0rFgAzo7IR+COMhoSWEriigA5I+YcaCTF4LQyDhgl+s1yGanJBwbcA/efP1VWX5/uVzDOrVNjbtLQEGLyYueF2uMOWKbKlN+zpZPyb3Jz3LxReZ462P5EJES+Syk4REYjGKyPIUZIHPwe0Ysw8fC/eHoMBLdtuFluuikcghJWXtGishKB8Zo8GdUQQNJFgoQAmDkpkijqFB7aQDTajSVzGk4LKEJgzFPFIaomcBRB7+ogaUFf+mwb9oWXH7Qb3FeZPhWfMDF5miJQM7BhCE8F3EQVW0D+gZQG1xnW1WqaxnIlJYv1sUP37/45EkRqgFA2PuXy+fXVxG4f3kc8MsAba9EqgvWe4Uc3iFJ4Q6wEv+4v3oC8ElW5aGtT4DtQYHuy3p3bGp0+GTV9fdl/FC1sD6s7kZLBPKJtYqomWSA1iyopK76AQ1lEMRJCr4oLAZIP5pqDvpRgPW/f3vz9eeff+fjT6u6hiWO0ywSCXHF9ZQSZX6Mi8CxchykkcvsA/QpiA+CIF3jCW4C8cIJzFnMkyI/kwnlnrM3pnscU3WO270gaXhze28iRoialXb/0TEmvE22jKRmIKVjzR+BpgH/IzavRVH+by2v0RanAHjAVhRgwkD2YJPArwY9tFguADyFgEpgxeNotVwuswI04eF4iKJvAIDXh0Mg+7xYgukLMFwQw5/OldAdkzEDjRbLXpXlKUUWXlCXZd/WKMx9Dwrp9z+8/K0ffgrO/PF42sThs2fXi+W61yJIn0dx2jelbgBCYXMQ9PPDWEURHIg4K4rVOkT+uupAqqpj19UtIDgQ+FMDuK3pQBjAJVy83VVvjvUhjg5wGojtBSKEsVGOrgGepSDojH6nVTzVtaDql7Kq4f3BK6m7DkDk7mH/s7/+u+pw3F5st5cXiN26hlNIxuoSpx0mvgPFANUsNj9V2VgmsRNBgsvcNmaYMoSjz6b5u6oMuJdXxii4cEKm+bcGrlFl8PDrb16jSlKkWMjISYeUGGl8xVzjF2WvU40qlopclB77GiAciBCZioCavARUmwfHEkQHKb1BoIcBTiRsSpamVxeXT66ulqs1eO7wgjhNVsUyDaK6qu7v75M4vbu7f3h4IKuMJYAASkAU4jglfYmLiixhTB2Ed/sHuFP46B7fvwJZhytcxMFPP7z6g8++89H3vtdJtq6Oy2WRrS9UvIjzJY9zsKSiPrLTTvcdwmYRaJuI7+NljH4reH9MJ4u1rA5YZFGUIGGbVds0FegbzPe13fsX2c2+PdTtHkAewPMOLqCrukFxEIig6WUtUTC6HmNltVTH8giOIaC0mvySOOrLpsGq7EBUcDjK45/86R9hv5u2QUsK1jAUlnBiAn4UdbQ2UdgMmsP3XPv0U0UkNO2Xijm0M2ojn1Nq35MLzhjj/0ZdrQlsyjmC814Tfv36tYkUKNd4Z6r2JJpWIKakNCAYEA5Y+hC3gXK99IxQkBBR06AY1yiMKToA3/RfSIIFcAbZvacGo9t5loFIXW0vN9sNKC146zhLiywHT7YqT3mewxX9869//eqrr0DqQaLozeMwSuM0pQp6zJqmIixE0AHuqStwGJuuu3+4b6pagaDI/tOnq//2Dz/76HvfTa6ehoNaXj0B4eXpIihWLF1hFxuMiEZYWT+0YAdBtuBYUbk0LhhoGUBGuBJRh/nTMImSIgizuC+LfAH30TcV6KHtJn960dUI81sAcCBYp6oDyA9ycWzVru4PdZMBBmQi6eR9M+wIU8Alg3FF71IEAL2Gpj+BGKdpeVwAwmtPJcfDFGoF16Ydk8lQq21gcUyrePWsfEY98AmQkz+oTbTBpk8sO597nYZs6xPGPdqF9fcmp2GsP7Sv5B79msQ1BJBL+tZUDZOAYPm5CI2gUFskTOqj6kHFE+NfsMf074D6LIkgQjMV0WMhFq7Tq9wb0DMRTAiuNLg/VVOBIGdZXuT5erUG8YrSBH4ZxUmepnBRgLTgnaumXq1WIHOghFALIhclQiCGzj66kCHokmFgNQCqCh7q2u54qg77Bzju5X5/GfV/8qPv/84f/B5bPRnglVkSJDmuUBCADOmu00YLxCnVoWWOlo3eIAc5A3gQpcgVVAAa4XMjBaLS1HBXok1VUwGujsIY3de+j8I6X2aLtl8twRiiV9uC3qraN4f6y7tTFoB4dSStumwVmD8wSTtwEtH7DRPAXNTGC7Sxic29fXObBGK1XJG9kGMZiBMpk/R3PtvEjSPGLfcbIpm07VSA6bgnxl+hyiK4QdDT1B9rJFdJyq8I9Y5mIaNV1MRdgL8G34/QjsYMXuHV5VVAUmG+YmpWhhomIAEx/w6MlOAfIEr4CAbNSbICKhOmBznpM3htYKXJfFFwHf/CAwdHu6pOgx5S1E/FcrEsFkvQb7Ao8JlpkgRUsQy7leYY3AbLhyFaQVhDuHY8GFkNwD/UDbL0sEyLcSzbAv2RZ1+9+ro53P43f/KDf/+nvx9cf6CCPMRKeZDLwBA26DAqbvsFoZ219fFaTUEeLgwnzTB6uQYHIUcHAxBYEMK3jmKBmZ5ahC2Y6WHogkAmWTHYwMpwKivsVsb5ro6XdVsgbRVsZfigh7rve5BbYStiVnm+yAv4RNDlD7vdV1++2q4L0NGJTngUwb1aOyeEdn6YVyA9dsawfIjRIGINjWU0jMrMaDQFC6pwmfEPhcsqvBiY6SjFtQHOxq8HzAAPCeVX+3H+iAQ8skjBNf7Ohy9D0km49ygvhGYCZ3xISiJSRdbkCXwOWkPScMx0hGMUa0FchZiA5Ij66AVOE1qlCJACo1CATTDgmaVRmsGZRY8MZBzVH56dUTxBqJMoAifT4Dfzv8GGALF6JUEAOYU6wHkERQGW9NWrL/bHw0/fu/j3f/jT7Sc/0FGGek5EJFKCyGa2vsqmtbEhSIjBGTi7AYUTJZV49hTeg02Fl3OK2w0DHXbsfiTiDPCdiAchQXu14EOG6AmDtlIhejltX59kOuhVAXYsDKo8ClYA5LV6va8U+KoSwTv4LHmcZGGQxZEc+hMCty4h+k0LljXP4zimXZY2PGmqvDWbKqWm9KrJqgnlcS/12NPEippXBSTJj0L9jYIlvJJtWhnKkmKBOHi/TU+iQa+2J5Ngno2GUwJOuSD5pNjCj16+DI3qIdGhHwJCMwSbBBrB0Ogbwa12MvJkttnIDEE+ekKI/zCS5LiDDg0SGogRgoNuCbBdInV0sShBm1g8cW/wI0AwEzSy3JTsUa9Ie/wGkyXoJbj1AJA1rVM71KfT8XAqi4j/zg8/+tGPf8KXTyUjyTA5DGZBoaPcGpKKyXDQQZM22wDLDZ+B12aKbKRrSWG89yhRdMEC1IlKVVCBnCnZBkqGfaewfxIyuxKEreGSbEMoKriv96V62DR3h/qEiSLUkzHZBqyDxdMaY7VHP9zu9m/v7rMsBU/DdNLiLuxkLlcxr/B9auSBF6pn8SXHLefCpysYEQUwidI94A56pfdG5aFgDbzuorJFTixhO5CgOLLqgWnbiQe8twHBAFw3nA3r32E+RIQvnj8LCIlTEi4wCJ2TS4fmjjSRcFJkDoO1SXzkZbnaEk+vmBZTU4tBv+cHAmYUL4GGVYx0tok/aHM95itkRFgzWnnAEuRQwBbCbXQ9ntQwkK0qywMceKFUFiWXyfD977y8ePkJA3UFakaTReMTj98WRVJIBnQSGFDbWtUIONoFK4gkbVhcaEvlQCNEIYb74FkhCDRILbx3Dv4D1iPCxbQ1ZxUWRcuU4n8cuyOZIDMxOT69Gt6UzU13qgYGrjHsCRqaIAIHBe56s1jg86X85vXNssg36yW4wML6gBNvmD3qfIh5N+v+Sz5yi03/DsLdgrnWWzYdhFujTKp15BI6grDzMnVrSmxAW8tB9knYx+TBmfMvTL04kQXatim7tqYGnKa4ioXrzcbsrinVMToIVYYRMTFxkbXH1OFe/skGICw2VPQ/mGNhE1CaTTqJPgMtKyK4BEEcmE5u+23Q56IIBE6mqPMqOObchPXHZggxNbjSYLnCYHc8vX37BjzEy/UK2SpN++nT/KMPX4rFRlHix4rqGFa29PhZ7sqFZkwAiBrSguo1UiV7OJaWO4a3CI8P6D/aZkDwohjzUfC6obMRF9Cz4OT0fcgH8ISTJO56k/kT20Xxclvf1vLVUcK5ottS4MxikJbzhEAtSO/D/gjuZdu1UdegCy74iM05E2MXR20JJEx40JtbeTL36qpGXd7e0epdixbBvEa+QnuMGkWJNTTMXd01BfgYYZgQtA4Jspi4ACwPCFbTNWVTnfq6AWRmu81ESXzODrTk3qn8UPv8WdtwwFHSxsImNimvUeuqKYFpY3yUc0YSWIRNghDGMQPLR2PJhYXqhhRNv8IIvkROBKMILF6RlIAE+64/HI6Hw/7qcvvk4vLu/mGZhZ989MGT5++xICYrgk2ItOEaKscXN8xGrcf6sqnTMArTQHCKo0eGnzhQ0IHMDn5jHglzkfY+qZcvqFXKm9K5DDCobeOHEpQr3DBKSxKDDKVx+GSZfbDq7psTsnACAd7JoCiPrcB+DgshwLDogMprMQB7sqp7rEGwvEnBxcQetu11xuPiauJHPvjYBFOfFSqO3a3xXSQJmxiZX2DdEGZVxzpOyesH7z8mfGR6USNIQmouODGACquyayqiOeFeh9or/R+tlTBhCv3u7m1zKs/I7hEuNOx9kyyNTXzovPGQ/k1hrsjIvlFuVpy4iTZbNUp6jNK2lGwDScJkQNfr5iTkgIHwusFWVqj5MLH7dLt87+nTfL0FBIRIwHqSXsWuVq6vkrQGTvW2UYBx76WyfxovSRH2UkbUkIBqkL7DLrCyHZeD6Z5HwAlj5lr25pnU30CCt4MuKWOxEOs0vsyjVKhd2y7WawwaaxUHAcovuWBD3wqsnjodyiodpDEZNhVtfSF74jAnzEzdgRCWSUxLbGh1YsIqFpYHWo0hrPN22S7SZZowYQpek9rqZdMwUTL7wQYzYRd0ilzSuVUDMRtb+KY+NhTHmpVY2NJVMbLZvVjpvExxTDK4cjMjPtrDXhZA2rAeH+uJDLdvioM5O+XgFje5H0C8fGzJpxUJFZoMuA3YKtjspmoeDoem7/M0Bw+r7brtanEVRhfbTRgnSN+nWh3tdU3HF2ptvWtYuSCcKktASgJTqkK3JnvUcyLUPuuNnoZiR+JiHW1QMLCgzKAxywvCs64orYNB1wHjYQAKlYIbLuLwIg+fFOHNXQcIqzudMBKGsDjAkG3XgCLTHbvbHbPiUCxyxzzjgZMoCvIwgsNO1rjxv0my0Ugx7rxxr/CF8pfjatvqBONkz1qt+mx5y6ukcnk11g8zu9HCxJ1MCyBstzOVaYXUr1N7LbothjaVqdzXPa5JpLEChssxBn/NjYyOIHNNGp3QWP4xOqzm3sOQohEOvNvY/rQIbPQFwENRuu0Gk2vCM0HrBVK2Oxybtnp68Qx80a5tlkl4dbFabLc8Ts3LrQ0XjiZHBA3YE27dPzIf5FdqIjegJAUgIr1rqmGCWxpdSxO/ppIH8D/Qbihp8loI55HMgflA3UvUr4pMI2XGTMMsjGYE4EeKKBTLNH6+yr+pGKJ3ha2cWYdEMNC8LfZ+a9K0gAWC5ao6sIe90SZGRkbMGIhJh5j/KQQY0LE1j5LgGemzy+6iPsZrd1ThwMJO43cKPTeYfnGQ9jqwo2obiGRHV6VsDE2ZFQ+ZaYPoSZZtS8nEJCvMT/K42IEQU5twJ1lOEswvnWSNfp/hPgsT4p/CW0Z2DavNiaggVE8BfxEQCx4DdrB3DBPYgGgjLDzW+mq9KtKkrmtMFMJxF6ZBcqyF698u+KxgXJsucLBGEutZMXYKpySkIHuPSwZCM7HH6S1QsQkKcfUU+4vxmaYzMRhBtHoDkfFJgLDehvgxaLOJC0qRF1I1qKfhOtMk2ebJOmnA7VIdaxTYdgBaoM8wAHG/P16JGKUE4EKRcSLTSsr/G3IS2WLbo5jZOIrRWEZfGWRNkRpLuMVfkw0QYrSoFGY0OxVYrSf4tGF+Z7SxBHvqz2nKhfWUFbB1NOMjIRm+sRzHVqmbSzSIh1nNybyae8O5sJX4zPMo+fQlzvo8O9eTjZLkShOt5aVjRbJp5IsYJ7QQgQ1gEqML4IsOQ9gysIygANIkatpGItG8X4RhniJXwsQMMdpuin+E4x0ZpQ/SqbGRA0qyBbXCFtbCSQOnTyrrsRDjnuI6ZDSCmCEiAp3UGnq+6ls19JYZDfaia/iAcobOEZoYgdctB/gpjkKFYVcNP+RpvE6TRRR0A30mrXQnZVk3eQrQkB3Kw/5w3LRDtknTfClNdRiGgnsUWGnZk/gpSHeDzxi4tC0jLZ1cmLIFawyN/jKJEgtBTKzb/kzKTRh5cyCOW+b92AeXTcFWI2/SipeeWj4oG9TQ4dgNxCgNE8A1cJrs11TxrCfihuDOMeReYxs+/2K+enMBKqbZXPasGhyrrPmsZafTfmQDpYHYQgws6JoawE5CqSMwYfvyoYhFml7ZwKyhKhjlxPnU/tRUblJ0k0L4FDUgKGbRt92WEPkOyHgRtp8ZV6avreo6PAlhYgTdTkhBr3BQU4dXt56gNQD1w+tATQFy17wHDzGUcNmrPFkm0U5Jc45NAWIH70QfC87J/uH+4eZ2fXGxurjkJjCB/stAfXkxHInMt8GwB0ngLLlJUoUTrhWFKAY+TO084bMCG2UMDGIjUTNBcQzRYk8vK2kitA8JG5nXbF6VTzgzAP81pKlGfGo+Sc8Kx4D+JD8e0PGLccfG0C6uNUEorTl/JC8uwWXfQzgQKdyX/a1wBdW2cYQxG6Ygx/2SwjIB9ngUPQ8SSsordO8ZOCbgOcFCJlGCxaFDH+CEplRbB5C7lrcmgk5dEKieXJt2AkHgwD0CLTpyTAeBbeYkQnrhQFdFRX4YVQ5YlNr5MEFsingNNoGtZ51b9QAfGZABG1HjGyYGFWIzELyRRRbDd9i18EgLnywx/gPvAp477ibTbV0pLK0WRZ6niwW6EyMLbkA+5UA5pL6npDdqs56CrZLspf3BVtE5mcPDiXeL1bccP49soY3xYCoO4biRKkznGV4KZudsftI2MDDVoEi+iJgNCs1KpOlfodd02RWATXbW5yFaAM7HtrrCK/LnowM3Gk/m0Pvo7k1hWGGjVDOYbnuQ2IfHIIYJxLnQH2V3Qoy/45rAclVVDZZts1iAM9WUx4BvoyznUeTaJrqBWLikmgrXCMkT0DWfa4tDyBKTZ0funiCVbBoNm18RZhBpThg/wFE8g7SgHi4qosuWPQ8THvUCaX094VjcANj0CbBoRYnCoEjioTshU57iZKHRD9pUEsB3X6wW+XoZp8lyuRRYJmnpTUZupJMuJPC6L3RwzP8kd/i3pH9S4dNU06KlLZpS2nYYA6/DVLhQPi2QIN9DpKNQRkGgDP4Xrp0QgpSAUvFw1xiJFLMRESZXKGaNsVwbBhd0EJaUxcYeM64dNT0mXBcd4cXiJ/w+onyjnJyjS6JDURhho+5TUaN4HKzF56GiUAPRpCMtEyYOYKo4b/v+VO7yNL189rQ8lGkwZFkaArhmwo3woagM2KMx8myUVhCZnBmZudmcOPKmKV2tCS3BwtGYEXNI4VuZfDYYriHifYRaAFuPYhE9RuTDmEeJGDpGhFyEIMT+p3ytteaCNOEiAfHXfd+3FI81ujvGep4e69j6Ic5SsIP5AqBjnGaZckOJbNGToR8QPdywU21NAT1qIRl99dZydlb4wHWlFB+9kDSZdExOEzkWOF6BoF8I98LgdgI6fmTWre1ARQYIN8Vm0lTbwmm1UWfTG4Ueyhnpr/wMi1P8zZ59YTJu1ssTtneSlUcH+Me0H3NZTeGFFebtcYxm1QZrCGu/+DT0gNuO/XRa4YojFDPdNj1SZfqhbatFkZzatjwdP3yxzbMC09smp4HHkYygli5nSckZpGRxryUBWVtlYl4CAZMifgiVpJEZdQeFapQx1gk/NwOWesUxxkLJPoLMIdnLgFtkNSZMNtoUktCuoRKjDIIJ0eRRuF0k942ssPxMh7DbSkVECgEnsO2GvmmKLF+utiAMVNZLGIk6x9oKTkXEX1uRYGs3kWhuq1lMIYvCigSMgPTWiEpCa/jtVB0Z05FTbuLGAXIqizgv4jgP4AgwcorBjea2hB1UGTpKIZKWkCQCBx/z0CSsUs0Ei09je85xlh/mYl7u2Wvr9vhL+LEIH9F7X4GziJaPQTjK2kPmXwPFAKheNGjqGompUQIKIU7g4CfffPPmerPMiT0YpyknrrrNr2nFpy51oCwi1CuOOgMWyCbcrM/ImUkZMSLWgSCCFUPrlnGi0CCcR6iOEyBZ19HMBoRipHEGZJJxTAric2inMNEMYtNL6foPkhFC6jn2YBY8i4OoDXvDiFUK1BUF6vDVp/2+rSrkkQo0+tw/0gbzIEZApwyslQqDMfBmqtMVFZVrWwNDBTFYWe7qXAiWjRZVkviZ3CUZ8ChIFkmxSvMViJeIYrJd2BNFYMU5IgW4WTANAcZsJIPVaGu8NWkLPkNhYfLIZZ5iTkbN6ClK4TI2bJb/OxMVZhWXYO+StfHZJuxi4As3MS9LmTKBXWFmk7rkBfEZ0RjwrpeLKIQj3PWwkUGaLapOnsr9xXc+hDcpVss4X4LAYdIKdXTAlHZMEyIfG0BAndmZsey0E5QHZCY/qCllgXqDILWNS4OSB7smCIk3laorEqxe9R14fzb0itFmHP8E0qf7wRRBmLo56TqGoQeGMF9RvIyZoIdAoqI2fBZYuAz1ALu/vbu5eXP90csA7CxF0gQmIsfuCV57P82Mn8sEdfkURltzgoIBlcfgOqgo0qa+QSlXRUW6ipQYqjc0rNYpCbNFWmzSfBNnOZVaUiwMD4Qk15oqquGehlYNreywaSLaQRc8DenJZz3gbQc/PoXO+VhExOcxBNfjZUzHMIfNJnUl3EMzggxJtAXq7izykR/lt0E0bw6mREmsWpYdmMOmrXf7B5qPIO6o0AiO3TIv1hdXAN6R74aBHWZ7ICjhUjs2cWxqEi1sRwXuAvFSuaiEZG2DDwNaF9gEC3UVUeC1avXpqPvWNGx3s6mIwBklQZRhrhXwGcfepxjxAxOJx3rANEccBjgQCo1PaLxTzFSiO9qTJQsIrqbYz02dqqqt6mm8ABISx+kS6mzYAps30Z9ws7A4w1YTGjIjfJBEgQtlIJGbaOuwtNFt6C6mYbbGWbXFMsb+TrFhF5vlc8eEKgbbRvZNB5eNjOxmamPk/MOpBm2me5g1EJ61nCkeX2ON8dRJgsRv0FkOujCvxbPj6DvFRwlVehYRC2TbI/UATm7T9nVTUyF+sz/cb1fYGSGPlmmxAJdQmWpxInbha9UwJj01ySDVXYXU/Yv0BIB0RyUx7UsAt+IYukGaMcqcapjMsAsUsq5V2AfAFH0TmGVGPzBEXX2LSBleq5EBgHHath2Q28uVK60DbchNOhStCTj5rEPVAa/H8SoodqFou7Y8Hoauj5IcPQCiplmx4iMJhvuZzP+38wFt9Azzo8ZKKW5q95DTgI+AL5rlACzgO0lpxjYKVmjLgsiwYuhlGDoRDEiHVLKvu7FpkTAhCjabw3EuWCa05DMQp+CnDVDNXyRm4c1zsfIFN9C2vnb2kePsxfmzQbPgmQBhKodhfziANLRtczzsYUWSKIbjvMiyJM8Jd/co52BBAOQcdkPbYfo1DNumU10DK9LgMKYuioICOxLlyAyLUnCfJTWaoOYXQqFjOJiUBogPxxm/WmF4qQP9j6Q2EB0MegkMhGIGWcq6A+jadX1TNx0S203CBN4cox0CcBNrJRFLjKdiMsc24W7T36h7AM7nIsKGSsNw2O14CM4igBmQuXAsYmbeJCuv7/ZZ3f00bldTCnpWHW9GG05kKND/ZoiMMAR0nI0eJykNQiNWcRCYCjTMK5DiCnrDgIY1CdBcBmP2OLSEC+5Ibzb4bmIAIweIz0rHZprnsfiMtOh36ith++a6YCibRce4P3vZJrhtoAI2twdbfipL9Pu4WlF051BWJpcI8GG9WsRJZgjH8OnVYX/76tX+9gb5j1JVvTxVNchTg20djtXDA1jXNI2eX188Wy8vL7ab66dFsYCjGMQJXBUy3bREO4qOuSQo38u2wmLKYehPJaKrOOZpJjokU/Wglk7HpsIC7rv7h8MJy+7hhhZRAA4gWDekZIuAqvM1ld6qiDbK5JxiBHXUf47zbpCREE+eP79+7wW4Jhqj7Bq545abZIcv23SeP6RXU13q45pT7s048lrp+vMl+cQvpQofk2Gj3KOtnMGiFPpoPHJYMI8+UkSBNbSVEUFATkjYNl4zUJYiSsJWIxqB0S6sNY3TEzOp8m2i60g6lj2+a9IQ1+M4KLryiVEovD6i/sggE0pFTYLtOZq2iVkRJHiUQh5Sa8b6BO+RBXK7WYH/AiZsaORxd/f2iy++/PyLw+lUt92uqneHiorPmgNgl6YBn6uuQEaDy3Xx/nrx0bOLTz56+fKD95brdXH5NIxjzCUz5N4KiSJFEW3URXBpXXlqyj34UTpKe3682x0eDvuHfVk3AIpOh7I8nKqux4J6EIlVEi3S5Mk6e7aIqR4Ficxw41kYpqEwk+3QyHAKXSKjn4XYnl5dP3/2/IOXxXJJVSqhDXGbwYK2C8PjemTTbVj+hv6aZsUHA8D93uVOChU5ApbZ5eYFC0eJGHOF9Bh6l1pimJ5a6AhbDCt0aIh0bERSltZuVIgQ7+D4nfflHdvXapdv114/41m4QptrpdSU6+o2s3hn4zS0YbfgMYXr71rMjZn6NFjqHvE39kPL02y7XK+ycLXdCJzyrN5+/fqrzz8Hn+rmbn8oj6e6OdVVFAAi5ZIPhW7TSAU5OOl4kI+n6vO2L6vTqTxW+4eXL188DcI0A1hjwoQ9Qn+ATXUFl9CDNQWdB+JclY3Sp37/+m7/T1988/Z+9+q+vEHRasH+EtTFYiYQrCxCt2+RRT98tv3eNZZ6o1HF0gReYBdTtL4xVk0C2JIU7tDwyiQUOI9suQ7jCDYmTXMzyG7s3+cmb+hxIpqe5vk57cP9fn9cmzbGts+HdoUatljD70wjbF9HNnZkt+3vkC04TurhqEZFIIU0iUebdSW1GXJvHhh/16xl117c0u0Rw84656D3bX6EBRXOo+NeAtJnCpJIxZxqJN10sykDrR37S5sk9xjgoqoENAZplhSLGLBU3Zb3qCZAryyK7GK5zqIBvBjABYf7/a//8Z+/+OILeGXdVHVZbvL4O1dPXjy/zpdLDAu2DSieGuTouL+7ewBIVIMP0HfgtbU99kxe7u9U3wZMAsxRGEwng9VXzeG+G1pQgQCe9nW3K09vduWvvnr79f2u6tjtqb8/VvCqLI3BuB0Ab2FEntUdys6r++Hr+/3rw9VPnl9cZCEWBTCxSuMM3ET4MImBRzAfA3ZAogCEAIMMWjlLsoIaPynOpxEh04QufyyM6+o3bqg+66npJkbZzg5IcpdTPNJNwRinzk0bM/lb45O5zfMRl5QESUy9jND38efjzibjjaXbfCQuq3knS8b5WQd7PkH7x81RUaHBVtGc0tCWJ4iRODyKoxNxPXU9hJMSB1G+XC03l9lyk0ZhFRzB4DzsHtI4XmR5156SpEgXKzD/zWF39+ab11+/KtJglaeffPL85YcvLz/6COuCQLLBwQeU1TSAh9ry4XTYN1UFhodChFLQ2DjZ1AAfAASJKCcVIumadXc6HKpD2Q+tit7cHl7f7R5OLehC9AZlVwT9kxfr7WLFg7BsQJ5PHTmnbdeVTQvm9PZ4+stftQ/H+k8+fnq1QF7JJk83acx03fRDakKKipp70UdyUwUpyHdzEzEnTME5f8fc7keNRKdebXYQ+dnsadMMy82M016DNoeGXK5tMjljmeyY7xUThYGqAHSIvRhHReiNHjibee3Na/IFUftDguwcci3GclxvGqwt1AVsjZ4GvTywVvwseDFrxG0zQkyAY7TebK4un6w3W97UFIwMsZVUWwNUAqnY/vQ9UGYU7xyebbNt8uGTp9frKxTEOE0FVy247k0Zct2eqt3dbV+BNTsErM/A6OTLuFhjWBXeNSmw+k3LKF/Eq8sgXSAfC+zgEUvgAZmXg2561ZR1JIdnRfDe9kkYpwNOGEjWF9uQMCz8V9WA6sqqPN0djm/ud7/65vYVAPque/Ww+9c7OAQXAICzNFpm4NAKrIw2DH0s6UesVSzy1WYdY+hEv2Mw5nk/2qnmSHNvfow3+swWhmlvlx91ZnO9qafZ1dP4m6n7uj/ndyyWc0rNdorUISAGN9SHuB2TEzsSAsdRU1TXovzGqV78ydaPTLQZYXO3Zsa5LYgJDT3exUYfT8EayWTS9rExdE4eJKCPVhfb7Wazbe7BxrXwtDxfDGDY2jYU+uL6aZCtQDKSPH/28uXQdxiHWRRxGh2+/OXDv/5T31aHqvn1293n3zy8vduBRgETA2htm4rf+vD6pz/45PrZdZItsfokz7Hkf7EKF5sgXyMHYJBhkERRyroBwHkLGx/H2wzQXQzArsgyuOooSUKQFEygxXAjfdf0NGJ6vz+9fnN3AVfz1Tev7ndtr77aVx9eb0BngSu1BWAfil2nEgQsQcZ5PQxRwJbL5WqzjbNcOuzqN6kdW2w/nqrHbcxWTdKm9LxrMp/e8GyY+TS/bRrEqufMdb/DNbeAzAIw7Y0zD+HUjh1ElR2lJPQYo7RpFkNj0tNIFdMVWtu8DyZ1MQ1iChK5cGRQNhG2bImhiBKMceB3MKaP/EC+9ij2hrhPCwWeebDIixWYmuWmvr0HJHQ8HsEVXxV5qGTMuovrZ+D8wzUBDltst6rvQcJCLd/8/f/9+d/+X5UafvX17Rc7uedZdHH98PS9/+n//J9//4Pkcnslk9Vffn5/2Jd//Ls/+Ph7349BMJYrJFoVyyArAoRZSiapgHdL8zjKeHcP6j6QMlsWm2UO2/bVF1+Xx/LYdLt2gFtcFPmmKLZ5CP5EUmRXi3wZXQbYhlnFAX+zL0G+f/n24QdPN+skXCBZUUhbSEf1S8gUku9/+NFyu1FuXI2eGpL7I86mShs+jo1htsEZG8MH/HxQ2/gWk3LT01A+Pe2C6ZHEbYcubYva5+3QR1CnLT+bnhDudg9jc1o3qMnwCrEHCBXToCdJWTDuT5+lAXjckIeRS4RtRZBVYqhWbMwIOQtKPfwYtR+JiWQVzLrYe2NVbBRvPg+UmsZiT5YIa5FlVe7r6pgtllGY5HG+DoftFdJHwZEAhYE+XdxHnFVff/n653/zs3/89Zt2AJT20dOXweZCJel9y998+sGnlyqLs81mffO6/5tfvQ34L5fr7cvLa+S5LVY6iiyrO4owWBWnFBqUXdvXXUvMXLVruq9vDjcPBxUnDzrrWPB6V769+XXB2g+2+dNF+vH1+unl5v33nr93vcUqIwy08v2pImYxnr4iSWIkTXQSa/EoIg+yFYbPP/hgfXFF/vXAvb60ftdr5to42gZ7jJq/mj/IsoiRvcRGJWaW1/ZJP5tvMeF3f8a9i6ryqfm8PylTTBQ97sZWgiMCZ9+OlOLUFQa9eZ1EpIbCVGBfw1RgeQIl8EfPAvNsiC+pbJFeZwviQzHyPz1X03QGxHlu+NTY1Az95rSDa/Nm+VMYcdCmZ66KiqWiZAnogP3hwPL8ux8/X20ujKRiw8gsZ22l6wNg6tX1s6fvVVdJ9sl3PgI1AHcEuKfcH/7r5/+hO9wDxoaLPayT15dgBOVuX77f1arcsbygMmFBiZRQhAlct+57eH5Z1ce62tf97tUdeIK7Q5utVj/8/R+uo22SJd/8/IvPP79JO8D43c++Fj9/df90EX//w7vf/+zTZ0+Wx6qquy5LwnWeGL4/dosU3JYCMBxhl8SgHBfFch2nmEVAng2xfOf7OSJbu5Wmi6dhVKBgMSNYQcDc4DYnipKKioj4YARrGtPwuG/RWbxJnUecuD4PRNmJPWFZNS7UDjsexyKiUBxAhSxMF3D2wygRYYqCJbwIE3JLYHNZGLCI+vbZ2GwY+EWStp2hIsIicX0iIvALIdi8YpHPRgPZknc739HwIDCugee874fLp9cv3n/5dduCM3V/LIf6dPF7P0CX0OwQ9dBiXQ2ue7q9eO+7318/efLkvQ/yq6fYfkizoO/1cadPF+XtzekI3uURPnD40YetAsWUKBZiiURTYREHtqkJuR3uoviAjWRwylwv3x5OX9xXUourzfblBy8+e/8abDAcyqJcvd+9H8olvOzL2xqU08/fHH51uwMX6U9+/PHTzQJDEhjiwkqRULDIBaUDqtSS1EMIAFYKuM2VytjZllMqxpa9aDvZiTo8G3KWtKQY8/RQUJMmMXYtpfoPYjQwogaaztp2WvZsCggX5yXKk7bSsy6APgITo7iFbSfNLiJTEjbe1JlhY3WwEjmGt+M0BKWFB1dPU9iJqw+WAqNSaAqFaUpDIQ1+Zs6RMiQtNhTCURfO3MC5iLnoxBjs02Z3QWw3Wfzyyfbiz/70L1j/V//wi6pt11mE00SSxI0JhQ8b4Klw5dhPIUmeffcHOkhOdcvUictBtS2Y0g5ziHWnFXiqSugiz67X23i1EckCMYC27T5tbxo56L7lWhEqwKAEqJzvgcG6vvr0w/exWy6v0lTD2fzJD9by4x8eT/XDoXx7e/8vN/u/++bhFze7v/rlq/cvls+2q2UOQBA0U0+t6BC/B6bokljt5hYWq8V6e4GXQR69Vv4kAKIk2kJtZqrCjCZnpo4ayVVI/nHkXKzWNq6XJn4YEkqlIStL7DmNWCayvPMxt+1K2jXzZ6FP+HecOi7O49tWN4SDLammBmPUrC9GxZXY/+MkgG/qaWQEH+HkoDBbSWpFCEuqFXzyS71xK8b71D7gm4IRPr9wpk61j1LNoUUNyfg6if740/c+uL5kHz35dJ0cD4cvbh4268s8z0UUmoIt0FVgAal5cRAVq2C1hZ9wGFNVcdkjK6Guhqoa2mroOjQc6HhEIIY6AoS+TpYbvHbZc8wY2q7WmorrEcQCUKBSiItFAnd7sb148RzbqGKLMTxdMfzHZJ+edlkW5hFf5PHVJr9YxM2gXt/u2NCBDtxm4Z4NGAfn2MgvoaEvyo4MwCVYXm6Xl5dw+dS/hU/ayjrwhuSimCXm2ebm2EFpaJEkQaQWHOpKpUrkinNqZo09ltq+w5aD4LD2A7LvozCOU9vEigW+x8nGTrg24uU6A/KpxbsBWWMveOcpEIXf2K7ANi2yFT+21YyrY6R6Bm7T4Za7wcYpmMwRsLwsFrmB/rRwNzTFjv0aux56U4NG1gzTbhChG+IJxxBe871nmxcvrlETFxc//qM//snf/OK//O0v4OXFGoeUSCO4UQpKCKkdXUt0RXANpUhkGGXy8NCd6h7HEkisacDulAtc1HyRXVwnmyueUgk1ZpczLEwVpj8WFSFyIbs+QBZeHIXscl3AKjW9fnO7lxogg8LzSMVZWvYd0hx0mi+WLPjy0F2tFkUSZiGvT3WWIl0A0zZhBEgC8BueWlRXuGGUCdHLzTbLcPyJUno2Ztbic0PSwwZCIClUJI9jVnA8WUfsG4LbsBqAUqgPP4IQzL63FY0w67EpLz5TRvDCLMc4OaEN2++HMX1WdP+O8WKWuaD9wjDTF8+M7vWbyjivc5roqV0ZoWnYYicpcTeHibPzDt+eqbYdyLWlk9v2uWPrill9tT6f2suZ61k16TG48yXgv5tXqjqKJ08B+D673LxYLWKhnj67suPFQfMKQwQFCcsYcXNBG4FQMACAABnZWuaZAl0F6F62PCtEkgf5GnOohqwXpwh2NPGfTCMQU8JApF6w6jlmW1USA37bwIeCoDbVEZwXJM+AUu8pSZLm4O/05QEE7cWTNWzaqa7hnrIgTASONMmCoKchDIqW1oypJBwirp5d/uj3/ihdbuTjgcXMDf0AqNR3TY1pdWRshzEIdAeYs2sY6k1sQznAzVAzNFRVCnR0VZVHwqVgBQfq3sUyABAxtsHBlpFmZInfS56/s+f2/EHOpuGKXnF+yEfk5ImXPx6Dj2PDqFRKWw6CK5wW2m+XpR+Jlx7LP8Y50Px85DMbDfp4pXrsN+8oRRRlbU5H9hd/ffiLv9Q/+Gz75//xh9/98M9+51M4HS+/87HqcSAOdR4YOBaUYsMqBv4sBcyYBPAXoV6OoqDDonbVJ5g/SQseF1i5qgYiRmGbXSpNiVkQ27GfOO6y03WFzZip6TeYElBbFIGKFqsrTW8LLo6mEammYHPAUpYuztQ26pZxUEtZ140e+jhGSvLpqMBpKuzoKsv2MMfuKo2Xb/6l/+JKvPeRCMEadm6QrDM3VLLadW1VV9XpBEITwdWCJcSpUh2oPwAGEbIz4HJ1oAI4GlVbHQ+707HEHkmamq5RYZo292gihrblu+mAPJ8W7Qd+zsd+Ma8XqTfF3s5m436e8lFCeiK7T9yZUaE5/ql+PLP5nNM4df6b9UJ6lFjUY2TfzSbkRN5lu2bQp1K/ei1XT2BpP/rex//9f/efwYFfri4AlwJ2RnSFrh8CE+rpaAbDwmoBikLeN9pnLL5iAnsPSWp6G1qyP3ZljtAeAJCKcqp1Rp4neAIgo5p69FB/VrReATmY8DIcHrW+oq45AdXop5Sqx4qrNXYkOzY4AWyHc+9lUZOO6YYBVGJmQjuOWEXkLfa8iD4rePHrvwm7hyD+z+rFJ9TQULqBV1TbNZiOTh282/64b/oaLgjxFlZFY+97eMscVwDDCYMcmq7bH/a73V2DWpMTmKI+r/SOVHgoY44q169ztqEpN8xppr84O59Xzd2QplFjTT0ZmD+wnDN+FsPg49Bo5khb3DbMO3NJH3Vxo26Ho/k9Gwg0hhi8D+Ru5OPYu46bUuAa/nnxNLl4Iq+e6WyTrref/vjHrXLxP90zkAz0mNCQOZqZnb2IOUwM4SZaxNQyuNfIn1PM5AyMNAdUSWfdNMe2pAIEs3LoQQEOE+TliyDOc0RJIoryRUAvRDUAn9o1uq1hb9MQm9gCXD3Vh6BvQZ6wY3DXN5I1da/dHD5yCeUqjX5ytfyty3zZ1fJffjG89zG7eKaiRHaNKRe09Q89Di/A1mAgWVUJWouiVwN17QqSNEG7xjWAck5E6rY+HY/73X4PwB20rAooQJSkYLqp0cmg44HSfYFxU2h6jxwn8OjZxN/ZtCg1Dbdn2ovlayNYbNaH7zfMKxOuWzxyB6mHrnI8Wdc8zRsrO76LIZ65ZkLMzZH+zWOeGY2z88auE8+/B6HZbsNFLi4ugmIF+gQn6fBI0tQautOE8d6krWleFfwWvUVuq0Ydb43mCHHbRZ0aEmnJTILB0BXxV8rOzjUzhZE2CSYVQHo4YLftU5bG68snMaA0hM8hiynaZ5w2HiC4Bt8Ti1g62M4hTpCZw0SMWkrBa484WZoUJXWGggv9YJX+1jNwcdP21B73t+vb12nfqChF/426lfbUSdZ4f01TNU0N3ydCTliVBP4I+CEyx4FAID0p+mII9LuBfMEWbCUqKAHXkuIUbG6yubZoB4TV5rFhMxGWoZo8Fwa7h2afuWtj5886nDCW15ZvAtUOTPkN+pzLp136EUnb6FypKXTljV1/xBZiU/8PNqtW5GdsCtPnWVkajpvLgZ31OpCsdBHm8VDkGJztKtWcJJgtEZuGethgKE5o4KIGQRFES+PkkiNXsKeWQ5gixqgibxuMsA0tGyrM22yvwRpilZwJ6micWcKpaMD1JGJ926ERbfvqdBRsWG+3+epSBIHJXlDL6gjjU6HSgN5AmssOjSKOH5dxHGFHzxb9M5C7zbLodJgkKonwIpegrp5vnq/Tsu4Pb/fquFviAkdYwgyv6EC6sHkW+H1wJYPqcfZhC5JlBKumeVgS0wNapUlWxMMgOh3QrWPvJ8VNux49aKEChIlU+KVDcGJB4lTFqDW2QOohyByoSRMbGzOJ03wAzualQPycQ2B7N3g2zmN2TYWR3G/IYNuZibHT86xIYmbkBHP99LSe8ZjZ2KyQjx/Op+7kPkFnClCYt6t62cV5sVmGywJvcveW7W/Zk4+sjErJkpga7SObEWudsFYOK9647LGHkOmA1g8Y6+qxPzsGCcs7Lltx9VRcmOiusG08zeVh+JHq01scjopVEhh2AOCiDsf6cHeb56t0dR3A+w+RNukT2QtshZywYsmpChtMFgiUIFppEyD3q25akYVBlOHwgDzbRMFn14vPXqxgq8uHZqi6LE2i5UZH0QCgDIxZdQLThwOn+46KIGWDXT/xQRAv5GxjmYmkFjG8KJY1OCggZyE6nENHnH+qAcKNA5OKFeQ4eEEyBe/YBI1JnIDA4axRMKZxhpI6TRr0cbeejYf2+RV6zCU7U6iJhu/pC3++k+M6jKwLbk6zaypuuz/wx/bNsWYFd3Mg+NgpzJ8B845MlS2o13oChiAWx64vgyR/9h4HjWXGrWluu8ghWkIDZz0KuB/TXgPn3/UKDjqW2isG/nlT6fKo2npoj0NV6uYQXl3F26c8WzJqn8fHJpG2ek4BYOrrQ4uTcuQJ3HysegqkCh7u9ov8bRjlQZyJXhC/Vth268IUYWPpMCCw5tAP1Ql2HWSLaDh6KPdiEYtk+f7Tqz8Xw4+eLNZxcNw11FxERkXM0gz2tkf5KXf7+6qqZG8ae6DlAkk6nQ7VqWy7hvQZpWrkEKEUliAoCcbbwN4JxGQU8SJsj0W6Em5HD6D9whrj4ZEZEYHd7KIcRF2pIMF4GHnlI/VhbGTMzzh6yhsuPGqC0Kt4dDRzNY3mtaZI2zd1EfFxyqJhEStTpuaz9fSZ6fV73T4C+dqOIOazaBg17KD6Ucvdws7jg7yV/PLlp+HmAlx3HB+wumDFdqhLDa5ekBC6CjBEC1ZvoPI3ECPw6WjQGwBmMDGq3MuyHNqTbEsdaLHaiMv3g7jgPdLVFaXUPT4/rYxELwwgDqjDUweWcHj+bAM+3f2hjF7fJMkC8xMIVmLOI9NJGYsNwZFE4ytBx6VJUhJDy3TVgk1DIgNc22rz6Yvnbc6i5vjwcMIuvfhpXRgvdRS3BKb6ugX4vds/YFNJbVtfglOIgxSbE0YZ2k6hYsbYKAgZWMcIUGWSmZbYXd/WXU0zhHuqnsEkxtBQ/aAIQTXmaYadVLClaADeqxIs7ta9tH0cZpGHRxMTXe5y2jVDtQcsoGw9hbUTSvsN3LyBiETF0FNFjWEOUsjdlDoLJ1fam23GXA9SE4Gx7ftmRnSMcWi/F46dmjnNccQXDpq9PrXfvXzClluOYRrF8hUDo1MeMYpNV0idjrD0mwEeImWjsM8CVZlW9XDcDeX90GF9opJdkCyw/ViWiTynknvAIpSeI4fEti2lzLZGkCaR38z5ssivn1wlSfpl8+rrtw/rxUKIIL9+n+NccoW9McDlpKADrCl1eaUC+SAAkwhyEEUY6cZiKbCwXRvHIY/joBc4N4gHje4wVZBlgObqEzp+LUWojod9XZ+MBwtHGTSQAe8g8RJPDhWxCmGqGsENwX4QNeImAPzwLgjUejgTFpJbFg3ncDmg/DAqR1NI4J5Bb6EITsbizOG3lRgzYKX1GZ01nMbqTJk57c1JdwwwPXqdylSdiamuULyLcHE2ZGMqs2b88Xw7zbyOl57KGttEuCJYLt6c2vYZUkrY7tZ27HAZLE0DnPCz+g7kibUNlskrrDtmTSup4UJfl7DMg2xwlEGx4lGMsXIR8SQHhIscD2yKDPg78sZPgsM1CHDfi0Wi9HrR5Xm6LFaLIj8sDq9fv339+jaIQ7iSDPQdjRx3kThpm01qkO1GUAytpcnYIQ8b1WJrka4J4wxVZd2ulilojRKPlAyWy8Mw7O5v2uMOABb2vCUbJ7ih3WH9T9XWoM+GBoMRAVZGYMMLcBXMOGYRYNSKfA8J7gLmfzACBsYc23EFIjI8XwR8gFzDFke7pXEO3kQnmfLYhHqydI5ex6cgw/kETVuqEI5QzGigsSu9R2THKAlOfjLTDfQZGcgWCp01pWFzkfJJZH6V86wsY2Q92s7PyrUKp8V0rcL37XCQYgF7DwvUlLpvWS5M5z6KKaAFZKcja04Y2gEJgxtvWkDLIFhDc2pOh648wBYkF0+ifCXIDeRhSswJUzkQuZ71hvVq4uE6QCZRJk5lkWZFnkXgy+PUcQm66fa+3FycePAWNE2SL7GFBvVIp54smrpudFjOOgxErwKZBw0RnUCDYuPSIY5wthY8DlsrWAjGKMtFsNncleWbU8fBjrVdecTh1D2WoClTVQBSAuqqwwjCgNgyCJXpMi4xw4wz1/FEMJNYxFAckbUGk8xhlKBGAh4uM4UyMPYaUnsI8qm92IGX43tH8Pws4eJC2yGW4epz3eGeiOiYT6RV7Vk5/W+EouZSfBYK8XC+q4DzUo+G4kefbZ4sfIUKu3HX9teKRyaSqQbbSM2EoyTmXvTpoJHkiQEmGhUA6wk+YN3sH053b2Cf86fPw/VFyKMgTlmS4jvAKYefeeBNRiHZhp2DN5QD9pEBEIZOAHJTmsMRfP72eASY0jW62jWAvsDUF1JlxTIMqN0VlkNKQDhmhm2DNdh4ZNpOpjk2LsMALUrggB2O04ShOQd0ry8vFlWSv37Y3bY9jrJuu125KxEXtnTkOLqpgJkahNgGohIMDUydAQYmTPAV+xOS6eMm6KLGzL5kVAxI9Z3ESQInIzQZuh7jhUi9UZqpd4oQf7TL+vzh0FFJvWdo7sda+Ugb5rZQcVQ8fKaHZhLEPQl+VAziyGuz7IAH0MaKSFcAYqpuDXEDJOUW25/LaHmBKhkcH9Vj9JzDoesYTmy6B48PrRuAG2mmXWO7xB4Ay/1NU+7TqyfZ0/eibIHtGeKELVbYFe3wwLHHZAKqEESCepMiQla722F3I8F5xCA16IIGPnwAE9w0APIe9gDlWRKJupRJCoLUkHboU3hzTK2gUIBAE18T3qwbcAIKNk4Fhx98MQB6mHZWoLR4HyUgcEkcboo4zxb/2MhX1W2HPXZl3VSH8gg4Hu7E9HmCx3tQw/1g2pRIUvIYX0G9S43VqMKaktu2/RS1YFe2Y5A2Az/xYgX1OjGeOjwTFCG8NTmZUyJJvxO6vDu0rV2ukE0lkGMpJLcj1GYp4pmMju3apglfZ56gZwptTJXPWlKcFyZ6aSHHJmTz/jfMzcy7b+DW22J7zdKU1QeweqaNjO4qzLnVWB7CswVWL6pONy3OVz4dQarq6hCvt6sPPkmXl5Rsto0eAJC0ZaUf7gDiBGlMY6Zp4EJdDjevm7tbpMcp1QpRd9g2tBVtDRCm6W52dTeIRRxrUFFYia86+DhKu6RFATKDyk3Kpqd4ADWDwIZxUdiAggxYT7XsEXEwiPCiFyJYFtlNUvx8d3zbY6shVLYdYSnVmTMPf4CyJIs2FqBTGy7iPnDrZxGNT1IhCh8NOyLQwPZAR28NzK4gecNixgCzjXVTJ2mKSN/0N1V6mjY9Nn3XXnzJomeb8nS6ZsJY1qgqNmbn+HlRvY1X2glZKhg/gvvJ78e5Z+UL0gTEZ7zpsxHqpguiMhW7psfTKP2Cla0EO3QJj2c5StLpyCkgp2RLGQnQAjFAaQwxEL7BfNl+d7x/C+Zm8ey9OF9z8K6TFKQBzrYw1Lkgag+n/uFrcMiTzRoc9Rg2va2q3d3x7VtAOYOWu7I5DroeMLz5cOqOLYAbcZllETw3DLCX3YD1zT0IKshNiHQvandHqWNKyIDeymMOaulQY3JZUwoIcFdTNg+3xzUAN3AP8uKvKvXF/R1IWohtugcz5xRDITaSwQ3P2zhVYqxlJfQgHM3AmkBT5GS2nyC5oqkjmJPQAuSTmP0cdvP/4ey9ni1J0vuwyix//PVtp834WTMLLLDAGogEVxBhKIYYIVF6YEh6YehZiuCb/g2GnvSkQOhFComUSILBABkAgiQsAezuLMabnu6+/vhTvjL1/b7MqlPndg8Aqtf19ty+t05V1md/hmJUJrFoD8I4Y0eMirVw1bYk33pCb1OSaFENYrsqVIaR3MrIWiJGI1DWxA9tl30Nr5s1AHgKKFytu6bA3bloV52mU5dvU2wrI2zD2e6S08jhm6uSfCsUE7EpVRWqWhRVoVQgvXYGhntOr7zryqiHB5GnOoeQGtqkZL24PK09t3dw4o/2nBhHyuF9swpixWMFCD0OqAvYg9npOqkuL+JeHNTFcno9nV7lGIZnzy4uLtfJ+ZK6NKqOdUQ9VBxFg8jreXSY8qr2XZZLhtOtwBjeYIb5s1QsXoOgVauoF+nlmtdMlAMhcLtZbfIkjfap8Pe+EN6n6zlEkEqKtBXLjEIqDo2AOVi8XxKGBSpbSADfUjNL0EbRz3AfWoEE1ckumKJIaylkn7AWpdmF+0mSomGA1jck/hgZJ19aWL9IamxkkL2GG92oCncVi8RWhontjmRtEVKC8QqWaah1I83dYeqLl0LxrVJuC09uVnLO7rGzAgMWlcggCseobfI7h7u7zgBYC1jxwAmH0OgsKwBm6LgEfbVZVOkVqB59Oih1trymr+of3IqP77rjI9kbaC/QWP6zDjQVQ4pVsuNAOj2HqnWgs7zlZl1RAl1uVlkBzQ86YEma5FVGCSzwxyEcrKPAl2GYUTFXQV8ZwyqgDJh54VH4wWQNxiOs7kcnjq66F4XjUSylm+GoUNKtcirQdD0e9/ZGPREEXyR1UpX4vMLAfHBUNQea7S1VwtKLhYlLsvVWsuMj1tmWjdyL0QWt2brYNSsUpnnqtprBWgI2BPRVeY4tJHUMZVVtA6PFjN7A+u0kqi3wV2ivq3mmzafpqteKNo9bnLHhCgkLOTNaiY2MVytr9ZIeojO70qIz6pfOzfKtM3s3P6C9NtEGf8E2YLwtpupb+U6asNGEx4JyrkrT7PKZGw/6k+O6pvK6jPb34+NXvMmJ7PWg/kiJkq6DaiMj6Y66BfqtXg1tYZe+6WiUr+aLaygeUZkdjPqDuqavj8tqlWR0cOAAEMEXj8oy6uxDKTI6mjVdCj5Qlpf5spa+G4cBOAWeS+eCcVTYLFHqNPxk8CsrahYzKtgP7056Ye86LS+gRkp/AzLyXJ3arYpyrIylGfi0DotuI0hvolSr5YIMSKG+5r0nRx3Rrjf4IUECDvIsygLflPXPxHabQWOV1QzqTgvEdindZDXdrm1MwWcIQqIxleqIv4hu/HEaT2RhYLFGCN1hVJsVohEvjZE3j1enaBM3Jw7ODaUIiyAVQrcKI50JLv13wcLWeBtdl6Vp2asSCD4XaSfNy+m1GlYCjEjXn+zB3WUwpBqLcmUtDR28IXw3Xj8QncbongolDMnSbF2k65Jq8jga9PvhqL+eL9bLzTDyVakjT/SiACMD1tdGs96Auhy2K6PCuKiryItRINbCjI7oaqECyCpOXHsr6lUjV+/v9Ud7e0kdTDfXMwq9gvOz3C5UUG3zU7YcZ057ptczDlbKTPLsXNwuZoVuZzuGTiO3mm22pmd3UW2SEtjr9NGYxYPMrbr2wE6HNN3xgLSILLGjJwP5RKdLe21R8ZYRz8cI8DHsdzn80m1m9w4Iz0mt//Le86ugVi8HT9/kq9roKxuaZKu3CbTdVVI8v5i+SWGdklG2CdbTnIIQrM7hYsKDBmq0KuEGbtzzh3v56qp2KqZzU8gvXBg6wzEeOzLPN47AiCJhqMNQUSIocl85fS8MenRk4GHt617myiUV9KOBKktXA6OCxosV0jd0jKC54HuseWSsHKiiqiD4LU2nBq9eCqYVK3hyVyIUxC9DX8ZxKP1Aeb25XC3zqTB7hBbYa6AiGKxzDWVJ8GZly/2TanKJkgbIydZekDywfvNWKrHxlxbt8ap5T6dbkxCUG4xrNKHnr5I11S9CD8z778mO1Ejju6baX6COYCNunDaAz68td5u6Qt2Bd20Xf3pHXsJ5AeH8Qj8omo2i2Olh7Ydr6jHj/c3G8m4YhInWP3l+WSznx7Enk3mZLieP3pRRZAp9elBuNFDsBedGsYzieiUxWTZmWJTsZBAEQI5iFFQW1LCpPIdxF5fEoiz8PB1SWX7sKa4z4KBK0Uu4kR9UAXDomB7BM7EC2AnTRLRvNZVYLq9DmeK6SbJwHI8HI5mmYA8BimxkuznYIC6WAMQpmSdV2KtFL7yUmES4nOuEtVNs3CjtidjqrpkavFG50A350ho0GMcvY0rf5kfbNQqnFX+3+HZkILSVwli7Nz2ZaGqnl4/a9UtKeEtTdTrDJas5Y3wOuMF1QLri6pp+i06wZqakqF3HNMrN7MJaX27tx1WtlX6JHqB2tsQv3Z1j7eomabutgjRY52BCbTXux1GfTs/lfPb0/PkwX7npimrgX7//atDUe27Y8wajKtvURSbCyI37wQBswbrM0fvA+a0s5/N0uSoXc7HeBDUDUbGxzrRtk1wH1gT0LenpZ3qzSeaz5OoqTzMVuliASOgbV5xG6AFOQr8y01y0ymg3IG1bQ+o9GI6z1QYDMs+lyl5adQFesufFIAQRgrImxdcq1jMmnXL/VykrTmynep19qp0Via0Cm9adtYitpWxM2hoQIiw4W1yKYBk93dh+t1bFjQdIQ9La4dKbWku2umktSmEr+2ciVsMg08jheuv9A0VodiwyOs227TC+mgYGZ0n61ljA2JqbWpy3r1gnWA5K92jJG3ps4sXmsWX12ObVzmKlF8ZBbxiFgyDsUTYcDetnq+WPF1fJurg1Gf6tsh4pu8IBjDMasFH2Mjy857FSeZFtygWGQel0en1x/fHHT3/06ScPD4IHvdHDk7sHb70hR2N1VlfrBVojKtXKsFql1AdUVbJarai6ApKAcuxV6QSi8HSyKakMw2Qh9oej3mAUR9QlhoEXRtDidlXU6/cne5RNqX2XYQwRiLT0XQlz7oKKGRXU5aAX9ELPNJHQGwGqk88WM1Fb8elGYLxVL9DWiqwxsdNix9i79cQ13Q/QJbZZ1F3Fsiazis4W0ALxm7mm2NE32jleWnQNDGy8NNA+7TXOPBSPa1kzC9IrvdpngxWF7ss1WvuShxwYtUmL72uoytY+1jjgOVudGEYFdN83vaO+bAcPnbpeb7UMLXLcSKkYL1jX7/XCuO9DZwh0gKCG/tV4MKT0ElL3XpQWtAUUF4YIihqrYhMygE0GoU6W+fxKFOns0y9+67f+8J/8+adZ7PzP/+i/f/Az3zk6uDe4ew8P8MlzuLJTfzca6aOT9fs/Wf+HP3G8g97J2Dl9Vn70dP+1h5vPn+2/difVxae//9Pzz6+/XK++oDrfcX/hzt2vvXr4yuNgEIM5H+NUTUb7t1SSXJyfjw6P6KxQ7RZSZ5lj/wy7CNiHOIHnQZbU86/z+nI1N+jE1pRP8YyJhXSUtjW4jTrKsoOFbdgNYN1qUe3oQ7XKMts5FtRy7MEShhwiO67gRqCzI02qdgVJmjypbujytWfTQ2rji8eZZwuyqnKrxjpK1uzn7irMsIS1RW5E40RX9E1au13RcNBKZWGf+gUUjZGckI7u7hil0xHBYNBMkw+NXiqdpLAXRmDM+XywwiqKwn4c98o8p0J6lRbKvMH8ZntRrOoJOw/UIozdeCDWC8dJZdy7/eZbv6r6fRm9t7zyBofjx+9O7j+WvlOtZs7Du974xFlfu72xM9wDWqEfu+ODatRfffLT/tEHwf0313s/PXzn6xeffzK49fxQiPMnp9mTs3Ihp1fVJ2Ixiv2ozp0oHN46OTy41YtHX372aS4kJcT56VleFHG8n2SU+UTuuIEMXEdSIpZB/Ekuf+/y4mo2Nbtf0ei7NtIojue6qt29shWPcNqxODeAukMgVvpFkIDtARxb67eTqUawBnUZSETSbT1JREdNeXtqtNCd/KkbVf/u1sVTfBaZQuyU1A6XbFdXlQGdr5r94jVAHS2fRXTRy80fWSl2nHPXOCegd1WsSHuz5hMdUsXLO0Y7VWn49Y2FAXhXIWVD3x4sCqrg8dJpC3Kq7lYFpKuAv1QKvLm4z+2rC69UHEyq1yM6jHShvaO9rz98+8GbX3v+o/fef+/T39b/8ls//JXXX33s90d6HMjexOtHvj+iv5yGvbI3kOP9+OBEl1U4Holo0uu54fjIe/ZleHCYbMTV5vNbwfDNh/v3JtHxndHtu5N4GFJ9NhwfDMbH1WZ5fvp0sL9H1c1iuaRrj+Loeraks09t6o8z/YV2jkt3JaoPk8vP5tdmuG59pYyUTEMlxd1VFtZroroSjeqiQnYwKsDWwIebvVbVp/t6y0a8lAfPsvnHulHUl7rDVW4gJ3pHKXb30cm2M2iIEIAm16iidHvBDKj32BqqMhGLuk/6b1aoajNv00OKLunUWsGa1M/4c33D8qWp0fVfirppylELjDXsc3MeWQwOISugH1R4+L0P64SYvm6WaWrgmItqJnSeDCNcYW11nqmi9yvsXL0gig6Pe0d3D+49Ovjphx88f/Y7//gf//Tt17/z8z+7R3kqGpZwnXZ6R0fp5Vk6nYMt7fmL5+fXz5/K/vL5Zx88eP3xn/zFJ3/+R++rRJzk7tsnB68cDSa3oni/F+8PvP7Qi/pRf5QX2fT5k6wobt+5d3ExTbN0/2Sfrm2ZJKX0LjfFB8v1p47suV7pOJkuVVXSG0EvOC+ThdMAC6Qhn0meZe3qnHP8kOaIaeMVyoeNAQvC+EyIzkqt1WGzWgd6Zy8snB014xZF3lX13FLTd/5Ad6nFQDdwm8cfhC+uql3jaQfkBaSrSwckAdcQZWr++67jbiVQnK6idiMet1VHfXlj+DLChXC6TgkWE2w/d1daRFqjbGGMyFlwKaZPcJWpdaUm7PVsfIbAeAYppaZ6y6GzSAkRfW7JeCYth7F85f6DycHel88nH/wFVdP++5+IPC+SbHG1qQLpHx9ouKoUV70PKZddPHv+7LMvprP5+eXp2+++Nbucxqebu/3B6Pjg1kE8ujsI9mMZhZJ6yTCm4Ec/ZXn25dXFs/HehBqg84tz33OHg96M2oC8ypzo+XIJxqkQK2ZeMWtMlsZ0hSHWTS9nX1otWp1ateXmMVhGN6M+Q5/HqFG1gE1eW1l/CNkZDnGAY/fKppwSuqt76+gb2AKnFWY3QUW3x8jpKBxZCISHNoknV4JxPT7oI9YokV6guiwwdWT4GMA6/Kl4tEiX7/Hq+2UTtB1GxYtjUPGCUtyLUcs4Bqn2KKqm5FRG/NQaHEhELShjqU1VXyfVUPJsVDutAbuqcmzxotjI5SgqgIxdpYLtpNof0a/vvP2WM1sW02u1WblnZ55YFdQLfPm04itIz86rrAiT9CBJ9eXlXhCOTq/u+HF0chK4lTuI/IPIm0QAgPohK9hjOVil6830oiiLyfDg/PxivVnfOT6gB301XeZKLmp9vlzV1HYwQ4Yfsu2dbPJrUUPGKdu2MVvhjG7ZYEw7RZc3w1moseU0Fp/G+tnaHbkG+2d5wfZvMgu6HZE7thLb+h9jRPviOlrdFP3jhMGQG3Y/N39ceWxQDWYskGUsBGmONgAAZgAXCL+WNlA3sK0belwvn6m/BAnxwj+2K1Mj8dK2mHY/rxoQpLbCpJAL1UFA/4T69/N1dSv2ejhY3LoaEDzMP5X0Q8WdLhY5xsWKSYiUYio4MSmxN3T3J1Ip7/HjwWyqp5f1cpFnSalgdqIL+BKq+kR/6zX6odlyvdlsFslyowrvcBgfDPM8DQUXmHx9VQ5PnbQqhB9QafXs7DyOgn4czRbJbJMVwnueFikjL1weP9KnAKIMts2V8b3CRBqIKjspcMxkqCFG2S2M3dfXjQyy0Ds9WqMepaxkgssHy7by+BdKZ9UcPsF9Iv1RoFRH978VO7WS6mbq0Wo1dpBSuqv0BxNYY8PJrzh8lyksBWaWUpWOWzgVWgQsfU2qBlSaqvmgnSHoLoZU7EJfuuNZrW+U8uKrZUibwyMaUrbTLs51hyIJEVQ6WMzZ9bV8vs4eDem0AIaljRSOaKD8vOzk1RkcVhXg6pBLdChLBj6TeTIHEGQAMevhAAzqwHPXnkw3Kk8QPF0fVqlKbyiB1cmmXumBMxgfOHGYs71y4IdYr7lQA8zT1TrZJDlsxmZX13mR3zk+ogRwPl0klbN0xNOkoHeWFYYqgzKHFCngDtIIvTVRgt94NpVkUyS3eZ4tslMYRdidM8U50Awm7CDRtXpnjQnrzupfO43FGyCEfBwwDNfbvWRHxtPRW+2Zzp5QdDTOJA9IG5khO3sXjZ4VT1MQCApZ4V2p7KPGXkIaOdBt/BE7B6p7dNux1Bbo7Oy6oLSdhCO69hhcpYouCNrqHXJB4TaFgmSVSsmDvOulfrrIB3syZjyplTRC2yGVtWeXLXCNv1EFZASmSK61XU0TJ88EREYzHTj1IK5FrnAWlcqS2oWjj4hF0BtJZ1A4NTrRNKPg3oc6iCoBApK6Lhl1XqRJejmdLVabvfEwcD1UV2mWieAqV7OyMpINW2k8CeEa3wnKuiqqnO68lSI3uD6gQRmThZdEsNczq3VyYaBYanGrptgIvYvGCt5o6rFwDY8VhAVC2YmOaJaJVjadfdLtNFK3GVbrruiordVv/FcrE+QxldAG1o6OFZOvqMwqZYW2rBJ8FxzsNWso+ATUw4cGZOa2cWp7GeorsdHir0PCcNoL2fWlFp3a3ryHGCwoVzn2YLhPlsmdXtiL4KksTddUl26VQ4RBQsJPWmY2ez8jsJU2AvJN0NTV+l6t6WAoJ0TCh8xC4Mt+3yn6ADrXJUOkSgGW4jpNMirvw9Bzw4CqMhcYQ1h4AduUbpar+eVq1fPd/X68SbLLdZbWeuM4UygbmA0djzRd6G+HkOb06UMFqnJLP3U2qk7ZCldzp820O2FXC8a00ujaGnwC79AdU0KZT+Sys5/mdYjLK2lhBUhM0OCpJVv0bIGZwqJ3WcdVNcC4XUE/3bB1trIaXfF5U+JJnryrZmzLAkwOs4Mkz+AYAZvTm2mFpoAYpWLFV7rXCARZCy9nJx+LTkn4MmiDeJnXmegw09rNg6HnOx3J+Iam1vj/SjutkYoasifX+d3I2TvyPCMhiBljLsJIOhGG17jRKDnsnBkUl4zeEFhygqIOEawyy6o6rwswmCn0bFKwIcK+60RxlZQCKhAVxaKSJTnoC6g6CjynKqgn8CoheZxJJVa6WKwu5quyqkbjPoWv6Sbf0F9RshhN3Gg0KvOVKszOkE5VQC2IF0hmcHgCqqDUlGzo/ySJKvl5qFb9zFD/bZpBilGiLUhVS97UhjPBJBQDi2qNeIQVeW/XNNqa4W6NaramAS/Am8z2RoqOZ5Qw4rTNG8/H34NyCacHodstkdMhyrA/re1vJYNL6Ib3OnIRW56gdZJwmunblufYkfL6KpmHXWl8E6NFZ1YvO5qlepsiWa/PEOqkG0B/Uf74dD7xB68e9DDWwgpdoCKuIfOnYXWKPVOtQDmUri+dyqlYMpPqeqqd8hTGxtDMKyqKQEJ6QVSDXJyIOqD8ppMEzXsBVmhF34GKvMgHPSgr/JilRKlyz8rFYn16vVwk2X4/oCAxT7JlWkII5OiV0eOvp3TuNiv6lIHcACiG4Zzvsi41Nld4bxUMxllkragzBay8eXuagFQ3KpxaNDd9e5c6bn9WGbQ1C2tHmaiqlepMTZ2tg3PnJGw1wIVzYxahO+VzS3xo8irGDUaA17QPqs2WjQ6EakfsZmspuppJnTOud+QD9YuThhuoeOdmjbWrd9msHDrVGw/47ZvVggdZGFiazQ+mD3EQfH5+EakkEgeHg5i6QYl5by0LzE2U9W5BqQjPN8+073VjTgq8EirIjPMdjpUfqLBOJR0sryrpVDIcjk4PdTQUIAOOUCqr6JxSmg3Y9Vmtk/TscnaxWMFetddLSmeRVatNIvp7k9e/Fdx/vXj2eXF0Qgcu8Rdgc/BomW+1CkJo7YJuqqkr6NXMwwIoQ7ENsOnmVYcmYFUVjfpuo3auX9KXq46lSSM1y8YEyJaCKzAj2NNWyju+FPqmzO0udc9pdRkacVvVQseaWYapkLpT8xbPivLRsatBIaV0XmZwuCvG9R9VYXXGX6qTS1n722g5i8ahsYmWZklph4aYl7rUZb1/en0cO/uv3qWeiyoXdORVid2O66OuRWFITaFoWSyojLHz8VwNFSTAs6ARzxA+GLxx7QJMYQAr3xICQJR2se1UFIdKCuphv+8GUVVWm6y4mC2fTRd5WU2GYeF4y6xYg69W7j+8c/TgdTXYS+ZXav+QPtXK97IsYYa0EbVGFkTPD/UHOtigisHZ2im0gUo1itfazqCFsQDQsiv7s33cKPYMK8e+5a0gBpdeHAVhM+1KuRUqrqToTEhb3c7uHEOIXeLpdobVOPdozxKFjPmC0Rq350srO/NuE6RiTraxyml1+Xbbv5YUtA1qO+adW+BHN8S1+hGN4hLzUJqWwnp2WjdpE6galXBpB8rGnQDmITLyfCpt1ljsDrLl3INXTQg1b8pcrDhq1qNACdeME2bdKFa2pe4ywPsborF3dV5VGaVOTPLCAFcEaRM0nDD/hqQ8GKj0syMYlsd0oPM8v5otn17NZmkawfc9WOblJofSI/2M/mDU6/czKaIw6oVxORiyo4q7SdZ0fE1ChNQqvismpcDDsWqVtgRTu9pyG/Aoz08sK8HiSnaFHRXLDuAzCq9VJdsaZUoHagJQA3ebBKV5LuGakcF2A2hqevOnu+LWTocA4XTmbJ7Fi/K2ScGkljsGlAp1Y61kQTxmvlKbQGbQQF3DKKdR3u0ujm5K/HUmpC8tstqZnl3Qb0lkJky61ph119zcSIZqw5DD76kcHg+Hw8kB3CizPOqDlIxK3S1dIwbJtYoqqfCCE5PppTAW831mIGFeBIMyV+QqR3dMHXjOEuplyUqlLvCX7Kss6ZREfXAKqR5fJ+fX8+sFDgodiILKthLofM3wPslTESPLAaSglFEQM/6tLLKsLSGqujQ7NdXgGlDbNhWWIdPz1ERt39VaODclYIUJGcA8VXiWDFmw7oKtcgbM5l1uGC12mKs0V1p24taw6cZh2lrc7dRaTsutgaQha95zGHObSUOt2kJLbNFU/AZI1ljVNqIoO0YxEVo4LzhU7YxDW7NEsUs/bBQp2avBXJpRx2p1kyFIyYa2jVrSlv0qpepI2VgNA8EiwHE0GO8tZtMizwMXgV+VBdZYYSyhtULHp8Rr5Yeu7Zwlo/krN2TUfJb49DVlDN1PXdYFREgrXbHcjyhzhAIQftyowO2o0qw4p05wsSrKPOC+v6rg5Apkqa49HjluijQtqyRPkgJ2wdB1Emb1KSsKgApGrND5YG0pc8pwjn0f8Fb6vWj6Fr5lVnGXWzpGcAlrqNqEEAvr4yG44im+Yfw0cCvDoGgnnIamI3aIVC+s4UxdLzuIJ33D69kiSA1Og89q+9daFcCWJm8ltTDcUqCN062uataEVe0WpuMt+1frhLxErHtHdU015G4rGCmarVnjobkTsgzz0gDUUJlTFoJ9txdSkorjJE0EiPNAmHErHCCCYJUQmG/fGNVoa9AGJ0uhVrN6s8ZsK4y5DAJeIwoCx5BJMHaEFjz9gzTN6TRcTlfPr5frNOMOwKsdyr3Yl1FeCDS8LemuzRfzdZ4t5rP1ZlEUOeq5ulQWseeU9BVsDMBcO4eDIqKijzILQrio9BtBfIuPEQbw4jRQq7aYUC1RtO3xhQEcsBmweT/N2ssiHtAE1Vp3TXZbUo/usqGl7jRrYmsh0D2KXjtzN5PXFp/DMmvCFa3Namu5wcAHiDwx9dvOV81cpUFoaL07Mes4srZ9xhagfXOlypBJO4ayXBGLeBVbNMfur674Fn156FNlhT0gxfmwF/MQPPPpaFEnXzlFloaUAzxfS+MBCziKzfvS2rsLpDxg7FWeqSJz6gKbNhk6uWb6qNReUCknK1RC5XeRr9fJk/Or69WaolToM+a9YnkgzBSokq3oUrKySmdXs9ViM7vOk3VWFS4rREABHtxQaDdWBaYYprzEdqUspTKCqpC0KjlLiFYa3XUa+PBNDwljR9DIXFuAmzFxZnw53LVEi9xS7dDeuogZeSotWllj0Vl4t9hC0XVN3BlUNXLcYutd3iHMNOJ9bMoB8hcHN8nizVQIgHlWARyhqLV02ZJB7xJ1duOk6For7oSnG7K4Da+j9Z02dgDtKsrZkQXAusbsqYXJkzhYYdCPe6aBpFqn1x/oclZmECag5O/UayyvA5/PESvv17WE9B70uYE/cxxTVylzMZSWgpDNmVWFHwcuAKWxtKi4hkvpDF4tltebTZIXQL9Amt8pIH2gIl/6upKoqHzqE+fL+XR+RQcLzSB8LqTvQSLQAPMY3JCXLEFkZIcEVlGQPaePV4ua2VFOh+/bYsRFd25FadzgFKzJhOm0eNHLAC1EEcgAmLe6ErVtikCZo+LP5Zgi9HYgJhpaYItW7qDJOwqQna+CWq6BozRXa4+V5B2bbfd5WtmonHJwcmrbQhqrmaan0FrfZKlqoTtqDTuer1sk1s7s3qhK7FrJWlMQp2XSbbUlurhb66I+7sUw1bV/y/XDMO71KbUVSeKGofRUtp7DBc+PTNXKtRdj0HlsqD23TNYYh1JQYWgTfMKoqoLKJ/aASFhUMCXpYjGnm5fU+ny2WCaFxlTEZYoOhA8oHrkO25YZChNvMEH5pzJ/s6qKjC4vkD6U/l10EBXrjdM7y9K4YAVqrqsZIqpYtsJVOxCRuuNWY6tyA9yyWPN2dLRVTbOljaEes4xlK9euS85BgUXNt5QL/QJrVXc6zJbmuHUU0QBSS9lWSE3XxWUy11yNXKLFH+MfAXXkMzLaQ6Zpg92NvU5niL/tRbX+SwdZot3lKKulJ3ZnqaIjJrI9vGa0VzOnxUDmx/3euNfHNtBlfnNVBlFYFUG1XlWZdjEqKlZ1FQ/HgR9wFVwbYwuDRdOZo9KVhvtaUhQZ1CU3CygsupA5TfOc0tYmL67m81WSUkyh/zmdr+g1g0INcN0UymuMLyQYqR5cHdF1wNQigJYsJWp4nGBYVdWUdOuC/d94ag8aY8mOSYK3fZQBrcahKX1cKZvjwfgoFMdMoDBVlLTDcxbXMEMh3Wxh5I7eVAfuJKwup+YtTIOwfAGSuUUrOV3jjiYziR0oi2f9NWvZkLN4WiR2Da4dywPFhsOP/CAOggjHCyMP05vKr5h16q+g3bcNxIup0I7dt3pwYgcbqLvrBKsOLi08gKKQT1W7O+xF9ACNoorrexhy0j+hQh5K7blCCpLFekYxoxfHLis+aGgGoSip87xcrwG8AZQhz9arFYW6IoHtHky2HCqINml+NV8sN+u0qmebckadYFX14FjoAQhdsUET8+gl5J5MJmI7AICpw9CLwiCGqncJzV12fWa3zdqWscocFR5BNf1dbZSLGo6dFXRsMAkGj2UOluD5ly2D6naZx4gHI//bqgo0slnG4ls34IZdKqHozip1dw19A+Dn3FD0Q1kspdjZ6DVdhxF707aaoS5euIGE+YIndhUYrIRIuyRvp7dWSEA38jVbE6ivgAI22k7KRuMOUMOOa7n27Mig4pOjDqZjnudZ5In94SAIQ3r9DcsarTvg8qEfRkAbg9uMbj5fzqrN0vUCTrGKPhW1k3VKB2uRsxiCDxPwIkFvRg2kUNgfwg3ufEbHakVV5jItL+d0zMA7xcgAyg+VC440ygfW7uMUaFhWmIw4LIhGwSygC6rYFZWKPsNu4KLKLBpcE0JMn8MWzzwNc5yuTZoZkSse+JrOTjYGfOxra+cvwHnYaSTngXoH5WtWZ8oui7TtxKw9pdBde/nGDqldNu8MH/UOgtizkGrjkCJFq1fVwvK6s1bzeogG5NkpsZXTisHf8PoSXe1mLbacL/3Vm2hn14ZObPmVPJPvbMu1UZqn+5GuVs+ffP75px+9ev/Og7t3BT02dHaS3W8peJQIrgwjAKjPPF1HJ5sViMeCYWYuUpcsARopqhLOubCfqwF/diljVZsko56NztHlcl0U5TotrldJybGKjlWG2r70GIjCOw34D0qz/mKJb0B34GkNvXU7XQVgDPWyaEWuIZShpAEjcCgRjtVrlE1/Zf38WhcSI6Rm1oV2DsCUZ2EWCizep2Bzph1XM7+dpSPMAdpSuxpon2Wf3qDWi471qtOW3lurOy12k5LXgl8s5bZrXSGk2rE4V1ACVmbIYEr4ZhS3u2xu9ZleCEviL1cCadmFStldod7ytoU2ZkL2Z1uUMr8V9fTs+Z/83u/97m//9sN3Xv37f+fXHt5/pV4+s77BDhfUmEIK5fqKDklVAOpPWcUPelR6b5L1OimLgmewFGO8CFMJKq4gTVVSjQXEcL1ZbxZZOV1n8zXFNGoxCyq26DnFEISg04hBjO9wG88ESw+KoCzzIixXl4XXqiJnZE6RAaCrhN5Wx5ZLidvOAiXudvcHdjqDgFzZsIGFrbOsjH77pcpIMNjiU9hhhIW5KMnaXbZz65iX6875kLYB16KjvNDIitgfITsjyaZr1HoLsdee7rBmnS2RB0SRygw/zeLGHm3qTbHJ2mLPG2SQqYskS8DrRul8hwbdXau/7HDp7VpSm6m+0Fu3HTOOh3yVPVIGbYy2az2b/uQP/vBf/tPfCobuf/vf/cO3Hz7Klucez5GbVriGoZwsDJGAnnsAMGZdeQEFJM/34lBoVFZJUlB2glERPRzqCjdZjuWKovRYrLMc0Cw2eIB0oK5wdALXiBYxKb8OeCGC3wvlu1YKv0VeUtSgMJUXeZJt0nRTFWmtK8cuDwyIVzqGEGUqRtdU76ymIJT1FRcmBiu73Gmkw7XQHUNKhmWKRiujcQhSW1tuMy7VWyNK3c4ZpWMp6q2rUndktYUqtPvm9kd3aR5eo5fViCa0J6GRT9Dbo8FZCFvStKziqgqqOjRda3PCzGxBdZAUOwens6T868BHLQ3aWudaJQgeB/B+03z7Kk9mp88/ev+j5xfP/sd/+D99651viM11Wa38QazKUhrCSjOZwJbZDyEuVBSccQwaNvDqOOxDocxN0vUmXa2zlL24EzpJhUlbVnyHks4ggM1qVUte+QlWwWNFd77V7BjPrGRAQxspfMkWgBT5MM/QxiRCNRQnY8iNGGc9swB7s+NmJuoaCQNYf9UlykVH2mq26fR4qqM66OFd13aLondas1tTHxm8gWu3Og1nhdu3Xcdu8SKeQLQG5I3b941Y4VknQMwgcatVuyu26cxRTKTguFQbT+Is24QhtYVB4dMzcemVV2rLnWmZS9rROyie7ZWKl1RYjYOnsAFL6Y7VgS1ArBA+L2dNF0vFSo7N23KRHN0+/pW//WuRK7PVdT9W/OpX2gqYGEKt57i169de7VZB4Bbwn/GA2w10gNqDXhK2g3Z814kjr8zzXkhZSzNxBvL7Za1Y7w3rppoH1o4d7ykGfdjq2LU7AksJNBUpdaV1ClEoalh7kAXYsKsqKFGo8f0AB8gag2IUZTSL2ViTsgow66bkAlRL0nMSlgHdkOEl21JYFNVW3dXW1AbBpeHgY62CzRFqPGsM7tnmT5DXLO/wBRCd3R47N/JcO7BtD7XHeoFGGMnBAL2pwk204NeATx7zDE3woFsOblhV8GKnrXZeVoP/FcprL5buYltjbSs3nvmxnpNqwN6skQxvNRe9PR0P+Z3vfefVVx/KZQbWtufbmZ/VbWNgjPFox2ArQGfPOsSCZz7oGZkchYI9jOm7Q5TN98I8j6kkY0u2JC1rUVM9T4FQGb079iaQTCqR7E9qWMkQ7sPgGVAVK9YKZ0w58nqL0pWVuH1ym7qEIktQdTGyzmexOLaMwCMzz5W+ki9YGHgPJvq+Z0Q1mi2gtLOHZhZugFdslKbsk1GWj2rrG93Vr7aCa5KJa0wp1DxwEgYaJW7YyO8EwxtgvxtipAD61UYlR1j1IdWMui2HqDGfVzYTKt0dxr5wTOSOQHJ3p/OX76f1zm5cKdVy1kRXM8uu7HH3qUYp041fo0ga7Y2/+0s/GPTjIldOEApZ26qvFbRhOJGypE2pXAq0ns8OhwIZDsanyvdLVaX4CZIlgxGi4ZUqHApuea159G6fjY0JLPMkjRwLjyc4xmCgFlBvwD8egy0liiofBP6wCi+yerQ/ODk8Xi3nDsYZ+JaGFV9S2mU8cg09VTNnt+9YbRMYK/SVzLRxLb7P5M6m75KiiSnG1hDUDls58VOTHd/IhinY0NitJKzTcVR6ySPWL/6/F+MIeIW1HZ1xSDAIUsbpKiF2/lrH923LKlPOi6aD4quRotttk/gqzqq9KWYxuVWK1128toBjTJlsFCgMbhgFDx89fOutr4GTGcaU7eCz2u7mhVmw1QYXYRtseiODUCoPOaVIobnjedDJrepCQlCvKoF055ccSxicMrMOAPNSG+aMZFirEtYNVjpGZNT1PaMBIGBkYkwS2ayrTNf9eNyT8ep6vn84iVmisnB0YdxOqVlME8q/lCALNAdbQIFuvDmU02rWadlU5a4V8EPlUm9x45L5DU6DaKodi1HdAVpaOTNhhvRSWH5+C6kTHcM4q2eqtqRC0QEadGxxOOd4LBkuGu6x0XGzhDbbJltLcMfRNxZ9OzvIll0jdiKo6CyYxF9J/doO7TrMWt3+5O3YxanTpE5TxGzf6w97bzx+vD88oPDhxpEDHaE1WDquC2CPsDdN8GqMYhW04FXg+2w+ZSptoIsxIveljHyPjlXhiloK2AOySBiWdo4T0CF0tAF38GwdgjoFT0N93vZIFhvypcFfMKCVlSTQ31V6OZ/G/fuTePTnH340mUyODk+oaC+FADKLvVRWnrd2lqjd4OpUah7Aycb/jMKgcErX7EC2THdziJr9W6OyvDUpkg1fWVurPKunhYbDgL1Zt99U8N0qamsGsB24bxff3YFoM/Dair0J6Zk5nIUYtdBPJhh4LVtDN3tGOyuQrUS4vOFk9xIXJ/1SkOhXyc1YvqyyGc8cqXZhZEjbfKo2qipNiez7/mg8MEYKQew40aRKZn6eiSDqAHXBHGGMN7S+RADgHAzltPL8UPu5KiWEUSQaMzoZoZQ5ZSgoWWB/RqcmRDmDEQz9SJ+Ns6hIy1BXO/AQ5JkmFVaRZ9kaASMtlDJ4earE8vVmFdbUf4br1erifDrZf3Vvf4/+zianBiTNski7Iq+p98uNu1Pt1D5WHV4TXhB5OdVx1SR1K8fSWA9pFqkUplZr0CBmoq1Mc+rKJsvJpszXW2aGsgOIRgZySxgU3RWdYRjsCGy/kC893dRQupP5nGbgayDCdiNs6RoNTNi5SSl8AfzeUWfW7TxFiK8+VtpqEDRANbuYVoY8RwUzvdhVmlZ0aCACCnpgyRR1+m2abNgJ0PHGh+Xyokiex0GI5ZlWdpQoGYKiqJYCORBWF9gSo//34tBRBXd1OEk11JSdwEOMwjSpFtBIoXctcOnchr5n6gbKlQF9WwAIkbl8n06VHzLOVdsSCN/QYFxhpuMrwNqFpHx3eXYWDXqT/QP6FeW5v1lRWZblqRt4mqnUlTG1gNi77eVrXducK9vym8nNDsQC0CA2jRtnTq06iEqjYOYJa3DL760Bo7dNom3zrJBNJ0/shI3mNVV2Fb31X9IW/WfLOc+sXADBdkQzPjJCOsbMXXSWOnaMYVAQYjvtkE4neWvdJVnobZ/w12NBqxaY02jXmwsG278onDyPGEhtbEuV0cDnN3g2neZZgR10zy2HR/nmKkgXsn8IQ0PQ0/mHA7joS/50Gg6/yvJhA4pgMW6nx7Yhdap81xnEeVa6sKCEcTxEGYQOIsjqMUy9wmJb8siAPzo0lVzUVS4AmozarhV7e6GJ26S58r1eb5TnUFDOks35l88/CMJ3XG//6JApX3UYRiFVfp6rrNuZg/FGZfccplTh/ZApgJ0tiVA1aAOTklSLBVZmyA0mm7OViuKNkVmrKC7ozehqa+qs23l8Z5nyonKyaPnJW2dKbcTfvPYrWqyVw82fqXPUDl6vbU4dS2YzhNEd9J14AWSx6zm9Heh+FQNsawXLCg5GGkPleU7p4c5ogBrIysho9k4oqGD2w2A2m87ns6hP/9wNDg6T5cni7Ef791zHG9ipIAZFSIXC85grhm7PTqjpU4U4ZNQeqrr0e71YKblZ6wo20CLwQs/lGMKDJdh3l/CgLOnMlVlJ/SVTW1y8xJ404BpRMeudV5uyqqrFuhgfT8Z7J4vLL4xsRJ5svvzsiyLP7z98eHjrKO7BQN6DUrwf+hRBqUksFNtvmWZYKLWtls0AASFHb4tx1c4fbQ0h2wGso7d33eJxbUZiUk6LoNRCv/z9b+OCgSVI6z3QjSC6U3cZs/EtV8Ly7WtLz9Fb7QfdAhQANGKYA24ni/i5Jmp0XQq1vrlUFje11V66gTYCEIhPrLymjCI5narjYP+dV+7tj4cmn7L4jZAtzRX1h7o4Oz86uUUHT4ZecPLK+vr57OOf7r36juNGuiNxoVxsh92qsFogbDVqcDogIUc9phsA9QISiw8/JsGoBNwSBsNURRV4lLhkggOu6ctcT/ocTLTQcit+L1PUSnq1ydaVfHT0YDTZX33yY5A7vJhOcLKaP/k0W8yXx7dPRvuj0q1hhQl2JPUevlmFirKy7T9dbVU343rre4JCjJeSsoOwVHpLgzEjo8bgs5GQVWb6jcfmccAyJfZ2+Wz1Z1pvye3ipzNikDcmSZ19sfaU1TV1TIFns1CzeZZOow5hg53hBoFe7AGCCZwgr3el83JK13/crzYUq4ZHS9kkSZLJePidb7371uNX6SfCm4038dh0eoiXPAmiNk9+9BcfHt+6ffvubToS4WRQPfza6k+fyU/eGz54C/aFdYMPbzYBbiMljnePcTUo3TB6dgFxd/nD+l5VKhMY7Lqlhv0a/RUfStMVjy/RIcLM1xMGqq+42c8r04E4V/OVPzi688rrYRQtl4uizLUTs4cpTtesrpL1uj8c9if92mWPJ1PyGCsCs/IQhl3hKEtGZyKLsFtr3ZDrRQcQYOx3Ou61ZtYitX1ljX9FYxHPpW/jG7BLvXmxOG9UQOVLgFgN/avpKZuUwxVWJ9M2qDvBEF2+PIz/XF6RGgWTFwionWK8CVLir3PmRCMRadeCFCPyLN/bG//iL/78d7/zi0EYlbDFQsekm2ysWDjFiBldXpx98P77473JaNSjP+/fvl2n/8n8T/9f/eTDwd2Hbji0dkfgTVZtMWhl9ulTBfCvZXy/xrwKUvdZAOwXYhUdO1Oulkx2QGKqSkpdpecWVc2uWtLzPVtCaLj9VHwg6fNcrdN7X3/rzv2HoGQzsgrVTW1Y8+w4jp10ka5WQc+next7A5feeZVQqKaEy3Lcrmh286oVr3bstrljBdnKVdnfStms1djqvKmTzd3TRlulCfxatdyJps2SToeBsEt7cV5YttzYFbYUHLsEsihY3bhomGioWiE0yxDUDYKiZuyRNtNfuxu+6fG6Awi0clDiBfioTVWGaMlWWflw3P/+d7/73V/8bhD2VpsVZgau10gCC4YeMFaTlx+DYfzsyZP5W2+Mxr0yU1SRDx8+qqtfnf/4X6jqk8HJHbc35HaNdawhRsqXAoYEpoya5Xcw5tR1wEVZ5bjabGdg5o0EavYkQUDHrigl00yM9ZZruRyUF7GSA7cVQuYUzVZJVsneoze/OdnfOzt/roC7o0hXMcsGq2cc2wp9ZUa1W+FFcTzuj1Q8iLyEuoAKNr0pm6OKpva18tnNwFNvM5NwGgCy6jiACCtXA2lIgAJ5bOVKq9djGbvaSoNo2212/QBfODz6K7l9Vs/DM/FJddF1dgtuOkhpZxGNuRmAaYwNMtpo9RYEYZxhm2ahI5NjD5C0DYvoWNq/xLOa/4diVVmWg0H/F37hF779M9/x/Wi9WRvgg5lKmx/Xnkv44lalF0g6i9cXV0fHtyl4UE9HPdbe2687XjD/o/+rTj8cHt9y+xN41muDyVTWNgyzT9jkUqDi54wcDKNM1Fw16i2uJgEOLCs+Z6i5rD6VAR+WCk0FY7srnn0hQbJk89lsfnTn9QevvU0xdTGdpuukZlSZYFMZbIFcl6mntYvWoc42iVOq/nB03DvZiw9G0eRqerpeL8uqaHRZtXA6Woo2KxkboC2RVBmBo2Y2qhpRjS2DDsstfhsY4gm+hvW+kNY5ekcBppUms6pH2gKwhL7pBM4zQ8duKs2q0kTohuPcFNPm5LFjNlUPCCXWfFNtqTpcvrSeLR1VSv1yYmor7L0NWu3wrcZkYTDqf/dr33/t9bfoe8+XC3N5PHeWBrlWMTTL+LbTxWw2SRzHvqeefP754dHRg8d3k0rAntKpJ48fCPlfzn///8w/+ovJvVf8yQm7shkj8tqilVwevxa5Zlll6YXGNMuitJH7GRqP0UOl2JIb94DfLMkpRUIC3BNGIqswFHkqs8RyVXzz5765d3xCH2q9STKG+NEv03xUKOoQdB0Y4pkRhaYztFrP18mqHw9uj28fjY9n6+nZ9bPr2UWV582euPU0FTxT0sZ6QVmjP2vu7eiuQa609u2NrpjLsC9pRWpqg+Qx8/ib5CnnpRiorvbwDiDKc3ZweNYWstFN6GQppUrgvRU1ETndIcDdyro2Ay/2feHJi8Hn6y3dQe8IY371IMtSmrWh0Yt+v/fdX/zB4f4txIiycBktbpfvrKCC1sGTeVaAOup5KqshWRxGQaCvr2eXFxf3H97FZFKx5ZFwRg/vuNE/mP27f/L0J/9u79bB6P7bwvNRaSEHKUitej5PWlgUHttGukkFiDX0zY0INmd5CVPxuoavreK+BjtIqsyiyIt6PU7KcO02zOo0qxbL9eHJa1//+V+Ke/2zL58sltP1ZinQEniK9U4lnwSju8mJFYsETHIZz5FlCV1eFEcnk9uHe7dW6fz09Mn59GmargHv8TyEGJd9TgzgpiFVsBktP51GBpeDE3MJ2SbKiqq4RtKhQ6/gBk1sGQ3ihZzS8Ko5aqlWy7GjW6x5V2g0eIXu6uk10zdGiOEXYlRZFAxtoz4bFpxUV8dxSN2YrqjS5KgpzarSmjm1Tp96x1W8i7Dg6QVqXp9BXVlBb+pqk2xundytS5bfqxWXre1ki4EAFNJqBsrxu2dspejuM3SJnnexXMzTJI97YZaxbC+MBWT/+ED+4O9d/H7v2U/++eb68uDRO27YR59eFzywYOUKrnWs6xQYSX2YEhoHMrpWgP5KihlljjtRVjpHR8qEVmDmQefAA+QJLvOkq01SvPvD//TB62/SHVvMrhaL2SZNXIAp/JrVOujgc6EluSqvDbLDGBNxjKT3OTfngi7ncHgw6U/ubx6dT59dTJ+ukxlCMp9FR24LWt2ywews0DBhuL8w4EEzpW85wEYH2BD/HGXDmbBSZC8NBqY47YKBRbvc5X97tmcTnVPliNa1wDZRUJaDBhh1KPSnYZpmaZrnaZn3qjCsKg+upYbF08xUzXfRjUCSXWd3rhBzCg9TtDwv5stVksDhek3Harmi8ipie/oaSzp8WkAM2HQFD77t/NGvuZSW16sVvXZBAAk/6qmiMJheXZ6fnb72xkP2cuBDXil6evHJ3tH3fr0W/vM//D/mF//m6PGbvb0TyVQpynb8oAsj+YlhtR9IP6SD5dasf1bmVZEVecqj+DrPKgpbdKzoYQWuGb4grdS1rQFSwA+Xg6O7b3/3l/04Ojs/XdKxms8Wy4XHYzOkP2PjzZowkpER0CSpUAng4XJfQheSV6VOUsxsa+UGwd5wfzQc37v1cLa6vpw9nc7PKb3SX4QooLCrFKEtUq4RSOZ8z7CxVp1lO2loRSGBXmNKjWQAkHhx2+tsdVx2YXQ7c3DBvMKt3e82noiONpFm1XdUVkVR0hXnBd9cuAaXDHQ0ADzjB64aJHSrFmMrLmmpQHT76N2jMKDpHs+mdKvnRZajYMEPARiJnlORlbKppgx7wjTK9NPwkalOxuafusKKnl9V5EGvbwINncX+cDCbzj//9PP7D+5z7VJZ0D62grp/ODr53q85frj68b96+sH7o/2L/uQg7A8lb6wZFWPoZApi0UEsw5g6AgHdNsTsbJ3kaY7FX4VOJcQQX7umH+QTRZEM83hQujwRDr/1w7975/U36OgvZ/P5cnl2eXE9vxr2QxS12F17yhogO833QaFmJj922eJLhoNnLhcBMOkM4Nq4Pzw8HB/dPbx3vby4nJ9NF5fJZk5xEfUNnXIBEppR7zdGCqzsJTm8uhY4Kq0olOV8II9a00WjCN+YcXeUD17SFd5gGNqaytM3tKvar1KttJ5i7xMAtfEmKUC2K5MydoVjblAyuOJXopngS2Yv+i5MlK/W8+nV9eX55fXlJYXBQb9H5ZH0vNgPRIBPRefLqDDYVapZJOsWKikMnibLKIRkYRhiQF0Urg8vXT8CKH12fT2fLg6P9+u686G5pKZ2q/8rf+ez/uEn/+x/vXrvz/b2++OTO9Fk34cNIttUSpBh6NI9EQEsILCUhIYVBdVVAtoO+0BBGomF2illQd1Dcr1UKwpqSVr2ju5++2/8wvf+8/+Gjub16XOKxsv1ZrpapHm6N+6blkBpKzHO0ktM01IWywLl+kAy8obN5SAGAQ2mwPEq5uEXZRZjMDGejA5uHT6Yr68up6fT6/PFalZkCVUHVHxyBeYa/yXH2tobnCkPGnYZnuZ0N8as4v/fuLs9Et5WNa+rbdsRONVsU8GiBajaXQc1DWp19OC8gLCzE20AHVuSstqxFDasRyqglvP56fOz6/OLfL2idyegutf3pXVONrp1BsrtMPzRqFWgeTcFmYVUUODMsjLLLHcbumf0tgnPC+hIxL2IysKL87PjW/smFTNFlVebHgQxnn159kcfnMqD74dpdnHx3vxqOjo+Hh3f7g0nftwDMRzQ9UiHlJYyiorparGezxPUlgVdkxv40udjCjlpGSKE+NAKBHKHKrFqs1kfPvrGu3/7v5olRT2n7DfNs4SiIaOLXSEa8xLuwpqBkiVYWbEXYWsK+iE+HWI/KDlksoUFChh62zdrCEyEcS8O4uHJ4+P9+8tbs6vp2cXFs/n0gmpgHvOCAWLik1nAmeflGl6g2aoYCRq7f+kKFn31ANSYQxmSj+7WTc2uUDVQ4y1Wog1FlnfMqztrBwbmE06VZ8j1rompW0No64BiKPLCRnnOg1Q6TNfz6/PL6cVllaQGLx9EMV0cJRf6e5Qf+Zu64HNWNRXDBuFYswMLtNdgv0JlT1Bh2JMmm42AurBLaYneXS5UtPG/CyPUgWfPzl57802uVZQRXqETGIXuF19c/G//y2/+63/+r/7e3/8H3/3V/2H2Z/90/uG/r2frWl7SwehhU0TH3PeKyklS+hH5ermZTzerTVHzeMN1GVyhnRLze6ADERE8ljJnYY+qcKNeNDr55JPL3/zff/P7P3j3zt6Bg1221wvB6AfIzm1M+jRyHyWvEkgNKsO9VliWbrj5aTxAp7bV427ciV3X8kAh/eMUeQ5QT4rEujfYPzm4/fj+m2fnT08vvlwsr+lG1bpsGDzaAGcMLLCl3TuGX78VrXZa+R7RmSHom6b22ortNoOAVhQZTGgDUGmFEpqhLsuR8GbW6MqwFhb8m2pPGVcW65rQmEnt+pt0dQQRYeh+zC+n6XKZrNd1lgsu2/gZAGoHCTIWs/JDifUftYeYwlZWQIYFLVBEc4kMy/jFKknXRqqBIxzVXqUPmVCHQgq3mJ7InNn0+vmTp688fgB7ZuaPeyE9P/3H//7H/+L//q39yWA4iAZ3Ht1+5x+tzz+5/tG/3Xz2p/X1vEqzeDiSUY9KKzfHwSqTDRVVwFB40iAGMC/FYS/tTsKwGyDcUFF2psLz1ts/e/y17//O7/zRb/+z34ri8t5/9hsxvUJogzCVB2oZIqYQC9ENmN8s7jzXtXsJAQI2C7Dgg3NOw9KfMj6Uj/gNxKiWk4UyGoz0DhT03DKqwF5/9a2HD15bJxRnr68Xl9PZ1Xo1r9D/ok/Aokc0AkMcP+mc10a2QdjJpxAv2Rnuwgc6qNEXRkmsYNjY/7bQOkNkcmoDaKsUi7CwKlblmubVMXIH1sdMt7bCW6UGq3VCEXG9WK2m04qab6p4Gd9NNzcrS83jdVEJzqdCFtILfSie+5gp0S9sb+zykhnmrqSSKl8n11eXdK97vR4Cp5ZsNF9TmgiCyDHmAMgvXrJZf/LRJ/ce3DfDVbq0IBAXl6uP3/uYKp741gkVQ2dfnG4Wg7B3fPKD/9r77t9Nvnhv/qPfrubPpVx4/Z4X9FweuICBz5NP+omG1KUqAbcU6u9K5qxjByjKrEjXy97hyeTxz1xvnPd/+uNKFxfnF9ScUFTKKyBFG5wU5xIrUNzgICm/U7Lj5TiHRXwK3sly2FaO7wVSIHfwfZZ0YxC8uPH2IYvq1MwAUeWmLHK6k6PecDyY3Lv9MC/zzWY1nVFVe7paIy9TL8p9rNdxU2494F/0DLjZFhqz1i6JotHmsrpNnkWJ6mYHrQyvyaCz+GCxyloFk3W0gQL7HEsjbAZjNhLKrrIjV8B0I5eXV5v5HOA50D7x3Vh70xoUohvADdLrLNtz5cgdawMK5RRcgo/CsAOkRUHN42K+mE8v47hHrZ/HM0aIVqKlcSHRqXPJLzd9aj/0qNt/9uSL8+dnJ3dvtTjnbJOv50vWQRFrqsTLkhrKKKITMSuVFz549+Dglav3/7i6/Di9fN+TC6pgvDB0g5DOlnGhqXmZI1lgnhU+mEWD7tipcrTJt954tx7c/YN/8wcX11d0gZPxxNCyihITMIQgP2iXuFQAiGaqBB0RZj+bS61rQ6yjF4d+Dy4Y/Zjr2ZSu+fbtu4d7A15LAWHqMU7aZc3bisGPFNncIChcqsl8uiQqRSajyWS8d//u43WyvL4+n83O1+trlqvE+tVMO80ax5Yw2/WtePm6sJXI2m5bDBXVQpN1q4u8FVFroGKMpavYELPif5eOz8ucxhpha25j3Si0sPrYerNcLS4us+XKyPExy1MZqAb9zpNuwbqaeZ7XSULfhz53EIYFiFeF4tsEwKdpMKGir9br1dnps34/nuzvYwyJ68JSBRkSSz1NlyprhwppYyZMRW26yT547/2j2ydmI0Dfrcwp14HHhWk6doN54C2G42GeieX0Ynp5sVgEmfvIOThWaSDP/zhYnvbG++FwQIkaUwgfaGV4P/HdNINTI/5D71+yXg1P7h2//fPn9aBOF3eOD/78pw7FDEgnm60znXhO6XQvzSczOvXcDtliCytqa9dikoICwIcKgHRzcX399Oz06ODozh1sJLkqwy0tETIpsXKtgBaS33w8J5hOslQfJq1BEAJMGBwO+5N7dx5lxeZydnZ9ebpeTUtolUuWWRVabCkTQuzQJl5ubdoxsmvEwYXX2eY2f2oZ7SAdmDUid4W10R7FAalhloBNqlPrLWWLMW4GfaD0ajZfXFwUdGKUScCtdLfi7sxFEsTuxKXsShVM1AuH41EYRWWxllBJVMwkdw0wBsL8yYaiFb3Q4709KF2Db14pvXVRdxtR7grqwkbROKRD+uSLz1fzd3EWWcEM6+3K4I7EZr0q06VTpPR0qC4ZjsLV9PTJB8vbD99xR4fOcC+T7vyjf71ZP8U8ot/jrCS3nXizC0GpxDGpLLK77/yct3/HPZu/9ujk8vpaomaPyrTQxlCLq3/DEBRWAMWivc3LAFV3xTxUHjNhNE3ZQpdXVC9eXFzN53Qs9yYTQExxKB2eu9FbSn21a3IIPC4lI9pq7Msd3hsBKYL7WHtlwd/d7ce9wXA0Gh/cOXowm12cXz9drKf00+jwDcI48gOXiRcvJfdtlUe7TaQWXY1bb+u7s7WlaKFeFqnVyLsYIjRLOlW11X1hqGe71qRohd58NltcovXjHQvSH4+UrfGry5qISIhVRddObxAdETpSWZJenZ+ZgoqlA12hLJKHTtVsNqeadXRwQBdACRTKd8xAd/h1pzsHc/sgLFGMVEZgxYHblz+9nn/2yWfvTsb0DbdSqNrJi+L88vT8+eHe/pCK8PEBhch4PlXX56v9k2RAiS/a9x/9EhXjmy9+X11dT6hh7PeALQwCFL9aW8yJwGVo6irW6fjw1ujhN04vV5+9916SZqcX57xfCCByWlarzTLLEjo6WDQ7dgZuRMVMO2wJMjwLpshF/49ev9l8Nl3OpwtsJ3ph9ODu/f3JvmngA9et+FWhv+hjR2SHiy4DYXCwrCaVQTnwyggxDopylAXowsIwHh3c2R/TTTieLi7zMqMYHvfjvdGkF8eg9L4USCduYDO7B86+6l4jPrLDk24khCzozkoX1VZPl0W5tSXBCyNBV1cFwyGzajmdJYtZTcUT+mpu7hh3CrUhjFTwzZFWC0wcKX9EUUxlR57mH33wUZYnkjGpURD0BwMqYwt8YZ4Xeb83OD6+R9eyWa97gz4PgRzzXlOiRqKJQoZwOjyct28KdQNBFH74/ocPX320f3jQbhK0Q+3bZrW8ohqMDsjdxD1KNsmq/vxzqu/6V9crKvSFk/X2bo3e/pXpZrr8/HcDag0iDMk4NIKLgM6YpRwNvog+8vG3v7fQ/Y/f++zJh09WlGk2azhWRxTqxDJNL6fXWZ5GkWfbPurJ+TCZBatsrD5M8MLenXPlbLX84vSM/lE/il+998r+wSHdLuVYRIrB8DLrvmKlJGB/PDbF9Rjewwwiw91htAbLDPDyWDL3OqNKh1Lo/uhwMjyk6h9rb6l70Sg0zojIr15X4bFd0egdvTW9i6/hXaEjmjq8AbZbsg4EMNgogIUwrHCC3nLMJWvhlGlWbVIoDFHzk6ZlVsInLe6ZkMaobGx4Ha5wjacohD2LnLo2Cr3MyJObJLm4un5+fnY9u8rzlPqiKKZyIKQv9nzv1cevfusbt6nfT4tEwxEdbu88mQMXymN5P2zKy8LkFLzEeGxo34ej/tXZ1ecffz4cjqLIpxorzwoI7le5qIssWV5djGU4ma+KPKPTeXDn0bHf88NhTMllfDgq3PRauBgilAU1nyFeosKjektKo77vcshy6hwCow+//unZ7Or0ea/fX2eA30R+FIUBxdrVJl2u1nQ/fTQjroEacxC14yIFMjaTzdAOuyz5UdNpPtg/zArM/Y8mBwd7e0ZLDVMJ7VAL6PLOGLvqkm67zzKiuMk8qPBZcoOxTq41b+ReTVuKFj9xaKuCo8V7H+q1owFa1Ewl51fXSBuyHwb0ngMsjLq6blKf1l2SQlO8N3thrMatD4FovCNs0WTA1drAABsJGB6HUTaIsP6AupRaphssEUvKRFVZozLtxQ4XOh1fX52ssdIHf0vDEjBNU3pUeZ4ZFATdKIYnBKNBf7FcrPMNvab0TeliRqPBz3/75775tXfHoz36GzXAUhDa9+m5Mw5Y8EyIEiB9wziOTQBmHwbKCAGjAuiM+p9+9PH9R68Mx0d0PtKMcjS/t6oejqjQiHs9f+94L4x6+FsO1dey1/f7/WB8fHz6F+dltilLhW1hVqmQzmzuRK41YKkl22kAZBdP9qpglKxOFYUBx1mnKfUSgeszvEZgc10VCBi+b1yljJSiIdI5DaDCcF+4xAAhMQz8B+N7D+68sljO02zDtpeS6qWawRRsiEGlFp0tT9lCWRrH0tY8nA29lJm9ebx0ouAWBOyAB/GcGqNu38XqrYZrCxfwaGzoPbj88snTjz6cfeMbX3v3Zwf9QRhGjQ+02E49O/xDa5TM/+M17NQGQMG7WqUMr4gBRxzQzCArDINXbt/7xqOvHY4Ph37sVqpUudlLaBZOAY63Ob247VtFK/SRBTWAII/n2HaVsBtBXIGmIwASw16/HBbF3l4ALl4xnaf0hv7Gr/3Gt775LhA1eebhZgboq/mManZlCtwATskCTaKBfkLdWqDZpAfJRZAb98KLy/PLs7P7D47oWG9WK7pzYRTOFuuyLgbjPh2vwSAKIno3KvoIVIisFvlmkSnh+aOj3q3H1+//LhalSVpTmeWjq3elvV0Ojxbp6QT7J4WSQEHkeUK9bV73w+j8eoNWUvqmZoX0NiDOAEtZBIuxNrGWohauZJZ5TGCk+FPRE93fHycp1qysKIE0AgtZa3fiUlSkn4sdH5+RmkFmaDzx4jnGLp7ldNAbg1LkwUOHopzgusCFWo/gaZCunJI6R20cBpQze/b0z64vls+fjvdGj77+M7fuvQK8KwttdpHv1qXGSqOx5YkwammWoSycLdqF4UllnUFoOOv3h49fefPe8f2Dg5PJcIz3SThFWbq85CoZEYUbYaQMW3As4LYC/VtV0ud1GaxYFfyV0OFUDBYtsajx6XXyKNRTuUi5o86z/b3R3/ybv/zaq29i/V1mqCT4NtFhMvqwFBSxBAKxqWZpW5eSVYAKhs4WXYZPMYwPH2Rf6jr/5KOPX33zdZ5tYq7jMX7q4vTq0etV1AMhnvKSj4mOECFVGV6dqcXlenx8cPzau2d/fDtPF3mvx2AOxFduGygh+1hsVlSLVMPHX1t4cUbFQF5Cq9wVi82cex2MVdFaeHg1fFh8aV3qFpNufOoFk655U17ZRlHawY3ikQpmKoEcDoc1O4PRU6GrpdaHjnfJvV7Nvrg4QL4wdikQkvD9wqAHQsGkJmEho3TPa7dgG+sGg8e6AUCclTzJElSx0A+nN6GYz56cP72+uvyFH/7Gyd177KytOqq3jTeN3spoWQ1SK0VitskUqbTKitxAgA/2j+hIHUyO9kZ7AXW5LOlpxFcBdRGawrXkVTHlFkNBYcKudo0iLy+JGboMi3ZV69YUm1HIuCmuG3LirelbjcZj+vbD0eDxa6+fnNyiv5clG7q6IOw5rBRFH547d4W+CfjSEttwx1AqBL/Iijk3eA6oulzto/sJnz59cvr8Iktyeoz9/oAO93jUc/1gMVvfoabS48E6rOB4C0DHnQ5b7eCw7j/ce/yd5Xv/T01hKN1Q9Q3POR4/c9vrUPtAzUA4OUqTYjWnEOVNRvsZQCBlCI2tghoIljOT/R5+FSBnWzE4YWwY0d0Yc22ekWLugOPLEC/8RZxHGKjgo0XcRJglDtrrguKq8DmO0nWwTCkwA+yfDKF5hskBk+KxDBd9W5+99djWyaw9DNoZg0bJpbDmlJlSD+tHvbgHVGeSzT/88Kf7R/3RaDSZqDxvcZzOVql2u9bzOobz0qjO5PA59ibjQ0AyxvvD/qgfD3zXRwRGusZAC9AeLgjNiWVPPQwKgCCWdYMDw1mFVLEf0T8FjLihP+DeITYA7exqZSKz2ZH7QXD/wYPx3ngwGiVJIswGqcGicYh2lYuCgGfWgBLQbRRUdqPuESiyqyqEJZPPi0XXkPZ7g97VxeWf/9GfXD1bUAd7MNnHtDAMjg8P6Uwmq2zvoA4j3zRAAtJGyDhxnw5RNT6+c/sbP1h+/G9zqs5Wfo+eK2BYCi5Q7AVMvZS/d2ejjz786ae6cB688pCu5OnZc3qog7hPLwad7LxIqbuI4pClHBpTN7hBe3QTKNTwltCulkFqxJXg3YDSluuHnl95lesYj1i6TOzbioKa6ZTuyQiMSOstUPEywLE2Ajht9J0rI5PFUstYfmCO73FXzXL0nNbwssB3i4oWOsIQ4c3KehSFcRAVObalRZp+9t6PHr75teF4Yh692gKWW9k0i0LwtvB0ZDRqWYuT0eTNx2/fPr7bj/p4sysFuAyXRNxM1QbYietA/HF4NiK5s+WazJVW759hZICcN0qF3Pyif2HOsU/hBNC+nN7RnJIEL0woVo1u37sVx/3lclFmBTvPgwrKIhbGYl0xeEYYWQtoCaEfLKGmjQEHFaSV2ecyqNCli6fzGPWi3rD3wXs/ee8/fHRxdfrqvXv93iSIor29yWhvQN8p3RQ4WKFnlFuKrOCDFXqeMxiMioevheO7xfITehXoYUb9GKmXMjGK7VL0j/pv/XrqHob+2etvvbE3Gnz+8ceL6TyUVDj2lvM5RZI0T6g3pM4RzAFMntASeSZcMenX4Ptqno4y0N6ELu58rcCiomPG6ky8e2Z0wHq9oW+wv+fyh+V2gjdBrA9oPZk1L46McA5aZZePlME4AQ1iDOnMTFDz6Jvag4L6dD8a0gngEFYZCPX0/Pz0yy/uvPIgjmIK367lCOmtDcF2Ca2sVwFlVvqZt45u/czbP/PG43foXVFsSE0RAEoaQcBEscrhwogqHbr1dKhZn96nfwH4UcAEjV5ivDvonqWZg7tMx2PxQbfk1SO/HxbMj80MtjgF9WbjyWTvYI++FbRfsaNwMe0EqBIIcVbeE9SJwmaNPypgUPRzsaCrsjQLY1jVe+zuyLaKbGwKWgKy5WA0vD6bnV0+Pz1/dvtwcv/ugzjei8NgOIziHpXtKkuqIPQxwORlg9sQOelJh/0oHO6Vc2VcaJQ2Go4CtVJvP7j7S+6D7wRJ9s2f+6ajq+XVdLFaLeZzeiy9KF7N1us1pSs37vfoya2RRPhJcklQcnIP/EA2+qOVLiU35AzdZh1FxCdl3hPdSDBIM3Eo8jge0JFVVmrDFCkKEz1XUC42NEyjwGwRhb7H038cxKq1FUAtJ4xQF/0r2awrJScH9AHCEvCBgg+9Sjeb0y8/Wy3f7cP3qhH8MMLxaiuUppjyz6maNeXuntz63re//813fpayBEyoyoJKUXro0BPDwwI/k54l/aLPDNBLRv0PpQdMDlIUiMyHsnhYBnGhTBb09D2uXB1mTmMhxg+PNxie2RxQoU2fczwZUXxKNpu6LAD98zGxMTtKptwo1qtmuUSKW5RH0Dd7qMNRgTBWgiJciEkpNwzYD/jMcaDfUdg/uLV/68EJvarPz860zo5O9np0FpUT+g59Jrq9zDxCtg4CXKbR7cRKji6Vmm3EZs3xQgGXViS1jJ17v+g//AFdcBTI26/ciuLg8uLs2elpUVcjNshwHS/L6v5wTD8LTQ+nHkzbPeP1KrmnEfzi1Ka4yHKK5awzU2+hvbjtgHVDlwYyR7i9+LzD4YjuKqp4x8UbBjUeHBTXt+hiZkODIxnRxWC0wbFKGPtixuo3pqRpCvjIkmLschFTrzwYOjwVM90l684Wl2fPFoupxfFahSvdDDe3ZiFmCU3Zunhw794Pv/fDr73xLeZ0V/1ezA9GlZBhTau6pIfXHw4FRg+eRcioGm0/nWVsqbFPpC4FcZifIv2GLoWOEtyyuImoOJwafiYTviUbawLLTveFzuVqueJmCU27w/cCZVNKzV3BDRWCE15JVSOC1hU1rAZ2x6a7lFtrTJbQNloUF8NQLVufAnwU+w8e3Xv2yfPVxezZ6dmjN18b7t2CAkNZ94aafhq/FBRcxGDUK5KyyisuH+EGLP0+UolRAkbfn1Zuzzn6urj3fQf1Vo3BZwBUETUJp2enA8oiUUxXdvvWCYzKgxA9F9pJoxyrLQ3GwGIb6SFjaU6RhqdKJSOVPCon4iiCFlEt6UbVVMXWkN/ZpBtqR+kH0SeMMR5z8ry2JByWUAvRvlSG9ujwUYYXkNl4u9aAyLMuoqAcUM2WpslyufSD3vHhUb8fZ9kKGjvC5eeEj76ezzeLpTGobiwPLCK0Fb+20lZ0EOnd+uXv/fCdN98FZqrKOWPihaBgQwX8cDIpK+f8/GJ+fUmnH2o7njuAbtikNxjQxUFFk44CL3BS8MIwokgZ8lZYAJY2/FYOIsqIbdCDR+NE6TxNAcrJy+UyoShI3xwTYcABsLMB5qkGP5QCFFspu41UNCYOeVGa5MR9Ik4z82SstgN7DuCesYAJ5X15eLT/2huv9HrB5dX1F5997oV1b9ynprtIMhZJM8pkIuaxVl1AGhSgIccNBnsVi7VDGqsu6bFWowfB4+/3J8PAr4MYvpsUVKgZPL24SjfpMO7FYXT75PZrb7yardP51awZtGnYQgkj+MHBHbbkHjyvPPw5vSFUwVBaj/uxhBV5ulwsFnOwTrIkZewIYj7zZesRFYDDAQUdquIBrWEpZafxtAcNy/ciiqKBz6kbEQoVJB4Wm3XwJ+JXFSeVsuCcolWS7B0ej8YDes50tyl1mSPu8Wwp22yoHUE9LcUutnNnqyPNSOnn3v32a4/foh8MHw7kR2Ho83aRrxXVuPfu3qN64MkXT1aLGaDYXG3EcTgcDSnGwhSJIk1dh4glmp63teLAqLYW5iLYQ4W+t8+GSgYaRsU1HcNNmmRlsd5sLi+vkAdd6E7TGUWxhYaAekdNxxVrUQMBYFpTwBkLk0DLkYHwMMawfIor6LybKxVJltGfUXkR9oP9k8nhyQHFz/PTs6uzs3Ag+3t9GDKvMtOPUOaiq4yGIeWdPEHrFdAZGR+UtaDvXWSlSpbe0avxm38j3LuLMSPSNj2/oD/unZ4+O332FIMc3z842Hv1jcd3Ht7N8mS5mkrIx0dQp6eDzGQvhzuesuSIjgIevt+GlusyFmgwHJ6cnOwfHnpBBKV4ZrKwiQvWOPQl/V7f4P1VZWRLFW8CHQYJaG63URVwc4C/Tu8G3QR6MwP4A7FdJeOUq7pIN+v1an01vY6iwdHRoYczTWcopadD/2Gig2LhgmyzWtWclLa6elrfgJliWEJB75tvf6vfG9KTwwlQ2ijsGHWimoFYVB72BjEAGHV5dUE/ezmajOmjYvYjZeDGNUgEJXQHGGNEBzRLUNpHYYTlqC6pFvN4MkdxjCKQ6XeM5hleF4rBGPiK1XpD783jVx813vQWrAiQDKxTQyMXZji4TJ4Gm5RrbQz3KOpXrIpOt89AzCRPRF1WAERX7/u90XD/1l56uqAk++zp88O7947uDkFRzMoyzcNeSEmnSGs/lIP93vTZfHW1HOz1KURT3Uu3YrNY7T3+peE3/4vw3rsalr4YG9Ct3D8cV7r+7NPPppfXw/5gf3/v+Pj41it3BqNBks7zalOzUD6GpUIalVVqM1AC8tzSwmbAtfZ4poNY6wdhr9dDaOcZUGOSxcb1CDmSDjySHUZdmGJUrDvgsJ0eI3AwxdAs7sVa7sIIuoaB75jZkzWsUJRkVtRjrFZJXrzx1iuj/lCx6yLnLsbhcWHDWuEVnTS6D0EYqxsUsI4JrkdZ6lvvfOP28X0sRnRpcF2y0aeisFAYeIyLYtwNvcFgQId9uVim6RlVdz2qTZiMFfhc7eIBI5uU0HcAiblwCsHKR9zG1Zzd3BIrd+Ac6a5GQYCmkOUMPJ8yaZGep/T2P3j4EHxiZm+JBshPwY2BO9qwGbjaFdwD1vjhlD0ZvmPcyo2sO9SuAB+XdDIzTH2cwXgwOhjrZU7F8PxqenV2sXdy2N8bZ6uiTCmXF0Evov6W4kgYeb1xbzUr5tcbP+rTwXOL/4+r7+i1LEuzOt5cb54JV+kiK6uK7oKeIKSWmCAxQkh0I5gwhT/ICMEIIRBigAR0SUVW+oh47np//GGt9Z0XmVRWKzsz8r17j9n7259ZZj/5B/949tf/Jvn0rwjWcBqkBBLjCxvf+Q///j/+3f/8XzjURqPheDiazq9H4wmypf1pi8CkbclgavIJ9BTriE6mNVfr3GdvxZO+c63SxwRCeyp4aQfMJcJGTi09uAQh0LFKvUPoSRjHtyY+/YmDICs02iI2S8QnUflR2UuDpGK/pq2p2bznXwhXt9fX+ADOpcgdLcWQas1jHluxYBqQGUz1Z3sK98/Zf8F4OPiLr36PZ6OXJBdzw0LVLhFmmmg/g0uZBYcxiosIN7FAyrX7MB4PZ9NZwPGkgwMujkMBYxzsr9pnOclt5wfiohDQxwYYql1ibBq813PxC5wiTzf28ZF1vXt/N51O8GpsziVMRKkqv3m2suebwGJ1BWHQw2XQ4s8EamBXjfobPOvJrei8zLjh4yQeXo2zzTGpCNfBwrp986o3HCajuDqVxaWI+3EY+qa9iIWF7bp6Ohy3J2SAn//1P/3NP/93L//+P4pSlPgUfz9fzg9Pd4un1bdff/ff/tN/2T4ux1hNIzyVF1dvXg8mo+UT5T0c4W3aDv/dcjqjeYuxUs2LiSjh0O8MwOVEgZdRyQLY5bSxe1b00FOLJaZcRSiWi68epJEGfeVwjkE/DKGqvouFeEnncARCqxWl8DQmvpxwvh3OWfHZl297/QTbIMsJ6CjE+za4kRjSbk2oRcGmtPesfPZR+sFoYJoRBq9fvLi6uqX8MFugHR+2kxxxGumAtJ0LpkniIpWuqiQJh6PR/v744d2HMru8ePXa+pOOPGc0GAlxubg+BHq2N8lC5tlaMxUomucRgPRNhFDg4uPCjaMEZyTO9u+//+HtWx9Fr40jORysi4i0vKA2MxsZ7DGOVqbM1dCek5DlWrJWgfERmTAqJ8OiQtlBMSK3HYxHp/khOiEn8/br3ephMZrNBpNxPIjKnJV8GHUc8TDyR/Pe5ZKfot5v/snf/sN//W9vvvzL42n38O3T+Xxer9bffv39/d396nG1fFj5jTud3kwmVy9fvnr9xSc3n7xMh+nph7tLdsQprHY6Wwu48lChCokpr5Cbh51n9R3YUjehZVeh1xGFU7PkoLGOi9OedseyKvrpWJtNspatCjdBLj+qDdtbJwaw7hSMuKgkmydDhNpooyizcA7uT0ckhr968wZBTgl7pXZeneWFgRQoL00OOxKeA/J3b3b1SzfAP/sr+OzNJ3iXKp1oAsMpN4XoJJTAMq82RUDxtUy8kZME3AOK6av5/O6S390/4XZevX7dhnFBg52G5rQ00Y3cyo0C36ymFHFqk/8x/SN2HxwmPQG7Mq6RTBr1IpCZPT2tBoP+i9cBEl5f8rU4313iwRtsIsc19QfuPFyPes5e1mS4F8SqUi1BgwsJA147ZqGMz2HCR33i4XySN7th0q/ydrNYz9e7ZNCPkih0if/B8hZtj9Ej7cezF4PT4cXoxd8sM//9//jvdx8e/vTHb+/e3a0Wm/XT3mtd1siT6ez6ChF8fnP18pPb25fT4aSHdYGKDm+H6v8tlmtYYmNo3Ks5IBvuNvJHnh2xCuM7wn3V0pHkEgjNockxKqL0YQju4Iw5ihCo1GSuNXKotWY856OYjDRmRZMUtVIsb6kwVxzqs2DH+0CCfj4c9iiVXrx+MR2NDDRlHihq37O+IPKHbVLiBzeP949371+9/tSS8GfPlGewvCry4LPXn1NLQkfVR7u2VqTyRlYOroKZiOQchmJd1ALfNUWDYvD69na5ePzw4QF3NBrNHD+w4bZwKWFIXbHOhNcP/eyUqzHIAVZrswxqqPgl2ZrWFkEOUVKvIODu/HD3ECXJ7YsXJmwRRXFF84CLb0r40iQWUadqfbwYMyEjVKmkUWUWYnuFkXXFWAq1nVUpLy/w0gGSp83Qw+ETZedst1qPrqdhjA3hF1mNSBKlkea0DgqLPRLyx/fv3j386evvuQda/3AkpDEdzn77+9/MJiMskCQORkisRpP5zWh6PegN2I3EJz883qvXFuE8Z/hmwW9HVuQ+q+VQJj4Q3oIFJus4OuAxB/XV9qOsAx78R+NevBAclYm0BYRj4F/WggsEj+G4WuTBWgpyhvmN2HH269LimriNbVUci/1ut98dcNp+8uZTXPOFyF6cdK1GIvlz97Pbz1EQrR8f333z9Vd/7/dpGJUSmPuZ6/rMHguu57dsCNWlRSlPhs9t3phtfU2kL31s8Q0xEoCAgE8qpXMNsLhNkwDZxMND8fV3P/zurT8cTmq2aHPjZrHp4LaoXKirWbN+IVZPipo4Bah5oEGEfrh+ZtvJ45RNnHS93b5/f4dHMLu6CYQ5qYra7kAAj8ra97L4xoOoEec6DWWvO0QY0t3aII4h22DExRKAIr5ePEyRrY96I6Rqu81uutn3Bj2PfGw2dQkkT/Auwh/+7rv/81//c+Qeb8eDzbh/OOP6+umg6Q+Gr371ZjQeJImrnen2+3F/NEC2lvTI68YFXo6Xd+9/ROjDcpfgBVcU8sg0TQaDEUJIKfCjSLbkP/n8SS5oX215mtfVFQcdQWCqYNgcslBsAoWxUpgzM/Y19K/6YZG0t1wNHLHVCdqhjkmNvJZka7+bC/NplXmx225P5/Po6uZ6NqOHELIrnDwVjsjLSZx1lZzIUiJUqXoLxeLDu9Xj/WefvS0MgOX9mdgRqlG8FaGpOotbkVMNiFwLGMRjVuWJoPXtc1hhSKj1oHAmvnhx+/j09O7D+09+Rde2AHtDAYgbUFRen92miirTbYwNU4taeGGD5KJxPQsZGSU3dVh5bSeH1B/0syxfL3dJmozHM6xubNwkiXHq+yz62EQmDSYOOBbXXldj3LFZLOtw7Psqx9FMPhkFN1Tztk6UxmldxXF8OZ9miRdUMfmGu/38xRVzn4AEDazcNAi2u/Pq/n3kbOe30x7Oyl7/j386Dq/enM4Fztqbm8Hsah7HjnJhrz9I4r6hgtnFxP0ctqfDcTebxwidZzrTkWsahAQs+EreTWdGuHKvMglYNnr8Tv1L4Hdm8WzRFSKyBuvNNi/y8QjRVu9LuQt1ePj6a6SwMUN+JExRIzNiFZ6VY1YogXiaxmTQg6o2+x3S3pvr2zSJS2QGilA8BDU4MmgYjivs2xEOSsc57HZ4Vuv16vO3X310EbNi8FkLXnJKBjW0DFGzRFZTtAMVAQN7qef25HVGDYzWzlxCzRS2pJ2F038+my6Xqx/f/XR1dYN4k+dU2yGlGbeaN17JLCciR90RAZp8N6RfhcfWA+XxhOtojbbRWiXOp54m6fl4XDwu2QiP01ICXbh01L1+N5yn/5fXaV2YobdkVRHq2aN38q7kbM+nSxD5igf48qxh8RuU2LF1Nk7657zerrbXx2PcS8y/TRNBd7/a58f97Gp48+o1fRB7l/un6uWrq6JycWFpGo/GyMukDe77SRpK4MT8BPzKLU+nE3ZhEPf88KN9hyf5eN9kGlCi4kE5AosSrijpx0aWGaGAbubKVvvCu6kjtd2t8vzkeWOZxtX2M/hcPm8NoDjbIF6ZW03PtHJqmRJGoWsEHrlvZkWGy9tv98fTKU6S69mcj1MCsLUKQms0CPgaItMVFpEZSNpLLW61P/sz67q7qlA670La+/LndDrpDINCUM0de5I9Ytxxk7uIkIY7I1ykcYTAyhEgIuQ+cYJFjuPr66//mGfv37x8GfcHHK1LuRv3TPwAkeQeIlBRsHeCvVdLXD0UYCarae0tgS01TJBpceCNt+GXSXw+FQ8PT1fXc2IomjpQVyxj1440gZrwVEEi3RB5gPE2dSD6RVm6PxtytFb2irzF1DzpD/zj8Wm/6N0Oca7h2FrcLUfTKUFQQYc3w7aoCwcBDvkMUqH1/hC6bRxyepOG/mw2HAwjT05gWrWBDqaODIMlsdvvsTwQCS7FOa9yq9F8dhX8SnBtTl2kXBq4tWhb/GUWzm6HAyyxLHAMechtPMLmy/JwODg8CgOpwtYSsFT/RYso8rGvU7GCHbVM2e/SOrfsy6iaFTa5c3HPp9PTennK8zfzF9PxBI+opGIhZ3JMjUysiysySnqpEAYt1bnwvjmvSp+FQtyflZGffe3pNMxZrzaUid+5Gt8GfKk2D3FE8mdYjhnDGUkjcq24KMIowd+ZW3KFId+aH4+XzXZTZMhtc+n0nXmE+aKgmMxFHOCkxov5aFZNI+AEf0DMLkEbJdbwBYFMqAp/2O+jPETBv1is1C8lwNX0V7XMfRvn488vWS7CYWX9CdwamWRJrOOmieNQkDekvXg6iUCm/mg8PjfnY35Keqg1ou1id9ofHTnPabup0dNEx2O4etouHtdP9+fZ1e317Ww86RHk4TvDUS/pJywnGaCljRp2SjzIGdarFfZsFEfPKGSebOy2i+ZGNLTXaV4z+/I5YzbwjH2chvUdBLRSEXehXXXBXEc1CjEoVakZToV/NrxdrWrLMFYq7lqjX5uPUuAZF4gZT55lq+0GB9T17ArbiU+eg2gqgZpxcEjSWxpJqqt7beTKtkhx0n7fbT+SBjvHlV9anghnzOEgOygmeEX9CdctaC3jtc/4fmkWmcMi+95JFDdBJAnlzsMXv3j74gYv9+HpCX+fzmaMDQ27v6QWSKGOzSTCtJEdI+vkTLCWb5t2LZZKbkKnKP3wZmKUBljKrh6K46BywU5HVW8HOeOKKiYiyajyF+D8FaKmVYnEY5WebyHB7/pnNsSE2BAMBlldweFdlCab4+pqcj0cjveH8+pxOZgPtbvZymczkFZWI/x/pGzj65urF69mV6OCEw+WJkkaa87e+OaJ5jzrGTdY2eV2s3Z8mxuTRsEhicZN1g2h1IgMxkkpF5zGk68JW4Ja92VdPgNsDBHqbwkbZFXeWWhJdDdQt5BhT4hINaVNEqLVVzg2QPQM2icEfU70XHk4Ho6n86A3nE7Guck5S+OgEyjkRNxWeOh0k/9Qechlt9sQ3/uzytCf81qDXjoqcuZr5F0b5tMU2zVvwQ+QTmea1cgum7rLZLhiUbjWmfaZL44Rn0tRoLbANl0s17j63mCAl0wZI/LDOKh2pSvMBh2uMY6CMjKyodMFoBArmrjYrMA6oc6bjFXwXpBoY3s9PTwStjWamPGe0ynvsPxGzZckCYsdh7IiTOpDFkeoDI0ChWtAaMRXYzs27EqEVcBNn/Z628flZr/49NUML2y93N4cL8EowgvLD+fz8aKwN0xHgx7RHCPiBkNv3KcwBH2UiOEJHOF5Os6ARPhRiGDrH/Y7ZFFiE1hr0ldC7ncyHgHTScc6ZtKqbiVXVMsDTxQmVHGRcNtatW27Wi9dYihZCOOJyiTHlbBu3KjLxS5swMhCYwwNiVxzXhXc0QjDnmZiWDmLzTovq9fjSV/AdrPV0FHka5LoGvbOuP/8QKfOqxKn0PHuw4efvv/L3/9V18U1me9fOHqxsD8ej3WVqbeGLDKoveeB4rNvOmfS1CAIDYCKKw2tfBXORDZ9RBrh2Ks5Z/Bfvn65fHw4HI5aE9TTRlIxHAzEH4k1yCvxX2InzsikaXAbtYZlNuqyoY2N/T0vT3t8D3jSZIEeD08PT7iR0Wisw640skbZ1liG/X5kY5NfWo+RyxDyWCe+VWh740K3AfEq+MowSRrfWe0W17NXvXRwOmfH7RHfhaL7uD8hG+gNY0lSRNOrWZhEOHFY0AxTPPHtcovlNb4aC1XWmLK+yRLhdvJzdjgd+pPE67B0pvrZSaAZqFoi3CZjhHyEWr3dXJ/rCWEY20NUCKqr1Sijd7ttEiY8JW2O/UzA8jhdaLUICPfLndzyYTGgu8rO9zu0iaYsLAm2hyP+AwrMOIlqJUMue5pIG6LA6/r1Ssta9vdQCZXEDSMUZNnh4acfNpvldDDOf2ET8ZESptEB00B/tVqvnh6yy8Fta+FS2s6nOtAQRPbX6k8I86TZuzkdNaKwVWx/XBrim93JeMDcJS+Xq6VG4sYpIo1LOg4OgxehNohZKrxVzti/2rKimihludTzUJeZZVcUzedXp2P2cH9/OO4rm4NK5iVNkePEuUR5mMWxL+oUqAAsSalrfBvXH5G3uVgKnFow3SEFP0Fk3WW7xfo+Yh8VleAuQ6g6IqklIm00GabD3jOthmqPFJzxKTqCqv58zHjG+h/5HjqoKTdA/kh2OVPzi4LsQgxLPI7DA8ZRVxJq3PGmE8yeggx4UOtEaWwLUW0nArizIt9stty9Stg7uIoBnNRJMUFwMaSrHBlq5LfquFsMZWZMupynZAz14IGaKHmRUgQgNuBhqJOP1nYeRfNxeCvW4oBiWA1UmjBX0ex28/j4+OGdTbtNd6FjEGppeVw9btsb9JPeMMurh7u7D+9/PB23fJdmba9mF54dtj6SOlaR3BO121gGhiMmuyBjRx0hyeRQAb/X6+H6Ntv9br8t1MQn+xkPRY4MFGQy0xbfxYt1VcKwNxtHxCKLcM2RO5n4uBHClUJBU2xt1UWDFBsno+pqD4cscwzX++hk3OrRi/OUY/02pjLi+aLJ1/h6IvE1n0MBhUUxHI9RmCz3i0u2QwmyWx9wAmanC8tmZMn9NOQh2whK1YgXyrQ4HaRBEiFiqebyjcjViUVJRgGLgCogUVBL9EvMeIEOROcyCf1anRFuqjCy+goPJ+0lJnzfPOPerM5hVVRWdLcn5RNhusYaHw5HrIKF+Y6UeEo5P6JANxurCLJ8PmaZm5nrk7bI6XTG02XZFBKqZWvVI1cxlvMoq29kIBzhe+zE4gSs8PczYjoiSH1Yrt59920pkFL7/yP9SFglVhNxsS7TFEshwCre7XaH7U/jyWA8m3o+cmenEPQaVVVF4+Q2u2Qcx+Gh85xulPFpAm91rywqcTXj6RTPdbXeYEvkwjUwa0YlhLtPQyoNycIEewQbTNlig1yVldpwSLyhI1ID2zvEbyHp90TNxlLAV69WW/x9dnVl6AYeK04TuMHxeEbYY/0njAr2NA9bUmmcNIr6vUGmyIotSKX1IMTH476ws869weVweVrdv371m9OJyEM3K+I09RXeCAHIfFGs5LoSsAqJ0wj5GQqpuu3s7M1bxIRdyrxCMoBMWPgqRm16g/koXetARd+lzMkXJp+hUj0YsvvQEr2ufgrrho5iJ3M2fMZmv3VFCiNSyHyJLIZyXmJSqG7sYysY1z5ou8JbKnuVerOs5DmcwQmy3e9xTA4SlLexWZ+IkebTIJQoWRbXon10PVBUKwhzh8Me/xVfh5j++P4dsnhc+c+iNG6nMYMqqcHK3aw3h+MRQaOP5GU6i9P++Vyun5bnw94YqjVnvQrYnO5Q6VIWP5YlMA6b/QnjJKn2BMyMx8P5fIZzdrtZsThwPaTkuCwCQRFmYgKPkl5qMpvaoKJ7d8qIjXrObPZQTIbjCMPduqZvi5h92B1wYBGwQDSmJ+1d5nyyjJBAQCsMtHJeRwW5egE8BMsye1aNb21wm/ZSx2+Xu0WRnxmZkE0cz4fdvrhkrtkwazTpdQYhzM1Jo+UOMQEKQ0K7JnHBHAtJ5+GMpYYT08ToTIiR5xWqmbLo6HyEurmhb9ZirJls9lYJqiDEvUtIVFPt8ewOez71AGlDlGg2zylLyHhkJGsOL9paXQ9XoD9mNZobukYLtSOPAhaXy/54QMpNzeUwNL6/ZXvOM1HQtLAFWSKCoClLhit6bxM4iaC1fnxAMm1CLO7HrskzCoZ/fDwX293hdDnjdQ5Go+l83h+McMtlWe+3u+NxVzCCCkHrdqphkQpmCf6RyCKKTmXSdaRx6sn20hRBYr8/HY97SVmTUns8EHQRyaEWdWK/38N5jh2HqEtHZGJztX9MqUcJRNlYAaEBtgR65vM5UoLlcnXC0m85LTGCirUb8DWVCOast9VactUqxP/Y0AkiYp7pWkAGG+duKGD7/SBN9vn+6ekD3t2ZTHmq21fE1LdsZiShiVBKTYTVAQ6RpIckmk+AT9PvbGQY3xuaEOK2hQ8NSuNuyx4hFHamVd8/lLaHgStJ8GuaQJQm+p03ta0VGQwwBmBVnRGPA2q/RLJYUWs6lb4D1RxkNOJpyFN3/gPqqnCSbWAV+WqXeDglCV4a5/uS2VVLk3qc1KQ0qyZD4Ys46QoNT2o3ohQ+ANtg0O+ncVxeLpvF47M9gPtR0o8JcRr77gzVOyNbWdT7+pCEYUr0fXA+UVP8fDkSNSHGNLuaxOn5uDj2KbmchY0S2lrSynWZd8EGMYLtzeHgcs4WT6ura7eHnLRuKcR/OvX6nNMW+BkCAQPTMdNQh8KAHv3buJwClYc8QwkLKevOwspFvon6YLVeIJF/7ZObVpsiA1t/JG606gRKzdG1zIbR/5xFpscYkSiBV0laiDQY8F44OvQOj5sP8/lrrCji0ann4T/zuQUnLCvkIAqIDhuhEY4kp8gq8fb0eGvzq2uLCxcWArPLBKhQu5VxjnmMXpmiZ+iYhJVRBdU+VcZDyEYgeVIOIZT5b/cbduM0ee3suD3fJIZD4k1xw3gsEbY5wrvNU0yVgQPsqsNBXS5nbEXlPxXqaMsOn0XRGjv41MFhjsvxojrm6tdUCHI43LBTECyYm6q8v5Ax67vOnwlKOsHpvJ6Mb5MkPh7xfyfinjOsTUaORsK6qLFwgRmuKLsEDLlxj3CAsroYLdHp9EUb8xN1c05RSpO4QPTt9dPZbLLdro+HfcjGUqh2MSkhUZJa/9yG9jSKV8Oag4WCClfchhqHRVgUkabzqHu9CBUZlg6WLMLSZrt8fLx79fJ17XaqSzYodJwO/C6VA4LHCe0lsLZEQZqmaeYUyIMQLB3X2MOcTUUIWrv94bScRC/YlQrUdAs6WfWGgjmlTdxMPA1bIivrp/vV609vJY3kccxkud0lP+53GlUEBpQUiSh4fgXM7gPHVIB90/rVa+ZPtlVr1THJm8w9cpxA680G6xEXr/5qYAk78TaRqk47R7ju8ABLMXK8c3HRAYLT39zaaqREq9VqOBhp2muUtcCMOEqFj0A4QWxhEiC0yNRO87Ao1us1HviQsOsxxRMLNos26wUy+qBT/PoZpBx88+GHv4j7+PgkwVbooyAlqP6UmVou80g60sYBVnxOREMPmxTLKwpwitQ00pWuasNDw7ADJi7auUmwZceW83Q226yW/Cd19kn8IIObWQKqjprA7dZKCQVxAirYlBc/u6UiQ84JYBTJ80VVX1W5oqads/Nqsemn/cnVtUH9se8in2WzmvIFdjvDjyR8QtJf+RdrH96vgKlknuX4XhwrCVtlp/vFj1FIkc6Q4N/ABsdUNFF7yg5EQx0R6l41P37zfn41649i15pkAiCf2Z7eoyCzhaSZvWN6ydxZZtmjrjRx7mITcVlwksZNmbJicJnW4qOyC14qLqwfJ30UWWkvTpKAnZoOKqjcgTkl9p5E4VwBQJ3T6cievmuzOcqW7zlxRn2TZJoGku3o+Tqla844Pb9oKsqZ2hxb/B/iy6tytVnjLB6Px/Or68Fg6HLERGLjN3/8w+2bN59/8QUJit5HkLITLI7Z4+pp0kfJiqXrDoe9JI1P6bkqKpSX+SVXwsx+cH8wbGqeZr1en6mU0ikdgMyuyTl2CAOs1LQ0XX/f64iO86s58oPNei2Wpr/dH5B0jqbjUGanOJhiydQQPFFSxiRKU7y7izpZpP8XReb5qWAhfuw2gl+jEsVnpb0+gt/d3WOcouQYs0XN6Y0v3Y5OwM7Obt6HZikl5bjKwEhz8gXCg6PAVYKAOkC4Xywfxr1rvJDeqC9MUR0yAQxcdf2c2vSCHBNgGo/6qx8fKOjQC38W2C2r0xEH/ml4nSDzE3DFb23M1FgSzfgk/QGsNtfk6X2zuCEirOkExqTygAtebVYIhAMK7AZsr2DHM2mXb1nrBnKMKZsql6Yh8pHNbqvUT9AX0cWMY8JhkRvolmv7cKlVEaWkuKV92+mIKCET4P1w2K3WK8SqVy/fDIdENWaXUyud6m//759+fP/ub/7lv/r001e+uvlGrQrSdLg+nFO8iDSo2k6+I8VDTJGZRuslxeYTQcMKPlUfxwi+br1cHHYbCQd6mkdQvjGn3BmllTyjyPHskDEOKbnh9dXs+5/2uD7CHHyfp+7+MJyEqP87Xrt5zVFOvWz5zgJUwW7pcAW71EHBAYq3kqQ9uRIyC2FGEgWj0eh0PN3d33/xxQCnGaUB2H7kUJKDVb3+Sl+SqC637j5TCKaG1uZOTNAeZ8poMjnu96vtk+cmKd5kTyg+WmqSVa+qs/EIQ0HUJEZtNB2EeHTkGdVB4usox0+2JOzml5HXxwrBOxLZhINRxSDHTsdQNMlnPfc2dAPH8kJhPBpB9V3hW7a7rehIfnfo0EuCixhFSiqZAn5SG6JA2h929HCSsyY+H7VJyPww0DuqpUYQ5ChNBDCMiKwNdN5hMRGFhkQLQYtFmAnOPP/14vYVCqb+cIgPwIs4X045+fHcdX/433/AA/zbf/HPZoPYAM0a6VAhMyqRU5dZR54VvFCdVh/vbNPUW3oIcsSCL2rvmsenBa4eK4etNU6UO0J35wZPGJNUJwjEY8GPQq6W3gtC6Gr1uEaYSnuIyVG8HI4modSILmRJU8CJ06G2kJoMsmm2Vc7IbCp2exGzmrpAblwKcBGFnfIAdRXieLFYvP/p+8+//DUCKsoDGijleW1gGXrUICPmaA+HCI5gj8SystfryXmqzqvMWoK4QYSL2Wx2WGyH2SQ7jYu8Xzd90YEiIxkzgDFUsLmAq+0PsfwGBY3x2oT1IHlE2FHnE+rgS5hQ7osL3Spcjts5KmZNHEfK07xnu2OePwa24ewrSvV2kcwWOxGz2N8KExoaSBNQWG2qV+HTBGgzHpJEGcT2EtUA+QKqM9dmR5qWEOi3P5wp26mptWinbUGB1YsZveLtX9h8rrPz+ZzlOKQ+++LtzfzGpYYeKevZCQnzHml3TRnHCiXjdz/89NN3P/V//St1c2Qrh5eTEKlLuRXCrH2vprw+Na8YqANvMh3hteEbUJ0irF6Kc9rrEc7GBimpDRlRQrnTAW74nCJJ01hfxJIRll5xcnV9fTgeNpttkvSm0/l+f8AZxIyewxnHes2IIiEDQcgTxPPo1xRhj3PUoXKvQY7A2i/pxHPVmSZ4cjqdLJ4ek/fvP/n8izhODvsdn27IIGHtIhWqjIsoeZtnr3RN03R2y28iousdTts4d4vNeRVv++PxUEUxzmtf6qa180tjdgHC+qMB27CO+VkxoCBZxt5DFkIRx4qyz5IkrWgeISlhLh2aNpqgEAk8mlJLF8i8ZprCoKFYskcxs66nFP/vS54dFXHMsoM83lKuGIEjwJVGAEEb4HTDigzikL1VKbXQ5pOVbChlNsQRw4I3Uq8+6098WTewrUPhAvFcXoynV/Ob/mAgYkRTHnfH0x6VoBZD2XZnN6Foh+OZRkbPQy3OX9IwYSdaPg0UKmrbj1mY6YjEESUZsZbwDwg2uGJlV2USU4R4t9+hwuPkpexcJSplOZpz8Xmx1uUuZGIwGowe9kdEFwTV0+Wy3aymV7eeYQ+NZsqskegJpG1RnCCTYbpUsWzk2vV8lDcOG3SdCYyZUbNMSnuT2fUjAmIc3d6+xNpCIWu1oan2qJtD2aCC+jke5ZnEFcM7TpPEsg62mlicBr3haLfa9oJhWbzmvPg5n1EroZP/ZU+BGYzTn4xO2y0WVSvuUE3+Z3Y5Uk4DC6t+NmSvG0PsaEToi17W2AqL1HzlJKBpOvYg0vDskuGbLtlluVohGXnz+pPPP397dX07HA+CjpLqdvZqnmmNengt5FnoQm0YzhEQowQWtK8+c6kmPhWmeZIWOXJ5auU3JhqFJc7F1+8nWLisEdI0IueKSGBx6/eIYrmkiRttKqzX8XD48uYlSTdYWLFrArhBEgRJFEvnJkZVTu/a2rTLWJyYzp+GFTyG44TFlNwDqsPpzOQpCaZE/PAGkJogwOJBoETEW8rr4nSqbFZKJAazaWc4HKyTmAoX6xXO0eViOZvfYL3i7kzq2xaz1MnUZ4uCpEkakVPlCxGW0o4ieLw0lz8WI6S1BP54PML33n94wLVPEbr1KGNhao1rJUmH+kI5boNvGNw+MGUqyni62gdItuK4Cfb70+aSnY0/xKSuNBlPs0Tw7WJRGA4nvfXjExv+nZGsez7huDjRbCBJauEw2RHASRdy07itgd6aZ921rkSXHHBtrXmSi3yuT5w40+nsq69++/LlC2Q5qYz4GsfMeaWxpm55xayj6oxqGmuqupLzLNXPEVuXyPP2mQAsW2tJ8YaUwOC5qjQh5iwkitK4JzAmg2JBVvTlxE5Upu/smlWVfv1Xr97czGfS1sp6HZ+lDXoBoSZseqq+rUuf8CypULa1SyqfGZUYc1LZgEYoUb91szPljXymC2HaIo+OzKG5zJnWceh8PhUquDqVGQFXB4PBfre/e/9uNBju06ipijAeqIVQm0teo3RHQ31J7HOKTKktoUCw8wK6FTVcfSGRkb5IlRmfCFXRp3f32U8/fcC9TGZXqBAEH2NfwROZ3GQFkbKlaSIkUyigNhcchSoRHAUqwGPuTwaHx8Nidf9y/woPWdxIHPMMe4jJ/D293zDC6gmQe1ALs25lz+GccVzsTlQ1wi8VJiZASpKv9Kqp7AhuKQDPNiZXiFyl/Q6pgjXhk7G9227wuj7/9LMvf/0VAiE7YZSyrUT+1rBFHepSv5WRWWRMYxbObFSZg6Ok9QgpEEbZfLKZRtNGOpDqboRSDZkiks5Igz/VnpEsrln/Y3FTGkUW642SSNyO+YMMh9O3X3yBNOFyuUgJJjb0X9CLEue5M0NxerbMGq8p1ZCh3g2rd41FWp7cDSc7FbIfnxqv9B3nDA5rKJK0WqjpKaFtTtvnBGeYkY7dUIAfQZjhtx0Ohjizn57uHh4+RHh2+90oNJBWY6p2bEz6nohGgWluq7tjE1dN9l3DVCGfZydNxvK5qVykqTedzd6/e/f+/Yf+cBClOBAzisFqUGB9e8n3ss2mCN/azNjgy5zr+l4qwCC5povd0/J+u9xM57PKo6Q6tS0jfjVuVF1S2nNqxOZlZ06HhP1qL6czIxYyPMkDUeVbTgetIg3b8dRN0FTR98yuFo+CaKpKKib4LdRS8npBJBiNBuwVcMJEDyrr5tTP9t6tQrvorCbHwLVGAa66Mf4zFdwqmV8oujOj9T2hAKmJh5vt9/vImzVRI73PkWoZQprfBuzxSahHBWmgZktjiGRkblE6+PSLL+fT0XazpBRlLhwGPgEbL0EeQz5WpYfFXY0tWNUk+gljxD3HTLxzdRK4R7gzKSfUOH+9sj2djtz12IjEVoVibtdJGqBAK2VEsfePeX6hiA/xM/lwNNxu47v7+9FktlyuesOxWfHU8vMyDwQCOPMOx0c2sz0V1gaVuWFL2I1e1Z5qUaoUNVSRx4KcTKbr1fKHb7/77Mu3tRzMkHiVGu97pswSUn9LLGTJH8vfEOsTR0Ok1cBel+MhUJ15pm2JM85QRvl6h0QNcIzE3M0LiND2cXIUFPmqIpdiCkxE8qyXIsuIyZMjSqMyv8tW79VOfKqMNI14tQwPSu+YzzVOVZyoy7Xfk+mF/1rJaMEYxcaWbqR3T1qOvHlEbORxn4lRbD1d8grVW+L75a/UyKhO58zAhp2LO79QUC5CClpRZAn/kqxKaXQsMR787NIYzEENnTJK+jcvXk8no+NxixMbB24hMTQTCgnUjJOmKcplRUqNhjyteoLwz3jceWVjPCnW8sQuBCWoC/yPbhFadlzkuAM/9Mh+ZS/Oa5RReiiRG3aV2AnimegM+v1e2l8sH84qXAmSMeYXO+8cJWN5VvTTLiiflKT4mNqzaZdOE4mUmE9cbbI+3Bu1cfHwUNI0Tnq9p8XG9b/91ZsvzOsYT44yBG2F+NeKYoX9YORjS25a4eIdiVCSGVbmw+FwV2zXu6fifPQIx3CIahYQsW1jAxM3pMm5yTApeVJw/eP2j4cTntp4yl68SebjmCAaAvFGa8J9Jg2q0SlD7LaDVVZyhHQln7ndEl0Sx6kjE/JAMASzmTfrPxthNXRNdakqo4CuSbwRQBsSZXM7yyjQcDyfsPzwZEXeERPN9TnHMW8+TcUbp7NB1xikQR6B1YWVhJRdnLAqKzMvSF+/+ezmerZePVREJ1AuqxBjXhItYrDiAuiLGxHi3nAKKKTUsyaY1P1NJtMzSQc+O6a9FP+shX6URQ4LcQT9jLpnhaRUGU417hYqXI14atUlNjsZYLdsN5vz+VIwm/Y66YvOpprnNH2RotSnIUojUrkam3KpqGQ+ZBRXkwdH6PW72SULUsrB9Yd3758Oxw3rnbqRhmxoWO+2NhRbYuZYJhwYEWVKRHxLjBtDPxsrUXi8HLa7rRYuR2g1Qgin3p7ipSmdNr1BinwyO2ca8DG/JGCrHwsLVNvAmSm2DiBSeo0KpQapIyOdSkKHobBUEhf1jscDXmSSsLnjsKpzTSTMbMxEUkXCXIof80zDevZgckwSt8xX+Gu7PWcFfjPt9W9vUAHMkE0RJB8QsitmP5lrrtSaWT/WJnfsKG3HmrxQGk61Kv4EIQ/x+dWbT2eT4WGzOB6ODVlAKH5RwOastdV656dmp5ykSqm/iQAtH6UyF1E3oDWVgnjRligDBOdzTMrC6+w0BCRhs5cuvKhFa6ouBUJr1Zkmw7XSrA7X67RJECZpghRxsVysNytCqpmauAZIYnpL47xI4VGX1EjE0TG6gumxuKGEl23m47IZW9QtdxvBmCzg3Xo0wE989/2PX30Z9ocT7FLh/xAJLoLbyqCqoV4cNRCU4JMYI80cWmVRQJ4knLzKHp/ux5M5xVQrlsd+XCSIsmFkpnnIVHqDXp6V5yMTZhxF58sJIQX1AQ4ymyw5pmJPbYGILBoef7FIvDGJ9shl69avhZ1yqImKX1qsFwQzkuxkHFQeG3h1RJ7g0CBvsLZGoc+JCJVLT5cLkdxUdqylHx31uIR8pfmFnUun4wWPgpANFasxNTaizheS1FbHSlblsbQmwWI2Nw0bCg3GV59++nk/Dh8e3u92u5Ag80RM6Voo8MZgWYFG3KHYrzZYcDrFVSmCFc/3I6pnV7PVqu1buZWaUEImHSVp67oX7I4yN71Kbui6RNHoMmsg4l0mUqwAkGz0e4PV+nG92eDn0+GYqW7p22BLDl7mft0aRaRSjwOrDSE0iSipIBCD2Qg4OHTLDMVBzZFI2Oih+YM+E9LN2vnmu29/99vfJemA21gVTSeiwhENoVG4eu3bECdRLFZy7TaxylhUR5fDcbl5+LL+LbZYXtbIhkoKklUxieq4rypKcFqFx8M5VwuG6N9LOegNiS/FK1SeLlXfoOVEz0oEjrwolsi+ZvDRU5nN1dqI4uVmvcafIk+lgI84c7hEob0ku6LinDUbn2u7zwlKEcEmFm2KcxxGGjlwE61QlGZT6ioiVpwYWerTSVd1JmS4qqaU95HJupoYDpNErOn59av5/Dr0nOXy4XDY480OBmOiXdpKwMIGaZbjRJ2iXwdPE0nGRHQlLCuhKcITeAqyT1U5URCTdozNXGRGdVJmHVAup+1U3hw5OpEsygjE0gSpkjlt5GVp75W2Y0GATGu5cpfrJYe140r/iVqM+AWz3uPBhy+JvNYYQ6KqEnwmbJoowp2SK5FNnMoHdhcaZlAaERc5mUw+fDh9882fvnj7ayR2xHgFfsGjpJbWOXvhNWf4IrOzF0HfFkp9qkbGesjKfLl9Wi4erm5f84jBM8ZKzHJP7hEVQT4S6Kwdk71AFo898+Vvfh2Mnc15yRecK9zqHXZrwlTLZGMkroDUsPTkEXrxyHdr6n9OKS08sMPFV5+FpABOrxEdjyKf8c2w9RyGqaGrfJpAt3JRyGtEuFx8aRNdt7Gk7pMS8KLRdn6enkmg0tE9L139iAy5iWQk/LpuRlSTm2Dtrder3W6Lnx+PJzhee4M+ldvJpC0vpFr08NICGWWb8ZgbCmGdWyBVKFQbUFA+A/5SA1Kaj1gi2uKOVGcQh502ReBR860NSh+5Yil59FaMFM7eSfFslORHJv/XS0lgWa9Wu+3m+vqVsb/1tFUjqjD0IzFLs0oyBwnztUsexOGzJwUTVLLTSYDxsFdznTzME2uppEuGZTwa3929j+KfPvv0c+QVaon5pkEvIiubZUYLNjUU4nFNgpX6ICyajpfjj+++mV+/cJVWW2NR45HARPrw7b0h5XR03/X8etafvrw7vKsOEogzn2zP9qGKbUV0n/MVmWlJdhCbgdpjJfsgT0+PuPjhaCSrc2XVvn/Ozo3Gh/TNyrOIin7UziGNIAp53GlyhYfIT1EjpSr14SheIwdJfEZYdiEv7SpqQ/OdNzqQOkotpddx2vqhVBesoEQ96w+GI5REuO3DcXc6HIi1TPvk8ov3EMgQ75IjZOc6tZ1guVxMx3NEPGbDApdZSwmvjI1XrtaykfwSrcwkR6VGX9jZRysTJkOWqIGY7E3WzjFfrFva3NMmKjbR4GjaLe1f8XCRxy83C6yt+i2hCnSbdd04iXRM5IaSZCmodPIjcsgnsJQenoU8kD2DuamhHApdiJOKIiY6uhECkxh7a7parPrIXl+8MoSqGu7tM1Sdo2X1IxoTvGNxRJIJAyR+a5dv71cfsvPe8WKx5VqchkFc+GbSxbGa3+tH2fGUk2rrj8bD3jSpNtKENXyR0DvSGtG8wCDmsudgW1XcVDVZuHARiu4f77GRRuMx9VpLGZITSE1dOzbufX84wJtO8C8UMLd8vXNwbm3SpZ4wO8zyxe0Uujlv1tjYaDmdO5REh1G4IUHDoWlpLsdBBX4QuZyLSgurKjsfNtvN+XLx2C/sDYbDgFmm2MiiGFEkPouFRWiD9dNyNpmaUl5bNZLT8GQs5mBdiWDeCi2kItmy9QBvi3PWxsADrskSNWYxZaIMDOwa/WSck9MKhbVrXmii4VGhXEKFuL5i2Wy3G5wunheLC8rNLDuCxidYr0HurBKwxWPlBUTqeZM3xS833hUzP5fAS8Fa6mfnzlo8XR6IV/PJeuM8PS2Qdd3cvJADlmcThULDDSFNZIFks/O6ldVGSaYuY0Zwyk5Py/c3N29lVY7qsHBPl6Tv0t9GSS5qBtTzFBKj/1OCrYCKKiQH1dN+qBCo6Q/uNbG8lkVh5yknTAlTXxI0tOJXiyeUhDfzOZ4P53pdy7vGx/Z6sdgnrKCNZMD6QMgZ11qTBo8rTfC4lakX87bGCn7G05ZEX7XuGO1oIRQRZIxo77T9dOCYpncrMJznI8mLfPewW20261wtrH6/PxpP+oMRh2lWPPlcM3l2dpohdQ/K+v8JMAA05P/NFLG/mwAAAABJRU5ErkJggg==",
        "issuerAuthority": "SWE",
        "lastName": "Doe",
        "nationality": "SWE",
        "personalNumber": "830412-1234",
        "serialNumber": "PASS-90876564",
        "signature": "/9j/4AAQSkZJRgABAQACWAJYAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/wAALCADIAbwBAREA/8QAHAABAAIDAQEBAAAAAAAAAAAAAAYHAQQFAwgC/8QAQhAAAQMDAQUFBAcHAgYDAAAAAQACAwQFBhEHEiExQRNRYXGBIjJCkRQWI1JiobEIFTNygpLBRPAYU6Ky0eElY8L/2gAIAQEAAD8Av9ERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERETVfnfboTrwHNcG65tjFl1FffrfA8c2GcF/wDaNT+SilXt0waleWsr6qo06w0rtPm7ReNPt6wiZ4a+evh4+9JS6j/pJU4seT2TJaYz2e509Y1vvCN3tM/maeI9QuyiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiLGo7wojkm0jFsVL2XC6ROqW/6an+1l9QOXqQq/ftWzTLZHQ4TicghJ0FZVDeA8deDB8yg2X55lP2mXZjJFE7iaWlJePLQbrB8ipBathWFW9rTU0tTXyDm6omIBP8rNApbSYLilA0imxy2M8TSscfmQSvaqxDG62Ex1FhtsjSNNDSs/wFVGcbNPqcx+YYPLNQ1FB9rNTNcXN3PiLdeg6tOoI1VnYNk8WYYjRXhjGxySNLJoxyZI3g4eWvEeBCkqIiIiIiIiIiIiIiIiIiIiIiIiIiIiIsE6KvMt2v41i7n00cpudxad36NSEENPc5/IeXE+Chgh2o7TeMr/AKtWV/wgOje9vl77/XdCl2M7GMUsBZLUUzrrVg6mWtAc3XvDPd+epViRxMijbGxoaxo0DWjQAeAXqiItK5xxzWmsjmAMb4HteDy0LTqqm/Z1kkdhlzjcSY2V/s9w1jbqrmREREREREREREREREREREREREREREWCdAoll+0KwYZTk3Ko36ot1jo4dHSv8dPhHidFWIl2h7WzpDrjuNSfES4GVvnwdJ6aNVhYjsrxrEWMlgpxV17RxrKkBzwfwjkz04+KnIGiyiIiKLbRLu2yYBe64kB4pnRR8eb3+w383KO7D7QbZszpZXjR1bNJU8fuk7rfyaD6qy0RERERERERERERERERERERERERERatZW0tvpJaqsnjp6eIb0ksrg1rR3klU7fNp97zC5SWLZ1RyynlLcnt0DB3t14MH4nce4Ls4dscttomF0yKX99Xh533vm1dEx3eAeLz+J3yCtEMaBpoNByX6RERETkFR+3C5zXi6WLCaA71RWTtllaOmpLI9fm53oFcdsoIbZa6Wgp26QU0TIYx+FoAH6LdRERERERERERERERERERERERERERRTMM5s2FW/wCkXKoDp3gmGlj0MkvkOg73Hh+irGjx/L9sFXFc8llktWNtdvQUMWodKOhAP/e70CuOxY/a8ct0dBaqKOlp28d1g4uPe483HxK6oGiyiIiIi1LhXU1st1TXVcoip6eN0srz8LQNSqT2VUk+bbQ7xtAr4z2Uchio2u4hriNAB/LHoPNyvYAAaBZRERERERERERERERERERERERERFgkAHiFWee7UY8fqP3FYYf3lkUx7NsMY32wOPLeA5u7mj10687DdlU8tf9Zc5mNxvUjhIIJTvshPTe6OI6Aey3xVutaByWURERERYJ0VI7Y8jqb1daLZ/Yz2lXVysNXunlrxZGfD43eACtTFcepMWxuis9IdWUzNHP00Mjzxc4+Z1K7aIiIiIiIiIiIiIiIiIiIiIiIiIsOO60nuVOZrtHuN1uxw/BGmqucurJ62I6thA4ODXcgR1fyHTjykmz7Zpb8Mp3VUrhW3qYfb1jhrprzazXiB3nmevcp+BosoiIiIiKH7Qczp8Jxiavk3ZKuTWOkhJ/iSadfwjmfl1UK2M4bUtE2aX0vkudz1dAZR7TY3HVzz4v6fh81cgGg0WUREREREREREREREREREREREREWHO3RqqUzTOLpmV7fhWCuLnP1bXXBjtGtbycA4cmjq7ryHjPMFwS14NaBTUjO1qpNDU1T26PlI/Ro6D/KmCIiIiLBOg1UQraiXK7lLaaCV8dppn7lxqonaGZ4508bhy0+Nw5e6OJOkva3dGi07lcaS0W6or62ZsNLAwvkkPJoH++SoOx0dZto2hS3u4xPjxy3O3I4HciNdRH5u9557uHcvoWNjY42saAGgaAAaAeS9ERERERERERY1QHVZRERERERERERERFguDeapbO80uOWX04Fhbi+WQllfWtf7LGj3mhw5NHxHr7oVgYThVtwmyMoaJu/K/R1TUubo+Z/ee4DoOnzUq00RERERYJAGpUQulzqb9dJsesk8kIZoLlcI/wDTNI/hRn/nOH9g4njoFIrdb6W12+ChooGQU0DQyONg4NH++vU8VuPeGDV3Ad6+e8yv9ftYy+HEMZlP7pp5N+oqQNWPLTxkPexvJo+I+iu7H7BQ41Zae1W6IR08DdBr7z3dXOPUk8SuwiIiIiIiIi16iqp6SnfPUzRwwxjV8kjg1rR3kngFU2U7d7NbN+jx6F12rD7Il1LYGnwPvP8AT5qNQ2nbBnx+k1Vxls1E/ixjpDTN08GM9s/1LFjvGX7NdotBjeR3OS42+4OY0OdK6Ruj3brXsLvaBDuBH/or6HRERERERERERERYJAVR7TM4rpa9mE4m5017qz2dRJEeNO0j3QejiOJPwjxKlWz/AAOhwayCmiDZq6bR1XVacZHdw7mjoPXmVMgNBoFlERERYJA5lQ69XqtutzkxvHJd2qYB9PrwAW0DD0HQzEe63pzK71ns1HY7ZFQUUPZwx8eJ3nOceJc53NzieJJ5ldMkAKj9qOeVt2uIwPFN6esqXdjVywn5xNPT8R6Dh3qfbPMFpMHsP0RgbLXTaPq6nT+I/uHc1vID16qZoiIiLBIHMrwnrKelj36ioihb96R4aPzSnq6aqj7SnqIpmfejeHD5he4Oqymq1qmrpqOmkqKmeKGCMavkkeGtaO8k8Aqnyrbvare91HjcDrtWE7olILYQfD4n+mg8VFoMG2ibTqltZlNa+3W3XeZDK3d0H4IRy83cfNWviezTGsQ3JaOh7atA41lTo+XXw6N/pAUy3QOioDbm80Gf4rcpQRTxNDi7T7kwc78iFfUMsc8TZYntfG9oc1zTqCDxBHovZF5PljiY573ta1o1c5x0AHeSubZsjs9/+ki1XGCtFNJ2cxhOoa7/AD5jguuiIiIiIiIiKvNp+f8A1PtbKO3gTXyu9ikiaN4s1OnaEdePADqfIrz2YbPvqrQSXO66zX+vG/UyvdvGIE67gPU68XHqfAKxxyREREWN4d41XAuWa4zZnllwv1up5BzY6dpcP6RxULvu1Kz3Oqp7Lj1/oaeWpBM11mdux0rOu7vab0h6DkOZU5xq22q02WGntEjJKU6vMwkEhmeeLnuf8TieJK7JcA0nUKodqW0qW3SHFsa3pr3UERSPhGroN74W6c5D/wBPPny62y/ZtDhtvNdcGNlvdS37aTmIWnj2bT/3HqfAKydQOoURybaPjGKPdDcbk01Tf9LTjtZfUD3fUhQyH9ofGpKoRvt1zjhJ07Utjdp47odqrRtN3or3bYbjbqqOppZRqySM8D4eB7weS6KLGoHULh5FltkxSk+kXivipgfcYTrJJ/K0cSqgr9quX5tWvtuBWaeKIHddVvaHSAd5J9iP11K/VHsIut5kNbluSTS1T+LmxAzOHm9/D5Bc+/7L7/s5b9YsPu9VOynG9PHubsgaOZLR7Mje8EKzdn+0i2Zrbo2vmhpbqxoE9I5+hJ+8zX3mn5jkfGXXC7W+007p7jXU1JE0al88oYPzKqfJ9vVuoyaPGKR90qney2d7XMi1/CPef+Xmo7SYHn+0ypZXZbXzW+367zIJG6HT8EI4N83cfNW1iuznGsQjDrfQB1WBoauf25T5H4fJuilwACyihm0XCYc5xt9GHCOtgPa0kx5NfoRofwuHA+h6KocW2nX3ZvN9Wcstk8tPTexHoQJoW9N0nhIzu4+vRWTDtvwaWEPfc54nf8t9HJvfkCPzUbv/AO0La6aN0djts9ZJyEtT9jGPTi4/kozb7TtE2u1DZbxVz0FjJ1J3DHER3Mj5vPi7UeKvDE8QtGH2n6FaqYxhxDpZXneklcOrj/gcB0UiRERERERERcHLMlosSx2qu9cdY4hoyMHR0rz7rB4k/Ianoq12Y41XZJe5domTt36qpdrb4XDhG3kHgHkAODfU8yFc4GiyiIiwToNVXOcbW7Jh5lo4/wD5C6N4Gnhf7MZ/+x3JvkNT5KBR27ahtRHbV1UbHZ5OLY/aia5vgwe2/wA3EBaFNsoslzu77HYqupr5aZ4Fyu7yG09N3xxtb78h8SQOqseXYZg8lMIhR1Ubw3TtWVTt4+PHUa+ih1dszy/Z9O664Ldp6unZxkonAb7h4s92T8j3LRu23u4z4vJQwWx1Dfy4xSTA6siHVzWniH68NDy56ldzZdYsXxml+sV6yG01F6qGl+++tjcKcHiRqTxefid6DrrJb5trw+yxubTVbrnMOUdGNW+rzo0emqg78j2l7UNYrDROslmfwNRvFm83xlI3neTApTi2wywWoNqL243is13iJAWwg/y83ebifJTe4YbjlytEttns9EKZ7d3SOnYws8WkDgR3hVZsPrJrHkmR4XWSEup5jLE1x+Jjtx5HmNwq9Vx75klpxujNXdq+Cki6do72n+DW83HyVPXXbBkGWVzrPs/tE5eeBq5Iw54HeGn2WDxcT6Lbx3YhJWVn73zm4y3GskO86nZK4jyfIeJ8hoPFXDb7bRWqjZSW+lhpaeP3YoWBrR6Bbqw5u8NCqpyfYXj98rn1tuqZrTPI7ee2FofEXd4bw3T5HTwXEo/2dKN04fc8lq6lgPuxQBh0/mcXforJxvZ/jWKNBtVtjZPpxqZPtJT/AFHiPTRSgDRZRERcq8Y7aMgphT3a3U1ZGOQmjBLfI8x6KGv2HYK+QvbbqiME67rKuQD9V2rNs2xCxSCWhsVKJm8RLMDK8HwL9dPRSwN0WUREREREREXnI9scbnvIDWjUknQAKiHmXbRtH7IF4xOzO4kcBUO/8v09GDvKvWGFkETY42taxoDWtaNA0DkAO5eyIiLxmmjgidLK9rI2Auc9x0DQOZJ6BUXlu0275fdzi2ARSv7QlsldH7LnjqWH4Gd7zxPTTrJcH2Q2jE4W3S8OiuF1aO0dJINYYDzJaDzI+878ls1F4uG0SqmtWNzyUWPxuMdbeWDR8/fFT/5f/sziy2S32C1QW220zaelhGjWNHzJPUnqTzXTLtOipzaPtTlgqnYviQdVXmZ/Yvnhbv8AYuPws75PHk3z5fjE9h1sbZ5JctD6y6Vftv3J3AQddA4H2na8ydR+p3f+HzD+17T6TddPufSG/ruaqS2PZbh9ge2Wls0Ms7eU1UTM4eI3uA9Apk1oaNAAAOAAX7WCNRoqe2gbOL67KWZjhlQ2K6jQzQB4YXuA03mk8DqNAWngVxnXbbjcmfRI7THRvPAziGKMjx3nOI+QWxZthtfdq/8AeWcXyasndxdDDI5xPgZHdPBo9Vb9nsVtx+hbRWmigo6dvwRM01PeTzJ8TquoiIiIiIiIiIiIiIiIiIiLBOgVRbYcoqyKbCLEXPu130ZKGHiyJx03fDe469zQe9TrCMVpcPxemtVOGve3255gP4sp953l0HgApIiIi1qqqgoaaSoqZWxQxML5JHnRrGjiST0C+fr/AJNfdsORHGcY34LHE7WeofqBI3X+JJ+H7rOZ6+Fq2LH8d2ZY1I4Pip4I2h9XX1BAfK7vP+Gj01PPgRx3fatKXzCpteGB2rYiSye5gHmfuR+HX9LKoaGmt1FFSUkEcFPC0Mjjjbo1rRyAC9ZZo4YnSSPDGNBc5zjoABzJPRUZme025ZZc/qlgTJZ3zEslrYjoXjruH4Wd7z6d5meznZfQ4RTCqqC2rvMrNJanThGDzZHryHeeZ8uCsQDQLKIiLGgPRN1vcPks6aIiIiIiIiIiIiIiIiIiIiIuVfrzS49Yq27VrtKekiMjwDxd3NHiToB5qrdkFiqr5dLhtEvbN6suEj20YcODGcnOHhw3B4A96uYAAaBZREWCdAVQG0bJbltBy6LAsafvUzJd2rlafZke0+1vEfAz8z6KdRSYvsfxSGjBc+ok03Y4wHVFdNy1DefPh3Dl569rxO75jcIb7nLBHTxnforE06xQ9zpvvv8AA/8ApWW1jGNAaAABpwXMvt/tmOWyW43WsjpqaP4nc3HoGjm4+AVE3HIMs2z3aSz2CF9Bj0bgJpHnQFvfKRzPURj115q4MLwS0YTbfo9BFvTyAdvVvA7SY+PcO5o4DxPFSxERERERERERERERERERERERERERFTG2CqqMjyKwYDQSFr62Zs9WW/CzU7uvkA93oFbltoKa2W6moaSMR01PG2KJg6NaNAttERFBdqmVvxLB6qpp5NytqdKalI5h7gdXejQT56Kodm9xdYbW6lxq3i75fdW7z3H+DQw6+z2ju/4iNeoB4jRW7ieAR2qvffb9VOu+RzcX1co9mH8MTfhA5a/pyU64NHNV9ne1OzYXHJTh4rbtp7NJE73PGR3wjw5nu6qu7Lg+U7VLrHkGZVM1Ja+cFO0brnM7o2/A0/ePE+PNXnaLLb7HbYrfbaSOlpYhoyOMaDzPeT1J4ldNERERERERERERERERERERERERERFgnuVLbP2/WXbbl2RSe3FQk0lOeg47g0/pYf7ldQ5IiIuJkGT2jFrc6su9dFTRH3ATq+Q9zWji4+S+ddoGV120TI7BQOttRbbZPKBRdsPtJmyPDDIRy04aDTXrxK+h8bxS0Yna/oFopGwR66vfrq+U973cyf06LzyLMrBisBku9yhgdp7MIO9K/wAmDif0VP3Tabl20CsfaMGts9LTHhJVcO0APVz/AHYh6k+KlmC7GrZjz2XO9vbdbqTv6vBMUTu8A+878TvkFaoboFlEREREREREREREREREREREREREREWHdPNUxsAG9TZTI7+K64je7+Tv/JV0Ii59yu1DZ6N1XcayGlpm85Znhrfz5nwCrOu2o3TJ6uS17PLPJXvB3X3OpYWQReIB/wD1p5Fb+O7KYm3AXvMK99/vB46z8YIvBrTz08QB4KM7YcdyKoziwXywWqetdSQtDeyi3wx7JC9ocByHFahoNt2Vjs6io/dFM/gdJGU+n9mr11rBsCt0MxrMluc91qHHefFGSyNx/E4ned8wrZttqobRRR0lupYaWmYNGxQsDW+fDr4rfRERERERERERERERERERERERERERERYIJVF41cKfZltXyCy3d4prXd3iopKmQ6MB3iW6noPac0noWjvVyvvNsig7eS4UjYdNe0dOwN089VD71tjwqzBzTdRWzDh2dEwy6/1cG/mo4M72g5kNzEsYNto38BcLkeneAdB8g5blt2Oi4Vjbnm97qr/WjiIS8sgZ4AcyPLdHgrNoaCkttHHSUVNDT08Y0ZFEwNa3yAW0sEA8wE0HcFnRERERERERERERERERERERERERERERERFw8ixSy5XQikvFBHUsaSWOJLXsPe1w4hQiPYJhLZd90Nwkbr7jqr2fyGv5qW2bAcVsBD7dYqKKVvKV0e+/+52pUl3R3LOmiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiL//2Q=="
      }
    }
  ],
  "userPin": ""
}`}
/>

### PID

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlCredentialSetProofOfIdentity:pidCredentialDefinitionCreated"
  initialJsonData={`{
  "issuanceMode": "InTime",
  "credentialDefinitionId": "<credentialDefinitionId>",
  "urlScheme": "openid-credential-offer://",
  "credentials": [
    {
      "id": "<id>",
      "claims": {
        "address": {
          "country": "Sweden",
          "locality": "Stockholm",
          "region": "Stockholms län",
          "street_address": "Sveavägen 44"
        },
        "birthdate": "1983-04-12",
        "email": "john.doe@example.se",
        "family_name": "Doe",
        "given_name": "John",
        "is_over_18": true,
        "is_over_21": true,
        "is_over_65": false,
        "phone_number": "+46 70 123 45 67"
      }
    }
  ],
  "userPin": ""
}`}
/>

### Photo ID

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlCredentialSetProofOfIdentity:photoIdCredentialDefinitionCreated"
  initialJsonData={`{
  "issuanceMode": "InTime",
  "credentialDefinitionId": "<credentialDefinitionId>",
  "urlScheme": "openid-credential-offer://",
  "credentials": [
    {
      "id": "<id>",
      "claims": {
        "dtc": {
          "dg_content_info": "Swedish national ID document data groups",
          "dtc_dg1": "Primary identifier and personal identity number",
          "dtc_dg10": "Resident address data group",
          "dtc_dg11": "Issuing authority information",
          "dtc_dg12": "Document metadata",
          "dtc_dg13": "Portrait image data",
          "dtc_dg14": "Signature data group",
          "dtc_dg15": "Optional data group 15",
          "dtc_dg16": "Optional data group 16",
          "dtc_dg2": "Name and nationality",
          "dtc_dg3": "Birth information",
          "dtc_dg4": "Sex and physical attributes",
          "dtc_dg5": "Document number and series",
          "dtc_dg6": "Issuing country and authority",
          "dtc_dg7": "Document validity period",
          "dtc_dg8": "Additional personal attributes",
          "dtc_dg9": "Machine readable zone data",
          "dtc_sod": "Security object and digital signature",
          "dtc_version": "EUDI DTC profile version 1.0"
        },
        "iso23220": {
          "age_birth_year": 1991,
          "age_in_years": 34,
          "age_over_18": true,
          "birth_date": "1991-04-12",
          "birthplace": "Gothenburg, Sweden",
          "document_number": "SE123456789",
          "expiry_date": "2030-06-30",
          "family_name_latin1": "Doe",
          "family_name_unicode": "Doe",
          "given_name_latin1": "John",
          "given_name_unicode": "John",
          "issue_date": "2025-01-15",
          "issuing_authority_unicode": "Swedish Tax Agency",
          "issuing_country": "SWE",
          "name_at_birth": "John Doe",
          "nationality": "SWE",
          "portrait": "base64-encoded-image-or-url",
          "portrait_capture_date": "2025-01-10T10:00:00Z",
          "resident_address_unicode": "Sveavägen 44, 111 34 Stockholm",
          "resident_city_unicode": "Stockholm",
          "resident_country": "SWE",
          "resident_postal_code": "111 34",
          "sex": 2
        },
        "photoid": {
          "administrative_number": "ADMIN-2025-0001",
          "birth_city": "Gothenburg",
          "birth_country": "Sweden",
          "birth_state": "Västra Götaland County",
          "person_id": "SE-19910412-1234",
          "resident_house_number": "44",
          "resident_state": "Stockholm County",
          "resident_street": "Sveavägen",
          "travel_document_number": "PA1234567"
        }
      }
    }
  ],
  "userPin": ""
}`}
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  emitPresentationDefinitionIdEvent="dcqlCredentialSetProofOfIdentity:presentationDefinitionCreated"
  initialJsonData={`{
  "label": "Credential Set for proof of identity (Alternatives)",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "dcqlQuery": {
    "credentials": [
      {
        "id": "Passport",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": ["Passport"]
        },
        "claims": [
          {
            "path": ["serialNumber"]
          },
          {
            "path": ["firstName"]
          },
          {
            "path": ["signature"]
          },
          {
            "path": ["personalNumber"]
          },
          {
            "path": ["id"]
          },
          {
            "path": ["image"]
          },
          {
            "path": ["birthDate"]
          },
          {
            "path": ["lastName"]
          },
          {
            "path": ["gender"]
          },
          {
            "path": ["expiryDate"]
          },
          {
            "path": ["nationality"]
          },
          {
            "path": ["issuerAuthority"]
          }
        ],
        "require_cryptographic_holder_binding": true,
        "multiple": false
      },
      {
        "id": "PID",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": ["urn:eu.europa.ec.eudi:pid:1"]
        },
        "claims": [
          {
            "path": ["family_name"]
          },
          {
            "path": ["given_name"]
          },
          {
            "path": ["address", "country"]
          },
          {
            "path": ["address", "locality"]
          },
          {
            "path": ["address", "region"]
          },
          {
            "path": ["address", "street_address"]
          },
          {
            "path": ["birthdate"]
          },
          {
            "path": ["email"]
          },
          {
            "path": ["is_over_18"]
          },
          {
            "path": ["is_over_21"]
          },
          {
            "path": ["is_over_65"]
          },
          {
            "path": ["phone_number"]
          }
        ],
        "require_cryptographic_holder_binding": true,
        "multiple": false
      },
      {
        "id": "Photo-ID",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": ["eu.europa.ec.eudi.photoid.1"]
        },
        "claims": [
          {
            "path": ["dtc", "dg_content_info"]
          },
          {
            "path": ["dtc", "dtc_dg1"]
          },
          {
            "path": ["dtc", "dtc_dg10"]
          },
          {
            "path": ["dtc", "dtc_dg11"]
          },
          {
            "path": ["dtc", "dtc_dg12"]
          },
          {
            "path": ["dtc", "dtc_dg13"]
          },
          {
            "path": ["dtc", "dtc_dg14"]
          },
          {
            "path": ["dtc", "dtc_dg15"]
          },
          {
            "path": ["dtc", "dtc_dg16"]
          },
          {
            "path": ["dtc", "dtc_dg2"]
          },
          {
            "path": ["dtc", "dtc_dg3"]
          },
          {
            "path": ["dtc", "dtc_dg4"]
          },
          {
            "path": ["dtc", "dtc_dg5"]
          },
          {
            "path": ["dtc", "dtc_dg6"]
          },
          {
            "path": ["dtc", "dtc_dg7"]
          },
          {
            "path": ["dtc", "dtc_dg8"]
          },
          {
            "path": ["dtc", "dtc_dg9"]
          },
          {
            "path": ["dtc", "dtc_sod"]
          },
          {
            "path": ["dtc", "dtc_version"]
          },
          {
            "path": ["iso23220", "age_birth_year"]
          },
          {
            "path": ["iso23220", "age_in_years"]
          },
          {
            "path": ["iso23220", "age_over_18"]
          },
          {
            "path": ["iso23220", "family_name_latin1"]
          },
          {
            "path": ["iso23220", "given_name_latin1"]
          },
          {
            "path": ["iso23220", "issue_date"]
          },
          {
            "path": ["iso23220", "issuing_authority_unicode"]
          },
          {
            "path": ["iso23220", "name_at_birth"]
          },
          {
            "path": ["iso23220", "nationality"]
          },
          {
            "path": ["iso23220", "birthplace"]
          },
          {
            "path": ["iso23220", "given_name_unicode"]
          },
          {
            "path": ["iso23220", "family_name_unicode"]
          },
          {
            "path": ["iso23220", "birth_date"]
          },
          {
            "path": ["iso23220", "sex"]
          },
          {
            "path": ["iso23220", "portrait"]
          },
          {
            "path": ["iso23220", "portrait_capture_date"]
          },
          {
            "path": ["iso23220", "resident_address_unicode"]
          },
          {
            "path": ["iso23220", "resident_city_unicode"]
          },
          {
            "path": ["iso23220", "resident_postal_code"]
          },
          {
            "path": ["iso23220", "issuing_country"]
          },
          {
            "path": ["iso23220", "expiry_date"]
          },
          {
            "path": ["iso23220", "resident_country"]
          },
          {
            "path": ["photoid", "birth_city"]
          },
          {
            "path": ["photoid", "birth_country"]
          },
          {
            "path": ["photoid", "birth_state"]
          },
          {
            "path": ["photoid", "travel_document_number"]
          },
          {
            "path": ["photoid", "person_id"]
          },
          {
            "path": ["photoid", "administrative_number"]
          },
          {
            "path": ["photoid", "resident_street"]
          },
          {
            "path": ["photoid", "resident_state"]
          }
        ],
        "require_cryptographic_holder_binding": true,
        "multiple": false
      }
    ],
    "credential_sets": [
      {
        "options": [
          ["PID"],
          ["Passport"],
          ["Photo-ID"]
        ],
        "required": true
      }
    ]
  }
}`}
/>

Once a presentation definition is created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

<DcqlStepTemplate
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode || ""}
  listenPresentationDefinitionIdEvent="dcqlCredentialSetProofOfIdentity:presentationDefinitionCreated"
  initialJsonData={`{
  "requestByReference": true,
  "presentationDefinitionId": "<presentationDefinitionId>"
}`}
/>

Users can copy the `presentationExchangeId` from the JSON response for use in Step 7 to read verification history.

## Step 6: Send and Receive Verifiable Presentation (Holder)

The holder wallet accepts (consents) to send the requested credentials.

- **Receive Verification:**
  - Use the `vpTokenQrCode`(step 5) with the API available [here](/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3/) to receive the verification.
  - Copy the `presentationId` from the JSON response received from **Receive Verification** for use in Step 6b.
- **Filter Verification:**
  - Use that `presentationId` with the API available [here](/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification) to find matching credentials.
  - Save the `<id>` and `<credentialId>` from the response.
- **Send Verification:**
  - Use the `presentationId`, `<id>` and `<credentialId>` with the API available [here](/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3) to send the credentials to the verifier.

## Step 7: Send and Receive Verifiable Presentation (Verifier/Relying Party)

- The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
- From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
- From the decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.


---

# DCQL: Combined Credential Sets
Source: https://docs.igrant.io/docs/dcql-2-4-4-kyc-request-photo-id-address-proof/

---
id: dcql-2-4-4-kyc-request-photo-id-address-proof
title: "DCQL: Combined Credential Sets"
hide_title: false
sidebar_label: Combined Credential Sets
slug: /dcql-2-4-4-kyc-request-photo-id-address-proof/
description: DCQL combined credential sets requiring multiple mandatory credential groups, each with alternative options.
keywords: [DCQL, combined credential sets, KYC, identity verification, OpenID4VP, credential query, EUDI Wallet, photo ID, address proof]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcql-kyc` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcql-kyc
> ```


import Link from "@docusaurus/Link";
import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";

Multiple `credential_sets` can be combined in a single DCQL query, each marked as required. This allows a verifier to request several credential groups simultaneously, where each group may accept alternatives.

**Scenario:** A KYC check requires:

- A **Photo ID** credential for identity verification.
- A separate **Proof of Address**, where either a **Utility Bill** or **Bank Statement** is acceptable.

For the underlying DCQL query, diagram and example, see the **“KYC request with Photo ID and address proof”** use case in our [DCQL concepts article](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/#244-use-case-kyc-request-with-photo-id-and-address-proof).

![Fig 04: Require a Photo ID (Mandatory) plus Proof of Address via Utility Bill or Bank Statement.](../cDocs/articles/dcql-images/fig-04-dcql-eudi-wallet-photo-id-proof-of-address.png)

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the interactive blocks below using the **Run** button. Alternatively, you can manually copy the JSON body and use it in the API request available [here](https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in the matching Step 3 request automatically (and updated whenever that Step 2 block is re-run).

Credential definitions for this KYC use case:

### Bank Statement

A Bank Statement credential provides verified financial information including account details, transaction history, and balance information. It serves as a proof of financial stability and is commonly used for KYC (Know Your Customer) verification processes in accordance with [European Anti-Money Laundering directives](https://commission.europa.eu/projects/anti-money-laundering_en).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlKycPhotoIdAddressProof:bankStatementCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Bank Statement",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "vct": "BankStatement",
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "accountHolderName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "accountNumber"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "transactions",
              "amount"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "transactions",
              "date"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

### Utility Bill

A Utility Bill credential contains verified address information from utility service providers such as electricity, water, or telecommunications companies. It serves as a proof of residence and is commonly required for address verification in accordance with [EU identity verification standards](https://digital-strategy.ec.europa.eu/en/policies/eudi-regulation).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlKycPhotoIdAddressProof:utilityBillCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Utility Bill",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "vct": "UtilityBill",
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "age"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "billingDetails",
              "detail1"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "billingDetails",
              "detail2"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "billingDetails",
              "detail3"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

### Photo ID

Photo ID is based on an electronic Machine-Readable Travel Document (eMRTD), is issued and verified as a digital credential under the [EU Digital Travel Credential (DTC) framework](https://ec.europa.eu/commission/presscorner/detail/en/ip_24_5047) and the EU Digital Identity Framework (eIDAS Regulation). For more technical details, please refer to [EWC RFC 013: Issue Photo ID](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc013-issue-photoid.md).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlKycPhotoIdAddressProof:photoIdCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Photo ID",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "display": {
        "name": "Photo ID",
        "description": "Photo ID"
      },
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dg_content_info"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg1"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg10"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg11"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg12"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg13"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg14"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg15"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg16"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg2"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg3"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg4"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg5"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg6"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg7"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg8"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_dg9"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_sod"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["dtc", "dtc_version"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "age_birth_year"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "age_in_years"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "age_over_18"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "family_name_latin1"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "given_name_latin1"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "issue_date"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "issuing_authority_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "name_at_birth"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "nationality"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "birthplace"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "given_name_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "family_name_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "birth_date"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "sex"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "portrait"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "portrait_capture_date"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "resident_address_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "resident_city_unicode"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "resident_postal_code"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "issuing_country"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "expiry_date"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["iso23220", "resident_country"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "birth_city"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "birth_country"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "birth_state"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "travel_document_number"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "person_id"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "administrative_number"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "resident_street"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["photoid", "resident_state"]
          }
        ]
      },
      "vct": "eu.europa.ec.eudi.photoid.1"
    }
  ]
}`}
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run a Step 2 credential definition block on this page, the matching Step 3 request below autofills `credentialDefinitionId` and `credentials[].id` automatically (and updates whenever that Step 2 block is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values from the corresponding Step 2 response. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Choose the credential format as needed. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

The user needs to issue **three** credentials to the holder wallet:

- Bank Statement
- Utility Bill
- Photo ID

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

### Bank Statement

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlKycPhotoIdAddressProof:bankStatementCredentialDefinitionCreated"
  initialJsonData={`{
  "issuanceMode": "InTime",
  "credentialDefinitionId": "<credentialDefinitionId>",
  "urlScheme": "openid-credential-offer://",
  "credentials": [
    {
      "id": "<id>",
      "claims": {
        "accountHolderName": "Alice Andersson",
        "accountNumber": "SE45 5000 0000 0583 9825 7466",
        "address": "Sveavägen 44, 111 34 Stockholm, Sweden",
        "transactions": {
          "amount": "1250.50",
          "date": "2025-09-15"
        }
      }
    }
  ],
  "userPin": ""
}`}
/>

### Utility Bill

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlKycPhotoIdAddressProof:utilityBillCredentialDefinitionCreated"
  initialJsonData={`{
  "issuanceMode": "InTime",
  "credentialDefinitionId": "<credentialDefinitionId>",
  "urlScheme": "openid-credential-offer://",
  "credentials": [
    {
      "id": "<id>",
      "claims": {
        "name": "Alice Andersson",
        "age": "34",
        "address": "Sveavägen 44, 111 34 Stockholm, Sweden",
        "billingDetails": {
          "detail1": "Electricity – September 2025",
          "detail2": "Usage: 250 kWh",
          "detail3": "Provider: Stockholm Energi"
        }
      }
    }
  ],
  "userPin": ""
}`}
/>

### Photo ID

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlKycPhotoIdAddressProof:photoIdCredentialDefinitionCreated"
  initialJsonData={`{
  "issuanceMode": "InTime",
  "credentialDefinitionId": "<credentialDefinitionId>",
  "urlScheme": "openid-credential-offer://",
  "credentials": [
    {
      "id": "<id>",
      "claims": {
        "dtc": {
          "dg_content_info": "Swedish national ID document data groups",
          "dtc_dg1": "Primary identifier and personal identity number",
          "dtc_dg10": "Resident address data group",
          "dtc_dg11": "Issuing authority information",
          "dtc_dg12": "Document metadata",
          "dtc_dg13": "Portrait image data",
          "dtc_dg14": "Signature data group",
          "dtc_dg15": "Optional data group 15",
          "dtc_dg16": "Optional data group 16",
          "dtc_dg2": "Name and nationality",
          "dtc_dg3": "Birth information",
          "dtc_dg4": "Sex and physical attributes",
          "dtc_dg5": "Document number and series",
          "dtc_dg6": "Issuing country and authority",
          "dtc_dg7": "Document validity period",
          "dtc_dg8": "Additional personal attributes",
          "dtc_dg9": "Machine readable zone data",
          "dtc_sod": "Security object and digital signature",
          "dtc_version": "EUDI DTC profile version 1.0"
        },
        "iso23220": {
          "age_birth_year": 1991,
          "age_in_years": 34,
          "age_over_18": true,
          "birth_date": "1991-04-12",
          "birthplace": "Gothenburg, Sweden",
          "document_number": "SE123456789",
          "expiry_date": "2030-06-30",
          "family_name_latin1": "Andersson",
          "family_name_unicode": "Andersson",
          "given_name_latin1": "Alice",
          "given_name_unicode": "Alice",
          "issue_date": "2025-01-15",
          "issuing_authority_unicode": "Swedish Tax Agency",
          "issuing_country": "SWE",
          "name_at_birth": "Alice Andersson",
          "nationality": "SWE",
          "portrait": "base64-encoded-image-or-url",
          "portrait_capture_date": "2025-01-10T10:00:00Z",
          "resident_address_unicode": "Sveavägen 44, 111 34 Stockholm",
          "resident_city_unicode": "Stockholm",
          "resident_country": "SWE",
          "resident_postal_code": "111 34",
          "sex": 2
        },
        "photoid": {
          "administrative_number": "ADMIN-2025-0001",
          "birth_city": "Gothenburg",
          "birth_country": "Sweden",
          "birth_state": "Västra Götaland County",
          "person_id": "SE-19910412-1234",
          "resident_house_number": "44",
          "resident_state": "Stockholm County",
          "resident_street": "Sveavägen",
          "travel_document_number": "PA1234567"
        }
      }
    }
  ],
  "userPin": ""
}`}
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  emitPresentationDefinitionIdEvent="dcqlKycPhotoIdAddressProof:presentationDefinitionCreated"
  initialJsonData={`{
  "label": "KYC request with Photo ID and address proof",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "dcqlQuery": {
    "credentials": [
      {
        "id": "bank_statement",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": ["BankStatement"]
        },
        "claims": [
          {
            "path": ["accountHolderName"]
          },
          {
            "path": ["accountNumber"]
          },
          {
            "path": ["address"]
          },
          {
            "path": ["transactions", "amount"]
          },
          {
            "path": ["transactions", "date"]
          }
        ],
        "require_cryptographic_holder_binding": true
      },
      {
        "id": "utility_bill",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": ["UtilityBill"]
        },
        "claims": [
          {
            "path": ["name"]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": ["age"]
          },
          {
            "path": ["address"]
          },
          {
            "path": ["billingDetails", "detail1"]
          },
          {
            "path": ["billingDetails", "detail2"]
          },
          {
            "path": ["billingDetails", "detail3"]
          }
        ],
        "require_cryptographic_holder_binding": true
      },
      {
        "id": "photo_id",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": ["eu.europa.ec.eudi.photoid.1"]
        },
        "claims": [
          {
            "path": ["dtc", "dg_content_info"]
          },
          {
            "path": ["iso23220", "age_birth_year"]
          },
          {
            "path": ["photoid", "birth_city"]
          }
        ],
        "require_cryptographic_holder_binding": true
      }
    ],
    "credential_sets": [
      {
        "options": [
          ["photo_id"]
        ],
        "required": true
      },
      {
        "options": [
          ["utility_bill"],
          ["bank_statement"]
        ],
        "required": true
      }
    ]
  }
}`}
/>

Once a presentation definition is created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

<DcqlStepTemplate
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode || ""}
  listenPresentationDefinitionIdEvent="dcqlKycPhotoIdAddressProof:presentationDefinitionCreated"
  initialJsonData={`{
  "requestByReference": true,
  "presentationDefinitionId": "<presentationDefinitionId>"
}`}
/>

Users can copy the `presentationExchangeId` from the JSON response for use in Step 7 to read verification history.

## Step 6: Send and Receive Verifiable Presentation (Holder)

The holder wallet accepts (consents) to send the requested credentials.

- **Receive Verification:**
  - Use the `vpTokenQrCode`(step 5) with the API available [here](/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3/) to receive the verification.
  - Copy the `presentationId` from the JSON response received from **Receive Verification** for use in Step 6b.
- **Filter Verification:**
  - Use that `presentationId` with the API available [here](/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification) to find matching credentials.
  - Save the `<id>` and `<credentialId>` from the response.
- **Send Verification:**
  - Use the `presentationId`, `<id>` and `<credentialId>` with the API available [here](/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3) to send the credentials to the verifier.

## Step 7: Send and Receive Verifiable Presentation (Verifier/Relying Party)

- The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
- From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
- From the decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.


---

# DCQL: Mandatory and Optional Sets
Source: https://docs.igrant.io/docs/dcql-2-4-5-student-transport-pass/

---
id: dcql-2-4-5-student-transport-pass
title: "DCQL: Mandatory and Optional Sets"
hide_title: false
sidebar_label: Mandatory and Optional Sets
slug: /dcql-2-4-5-student-transport-pass/
description: DCQL credential sets mixing mandatory and optional groups with selective claim disclosure in a single query.
keywords: [DCQL, mandatory sets, optional sets, credential sets, OpenID4VP, credential query, EUDI Wallet, selective disclosure]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcql-student-pass` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcql-student-pass
> ```


import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";

DCQL `credential_sets` support a mix of mandatory and optional groups in a single query. Optional sets allow a verifier to request additional credentials that enhance the response but are not strictly required.

**Scenario:** A public transport authority requests a discounted student transport pass:

- **PID** for identity (mandatory)
- **Student ID** or **Enrolment Letter** to prove student status (mandatory)
- **Utility Bill** or **Rental Agreement** to prove local residency for an additional discount (optional)

For the underlying DCQL query, diagram and example, see the **“Student transport pass with mandatory and optional credentials”** use case in our [DCQL concepts article](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/#245-use-case-student-transport-pass-with-mandatory-and-optional-credentials).

![Fig 05: Require a PID and proof of being a student via Student ID or Enrolment Letter, with optional address proof.](../cDocs/articles/dcql-images/fig-05-dcql-eudi-wallet-student-proof-optional-address.png)

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the code blocks below using the **Run** button. Alternatively, you can manually copy the JSON body and use it in the API request available [here](https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in the matching Step 3 request automatically (and updated whenever that Step 2 block is re-run).

Credential definitions for this use case:

The issuer can define credential definitions for the following identity credentials:

- `PID` with credential format `mso_mdoc`
- `Student ID` with credential format `dc+sd-jwt`
- `Enrolment Letter` with credential format `dc+sd-jwt`
- `Utility Bill` with credential format `dc+sd-jwt`
- `Rental Agreement` with credential format `dc+sd-jwt`

### PID

Person Identification Data (PID) is a standardised European identity credential defined under the [EU Digital Identity Framework (eIDAS 2.0)](https://digital-strategy.ec.europa.eu/en/policies/eudi-regulation). It contains essential personal information including family name, given name, date of birth and address, enabling secure digital identification across EU member states.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlStudentTransportPass:pidCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Person Identification Data",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "mso_mdoc",
      "doctype": "urn:eu.europa.ec.eudi:pid:1",
      "display": {
        "name": "Person Identification Data",
        "description": "Person Identification Data credential with identity attributes"
      },
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "address",
              "country"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "address",
              "locality"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "address",
              "region"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "address",
              "street_address"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "birthdate"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "email"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "family_name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "given_name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "is_over_18"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "is_over_21"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "is_over_65"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eu.europa.ec.eudi",
              "phone_number"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

### Student ID

A Student ID credential is an official digital identification document issued by European educational institutions. It contains student information including enrolment status, student number and academic details in accordance with the [European Student Card Initiative](https://erasmus-plus.ec.europa.eu/european-student-card-initiative) standards, providing proof of student status for various services and benefits across the [European Higher Education Area](https://education.ec.europa.eu/education-levels/higher-education/european-student-card-initiative).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlStudentTransportPass:studentIdCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Student ID",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "vct": "VerifiableStudentID",
      "display": {
        "name": "Student ID",
        "description": "Verifiable student ID credential"
      },
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "commonName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "dateOfBirth"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "displayName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eduPersonAffiliation",
              null
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eduPersonAssurance",
              null
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eduPersonPrimaryAffiliation"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eduPersonPrincipalName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "eduPersonScopedAffiliation",
              null
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "familyName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "firstName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "id"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "identifier"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "mail"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "schacHomeOrganization"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "schacPersonalUniqueCode",
              null
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "schacPersonalUniqueID"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

### Enrolment Letter

An Enrolment Letter credential is an official document from a European educational institution confirming a student's enrolment in a specific program. It includes details such as the program of study, enrolment dates and academic standing, serving as a proof of current student status in compliance with [European higher education standards](https://education.ec.europa.eu/education-levels/higher-education/european-student-card-initiative).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlStudentTransportPass:enrolmentLetterCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Enrolment Letter",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "vct": "EnrolmentLetter",
      "display": {
        "name": "Enrolment Letter",
        "description": "Enrolment letter credential"
      },
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "dob"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "universityName"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "statusActive"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address",
              "addressLine1"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address",
              "addressLine2"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address",
              "addressLine3"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

### Utility Bill

A Utility Bill credential contains verified address information from utility service providers such as electricity, water or telecommunications companies. It serves as proof of residence and is commonly required for address verification in accordance with [EU identity verification standards](https://digital-strategy.ec.europa.eu/en/policies/eudi-regulation).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlStudentTransportPass:utilityBillCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Utility Bill",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "vct": "UtilityBill",
      "display": {
        "name": "Utility Bill",
        "description": "Utility bill credential with address details"
      },
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "age"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "billingDetails",
              "detail1"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "billingDetails",
              "detail2"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "billingDetails",
              "detail3"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

### Rental Agreement

A Rental Agreement credential is a digital version of a legally binding contract between a landlord and tenant, compliant with [European housing policies](https://housing.ec.europa.eu/index_en). It contains verified information about the rental property, terms of lease, and tenant details, serving as proof of residence for official purposes across EU member states.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlStudentTransportPass:rentalAgreementCredentialDefinitionCreated"
  initialJsonData={`{
  "label": "Rental Agreement",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "vct": "RentalAgreement",
      "display": {
        "name": "Rental Agreement",
        "description": "Rental agreement credential"
      },
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "address"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "amount"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "issuanceDate"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "expiryDate"
            ]
          }
        ]
      }
    }
  ]
}`}
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run a Step 2 credential definition block on this page, the matching Step 3 request below autofills `credentialDefinitionId` and `credentials[].id` automatically (and updates whenever that Step 2 block is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values from the corresponding Step 2 response. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Choose the credential format as needed. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

The user needs to issue **five** credentials to the holder wallet:

- `PID` with credential format `mso_mdoc`
- `Student ID` with credential format `dc+sd-jwt`
- `Enrolment Letter` with credential format `dc+sd-jwt`
- `Utility Bill` with credential format `dc+sd-jwt`
- `Rental Agreement` with credential format `dc+sd-jwt`

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

### PID

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlStudentTransportPass:pidCredentialDefinitionCreated"
  initialJsonData={`{
    "issuanceMode": "InTime",
    "credentialDefinitionId": "<credentialDefinitionId>",
    "urlScheme": "openid-credential-offer://",
    "credentials": [
        {
            "id": "<id>",
            "claims": {
                "eu.europa.ec.eudi": {
                    "address": {
                        "country": "Sweden",
                        "locality": "Stockholm",
                        "region": "Stockholm County",
                        "street_address": "Sveavägen 44, 111 34 Stockholm"
                    },
                    "birthdate": "1998-09-17",
                    "email": "alice.andersson@example.se",
                    "family_name": "Andersson",
                    "given_name": "Alice",
                    "is_over_18": true,
                    "is_over_21": true,
                    "is_over_65": false,
                    "phone_number": "+46 70 123 45 67"
                }
            }
        }
    ],
    "userPin": ""
}`}
/>

### Student ID

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlStudentTransportPass:studentIdCredentialDefinitionCreated"
  initialJsonData={`{
    "issuanceMode": "InTime",
    "credentialDefinitionId": "<credentialDefinitionId>",
    "urlScheme": "openid-credential-offer://",
    "credentials": [
        {
            "id": "<id>",
            "claims": {
                "commonName": "Alice Andersson",
                "dateOfBirth": "1998-09-17",
                "displayName": "Alice A.",
                "eduPersonAffiliation": [
                    "student",
                    "member"
                ],
                "eduPersonAssurance": [
                    "https://refeds.org/assurance/ID/unique",
                    "https://refeds.org/assurance/ID/aal2"
                ],
                "eduPersonPrimaryAffiliation": "student",
                "eduPersonPrincipalName": "alice.andersson@su.se",
                "eduPersonScopedAffiliation": [
                    "student@su.se"
                ],
                "familyName": "Andersson",
                "firstName": "Alice",
                "id": "123456",
                "identifier": "alice123",
                "mail": "alice.andersson@example.se",
                "schacHomeOrganization": "su.se",
                "schacPersonalUniqueCode": [
                    "urn:schac:personalUniqueCode:int:se:personalNumber:199809179999"
                ],
                "schacPersonalUniqueID": "urn:schac:personalUniqueID:se:su.se:alice.andersson"
            }
        }
    ],
    "userPin": ""
}`}
/>

### Enrolment Letter

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlStudentTransportPass:enrolmentLetterCredentialDefinitionCreated"
  initialJsonData={`{
    "issuanceMode": "InTime",
    "credentialDefinitionId": "<credentialDefinitionId>",
    "urlScheme": "openid-credential-offer://",
    "credentials": [
        {
            "id": "<id>",
            "claims": {
                "name": "Alice Andersson",
                "dob": "1998-09-17",
                "universityName": "Stockholm University",
                "statusActive": "true",
                "address": {
                    "addressLine1": "Stockholm University",
                    "addressLine2": "Universitetsvägen 10",
                    "addressLine3": "114 18 Stockholm, Sweden"
                }
            }
        }
    ],
    "userPin": ""
}`}
/>

### Utility Bill

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlStudentTransportPass:utilityBillCredentialDefinitionCreated"
  initialJsonData={`{
    "issuanceMode": "InTime",
    "credentialDefinitionId": "<credentialDefinitionId>",
    "urlScheme": "openid-credential-offer://",
    "credentials": [
        {
            "id": "<id>",
            "claims": {
                "name": "Alice Andersson",
                "age": "27",
                "address": "Sveavägen 44, 111 34 Stockholm, Sweden",
                "billingDetails": {
                    "detail1": "Electricity - September 2025",
                    "detail2": "Usage: 250 kWh",
                    "detail3": "Provider: Stockholm Energi"
                }
            }
        }
    ],
    "userPin": ""
}`}
/>

### Rental Agreement

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlStudentTransportPass:rentalAgreementCredentialDefinitionCreated"
  initialJsonData={`{
    "issuanceMode": "InTime",
    "credentialDefinitionId": "<credentialDefinitionId>",
    "urlScheme": "openid-credential-offer://",
    "credentials": [
        {
            "id": "<id>",
            "claims": {
                "name": "Alice Andersson",
                "address": "Sveavägen 44, 111 34 Stockholm, Sweden",
                "amount": "9500",
                "issuanceDate": "2024-09-13",
                "expiryDate": "2026-09-23"
            }
        }
    ],
    "userPin": ""
}`}
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  emitPresentationDefinitionIdEvent="dcqlStudentTransportPass:presentationDefinitionCreated"
  initialJsonData={`{
  "label": "Student transport pass with mandatory and optional credentials",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "dcqlQuery": {
    "credentials": [
      {
        "id": "pid",
        "format": "mso_mdoc",
        "meta": {
          "doctype_value": "urn:eu.europa.ec.eudi:pid:1"
        },
        "claims": [
          {
            "id": "full_name",
            "path": [
              "eu.europa.ec.eudi",
              "given_name"
            ]
          },
          {
            "id": "dob",
            "path": [
              "eu.europa.ec.eudi",
              "birthdate"
            ]
          }
        ],
        "claim_sets": [
          [
            "full_name"
          ],
          [
            "dob"
          ]
        ]
      },
      {
        "id": "student_id_card",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "VerifiableStudentID"
          ]
        },
        "claims": [
          {
            "id": "student_id",
            "path": [
              "schacPersonalUniqueID"
            ]
          },
          {
            "id": "university_org_name",
            "path": [
              "schacHomeOrganization"
            ]
          }
        ],
        "claim_sets": [
          [
            "university_org_name",
            "student_id"
          ]
        ]
      },
      {
        "id": "enrolment_letter",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "EnrolmentLetter"
          ]
        },
        "claims": [
          {
            "id": "status",
            "path": [
              "statusActive"
            ]
          },
          {
            "id": "university_name",
            "path": [
              "universityName"
            ]
          }
        ],
        "claim_sets": [
          [
            "university_name",
            "status"
          ]
        ]
      },
      {
        "id": "utility_bill_doc",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "UtilityBill"
          ]
        },
        "claims": [
          {
            "id": "address",
            "path": [
              "address"
            ]
          }
        ]
      },
      {
        "id": "rental_agreement_doc",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "RentalAgreement"
          ]
        },
        "claims": [
          {
            "id": "full_address",
            "path": [
              "address"
            ]
          }
        ]
      }
    ],
    "credential_sets": [
      {
        "options": [
          [
            "pid"
          ]
        ],
        "required": true
      },
      {
        "options": [
          [
            "student_id_card"
          ],
          [
            "enrolment_letter"
          ]
        ],
        "required": true
      },
      {
        "options": [
          [
            "utility_bill_doc"
          ],
          [
            "rental_agreement_doc"
          ]
        ],
        "required": false
      }
    ]
  }
}`}
/>

Once a presentation definition is created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

<DcqlStepTemplate
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode || ""}
  listenPresentationDefinitionIdEvent="dcqlStudentTransportPass:presentationDefinitionCreated"
  initialJsonData={`{
  "requestByReference": true,
  "presentationDefinitionId": "<presentationDefinitionId>"
}`}
/>

Users can copy the `presentationExchangeId` from the JSON response for use in Step 8 to read verification history.

## Step 6: Send and Receive Verifiable Presentation (Holder)

The holder wallet accepts (consents) to send the requested credentials.

- **Receive Verification:**
  - Use the `vpTokenQrCode`(step 5) with the API available [here](/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3/) to receive the verification.
  - Copy the `presentationId` from the JSON response received from **Receive Verification** for use in Step 6b.
- **Filter Verification:**
  - Use that `presentationId` with the API available [here](/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification) to find matching credentials.
  - Save the `<id>` and `<credentialId>` from the response.
- **Send Verification:**
  - Use the `presentationId`, `<id>` and `<credentialId>` with the API available [here](/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3) to send the credentials to the verifier.

## Step 7: Send and Receive Verifiable Presentation (Verifier/Relying Party)

- The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
- From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
- From the decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.


---

# DCQL: Multiple Credential Instances
Source: https://docs.igrant.io/docs/dcql-2-4-6-loan-application-multiple-bank-statements/

---
id: dcql-2-4-6-loan-application-multiple-bank-statements
title: "DCQL: Multiple Credential Instances"
hide_title: false
sidebar_label: Multiple Credential Instances
slug: /dcql-2-4-6-loan-application-multiple-bank-statements/
description: DCQL multiple field for requesting several instances of the same credential type in a single verification flow.
keywords: [DCQL, multiple credential instances, credential query, OpenID4VP, EUDI Wallet, bank statements, verifiable credentials]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcql-multiple-statements` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcql-multiple-statements
> ```


import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";

Setting the DCQL query's `multiple` field to `true` allows a verifier to request several instances of the same credential type in a single verification flow.

**Scenario:** A loan provider requests six recent `BankStatement` credentials as part of assessing a loan application.

For the underlying DCQL query, diagram and narrative, see the **“Loan application with multiple recent bank statements”** use case in our [DCQL concepts article](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/#246-use-case-loan-application-with-multiple-recent-bank-statements).

![Fig 06: Require six recent Bank Statements (Mandatory) to assess affordability as part of a loan application.](../cDocs/articles/dcql-images/fig-06-dcql-eudi-wallet-multiple-bank-statements-loan.png)

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in Step 3 automatically (and updated whenever Step 2 is re-run).

The issuer can define credential definition for the `BankStatement` of credential format `dc+sd-jwt`

### Bank Statement

A Bank Statement credential provides verified financial information including account details, transaction history and balance information. It serves as a proof of financial stability and is commonly required for loan applications and financial assessments in accordance with [European banking regulations](https://www.eba.europa.eu/) and [Anti-Money Laundering directives](https://commission.europa.eu/projects/anti-money-laundering_en).

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  emitCredentialDefinitionIdsEvent="dcqlLoanApplicationMultipleBankStatements:credentialDefinitionCreated"
  defaultRequestJson={{
    label: "Bank Statement",
    cryptographicKeyFormat: "x509",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    credentialDefinitions: [
      {
        credentialFormat: "dc+sd-jwt",
        vct: "BankStatement",
        display: {
          name: "Bank Statement",
          description: "Bank account statement credential",
        },
        claims: {
          claims: [
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["account_holder_name"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["period"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["account_number"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["transactions", "amount"],
            },
            {
              limitDisclosure: true,
              mandatory: true,
              path: ["transactions", "date"],
            },
          ],
        },
      },
    ],
  }}
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run Step 2 on this page, the `credentialDefinitionId` and `credentials[].id` fields below are autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained from Step 2. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Choose the credential format as needed. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

> Note: The user needs to issue credentials for multiple recent Bank Statements to the holder wallet. After Step 2 autofills the IDs, run this Step 3 request once per bank statement (updating the claims as needed).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

### Bank Statement

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlLoanApplicationMultipleBankStatements:credentialDefinitionCreated"
  defaultRequestJson={{
    issuanceMode: "InTime",
    credentialDefinitionId: "<credentialDefinitionId>",
    urlScheme: "openid-credential-offer://",
    credentials: [
      {
        id: "<id>",
        claims: {
          account_holder_name: "Alice Andersson",
          account_number: "SE12 3456 7890 1234 5678 90",
          period: "180d",
          transactions: {
            amount: "1200.50",
            date: "2025-08-31",
          },
        },
      },
    ],
    userPin: "",
  }}
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  emitPresentationDefinitionIdEvent="dcqlLoanApplicationMultipleBankStatements:presentationDefinitionCreated"
  defaultRequestJson={{
    label: "Loan application with multiple recent bank statements",
    cryptographicKeyFormat: "x509",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    dcqlQuery: {
      credentials: [
        {
          id: "bank_statement",
          format: "dc+sd-jwt",
          multiple: true,
          meta: {
            vct_values: ["BankStatement"],
          },
          claims: [
            {
              id: "statement_period",
              path: ["period"],
            },
            {
              id: "account_number",
              path: ["account_number"],
            },
            {
              id: "account_holder_name",
              path: ["account_holder_name"],
            },
          ],
          claim_sets: [
            ["statement_period", "account_number", "account_holder_name"],
          ],
        },
      ],
    },
  }}
/>

Once a presentation definition is created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

<DcqlStepTemplate
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode || ""}
  listenPresentationDefinitionIdEvent="dcqlLoanApplicationMultipleBankStatements:presentationDefinitionCreated"
  defaultRequestJson={{
    presentationDefinitionId: "<presentationDefinitionId>",
    requestByReference: true,
  }}
/>

Users can copy the `presentationExchangeId` from the JSON response for use in Step 7 to read verification history.

## Step 6: Send and Receive Verifiable Presentation (Holder)

The holder wallet accepts (consents) to send the requested credentials.

- **Receive Verification:**
  - Use the `vpTokenQrCode`(step 5) with the API available [here](/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3/) to receive the verification.
  - Copy the `presentationId` from the JSON response received from **Receive Verification** for use in Step 6b.
- **Filter Verification:**
  - Use that `presentationId` with the API available [here](/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification) to find matching credentials.
  - Save the `<id>` and `<credentialId>` from the response.
- **Send Verification:**
  - Use the `presentationId`, `<id>` and `<credentialId>` with the API available [here](/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3) to send the credentials to the verifier.

## Step 7: Send and Receive Verifiable Presentation (Verifier/Relying Party)

- The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
- From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
- From the decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.


---

# DCQL: Values Constraint
Source: https://docs.igrant.io/docs/dcql-2-4-7-delivery-service-restricted-postal-codes/

---
id: dcql-2-4-7-delivery-service-restricted-postal-codes
title: "DCQL: Values Constraint"
hide_title: false
description: DCQL values constraint for restricting accepted claim values to a predefined allowed list.
keywords: [DCQL, values constraint, allowed values, credential query, OpenID4VP, EUDI Wallet, claim validation, verifiable credentials]
sidebar_label: Values Constraint
slug: /dcql-2-4-7-delivery-service-restricted-postal-codes/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcql-postal-codes` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcql-postal-codes
> ```


import Link from "@docusaurus/Link";
import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";

The DCQL `values` constraint restricts accepted claim values to a predefined allowed list, enabling a verifier to enforce eligibility criteria directly in the query.

**Scenario:** A delivery service requests a PID credential (in `dc+sd-jwt` format) containing the holder's residential address, accepting only postal codes from an allowed list.

For the underlying DCQL query, diagram and example, see the **“Delivery service restricted to specific postal codes”** use case in our [DCQL concepts article](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/#247-use-case-delivery-service-restricted-to-specific-postal-codes).

![Fig 07: Require a PID and an address credential with a postal code matching 43242 or 43243 for eligibility.](../cDocs/articles/dcql-images/fig-07-dcql-eudi-wallet-address-postal-code-eligibility.png)

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the JSON body using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in Step 3 automatically (and updated whenever Step 2 is re-run).

The issuer can define credential definition for the `PID` of credential format `dc+sd-jwt`

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlDeliveryServiceRestrictedPostalCodes:credentialDefinitionCreated"
  initialJsonData={`{
  "label": "Person Identification Data",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "credentialDefinitions": [
    {
      "credentialFormat": "dc+sd-jwt",
      "vct": "urn:eu.europa.ec.eudi:pid:1",
      "claims": {
        "claims": [
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "residential_address",
              "street_address"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "residential_address",
              "postal_code"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "residential_address",
              "locality"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "residential_address",
              "country"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "birthdate"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "email"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "family_name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "given_name"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "is_over_18"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "is_over_21"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "is_over_65"
            ]
          },
          {
            "limitDisclosure": true,
            "mandatory": true,
            "path": [
              "phone_number"
            ]
          }
        ]
      },
      "display": {
        "name": "Person Identification Data",
        "description": "Proof of identity and address"
      }
    }
  ]
}`}
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run Step 2 on this page, the `credentialDefinitionId` and `credentials[].id` fields below are autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained from Step 2. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Choose the credential format as needed. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

### PID

Person Identification Data (PID) is a standardised European identity credential defined under the [EU Digital Identity Framework (eIDAS 2.0)](https://digital-strategy.ec.europa.eu/en/policies/eudi-regulation). It contains essential personal information including family name, given name, date of birth and address, enabling secure digital identification across EU member states.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
  listenCredentialDefinitionIdsEvent="dcqlDeliveryServiceRestrictedPostalCodes:credentialDefinitionCreated"
  initialJsonData={`{
  "issuanceMode": "InTime",
  "credentialDefinitionId": "<credentialDefinitionId>",
  "urlScheme": "openid-credential-offer://",
  "credentials": [
    {
      "id": "<id>",
      "claims": {
        "residential_address": {
          "country": "Sweden",
          "locality": "Stockholm",
          "region": "Stockholms län",
          "street_address": "Sveavägen 44",
          "postal_code": "11134"
        },
        "birthdate": "1990-04-15",
        "email": "alice.andersson@example.se",
        "family_name": "Andersson",
        "given_name": "Alice",
        "is_over_18": true,
        "is_over_21": true,
        "is_over_65": false,
        "phone_number": "+46 70 123 45 67"
      }
    }
  ],
  "userPin": ""
}`}
/>

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

In this use case, the verifier expresses a requirement for a residential address credential where the postal code is in an allowed list of delivery zones.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  emitPresentationDefinitionIdEvent="dcqlDeliveryServiceRestrictedPostalCodes:presentationDefinitionCreated"
  initialJsonData={`{
  "label": "Delivery service restricted to specific postal codes",
  "cryptographicKeyFormat": "x509",
  "cryptographicKeyIdentifier": "<cryptographicKeyIdentifier>",
  "dcqlQuery": {
    "credentials": [
      {
        "id": "residential_address",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "urn:eu.europa.ec.eudi:pid:1"
          ]
        },
        "display": {
          "name": "Person Identification Data",
          "description": "PID credential with residential address and contact details"
        },
        "claims": [
        {
          "id": "full_address",
          "path": [
            "residential_address",
            "street_address"
          ]
        },
        {
          "id": "postal_code",
          "path": [
            "residential_address",
            "postal_code"
          ],
          "values": [
            "11134",
            "41103"
          ]
        },
        {
          "id": "city",
          "path": [
            "residential_address",
            "locality"
          ]
        },
        {
          "id": "country",
          "path": [
            "residential_address",
            "country"
          ]
        }
      ],
        "claim_sets": [
          [
            "full_address",
            "postal_code",
            "city",
            "country"
          ]
        ]
      }
    ]
  }
}`}
/>

Once a presentation definition is created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

<DcqlStepTemplate
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode || ""}
  listenPresentationDefinitionIdEvent="dcqlDeliveryServiceRestrictedPostalCodes:presentationDefinitionCreated"
  initialJsonData={`{
  "requestByReference": true,
  "presentationDefinitionId": "<presentationDefinitionId>"
}`}
/>

Users can copy the `presentationExchangeId` from the JSON response for use in Step 8 to read verification history.

## Step 6: Send and Receive Verifiable Presentation (Holder)

The holder wallet accepts (consents) to send the requested credentials.

- **Receive Verification:**
  - Use the `vpTokenQrCode`(step 5) with the API available [here](/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3/) to receive the verification.
  - Copy the `presentationId` from the JSON response received from **Receive Verification** for use in Step 6b.
- **Filter Verification:**
  - Use that `presentationId` with the API available [here](/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification) to find matching credentials.
  - Save the `<id>` and `<credentialId>` from the response.
- **Send Verification:**
  - Use the `presentationId`, `<id>` and `<credentialId>` with the API available [here](/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3) to send the credentials to the verifier.

## Step 7: Send and Receive Verifiable Presentation (Verifier/Relying Party)

- The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
- From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
- From the decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.


---

# DCQL: Trusted Authorities
Source: https://docs.igrant.io/docs/dcql-basic-credential-query-with-trusted-authority/

---
id: dcql-basic-credential-query-with-trusted-authority
title: "DCQL: Trusted Authorities"
hide_title: false
description: DCQL credential query filtered by trusted authorities (EU Trust List, EBSI, OpenID Federation) using iGrant.io Digital Wallets.
sidebar_label: Trusted Authorities
keywords: [DCQL, trusted authorities, EU Trust List, EBSI, OpenID Federation, credential query, OpenID4VP, EUDI Wallet, trust framework]
slug: /dcql-basic-credential-query-with-trusted-authority/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcql-trusted-authority` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcql-trusted-authority
> ```


import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";

The `trusted_authorities` field in a DCQL query allows a verifier to restrict accepted credentials to those issued by specific trust anchors.

**Scenario:** A verifier requests a University Degree credential, accepting it only if issued by an authority in the EU Trust List, EBSI, or an OpenID Federation trust anchor.

For the underlying DCQL query, diagram and video walkthrough, see the **“Basic credential query with trusted authority”** use case in our [DCQL concepts article](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/#241-use-case-basic-credential-query-with-trusted-authority).

![Fig 01: Require a University Degree credential, only if issued by an authority listed in the trusted list.](../cDocs/articles/dcql-images/fig-01-dcql-eudi-wallet-university-degree-trusted-authority.png)

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definitions (Issuer Admin)

To create a credential definition, run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

From the API response, copy the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array for use in the Step 3.

### Aegean University Degree - Master's (Issuer Admin)

Use this step to create the credential definition for the Aegean University Master's degree that is present in the EWC Trust List and key format `x509`.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlTrustedAuthority:mastersCredentialDefinitionCreated"
  initialJsonData={{
    label: "UAegean University Degree (Masters)",
    cryptographicKeyFormat: "x509",
    version: "version_01",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    enforceWUA: true,
    credentialDefinitions: [
      {
        credentialFormat: "dc+sd-jwt",
        vct: "UniversityDegree",
        claims: {
          claims: [
            { limitDisclosure: true, mandatory: true, path: ["name"] },
            { limitDisclosure: true, mandatory: true, path: ["registrationNumber"] },
            { limitDisclosure: true, mandatory: true, path: ["dateOfBirth"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject1"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject2"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject3"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject4"] },
          ],
        },
        display: {
          name: "UAegean University Degree (Masters)",
          description: "UAegean University's Master's degree credential",
        },
      },
    ],
  }}
/>

### Aegean University Degree - Bachelor's (Issuer Admin)

This step creates the credential definition for the Aegean University Bachelor's degree, also present in the EWC Trust List and key format `x509`.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlTrustedAuthority:aegeanBachelorsCredentialDefinitionCreated"
  initialJsonData={{
    label: "UAegean University Degree (Bachelors)",
    cryptographicKeyFormat: "x509",
    version: "version_01",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    enforceWUA: true,
    credentialDefinitions: [
      {
        credentialFormat: "dc+sd-jwt",
        vct: "UniversityDegree",
        claims: {
          claims: [
            { limitDisclosure: true, mandatory: true, path: ["name"] },
            { limitDisclosure: true, mandatory: true, path: ["registrationNumber"] },
            { limitDisclosure: true, mandatory: true, path: ["dateOfBirth"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject1"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject2"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject3"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject4"] },
          ],
        },
        display: {
          name: "UAegean University Degree (Bachelors)",
          description: "UAegean University's Bachelor's degree credential",
        },
      },
    ],
  }}
/>

### ABC University Degree - Bachelor's (Issuer Admin)

In this step you create the credential definition for a Bachelor's degree issued by ABC University, Australia. This university is **not** in the EWC Trust List: its signing certificate is not on the list, so the `trusted_authorities` query does not match its credential.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  emitCredentialDefinitionIdsEvent="dcqlTrustedAuthority:abcBachelorsCredentialDefinitionCreated"
  initialJsonData={{
    label: "ABC University (Australia) (Bachelors)",
    cryptographicKeyFormat: "x509",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    version: "version_01",
    credentialDefinitions: [
      {
        credentialFormat: "dc+sd-jwt",
        vct: "UniversityDegree",
        claims: {
          claims: [
            { limitDisclosure: true, mandatory: true, path: ["name"] },
            { limitDisclosure: true, mandatory: true, path: ["registrationNumber"] },
            { limitDisclosure: true, mandatory: true, path: ["dateOfBirth"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject1"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject2"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject3"] },
            { limitDisclosure: true, mandatory: true, path: ["subjects", "subject4"] },
          ],
        },
        display: {
          name: "ABC University (Australia) (Bachelors)",
          description:
            "ABC University (Australia) Bachelor's degree credential",
        },
      },
    ],
  }}
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in the `InTime` issuance mode. Run the request separately for each credential type. When you run Step 2 on this page, the `credentialDefinitionId` and `id` fields of the matching request below are autofilled (and updated whenever that Step 2 block is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained in Step 2. Alternatively, you may use the API available [here](https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, toggle the provided button to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device (e.g. via a browser).

### Aegean University Degree - Master's

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  listenCredentialDefinitionIdsEvent="dcqlTrustedAuthority:mastersCredentialDefinitionCreated"
  initialJsonData={{
    issuanceMode: "InTime",
    credentialDefinitionId: "<credentialDefinitionId>",
    userPin: "",
    credentials: [
      {
        id: "<id>",
        claims: {
          name: "Alice Andersson",
          registrationNumber: "SE-2020-000123",
          dateOfBirth: "1993-04-12",
          subjects: {
            subject1: "Computer Science",
            subject2: "Data Privacy and GDPR",
            subject3: "Distributed Systems",
            subject4: "Digital Identity and Wallets",
          },
        },
      },
    ],
  }}
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
/>

### Aegean University Degree - Bachelor's

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  listenCredentialDefinitionIdsEvent="dcqlTrustedAuthority:aegeanBachelorsCredentialDefinitionCreated"
  initialJsonData={{
    issuanceMode: "InTime",
    credentialDefinitionId: "<credentialDefinitionId>",
    userPin: "",
    credentials: [
      {
        id: "<id>",
        claims: {
          name: "Alice Andersson",
          registrationNumber: "SE-2020-000123",
          dateOfBirth: "1993-04-12",
          subjects: {
            subject1: "Computer Science",
            subject2: "Data Privacy and GDPR",
            subject3: "Distributed Systems",
            subject4: "Digital Identity and Wallets",
          },
        },
      },
    ],
  }}
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
/>

### ABC University Degree - Bachelor's

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  listenCredentialDefinitionIdsEvent="dcqlTrustedAuthority:abcBachelorsCredentialDefinitionCreated"
  initialJsonData={{
    issuanceMode: "InTime",
    credentialDefinitionId: "<credentialDefinitionId>",
    userPin: "",
    credentials: [
      {
        id: "<id>",
        claims: {
          name: "Alice Andersson",
          registrationNumber: "SE-2020-000123",
          dateOfBirth: "1993-04-12",
          subjects: {
            subject1: "Computer Science",
            subject2: "Data Privacy and GDPR",
            subject3: "Distributed Systems",
            subject4: "Digital Identity and Wallets",
          },
        },
      },
    ],
  }}
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer || ""}
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

> Note: With `cryptographicKeyFormat` `x509`, the `cryptographicKeyIdentifier` must be a key of your organisation that has a certificate chain. The page fills in such a key after you set the API key. Use **Select key** on the request to choose another key, or see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

- Create a Presentation Definition by executing the code block below.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  emitPresentationDefinitionIdEvent="dcqlTrustedAuthority:presentationDefinitionCreated"
  initialJsonData={{
    label: "Basic Credential Query with trusted authority",
    cryptographicKeyFormat: "x509",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    dcqlQuery: {
      credentials: [
        {
          id: "UniversityDegreeCredential",
          format: "dc+sd-jwt",
          meta: {
            vct_values: ["UniversityDegree"],
          },
          claims: [
            {
              path: ["name"],
            },
            {
              path: ["registrationNumber"],
            },
            {
              path: ["dateOfBirth"],
            },
            {
              path: ["subjects", "subject1"],
            },
            {
              path: ["subjects", "subject2"],
            },
            {
              path: ["subjects", "subject3"],
            },
            {
              path: ["subjects", "subject4"],
            },
          ],
          require_cryptographic_holder_binding: true,
          trusted_authorities: [
            {
              type: "etsi_tl",
              values: [
                "https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml",
              ],
            },
          ],
        },
      ],
    },
  }}
/>

Once a presentation definition has been created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

<DcqlStepTemplate
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  listenPresentationDefinitionIdEvent="dcqlTrustedAuthority:presentationDefinitionCreated"
  initialJsonData={{
    presentationDefinitionId: "<presentationDefinitionId>",
    requestByReference: true,
  }}
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode || ""}
/>

## Step 6: Send and Receive Verifiable Presentation (Holder)

The holder wallet accepts (consents) to send the requested credentials.

- **Receive Verification:**
  - Use the `vpTokenQrCode`(step 5) with the API available [here](/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3/) to receive the verification.
  - Copy the `presentationId` from the JSON response received from **Receive Verification** for use in Step 6b.
- **Filter Verification:**
  - Use that `presentationId` with the API available [here](/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification) to find matching credentials.
  - Save the `<id>` and `<credentialId>` from the response.
- **Send Verification:**
  - Use the `presentationId`, `<id>` and `<credentialId>` with the API available [here](/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3) to send the credentials to the verifier.

## Step 7: Send and Receive Verifiable Presentation (Verifier/Relying Party)

- The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
- From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
- From the decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.


---

# DCQL (Digital Credential Query Language)
Source: https://docs.igrant.io/docs/dcql-overview/

---
id: dcql-overview
title: "DCQL (Digital Credential Query Language)"
hide_title: false
description: Introduction to the Digital Credential Query Language (DCQL) as defined in OpenID4VP 1.0, with a summary of its building blocks and developer workflow examples.
sidebar_label: Overview
keywords: [DCQL, Digital Credential Query Language, OpenID4VP, credential query, verifiable presentations, EUDI Wallet, credential request, selective disclosure]
slug: /dcql-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


The Digital Credential Query Language (DCQL, pronounced "dak-l") is a JSON-based query language introduced in the [OpenID for Verifiable Presentations (OpenID4VP) 1.0](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html) specification. It enables verifiers to express precise requirements for the credentials they need from a holder's wallet.

A DCQL query is a JSON object with two top-level properties:

- **`credentials`** (required): An array of Credential Query objects, each describing a specific credential the verifier is interested in.
- **`credential_sets`** (optional): An array defining logical groupings and requirements across the requested credentials.

For the full specification, business context, and real-world payment examples, see our [concepts article on DCQL in the EUDI Wallet ecosystem](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/).

## Building Blocks

DCQL provides a small set of composable building blocks that cover a wide range of verification scenarios:

| Building block | Purpose |
|---|---|
| **Credential Query** | Requests a specific credential by format, metadata, and claims. The fundamental unit of a DCQL query. |
| **`trusted_authorities`** | Restricts accepted credentials to those issued by specific trust anchors (EU Trust List, EBSI, OpenID Federation). |
| **`claims`** | Specifies which individual claims within a credential are requested, enabling selective disclosure. |
| **`claim_sets`** | Defines acceptable combinations of claims, allowing preferred claims with fallback alternatives. |
| **`credential_sets`** | Groups multiple credential queries with logical rules (AND/OR), supporting mandatory and optional sets. |
| **`multiple`** | When set to `true`, allows several instances of the same credential type to be returned in a single flow. |
| **`values`** | Constrains accepted claim values to a predefined allowed list. |

## Developer Workflow Examples

Each example below demonstrates a specific DCQL building block through a complete developer workflow with runnable API calls. You can also try these scenarios live in the [iGrant.io DCQL demos](https://igrant.io/demo.html?filter=tech-dcql) and watch walkthroughs on the [iGrant.io YouTube channel](https://www.youtube.com/@iGrantio).

| Example | DCQL feature | Scenario |
|---|---|---|
| [Trusted Authorities](/docs/dcql-basic-credential-query-with-trusted-authority/) | `trusted_authorities` | Request a University Degree credential only from issuers in the EU Trust List, EBSI, or an OpenID Federation trust anchor. |
| [Claim Sets (Selective Disclosure)](/docs/dcql-2-4-2-claim-set-age-verification) | `claim_sets` | Verify age from a PID credential, preferring a boolean `over_21` claim and falling back to the full `birthdate`. |
| [Credential Sets (Alternatives)](/docs/dcql-2-4-3-credential-set-proof-of-identity-alternatives/) | `credential_sets` | Accept any one of a Passport, PID, or Photo ID for proof of identity. |
| [Combined Credential Sets](/docs/dcql-2-4-4-kyc-request-photo-id-address-proof/) | Multiple required `credential_sets` | Require a Photo ID plus a Proof of Address (Utility Bill or Bank Statement). |
| [Mandatory and Optional Sets](/docs/dcql-2-4-5-student-transport-pass/) | Mandatory + optional `credential_sets` | Require PID and student proof, with optional address proof for an additional discount. |
| [Multiple Credential Instances](/docs/dcql-2-4-6-loan-application-multiple-bank-statements/) | `multiple: true` | Request six recent Bank Statement credentials in a single verification flow. |
| [Values Constraint](/docs/dcql-2-4-7-delivery-service-restricted-postal-codes/) | `values` | Accept a PID credential only if the postal code matches an allowed list. |

## Related

- [OpenID4VP credential verification](/concepts/openid4vp-credential-verification/) shows where a DCQL query fits in the full verifier flow.
- [OpenID4VCI credential issuance](/concepts/openid4vci-credential-issuance/) covers how the credentials that DCQL queries are first issued.


---

# Trust List Certificate Generator
Source: https://docs.igrant.io/docs/devtools-certificate-generator/

---
id: certificate-generator
title: Trust List Certificate Generator
description: Generate a test X.509 certificate from a CSR and your organisation details - a root CA for issuers and wallet providers, or an access certificate for relying parties - ready to register in the trust list.
keywords:
  - certificate generator
  - CSR to certificate
  - relying party certificate
  - root CA
  - trust anchor
  - access certificate
  - WRPAC
  - X.509 certificate generator
  - trust list onboarding
  - EUDI Wallet
  - European Business Wallet
hide_title: true
hide_table_of_contents: true
sidebar_label: Certificate Generator
slug: /devtools-certificate-generator/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import CertificateGenerator from '@site/src/components/CertificateGenerator';
import NoteBox from '@site/src/components/NoteBox';

<NoteBox title="Note:" variant="caution">
The certificate produced here is a <strong>self-signed test certificate</strong>, signed by a throwaway key generated in your browser, because a CSR carries only the public key. It is not issued by a Certificate Authority. Use it to preview the trust-list entry, then replace it with one from your own PKI or a trusted authority before submitting to the registry.
</NoteBox>

<CertificateGenerator />

The Certificate Generator turns a certificate signing request (CSR) and your organisation details into the X.509 certificate your actor type submits to the trust list, and prepares a trust-list entry you can send in with your registration.

The certificate profile follows the service type you pick:

| Service type | Certificate generated | Profile |
|---|---|---|
| Wallet Provider | Trust anchor (root CA) | `CA=true`, key usage `keyCertSign`, `cRLSign`. Wallet unit attestation signing certificates chain to it. |
| PID / EBWOID / QEAA / EAA Issuer | Trust anchor (root CA) | `CA=true`, key usage `keyCertSign`, `cRLSign`. Credential signing certificates chain to it, or credentials are signed directly with this key. |
| Relying Party | Access certificate (WRPAC) | End-entity certificate per ETSI TS 119 411-8: key usage `digitalSignature`, extended key usage `clientAuth`, contact email and support URI in the subject alternative name, NCP-l-eudiwrp certificate policy. |

Provide the organisation details, choose the service type, and upload, drag and drop, or paste a CSR. The tool reads the public key from the CSR and builds a certificate that carries that key together with your organisation as the subject. It then prepares an `onboarding/<participant-id>.json` entry that matches the trust-list onboarding schema, with the certificate embedded.

Everything runs in your browser. Nothing you enter or upload leaves the page.


---

# Online Digital Certificate Viewer
Source: https://docs.igrant.io/docs/devtools-certificate-viewer/

---
id: certificate-viewer
title: Online Digital Certificate Viewer
description: Parse, analyze and validate X.509 certificates in PEM format. View details, check validity, and verify signatures.
keywords:
  - certificate viewer
  - X.509 certificate parser
  - PEM certificate analyzer
  - SSL certificate viewer
  - certificate decoder
  - digital certificate tool
  - certificate validation
  - public key infrastructure
  - PKI tools
hide_title: true
hide_table_of_contents: true
sidebar_label: Certificate Viewer
slug: /devtools-certificate-viewer/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import CertificateViewer from '@site/src/components/CertificateViewer';

<CertificateViewer />


---

# JSON Schema Validator
Source: https://docs.igrant.io/docs/devtools-json-schema-validator/

---
id: json-schema-validator
title: JSON Schema Validator
description: JSON Schema Validator for developers
hide_title: true
hide_table_of_contents: true
sidebar_label: JSON Schema Validator
keywords: [JSON Schema Validator, schema validation, credential schema, EUDI Wallet, developer tools, JSON validation, verifiable credentials]
slug: /devtools-json-schema-validator/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import JsonSchemaValidator from '@site/src/components/JsonSchemaValidator';

<JsonSchemaValidator />

---

# Decode JWT and SD-JWT VC tokens
Source: https://docs.igrant.io/docs/devtools-jwt-decoder/

---
id: jwt-decoder
title: Decode JWT and SD-JWT VC tokens
description: Free online JWT and SD-JWT VC decoder. Inspect headers, payloads, disclosures and key-binding JWTs, then verify the signature with an issuer key auto-derived from header.jwk, x5c, did:key or did:jwk.
hide_title: true
hide_table_of_contents: true
sidebar_label: JWT Decoder
keywords:
  - JWT decoder
  - SD-JWT decoder
  - SD-JWT VC
  - JSON Web Token
  - selective disclosure
  - JWT signature verification
  - did:key
  - did:jwk
  - x5c
  - EUDI Wallet
  - ETSI TS 119 472-1
  - ETSI EAA Plugtests
  - credential validation
  - developer tools
slug: /devtools-jwt-decoder/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import JwtDecoderSeo from '@site/src/components/JwtDecoderSeo';
import JwtDecoder from '@site/src/components/JwtDecoder';

<JwtDecoderSeo />

<JwtDecoder />


---

# Decode mdoc CBOR (ISO/IEC 18013-5 IssuerSigned)
Source: https://docs.igrant.io/docs/devtools-mdoc-decoder/

---
id: mdoc-decoder
title: Decode mdoc CBOR (ISO/IEC 18013-5 IssuerSigned)
description: Free online mdoc CBOR decoder. Inspect IssuerSigned structures, COSE_Sign1 issuer authentication, the Mobile Security Object, namespaces, and the issuer x5chain certificate.
hide_title: true
hide_table_of_contents: true
sidebar_label: mdoc CBOR Decoder
keywords:
  - mdoc decoder
  - CBOR decoder
  - ISO 18013-5
  - IssuerSigned
  - Mobile Security Object
  - MSO
  - COSE_Sign1
  - x5chain
  - eu.europa.ec.eudi.pid.1
  - EUDI Wallet
  - mDL
  - developer tools
slug: /devtools-mdoc-decoder/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import MdocDecoderSeo from '@site/src/components/MdocDecoder/MdocDecoderSeo';
import MdocDecoder from '@site/src/components/MdocDecoder';

<MdocDecoderSeo />

<MdocDecoder />


---

# EUDI & Business Wallet Developer Debug Tools
Source: https://docs.igrant.io/docs/devtools-overview/

---
id: devtools-overview
title: EUDI & Business Wallet Developer Debug Tools
description: Debugging tools for issuers, holders, and verifiers working with EU Digital Identity (EUDI) Wallets and the European Business Wallet under eIDAS 2.0.
hide_title: false
hide_table_of_contents: true
sidebar_label: Overview
keywords: [developer tools, EUDI Wallet, European Business Wallet, debugging, QR code, JWT decoder, mdoc CBOR, JSON schema, eIDAS 2.0, verifiable credentials, testing]
slug: /devtools-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import DevtoolsCards from '@site/src/components/DevtoolsCards';

iGrant.io provides tools to support developers working with EU Digital Identity (EUDI) Wallets and the European Business Wallet, enabling debugging and testing of interactions between issuers, holders, and verifiers. These tools simplify decoding and validating critical components such as QR codes, JWTs, mdoc CBOR, JSON schemas, and X.509 certificates. They are designed to enhance development efficiency and help ensure compliance with the latest eIDAS 2.0 standards.

<DevtoolsCards />


---

# Decode QR Codes with developer tools
Source: https://docs.igrant.io/docs/devtools-qrcode-decoder/

---
id: qrcode-decoder
title: Decode QR Codes with developer tools
description: See how to decode QR codes to extract credential data securely, supporting verification workflows in digital identity implementations.
hide_title: true
hide_table_of_contents: true
sidebar_label: QR Code Decoder
keywords: [QR code decoder, credential data, OpenID4VCI, OpenID4VP, EUDI Wallet, developer tools, digital identity, debugging]
slug: /devtools-qrcode-decoder/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import QRCodeDecoder from '@site/src/components/QRCodeDecoder';

<QRCodeDecoder />


---

# Generate QR Codes with developer tools
Source: https://docs.igrant.io/docs/devtools-qrcode-generator/

---
id: qrcode-generator
title: Generate QR Codes with developer tools
description: Learn how to create and use QR codes for credential sharing and verification in digital identity workflows using the developer tools.
hide_title: true
hide_table_of_contents: true
sidebar_label: QR Code Generator
keywords: [QR code generator, credential sharing, OpenID4VCI, OpenID4VP, EUDI Wallet, developer tools, digital identity, verification]
slug: /devtools-qrcode-generator/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import QRGenerator from '@site/src/components/QRGenerator';

<QRGenerator />


---

# Admin login
Source: https://docs.igrant.io/docs/drv-bund-api/admin-login

---
id: admin-login
title: "Admin login"
description: "Authenticates an administrative user by validating the provided username and password. Upon successful authentication, a pair of JSON Web Tokens (JWT) - access and refresh - are issued, along with basic user details. These tokens are required for accessing protected endpoints within the system."
sidebar_label: "Admin login"
hide_title: true
hide_table_of_contents: true
api: eJztVs1uGzcQfpXBXJoAK8l2k6LYU5zYLWw0dmAr9UHxYbQc7TLhkhuSK0UQdOuT9NH6JMVwVz+OlcYFeqwuXpPz+83wm1lhpDJgPsHTNlZsoy4oamfxPkPFofC6Sf/m+/ccgCyQqrXVIXqKes7QBvYwXcKcjFYUtS0hVgyNd3OtWKV7SzUDWQUNhbBwXg3hfeMshLYoOIRZa4AehJEBQUPag5vB5e31FdzxFMbuE9sAzy7vxs9hAJR0k1nPM8+hkkPPoENoWWVAxtkSFjpWMKWgiy5UxZG0CUMYVxwYYmdU9Dx/brVnBTPne+uSTeNd5CKyAraqcdrGkIxqmxINyxC5HmKGos8hvnZqifkKC2cj2yif1DSmz2z0MQisKwxFxTXJV1w2jDm66UcuImbYeNewj5qD3G7w25MM0Wtb4teVGlcMXJM2QEp5wcbNUohiYojrDDfwH7I1c76miPlO6JB9MfVD2NUR1+sucQFO2mkb7p63+/W6EwuNs6FL6+ToSP489HDDsfVSjcel3dRpV9NUzca7mTYMiiJJDf4j0Huv38f88m78MESBuQv/acp9qltdyer78en9EmobuWSPGfIXqhvDmP/YW/pW42wF8aOrrHL8SnEbBZ2BZ0Fwzj7oomLf2nKoWCJLrXXImG2NoalYi77l3vM4CR3wbNs60c7Z24srzPD97fmNkM4uou5GYOy6+Ekup9rH6oziQZ/b1lYicEB7RrU2y6tvgPVIvNRztk+W1uF6zv745z3hqXOGye4XYkYm7KRPjv+N9E8vnybdVM7yVVtPH7TYtyLvfxm+OPRUL2zhvOciQuFZCXOTCVvWT2zz4uj4sd5bMlIOVuA8aFs4CTF25MshdoRSc6ycEi5yITU/xQpzHMmQGKX5MzKu1HaEGQb20qyYT1bYeoM5VjE2IR+NlJ8Ppq1VgzQQ/EC4wTtj2A+o0UNderJxqB2u78VM0Xodl7fCEN0jmzJ59jL/9tAS4+I1iQncSQiz/uOXTatd3o1TKsI8N7vBcL6pyT6x70qwI+jNmRTZzlyKQMf0QM5ufofXrVXwZpsQnL67gDNXtDXb2A3yDNMbTqCfHJ28HL4YHvcESUUiyP5BY2ibxvn4agdIhn1g+tfd0UNw99D7mta2SvDsrz/+fA46AMHtgpUOVSJq4C9FRbbsdoI5ez3riRqkmrrYrg9+CBdRmD5AYDMbBDdnz7q0oFPPxWXW60vj7reibBBKlzqSgQUZwzE5C85oBY1TELmorJM24pABW5oamfYElhdgeM5Gxqdwa2Jemmqj4zIZoTa6ult1Uv9qsgV3Qyml57lsTcongLZAMGuNWQK1SscUZ03WykjO0OiCbUj90EN+2lBRMZwMjx5hvlgshpSuh86Xo143jH67eHN+dXs+EB3pOXk1Ndl9o/JmIL2Zr6fQ3qLy/6735F2vZ4PIX+KoMaS72e3TfOzYaoKSJsoYqxPqG/Rl2lXCa/kEV6spBX7vzXotx59b9kvMJ/cZzsnrjown9+sMKyYlrD1Z4SdeYo5vuqIN0pwVcdNKQI+WnnW20TgtCm7iP8re71Hvu+vbsdBav83WTomOp4VsurTAHD/gB8QMXWqkbm2S8xUasmVLZVovkl35/Q1CDVsG
sidebar_class_name: "post api-method"
info_path: docs/drv-bund-api/drv-bund-controller-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Admin login</h1>

<MethodEndpoint method={"post"} path={"/auth/admin/login/"}></MethodEndpoint>



Authenticates an administrative user by validating the provided username and password. Upon successful authentication, a pair of JSON Web Tokens (JWT) - access and refresh - are issued, along with basic user details. These tokens are required for accessing protected endpoints within the system.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"username"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The email address of the user."}}></SchemaItem><SchemaItem collapsible={false} name={"password"} required={true} schemaName={"password"} qualifierMessage={undefined} schema={{"type":"string","format":"password","description":"The user's password."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Returns access and refresh tokens along with user profile data.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"refresh"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT refresh token"}}></SchemaItem><SchemaItem collapsible={false} name={"access"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT access token"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>user</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"johndoe@deutsche-rentenversicherung.de"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"userType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ADMIN`, `USER`]"} schema={{"type":"string","enum":["ADMIN","USER"],"example":"ADMIN"}}></SchemaItem><SchemaItem collapsible={false} name={"address"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"birthDate"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"familyName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"givenName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"isOver18"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"isOver21"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"isOver65"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"phoneNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"refresh\": \"string\",\n  \"access\": \"string\",\n  \"user\": {\n    \"id\": 3,\n    \"username\": \"johndoe@deutsche-rentenversicherung.de\",\n    \"email\": \"string\",\n    \"userType\": \"ADMIN\",\n    \"address\": \"string\",\n    \"birthDate\": \"2026-10-20\",\n    \"familyName\": \"string\",\n    \"givenName\": \"string\",\n    \"isOver18\": false,\n    \"isOver21\": false,\n    \"isOver65\": false,\n    \"phoneNumber\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Incorrect credentials provided.

</div><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Malformed or incomplete request.

</div><div></div></TabItem></ApiTabs></div></div>
      

---

# DRV Bund Controller API Documentation
Source: https://docs.igrant.io/docs/drv-bund-api/drv-bund-controller-api-documentation

---
id: drv-bund-controller-api-documentation
title: "DRV Bund Controller API Documentation"
description: "iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 2025.4.1</span>

<h1 className={"openapi__heading"}>DRV Bund Controller API Documentation</h1>



iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner.

<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"HTTP: Bearer Auth"} value={"bearerAuth"}><div><table><tbody><tr><th>Security Scheme Type:</th><td>http</td></tr><tr><th>HTTP Authorization Scheme:</th><td>bearer</td></tr><tr><th>Bearer format:</th><td>JWT</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>iGrant.io: <a href={"mailto:support@igrant.io"}>support@igrant.io</a></span><span>URL: <a href={"https://igrant.io"}>https://igrant.io</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3><a href={"https://www.apache.org/licenses/LICENSE-2.0"}>Apache 2.0</a></div>
      

---

# DRV Bund Controller API Documentation
Source: https://docs.igrant.io/docs/drv-bund-api/overview

---
id: drv-bund-overview
title: "DRV Bund Controller API Documentation"
description: "Overview of the DRV Bund Controller API powered by Organisation Wallet Suite APIs"
sidebar_label: "Overview"
sidebar_position: 1
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


# DRV Bund Controller API Documentation

## Introduction

The DRV Bund Controller API, developed by iGrant.io as part of EBSI VECTOR WP 5.2, enables administrators to upload bulk attestation data for citizens' Portable Document A1 (PDA1) and European Health Insurance Card (eEHIC) credentials.

## Portals

Two portals have been implemented:

1. **Administrative Portal** (https://drv-bund-issuer-controller-api.igrant.io/admin/)
   - Facilitates bulk attestation data uploads by administrators
   - Implements secure authentication protocols
   - Provides centralised data management for all citizens

2. **Citizen Portal** (http://drv-bund-issuer.igrant.io/)
   - Enables citizens to authenticate and request credentials
   - Facilitates issuance of:
     - Portable Document A1 (PDA1)
     - European Health Insurance Card (eEHIC)

## Core Functionality

### Authentication
- Robust administrative login system
- JWT-based access control implementation
- Token refresh functionality

### Bulk Data Management
- EHIC attestation data upload capability
- PDA1 attestation data upload functionality
- Comprehensive data validation and processing

## Implementation Guide

To obtain access to the DRV Bund Controller API:

1. Contact [iGrant.io Technical Support](mailto:support@igrant.io?subject=Request%20DRV%20Bund%20API%20Access)
2. Obtain administrative credentials
3. Commence attestation data uploads via the Administrative Portal

## Domains to Whitelist

When deploying behind a firewall, ensure the following domains are whitelisted:

- https://drv-bund-issuer-controller-api.igrant.io
- https://demo-api.igrant.io

## Technical Support

For technical assistance:

- **Electronic Mail**: [support@igrant.io](mailto:support@igrant.io)
- **WhatsApp Support**: [Contact Us](https://wa.me/message/3YFVQOBN5ZYFE1)


---

# Refresh access token
Source: https://docs.igrant.io/docs/drv-bund-api/refresh-access-token

---
id: refresh-access-token
title: "Refresh access token"
description: "Allows clients to obtain a new access token using a previously issued refresh token. This mechanism supports session continuation without requiring the user to re-authenticate."
sidebar_label: "Refresh access token"
hide_title: true
hide_table_of_contents: true
api: eJzVVcFu20YQ/ZXBnFqAomwjKVCe6jhuIKNNAttJCjg+jJYjceLlLrO7lKwKuvVL+mn9kmKWdCzbQVsUvdQXU8uZ4bz3Zt5uMdEyYnWFx31q2CUxlMQ7vC6w5miCdPlnhcfW+nUEY4VdipA8+HkicUDgeA1kDEc9vmEHfRS3BIIu8Ep8H+0GJMaeawi8CBybIa6Ey0YitGwachJbiH3X+ZAiRI5RvAPjXRLX55ZgLanxfYLAn3sJ+oXUMPSRg3YTeEL3ELjEAjWQY3rh6w1WW9Ri7JI+UtfZEen0U1R8W4ym4Zb0KW06xgr9/BObhAV2wXccknDUtyOEvcCYtBt8whisyMpjzFgg31LbWc3kzVkzf2XkjZzN3v06O3wtszhz58/Nyey72U33y/uTs+/LssTdbkAjgWsV666H691ueBU77+LQ39HBgf572Ms5pz64+BWxtKH/iJmh7N8T85rXcPbh8kEb/5KWAf+zr0G+bPgh9SARxA2a+AANReDbTiktMRc5fFrkZ4l5ln2AluzCh/bJEGdxWk6Nr7HCzsdMDKUGK5zqSE5z3HTMmmKBkcOKg67dFvtgscImpS5W02kdVpN57+pJ3pcwUWWCt5bDhDopZRnIpVI87q61jOmDpM2F6jNIMGcKHHSX92TQ4vrVHIbVGITF+PCjDy0lrPDsw2UGo7qf3+/O6Z0ue7P/zyUqUNzC524kZXVfnr+HF72r4eQLODh+O4OX3vQtuzQYUIFK0aDC0cHR8/JZeTiOKpk8qtySKHeja/xwT06BjjJSeXV/9JDoPSYfj+eXJPjmj99+/1bHhuBizbXEBmpKBHyrjrVkIFfDioMsxpUBVVYMQxf8SmoOJcySWpRaml1Mol9xYFk6kFqdKm2KMZ/mlsEEzsdkYwEEtSwlkYU1Wcspfyx6nd7O15DYNM5bvxSOBbCjuR1MVxfc8oot+AWIS5x3lOZiJW1yEeqTbylpuPFtZ4Wc4WyvA7zAy95mPLowQLDord0A9bWk3GdLznFQ57Bi2MU8GyPlxx2ZhuGoPHjC+Xq9Lim/Ln1YTsfcOP1pdnL6+uJ0ojk6f7pDLbm9oufjxj1yjAe67Rn8//GyGnc18W2adpbE6WBm/rajm1yh5mjoCP9uGwvU67pR56mucLudU+R3we52evy557DB6uq6wBWFPGf6a1dgw1RzyCZ0wxus8GTgb3KprWi47bWlJ1fCrrjLODaGu/SXsdd75vj2zcWl2s54Ibe+1pxAawVDa6zwI35ELNBnTYfrVs+3aMkte1pq/FBX//4E0QEPVw==
sidebar_class_name: "post api-method"
info_path: docs/drv-bund-api/drv-bund-controller-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Refresh access token</h1>

<MethodEndpoint method={"post"} path={"/auth/token/refresh/"}></MethodEndpoint>



Allows clients to obtain a new access token using a previously issued refresh token. This mechanism supports session continuation without requiring the user to re-authenticate.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"refresh"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A valid refresh token.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Returns a new access token.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"access"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"New JWT access token","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"access\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The refresh token is invalid or has expired.

</div><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Missing or malformed refresh token.

</div><div></div></TabItem></ApiTabs></div></div>
      

---

# Upload EHIC
Source: https://docs.igrant.io/docs/drv-bund-api/upload-ehic

---
id: upload-ehic
title: "Upload EHIC"
description: "Submits electronic European Health Insurance Card (eEHIC) data for credential issuance. Each request may include multiple data entries. The system validates and processes the entries and issues the corresponding verifiable credentials."
sidebar_label: "Upload EHIC"
hide_title: true
hide_table_of_contents: true
api: eJzlVs1u20YQfpXBnBKA+omQ9EAURW3HbVwUaRA77UHxYbQckZssd5n9kSwIuvVJ+mh9kmKWtCU5MpJ7LxI5+81wdvb7ZnaLFQfldRe1s1jidVq0OgZgwyp6Z7WCy+Rdx2ThDZOJDVzZkDxZxXBBvoJnfPnm6uI5VBQJls6D8lyxjZoM6BCSIMdwSaoBz18ShwgtbUBbZVLF0CYTdWe492cbveYwhpuGIWxC5BZWZHRFkQOQraDzTnEIHCA2fI/PK/Kxwayc9xw6Zytta1ix10tNC8MHuYUxFug69iQ7v6qwxNQZR5XsBguMVAcs5/ghG+EsRg4xY+E1RcLbAgOr5HXcYDnf4oLJsz9LscFyfru7LXDY7bmrNlhuUTkb2UZ5pK4zWuVgk09B6r7FoBpuSZ7ipmMs0S0+sYpYYCfl91FzkFVutMoJ7JHkPW2wQB25Dd8X4duofaWuU4/4psvqABKi17bGXYGN/bbn0p50rZ8yxxP23a7Ayi2+Xilw6XxLEUsUGuWc9MnA+gnz6TTUE2h10hyq78qMvwe2y5sNTsnpDCR8m9oF+5N12Q0OvSRCX/LZ9IX8HatfuA90QPUsyl4XXEFISrS3TMZs4Jl1MHD6uWT+cjr9OuA5VfeqF8yrU5grG9lbMhDYr9gDe+88SsItx8aJMjsXMmlI1IWT+7YyESpPlGepiuhR/EOWY/IGS2xi7EI5mVR+NVokW41yj/Ajyds7Y9iPqNNjXXuycawd7g5kfS2K7It1KO6HAktw+WqGYTmAsBgefrk/s9/+usm7EaW/3/eEyztqO8PHmp7v5XlSgKtDVvTKEu3sbfWjt3hEwqwPnE1nP4xeTEezKfZS2Dvo47ejYOp4TR2+CbuP4/Ijy9OMfcjvNmtt6XKNdZTa4Ov3f8J5shVcPBwZnL27gtdOpZZtT1MsUA6+p9NsOns1fjl+IRk7G6kvHLekhREhdZ3z8ef9kRdoKZ+f/nVvOqbPAT+KR+R9cIJn//79z3PQAQiu11zp0Awj7U41ZGvOM6ofRX3rz3zXimWkrXTFfgxXEZKMtsBmOQpuxZ51bUFnIsRN8cQoK4Cg0rWOZGBNxnDMHwvO6Ao6V0Fk1VhnXK05FMCWFkYGI4HlNRhesQG3BC1CzCNxoY2OmxyEUnQtRYEr13ZG58m/1nHYnuc6mbyfANoCQd8dKFU65jxbspa9TFujFduQGT+U/Kwj1TDMxtOvar5er8eUl8fO15PBN0x+v7q4fHt9ORIf4ZS0hpbsQdBhYg9z/Oi4Dqbw/+ymM/SsyHdx0hnSVqicK74d2uoc7/cg6pUmVODQWm8LbKQDl3PcbhcU+IM3u52YvyT2cv+5LXBFPn85X38KbJgqUfd8i595gyVe9JUf3UgmAjcpX14e34WkBT80/nd/XN9IRx3uUK2rxMfTGov8W+JH/Ij5JpcpKKBs36IhWyeqBd/HFbbQcQt/1LJztveXKrs5yPLH8wyAG/eZ7U9YDHuK8iqNa7f7DxfS4wo=
sidebar_class_name: "post api-method"
info_path: docs/drv-bund-api/drv-bund-controller-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Upload EHIC</h1>

<MethodEndpoint method={"post"} path={"/issuance/ehic/create"}></MethodEndpoint>



Submits electronic European Health Insurance Card (eEHIC) data for credential issuance. Each request may include multiple data entries. The system validates and processes the entries and issues the corresponding verifiable credentials.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ehicData</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ehic</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"v"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>hn</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"fn"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"gn"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"gnt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dob"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date"}}></SchemaItem><SchemaItem collapsible={false} name={"hi"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"ii"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"in"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"ci"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"ic"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"sd"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date"}}></SchemaItem><SchemaItem collapsible={false} name={"ed"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"socialSecurityNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

EHIC attestation data uploaded successfully (no content)

</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request

</div><div></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><div></div></TabItem></ApiTabs></div></div>
      

---

# Upload PDA1
Source: https://docs.igrant.io/docs/drv-bund-api/upload-pda-1

---
id: upload-pda-1
title: "Upload PDA1"
description: "Processes submission of ESSPASS Portable Document A1 data for credential issuance. The request must include detailed personal, legal, employment, and organisational information structured across multiple sections."
sidebar_label: "Upload PDA1"
hide_title: true
hide_table_of_contents: true
api: eJzdmM1u4zYQgF+F4KkFZDvxJmlrFEWdTVqkKFJjnd09uDmMxZHMLkVq+RPHNXzrk/TR+iTFULIt+SfJAtvD9mRZHA6Hw+HMp1lyU6IFL42+EXzAQ6kMiNHV8JQnXKBLrSxpkA/4yJoUnUPHXJgW0jlpNDMZux6PR8PxmI2M9TBVyK5MGgrUng1PmQAPLDOWpRYFai9BMelcAJ1il93NkFn8GNB5VgTnmdSpCgKZQA9SoWAlWmc0qIQpzOkHi1KZBalPGGjBjM1BSxd3QLp1ZmwR/zHnbUh9sCgYpNY4x4qgvCwVMocpibguT7iH3PHBhL+NW2dD79H5SsMVeOD3CXeYBiv9gg8mSz5FsGiHwc/4YHK/uk94vYVLIxZ8sOSp0R61p0coSyXTqKz3hyM3LrlLZ1gAPflFiXzAzfQPTD1PeGnpMLxER6OlgNNowFYSrIUFT7j0WLiXaXheansy41BJPDtFioaM81bqnCe88jwFUZCCr6LbaOcvsEGAx0tpyaVP6CUp0psZixoKdPvSq4TrOhbkWvkzzlvPXCV8HW030SFZfXK3oZiiPbhWqSDdM/yYn03Q3i5eG4EHdVnMZRUhe0PezA8NrKKPHw9OoRDG37I36KRAneJQCIvuBUHznJmlcf7ooPMW0d+aT9pFwr30il6tjdzaP/aw+OJMD5ai8/Aq1djQH4n2+kzjvek/v2PnwXqp8yu6GS+5OqjFp4gXSKE/prN4P5Pp7FfMpVPxVgwptR28go0tvDq0BRBCVld01NpMLTc1RiFo3lBz9rwnqrqAdowqu66exTD18kH6GBCfmAnokC6Dkxqduz12mHRjnUeL4ssK0YZnz583eW7shxHluXr+i1x5RBd8UX4iL33UTTVSe8zRkgtXydYztzvF6BO9kpqiBL0gLe/IwepoxD1lT+NUL/5/JyFenOEKkOpJyUpilXCpnZc+RPi9OsISRw7CZJlM8Sd4PLK3anw0MxqPSDiZayA6PZhB6+M0KWFZTZ9HOWS1mWDRlUbXV7R/chLZqk3xV8NTBg3GjYReYT8K5kJKkJ8FpRbsK21YDbNfk8lnhxReglgzfCVzui/zVkPwM2PlnxjB8PyQohvt0RLDO7QPaBlaa2wMhwL9zNDXCcUaBShQ6eS99YdEj0C3l1qkEKBLQPNdhPVgFR/wmfelG/R6wj50pkGLDs1E26HNWaMU2g6UsitzC9p3peGrBvSPidcrjzbRf3MKpJxWjWJUv6IQT+qHn9Zh98v7u7gb+g54s/1iuH6EolTYJv7JFt4P4jkBOH+Vwbfn2cVZ5/yb0286Z+cX/c70VZZ2+ul3F6+yiwvI4IK3KbzB2bx/0r/onJ50+ie8hdTbG7ND0pP1yP1zpLxV0QbkVi7ZCq3Jd/umSg2txPfYHH+Cbo+ssU1TTS3r7PTUygdB9LOvsmbGxrwdVGx5YwuIbQRsn2qT9tojLwG7/QUJ53ao7AXc1Yybfa5qh8EeTn1eR++AzyG0mbRq42c/56qAn1CC2cWHyVESaCyymb9T7f9Dm8WhyKqqLA8O7Y9YpbBuagq+V1Wb6aS9l1YN3X29KZ0NY7cVs/2tcbBKbkTuY6XPqipcg8XVm3fsMmjBXm8qABuObjatq3gReMKpjlSpqX/SP++edaktRlUDqjy8doMLZWms/3FbQTbblT9vX7WrUaPc7PbaNpPYV//89ffXTDoGbDxHId2sqtj4mM5A5xibYA9oNzk4lk+ZIiuteZACbZfdeBZi3w5V1nHmAS3KXDMZc7dfJPX82LzblhuXMGBC5tKDYnNQCn1czBklBSuNYB7TmTbK5BJdwlDDVEmdM2Aa50zhAyrqDxKjRqKEqVTSL6ISCN5Qm07njGJeSarjbC59vT2LeajSkWNSM2AVkUAQsmoyFqA1WurfKZmidrGA1i4flpDOkPW7J3s+n8/nXYjDXWPzXj3X9X69eX19O77u0JxVTbUF6IbSuj14qDXaaPn9f7ukFex4fPS9UoHUFLTRt8uaxyZ8bTIlG6KXhNdMdp/wGaHbYMKXyyk4fGvVakWvPwa01Fa9T/gD2BiCsaua8BmCoHs8WfIPuOAD/rryceeOLCFxFeK31m6LlVLrhhhHv43vCMXq1mxR5T8Lc6o3MOcD/jv/nVPWiWcZ82d8v+QKdB4gJ/lKL8UFtNlvh/WitetvQL1oWPn9ZRRgd+YD6h94Uu/J019KUavVvyBcM0I=
sidebar_class_name: "post api-method"
info_path: docs/drv-bund-api/drv-bund-controller-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Upload PDA1</h1>

<MethodEndpoint method={"post"} path={"/issuance/pda1/create"}></MethodEndpoint>



Processes submission of ESSPASS Portable Document A1 data for credential issuance. The request must include detailed personal, legal, employment, and organisational information structured across multiple sections.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pda1Data</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pda1</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>section1</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"dateBirth"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date"}}></SchemaItem><SchemaItem collapsible={false} name={"forenames"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"nationalities"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"personalIdentificationNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>placeBirth</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"countryCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"region"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"town"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"sex"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>stateOfResidenceAddress</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"countryCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"postCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"streetNo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"town"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>stateOfStayAddress</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"countryCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"postCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"streetNo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"town"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"surname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"surnameAtBirth"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>section2</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"startingDate"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date"}}></SchemaItem><SchemaItem collapsible={false} name={"endingDate"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date"}}></SchemaItem><SchemaItem collapsible={false} name={"memberStateWhichLegislationApplies"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>section3</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>section4</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"employerSelfEmployedActivityCodes"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"nameBusinessName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>registeredAddress</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"countryCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"postCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"streetNo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"town"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>section5</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>workPlaceAddresses</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>address</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"countryCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"postCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"streetNo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"town"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"seqno"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>workPlaceNames</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"companyNameVesselName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"seqno"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>section6</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>address</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"countryCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"postCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"streetNo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"town"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"date"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email"}}></SchemaItem><SchemaItem collapsible={false} name={"institutionID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"officeFaxNo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"officePhoneNo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"socialSecurityNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

PDA1 attestation data uploaded successfully (no content)

</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request

</div><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><div></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><div></div></TabItem></ApiTabs></div></div>
      

---

# EUDI Wallet Pilots and Production Deployments
Source: https://docs.igrant.io/docs/ecosystem-engagements/eudi-wallet-pilots-and-deployments

---
id: ee-eudi-wallet-pilots-and-deployments
title: EUDI Wallet Pilots and Production Deployments
description: Real-world EUDI Wallet pilots and production deployments delivered by iGrant.io, including the first live EUDI Wallet payments at Banca Transilvania and Fast Ferries, the WE BUILD European Business Wallet pilot, CRANE PCP cross-border health data, ITU/GovStack Consent Building Block and EBSI conformance.
sidebar_label: EUDI Wallet Pilots & Deployments
keywords: [EUDI Wallet pilots, EUDI Wallet deployments, EUDI Wallet payments, EU Large-Scale Pilot, EWC, WE BUILD, CRANE PCP, ITU GovStack, EBSI, European Health Data Space, EHDS, Banca Transilvania, Fast Ferries, Visa, Worldline, eIDAS 2.0, business wallet, iGrant.io]
slug: /ecosystem-engagements/eudi-wallet-pilots-and-deployments
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ChipBar from '@site/src/components/ChipBar';

iGrant.io has shipped its Organisation Wallet Suite into real EUDI Wallet pilots and production deployments across the EU. This page brings together the live deployments, EU Large-Scale Pilots and public sector programmes that have anchored our wallet, consent and trust infrastructure stack in the field.

## Production deployments

### First live EUDI Wallet payments in production

During the EWC Large-Scale Pilot, iGrant.io's Organisation Wallet Suite was integrated into banking and payment systems running in **production** at <strong>Banca Transilvania</strong> (Romania) and <strong>Fast Ferries</strong> (Greece), enabling Strong Customer Authentication (SCA) over <strong>Visa</strong> and <strong>Worldline</strong> payment rails together with <strong>UAegean</strong>. These were the first live production trials of EUDI Wallets with issuers and verifiers integrated to real payments, demonstrating that the EUDI Wallet ecosystem can clear the bar required by regulated financial flows. Read the full story in this [article](https://www.igrant.io/articles/business-wallets-enabling-trust-and-scale-in-the-european-digital-identity-eudi-wallet-ecosystem).

## EU Large-Scale Pilots

### European Wallet Consortium (EWC)

<ChipBar chips={["EU Large-Scale Pilot", "Completed 2025"]} />

The EWC project was co-funded by the European Union and coordinated by Sweden, involving 18 Member States, more than 15 public administrations, and more than 40 private entities. iGrant.io served as one of the EUDI Wallet software providers within the consortium and played a key role in the EUDI wallet ecosystem task, including responsibility for maintaining EWC RFCs, managing interoperability across wallets, and supporting the development of the EWC Interoperability Test Bed (ITB).

The Organisation Wallet Suite was conformant with all EWC use cases and was the most widely used wallet stack across the consortium. In addition to the production payment integrations described above, the suite powered a wide set of cross-border consumer scenarios:

#### Use case demos and trials

<table>
<tbody>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/XlzInUYijdI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>EU Business Owner ID (EBWOID/LPID) Issuance</strong><br/>Bolagsverket (Swedish Companies Registration Office) use case demonstrating Legal Person Identification Data issuance to Business Wallets using the iGrant.io Organisation Wallet Suite.</td>
</tr>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/gfb9cL2ulso" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>Linking EUDI Wallets to Bank Accounts</strong><br/>Enabling Strong Customer Authentication for payments by linking a user's bank account to the EUDI Wallet via a trusted business process.</td>
</tr>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/6GwCxyofSVE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>EUDI Wallet in Action: Prove ID, Apply Discounts, Pay</strong><br/>Real-world ferry payment flow where the user proves identity, applies discounts, pays and receives a boarding pass and e-receipt in seconds.</td>
</tr>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/xaYztdKB26g" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>EUDI Wallet for Hotel Check-in</strong><br/>Hotel registration scenario from the EWC LSP pilot, showing how guests can check in using verifiable credentials from their EUDI Wallet.</td>
</tr>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/uKQo34vOIEo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>EUDI Wallet at Buda Castle</strong><br/>Age-based discount scenario from EWC LSP Phase 02, demonstrating selective disclosure for ticketing at a real-world tourist attraction.</td>
</tr>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/cgIu4mbitaM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>Biometric Traveler Enrolment with EUDI Wallet</strong><br/>Easy flight check-in scenario from EWC Pilot Phase 02, combining biometric enrolment with EUDI Wallet credentials for streamlined travel.</td>
</tr>
</tbody>
</table>

### WE BUILD Consortium

<ChipBar chips={["EU Large-Scale Pilot", "Ongoing"]} />

[WE BUILD](https://www.webuildconsortium.eu/) is one of the official European Large-Scale Pilots for the EU Digital Identity Wallet and European Business Wallets, bringing together 180+ public authorities and private companies across 27 countries. iGrant.io is a named beneficiary contributing business wallet software, and the Organisation Wallet Suite is listed as the first conformant business wallet in the [WE BUILD Conformance Overview](https://webuild-consortium.github.io/wp4-interop-test-bed/docs/conformance-overview.html).

Our WE BUILD deliverables, starting with verifiable eReceipts, are documented on the dedicated <a href="/docs/ecosystem-engagements/we-build-consortium/">WE BUILD Consortium</a> page.

## Public sector & EU R&D programmes

### CRANE Pre-Commercial Procurement (PCP)

<ChipBar chips={["EU Pre-Commercial Procurement", "Completed March 2026"]} />

iGrant.io served as consortium lead for this three-year [pre-commercial procurement](https://crane-pcp.eu/) initiative, partnering with two other organisations to build cross-border health data infrastructure. The CRANE PCP project aimed to break down data silos in healthcare by creating a self-managed, cross-border health data space. The infrastructure was piloted in Spain, Norway, and Sweden.

iGrant.io contributed consent management systems, wallet SDKs, and the underlying infrastructure for a health data marketplace, enabling patients to manage and share their health data across borders using digital wallets aligned with the European Health Data Space (EHDS). Delivered use cases included remote patient monitoring and consent-based data exchange under the EHDS framework.

#### Use case demos and trials

<table>
<tbody>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/f6nevU4yhWs" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>European Health Data Space with EUDI & Business Wallets</strong><br/>CRANE dHDSI demonstration of the European Health Data Space, showing how patients can manage and share health data across borders using EUDI Wallets and Business Wallets.</td>
</tr>
</tbody>
</table>

### ITU/GovStack Consent Management Building Block

<ChipBar chips={["ITU contract", "Completed April 2024"]} />

iGrant.io, together with Redpill Linpro (Sweden), delivered the Consent Building Block (BB) under an ITU contract to provide a consent management solution in accordance with GovStack specifications.

The Consent BB empowers individuals to approve the use of their personal data through a comprehensive framework encompassing laws, norms, and principles; system architectures; and standards, covering all lawful bases for processing to ensure compliance with data protection regulations.

The resulting solution is recognised as a Digital Public Good (DPG), with its consent management microservice aligned with ISO 27560 and GovStack specifications, integrating seamlessly into both Web 2.0 and Web 3.0 digital identity wallet workflows. The software has been deployed in the GovStack Sandbox, and iGrant.io is named as a primary author of the Consent BB specification.

### European Blockchain Services Infrastructure (EBSI)

<ChipBar chips={["EC programme", "Completed 2024"]} />

iGrant.io was among the first wallet providers in Europe to achieve conformance with EBSI and the first to support both versions of the infrastructure, extending trust anchor support to encompass the European public sector blockchain.

The iGrant.io Data Wallet is listed as an EBSI-conformant wallet by the European Commission and was demonstrated live at the EBSI Experience Centre, the European Commission's first public Web3 lab in the heart of Brussels, showcasing real-world cross-border use cases, including social security credentials (ESSPASS/PDA1), student diplomas, and labour cards anchored to the EBSI trust infrastructure.

The wallet supports EBSI as a ledger-based trust registry alongside the EU Trust List and other European trust anchors, with iGrant.io demonstrating production-ready interoperability across EU public-sector ecosystems and direct recognition by the European Commission.

#### Use case demos and trials

<table>
<tbody>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/BpqmIWztj2o" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>Cross-border ODI Data Exchange in EBSI VECTOR</strong><br/>Demonstrating cross-border Organisation Digital Identity data exchange using OpenID4VCI and OpenID4VP within the EBSI VECTOR project.</td>
</tr>
<tr>
<td width="320"><iframe width="300" height="170" src="https://www.youtube.com/embed/-a7wwzd5anU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></td>
<td><strong>iGrant.io & Walt.id Enterprise Wallet Interoperability</strong><br/>Cross-wallet interoperability demonstration between iGrant.io and Walt.id enterprise wallets, anchored to the EBSI trust infrastructure.</td>
</tr>
</tbody>
</table>


---

# Interoperability & Compliance
Source: https://docs.igrant.io/docs/ecosystem-engagements/interoperability-and-compliance

---
id: ee-interoperability-and-compliance
title: Interoperability & Compliance
description: Interoperability achievements, compliance badges, ISO/IEC 27001:2022 certification, EWC RFC support, and standards contributions for the iGrant.io Organisation Wallet Suite.
sidebar_label: Interoperability & Compliance
keywords: [interoperability, compliance, OpenID4VCI, OpenID4VP, HAIP, OpenID Foundation conformance, ISO 27001, ISO/IEC 27001:2022, ISMS, France Identite, UNFOLD, EWC ITB, WE BUILD ITB, OpenID4VC, EWC RFC, eIDAS 2.0, iGrant.io, FIDES, ETSI Plugtests]
slug: /ecosystem-engagements/interoperability-and-compliance
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import EcosystemCard from '@site/src/components/EcosystemCard';

This page is the single landing point for iGrant.io's contributions to the European Digital Identity ecosystem: the consortia and standards bodies we contribute to, the plugtests and test beds we have cleared, and the public catalogues that list our deployments. For demos, trial videos and write-ups of each project, see [EUDI Wallet Pilots & Deployments](/docs/ecosystem-engagements/eudi-wallet-pilots-and-deployments).

## Security and certifications

<EcosystemCard
  logo="/img/ecosystem/iso-27001.svg"
  logoBg="#0B1220"
  name="ISO/IEC 27001:2022 Certified"
  href="https://www.iafcertsearch.org/certification/km2vH6e1i3j2Ai0WISr9krvR"
  badge="Certification"
>
Our Information Security Management System (ISMS) is certified to <strong>ISO/IEC 27001:2022</strong> by InterCert (Registration No. IC-IS-2607083), covering the design, development, delivery, support, and maintenance of our data exchange and digital identity solutions. This certificate can be independently verified via <a href="https://www.iafcertsearch.org/certification/km2vH6e1i3j2Ai0WISr9krvR" target="_blank" rel="noopener noreferrer">IAF CertSearch</a>.
</EcosystemCard>

<EcosystemCard
  logo="/img/ecosystem/openid-foundation.png"
  logoBg="#FFFFFF"
  name="OpenID Foundation"
  href="https://openid.net/wg/digital-credentials-protocols/"
  badge={["Certification ready (HAIP 1.0)", "Standards validation"]}
>
iGrant.io was one of the first implementations to clear the <strong>OpenID4VC conformance suite</strong> run by the OpenID Foundation, covering OpenID4VCI and OpenID4VP. The Organisation Wallet Suite passes the OpenID Foundation <strong>HAIP 1.0</strong> certification test plans for the issuer, verifier and holder roles, with published test results (see <a href="/docs/organisation-wallet-features/#openid-foundation-conformance-haip-10">OpenID Foundation conformance (HAIP 1.0)</a> on the Organisation Wallet Suite features page). We retest with each new release to keep the Organisation Wallet Suite aligned to the latest published profiles, and contribute validation feedback during specification drafting so issues are caught before standards are finalised.
</EcosystemCard>

## Ecosystem engagements and recognitions

<EcosystemCard
  logo="/img/ecosystem/gdc2026-business-value-finalist.png"
  logoBg="#FFFFFF"
  logoWidth="150px"
  logoPadding="8px"
  logoStretch
  name="GDC 2026 Business Value Award Finalist"
  href="https://igrant.io/articles/trusted-ereceipts-for-b2b-payments-taking-eudi-wallet-payments-from-the-consumer-to-the-company"
  badge="Award finalist"
>
iGrant.io's <a href="https://igrant.io/articles/trusted-ereceipts-for-b2b-payments-taking-eudi-wallet-payments-from-the-consumer-to-the-company" target="_blank" rel="noopener noreferrer">Trusted eReceipts for B2B Payments</a> use case was selected as a finalist for the <strong>Business Value Award</strong> at the Global Digital Trust Awards, GDC 2026, in Geneva. Developed within <strong>WE BUILD PA4</strong>, it pairs EUDI Wallet based payment authentication with signed eReceipts delivered to the European Business Wallet. An employee pays with <strong>Strong Customer Authentication (SCA)</strong> in the EUDI Wallet, the signed eReceipt lands in the company's European Business Wallet, and VAT is reconciled with the tax authority automatically. The business value is clear: stronger transaction records, reduced fraud, and reconciliation and record-keeping with no manual data entry. <a href="https://www.youtube.com/watch?v=m6opYC-0U7c" target="_blank" rel="noopener noreferrer">Watch the demo</a>.
</EcosystemCard>

<EcosystemCard
  logo="/img/ecosystem/fides-best-business-wallet-finalist.png"
  logoBg="#FFFFFF"
  logoWidth="150px"
  logoPadding="8px"
  logoStretch
  name="FIDES Community Awards 2026 Best Business Wallet Finalist"
  href="/docs/organisation-wallet-overview/"
  badge="Award finalist"
>
iGrant.io's <a href="/docs/organisation-wallet-overview/">Organisation Wallet Suite</a> was selected as a finalist for <strong>Best Business Wallet</strong> at the FIDES Community Awards 2026. The recognition highlights its support for trusted organisational identity, digital credentials, signing, payments, and KYC and KYB workflows across the emerging European Business Wallet ecosystem. <a href="https://www.youtube.com/watch?v=9XIPMjHxq_k" target="_blank" rel="noopener noreferrer">Watch the demo</a>.
</EcosystemCard>

<EcosystemCard
  logo="/img/ecosystem/unfold-bridge-builder-award.png"
  logoBg="#0B1220"
  name="UNFOLD #4 Bridge Builder Award"
  href="https://www.igrant.io/news/events/igrantio-joins-france-identite-eudiw-unfold-4-to-demonstrate-passwordless-login-with-eudi-wallet.html"
  badge="Award"
>
iGrant.io received the <a href="https://www.igrant.io/news/events/igrantio-joins-france-identite-eudiw-unfold-4-to-demonstrate-passwordless-login-with-eudi-wallet.html" target="_blank" rel="noopener noreferrer">Bridge Builder Award</a> for testing with the widest diversity of partners at the France Identité EUDIW UNFOLD #4 event in Paris. Where the earlier Remote Excellence Award recognised the highest success rate in remote flows, this award reflects how widely the Organisation Wallet Suite connects across issuers, verifiers, and wallets. Testing spanned <strong>30+ organisations</strong> across issuer, verifier, and wallet flows, with teams from across Europe building the EU Digital Identity Wallet ecosystem together.
</EcosystemCard>

<EcosystemCard
  logo="/img/ecosystem/etsi.png"
  logoBg="#FFFFFF"
  name="ETSI Signature Plugtests"
  href="https://signature-plugtests.etsi.org/homeview"
  badge="Plugtests contributor"
>
iGrant.io takes part in the ETSI Signature Plugtests, the official interoperability events run by the ETSI Centre for Testing and Interoperability for Electronic Attestation of Attributes. The Organisation Wallet Suite is exercised against <strong>ETSI TS 119 472-1</strong> "Profiles for Electronic Attestations of Attributes, Part 1: General requirements", the canonical EAA profile under eIDAS 2.0 covering issuance, presentation and verification of <strong>SD-JWT VC</strong>, <strong>ISO 18013-7 mdoc</strong> and <strong>W3C VC (JWT)</strong> over OpenID4VCI and OpenID4VP. Multi vendor cross testing at the Plugtests confirms conformance with the wallet, issuer and verifier profiles required by the EUDI Wallet ecosystem.
</EcosystemCard>

<EcosystemCard
  logo="/img/ecosystem/unfold-interop-award.png"
  logoBg="#0B1220"
  name="UNFOLD #3 Remote Excellence Award"
  href="https://www.igrant.io/news/press-releases/igrantio-wins-remote-excellence-award-at-eudiw-unfold-interoperability-week.html"
  badge="Award"
>
iGrant.io won the <a href="https://www.igrant.io/news/press-releases/igrantio-wins-remote-excellence-award-at-eudiw-unfold-interoperability-week.html" target="_blank" rel="noopener noreferrer">Interop Award for Remote Excellence</a> at the EUDIW UNFOLD Interoperability Week, recognising the highest success rate in remote issuance and verification flows within the EUDI Wallet ecosystem. The award highlights the strength of the Organisation Wallet Suite in delivering standards compliant, interoperable digital identity solutions.
</EcosystemCard>

<EcosystemCard
  logo="/img/ready-for-france-identite-badge.png"
  logoBg="#0B1220"
  name="Ready for France Identité"
  href="https://www.igrant.io/news/events/eudi-wallet-unfold-interop-week-testing-the-eudi-wallets-with-organisation-wallet-suite-by-igrantio.html"
  badge="Interoperability Tests - Passed"
>
iGrant.io is ready for France Identité, following rigorous testing with the Organisation Wallet Suite and validation of real world EUDI Wallet scenarios across issuance, presentation, and verification flows at <a href="https://www.igrant.io/news/events/eudi-wallet-unfold-interop-week-testing-the-eudi-wallets-with-organisation-wallet-suite-by-igrantio.html" target="_blank" rel="noopener noreferrer">UNFOLD #2.2 Interoperability Week, Paris</a>. The event brought together 60+ organisations from 20+ countries to collaboratively test interoperability across both remote and proximity use cases.
</EcosystemCard>

<EcosystemCard
  logo="/img/ecosystem/fides.png"
  logoBg="#1A2238"
  name="FIDES Ecosystem Explorer"
  href="https://fides.community/ecosystem-explorer/relying-party-catalog/?rp=igrant-open-bank-account-demo"
  badge="Live demo"
>
The iGrant.io <strong>Open Bank Account</strong> relying party is published in the FIDES Relying Party catalogue. It demonstrates privacy preserving KYC for financial onboarding using <strong>SD-JWT VC</strong> over <strong>OpenID4VP</strong>, conformant with the <strong>EWC v3</strong> interoperability profile and accepting <strong>PID</strong> credentials from the EUDI Wallet ecosystem. <a href="https://www.igrant.io/demo/open-bank-account.html" target="_blank" rel="noopener noreferrer">Try the live demo</a>.
</EcosystemCard>

<EcosystemCard
  logo="/img/ecosystem/webuild.svg"
  logoBg="#0B1220"
  name="WE BUILD Consortium"
  href="https://www.webuildconsortium.eu/use-cases"
  badge={["EUDI Wallet SW", "European Business Wallet SW"]}
>
iGrant.io is a Wallet Software Provider in the WE BUILD consortium for both <strong>EUDI Wallets</strong> and <strong>European Business Wallets</strong>, contributing to the Architecture, Interoperability Tests, and Conformance Spec Authoring workpackages. Use cases supported span <strong>European Business Owner ID issuance</strong>, all card and account based payment flows, <strong>document signing</strong>, and <strong>Qualified EAA issuance</strong>. The Organisation Wallet Suite is listed as the first conformant business wallet in the <a href="https://webuild-consortium.github.io/wp4-interop-test-bed/docs/conformance-overview.html" target="_blank" rel="noopener noreferrer">WE BUILD Conformance Overview</a>.
</EcosystemCard>

<EcosystemCard
  logo="/img/ecosystem/ewc.jpg"
  logoBg="#FFFFFF"
  name="EU Digital Identity Wallet Consortium (EWC)"
  href="https://github.com/EWC-consortium"
  badge={["Ecosystem lead", "First EUDI payments in production"]}
>
iGrant.io leads ecosystem development in the EWC consortium and introduced the concept of <a href="https://github.com/EWC-consortium/eudi-wallet-rfcs" target="_blank" rel="noopener noreferrer">EWC RFCs</a>, a scalable approach to bootstrapping a multi vendor EUDI Wallet ecosystem. The Organisation Wallet Suite was conformant with all EWC use cases, was validated through the EWC Interoperability Test Bed (ITB), and was the most widely used wallet stack across the consortium. During EWC, the suite was integrated into banking and payment systems in production at <strong>Banca Transilvania</strong> (Romania) and <strong>Fast Ferries</strong> (Greece), enabling <strong>Strong Customer Authentication (SCA)</strong> over Visa and Worldline payment rails. These were the first live production trials of EUDI Wallets with issuers and verifiers integrated to real payments. <a href="https://www.igrant.io/articles/business-wallets-enabling-trust-and-scale-in-the-european-digital-identity-eudi-wallet-ecosystem" target="_blank" rel="noopener noreferrer">Read the full story</a>.
</EcosystemCard>

## Implementing Acts compliance

The Organisation Wallet Suite is built to comply with the Implementing Acts under Regulation (EU) 2024/1183 (eIDAS 2.0). For details on individual Implementing Acts, see the [eIDAS and EU Regulations](/regulations/implementing-acts-overview/) section.

## Standards contributions

iGrant.io actively contributes to the standards that underpin the EUDI Wallet ecosystem:

- **OpenID Foundation**: implementation feedback on OpenID4VCI and OpenID4VP specifications
- **W3C**: contributions to Verifiable Credentials standards
- **ETSI**: alignment with trust service standards (ETSI TS 119 612) and Electronic Attestation of Attributes specifications (ETSI TS 119 472-1)
- **EWC RFCs**: co-authorship of consortium specifications
- **Open source**: [Decentralised Data Exchange](https://github.com/decentralised-dataexchange) project

## See also

- [EUDI Wallet Pilots & Deployments](/docs/ecosystem-engagements/eudi-wallet-pilots-and-deployments): detailed write-ups, demos and production trials from EWC, WE BUILD, CRANE PCP, ITU/GovStack and EBSI.
- [Organisation Wallet Suite Features](/docs/organisation-wallet-features/#openid-foundation-conformance-haip-10): the supported standards and the published OpenID Foundation HAIP 1.0 conformance test results.


---

# WE BUILD Consortium: EUDI Wallet and European Business Wallet Large Scale Pilot
Source: https://docs.igrant.io/docs/ecosystem-engagements/we-build-consortium

---
id: ee-we-build-consortium
title: "WE BUILD Consortium: EUDI Wallet and European Business Wallet Large Scale Pilot"
description: iGrant.io's work in the WE BUILD Large-Scale Pilot for the EU Digital Identity Wallet and European Business Wallets, starting with verifiable eReceipts and account-to-account payments, alongside business registry, document signing and Qualified EAA use cases.
sidebar_label: WE BUILD Consortium
keywords: [WE BUILD, WE BUILD Consortium, EU Large-Scale Pilot, EUDI Wallet, European Business Wallet, eReceipt, verifiable receipt, account-to-account payments, Bank Account Key, Bank iD, pay by bank, Strong Customer Authentication, SCA, GDC26, Global Digital Collaboration Conference, Digital Credentials API, Architecture Workpackage, Architecture Blueprint Team, conformance specifications, Interoperability Test Bed, ITB, University of the Aegean, LPID, EBWOID, QEAA, document signing, payments, eIDAS 2.0, iGrant.io, Organisation Wallet Suite]
slug: /ecosystem-engagements/we-build-consortium
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ChipBar from '@site/src/components/ChipBar';
import YouTubeEmbed from '@site/src/components/YouTubeEmbed';

<ChipBar chips={["EU Large-Scale Pilot", "Ongoing"]} />

[WE BUILD](https://www.webuildconsortium.eu/) is one of the official European Large-Scale Pilots for the EU Digital Identity Wallet and European Business Wallets, bringing together 180+ public authorities and private companies across 27 countries. iGrant.io is a named beneficiary contributing across several WE BUILD workpackages, from architecture and conformance through to wallet provisioning and business use case delivery. This page is the home for that work, and it sits alongside our wider <a href="/docs/ecosystem-engagements/eudi-wallet-pilots-and-deployments/">EUDI Wallet pilots and production deployments</a>.

## Deliverables

This is the home for iGrant.io's WE BUILD deliverables, and it grows as the pilot progresses. Further deliverables, including Business Registry workflows (Legal Person Identification Data issuance), document signing and Qualified EAA issuance, will be added as they land.

### Architecture workpackage

<ChipBar chips={["Workpackage", "Ongoing"]} />

The Architecture workpackage defines the common blueprint, conformance specifications and test tooling that every WE BUILD wallet and service is built and tested against. iGrant.io contributes here on three fronts:

- **Architecture Blueprint Team.** iGrant.io is part of the team shaping the WE BUILD reference architecture for the EU Digital Identity Wallet and European Business Wallets.
- **Conformance specifications.** iGrant.io contributed a significant part of the [conformance specifications](https://github.com/webuild-consortium/wp4-architecture/tree/main/conformance-specs) that define what a conformant wallet or service must do.
- **Interoperability Test Bed (ITB).** Together with several partner companies, led by the University of the Aegean, iGrant.io helped build the ITB that WE BUILD uses to test wallets and services against those specifications.

The Organisation Wallet Suite is listed as the first conformant business wallet in the [WE BUILD Conformance Overview](https://webuild-consortium.github.io/wp4-interop-test-bed/docs/conformance-overview.html).

### eReceipts (verifiable receipts)

<ChipBar chips={["Use case", "In progress"]} />

**eReceipts** are trusted, verifiable purchase receipts issued straight into a European Business Wallet, taking EUDI Wallet payments from the consumer to the company. Today a business purchase still ends in a paper or PDF receipt that someone keys into an accounting system by hand, and a lost receipt can put a VAT claim at risk. eReceipts replace that chain with two wallets that work together.

**How it works:**

1. An employee pays from a company account or card using their EUDI Wallet, authorised with Strong Customer Authentication (SCA).
2. The seller's business wallet issues the receipt as a verifiable credential directly into the buyer's European Business Wallet.
3. Buyer and seller hold the same signed record, so it books into accounting automatically.
4. A tax authority can verify the receipt and reconcile input VAT without manual data entry.

Because the receipt is a selectively disclosable credential, the holder shares only the fields a given service needs, for example proof of purchase for an expense report or a warranty claim. This takes forward the consumer e-receipt flow first demonstrated in the EWC Large-Scale Pilot, described under <a href="/docs/ecosystem-engagements/eudi-wallet-pilots-and-deployments/">EUDI Wallet Pilots and Deployments</a>, and extends it to business-to-business payments.

<YouTubeEmbed
  videoId="uYhA1WUhfTw"
  title="Trusted eReceipts for B2B Payments: Verifiable Receipts to a European Business Wallet"
  description="See how a business purchase ends not in a paper receipt but in a verifiable eReceipt delivered straight into a European Business Wallet. An employee pays from a company card using their EUDI Wallet with Strong Customer Authentication, the seller issues the receipt as a signed credential, and buyer and seller hold the same trusted record, ready to book into accounting and reconcile VAT automatically."
/>

Read the background in [Trusted eReceipts for B2B payments](https://igrant.io/articles/trusted-ereceipts-for-b2b-payments-taking-eudi-wallet-payments-from-the-consumer-to-the-company).

### Account onboarding and account-to-account payments

<ChipBar chips={["Use case", "In progress"]} />

<ChipBar chips={[
  { label: "Event", chips: ["GDC26 Geneva, September 2026"] },
  { label: "Use cases", chips: ["Payments"] },
  { label: "Building blocks", chips: ["Wallets", "Credentials", "Issuers", "Verifiers"] },
  { label: "Focus areas", chips: ["Standards"] },
  { label: "Goals", chips: ["Interoperability"] },
  { label: "Regions", chips: ["Europe"] },
  { label: "Format", chips: ["Demo"] },
]} />

**Pay by bank with the EUDI Wallet.** Open a bank account with the wallet, receive a payment credential from the bank and pay a shop straight from that account by confirming the amount in the wallet. No forms, no passwords and no card numbers. iGrant.io and [Bank iD](https://www.bankid.cz/) (Czechia) showed this flow at the [Global Digital Collaboration Conference (GDC26)](https://globaldigitalcollaboration.org/) in Geneva in September 2026. The two-minute video below is the demo as shown there.

**Account provisioning and account-to-account payment** (WE BUILD WP3 Consumer Banking, PA1, and Consumer Payments, PA2 scenario A2) takes the consumer payment flow from the EWC pilot one step further. In EWC, a bank linked an existing account to the EUDI Wallet with a card-based Payment Wallet Attestation. In WE BUILD, the bank opens the account with the wallet in the first place, provisions a **Bank Account Key** into it, and the customer pays account-to-account at a merchant by confirming the transaction in the wallet, with the merchant reaching the wallet through the **W3C Digital Credentials API (DC API)**. The merchant and the verification run on the iGrant.io Organisation Wallet Suite.

<YouTubeEmbed
  videoId="9XIPMjHxq_k"
  title="Account Onboarding and Account-to-Account Payments with the EUDI Wallet | WE BUILD, Bank iD, iGrant.io"
  description="A customer opens a bank account at Bank iD with the EUDI Wallet, receives a Bank Account Key credential in the wallet, and pays account-to-account at the WE BUILD Shop by confirming the transaction in the wallet through the W3C Digital Credentials API (Android, Chrome). Verified by the iGrant.io Organisation Wallet Suite. Shown at the Global Digital Collaboration Conference (GDC26) in Geneva."
  uploadDate="2026-09-03"
  duration="PT2M14S"
  thumbnailUrl="https://i.ytimg.com/vi/9XIPMjHxq_k/maxresdefault.jpg"
/>

**How it works:**

1. The customer opens a bank account with the EUDI Wallet: no forms and no passwords. The wallet presents the person identification data (PID), the bank performs identity matching and opens the account.
2. The bank issues a Bank Account Key into the wallet over OpenID4VCI: a payment credential bound to the account that carries the IBAN, BIC, currency and issuing authority. In the WE BUILD specifications this is the SCA-IBAN attestation.
3. At the merchant's checkout the customer chooses account-based payment. The shop calls the wallet through the DC API, the customer reviews the amount and confirms with the Bank Account Key, and the payment is authorised straight from the bank account.

**For developers.** The shop calls `navigator.credentials.get()` from the page and the browser and operating system hand an OpenID4VP 1.0 request to the EUDI Wallet: no redirect, no app link and no QR code on the same device. The request carries a DCQL query for the Bank Account Key and a `transaction_data` object in the ARF Technical Specification 12 (TS12) payment schema with the amount and the payee. The wallet returns an SD-JWT presentation with a Key Binding JWT over the nonce, the verifier and the transaction data hash. This is the dynamic linking that Strong Customer Authentication (SCA) under PSD2 requires: any change to the amount or the payee breaks the hash. The Organisation Wallet Suite checks the issuer signature, the trust list status and the hash, and the shop, or a payment initiation service provider on its behalf, sends the payment body and the presentation to the bank in one Signed Payment Request. This is the flow described in the <a href="/docs/openID4vc-dcapi-overview/">DC API overview</a>, the step-by-step guide <a href="/docs/openID4vc-send-verify-credentials-dcapi-android/">Verify credentials with the DC API on Android (Chrome)</a> and the <a href="/docs/dcql-overview/">DCQL overview</a>.

It works on **Android with Chrome 141 or later**. It does **not work on iOS yet**: Safari, and therefore every browser on iOS, implements only ISO/IEC 18013-7 Annex C over the DC API and does not offer OpenID4VP, so a Bank Account Key (an SD-JWT credential presented over OpenID4VP) cannot be requested through the DC API on iPhone or iPad; see <a href="/docs/openID4vc-send-verify-credentials-dcapi-ios/">DC API on iOS (Safari)</a>. On iOS the merchant's standard OpenID4VP flow (QR code or app link) remains the way to pay.

The same checkout also accepts the card-based flow from EWC, so a merchant integrates once and takes both instruments through one strong customer authentication (SCA) pattern. Combined with <a href="#ereceipts-verifiable-receipts">eReceipts</a>, this closes the loop from account opening to payment to a verifiable receipt in the buyer's wallet. The scenarios are piloted cross-border between Czechia and Greece.

Try it yourself on an Android phone with Chrome: open an account at the [Bank iD onboarding demo](https://rp-demo.lab.euwallet.cz/business/wallet) with your EUDI Wallet, then pay account-to-account at the [WE BUILD Shop](https://webuildshop-demo.igrant.io). The building blocks are documented under <a href="/docs/openID4vci-payment-wallet-attestation/">Payment Wallet Attestation</a>, <a href="/docs/openID4vci-payment-data-confirmation/">Payment Data Confirmation</a> and <a href="/docs/openID4vc-send-verify-credentials-dcapi-android/">verification with the DC API on Android</a>.

## Related

* <a href="/docs/ecosystem-engagements/eudi-wallet-pilots-and-deployments/">EUDI Wallet Pilots and Production Deployments</a>
* <a href="/docs/ecosystem-engagements/interoperability-and-compliance/">Interoperability and Compliance</a>
* [WE BUILD Consortium](https://www.webuildconsortium.eu/)
* [Global Digital Collaboration Conference (GDC26)](https://globaldigitalcollaboration.org/)
* [WE BUILD Conformance Overview](https://webuild-consortium.github.io/wp4-interop-test-bed/docs/conformance-overview.html)


---

# Consent Management Overview
Source: https://docs.igrant.io/docs/consent-management-overview/

---
id: consent-management-overview
title: Consent Management Overview
description: iGrant.io facilitates trusted data sharing and compliant data usage with consent management systems. Giving individuals control over their data.
hide_title: false
sidebar_label: Overview
keywords: [consent management, GDPR, data sharing, data agreement, privacy, consent record, GovStack, data protection, iGrant.io]
slug: /consent-management-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


<img src="/img/GovStack-collaboration-Logo-RGB-dunkelblau.png" alt="GovStack" width="200" />

iGrant.io offers organisations a consent management solution based on ISO 27560, seamlessly integrating with both Web 2.0 and Web 3.0 applications and optimised for use with digital wallets. Compliant with GDPR, CCPA, and other global data protection regulations, and adhering to MyData and FAIR data principles, iGrant.io equips organisations with the tools to ensure compliance and maintain a competitive edge.

In the digital era, effective data and consent management are crucial for ensuring regulatory compliance and safeguarding individual privacy. Many organisations face challenges in these areas due to regulatory and technical complexities. iGrant.io addresses these challenges with a robust Consent Management Microservice, designed to simplify the consent process through four distinct phases: Definition, Preparation, Capture, and Proof. This service not only captures end-user agreements and consent but also provides them with consent receipts for every data processing activity or transaction.

### Key Features

The key features of the iGrant.io consent management are summarised below:

- **Four-Phase Consent Process for easy onboarding and deployment**:

  - **Definition**: Establish clear terms and conditions for user consent (Data Agreement with lawful basis consent).
  - **Preparation**: Prepare the consent request in accordance with legal and ethical standards, aligned with ISO27560.
  - **Capture**: Efficiently obtain user consent in a compliant manner.
  - **Proof**: Provide irrefutable proof of consent (Consent Receipts or Data Agreement Receipts), ensuring both compliance and accountability.

- **Built on Three Pillars Inspired by Lessig’s Modalities of Regulation**:

  - **Data Laws**: Complies with major data protection laws such as GDPR, CCPA, and DPDPA, incorporating principles from MyData, FAIR Data Principles, and Govstack based on ISO27560 agreements.
  - **Ethics and Norms**: Adheres to ethical standards that respect user privacy and promote transparency.
  - **Standards and Architectures**: Utilises advanced standards and architectures to support both Web 2.0 and Web 3.0 workflows and use cases.
  
- **Extentions to OAuth**:
  - Data Agreements, enabling organisations to comply with advanced GDPR requirements (E.g. [GDPR Article 30](https://docs.igrant.io/regulations/reg-eu-gdpr/#article-30-records-of-processing-activities)).

This microservice is not just a tool; it is a forward-thinking solution that empowers organisations to innovate while complying with the latest regulations and upholding high standards of user privacy and digital rights management. Discover the future of consent management with the Consent Building Block microservice at iGrant.io. Empower your organisation, comply with regulations, and innovate responsibly. Because in the digital age, privacy matters more than ever.

For more information and to get started, visit the [Consent Github](https://github.com/decentralised-dataexchange/bb-consent-docs/wiki/).

### Deployment Option: On-Premise

<table style={{width: '100%', borderCollapse: 'collapse'}}>
  <thead style={{fontWeight: 'bold', backgroundColor: 'black', color: 'white'}}>
    <tr>
      <th style={{backgroundColor: 'black', color: 'white'}}>Feature</th>
      <th style={{backgroundColor: 'black', color: 'white'}}>Default</th>
      <th style={{backgroundColor: 'black', color: 'white'}}>Configurability</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td style={{backgroundColor: 'black', color: 'white', fontWeight: 'bold'}}>Identity Management</td>
      <td>Pre-Built IDAM (KeyCloak)</td>
      <td>OpenID Connect or SAML</td>
    </tr>
  </tbody>
</table>

### Deployment Option: PaaS

<table style={{width: '100%', borderCollapse: 'collapse'}}>
  <thead style={{fontWeight: 'bold', backgroundColor: 'black', color: 'white'}}>
    <tr>
      <th style={{backgroundColor: 'black', color: 'white'}}>Feature</th>
      <th style={{backgroundColor: 'black', color: 'white'}}>Default</th>
      <th style={{backgroundColor: 'black', color: 'white'}}>Configurability</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td style={{backgroundColor: 'black', color: 'white', fontWeight: 'bold'}}>Identity Management</td>
      <td>Pre-Built IDAM (KeyCloak)</td>
      <td>OpenID Connect or SAML</td>
    </tr>
  </tbody>
</table>

### Developer APIs

All available Developer APIs are as below:
* [Administrative APIs](/docs/category/consent-management-admin-api/data-agreement)
* [Individual APIs](/docs/category/consent-management-individual-api/organisation)

### Try out

* For developers, you can access the developer playground [available here](https://github.com/decentralised-dataexchange/bb-consent-playground). 

* You can also deploy it on-premise using helm charts [available here](https://artifacthub.io/packages/helm/consentbb/consentbb).

* Please feel free to write to support@igrant.io to gain access to our enterprise trial use.


---

# Consent Management APIs
Source: https://docs.igrant.io/docs/consent-management-apis/

---
id: consent-management-apis
title: Consent Management APIs
description: Get started with consent management APIs to create data agreements, manage consent records, and enable GDPR-compliant data sharing workflows.
keywords: [consent management, API, data agreement, GDPR, consent record, data policy, privacy, data sharing]
hide_title: false
sidebar_label: Quick Start with APIs
slug: /consent-management-apis/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import Step1 from '@site/src/components/ConsentManagementApis/Step1';
import Step2 from '@site/src/components/ConsentManagementApis/Step2';
import Step3 from '@site/src/components/ConsentManagementApis/Step3';
import Step4 from '@site/src/components/ConsentManagementApis/Step4';
import Step5 from '@site/src/components/ConsentManagementApis/Step5';
import Step6 from '@site/src/components/ConsentManagementApis/Step6';
import Step7CreateIndividual from '@site/src/components/ConsentManagementApis/Step7CreateIndividual';
import Step7ReadIndividual from '@site/src/components/ConsentManagementApis/Step7ReadIndividual';
import Step7UpdateIndividual from '@site/src/components/ConsentManagementApis/Step7UpdateIndividual';
import Step7ListIndividuals from '@site/src/components/ConsentManagementApis/Step7ListIndividuals';

The following steps outline how developers can integrate iGrant.io consent management (Privacy Dashboard) APIs into their existing applications.

## Step 01: Get the API Key (Admin)

To get the API key, please contact <support@igrant.io>.

<Step1 />

## Step 02: Create Data Agreement

Create a data agreement by executing the following cURL command. This data agreement schema is based on ISO27560. When the `active` field is set to `true`, the data agreement is published and made available to individuals through the privacy dashboard.

<NoteBox title="Note:" variant="note">
Copy the Data Agreement ID from the response for performing other operations.
</NoteBox>

<Step2 />

**API Reference:** [Create Data Agreement](/docs/consent-management-admin-api/config-create-agreement)

## Step 03: Read Data Agreement

Retrieve a specific data agreement using its ID:

<Step3 />

**API Reference:** [Read Data Agreement](/docs/consent-management-admin-api/config-read-agreement)

## Step 04: Update Data Agreement

Update an existing data agreement using the PUT method with a similar request body as the CREATE operation:

<Step4 />

**API Reference:** [Update Data Agreement](/docs/consent-management-admin-api/config-update-agreement)

## Step 05: Delete Data Agreement

Delete a data agreement using its ID:

<Step5 />

**API Reference:** [Delete Data Agreement](/docs/consent-management-admin-api/config-delete-agreement)

## Step 06: List Data Agreements

Retrieve all data agreements:

<Step6 />

**API Reference:** [List Data Agreements](/docs/consent-management-admin-api/config-list-agreement)

## Step 07: Onboard Individuals

To enable individuals to access the consent management system through the privacy dashboard, you need to onboard them first.

### Create Individual

Create an individual account to allow access to the privacy dashboard:

<NoteBox title="Note:" variant="note">
Both <code>name</code> and <code>email</code> are optional fields. This allows for anonymous onboarding of individuals, with details being updated subsequently if collected.
</NoteBox>

<Step7CreateIndividual />

**API Reference:** [Create Individual](/docs/consent-management-admin-api/config-create-individual)

### Read Individual

Retrieve a specific individual's information:

<Step7ReadIndividual />

**API Reference:** [Read Individual](/docs/consent-management-admin-api/config-read-individual)

### Update Individual

Update an existing individual's information:

<Step7UpdateIndividual />

**API Reference:** [Update Individual](/docs/consent-management-admin-api/config-update-individual)

### List Individuals

Retrieve all individuals:

<Step7ListIndividuals />

**API Reference:** [List Individuals](/docs/consent-management-admin-api/config-list-individuals)

## Step 08: Privacy Dashboard Deployment

### Web Privacy Dashboard

The privacy dashboard (Web) can be deployed through the iGrant.io dashboard. This provides individuals with a web-based interface to manage their consent preferences and view their data agreements.

### Mobile SDK Integration

For mobile applications, you can integrate the consent management SDK for both iOS and Android platforms. Follow the comprehensive instructions available in our SDK documentation:

**SDK Documentation:** [Consent Management SDKs](https://docs.igrant.io/docs/consent-management-sdks/)

The mobile SDKs provide native integration capabilities, allowing you to embed consent management functionality directly into your mobile applications whilst maintaining a consistent user experience.


---

# Consent Management SDKs
Source: https://docs.igrant.io/docs/consent-management-sdks/

---
id: consent-management-sdks
title: Consent Management SDKs
description: Integrate the iGrant.io consent management Privacy Dashboard SDKs for Android, iOS, and cloud into your application.
keywords: [consent management, SDK, Android SDK, iOS SDK, Privacy Dashboard, GDPR, data agreement, consent record]
hide_title: false
sidebar_label: Quick Start with SDKs
slug: /consent-management-sdks/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The following steps outline how developers can integrate iGrant.io consent management (Privacy Dashboard) Android/iOS/Cloud SDKs into your application.

## Step 01: Installation

Use the following code to add depedency:

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

**For Gradle:**

```groovy showLineNumbers title="settings.gradle"
dependencies {
  implementation 'com.github.L3-iGrant:privacy-dashboard-android:<latest release>'
}
```

**For Maven:**

```xml showLineNumbers title="pom.xml"
<dependency>
    <groupId>com.github.L3-iGrant</groupId>
    <artifactId>privacy-dashboard-android</artifactId>
    <version><latest release></version>
</dependency>
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

Install SDK using SPM. To install, do the following:
- In Xcode, select **File → Add Packages...**
- Enter the URL: `https://github.com/L3-iGrant/privacy-dashboard-ios`

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="Cloud" label="Cloud">
```

Use the following command to pull the docker image to the local repository. You may skip this and run it directly from the docker hub (as in Step 02).

```bash
docker pull igrantio/bb-consent-privacy-dashboard:<tag>
```

Example: To pull version 2023.11.4 execute the following command in the terminal:

```bash
docker pull igrantio/bb-consent-privacy-dashboard:2023.11.4
```

```mdx-code-block
</TabItem>
</Tabs>
```

## Step 02: Initialise Privacy Dashboard

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

**For Gradle:**

We can initiate the privacy dashboard using the below code block:

```kotlin showLineNumbers title="MyActivity.kt"
PrivacyDashboard.showPrivacyDashboard()
    .withApiKey("API_key")
    .withUserId("User_ID")
    .withBaseUrl("Base_URL")
    .withOrganisationId("Org ID")
    .withViewMode(ViewMode.BottomSheet)
    .start(this)
```

We can also show the privacy dashboard with `accessToken`. For that use the below

```kotlin showLineNumbers title="MyActivity.kt"
.withAccessToken("accessToken")
```
> **_Note:_** If we have `accessToken` then no need to pass `API key` and `User ID`

To set the language we just need to add the following before the `start(this)`

```kotlin showLineNumbers title="MyActivity.kt"
.withLocale("language_code")
```

To enable user requests we just need to add the following before the `start(this)`

```kotlin showLineNumbers title="MyActivity.kt"
.enableUserRequest()
```

To enable Ask me we just need to add the following before the `start(this)`

```kotlin showLineNumbers title="MyActivity.kt"
.enableAskMe()
```

To listen for consent changes, add the following code before calling `start(this)`. This will notify you whenever a consent status update occurs.

```kotlin showLineNumbers title="MyActivity.kt"
.withConsentChangeListener(object : ConsentChangeListener {  
	override fun onConsentChange(status: Boolean, dataAgreementId: String,consentRecordId: String) {  
		Log.d(TAG, "onConsentChange: $status, $dataAgreementId, $consentRecordId")  
	}  
})
```

To display only specific data agreements in the privacy dashboard, use the following code before `start(this)`.  
If you want to show all available data agreements, simply omit this step.

```kotlin showLineNumbers title="MyActivity.kt"
.withDataAgreementIDs(arrayListOf("<Data Agreement ID 1>", "<Data Agreement ID 2>", "<Data Agreement ID 3>"))
``````

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
import PrivacyDashboardiOS

PrivacyDashboard.showPrivacyDashboard(
  withApiKey: "apiKey",
  withUserId: "userID",
  withOrgId: "orgID",
  withBaseUrl: "baseURL",
  turnOnAskme: "bool",
  turnOnUserRequest: "bool",
  turnOnAttributeDetail: "bool",
  viewMode: .bottomSheet)
```

We can show the privacy dashboard with `accessToken` (optional parameter).

> **_Note:_** If we have `accessToken` then no need to pass `API key` and `User ID`

To set app language, pass language code to `withLocale`. 
Now supporting three languages ie: English, Swedish and Finnish (By default it'll be English) 

```swift showLineNumbers title="MyViewController.swift"
withLocale: "en",
```

To enable user requests, set the `turnOnUserRequest` to `true`

```swift showLineNumbers title="MyViewController.swift"
turnOnUserRequest : true
```

To enable Ask me, set the `turnOnAskme` to `true`

```swift showLineNumbers title="MyViewController.swift"
 turnOnAskme : true
```

To enable Attribute detail screen, set the `turnOnAttributeDetail` to `true`

```swift showLineNumbers title="MyViewController.swift"
 turnOnAttributeDetail : true
```

To listen for consent changes, pass `onConsentChange` as below

```swift showLineNumbers title="MyViewController.swift"
 onConsentChange: { success, dataAgreementID, consentRecordID in 
			debugPrint("Consent change here:\(success) - \(resultVal) \(consentRecordID)")  
		}
```

To display only specific data agreements in the privacy dashboard, pass `dataAgreementIDs` as below.
If you want to show all available data agreements, simply omit this parameter.

```swift showLineNumbers title="MyViewController.swift"
dataAgreementIDs: ["<Data Agreement ID 1>", "<Data Agreement ID 2>", "<Data Agreement ID 3>"]
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="Cloud" label="Cloud">
```

iGrant.io hosts a privacy dashboard for each organisation. For an on-premise installation, you can run the privacy dashboard image yourself. iGrant.io gives you the image name with your installation. Mount your `config.json` into the container:

```bash
docker run -v ./config.json:/usr/share/nginx/html/config/config.json -p 3030:80 <privacy dashboard image>
```

All four keys are necessary. A sample configuration file:

```json
{
  "baseUrl": "https://api.igrant.io/v2",
  "redirectUrl": "http://localhost:3030/login",
  "clientId": "<client id of the individual login>",
  "organizationId": "<your organisation id>"
}
```

`baseUrl` is the api of your installation. `redirectUrl` must be a registered login redirect URI of the client.

The privacy dashboard is accessible at [http://localhost:3030/#/login](http://localhost:3030/#/login).

```mdx-code-block
</TabItem>
</Tabs>
```

## Supported Privacy Dashboard Functions

### Data Sharing UI

To initiate the Data sharing UI.

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```
Register activity for result to get the response back from the Data sharing UI.


```kotlin showLineNumbers title="MyActivity.kt"
var resultLauncher =
    registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
        if (result.resultCode == Activity.RESULT_OK) {
            val data: Intent? = result.data
            if (data != null) {
                Log.d("Data Agreement Record", data.getStringExtra("data_agreement_record") ?: "")
            }
        }
    }
```

To initiate the Data sharing UI


```kotlin showLineNumbers title="MyActivity.kt"
val intent =
    DataSharingUI.showDataSharingUI()
        .withApiKey("API_key")
        .withUserId("user_id")
        .withDataAgreementId("data_agreement_id")
        .withThirdPartyApplication("third_party_application_name", "third_party_application_logo")
        .withBaseUrl("base_url")
        .withOrganizationId("Org ID")
        .get(this)

resultLauncher.launch(intent)
```

To set the secondary button's text. Use the following before the `start(this)`.

```kotlin showLineNumbers title="MyActivity.kt"
.secondaryButtonText(<Button text>)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
PrivacyDashboard.showDataSharingUI(
  apiKey: "api_key",
  userId: "user_id",
  baseUrlString: "base_url",
  dataAgreementId: "data_agreement_id",
  organisationName: "organisation_name",
  organisationLogoImageUrl: "organisation_logo",
  termsOfServiceText: "terms_of_service_text",
  termsOfServiceUrl: "terms_of_service_url",
  cancelButtonText: "cancel_button_text")
```


```mdx-code-block
</TabItem>
</Tabs>
```

### Opt-in to Data Agreement

This function is used to provide the 3PP developer to opt-in to a data agreement.

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
PrivacyDashboard.updateDataAgreementStatus(
    dataAgreementId = "data_agreement_id",
    baseUrl = "base_url",
    apiKey = "api_key",
    userId = "user_id",
    status = true
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
PrivacyDashboard.updateDataAgreementStatus(
  dataAgreementId: "data_agreement_id",
  status: "true")
```


```mdx-code-block
</TabItem>
</Tabs>
```

### Read Data Agreement

This function is used to fetch the data agreement using `dataAgreementId`

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
PrivacyDashboard.getDataAgreement(
    dataAgreementId = "data_agreement_id",
    baseUrl = "base_url",
    apiKey = "api_key",
    userId = "user_id"
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
PrivacyDashboard.readDataAgreementApi(dataAgreementId: <>) {
  success, resultVal in
  // Result val will be a callback
  // response in dictionary format
}
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Show Data Agreement Policy

This function is used to show the data agreement policy.

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
PrivacyDashboard.showDataAgreementPolicy()
    .withDataAgreement("data_agreement_response")
    .withViewMode(ViewMode.BottomSheet)
    .withLocale("en")
    .start(this)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
PrivacyDashboard.showDataAgreementPolicy(dataAgreementRecord: "data_agreement_response",
                                         viewMode: .bottomSheet)
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Create an Individual

This function is used to create an individual.

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
PrivacyDashboard.createAnIndividual(
    baseUrl = "base_url",
    apiKey = "api_key",
    name = "optional",
    email = "optional",
    phone = "optional",
    pushNotificationToken = "FCM_token",
    deviceType = "android"
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
PrivacyDashboard.createAnIndividual(
  name: "optional",
  email: "optional",
  phone: "optional",
  pushNotificationToken: "FCM_token",
  deviceType: "ios"
) { success, resultVal in
  // Result val will be a callback
  // response in dictionary format
}

```

```mdx-code-block
</TabItem>
</Tabs>
```

### Read an Individual

This function is used to fetch an individual.

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
PrivacyDashboard.fetchTheIndividual(
    baseUrl = "base_url",
    apiKey = "api_key",
    individualId = "individual_id"
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
PrivacyDashboard.readAnIndividual(
  individualId = "individual_id"
) { success, resultVal in
  // Result val will be a callback
  // response in dictionary format
}
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Update an Individual

This function is used to update an individual.

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
PrivacyDashboard.updateTheIndividual(
    baseUrl = "base_url",
    apiKey = "api_key",
    name = "name",
    email = "email",
    phone = "phone",
    individualId = "individual_id",
    pushNotificationToken = "FCM_token",
    deviceType = "android"
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
PrivacyDashboard.updateAnIndividual(
  individualId = "individual_id",
  name: "optional",
  email: "optional",
  phone: "optional",
  pushNotificationToken: "FCM_token",
  deviceType: "ios"
) { success, resultVal in
  // Result val will be a callback
  // response in dictionary format
}
```

```mdx-code-block
</TabItem>
</Tabs>
```

### List Individuals

This function is used to list all individuals.

```mdx-code-block
<Tabs>
<TabItem value="gradle" label="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
PrivacyDashboard.getAllIndividuals(
    baseUrl = "base_url",
    apiKey = "api_key",
    offset = "offset(int)",
    limit = "limit(int)"
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS" label="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
PrivacyDashboard.fetchAllIndividuals(
  individualId = "individual_id"
) { success, resultVal in
  // Result val will be a callback
  // response in dictionary format
}
```

```mdx-code-block
</TabItem>
</Tabs>
```


---

# Consent Management Admin User Guide
Source: https://docs.igrant.io/docs/consent-management-admin-guide/

---
id: consent-management-admin-guide
title: Consent Management Admin User Guide
description: "Learn how to configure and manage user consent, data agreements, and permissions using the Consent Management system for secure data sharing."
hide_title: false
sidebar_label: Admin User Guide
keywords: [consent management, admin guide, data agreement, data policy, consent record, GDPR, configuration, iGrant.io]
slug: /consent-management-admin-guide/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Admin guide for Consent Management | iGrant.io DevDocs</title>
  <meta name="description" content="Learn how to configure and manage user consent, data agreements, and permissions using the Consent Management system for secure data sharing." />
</head>

import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';
import NoteBox from '@site/src/components/NoteBox';

This is the Consent Management admin user guide.

# 1.0	Introduction

This guide is for administrators of organisations configuring and using consent management. It provides instructions through a sandbox use case example, Unconditional Social Cash Transfer (USCT). The guide assumes that the consent Building Block (BB) is installed, and the admin user is configured in your environment or that you are consuming this service via iGrant.io.

## 1.1  Sandbox use case example

The USCT is a governmental programme that helps families meet their essential well-being and safety needs and serves as their path to self-sufficiency. The net result of the cash payments is provided to financially disadvantaged or vulnerable people or households without requiring anything in return (i.e. without conditionality). Today, the GovStack sandbox USCT use case reflects only a fraction of Consent Management functionality, demonstrating how various civil servants operating on behalf of the government department or agency interact and affect the transfer of cash payments to beneficiaries.

In the current use case, a fictional **enrolment officer receives user consent** to use essential personal information from the Candidate database to enrol anyone on any available benefits package. As there is no direct role for the user, consent is given via an out-of-band process via the personal data dashboard. Additional BB components have been included for demonstration purposes:  

![](images/cm-sandbox-usecase.png)
_Figure 1: USCT use case with Consent BB_

## 1.2  Consent Management: Key actors and use cases

Three actors in the Consent Management system have distinct roles, contributing to specific use cases that implement the desired functionality [1]. These actors, illustrated in Figure 02, form the fundamental dynamics of the ecosystem:


1. An **Administrator** representing an organisation (data controller or PII controller) processing personal data relies on the Consent Management to facilitate compliance with consent-related regulations and ethical practices. They seek agreement (consent being one of the lawful bases) from individuals for processing their data, outlining the envisaged data processing activities. The Administrator also ensures that data usage aligns with the provisions stated in the granted consent and adjusts operations in response to any alterations in individual preferences.

![](images/cm-actors-n-uscases.png)
_Figure 02: Key actors and use cases_

2. **Individuals** (or data subject or PII principle) are the primary proprietors of their personal data and have the authority to grant or withhold consent for its use if the lawful basis of the process is of the type of consent, contract or legitimate interest[^1]. Their engagement entails initiating and responding to consent requests, scrutinising data processing intentions and ultimately bestowing or retracting consent. Through this active involvement, individuals exercise control over their personal information and affirm their preferences.

<NoteBox title="Info:">
When an organisation uses legitimate interest as lawful basis, it does not need to seek the individual's consent for processing data, however the individual has the right to opt out.
</NoteBox>

3. A data processing **Auditor** (or regulatory body) oversees and assures adherence to contracted and regulatory requisites within the system. By maintaining a vigilant stance, the Auditor upholds the integrity of the consent ecosystem, fostering trust between individuals and data processors.

These three actors collectively establish a harmonious and responsible consent system in which transparency, individual autonomy, and regulatory compliance converge to shape data processing parameters. 

## 1.3	Consent workflow

The consent workflow, as per the specification of the input, takes a structured data agreement lifecycle comprising four phases [1]: 1) **Definition**, 2) **Preparation**, 3) **Capture**, and 4) **Proof **(also referred to as CRUD below), as illustrated below.

![alt_text](images/cm-da-workflow.png)
_Figure 03: Consent or data agreement workflow_

In the **definition phase**, the organisation (a data provider or data consumer) defines an agreement with a data policy that applies to the industry or sector-specific data usage as a template. While this phase is considered a "black box" to the Consent Management, it is an input leading to configuration and compatibility checks in all the following phases. This phase could follow a data protection impact assessment (DPIA) or similar based on applicable data regulations. In the **preparation phase**, the organisation that processes personal data (a data provider or a data consumer) configures the data agreement and relevant rules for its use. In the case of obtaining user consent, the lawful basis of processing is marked "Consent" or "Legitimate Interest". For example, an organisation could also share personal data for third-party data. The preparation phase is carried out via the admin dashboard, described in section 2.1.

During the **capture phase**, an individual can review the data agreement, which, once agreed upon, is captured in a consent record by the organisation and stored for verification. This is described in section 2.2. 

In the **proof phase**, the organisation (or an external auditor) can verify that it holds a valid record for performing data processing. This allows internal usage, and an auditor can verify and ensure that records are in place to process an individual's personal data. For example, in the USCT use case, the proof is used to check if the consent record exists, as described in section 2.3.


# 2.0	Consent Management user guide


## 2.1	Admin user

The organisation's admin user can orchestrate personal data processing via the admin dashboard. With the help of the dashboard, the admin user can perform all CRUD (create, read, update and delete) operations on Data agreements. The portal also audits user consent, revision handling, and compliance management.

You can try out using the [iGrant.io demo environment](https://demo-consent-bb-admin-dashboard.igrant.io/#/login). For login details, kindly contact us at [iGrant.io Developer Support](mailto:support@igrant.io?subject=Request%20Developer%20Access) to obtain your login credentials.

### 2.1.1	Login to admin dashboard

The admin user can login and view the organisation's data agreements. 

![alt_text](images/cm-login.png)
_Figure 04: Login to Admin Dashboard Screen_

### 2.1.2	Configure organisation

Here, the admin can provide details about the organisation, such as name, location, cover image, and logo. 

![alt_text](images/cm-getting-started.png)
_Figure 05: Get Started Screen_

The admin user can configure the global data policy, which is visible when creating data agreements. The global data policy configuration is set up for an organisation. 

![](images/cm_create-da.png)
_Figure 06: Global Data Policy Configurations_

### 2.1.3	Create data agreement

A data agreement is created based on an existing or new data policy template. Its status is Published or Saved. The consent agreement must be under version control to ensure an auditable trial.  

![](images/cm-global-policy.png)
_Figure 07: Create Data Agreement_

### 2.1.4	View data agreement

The admin user can view all DAs and their parameters, including the version number. Here, all previously published and newly created DAs are listed. The unpublished DAs are marked in red. 

![](images/cm-view-da.png)
_Figure 07: Read Data Agreement_

### 2.1.5	Update data agreement

The DA is updated with the newly provided values. When using View DA, a new revision of the DA is created. 

![alt_text](images/cm-update-da.png)
_Figure 08: Update Data Agreement_

### 2.1.6	Delete data agreement

This function allows the admin user to permanently delete a published or draft DA. A warning is provided before confirming a deletion. 


![](images/cm-delete-da.png)
_Figure 09: Delete Data Agreement_

## 2.2	Individuals

Individuals control the use of their personal data and have the authority to grant or revoke consent. This is exercised either actively in real time or via a privacy dashboard, which provides a transparent view of how their data is used and shared. 

### 2.2.1	View data agreement

Here, the individual can view every data agreement signed with a specific organisation. Each processing purpose, e.g. marketing and campaign, corresponds with a data agreement.

![](images/cm-individual-view-da.png)
_Figure 10: View Data Agreements_

### 2.2.2	Toggle consents

The View DA screen shown above can toggle ON and OFF for those DAs whose lawful basis of processing is legitimate interest and consent. In other words, this is where a user makes their preference for data sharing known. 

![alt_text](images/cm-individual-toggle-consent.png)
_Figure 10: Opt-in/out of data agreements_


### 2.2.3	View DA consent history

Here, the DAs' consent history can be seen. When an individual signs an agreement, this is automatically logged in the consent record. 


![alt_text](images/cm-individual-view-consenthistory.png)
_Figure 11: View Consent History_

## 2.3	Auditor

The Auditor oversees and assures adherence to legal and regulatory requirements within the system. The auditor can retrieve audit logs about a user's consent actions to check if specific actions have been performed. Each log includes the user's identity, timestamp, consent and the operations performed. 

When signed, consent records are tamper-proof and can be verified to check their integrity. By remaining vigilant, the Auditor preserves the integrity of the consent ecosystem, nurturing trust between individuals and data processors.   


### 2.3.1	View consent record

The following information can be viewed in the individual's consent record (for lawful basis consent or legitimate interest): Record ID, timestamps and other operations such as lawful basis and usage purpose, etc. There is a filter option to fetch the records based on purpose or lawful basis. Each log record clearly shows where the individual has selected opt-in or opt-out for a corresponding data agreement. 

![alt_text](images/cm-individual-view-consentrecords.png)
_Figure 12: View Consent Records_

### 2.3.2	Read consent record for an individual

This API reads consent records for an individual in the USCT scenario:

Execute the API [here](/docs/consent-management-individual-api/service-read-individual-record-read).

With the following input:

<table>
  <tr>
   <td colspan="2" ><strong>PATH PARAMETERS</strong>
   </td>
  </tr>
  <tr>
   <td>dataAgreementId
   </td>
   <td>The data agreement ID (E.g. Process UCST payments)
   </td>
  </tr>
  <tr>
   <td colspan="2" ><strong>REQUEST HEADERS</strong>
   </td>
  </tr>
  <tr>
   <td>X-ConsentBB-IndividualId
   </td>
   <td>The individual ID whose consent record is being fetched
   </td>
  </tr>
</table>


Sample GET request: 

```json
curl -X GET "https://api.bb-consent.dev/v2/service/individual/record/data-agreement/<dataAgreementID>" \
 -H "accept: application/json"\
-H "authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ2dVl0YTZERy1nMHhRRXdiR1JKSHFWSThOWTh4a2RyQWhYR08yOHFRNlNJIn0.eyJleHAiOjE2OTg1OTg1NzYsImlhdCI6MTY5ODU5NjgzNiwianRpIjoiMzdhYzAwMDYtNjM0ZS00MWM0LWE1NTYtMjk5OWJmYWVjMWU3IiwiaXNzIjoiaHR0cHM6Ly9zdGFnaW5nLWNvbnNlbnQtYmItaWFtLmlncmFudC5pby9yZWFsbXMvQkItQ29uc2VudC1Vc2VycyIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiJkZmYxZjQwNC1jZWIyLTQzNTItYmY5Ny05MmY3NzA3MWM2YTgiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJpZ3JhbnQtaW9zLWFwcCIsInNlc3Npb25fc3RhdGUiOiI2MjRmNmVjNC02N2Q1LTRhM2YtOTU5MS02YmUzODQzMjI5MTYiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIi8qIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLWJiLWNvbnNlbnQtdXNlcnMiLCJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIGVtYWlsIiwic2lkIjoiNjI0ZjZlYzQtNjdkNS00YTNmLTk1OTEtNmJlMzg0MzIyOTE2IiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJhZG1pbkBsYWxzcmV0YWlsLmNvbSIsImdpdmVuX25hbWUiOiIiLCJmYW1pbHlfbmFtZSI6IiIsImVtYWlsIjoiYWRtaW5AbGFsc3JldGFpbC5jb20ifQ.1GdY16YnDoVW7ra7NYvMSIl_Em99Mg72upta9O03EtJ4QG-avf9WrP6j3zHt01PXWuMYPERaUoFDsBgJYbCdnVpc79SqLt0Zy9UMJJr3wSllbtdo1-hCXBHUlU410yAF_WunBrglgyjqX4_cq6dA9q6XwoqyAJwMbCWboBP497TURhCqZl4gCDXLZkp6BRAwfi5Re5ZqFlmOxD6MikYzpBEMxOmDn85lsVuc9mpNI-GlHdNVxBlMTjLKrdUMhPx5gR9iSnWtSnQQPJOme4Ekw9A2Pqs1HgRi4mA8OOIamXxgV35OYfhYiVc23PxddpdFj1Zo8X2jUdFACHkZBPOjOQ"\
 -H "x-consentbb-individualid: <X-ConsentBB-IndividualId>"

```


The response received is as follows:

```json
{
"consentRecord": {
"id": "string",
"dataAgreementId": "string",
"dataAgreementRevisionId": "string",
"dataAgreementRevisionHash": "string",
"individualId": "string",
"optIn": false,
"state": "unsigned",
"signatureId": "string"}
}
```

From the API schema description:

![alt_text](images/api-schema.png)

# 3.0	Conclusions

This user guide is provided for GovStack Sandbox users. The current Sandbox use case (USCT) only uses a small number of the functions of the Consent Management. Hence, we recommend viewing our full demonstration [recorded for a Data4Diabetes application scenario](https://youtu.be/UAiFvciYM34) [2]. Please note, however, that this was recorded earlier and may have used an earlier version of the Consent Management UI, interfaces, APIs, etc.


# References

1. [Govstack Consent BB Software Design Specification](https://github.com/decentralised-dataexchange/bb-consent-docs/wiki/developer-documentation)

2. Data4Diabetes Application demo using Consent BB, Available at: [https://youtu.be/UAiFvciYM34](https://youtu.be/UAiFvciYM34) (Embedded below)

## Demo video

<VideoPlayer
  videoId="UAiFvciYM34"
  title="Data4Diabetes Application Demo"
  description="Learn how to implement Data4Diabetes application using Consent Management with iGrant.io."
  uploadDate="2024-01-01"
  duration="PT10M"
/>


---

# Data Intermediation Service Provider APIs
Source: https://docs.igrant.io/docs/data-intermediation-service-provider-apis/

---
id: data-intermediation-service-provider-apis
title: Data Intermediation Service Provider APIs
description: Integrate iGrant.io data intermediation APIs to enable secure, consent-based personal data exchange between organisations and individuals.
keywords: [Data Intermediation, DISP, API, data exchange, consent management, digital wallet, personal data, EU Data Governance Act]
hide_title: false
sidebar_label: Quick Start DISP APIs
slug: /data-intermediation-service-provider-apis/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>APIs for Data Intermediation Service Provider | iGrant.io DevDocs</title>
  <meta name="description" content="Explore APIs that enable secure data exchange and consent management through the Data Intermediation Service Provider for digital identity solutions." />
</head>
The following steps outline how developers can integrate iGrant.io data intermediation services to expose consumer personal data within their organisations. This guide is intended for those looking to incorporate:

- Digital wallets into their applications.
- Consent management into their applications using digital wallets.

## Step 1: Get the API Key

To obtain the API key, contact [support@igrant.io](mailto:support@igrant.io).

## Step 2: Define a Data Agreement

During this step, data agreements are defined for any processing of personal data. This processing may involve exposing data as a data source (Issuer of the data) or consuming data as a data-using service (Verifier of the data). This can be achieved through a Data Protection Impact Assessment (DPIA) or a similar process to ensure robust data usage in compliance with applicable data regulations, such as GDPR.

Copy the code block below and execute the [create data agreement API](/docs/consent-management-admin-api/config-create-agreement).

```json
{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controllerId": "string",
    "controllerUrl": "string",
    "controllerName": "string",
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": "",
      "thirdPartyDataSharing": true
    },
    "dataAttributes": [
      {
        "id": "",
        "name": "",
        "description": "",
        "sensitivity": "",
        "category": "",
        "restrictions": [
          {
            "credDefId": "H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default",
            "schemaId": "H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0"
          }
        ]
      }
    ],
    "purpose": "string",
    "purposeDescription": "string",
    "lawfulBasis": "",
    "methodOfUse": "",
    "dpiaDate": "",
    "dpiaSummaryUrl": "string",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    },
    "active": "",
    "forgettable": "",
    "compatibleWithVersionId": "string",
    "lifecycle": "draft",
    "dataExchange": {
      "dataExchangeProfile": "AIP10",
      "id": "string",
      "credentialDefinitionId": "string",
      "schemaId": "string",
      "isExistingSchema": true,
      "qrId": "string",
      "firebaseDynamicLink": "string",
      "presentationRequest": {
        "name": "string",
        "version": "string",
        "requestedAttributes": {
          "name": "string",
          "restrictions": [
            {
              "schemaId": "string",
              "credDefId": "string"
            }
          ]
        }
      }
    }
  }
}
```

## Step 3: Integrate Data Wallet SDK

This step integrates the iGrant.io digital wallet SDKs into existing Android and iOS applications, enhancing them with decentralised application (dApp) capabilities and digital wallet functionalities.

- **For Android**: Go to [Data Wallet (For Individuals) → Integrate Android SDKs](/docs/data-wallet-sdks/) and choose the Android tab option.
- **For iOS**: [Data Wallet (For Individuals) → Integrate iOS SDKs](/docs/data-wallet-sdks/) and choose the iOS tab option.

## Step 4: Integrate Consent Management (Privacy Dashboard) SDK

This step integrates the iGrant.io consent management (Privacy Dashboard) SDKs into existing Android and iOS applications, introducing privacy dashboard capabilities that enable individuals to exercise their rights under data regulations such as GDPR.

- **For Android**: Go to [Consent Management → Integrate Android SDKs](/docs/consent-management-sdks/) and choose the Android tab option.
- **For iOS**: Go to [Consent Management → Integrate iOS SDKs](/docs/consent-management-sdks/) and choose the iOS tab option.

## Step 5:  Implement DISP APIs

### Establish connection with Cloud/Mobile wallets

The process of establishing a connection between wallets involves several key steps to ensure secure and efficient communication between an organisation and an individual. Here is a step-by-step overview of how this process operates using the iGrant.io platform:

![Connection Establishment Workflow](eo-disp-establish-connection-flow.png)

1. **Create Connection Invitation QR**: Organisation A generates a QR code invitation. This code is designed to initiate a secure connection between the organisation Wallet and an individual's personal wallet.

2. **Scan the QR Code or Use NFC**: The individual scans the QR code or uses NFC (Near Field Communication) technology to respond to the connection invitation. This action triggers the process to establish a direct link between the two wallets.

3. **Notify Connection Status**: Once the connection is successfully established, Organisation A is notified of the connection status through a webhook event. This notification confirms that the individual’s wallet is now securely connected to the organisation Wallet, allowing for subsequent data transactions or interactions as defined by the organisation's protocols.

This workflow provides a secure and streamlined method for individuals to connect their digital wallets with organisations, facilitating trusted exchanges and interactions within the iGrant.io ecosystem.

Following APIs are available to intiate a connection as per DIDComm protocol:

- **Create connection invitation QR code**: This is used to send connection invitation from one wallet to another wallet using DIDComm protocol. For individual wallets, when the QR code is scanned, the connection invitation request is sent to the requesting wallet.

- **Receive connection invitation**: This is used to receive connection invitation from another wallet. E.g. a data wallet (individual) can scan a QR that contains this using DIDComm protocol.

### Issue/expose data to a connection (Data Source)

The process of issuing (or exposing) data to a connection allows organisations to securely manage credentials issuance workflow with data consents. This workflow is designed to be both secure and compliant with regulatory requirements. Here is a step-by-step overview:

![Issuance Workflow](eo-disp-issue-credential-flow.png)

1. **Create Data Agreement to Issue Credential**: Organisation A initiates the process by creating a data agreement. This agreement outlines the terms under which credentials are issued as per [ISO27560](https://www.iso.org/standard/80392.html), ensuring all actions comply with relevant data protection laws and organisational policies. This data agreement could be formulated based on a Data Protection Impact Assessment (DPIA) and follows the framework defined in this [IEEE paper](https://igrant.io/papers/iGrant.io_IEEE-Paper-DataExchangeAgreements-v3.1.pdf).

2. **Issue a Credential to a Connection**: Based on the data agreement, Organisation A issues a credential directly to an individual's wallet. This step is facilitated through a secure connection that ensures data integrity and privacy.

3. **Notify Issuance State Through Webhook Event**: Upon successful issuance of the credential, Organisation A is notified through a webhook event. This notification confirms the successful transmission and acceptance of the credential, allowing for real-time updates and further action if required.

This streamlined workflow enables organisations to efficiently manage the distribution of digital credentials, enhancing user trust and compliance with data governance standards.

As a Data Source (or Data Producer or Issuer), following APIs are available to issue a credential:

- Create data agreement with data exchange profile: This creates a credential definition for credential issuance.
- Issue credential: Used to issue credential to a connection based on the data agreement.

### Verify/consume data from a connection (Data Using Service)

The process of verifying (or consuming data) from a connection allows organiations to manage consume data workflow with digital wallet based verifications. Below is a detailed step-by-step overview:

![Verification Workflow](eo-disp-verify-credential-flow.png)

1. **Define Data Agreement to Verify Credential**: Organisation A sets up a data agreement that stipulates the criteria under which credentials will be verified. Here, the data agreement policy is based on [ISO27560](https://www.iso.org/standard/80392.html) standards and can use any of the lawful basis of processing including consent. This ensures that all actions to consume personal data comply with relevant data protection laws and organisational policies. This data agreement could be formulated based on a Data Protection Impact Assessment (DPIA) and follows the framework defined in this [IEEE paper](https://igrant.io/papers/iGrant.io_IEEE-Paper-DataExchangeAgreements-v3.1.pdf).

2. **Send a Verification Request to a Connection**: Subsequent to the agreement, Organisation A sends a verification request to an individual’s connection. This step involves securely querying the individual's wallet to verify the credentials it holds.

3. **Notify Verification State Through Webhook Event**: Upon completion of the verification process, Organisation A receives a notification via a webhook event. This alert signifies whether the verification was successful, enabling the organisation to proceed with data-related decisions based on verified credentials.

This streamlined verification workflow allows organisations to efficiently validate and consume data, enhancing the security and reliability of digital interactions within the iGrant.io ecosystem.

As a Data Using Service (or Data Consumer or Verifier), following APIs are available to verify credentials:

- Send verification request: This is used to send verification request to an existing connection.
- Create verification QR code: This is used to generate QR codes that can be used to request presentation from another wallet, e.g. an individual or cloud based wallet. For individual wallets, when the QR code is scanned, the presentation request is sent to the requesting wallet.



---

# Data Intermediation Service Provider Overview
Source: https://docs.igrant.io/docs/data-intermediation-service-provider-overview/

---
id: data-intermediation-service-provider-overview
title: Data Intermediation Service Provider Overview
description: Understand how the Data Intermediation Service Provider facilitates secure data exchange between individuals and organisations with auditable consent.
hide_title: false
sidebar_label: Overview
keywords: [Data Intermediation, DISP, data exchange, consent, EU Data Governance Act, personal data, auditable consent, data sharing, iGrant.io]
slug: /data-intermediation-service-provider-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Overview of the Data Intermediation Services | iGrant.io DevDocs</title>
  <meta name="description" content="Understand how the Data Intermediation Service Provider facilitates secure data exchange between individuals and organisations with auditable consent." />
</head>

In addition to offering standalone solutions such as the Data Wallet, Organisation Wallet Suite, and Consent Management in both on-premises and Platform-as-a-Service formats, iGrant.io provides a Data Intermediation Service Provider (DISP) as a service. This service enables consented data exchanges through the integration of digital wallets and consent management within automated workflows. Fully compliant with the [EU Data Governance Act](/regulations/reg-eu-data-governance-act/), it ensures regulatory adherence and empowers individuals in both exposing and consuming personal data. This overview underscores the capabilities of the DISP platform, which is ideally suited for applications that incorporate personal data into their functionalities.

A Data Intermediation Service Provider (DISP) facilitates the secure and efficient exchange of data among various parties (e.g., organisations - both data sources (issuers), data using services (verfiers) and individuals), as outlined in the EU Data Governance Act. DISPs provide platforms and technical means for Data Sources (Issuers or Data Producers), Data Using Services (Verifiers or Data Consumers), and Individuals to exchange data, ensure compliance with data protection regulations, and support data subjects in exercising their rights.

### Key Features

The key capabilities of iGrant.io DISP platform includes the following:

- **Based on Data Exchange Agreement Framework build over ISO27560**: Provides state of the art regulatory compliance and digital rights management including consents based on ISO27560. Read more on the framework in our [IEEE published paper](https://igrant.io/papers/iGrant.io_IEEE-Paper-DataExchangeAgreements-v3.1.pdf).

- **Support for multiple digital wallet Profiles**: Accommodates a diverse range of credentialing needs supporting eIDAS2.0 (OpenID).

- **Web Hooks** Enables real-time notifications and automatic updates within digital wallet workflows, enhancing efficiency and user experience by syncing transaction events instantly.

For developers looking to integrate these features, refer to the [Get Started with iGrant.io Data Intermediation Service Development](#) guide.

### Try out

To explore our Data Intermediation Service Provider, please contact support@igrant.io to gain access. Our team will assist you in setting up and navigating the features tailored for enterprise use.


---

# Data Wallet (UI) SDKs
Source: https://docs.igrant.io/docs/data-wallet-sdks/

---
id: data-wallet-sdks
title: Data Wallet (UI) SDKs
description: Integrate the Data Wallet UI SDKs for Android and iOS into your mobile application to enable secure credential storage and sharing.
keywords: [Data Wallet, UI SDK, Android SDK, iOS SDK, mobile wallet, verifiable credentials, EUDI Wallet, digital identity]
hide_title: false
sidebar_label: UI SDKs
slug: /data-wallet-sdks/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The following steps outline how developers can integrate Data Wallet (UI) SDKs for Android and iOS into their existing Android or iOS applications.

## Step 01: Installation

Use the following code to add depedency:

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```groovy showLineNumbers title="settings.gradle"
repositories {
    google()
    mavenCentral()
    jcenter()
    maven {
            name = "GitHubPackages"
            url 'https://maven.pkg.github.com/L3-iGrant/ama-android-sdk'
            credentials {
                username = "L3-iGrant"
                password = <Contact to get password>
            }
        }
    maven { url 'https://igrant.io/java-packages'}
    maven { url "https://jitpack.io" }
}
```

```groovy showLineNumbers title="settings.gradle"
dependencies {
    implementation 'com.github.L3-iGrant:data_wallet:2026.8.1'
}
```

Additional dependencies:

```groovy showLineNumbers title="settings.gradle"
dependencies {
    implementation 'com.github.L3-iGrant:wallet-store:2026.8.1'
    implementation platform('com.google.firebase:firebase-bom:28.0.1')
    implementation 'com.google.firebase:firebase-dynamic-links-ktx'
    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'com.google.android.material:material:1.3.0'
    implementation 'org.hyperledger:indy:1.16.0'
    implementation 'net.java.dev.jna:jna:5.6.0'
    implementation 'org.apache.commons:commons-lang3:3.7'
    implementation 'commons-io:commons-io:2.8.0'
    implementation('com.squareup.retrofit2:retrofit:2.7.1') {
        exclude module: 'okhttp'
    }
    implementation 'com.squareup.retrofit2:converter-gson:2.7.1'
    implementation 'com.squareup.okhttp3:okhttp:4.3.1'
    implementation 'com.squareup.okhttp3:logging-interceptor:4.3.1'
    implementation 'com.google.code.gson:gson:2.8.6'
    implementation 'com.github.bumptech.glide:glide:4.11.0'
    annotationProcessor 'com.github.bumptech.glide:compiler:4.11.0'
    implementation 'com.airbnb.android:lottie:3.5.0'
    implementation 'org.greenrobot:eventbus:3.1.1'
    annotationProcessor "org.greenrobot:eventbus-annotation-processor:3.1.1"
    implementation 'com.github.koushikcse:LoadingButton:1.7'
    implementation 'com.github.mediapark-pk:Base58-android:0.1'
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.2'
    implementation 'com.tbuonomo:dotsindicator:4.2'
    implementation 'com.nimbusds:nimbus-jose-jwt:9.21'
    implementation 'androidx.preference:preference-ktx:1.2.0'
    implementation("com.github.decentralised-dataexchange:presentation-exchange-sdk-android:2024.11.1")
    implementation("co.nstant.in:cbor:0.9")
    implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.3"
    implementation 'org.jetbrains.kotlin:kotlin-reflect'
    implementation 'com.madgag.spongycastle:prov:1.58.0.0'
    implementation ("com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.15.4")
    implementation ("com.fasterxml.jackson.module:jackson-module-kotlin:2.15.4")
    implementation("com.fasterxml.woodstox:woodstox-core:7.1.0")
    implementation ("javax.xml.stream:stax-api:1.0-2")
    implementation ("com.hbb20:ccp:2.5.1")
    implementation("com.jayway.jsonpath:json-path:2.9.0")
    implementation 'com.github.decentralised-dataexchange:PassCodeText:2024.10.1'
    implementation "androidx.lifecycle:lifecycle-process:2.6.2"
    implementation 'com.github.decentralised-dataexchange:eudi-wallet-oid4vc-android:2025.10.1'
    implementation 'com.squareup.retrofit2:converter-scalars:2.9.0'
    implementation 'com.github.amoskorir:avatarimagegenerator:1.5.0'
}
```
If you encounter SLF4J version conflicts or `Duplicate class org.slf4j` errors during the build,
add the following configuration block to your **root-level** `build.gradle` file:

```gradle
configurations.all {
    exclude group: 'org.slf4j', module: 'slf4j-api'

    resolutionStrategy {
        force 'org.slf4j:slf4j-api:2.0.9'
    }
}
```
```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

The SDK is in a private repository. Contact [support@igrant.io](mailto:support@igrant.io) for read access to `L3-iGrant/data-wallet-sdk-ios`, then sign that GitHub account in under **Xcode > Settings > Accounts** using a personal access token with the `repo` scope.

Install SDK using SPM. To install, do the following:

- In Xcode, select **File > Add Package Dependencies...**
- Enter the URL: `https://github.com/L3-iGrant/data-wallet-sdk-ios`
- Use the latest version shown in the dialog
- Add the `ama-ios-sdk` product to your app target

Requires iOS 15 or later, and a physical device as the SDK uses App Attest.

Add the following keys to the app's Info.plist:

- `NSCameraUsageDescription` for QR scanning.
- `NSFaceIDUsageDescription` for biometric confirmation. Without it, iOS terminates the app at the first biometric prompt.

</TabItem>
</Tabs>

## Step 02: Initialise Data Wallet

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.initializeSdk(
    this,
    object : InitializeWalletCallback {
        override fun progressUpdate(progress: Int) {
            when (progress) {
                InitializeWalletState.INITIALIZE_WALLET_STARTED -> {}
                InitializeWalletState.INITIALIZE_WALLET_EXTERNAL_FILES_LOADED -> {}
                InitializeWalletState.WALLET_OPENED -> {
                    // Wallet is ready. Register a notification listener here if needed —
                    // see "Subscribe To Notifications" below.
                }
            }
        }
    },
    viewMode = ViewMode.BottomSheet
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

Import the SDK into your code using the following import statement.

```swift showLineNumbers title="MyViewController.swift"
import ama_ios_sdk

final class WalletHost: AriesMobileAgentDelegate {
    func notificationReceived(message: String) {
        // Called by the SDK when a notification arrives
    }
}

let delegate = WalletHost()

@MainActor
func configureWallet() {
    AriesMobileAgent.shared.configureWallet(
        delegate: delegate,
        isAriesEnabled: false,
        viewMode: .BottomSheet   // or .FullScreen
    ) { success in
        DispatchQueue.main.async {
            if success == true {
                // Wallet configuration successful
            } else {
                // Wallet configuration failed
            }
        }
    }
}
```

This function initialises and configures the Data Wallet. It takes a completion block as a parameter, which is called when the wallet configuration is completed. The success parameter indicates whether the wallet configuration was successful.

`ViewMode` defines how the wallet UI should appear, either as a bottom sheet or full screen. The cases are capitalised, `.BottomSheet` and `.FullScreen`.
</TabItem>
</Tabs>

## Supported Wallet Functions

### Show Wallet UI

This function presents the data wallet's home view. The wallet home provides a user interface for managing wallet contents, accessing shared data, and performing wallet-related operations.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.showWallet(this)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.showDataWalletHomeViewController(showBackButton: true)
```
</TabItem>
</Tabs>

### Show Connections UI

This function presents the connections view of the data wallet. This view displays the list of established connections, allowing users to manage their connections, view connection details, and perform connection-related actions.


```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.showConnections(this)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.showDataWalletConnectionsViewController()
```
</TabItem>
</Tabs>

### Show Notifications UI

This function presents the data wallet's notifications views. This view provides a user interface for managing wallet notifications, such as receiving and viewing notifications related to data sharing or wallet updates.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.showNotifications(this)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.showDataWalletNofificationViewController()
```

Note the spelling `Nofification` in the shipped SDK. A corrected alias is planned.

</TabItem>
</Tabs>

### Show MySharedData UI

This function presents the share data history view of the data wallet. The share data history view displays a log of all the shared data, allowing the user to view the details of each shared item and manage data-sharing permissions.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.showMySharedData(this)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.showDataWalletShareDataHistoryViewController()
```

</TabItem>
</Tabs>

### Show DataAgreementPolicy UI

This function enables your application, integrated with the wallet, to retrieve data agreements associated with a specific organisation. By passing the required parameters such as `api_key`, `organization_id`, and `agreement_id`, along with a context (`this`), the function securely fetches the details of the specified agreement. This capability is essential for managing data consents and agreements programmatically, ensuring that your application adheres to specified data use policies and user consents.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataAgreementUtils.fetchDataAgreement(
    "api_key",
    "organization_id",
    "agreement_id",
    this
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.showDataAgreementScreen(
    dataAgreementID: "agreement_id",
    apiKey: "api_key",
    orgId: "organization_id"
)
```

</TabItem>
</Tabs>

### Delete Data Wallet

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.deleteWallet(this) { result ->
    when (result) {
        is DeleteWalletResult.Success -> {
            // Show success message or perform any other action
            DataWallet.releaseSdk()
        }
        is DeleteWalletResult.Error -> {
            // Show error message
        }
    }
}
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.deleteWallet(completion: { success in
     if success ?? false {
         // Wallet deleted successfully
     }
 })
```

</TabItem>
</Tabs>

### Process Deeplink

This function is used when scanning a QR code or generating a clickable link that opens the Data Wallet app, facilitating connections, as well as the issuance and verification of credentials. To integrate this functionality, add the specified intent filter to the activity where the SDK is initialised.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

To register your app to open didcomm:// deeplinks, add the following:

```xml showLineNumbers title="AndroidManifest.xml"
<intent-filter>
 <action android:name="android.intent.action.VIEW" />
 <category android:name="android.intent.category.DEFAULT" />
 <category android:name="android.intent.category.BROWSABLE" />
 <data android:scheme="didcomm" />
</intent-filter>
```

Then, add the code below to Wallet SDK and initialise the callback -> InitializeWalletState.WALLET_OPENED.

```kotlin showLineNumbers title="MyActivity.kt"
if (intent.scheme == "didcomm"){
  DataWallet.processDeepLink(this, intent.data.toString())
}
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

Register your URL scheme under `CFBundleURLTypes`, then forward the incoming URL to `saveConnection(withPopup:url:)`.

```swift showLineNumbers title="AppDelegate.swift"
func application(
    _ app: UIApplication,
    open url: URL,
    options: [UIApplication.OpenURLOptionsKey: Any] = [:]
) -> Bool {
    Task {
        let (success, _, message, _) =
            await AriesMobileAgent.shared.saveConnection(
                withPopup: true,
                url: url.absoluteString
            )

        if !success {
            print("Could not handle invitation: \(message ?? "unknown error")")
        }
    }
    return true
}
```

</TabItem>
</Tabs>

### Change Language

This function allows you to change the language used by the SDK. Provide the language code (e.g., "en" for English) to switch the SDK's localization to the desired language.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.changeLanguage(context, languageCode) 
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
// Change the SDK language to English
AriesMobileAgent.shared.changeSDKLanguage(languageCode: "en") 
```

</TabItem>
</Tabs>

### Handle Notification

This function handles push notifications sent from the dashboard. It processes incoming issuance and verification requests as they arrive.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.handlePushNotification(message =  Map<String, Any>)
```

The callbacks for this function are received through the `registerForSubscription` method.

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="AppDelegate.swift"
func userNotificationCenter(
    _ center: UNUserNotificationCenter,
    didReceive response: UNNotificationResponse,
    withCompletionHandler completionHandler: @escaping () -> Void
) {
    let userInfo = response.notification.request.content.userInfo

    AriesMobileAgent.shared.handlePushNotification(
        data: userInfo,
        otpHandler: { type, continueFlow in
            DispatchQueue.main.async {
                switch type {
                case .PinEntryDuringIssuance:
                    // Prompt the user for a PIN, then continue
                    continueFlow()

                case .Verification:
                    // Proceed with the verification flow
                    continueFlow()
                }
            }
        }
    )

    completionHandler()
}
```

</TabItem>
</Tabs>

### Subscribe To Notifications

This function enables your application, integrated with the wallet, to register for subscriptions using specific arguments such as `api_key` and `organization_id`. It sets up a listener to process incoming notifications by type, such as `SHARE_REQUEST`, `OFFER_REQUEST`, `REQUEST_WITH_PIN_ENTRY` or `VERIFY_REQUEST`. Upon notification receipt, it executes tailored logic and navigates to relevant screens based on the provided intent. This functionality is crucial for enabling dynamic, automatic responses to user interactions or system events. 

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.setNotificationListener(
    object : NotificationListener {
        override fun receivedNotification(
            notificationType: String,
            intent: Intent
        ) {
            when (notificationType) {
                MessageTypes.SHARE_REQUEST -> {
                    // your logic
                    // intent will contain the screen to redirect
                    // startActivity(intent)
                }
                MessageTypes.OFFER_REQUEST -> {
                    // Do your logic
                    // intent will contain the screen to redirect
                    // startActivity(intent)
                }
                MessageTypes.REQUEST_WITH_PIN_ENTRY -> {
                   // startActivity(intent)
                }
                MessageTypes.VERIFY_REQUEST -> {
                   // startActivity(intent)
                }
            }
        }
        override fun walletReadyToUse() {
            //Get notified when wallet is ready to use
        }
        override fun pushNotificationResponse(status: Boolean) {
            // response to the handle push notification 
        }

    }
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

Notifications are delivered through the delegate passed to `configureWallet`.

```swift showLineNumbers title="MyViewController.swift"
final class WalletHost: AriesMobileAgentDelegate {
    func notificationReceived(message: String) {
        // Called by the SDK when a notification arrives
    }
}
```

</TabItem>
</Tabs>

### Wallet Unit Attestation

This function turns on Wallet Unit Attestation and points the SDK at the attestation service.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.showWallet(
    this,
    enableWUA = true,
    baseUrl = "https://your-attestation-service.example",
    cloudProjectNumber = 1234567890L
)
```

`baseUrl` and `cloudProjectNumber` are both required when `enableWUA` is true. If either is missing, the wallet is not shown.

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.enableWUA(baseURL: "https://your-attestation-service.example")
```

On iOS, call this before `configureWallet`. Both the flag and a non empty URL are required, so passing `nil` leaves the feature off.

</TabItem>
</Tabs>

### Self Attested Credential
The SDKs provide applications with the ability to save, update, retrieve, and delete self-attested credentials securely. 
#### Add
Allows the Applications can store self-attested credentials. When `connectionID` is not supplied, the connection name and location are required.
```mdx-code-block
<Tabs>
<TabItem value="Android">
```
```kotlin showLineNumbers title="MyActivity.kt"
val id = SelfAttestedOpenIDCredential().add(
    title = "Title",
    description = "Description",
    attributes = mapOf(
        "attribute1" to "value1",
        "attribute2" to "Value2"
    ),
    connectionName = "Connection name shown on the credential",
    location = "Location shown on the credential",
    vct = "credential_type",
    logo = "https://example.org/logo.png"
)
```
```mdx-code-block
</TabItem>
```
```mdx-code-block
<TabItem value="iOS">
```
```swift showLineNumbers title="MyViewController.swift"
let attributes = [["attribute1": "value1"], ["attribute2": "value2"]]

let credentialId = try await SelfAttestedOpenIDCredential.shared.add(
    title: "Title",
    description: "Description",
    attributes: attributes,
    connectionID: nil,           // optional
    connectionName: "Connection name shown on the credential",
    connectionLocation: "Location shown on the credential",
    issuedDate: Date(),          // optional
    vct: "credential_type",
    logo: "https://example.org/logo.png"
)
```

</TabItem>
</Tabs>

#### Update
Allows the Applications can update self-attested credentials.
```mdx-code-block
<Tabs>
<TabItem value="Android">
```
```kotlin showLineNumbers title="MyActivity.kt"
SelfAttestedOpenIDCredential().update(
    id = id,
    title = "Title",
    description = "Description",
    attributes = mapOf(
        "attribute1" to "value1",
        "attribute2" to "Value2",
        "attribute3" to "Value3"       ),
)


```
```mdx-code-block
</TabItem>
```
```mdx-code-block
<TabItem value="iOS">
```
```swift showLineNumbers title="MyViewController.swift"
try await SelfAttestedOpenIDCredential.shared.update(
    title: "Title",                    // Updated title
    description: "Description",        // Updated description
    attributes: attributes,            // Updated key value pairs
    credentialId: credentialId,        // Id returned by add
    connectionID: nil,                 // optional
    connectionName: "Connection name", // optional
    connectionLocation: "Location",    // optional
    vct: "credential_type"             // optional
)
```

</TabItem>
</Tabs>

#### Get
Allows the Applications can read the self-attested credential.
```mdx-code-block
<Tabs>
<TabItem value="Android">
```
```kotlin showLineNumbers title="MyActivity.kt"
val credential = SelfAttestedOpenIDCredential().get(id)
```
```mdx-code-block
</TabItem>
```
```mdx-code-block
<TabItem value="iOS">
```
```swift showLineNumbers title="MyViewController.swift"
await SelfAttestedOpenIDCredential.shared.get(id: credentialId) { title, description, attributes in
    print("Title:", title)
    print("Description:", description)
    print("Attributes:", attributes)
}
```

</TabItem>
</Tabs>

#### Delete
Allows the Applications can delete the self-attested credential.
```mdx-code-block
<Tabs>
<TabItem value="Android">
```
```kotlin showLineNumbers title="MyActivity.kt"
SelfAttestedOpenIDCredential().delete(id)
```
```mdx-code-block
</TabItem>
```
```mdx-code-block
<TabItem value="iOS">
```
```swift showLineNumbers title="MyViewController.swift"
SelfAttestedOpenIDCredential.shared.delete(id: credentialId) { success in
    // success indicates whether the credential was removed
}
```

</TabItem>
</Tabs>

### Backup and Restore
The SDKs enable applications to backup and restore wallet data.
Currently, backup and restore operations are supported only through Data Pods by igrant.io.

Before initiating backup or restore, users must have an account with [Data Pods](https://datapod.igrant.io/login).
#### Backup
To initiate the backup
```mdx-code-block
<Tabs>
<TabItem value="Android">
```
```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.initiateBackUp(context)
```
```mdx-code-block
</TabItem>
```
```mdx-code-block
<TabItem value="iOS">
```
```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.initiateBackup()
```
</TabItem>
</Tabs>

#### Restore
To initiate the restore the backup. Before restoring make sure to delete wallet.
```mdx-code-block
<Tabs>
<TabItem value="Android">
```
```kotlin showLineNumbers title="MyActivity.kt"
DataWallet.initiateRestore(context, object : RestoreCallback {
    override fun onRestoreSuccess() {
        // Handle successful restore here
    }

    override fun onRestoreFailed(error: String) {
        // Handle restore failure here
    }
})
```
```mdx-code-block
</TabItem>
```
```mdx-code-block
<TabItem value="iOS">
```
```swift showLineNumbers title="MyViewController.swift"
AriesMobileAgent.shared.initiateRestore(viewMode: .BottomSheet) { success in
    // success indicates whether the restore completed
}
```

</TabItem>
</Tabs>


---

# Data Wallet Features
Source: https://docs.igrant.io/docs/data-wallet-features/

---
id: data-wallet-features
title: Data Wallet Features
description: Review the main features of the Data Wallet, including secure storage, credential sharing, and privacy controls for digital identity management.
hide_title: false
sidebar_label: Features
keywords: [Data Wallet, features, credential storage, credential sharing, privacy controls, EUDI Wallet, digital identity, verifiable credentials, trust management, trust list, EU Trust List, Untrusted Service Provider]
slug: /data-wallet-features/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Discover Key Features of the Data Wallet by iGrant.io | iGrant.io DevDocs</title>
  <meta name="description" content="Review the main features of the Data Wallet, including secure storage, credential sharing, and privacy controls for digital identity management."/>
</head>
Data Wallets and mobile SDKs provided by iGrant.io are specifically designed for mobile applications targeted at individual holders. They support OpenID for Verifiable Credentials (OpenID4VC - OpenID4VCI and OpenID4VP) along with various other credential profiles as detailed below.

## OpenID for Verifiable Credentials (OpenID4VC - OpenID4VCI and OpenID4VP)

The following features are supported for OpenID for Verifiable Credentials (OpenID4VC):

| Category                   | Supported Options                                                                                                                                                                                                                                                                                      |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Formats**                | W3C VC (JWT), IETF SD-JWT, ISO 18013-5 (mdoc, mDL)                                                                                                                                                                                                                                                     |
| **Issuance Protocols**     | [OpenID4VCI - Draft 13](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-ID1.html), [EWC RFC001: Issue Verifiable Credential - v2.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc001-issue-verifiable-credential.md)                                       |
| **Key Managements**        | [JSON Web Key (JWK)](https://datatracker.ietf.org/doc/html/rfc7517) via `.well-known/jwk_uri`, [`did:ebsi`](https://hub.ebsi.eu/vc-framework/did/legal-entities), [`did:key:jwk_jcs-pub`](https://hub.ebsi.eu/vc-framework/did/natural-person), [`did:web`](https://w3c-ccg.github.io/did-method-web/), [`did:jwk`](https://github.com/quartzjer/did-jwk/blob/main/spec.md), [`did:tdw` (or `did:webvh`)](https://identity.foundation/didwebvh/) |
| **Presentation Protocols** | [OpenID4VP - Draft 18](https://openid.net/specs/openid-4-verifiable-presentations-1_0-ID2.html), [EWC RFC002: Present Verifiable Credentials - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc002-present-verifiable-credentials.md)                                        |
| **Signing Algorithms**     | ECDSA (secp256r1/P-256) with SHA-256, RSA-2048 with SHA-256, Ed25519                                                                                 |
| **Revocation Management**  | [Token Status List](https://www.ietf.org/archive/id/draft-ietf-oauth-status-list-06.html), [Verifiable Credentials Status List v2021](https://www.w3.org/TR/2023/WD-vc-status-list-20230427/)                                                                                                          |
| **Trust Managements**      | EBSI, OpenID Federation (Coming soon), Verifier knows Issuers, X.509 certificates, EU Trust List (as per [ETSI TS 119 612](https://www.etsi.org/deliver/etsi_ts/119600_119699/119612/02.01.01_60/ts_119612v020101p.pdf))                                                                               |

For how the wallet establishes trust in issuers and verifiers, and what the **"not verified"** notice means, see [Trust in the Wallet Ecosystem](/docs/trust-overview/) and [The "not verified" provider notice](/docs/trust-untrusted-service-provider/).

## EWC RFCs

The following EWC RFCs are supported:

| Category                                   | RFC                                                                                                                                                                                   |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **PID Issuance**                           | [EWC RFC003: EWC RFC003: Issue Person Identification Data (PID) - v1.1](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc003-issue-person-identification-data.md)  |
| **Legal PID Issuance**                     | [EWC RFC005: Issue Legal Person Identification Data (LPID) - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc005-issue-legal-person-identification-data.md) |
| **Wallet Unit Attestation (Individual)**   | [EWC RFC004: EWC RFC004: Individual Wallet Unit Attestation - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc004-individual-wallet-attestation.md)         |
| **Wallet Unit Attestation (Organisation)** | EWC RFC006: Organisational Wallet Unit Attestation (Work-In-Progress)                                                                                                                 |
| **Payment Authenticator**                  | [EWC RFC007: Payment Authenticator - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/payment-rfcs/ewc-rfc007-payment-wallet-attestation.md)                        |
| **Payment Data Confirmation**              | [EWC RFC008: Payment Data Confirmation - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/payment-rfcs/ewc-rfc008-payment-data-confirmation.md)                     |


## Others

Additionally, the following features are supported on OID4VC:

| Category    | Supported Options                                                                        |
| ----------- | ---------------------------------------------------------------------------------------- |
| **Formats** | Passports (ICAO DTC), x509, PKPASS, Aadhar, Covid Vaccination (EU, Singapore, India, US) |

For ICAO DTC, the following countries are supported:

- EU
- Singapore
- United States of America
- China

Please note that exhaustive tests have not been carried out for every country. If you encounter issues using your country's passport, please contact:

- **Email**: [support@igrant.io](mailto:support@igrant.io)

- **WhatsApp Us**: [WhatsApp Us](https://wa.me/message/3YFVQOBN5ZYFE1)


---

# Data Wallet (OpenID4VC) SDKs
Source: https://docs.igrant.io/docs/data-wallet-openID4vc-sdks/

---
id: data-wallet-openID4vc-sdks
title: Data Wallet (OpenID4VC) SDKs
description: Integrate EUDI Wallet OpenID4VC SDKs for Android and iOS to enable credential issuance and verification using OpenID4VCI and OpenID4VP.
keywords: [Data Wallet, OpenID4VC, OpenID4VCI, OpenID4VP, Android SDK, iOS SDK, EUDI Wallet, verifiable credentials, credential issuance]
hide_title: false
sidebar_label: OpenID4VC SDKs
slug: /data-wallet-openID4vc-sdks/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The following steps outline how developers can integrate EUDI Wallet OpenID4VC SDKs for Android and iOS into their existing Android or iOS applications.

## Step 01: Installation

Use the following code to add depedency:

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```groovy showLineNumbers title="settings.gradle"
repositories {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}
```

```groovy showLineNumbers title="build.gradle"
dependencies {
    implementation 'com.github.decentralised-dataexchange:eudi-wallet-oidc-android:2024.5.1'
}
```

Additional dependencies:

```groovy showLineNumbers title="build.gradle"
dependencies {
    implementation("com.nimbusds:nimbus-jose-jwt:9.21")
    implementation("com.squareup.retrofit2:converter-gson:2.9.0")
}
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```
Follow the instructions below to add the SDK to your iOS project:

1. File > Swift Packages > Add Package Dependency
2. Enter the URL of the package: https://github.com/decentralised-dataexchange/eudi-wallet-oidc-ios and click Next.
3. Choose the version or branch you want and click Next.
4. Select the target to which you want to add the package and click Finish.

```mdx-code-block
</TabItem>
</Tabs>
```

## Verifiable Credential Issuance Functions

### Initialise

The following function allows you to initialise the issuance service class with the required parameters.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val issueService = IssueService()
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

Import the EUDI wallet SDK as follows:

```swift showLineNumbers title="MyViewController.swift"
import eudiWalletOidcIos
```

To create instance of an issuance service, use the following function:

```swift showLineNumbers title="MyViewController.swift"
let keyHandler = CryptoKitHandler()
let issueService = eudiWalletOidcIos.IssueService(keyHandler: keyHandler)
```
> **_NOTE:_**  The classes in which the functions are implemented should conform to NSObject.

```mdx-code-block
</TabItem>
</Tabs>
```

### Resolve Credential offer

This function allows resolving the credential offer received from the issuer. A credential offer may have a grant specified. It can be either:
1. Pre-Authorized code flow
2. Authorization code flow

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val credentialOffer = issueService.resolveCredentialOffer(data)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let credentialOffer = try await issueService?.resolveCredentialOffer(credentialOffer:data)
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Issuer Metadata

This function allows to perform discovery and fetch issuer metadata.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val discoveryService = DiscoveryService()
val issuerMetadata= discoveryService.getIssuerConfig("${credentialOffer?.credentialIssuer}/.well-known/openid-credential-issuer")
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let issuerMetadata = try await eudiWalletOidcIos.DiscoveryService.shared.getIssuerConfig(credentialIssuerWellKnownURI: credentialOffer.credentialIssuer)
```
```mdx-code-block
</TabItem>
</Tabs>
```

### Authorisation Server Metadata

This function allows to perform discovery and fetch authorisation server metadata.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val authorisationServerMetadata = DiscoveryService().getAuthConfig("${issuerMetadata?.issuerConfig?.authorizationServer}/.well-known/openid-configuration"
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let authorisationServerMetadata = try? await eudiWalletOidcIos.DiscoveryService.shared.getAuthConfig(authorisationServerWellKnownURI: issuerMetadata.authorizationServer)
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Authorisation Request

This section outlines the steps to perform the authorization request for credential issuance.

#### Step 1: Identify the Code Flow

Determine whether the issuance is an Authorized code flow or Pre-authorized code flow using the following code:

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val isPreAuthFlow = credentialOffer.grants?.preAuthorizationCode != null
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let isPreAuthFlow = credentialOffer.grants?.urnIETFParamsOauthGrantTypePreAuthorizedCode
```

```mdx-code-block
</TabItem>
</Tabs>
```

#### Step 2: Create DID and Public/Private Key Pair

##### Create Public/Private Key Pair

The following function allows to create a random public/private key pair and Json Web Key (JWK) for the same:

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val jwk = DIDService().createJWK(cryptographicAlgorithm = CryptographicAlgorithms.ES256)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let jwk = await eudiWalletOidcIos.DidService.shared.createJWK(keyHandler: keyHandler)
```

```mdx-code-block
</TabItem>
</Tabs>
```

##### Create DID

The following function allows to create a `did:key` identifier from a JSON Web Key (JWK).

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val did = DIDService().createDID(jwk, cryptographicAlgorithm = CryptographicAlgorithms.ES256)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let did = await didKeyHandler.shared.createDID(jwk: jwk.0)
```

```mdx-code-block
</TabItem>
</Tabs>
```

#### Step 3: Generate Code Verifier for Proof Key for Code Exchange (PKCE)

The following function allows to create a code verifier for Proof Key for Code Exchange (PKCE):

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val codeVerifier = CodeVerifierService().generateCodeVerifier()
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let codeVerifier = codeVerifierHandler.shared.generateCodeVerifier()
```

```mdx-code-block
</TabItem>
</Tabs>
```

#### Step 4: Send Authorisation Request

The following function allows to send authorisation request to issuer's authorisation server endpoint and obtain the authorisation response.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val authorisationResponse = issueService.processAuthorisationRequest(
   did,
   jwk,
   credentialOffer,
   codeVerifier,
   authorisationServerMetadata?.authConfig?.authorizationEndpoint
)

val authorisationCode = Uri.parse(authorisationResponse).getQueryParameter("code")
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let authorisationCode =  await issueService?.processAuthorisationRequest(did: did, secureKey: jwk.1, credentialOffer: credentialOffer, codeVerifier: codeVerifier, authServer: authorisationServerMetadata)
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Token Request

The following function allows to sent token request to the issuer's token endpoint and obtain the access token/refresh token pair.

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val tokenResponse= issueService.processTokenRequest(
   did = did,
   tokenEndPoint = authorisationServerMetadata?.authConfig?.tokenEndpoint,
   code = authorisationCode,
   codeVerifier = codeVerifier,
   isPreAuthorisedCodeFlow = isPreAuthFlow ,
   userPin = null 
)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let tokenResponse = await issueService?.processTokenRequest(did: did, tokenEndPoint: authorisationServerMetadata.tokenEndpoint, code: code , codeVerifier: codeVerifier, isPreAuthorisedCodeFlow: false, userPin: nil)
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Credential Request

Credentials can be issued in two ways: InTime and Deferred. 

- **InTime issuance**: The credential is provided immediately as a response.
- **Deferred issuance**: The credential is issued after a processing period, which can take minutes to hours.

The following function allows to sent credential request to credential endpoint using the access token and nonce obtained from the previous step:

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val credentialResponse = issueService.processCredentialRequest(did, jwk, nonce, credentialOffer, issuerMetadata?.issuerConfig, accessToken, format)
```

Format can be obtained from the issuerMetadata, Use 

```
issuerService.getFormatFromIssuerConfig(issuerMetadata?.issuerConfig, <Credential type>)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let credentialResponse = await issueService?.processCredentialRequest(did: did, secureKey: jwk.1, nonce: tokenResponse.cNonce, credentialOffer: credentialOffer, issuerConfig: issuerMetadata, accessToken: tokenResponse.accessToken, format: "")
```

</TabItem>
</Tabs>

In the response, you will receive the credential. Sometimes, instead of credentials, you will only receive an acceptance token. If the response contains an acceptance token, you need to follow the deferred credential flow.

### Deferred Credential Request

The following function allows to sent deferred credential request to deferred credential endpoint using the acceptance token obtained from the previous step:

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val credentialResponse = issueService.processDeferredCredentialRequest(acceptanceToken, issuerMetadata.issuerConfig?.deferredCredentialEndpoint)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let credentialResponse = await issueService?.processDeferredCredentialRequest(acceptanceToken: acceptanceToken, deferredCredentialEndPoint: issuerConfig.deferredCredentialEndpoint)
```

</TabItem>
</Tabs>

## Verifiable Presentation Functions

### Authorisation Request

This function allows to resolve the authorisation request from the verifier containing the presentation definition:

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val authorisationRequest = VerificationService().processAuthorisationRequest(data)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let authorisationRequest = await verificationHandler.processAuthorisationRequest(data: data)
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Authorisation Response

This function allows to send the authorisation response with VP token and presentation submission to the verifier.

#### Step 1: Filter the Matching Credentials against Presentation Definition

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val filteredCredentials = VerificationService().filterCredentials(<All credentials in the storage>, authorisationRequest)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let filteredCredentials = verificationHandler.filterCredentials(credentialList:<All stored credentials>, presentationDefinition: presentationDefinitionModel)
```

```mdx-code-block
</TabItem>
</Tabs>
```

#### Step 2: Send Authorisation Response

```mdx-code-block
<Tabs>
<TabItem value="Android">
```

```kotlin showLineNumbers title="MyActivity.kt"
val authorisationCode = VerificationService().sendVPToken(did, jwk, authorisationRequest, filteredCredentials)
```

```mdx-code-block
</TabItem>
```

```mdx-code-block
<TabItem value="iOS">
```

```swift showLineNumbers title="MyViewController.swift"
let authorisationCode = await verificationHandler.sendVPToken(did: did, secureKey: jwk.1, authorisationRequest: presentationRequest, credentialsList: [filteredCredentials])
```

```mdx-code-block
</TabItem>
</Tabs>
```


---

# Data Wallet Overview
Source: https://docs.igrant.io/docs/data-wallet-overview/

---
id: data-wallet-overview
title: Data Wallet Overview
description: "Learn how the Data Wallet enables individuals to securely store, manage, and share Verifiable Credentials for trusted digital identity interactions."
hide_title: false
sidebar_label: Overview
keywords: [Data Wallet, EUDI Wallet, verifiable credentials, credential storage, digital identity, mobile wallet, individual wallet, privacy]
slug: /data-wallet-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Overview of the EU Digital Identity (EUDI) Data Wallet | iGrant.io DevDocs</title>
  <meta name="description" content="Learn how the Data Wallet enables individuals to securely store, manage, and share Verifiable Credentials for trusted digital identity interactions."/>
</head>

iGrant.io offers Data Wallet (For Individuals) as SDKs that can be integrated into an organisation's existing mobile apps, enriching them with digital wallet or dApp capabilities. It is also available at as a standalone app as well, downloadable from the App Store and Google Play, primarily used for trials and demonstrations. 

This solution enables individuals to store and manage their personal and sensitive data, providing wallet functions with an enhanced user experience. Such features make it particularly suitable for organisations looking to offer their users comprehensive control over their data, whether through direct app downloads or through seamless integration into their existing services.

### Core Capabilities

* **Interoperability**: Seamlessly integrates with existing systems and supports data portability across different platforms supporting OpenID4VCI/OpenID4VP (JWT/SD-JWT).

* **Support for Multiple Trust Anchors**: The wallet support multiple trust anchors, both ledgers and non-ledger ones. The ledger trust anchor support include [European Blockchain Service Infrastructure](https://ec.europa.eu/digital-building-blocks/sites/display/EBSI/Conformant+wallets), IDUnion, Sovrin, NordXDataspace etc.)

* **Support for Multiple EAAs**: The wallet features a modular architecture that integrates various EAAs, seamlessly incorporating new types without significant system overhauls.

* **Usability and Accessibility**: A user-centric design prioritises intuitive navigation, search, stacked credential interaction, facilitating easy management and presentation of EAAs, straightforward visuals, and minimal steps for access or sharing.

* **Security and Data Privacy**: All EAAs will be protected through cryptographic functions that are compliant with SOG-IS/BSI CSP2 security standards, ensuring user data remains secure in transit and at rest. The privacy considerations will adhere to the [eIDAS2 requirements](https://docs.igrant.io/regulations/reg-eu-digital-id-framework), addressing critical issues of unobservability and unlinkability.

*  **Branding Flexibility**: Organisations can do custom branding of credentials to maintain their brand identity in the wallet, enhancing trust and recognition within the ecosystem.

* **Online and In-Person Use**: The EAAs are designed for dual-purpose functionality, effective in online and in-person transactions, and facilitated through QR codes and NFC taps for easy sharing and verification across all interaction modes.


---

# Data Wallet - Try Out! 
Source: https://docs.igrant.io/docs/data-wallet-tryitout/

---
id: data-wallet-tryitout
title: Data Wallet - Try Out! 
description: Explore the interactive demo to experience how the Data Wallet stores and shares verifiable credentials for secure digital interactions.
hide_title: false
sidebar_label: Try It Out
keywords: [Data Wallet, demo, try it out, EUDI Wallet, verifiable credentials, interactive demo, digital identity, mobile app]
slug: /data-wallet-tryitout/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Download the Data Wallet and use it in a live demo | iGrant.io DevDocs</title>
  <meta name="description" content="Explore the interactive demo to experience how the Data Wallet stores and shares verifiable credentials for secure digital interactions."/>
</head>

import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';

Here are the steps for trying Data Wallet by iGrant.io capabilities in a mobile application.

## Step 1: Download and Install

- <div style={{ display: 'flex', alignItems: 'center' }}>
    You can download and explore our wallet app.
    <span class='featured-card__product-list-item apple-icon'>
      <a
        href='https://apple.co/2Mz9nJp'
        target='_blank'
        rel='noopener noreferrer'
        class='featured-card__product-link'
      >
        iOS
      </a>
    </span>
    <span style={{ margin: '0 0.2em' }}></span> {    /* Add a space here */}
    <span class='featured-card__product-list-item android-icon'>
      <a
        href='https://play.google.com/store/apps/details?id=io.igrant.mobileagent'
        target='_blank'
        rel='noopener noreferrer'
        class='featured-card__product-link'
      >
        Android
      </a>
    </span>
  </div>
- Once you have your data wallet installed on your smartphone, we invite you to access our [demo catalogue](https://igrant.io/demo.html) to experience the data exchange features firsthand. This will give you a practical understanding of how the app manages and secures personal and sensitive data.

## Step 2: Try It Yourself

Some of the demos which you can try out to learn Data Wallet by iGrant.io are provided here.

### Issuer-Holder-Verifier Developer Workflow with APIs

For developers, you can try data wallet with your own end-to-end workflow with our organisational wallets APIs:

* [Issue Credentials API workflow](/docs/openID4vci-issue-credential-intime/) - View the ([Demo video](https://youtu.be/qtsyvw9alb4)).
* [Verify Credentials API workflow](/docs/openID4vc-send-verify-credentials/) - View the ([Demo video](https://youtu.be/xD4TLfdnSG0)).

### EBSI PDA1 Credential Exchange (ESSPASS Scenario)

[Click here](https://igrant.io/ebsi.html) and follow the steps in the example scenario for PDA1 credential issuance and verification with EBSI trust anchor in accordance with OpenID4VC. Watch the demo video below.

<VideoPlayer
  videoId="b-dTpMbxHPU"
  title="EBSI PDA1 Credential Exchange Demo"
  description="Learn how to implement EBSI PDA1 credential exchange using OpenID4VC protocol with iGrant.io Data Wallet."
  uploadDate="2024-01-01"
  duration="PT10M"
/>

### Data4Travel with Covid Certificate

[Click here](https://igrant.io/data4travel.html) and follow the steps in the example scenario with Data4Travel with covid certificate issuance and verification. Watch the demo video below.

<VideoPlayer
  videoId="NF81dlISBeA"
  title="Data4Travel with Covid Certificate Demo"
  description="Learn how to implement Data4Travel with Covid Certificate using iGrant.io Data Wallet."
  uploadDate="2024-01-01"
  duration="PT10M"
/>

### Data4Forms with NFC-chip enabled Passports

[Click here](https://igrant.io/data4forms.html) and follow the steps in the example scenario with Data4Forms with NFC-chip Passports issuance and verification. Here the passport is using the NFC-chip and can be used in age verification and verified form filling scenarios. You can try OpenID4VC protocols in this scenario.

---

# Organisation Wallet Suite Features
Source: https://docs.igrant.io/docs/organisation-wallet-features/

---
id: organisation-wallet-features
title: Organisation Wallet Suite Features
description: Review key features of the Organisation Wallet Suite, including credential issuance, verification, and secure management for businesses and institutions.
keywords: [Organisation Wallet, European Business Wallet, features, credential issuance, credential verification, SD-JWT, mdoc, OpenID4VC, OpenID4VCI, OpenID4VP, HAIP, OpenID Foundation conformance, WE BUILD, TS3, TS12, Wallet Unit Attestation, SCA, EUDI Wallet, digital wallet]
hide_title: false
sidebar_label: Features
slug: /organisation-wallet-features/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Discover Features of the Organisation Wallet Suite | iGrant.io DevDocs</title>
  <meta name="description" content="Review key features of the Organisation Wallet Suite, including credential issuance, verification, and secure management for businesses and institutions."/>
</head>
The Organisation Wallet Suite from iGrant.io is specifically designed for enterprises, offering support for OpenID for Verifiable Credentials (OpenID4VC - OpenID4VCI and OpenID4VP), the EUDI Wallet technical specifications TS3 and TS12, and the WE BUILD conformance specifications, as detailed below.

## OpenID for Verifiable Credentials (OpenID4VC - OpenID4VCI and OpenID4VP)

Summary of key features and protocols

<table>
<thead>
<tr>
<th align="left">Category</th>
<th align="left">Supported Options</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><strong>Formats Supported</strong></td>
<td align="left" valign="top"><ul><li>IETF SD-JWT VC (<code style={{"color": "#800020"}}>dc+sd-jwt</code>), with selective disclosure as per <a href="https://www.rfc-editor.org/rfc/rfc9901.html" target="_blank" rel="noopener noreferrer">SD-JWT (RFC 9901)</a>, including nested objects and array elements</li><li>ISO/IEC 18013-5 mdoc (<code style={{"color": "#800020"}}>mso_mdoc</code>), for example mDL, PID and Photo ID</li><li>W3C VC (JWT, <code style={{"color": "#800020"}}>jwt_vc_json</code>), presented with OpenID4VP (Draft 18)</li></ul></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Issuance Protocols</strong></td>
<td align="left" valign="top"><a href="https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html" target="_blank" rel="noopener noreferrer">OpenID4VCI 1.0</a> with <a href="https://openid.net/specs/openid4vc-high-assurance-interoperability-profile-1_0.html" target="_blank" rel="noopener noreferrer">HAIP 1.0</a><br/><br/><a href="https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc001-issue-verifiable-credential.md">EWC RFC001: Issue Verifiable Credential - v2.0</a></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Issuance Features</strong></td>
<td align="left" valign="top"><ul><li>Pre-authorised code flow with transaction code (<code style={{"color": "#800020"}}>tx_code</code>), and authorisation code flow with Pushed Authorisation Requests (PAR) and PKCE</li><li>Issuer-initiated issuance (credential offer by value or by reference) and wallet-initiated issuance</li><li>Credential offer reuse per credential definition: one credential offer can start several issuances</li><li>Interactive Authorisation Request (IAR), including OpenID4VP presentation during issuance</li><li>Sender-constrained tokens with <a href="https://www.rfc-editor.org/rfc/rfc9449.html" target="_blank" rel="noopener noreferrer">DPoP (RFC 9449)</a> and wallet authentication with <a href="https://datatracker.ietf.org/doc/draft-ietf-oauth-attestation-based-client-auth/" target="_blank" rel="noopener noreferrer">OAuth 2.0 Attestation-Based Client Authentication</a></li><li>Proof types <code style={{"color": "#800020"}}>jwt</code> and <code style={{"color": "#800020"}}>attestation</code>, with key attestation requirements set per credential definition and per proof type</li><li>Batch issuance, <a href="/docs/openID4vci-issue-credential-deferred/">deferred issuance</a>, nonce endpoint and notification endpoint</li><li>Credential refresh (re-issuance with a refresh token)</li><li>Encrypted credential requests and responses</li><li><a href="/docs/openID4vci-issue-dynamic-credential-request/">Dynamic credential request</a> (the issuer requests a presentation before it issues)</li><li>External authorisation servers: user authentication at an external OpenID Connect provider, set per credential definition</li></ul></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Key Managements</strong></td>
<td align="left" valign="top">Cryptographic key formats supported are: X.509, JWK, Decentralised Identifier (DID) <code style={{"color": "#800020"}}>did:key</code><br/><br/>The key storage can be:<br/><ul><li>iGrant.io secure storage vault</li><li>Bring your HSMs via Hashicorp Vault</li><li>Use a Qualified Trust Service Provider (QTSP) through the <a href="https://cloudsignatureconsortium.org/resources/download-api-specifications/" target="_blank" rel="noopener noreferrer">Cloud Signature Consortium (CSC) API</a> v1.0.4.0 or v2.2.0.0</li></ul></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Presentation Protocols</strong></td>
<td align="left" valign="top"><a href="https://openid.net/specs/openid-4-verifiable-presentations-1_0.html" target="_blank" rel="noopener noreferrer">OpenID4VP 1.0</a> with <a href="https://openid.net/specs/openid4vc-high-assurance-interoperability-profile-1_0.html" target="_blank" rel="noopener noreferrer">HAIP 1.0</a>, <a href="https://openid.net/specs/openid-4-verifiable-presentations-1_0-ID2.html" target="_blank" rel="noopener noreferrer">OpenID4VP (Draft 18)</a><br/><br/>ISO/IEC 18013-7 Annex C and the <a href="https://www.w3.org/TR/digital-credentials/" target="_blank" rel="noopener noreferrer">W3C Digital Credentials API</a> (see <a href="/docs/openID4vc-dcapi-overview/">DC API overview</a>)<br/><br/><a href="https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc002-present-verifiable-credentials.md">EWC RFC002: Present Verifiable Credentials - v1.0</a></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Presentation Features</strong></td>
<td align="left" valign="top"><ul><li><a href="/docs/dcql-overview/">Digital Credentials Query Language (DCQL)</a>, including credential sets, claim sets and trusted authorities (<code style={{"color": "#800020"}}>aki</code>, <code style={{"color": "#800020"}}>etsi_tl</code>)</li><li>Transaction data, including the TS12 payment, e-mandate, account access and login and risk types, and qualified electronic signature data</li><li>Response modes <code style={{"color": "#800020"}}>direct_post</code>, <code style={{"color": "#800020"}}>direct_post.jwt</code>, <code style={{"color": "#800020"}}>dc_api</code> and <code style={{"color": "#800020"}}>dc_api.jwt</code></li><li>Client identifier prefixes <code style={{"color": "#800020"}}>x509_san_dns</code>, <code style={{"color": "#800020"}}>x509_hash</code>, <code style={{"color": "#800020"}}>decentralized_identifier</code> (<code style={{"color": "#800020"}}>did:key</code>), <code style={{"color": "#800020"}}>verifier_attestation</code> and <code style={{"color": "#800020"}}>redirect_uri</code></li><li>Signed request objects, passed by value or by reference (<code style={{"color": "#800020"}}>request_uri</code>, including <code style={{"color": "#800020"}}>request_uri_method=post</code>)</li></ul></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Signing Algorithms</strong></td>
<td align="left" valign="top">ECDSA (secp256r1/P-256) with SHA-256 (ES256)</td>
</tr>
<tr>
<td align="left" valign="top"><strong>Revocation Management</strong></td>
<td align="left" valign="top"><a href="https://datatracker.ietf.org/doc/draft-ietf-oauth-status-list/" target="_blank" rel="noopener noreferrer">IETF Token Status List</a>:<ul><li>Status List Token in JWT format for SD-JWT VC, and in CWT format for mdoc as per ISO/IEC 18013-5, served from the same status list URL (the format is selected with the HTTP Accept header)</li><li>A status list signing key per credential configuration; for mdoc, a revocation list signer certificate as per ISO/IEC 18013-5 Table B.9</li></ul></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Trust Managements</strong></td>
<td align="left" valign="top">X.509 certificate chains, EU Trusted Lists as per <a href="https://www.etsi.org/deliver/etsi_ts/119600_119699/119612/02.03.01_60/ts_119612v020301p.pdf" target="_blank" rel="noopener noreferrer">ETSI TS 119 612</a> (XML), Lists of Trusted Entities as per <a href="https://www.etsi.org/deliver/etsi_ts/119600_119699/119602/01.01.01_60/ts_119602v010101p.pdf" target="_blank" rel="noopener noreferrer">ETSI TS 119 602</a> (JSON and XML), and trust anchors configured per organisation. See <a href="/docs/trust-overview/">Trust in the Wallet Ecosystem</a></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Wallet Provider</strong></td>
<td align="left" valign="top"><ul><li>Wallet Unit Attestation (WUA) as per <a href="https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts3-wallet-unit-attestation.md" target="_blank" rel="noopener noreferrer">TS3: Wallet Unit Attestation</a>, with a Wallet Instance Attestation (WIA) and a wallet-provider-signed key attestation</li><li>Wallet unit management and statistics</li><li>Revocation of WUAs and key attestations through the Token Status List</li></ul></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Holder (Organisation Wallet)</strong></td>
<td align="left" valign="top"><ul><li>Receive and store credentials over OpenID4VCI 1.0, including deferred and batch issuance, DPoP and credential refresh (see <a href="/docs/openID4vc-receive-and-store-credential/">Receive and Store Credential</a>)</li><li>Present credentials over OpenID4VP 1.0 (see <a href="/docs/openID4vp-receive-and-present-credentials/">Receive and Present Credential</a>)</li><li>Holder keys in a separate holder key store, apart from the issuer and verifier signing keys</li><li>Organisational identity with Legal Person Identification Data (LPID)</li></ul></td>
</tr>
<tr>
<td align="left" valign="top"><strong>Payments (TS12)</strong></td>
<td align="left" valign="top">Strong Customer Authentication (SCA) attestations as per <a href="https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md" target="_blank" rel="noopener noreferrer">TS12: Electronic payments, SCA implementation with the wallet</a>: payment card, payment account, payment service user (issued without user claims, as the rulebook defines), and Strong User Authentication (SUA) user and IBAN credentials. SCA transaction data is validated at presentation. See the payment extensions below.</td>
</tr>
</tbody>
</table>

## EUDI Wallet technical specifications

The Organisation Wallet Suite implements the following EUDI Wallet technical specifications:

| Specification | Organisation Wallet Suite feature |
| --- | --- |
| [TS3: Wallet Unit Attestation](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts3-wallet-unit-attestation.md) | Wallet Provider: WUA with WIA and key attestation; issuers can require key attestation with a specified assurance level |
| [TS12: Electronic payments, SCA implementation with the wallet](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md) | SCA attestations, SCA transaction data and the payment extensions |

## WE BUILD conformance specifications

The Organisation Wallet Suite is built against the [WE BUILD conformance specifications](https://github.com/webuild-consortium/wp4-architecture/tree/main/conformance-specs), which iGrant.io helps to write (see [WE BUILD Consortium](/docs/ecosystem-engagements/we-build-consortium)). The [WE BUILD Conformance Overview](https://webuild-consortium.github.io/wp4-interop-test-bed/docs/conformance-overview.html) of the [WE BUILD Interoperability Test Bed](https://webuild-consortium.github.io/wp4-interop-test-bed/) lists the Organisation Wallet Suite (wallet, issuer and verifier) with full conformance to the base protocols CS-01 and CS-02.

| Specification | Title | Organisation Wallet Suite feature |
| --- | --- | --- |
| [CS-01](https://github.com/webuild-consortium/wp4-architecture/blob/main/conformance-specs/cs-01-credential-issuance.md) | Credential Issuance | OpenID4VCI 1.0 issuer and holder |
| [CS-02](https://github.com/webuild-consortium/wp4-architecture/blob/main/conformance-specs/cs-02-credential-presentation.md) | Credential Presentation | OpenID4VP 1.0 verifier and holder |
| [CS-03](https://github.com/webuild-consortium/wp4-architecture/blob/main/conformance-specs/cs-03-remote-signing-with-wallet-units.md) | Remote Qualified Signing with Wallet Units | [Document Signing](/docs/extensions/document-signing) with a QTSP over the CSC API |
| [CS-04](https://github.com/webuild-consortium/wp4-architecture/blob/main/conformance-specs/cs-04-wua-lifecycle.md) | Individual Wallet Unit Attestation (WUA) Lifecycle | Wallet Provider: TS3 WUA issuance and revocation |
| [CS-07](https://github.com/webuild-consortium/wp4-architecture/blob/main/conformance-specs/cs-07-credential-presentation-dc-api.md) | Credential Presentation and Issuance via the Digital Credentials API | Presentation over the [DC API](/docs/openID4vc-dcapi-overview/) |
| [CS-10](https://github.com/webuild-consortium/wp4-architecture/blob/main/conformance-specs/cs-10-revocation-mechanism.md) | Attestation Revocation Mechanism | IETF Token Status List |
| [CS-12](https://github.com/webuild-consortium/wp4-architecture/blob/main/conformance-specs/cs-12-sca-payments.md) | SCA Attestations for Payment Transactions (TS12 Profile) | TS12 SCA attestations and the payment extensions |

## Extensions

The following [extensions](/docs/extensions/overview) are available in the Organisation Wallet Suite:

| Extension | Purpose |
| --- | --- |
| [Age Verification](/docs/extensions/age-verification) | Check the age of a user with PID, Passport or Photo ID |
| [Know Your Customer (KYC)](/docs/extensions/know-your-customer) | Verify the identity of a customer with PID, Passport or Photo ID |
| [Passwordless Login](/docs/extensions/passwordless-login) | OpenID Connect provider for login with an EUDI Wallet |
| [Document Signing](/docs/extensions/document-signing) | Sign PDF documents with a Qualified Electronic Signature from the wallet |
| [PID Credential Issuance](/docs/extensions/pid-credential-issuance) | Issue PID credentials |
| [Photo ID Credential Issuance](/docs/extensions/photoid-credential-issuance) | Issue Photo ID credentials |
| [Payment Credential Issuance (TS12)](/docs/extensions/payment-credential-issuance) | Issue SCA attestations for a payment account, card or user |
| [Payment Authorisation (for Banks) (TS12)](/docs/extensions/payment-authorisation-for-banks) | Authorise payments initiated at the bank of the payer |
| [Payment Authorisation (for Merchants) (TS12)](/docs/extensions/payment-authorisation-for-merchants) | Authorise payments at a merchant or a PISP |
| [Account Information Access (TS12)](/docs/extensions/account-information-access) | Consented access to payment account information |
| [Recurring Payment Mandate (TS12)](/docs/extensions/recurring-payment-mandate) | Consent for recurring or merchant-initiated payments |
| [Risk-based Authentication (TS12)](/docs/extensions/risk-based-authentication) | Step-up SCA for login and sensitive actions |
| OpenID Conformance | Set up the organisation for the OpenID Foundation conformance test plans (HAIP 1.0) |

## OpenID Foundation conformance (HAIP 1.0)

The Organisation Wallet Suite is tested against the OpenID Foundation conformance suite with the <strong>High Assurance Interoperability Profile (HAIP) 1.0</strong> certification test plans: OpenID4VCI 1.0 Final + HAIP 1.0 Final and OpenID4VP 1.0 Final + HAIP 1.0 Final. The test plans below are published by the OpenID Foundation conformance suite, and each link opens the public test results.

As a software provider, we keep the Organisation Wallet Suite <strong>certification ready</strong>: all certification profiles that the software supports pass.

| Role | Certification profile | Test results |
| --- | --- | --- |
| Issuer | OID4VCI 1.0 + HAIP 1.0, SD-JWT VC, wallet-initiated | <a href="https://www.certification.openid.net/plan-detail.html?plan=tadjc9FPDRExR&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Issuer | OID4VCI 1.0 + HAIP 1.0, mdoc, wallet-initiated | <a href="https://www.certification.openid.net/plan-detail.html?plan=EXGdmrWHYtPwF&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Issuer | OID4VCI 1.0 + HAIP 1.0, SD-JWT VC, issuer-initiated | <a href="https://www.certification.openid.net/plan-detail.html?plan=FWvAe7tOdJMi6&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Issuer | OID4VCI 1.0 + HAIP 1.0, mdoc, issuer-initiated | <a href="https://www.certification.openid.net/plan-detail.html?plan=kZCDMgyngbDrd&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Verifier | OID4VP 1.0 + HAIP 1.0, SD-JWT VC, direct_post.jwt | <a href="https://www.certification.openid.net/plan-detail.html?plan=8UlA3VXleLY85&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Verifier | OID4VP 1.0 + HAIP 1.0, mdoc, direct_post.jwt | <a href="https://www.certification.openid.net/plan-detail.html?plan=goNWMj0pg7ET0&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VCI 1.0 + HAIP 1.0, SD-JWT VC, wallet-initiated | <a href="https://www.certification.openid.net/plan-detail.html?plan=Pm74XUmmO0GL7&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VCI 1.0 + HAIP 1.0, mdoc, wallet-initiated | <a href="https://www.certification.openid.net/plan-detail.html?plan=KyYI4LjB3oUYu&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VCI 1.0 + HAIP 1.0, SD-JWT VC, issuer-initiated, offer by value | <a href="https://www.certification.openid.net/plan-detail.html?plan=d8nBLzlQESi38&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VCI 1.0 + HAIP 1.0, SD-JWT VC, issuer-initiated, offer by reference | <a href="https://www.certification.openid.net/plan-detail.html?plan=fC2j8wtXeDIAz&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VCI 1.0 + HAIP 1.0, mdoc, issuer-initiated, offer by value | <a href="https://www.certification.openid.net/plan-detail.html?plan=n53OFhXlUkKoi&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VCI 1.0 + HAIP 1.0, mdoc, issuer-initiated, offer by reference | <a href="https://www.certification.openid.net/plan-detail.html?plan=JYUDheR38dcj3&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VP 1.0 + HAIP 1.0, SD-JWT VC, direct_post.jwt | <a href="https://www.certification.openid.net/plan-detail.html?plan=rwXZNeLHVfpDk&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VP 1.0 + HAIP 1.0, SD-JWT VC, direct_post.jwt, PID query | <a href="https://www.certification.openid.net/plan-detail.html?plan=0Rfo539hTBK4e&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VP 1.0 + HAIP 1.0, mdoc, direct_post.jwt | <a href="https://www.certification.openid.net/plan-detail.html?plan=koqXZ7yvlmHCA&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VP 1.0 + HAIP 1.0, mdoc, direct_post.jwt, mDL query | <a href="https://www.certification.openid.net/plan-detail.html?plan=n69t9IEpbOPJG&public=true" target="_blank" rel="noopener noreferrer">View results</a> |
| Holder | OID4VP 1.0 + HAIP 1.0, mdoc, direct_post.jwt, Photo ID query | <a href="https://www.certification.openid.net/plan-detail.html?plan=jOV4YfizajzwG&public=true" target="_blank" rel="noopener noreferrer">View results</a> |

## EU Digital Identity Wallet Consortium (EWC) Specifications

The following EWC RFCs are supported by iGrant.io Organisation Wallet.

| Category                                   | RFC                                                                                                                                                                                   |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **PID Issuance**                           | [EWC RFC003: Issue Person Identification Data (PID) - v1.1](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc003-issue-person-identification-data.md)  |
| **Legal PID Issuance**                     | [EWC RFC005: Issue Legal Person Identification Data (LPID) - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc005-issue-legal-person-identification-data.md) |
| **Wallet Unit Attestation (Individual)**   | [EWC RFC004: Individual Wallet Unit Attestation - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc004-individual-wallet-attestation.md)         |
| **Wallet Unit Attestation (Organisation)** | EWC RFC006: Organisational Wallet Unit Attestation (Work-In-Progress)                                                                                                                 |
| **Payment Authenticator**                  | [EWC RFC007: Payment Authenticator - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/payment-rfcs/ewc-rfc007-payment-wallet-attestation.md)                        |
| **Payment Data Confirmation**              | [EWC RFC008: Payment Data Confirmation - v1.0](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/payment-rfcs/ewc-rfc008-payment-data-confirmation.md)                     |


---

# Explore documentation for EUDI Wallet integration
Source: https://docs.igrant.io/docs/

---
id: eo-overview
title: Explore documentation for EUDI Wallet integration
description: Explore documentation for EUDI Wallet integration
keywords: [EUDI Wallet, European Business Wallet, Organisation Wallet Suite, digital wallet, verifiable credentials, OpenID4VC, eIDAS 2.0, iGrant.io]
hide_title: true
sidebar_label: Overview
slug: /
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


The **[Organisation Wallet Suite](/docs/organisation-wallet-overview/)** by iGrant.io, recognised as the **European Business Wallet**, is our core product for organisations looking to issue, hold, and verify digital credentials. It supports the OpenID4VC (OpenID4VCI/OpenID4VP) protocol suite aligned with the European Digital Identity (EUDI) Framework and is available both as an on-premise deployment and as a Platform as a Service (PaaS).

**[Get started with the Organisation Wallet Suite](/docs/organisation-wallet-overview/)**

---

We also offer the following complementary products:

- [Data Wallet (for Individuals)](/docs/data-wallet-overview/): SDKs and white-labellable standalone apps for personal credential management. Available on the [Google Play Store](https://play.google.com/store/apps/details?id=io.igrant.mobileagent) and [Apple App Store](https://apple.co/2Mz9nJp).

- [Data Intermediation Services](/docs/data-intermediation-service-provider-overview/): Secure data exchange between individuals and organisations with auditable consent, in compliance with the EU Data Governance Act.

- [Consent Management](/docs/consent-management-overview/): Management and recording of consents and permissions for both Web 2.0 (traditional API-based systems) and Web 3.0 (digital wallets), ensuring compliance with data regulations.

Use the sidebar to explore all products. We also provide [online tools for developers](/docs/devtools-overview/).

---

# Age Verification
Source: https://docs.igrant.io/docs/eu-age-verification/

---
id: eu-age-verification
title: Age Verification
description: Issue and verify EU age verification attestations (eu.europa.ec.av.1, ISO mdoc) with OpenID4VCI and OpenID4VP. Prove age over 18 without revealing identity.
hide_title: false
sidebar_label: Age Verification
keywords: [age verification, EU Age Verification, EUDI Wallet age verification, age verification API, eu.europa.ec.av.1, age_over_18, proof of age, mso_mdoc, ISO 18013-5 mdoc, OpenID4VCI, OpenID4VP, DCQL, selective disclosure, age-restricted services, Organisation Wallet, European Business Wallet]
slug: /eu-age-verification/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-eu-age-verification` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-eu-age-verification
> ```

<head>
  <title>Age Verification with EUDI Wallet using OpenID4VC | iGrant.io DevDocs</title>
  <meta name="description" content="Issue and verify EU age verification attestations (eu.europa.ec.av.1, ISO mdoc) with OpenID4VCI and OpenID4VP. Prove age over 18 without revealing identity."/>
</head>

import Link from '@docusaurus/Link';
import NoteBox from '@site/src/components/NoteBox';

This workflow implements the [EU Age Verification solution](https://ageverification.dev/) profile, which defines the age verification attestation as an ISO/IEC 18013-5 mdoc with doctype `eu.europa.ec.av.1` and boolean `age_over_NN` claims. It employs the [OpenID4VCI Issue Credential (In-Time)](/docs/openID4vci-issue-credential-intime/) protocol to issue the attestation and the [OpenID4VP](/docs/openID4vc-send-verify-credentials/) protocol with a [DCQL query](/docs/dcql-overview/) to verify a proof of age. The attestation is issued with selective disclosure enabled, so the holder can prove, for example, being over 18 without revealing any other attribute. The process is illustrated in the diagram below:

![EU Age Verification workflow](./images/ow-eu-age-verification.png)

### Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from '@site/src/components/ApiKeyManager';

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Credential Definition (Age Verification Issuer Admin)

Use the code block below to create a credential definition for the age verification attestation in `mso_mdoc` format with doctype `eu.europa.ec.av.1`. You can run it using the **Run** button. Alternatively, execute the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition). From the API response, copy the `credentialDefinitionId` and the `id` field from the `credentialDefinitions` array for use in Step 3.

import Step2 from '@site/src/components/AgeVerificationUsecase/Step2';

<Step2
  versionFamily="createCredentialDefinition"
  initialVersionKey="version_01"
  initialFormatKey="mso_mdoc"
/>

### Step 3: Issue Age Verification Attestation (Issuer)

After verifying the age of the individual (e.g. against a national eID, passport or PID), the issuer issues the age verification attestation in in-time (`InTime`) mode with the applicable `age_over_NN` values. When you run Step 2 on this page, the `credentialDefinitionId` and `id` fields below are autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained in Step 2. Run the code block below using the **Run** button. Alternatively, execute the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential/).

From the API response, note the `CredentialExchangeId`. Toggle the switch provided to render the credential offer as a QR code.

import Step3 from '@site/src/components/AgeVerificationUsecase/Step3';

<Step3
  versionFamily="issueCredential"
  initialVersionKey="version_01"
  initialFormatKey="mso_mdoc"
/>

### Step 4: Receive Attestation (Individual/Holder)

The individual scans the QR code (or opens the `openid-credential-offer://` deeplink) using the [Data Wallet](/docs/data-wallet-overview/) or any other EU Digital Identity Wallet, and receives and stores the age verification attestation.

The issuer can track the issuance lifecycle using the [read credential history API](/docs/openid4vc-api/config-read-digital-wallet-open-id-credential-history) with the `CredentialExchangeId` from Step 3, or alternatively configure [webhooks](/docs/openid4vc-webhooks/) (e.g. the `openid.credential.credential_acked` event) to get notified about issuance lifecycle events.

### Step 5: Create Presentation Definition (Relying Party Admin)

The relying party (e.g. an online service with age-restricted content) creates a presentation definition with a DCQL query requesting the `age_over_18` claim from an `eu.europa.ec.av.1` mdoc. The `label` is the usage purpose shown to the individual when they are asked to share the proof of age. You can request additional `age_over_NN` claims (e.g. `age_over_65` for senior discounts) by adding them to the `claims` array. Run the code block below using the **Run** button. Alternatively, execute the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition). From the API response, copy the `presentationDefinitionId` for use in Step 6.

<Step2
  versionFamily="createPresentationDefinition"
  initialVersionKey="version_01"
  initialFormatKey="mso_mdoc"
  versionLabel="OpenID4VP Version"
/>

<NoteBox title="Tip:" variant="tip">
Once a presentation definition is created, the <code>presentationDefinitionId</code> can be reused to send multiple verification requests (Step 6).
</NoteBox>

### Step 6: Send Verification Request (Relying Party)

The relying party requests a proof of age from the holder. When you run Step 5 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 5 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 5. Run the code block below using the **Run** button. Alternatively, execute the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3). From the API response, note the `presentationExchangeId`. Toggle the switch provided to render the authorisation request as a QR code.

import Step6 from '@site/src/components/AgeVerificationUsecase/Step6';

<Step6
  versionFamily="sendVerificationRequest"
  initialVersionKey="version_01"
  initialFormatKey="mso_mdoc"
/>

### Step 7: Present Proof of Age (Individual/Holder)

The individual scans the QR code (or opens the `openid4vp://` deeplink) with their wallet, reviews the request and consents to share the `age_over_18` claim. With selective disclosure, only the requested boolean claim is revealed; no birthdate or identity attributes are shared.

The relying party can track the verification using the [read verification history API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3) with the `presentationExchangeId` from Step 6, or alternatively configure [webhooks](/docs/openid4vc-webhooks/) (e.g. the `openid.presentation.presentation_acked.v3` event) to get notified when the presentation is completed.


---

# OpenID4VCI - Issue Credential (Deferred)
Source: https://docs.igrant.io/docs/openID4vci-issue-credential-deferred/

---
id: openID4vci-issue-credential-deferred
title: OpenID4VCI - Issue Credential (Deferred)
hide_title: false
description: Create credential definition and issue in-time credentials using OpenID for verifiable credentials (OpenID4VCI) issuance in deferred mode
keywords: [OpenID4VCI, credential issuance, deferred, OID4VCI, verifiable credentials, Organisation Wallet, European Business Wallet, EUDI Wallet, async issuance]
sidebar_label: Issue Credential (Deferred)
slug: /openID4vci-issue-credential-deferred/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';
import NoteBox from '@site/src/components/NoteBox';

In many real-life situations, a credential isn't immediately available when requested, often due to time-consuming business processes happening in the back office. In these cases, deferred issuance is used. Here's how credentials are issued on a deferred basis using OpenID for Verifiable Credentials Issuance (OID4VCI). The process involves the following key stages:

**Create Credential Definition:** This stage consists of two main sub-steps:

  * Define: The credential parameters and rules are established.
  * Prepare: All necessary information and infrastructure are set up for issuing the credential.

**Deferred Issue:** Once the credential definition is created and prepared, the issuance is deferred, allowing for any pending business processes to be completed. The credential will be issued only after authorisation or pre-authorisation is completed (as indicated by the transaction code, Txn_Code).

**Issue Credentials:** After the authorisation step, the credentials can be issued to the holder. At this stage, it's necessary to configure the holder's wallet endpoint to complete the credential transfer.

![Issue credential - Deferred](./images/ow-issue-deferred.png)

The image illustrates this deferred process, where the issuance of the credential happens after a delay, once the back-end processes and authorisation steps have been successfully completed.

### Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from '@site/src/components/ApiKeyManager';

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition). From the API response, copy the `credentialDefinitionId` for use in Step 3. Credentials can be issued in any of the following formats: 
1. [W3C Verifiable Credentials Data Model - JWT](https://www.w3.org/TR/vc-data-model/)
2. [IETF SD-JWT](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-selective-disclosure-jwt) 
3. [ISO/IEC 18013-5:2021 mdoc/mDL](https://www.iso.org/standard/69084.html)

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

import Step2 from '@site/src/components/DeferredIssuance/Step2';

<Step2
  versionFamily="createCredentialDefinition"
  requestBodyOptions={[
    {
      label: "W3C VC (JWT)",
      requestBodyJson: {
        label: "Legal PID (W3C VC) - Deferred",
        type: ["LegalPersonIdentificationData"],
        credentialDefinition: {
          type: "object",
          properties: {
            identifier: {
              type: "string",
            },
            legalName: {
              type: "string",
            },
          },
          required: ["identifier", "legalName"],
        },
        credentialFormat: "jwt_vc_json",
      },
    },
    {
      label: "IETF SD-JWT",
      requestBodyJson: {
        label: "Legal PID (SD-JWT) - Deferred",
        vct: "LegalPersonIdentificationData",
        claims: {
          type: "object",
          properties: {
            // highlight-start
            identifier: {
              type: "string",
              limitDisclosure: true,
            },
            legalName: {
              type: "string",
              limitDisclosure: true,
            },
            // highlight-end
          },
          required: ["identifier", "legalName"],
        },
        credentialFormat: "dc+sd-jwt",
      },
    },
    {
      label: "ISO 18013-5 mdoc/mDL",
      requestBodyJson: {
        label: "Legal PID (mdoc/mDL) - Deferred",
        expirationInDays: 30,
        supportRevocation: true,
        display: {
          name: "org.iso.18013.5.1.lpid",
          description: "LPID (mdoc)",
          backgroundColor: "",
          textColor: "",
        },
        credentialFormat: "mso_mdoc",
        doctype: "org.iso.18013.5.1.lpid",
        claims: {
          type: "object",
          properties: {
            identifier: {
              type: "string",
              limitDisclosure: true,
            },
            legalName: {
              type: "string",
              limitDisclosure: true,
            },
          },
          required: ["identifier", "legalName"],
        },
      },
    },
  ]}
/>

<NoteBox title="Tip:" variant="tip">
Once a credential definition is created, the <code>credentialDefinitionId</code> can be reused to issue multiple credentials (Step 3).
</NoteBox>

### Step 3: Issue Credential (Issuer)

When you run Step 2 on this page, the `credentialDefinitionId` field below is autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` with the ID obtained in Step 2. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `Deferred` issuance mode. Choose the credential format as needed. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

import Step3 from '@site/src/components/DeferredIssuance/Step3';

<Step3 versionFamily="issueCredential" initialJsonData={{
  "issuanceMode": "Deferred",
  "credentialDefinitionId": "<credentialDefinitionId>"
}} />

From the API response, copy the `credentialExchangeId` and the `credential.id` for use in the next step. When you run Step 3 on this page, the **Credential Exchange ID** path parameter in Step 4 is autofilled automatically (and updated whenever Step 3 is re-run). When you run Step 2, the `credential.id` field in Step 4 is autofilled from the `id` in the `credentialDefinitions` array. The `credential.id` corresponds to the `id` field from the `credentialDefinitions` array in the create credential definition response.

### Step 4: Update Credential Offer and Receive (Issuer/Holder)

When you run Steps 2 and 3 on this page, the **Credential Exchange ID** path parameter and the `credential.id` field below are autofilled automatically (and updated whenever those steps are re-run). If you are executing the APIs yourself, use the `credentialExchangeId` from Step 3 as the path parameter and replace `<id>` with the credential `id` from Step 2 or Step 3. Once the request is received and the necessary validations are completed, update the credential offer by executing the code block below using the **Run** button.

Alternatively, you can manually copy the code block, replace the placeholders, and use the `credentialExchangeId` from the response as the path parameter in the API request available [here](/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history).

import Step4 from '@site/src/components/DeferredIssuance/Step4';

<Step4
  versionFamily="updateCredentialOfferAndReceive"
  requestBodyOptions={[
    {
      label: "W3C VC (JWT)",
      requestBodyJson: {
        credential: {
          credentialSubject: {
            identifier: "000",
            legalName: "Bygg AB, Sweden",
          },
        },
      },
    },
    {
      label: "IETF SD-JWT",
      requestBodyJson: {
        credential: {
          claims: {
            identifier: "000",
            legalName: "Bygg AB, Sweden",
          },
        },
      },
    },
    {
      label: "ISO 18013-5 mdoc/mDL",
      requestBodyJson: {
        credential: {
          claims: {
            identifier: "000",
            legalName: "Bygg AB, Sweden",
          },
        },
      },
    },
  ]}
/>

## Try It Yourself (With Demo Video)

Watch the below demo to learn issue credential API and try it out yourselves:

### W3C VC JWT / SD-JWT Credential Format

<VideoPlayer
  videoId="qtsyvw9alb4"
  title="Deferred Credential Issuance Demo"
  description="Learn how to issue credentials in deferred mode using OpenID4VCI protocol with iGrant.io Digital Wallets."
  uploadDate="2024-01-01"
  duration="PT10M"
/>


---

# OpenID4VCI - Dynamic Credential Request
Source: https://docs.igrant.io/docs/openID4vci-issue-dynamic-credential-request/

---
id: openID4vci-issue-dynamic-credential-request
title: OpenID4VCI - Dynamic Credential Request
description: Explore how OpenID4VCI enables dynamic credential requests, ensuring secure issuance and verification of verifiable credentials across digital identity systems.
keywords: [OpenID4VCI, dynamic credential request, OID4VCI, verifiable credentials, Organisation Wallet, European Business Wallet, EUDI Wallet, credential issuance]
hide_title: false
sidebar_label: Dynamic Credential Request
slug: /openID4vci-issue-dynamic-credential-request/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';
import NoteBox from '@site/src/components/NoteBox';

OpenID4VCI based Dynamic Credential Request enable an organisation to request additional proof before issuing a credential. The following steps outline the process for issuing credentials with a dynamic credential request using OpenID for Verifiable Credentials Issuance (OID4VCI). This process is based on [Chapter 5.1.5 of the approved OID4VCI specification](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-ID1.html#section-5.1.5), and is as illustrated below:

![Issue credential - DCR](./images/ow-dynamic-credential-request.png)

**Example workflow scenario**: The Companies Registration Office is issuing a Certificate of Registration to a company. To proceed, the company must provide a Legal Person Identification Data (LPID) credential for verification.

### Prerequisite

The company must have an LPID SD-JWT credential in their wallet. Follow the workflow guide available [here](/docs/openID4vci-issue-credential-intime/) to obtain the LPID credential.

### Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from '@site/src/components/ApiKeyManager';

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create a Presentation Definition (Issuer)

The Companies Registration Office creates a presentation definition to specify the verification requirements. Execute the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition). From the API response, copy the `presentationDefinitionId` for use in Step 4.

import Step2 from '@site/src/components/DynamicCredentialRequest/Step2';

<Step2
  versionFamily="createPresentationDefinition"
  initialVersionKey="version_01"
  initialFormatKey="w3c_jwt"
/>

<NoteBox title="Tip:" variant="tip">
Once a presentation definition is created, the <code>presentationDefinitionId</code> can be reused to issue multiple credentials (Step 4).
</NoteBox>

### Step 3: Create a Credential Definition (Issuer)

The Companies Registration Office defines the structure of the Certificate of Registration. Execute the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition). From the API response, copy the `credentialDefinitionId` for use in Step 4. Credentials can be issued in any of the following formats: 
1. [W3C Verifiable Credentials Data Model - JWT](https://www.w3.org/TR/vc-data-model/)
2. [IETF SD-JWT](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-selective-disclosure-jwt) 
3. [ISO/IEC 18013-5:2021 mdoc/mDL](https://www.iso.org/standard/69084.html)

import Step3 from '@site/src/components/DynamicCredentialRequest/Step3';

<Step3
  versionFamily="createCredentialDefinition"
  initialVersionKey="version_01"
  initialFormatKey="w3c_jwt"
/>

<NoteBox title="Tip:" variant="tip">
Once a credential definition is created, the <code>credentialDefinitionId</code> can be reused to issue multiple credentials (Step 4).
</NoteBox>

### Step 4: Issue and Receive Credential (Issuer/Holder)

When you run Steps 2 and 3 on this page, the `credentialDefinitionId` and `presentationDefinitionId` fields below are autofilled automatically (and updated whenever those steps are re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<presentationDefinitionId>` with the IDs obtained in Steps 2 and 3. The Companies Registration Office proceeds to issue the Certificate of Registration immediately or **InTime**. You can run the JSON code block below using the **Run** button.

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

import Step4 from '@site/src/components/DynamicCredentialRequest/Step4';

<Step4
  versionFamily="issueCredential"
  initialVersionKey="version_01"
  initialFormatKey="w3c_jwt"
/>

<NoteBox title="Info:">
For deferred credential issuance, follow the guide <a href="/docs/openID4vci-issue-credential-deferred/">here</a>.
</NoteBox>

### Try It Yourself (With Demo Video)

Watch the below demo to learn issue credential API and try it out yourselves:

<VideoPlayer
  videoId="lForfQ3xWcQ"
  title="Dynamic Credential Request Demo"
  description="Learn how to implement dynamic credential requests using OpenID4VCI protocol with iGrant.io Digital Wallets."
  uploadDate="2024-01-01"
  duration="PT10M"
/>

---

# OpenID4VCI - Issue Credential (In-Time)
Source: https://docs.igrant.io/docs/openID4vci-issue-credential-intime/

---
id: openID4vci-issue-credential-intime
title: OpenID4VCI - Issue Credential (In-Time)
hide_title: false
description: Create credential definition and issue in-time credentials using OpenID for verifiable credentials issuance - Try OpenID4VCI with iGrant.io Digital Wallets.
keywords: [OpenID4VCI, credential issuance, in-time, OID4VCI, verifiable credentials, Organisation Wallet, European Business Wallet, EUDI Wallet, SD-JWT]
sidebar_label: Issue Credential (In-Time)
slug: /openID4vci-issue-credential-intime/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';
import NoteBox from '@site/src/components/NoteBox';

InTime issuance of credentials (or immediately) using OpenID for Verifiable Credentials Issuance (OID4VCI) involves two main stages: the creation of a credential definition and the in-time issuance of the credential.

**Create Credential Definition:** This involves the following sub-steps as illustrated:

* **Define**: Establish the parameters and rules for the credential.
* **Prepare**: Set up the necessary infrastructure and information for issuing the credential.

**InTime Issue:** The credentials are issued after either being authorised or pre-authorised (as indicated by the transaction code, Txn_Code). Before issuing, the holder's wallet endpoint must be configured.

![Issue credential - in-Time](./images/ow-issue-in-time.png)

The image illustrates this process, showing how the credential definition is linked to the in-time issuance mechanism. The flow moves from defining and preparing the credential to an authorised issuance step, where the credential can be configured and issued to the holder's wallet. Here are the steps to follow:  

### Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from '@site/src/components/ApiKeyManager';

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition). From the API response, copy the `credentialDefinitionId` for use in Step 3. Credentials can be issued in any of the following formats: 
1. [W3C Verifiable Credentials Data Model - JWT](https://www.w3.org/TR/vc-data-model/)
2. [IETF SD-JWT](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-selective-disclosure-jwt) 
3. [ISO/IEC 18013-5:2021 mdoc/mDL](https://www.iso.org/standard/69084.html)

import Step2 from '@site/src/components/InTimeIssuance/Step2';

<Step2
  versionFamily="createCredentialDefinition"
  requestBodyOptions={[
    {
      label: "W3C VC (JWT)",
      requestBodyJson: {
        label: "Legal PID (W3C VC)",
        type: ["LegalPersonIdentificationData"],
        credentialDefinition: {
          type: "object",
          properties: {
            identifier: {
              type: "string",
            },
            legalName: {
              type: "string",
            },
          },
          required: ["identifier", "legalName"],
        },
        credentialFormat: "jwt_vc_json",
      },
    },
    {
      label: "IETF SD-JWT",
      requestBodyJson: {
        label: "Legal PID (SD-JWT)",
        vct: "LegalPersonIdentificationData",
        claims: {
          type: "object",
          properties: {
            // highlight-start
            identifier: {
              type: "string",
              limitDisclosure: true,
            },
            legalName: {
              type: "string",
              limitDisclosure: true,
            },
            // highlight-end
          },
          required: ["identifier", "legalName"],
        },
        credentialFormat: "dc+sd-jwt",
      },
    },
    {
      label: "ISO/IEC 18013-5 mdoc/mDL",
      requestBodyJson: {
        label: "Legal PID (mdoc/mDL)",
        expirationInDays: 30,
        supportRevocation: true,
        display: {
          name: "org.iso.18013.5.1.lpid",
          description: "LPID (mdoc)",
          backgroundColor: "",
          textColor: "",
        },
        credentialFormat: "mso_mdoc",
        doctype: "org.iso.18013.5.1.lpid",
        claims: {
          type: "object",
          properties: {
            identifier: {
              type: "string",
              limitDisclosure: true,
            },
            legalName: {
              type: "string",
              limitDisclosure: true,
            },
          },
          required: ["identifier", "legalName"],
        },
      },
    },
  ]}
/>

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

**Credential category:** each entry of `credentialDefinitions` can have a `credentialCategory`: `pid`, `eaa`, `qeaa`, `pub-eaa`, or `none` (the default, no rule). With a category, the wallet checks that the certificate of the signing key of the entry fits the category, and refuses a key that does not fit with `400` and `errorType` `signing_key_does_not_fit`. An mDL (doctype `org.iso.18013.5.1.mDL`) needs a key with the ISO/IEC 18013-5 Document Signer profile, whatever its category. Each answer shows the result of the check in `signingKeyCheck`. When the category is `none` and the entry is a PID whose key fits, `suggestedCredentialCategory` is `pid`. For a QEAA and a PuB-EAA, the issuer adds the EAA category of ETSI TS 119 472-1 to each credential. For the categories, their certificate rules and the key usage types, see [Credential Categories and Key Usage Types](/docs/openid4vc-key-management/#credential-categories-and-key-usage-types).

<NoteBox title="Tip:" variant="tip">
Once a credential definition is created, the <code>credentialDefinitionId</code> can be reused to issue multiple credentials (Step 3).
</NoteBox>

### Step 3: Issue and Receive Credential (Issuer/Holder)

When you run Step 2 on this page, the `credentialDefinitionId` field below is autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` with the ID obtained in Step 2. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Choose the credential format as needed. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

import Step3 from '@site/src/components/InTimeIssuance/Step3';

<Step3
  versionFamily="issueCredential"
  requestBodyOptions={[
    {
      label: "W3C VC (JWT)",
      requestBodyJson: {
        issuanceMode: "InTime",
        credentialDefinitionId: "<credentialDefinitionId>",
        credential: {
          // highlight-start
          credentialSubject: {
            identifier: "000",
            legalName: "Bygg AB, Sweden",
          },
          // highlight-end
        },
      },
    },
    {
      label: "IETF SD-JWT",
      requestBodyJson: {
        issuanceMode: "InTime",
        credentialDefinitionId: "<credentialDefinitionId>",
        credential: {
          // highlight-start
          claims: {
            identifier: "000",
            legalName: "Bygg AB, Sweden",
          },
          // highlight-end
        },
      },
    },
    {
      label: "ISO 18013-5 mdoc/mDL",
      requestBodyJson: {
        issuanceMode: "InTime",
        credentialDefinitionId: "<credentialDefinitionId>",
        credential: {
          // highlight-start
          claims: {
            identifier: "000",
            legalName: "Bygg AB, Sweden",
          },
          // highlight-end
        },
      },
    },
  ]}
/>

Alternatively, you can manually copy the code block, update the placeholders, and use it in the body of the API request available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential/). From the response received, copy the `credentialOffer` and generate a QR code using a QR code generator tool, or paste the response into our tool [here](/docs/devtools-qrcode-generator/). The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device (e.g., in a browser).

## Try It Yourself (With Demo Video)

Watch the below demo to learn issue credential API and try it out yourselves:

### W3C VC JWT Credential Format

<VideoPlayer
  videoId="EiMh7YZu1IQ"
  title="W3C VC JWT Credential Format Demo"
  description="Learn how to issue W3C Verifiable Credentials (JWT) using OpenID4VCI protocol with iGrant.io Digital Wallets."
  uploadDate="2024-01-01"
  duration="PT10M"
/>

### ISO/IEC 18013-5 mdoc/mDL Credential Format

<VideoPlayer
  videoId="Ri0YymoiVwk"
  title="ISO/IEC 18013-5 mdoc/mDL Credential Format Demo"
  description="Learn how to issue ISO/IEC 18013-5 mdoc/mDL credentials using OpenID4VCI protocol with iGrant.io Digital Wallets."
  uploadDate="2024-01-01"
  duration="PT10M"
/>

### IETF SD-JWT Credential Format

_Will be published soon_

---

# Key Management - Signing Keys and Certificates
Source: https://docs.igrant.io/docs/openid4vc-key-management/

---
id: openid4vc-key-management
title: Key Management - Signing Keys and Certificates
hide_title: false
description: Keep the signing keys of your organisation in the key store of your choice, give them X.509 certificates that wallets trust, and choose the right certificate for each credential category.
keywords: [key management, signing key, key store, OpenBao, HashiCorp Vault, Google Cloud KMS, AWS KMS, Azure Key Vault, Thales Luna Cloud HSM, DPoD, HSM, QTSP, CSC API, CSR, certificate preset, WRPAC, mdoc Document Signer, built-in test CA, X.509 certificate, certificate chain, x5c, trust list, credential category, key usage type, Organisation Wallet, EUDI Wallet]
sidebar_label: Key Management
slug: /openid4vc-key-management/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import { ApiKeyManager } from '@site/src/components/ApiKeyManager';
import DcqlStepTemplate from '@site/src/components/DCQL/DcqlStepTemplate';
import { refreshOrganisationKeys } from '@site/src/hooks/useOrganisationSigningKey';
import { PRESET_REQUESTS } from '@site/src/data/keyManagementPresetRequests';

export const KEY_STORE_ADDED_EVENT = 'keyManagement:keyStoreAdded';
export const KEY_CREATED_EVENT = 'keyManagement:keyCreated';

export const EXAMPLE_KEY_ID = '3f2a91c47b8d4e6fa0c5d7e18b924f30';
export const EXAMPLE_KEY_STORE_ID = '8c1f4e2a-6b3d-4f5e-9a7c-2d1e0f3b4a59';
export const EXAMPLE_TIME = '2026-10-22T09:30:00Z';

export const OPENBAO_STORE = {
  type: 'vault',
  provider: 'openbao',
  name: 'Customer OpenBao',
  settings: {
    address: 'https://openbao.example.com:8200',
    transitMount: 'transit',
    authentication: { method: 'approle', roleId: 'c3f1e0a2-7b4d-4e9f-8a6c-1d2e3f4a5b6c' },
  },
  credentials: { secretId: '<yourSecretId>' },
};

export const HASHICORP_STORE = {
  type: 'vault',
  provider: 'hashicorp-vault',
  name: 'Customer vault',
  settings: {
    address: 'https://vault.example.com:8200',
    transitMount: 'transit',
    authentication: { method: 'userpass', username: 'wallet' },
  },
  credentials: { password: '<yourPassword>' },
};

export const GCP_STORE = {
  type: 'gcp-kms',
  provider: 'google-cloud-kms',
  name: 'Google Cloud KMS',
  settings: { project: 'example-project', location: 'europe-west1', keyRing: 'ows-signing', protectionLevel: 'HSM' },
  credentials: { serviceAccountKey: '<the text of the JSON key file of the service account>' },
};

export const AWS_STORE = {
  type: 'aws-kms',
  provider: 'aws-kms',
  name: 'AWS KMS',
  settings: { region: 'eu-central-1', authentication: { method: 'accessKey' } },
  credentials: { accessKeyId: '<yourAccessKeyId>', secretAccessKey: '<yourSecretAccessKey>' },
};

export const AZURE_STORE = {
  type: 'azure-key-vault',
  provider: 'azure-key-vault',
  name: 'Azure Key Vault',
  settings: {
    vaultUrl: 'https://example-vault.vault.azure.net',
    tenantId: '9b2e6c1d-4f3a-4e8b-a7d5-0c1f2e3d4b5a',
    clientId: '1e7d3c9b-5a2f-4b6e-8d0c-7f4a1b2c3d4e',
    keyType: 'EC-HSM',
    authentication: { method: 'clientSecret' },
  },
  credentials: { clientSecret: '<yourClientSecret>' },
};

export const DPOD_STORE = {
  type: 'dpod',
  provider: 'thales-dpod',
  name: 'Thales Luna Cloud HSM',
  settings: { tokenLabel: 'ows-signing', serialNumber: null },
  credentials: {
    authTokenConfigUri: '<AuthTokenConfigURI>',
    authTokenClientId: '<AuthTokenClientId>',
    authTokenClientSecret: '<AuthTokenClientSecret>',
    pin: '<yourCryptoOfficerPin>',
  },
};

export const INTESI_STORE = {
  type: 'csc',
  provider: 'intesi',
  name: 'Intesi Group',
  settings: { cscUrl: 'https://services.test4mind.com', apiVersion: 'v1', clientId: 'example-client', userId: 'example-user' },
  credentials: { clientSecret: '<yourClientSecret>', userPin: '<yourUserPin>' },
};

export const keyStoreResponse = (request, protection, credentialsConfigured) => ({
  id: EXAMPLE_KEY_STORE_ID,
  type: request.type,
  provider: request.provider,
  name: request.name,
  status: 'active',
  protection,
  settings: request.settings,
  credentialsConfigured,
  lastCheckResult: { ok: true, message: null, checkedAt: EXAMPLE_TIME },
  createdAt: EXAMPLE_TIME,
});

export const EXAMPLE_JWK = {
  kty: 'EC',
  crv: 'P-256',
  x: 'f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU',
  y: 'x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0',
  kid: EXAMPLE_KEY_ID,
  alg: 'ES256',
};

export const EXAMPLE_JWK_WITH_CHAIN = {
  ...EXAMPLE_JWK,
  x5c: ['MIICLzCCAdWgAwIBAgIUX2b7...', 'MIIB9TCCAZugAwIBAgIUa1c4...'],
  x5t: 'Pc9qa0x1tWfGqFOAPfUzjgKCOyk',
  'x5t#S256': '3T1jzz8BK8b6vrTVo2C5sm8Ehb0cDcnfjVEHg9ZJ7ZM',
  x5c_expiry: '2027-10-22T09:30:00Z',
};

export const exampleKey = (changes = {}) => ({
  keyId: EXAMPLE_KEY_ID,
  name: 'PID issuance 2026',
  keyStore: { id: 'local-openbao', type: 'local', name: 'Local vault' },
  origin: 'created',
  algorithm: 'ES256',
  isDefault: false,
  jwk: EXAMPLE_JWK,
  hasCertificateChain: false,
  certificateSource: null,
  testCertificate: false,
  certificatePreset: null,
  createdAt: EXAMPLE_TIME,
  ...changes,
});

export const referencedKey = (keyStore, name, changes = {}) =>
  exampleKey({ name, keyStore: { id: EXAMPLE_KEY_STORE_ID, ...keyStore }, origin: 'referenced', ...changes });

export const csrResponse = (preset) => ({
  csr: '-----BEGIN CERTIFICATE REQUEST-----\nMIIBSzCB8gIBADBVMQswCQYDVQQGEwJTRTETMBEGA1UECgwKRXhhbXBsZSBBQjEx...\n-----END CERTIFICATE REQUEST-----\n',
  csrId: '5e1c2f7a-8b3d-4c6e-9f0a-1b2c3d4e5f60',
  preset,
  warnings: [],
});

export const testCertificateResponse = (preset) => ({
  key: exampleKey({
    jwk: EXAMPLE_JWK_WITH_CHAIN,
    hasCertificateChain: true,
    certificateSource: 'test-ca',
    testCertificate: true,
    certificatePreset: preset,
  }),
  warnings: [
    {
      code: 'test-certificate',
      message:
        'Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production.',
    },
  ],
  affectedCredentialConfigurations: [],
});

export const CSR_PRESET_OPTIONS = PRESET_REQUESTS.map((preset) => ({
  value: preset.id,
  label: preset.label,
  description: preset.description,
  json: preset.body,
  exampleResponse: csrResponse(preset.id),
}));

export const TEST_CERTIFICATE_PRESET_OPTIONS = PRESET_REQUESTS.map((preset) => ({
  value: preset.id,
  label: preset.label,
  description: preset.description,
  json: { ...preset.body, validityDays: preset.validityDays },
  exampleResponse: testCertificateResponse(preset.id),
}));

The Organisation Wallet Suite signs everything that your organisation sends to wallets with your own keys: credentials, status lists, verification requests and signed issuer metadata. This guide explains where the keys can be kept, how to give a key a certificate that wallets trust, and which certificate each credential needs. For every field and response, see the [Key Management API reference](/docs/category/openid4vc-api/key-management).

## Signing Keys, Key Stores and Certificates

- **Signing key:** the key that signs on behalf of your organisation.
- **Key store:** where the private key is kept. The private key never leaves the key store, and the API only returns public keys.
- **Certificate:** an X.509 certificate from a certificate authority (CA) that ties the key to your organisation. A key with a certificate chain signs with the `x509` format. Each signature carries the chain (`x5c`), and wallets check it against a trust list. If the list has your certificate or its CA, the wallet shows your organisation as trusted.

A key without a certificate signs with `did:key`, which is for tests only. mdoc credentials (`mso_mdoc`) always need `x509`.

### Certificate Presets

When you request a certificate, you choose a preset: a template for the certificate signing request (CSR) that matches what the key will sign.

| What the key signs | Preset |
|---|---|
| PID, EAA, QEAA or PuB-EAA credentials | The preset of the credential category: `pid-provider`, `eaa-provider`, `qeaa-provider` or `pub-eaa-provider` |
| mdoc credentials without a category, such as an mDL | `mdoc-document-signer` |
| SD-JWT VC or W3C VC credentials, and signed issuer metadata, from an issuer outside the EU trusted lists | `credential-issuer` |
| Status lists | `status-list-signer`, or `mdoc-status-list-signer` for mdoc credentials that a Document Signer signs |
| Verification requests in the EU | `wrpac-legal`, or `wrpac-natural` for a verifier who is a natural person |
| Signed issuer metadata in the EU | `wrpac-legal` |
| Verification requests outside the EU | `request-signer-san-dns` for the client identifier prefix `x509_san_dns`, or `mdoc-reader` for ISO/IEC 18013-7 Annex C |
| Wallet instance attestations (WIA) and key attestations (KA) | `wallet-provider`, and `wallet-status-list-signer` for their status lists |
| Anything else | `custom` |

A status list without a key of its own is signed with the credential signing key. Use a separate key for each purpose: the API warns you (`purpose-reuse`) when you request a certificate for a different purpose than the key already has. The [List Certificate Presets](/docs/openid4vc-api/config-digital-wallet-open-id-list-certificate-presets/) API gives the fixed values, the required fields and the standards of each preset. The certificate that a credential needs depends on its category: see [Credential Categories and Key Usage Types](#credential-categories-and-key-usage-types).

### Key Store Types

Every organisation starts with the local vault. Add another key store when your keys must stay in your own vault, cloud KMS or HSM, or with a qualified trust service provider.

| Key store | What it is | Use it when |
|---|---|---|
| Local vault (`local`) | The key store of the installation. Every organisation has it, and new keys go there by default. | You are happy for the platform to hold your keys. |
| External vault (`vault`) | Your OpenBao or HashiCorp Vault, with the Transit secrets engine. | Your keys must stay in your own vault. |
| Google Cloud KMS (`gcp-kms`) | A key ring in your Google Cloud project. | Your keys must stay in Google Cloud. |
| AWS KMS (`aws-kms`) | AWS KMS in one region of your AWS account. | Your keys must stay in AWS. |
| Azure Key Vault (`azure-key-vault`) | Your Azure key vault or managed HSM. | Your keys must stay in Azure. |
| Thales Luna Cloud HSM (`dpod`) | A partition of your Thales Luna Cloud HSM service (Thales Data Protection on Demand, DPoD). | You want your keys in a dedicated HSM partition. |
| Remote signing (`csc`) | A remote signing service with the Cloud Signature Consortium (CSC) API: a qualified trust service provider (QTSP) such as Intesi Group, or another CSC-compatible provider. The key and its certificate stay with the provider. | You sign with QTSP keys, for example for qualified electronic seals. |

You can add one key store for each provider. Your installation may not offer every type: the dashboard and the [List Key Store Types](/docs/openid4vc-api/config-digital-wallet-open-id-list-key-store-types/) API show the ones that are available to you. For on-premise installations, see [Organisation key stores](/docs/organisation-wallet-on-premise-deployment/#organisation-key-stores).

**Qualified keys:** for keys held by a QTSP, the wallet checks the certificate against the EU trusted lists when you add the key and at each connection test. If the certificate is qualified and the key is in a qualified signature or seal creation device (QSCD), the dashboard shows the badge **Qualified**. Other CSC providers never get this badge.

<a id="tasks"></a>
<a id="step-1-get-the-api-key-admin"></a>

## Step 1: Get the API Key {#get-the-api-key}

The steps below show a request and an example response. Enter your API key to run them against your organisation: each **Run** replaces the example with the real response. A request with an ID in its path, such as `keyStoreId` or `keyId`, has a field for it above the request: the step that returns the ID fills it in, or you can paste one. To get an API key, see [Get API Keys](/docs/developer-apis/get-started/).

<ApiKeyManager />

In the dashboard, key management starts at **Issuer & Verifier** > **Base Configurations** > **Key Management and Signing** > **Configure**. Sandbox organisations use the key stores and keys of their main organisation, and cannot change them.

<a id="step-2-configure-the-secure-vaults-admin"></a>

## Step 2: Add a Key Store (optional) {#add-a-key-store}

You need this step only when your keys must be kept outside the local vault.

1. Check which providers you can add with [List Key Store Types](/docs/openid4vc-api/config-digital-wallet-open-id-list-key-store-types/).
2. Add the key store with [Create Key Store](/docs/openid4vc-api/config-digital-wallet-open-id-create-key-store/): its type, provider, settings and credentials. Select an example, replace the values with your own, and run it. The API reference shows every field for each type.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/key-stores"
  method="POST"
  jsonOptionLabel="Key store"
  jsonOptions={[
    {
      value: 'openbao',
      label: 'OpenBao, AppRole',
      json: OPENBAO_STORE,
      exampleResponse: keyStoreResponse(OPENBAO_STORE, 'software', {
        password: false,
        secretId: true,
        token: false,
        clientPrivateKey: false,
      }),
    },
    {
      value: 'hashicorp-vault',
      label: 'HashiCorp Vault, user name and password',
      json: HASHICORP_STORE,
      exampleResponse: keyStoreResponse(HASHICORP_STORE, 'software', {
        password: true,
        secretId: false,
        token: false,
        clientPrivateKey: false,
      }),
    },
    {
      value: 'gcp-kms',
      label: 'Google Cloud KMS',
      json: GCP_STORE,
      exampleResponse: keyStoreResponse(GCP_STORE, 'hsm-backed', { serviceAccountKey: true }),
    },
    {
      value: 'aws-kms',
      label: 'AWS KMS',
      json: AWS_STORE,
      exampleResponse: keyStoreResponse(AWS_STORE, 'hsm-backed', { accessKeyId: true, secretAccessKey: true }),
    },
    {
      value: 'azure-key-vault',
      label: 'Azure Key Vault',
      json: AZURE_STORE,
      exampleResponse: keyStoreResponse(AZURE_STORE, 'hsm-backed', {
        clientSecret: true,
        clientCertificate: false,
        clientPrivateKey: false,
      }),
    },
    {
      value: 'dpod',
      label: 'Thales Luna Cloud HSM (DPoD)',
      json: DPOD_STORE,
      exampleResponse: keyStoreResponse(DPOD_STORE, 'dedicated-hsm', {
        authTokenConfigUri: true,
        authTokenClientId: true,
        authTokenClientSecret: true,
        pin: true,
      }),
    },
    {
      value: 'intesi',
      label: 'Intesi Group (QTSP)',
      json: INTESI_STORE,
      exampleResponse: keyStoreResponse(INTESI_STORE, 'provider', { clientSecret: true, userPin: true }),
    },
  ]}
  emitResultEvent={KEY_STORE_ADDED_EVENT}
  extractResultEvent={(result) => (result?.id ? { keyStoreId: result.id } : null)}
/>

3. The wallet tests the connection and saves the key store only if the test passes. You can repeat the test at any time with [Test Key Store](/docs/openid4vc-api/config-digital-wallet-open-id-test-key-store/). A failed test still returns `200`, with `ok` set to `false` and the reason in `message`.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/key-stores/{keyStoreId}/test"
  method="POST"
  listenPathParamsEvent={KEY_STORE_ADDED_EVENT}
  noRequestBody
  exampleResponse={{ ok: true, message: null, checkedAt: EXAMPLE_TIME }}
/>

In the dashboard, choose **Configure** next to the provider. **Test Connection** runs the test again.

Credentials are write-only and never returned. To change a key store, use [Update Key Store](/docs/openid4vc-api/config-digital-wallet-open-id-update-key-store/): credentials that you leave out are kept, and the provider cannot change. To remove a key store, delete its keys first and then use [Delete Key Store](/docs/openid4vc-api/config-digital-wallet-open-id-delete-key-store/). The wallet never deletes keys that your provider holds.

<details>
<summary>Rights for a cloud KMS</summary>

Give the account of the wallet only the rights that it needs. The wallet lists keys, reads public keys and signs. It creates a key only when you ask it to, and it never deletes, disables or rotates a key. A missing right shows up as `The connection test failed: Key management service refused the request`.

| Cloud KMS | Rights |
|---|---|
| Google Cloud KMS (service account with a JSON key) | On the key ring: `roles/cloudkms.viewer` and `roles/cloudkms.signerVerifier`. To create keys, also `cloudkms.cryptoKeys.create`. Of the predefined roles, only `roles/cloudkms.admin` has it, and that role can also destroy keys, so use a [custom role](https://cloud.google.com/iam/docs/creating-custom-roles). |
| AWS KMS (IAM user with an access key) | `kms:ListKeys`, plus `kms:DescribeKey`, `kms:GetPublicKey` and `kms:Sign` on the keys. To create keys, also `kms:CreateKey`, and `kms:CreateAlias` on the aliases `alias/ows-*`. For a key that you reference, the key policy must allow `kms:DescribeKey`, `kms:GetPublicKey` and `kms:Sign`, or allow the IAM policies of the account. |
| Azure Key Vault (app registration with a client secret or a client certificate) | With Azure RBAC: **Key Vault Crypto Officer** to create keys, or **Key Vault Crypto User** to use existing keys only. With access policies: the key permissions Get, List and Sign, plus Create to create keys. For a managed HSM: **Managed HSM Crypto User**. |

</details>

<details>
<summary>Thales Luna Cloud HSM (DPoD)</summary>

1. In DPoD, create the Luna Cloud HSM service and download its service client package ([add and configure a client](https://thalesdocs.com/dpod/services/luna_cloud_hsm/client/configure/index.html)).
2. Initialise the partition and the Crypto Officer role with `lunacm` from the package, as described in the [DPoD documentation](https://thalesdocs.com/dpod/services/luna_cloud_hsm/index.html).
3. Copy `AuthTokenConfigURI`, `AuthTokenClientId` and `AuthTokenClientSecret` from `Chrystoki.conf` in the package. In the dashboard, **Fill In from Chrystoki.conf** reads them from the file in your browser, without sending the file.
4. Add the key store with the partition label, these three values and the Crypto Officer PIN.

New keys are created in the partition as key pairs that cannot be extracted, with the label `ows:<keyId>`.

<NoteBox title="PIN:" variant="caution">
The partition locks after too many wrong PINs. The platform tries each PIN only once: after a wrong PIN, it waits until you send a new one with <a href="/docs/openid4vc-api/config-digital-wallet-open-id-update-key-store/">Update Key Store</a>. Check the PIN before you send it.
</NoteBox>

</details>

<a id="step-3-create-a-key-admin"></a>

## Step 3: Create a Key {#create-a-key}

Call [Create Key](/docs/openid4vc-api/config-digital-wallet-open-id-create-key/). Without `keyStoreId`, the key goes into the local vault. Add `keyStoreId` to use a key store that you added, and a `name` that says what the key is for. The `keyId` in the response fills in the next steps.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys"
  method="POST"
  jsonOptionLabel="Key store"
  jsonOptions={[
    {
      value: 'local',
      label: 'Local vault',
      json: { name: 'PID issuance 2026' },
    },
    {
      value: 'added',
      label: 'A key store that you added',
      json: { keyStoreId: EXAMPLE_KEY_STORE_ID, name: 'PID issuance 2026' },
      exampleResponse: {
        keyId: EXAMPLE_KEY_ID,
        jwk: EXAMPLE_JWK,
        key: exampleKey({ keyStore: { id: EXAMPLE_KEY_STORE_ID, type: 'vault', name: 'Customer OpenBao' } }),
      },
    },
  ]}
  exampleResponse={{ keyId: EXAMPLE_KEY_ID, jwk: EXAMPLE_JWK, key: exampleKey() }}
  emitResultEvent={KEY_CREATED_EVENT}
  extractResultEvent={(result) => (result?.keyId ? { keyId: result.keyId } : null)}
  onSuccess={refreshOrganisationKeys}
/>

New keys are ECDSA P-256 keys (`ES256`) that cannot be exported. Every key store type except remote signing (`csc`) can create keys. In the dashboard, choose **View Keys** on a key store, then **Create Signing Key**.

## Step 4: Reference or Import a Key (instead of Step 3) {#reference-or-import-a-key}

**Use a key that your provider already has.** Find its `providerKeyRef` with [List Provider Keys](/docs/openid4vc-api/config-digital-wallet-open-id-list-provider-keys/), which also shows each public key (`jwk`), so you can match it against your console. Then call [Create Key](/docs/openid4vc-api/config-digital-wallet-open-id-create-key/) with `keyStoreId` and `providerKeyRef`. A QTSP key comes with its certificate, so you can skip Step 5. In the dashboard, this is **Add Existing Key**.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys"
  method="POST"
  jsonOptionLabel="Key store"
  jsonOptions={[
    {
      value: 'vault',
      label: 'External vault (OpenBao or HashiCorp Vault): Transit key name',
      json: { keyStoreId: EXAMPLE_KEY_STORE_ID, providerKeyRef: 'pid-issuance-2026', name: 'PID issuance 2026' },
      exampleResponse: { keyId: EXAMPLE_KEY_ID, jwk: EXAMPLE_JWK, key: referencedKey({ type: 'vault', name: 'Customer OpenBao' }, 'PID issuance 2026') },
    },
    {
      value: 'gcp-kms',
      label: 'Google Cloud KMS: crypto key version',
      json: {
        keyStoreId: EXAMPLE_KEY_STORE_ID,
        providerKeyRef: 'projects/example-project/locations/europe-west1/keyRings/ows-signing/cryptoKeys/pid-issuance/cryptoKeyVersions/1',
        name: 'PID issuance 2026',
      },
      exampleResponse: { keyId: EXAMPLE_KEY_ID, jwk: EXAMPLE_JWK, key: referencedKey({ type: 'gcp-kms', name: 'Google Cloud KMS' }, 'PID issuance 2026') },
    },
    {
      value: 'aws-kms',
      label: 'AWS KMS: key ARN',
      json: {
        keyStoreId: EXAMPLE_KEY_STORE_ID,
        providerKeyRef: 'arn:aws:kms:eu-central-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        name: 'PID issuance 2026',
      },
      exampleResponse: { keyId: EXAMPLE_KEY_ID, jwk: EXAMPLE_JWK, key: referencedKey({ type: 'aws-kms', name: 'AWS KMS' }, 'PID issuance 2026') },
    },
    {
      value: 'azure-key-vault',
      label: 'Azure Key Vault: key ID with its version',
      json: {
        keyStoreId: EXAMPLE_KEY_STORE_ID,
        providerKeyRef: 'https://example-vault.vault.azure.net/keys/pid-issuance/0f3c6a9e2b7d4c1a8e5f2b9d6c3a0e7f',
        name: 'PID issuance 2026',
      },
      exampleResponse: { keyId: EXAMPLE_KEY_ID, jwk: EXAMPLE_JWK, key: referencedKey({ type: 'azure-key-vault', name: 'Azure Key Vault' }, 'PID issuance 2026') },
    },
    {
      value: 'dpod',
      label: 'Thales Luna Cloud HSM (DPoD): key pair label',
      json: { keyStoreId: EXAMPLE_KEY_STORE_ID, providerKeyRef: 'ows:pid-issuance-2026', name: 'PID issuance 2026' },
      exampleResponse: { keyId: EXAMPLE_KEY_ID, jwk: EXAMPLE_JWK, key: referencedKey({ type: 'dpod', name: 'Thales Luna Cloud HSM' }, 'PID issuance 2026') },
    },
    {
      value: 'csc',
      label: 'QTSP: CSC credential ID',
      json: { keyStoreId: EXAMPLE_KEY_STORE_ID, providerKeyRef: '8f14e45f-ceea-467a-9575-1c2b6a3d5e7f', name: 'Qualified seal' },
      exampleResponse: {
        keyId: EXAMPLE_KEY_ID,
        jwk: EXAMPLE_JWK_WITH_CHAIN,
        key: referencedKey({ type: 'csc', name: 'Intesi Group' }, 'Qualified seal', {
          jwk: EXAMPLE_JWK_WITH_CHAIN,
          hasCertificateChain: true,
          certificateSource: 'qtsp',
          trust: { status: 'qualified', checkedAt: EXAMPLE_TIME },
        }),
      },
    },
  ]}
  emitResultEvent={KEY_CREATED_EVENT}
  extractResultEvent={(result) => (result?.keyId ? { keyId: result.keyId } : null)}
  onSuccess={refreshOrganisationKeys}
/>

**Import a key that you already have.** Use [Import Key](/docs/openid4vc-api/config-digital-wallet-open-id-import-key/) with a password-protected P-256 private key: a PKCS#12 file (`.p12` or `.pfx`) or an encrypted PKCS#8 key in PEM (`BEGIN ENCRYPTED PRIVATE KEY`). If the file also holds the certificate chain, the key can sign with `x509` straight away. You can import into an external vault, and into the local vault when it is backed by OpenBao. Cloud KMS and HSM key stores do not accept imported keys. In the dashboard, this is **Import Key**.

The import is a file upload (`multipart/form-data`), so the request is shown with curl:

```bash
read -rs KEY_PASSWORD   # the password of the file; the terminal does not show it
curl -X POST "https://demo-api.igrant.io/v2/config/digital-wallet/openid/key-management/keys/import" \
  -H "Authorization: ApiKey $API_KEY" \
  -F "file=@key.p12" \
  --form-string "password=$KEY_PASSWORD" \
  -F "name=PID issuance 2026"
```

Example response (`201`):

```json
{
  "keyId": "3f2a91c47b8d4e6fa0c5d7e18b924f30",
  "name": "PID issuance 2026",
  "keyStore": { "id": "local-openbao", "type": "local", "name": "Local vault" },
  "origin": "imported",
  "algorithm": "ES256",
  "isDefault": false,
  "jwk": {
    "kty": "EC",
    "crv": "P-256",
    "x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
    "y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0",
    "kid": "3f2a91c47b8d4e6fa0c5d7e18b924f30",
    "alg": "ES256",
    "x5c": ["MIICLzCCAdWgAwIBAgIUX2b7...", "MIIB9TCCAZugAwIBAgIUa1c4..."],
    "x5c_expiry": "2027-10-22T09:30:00Z"
  },
  "hasCertificateChain": true,
  "certificateSource": "imported",
  "createdAt": "2026-10-22T09:30:00Z"
}
```

<NoteBox title="Partition full (507):" variant="info">
If the HSM partition behind a key store has no room for another key, the request fails with <code>507</code>. The response has no <code>Retry-After</code>, and a retry fails in the same way until there is room. For your own DPoD partition, remove unused key pairs or add capacity, then try again. If the local vault of your installation uses an HSM, contact the operator of your installation. Any request that creates a key can return this response, including test certificates, test CAs, the deployment of the organisation wallet, the creation of a sandbox organisation and the OpenID Conformance extension.
</NoteBox>

<a id="step-4-generate-a-csr-admin"></a>
<a id="step-5-get-a-certificate-for-the-csr"></a>

## Step 5: Get a Certificate for a Key {#get-a-certificate-for-a-key}

**For production:**

1. Generate a CSR with [Generate CSR](/docs/openid4vc-api/config-digital-wallet-open-id-generate-csr/), with the [preset](#certificate-presets) for the purpose of the key. Each example shows every field of the request, filled with the value that the wallet uses when you leave the field out: the fixed values of the preset and the details of your organisation (here Example AB). Change any value, or leave a field out to use the value of the wallet. A value that differs from a fixed value of the preset gives the warning `preset-override`.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys/{keyId}/csr"
  method="POST"
  listenPathParamsEvent={KEY_CREATED_EVENT}
  jsonOptionLabel="Preset"
  jsonOptions={CSR_PRESET_OPTIONS}
/>

2. Send the CSR to your CA or QTSP, and ask for the certificate profile of that preset. The CA decides the final content of the certificate.
3. <a id="step-6-upload-the-certificate-chain-admin"></a>Upload the chain with [Upload Certificate Chain](/docs/openid4vc-api/config-digital-wallet-open-id-upload-certificate-chain/): a PEM file with the leaf certificate first, then any intermediate certificates, then the root. The upload is a file upload (`multipart/form-data`):

```bash
curl -X POST "https://demo-api.igrant.io/v2/config/digital-wallet/openid/key-management/keys/$KEY_ID/certificate-chain" \
  -H "Authorization: ApiKey $API_KEY" \
  -F "certificate_file=@chain.pem"
```

Example response (`200`):

```json
{
  "key_id": "3f2a91c47b8d4e6fa0c5d7e18b924f30",
  "certificates_count": 2,
  "x5t": "Pc9qa0x1tWfGqFOAPfUzjgKCOyk",
  "x5t_s256": "3T1jzz8BK8b6vrTVo2C5sm8Ehb0cDcnfjVEHg9ZJ7ZM",
  "csrId": "5e1c2f7a-8b3d-4c6e-9f0a-1b2c3d4e5f60",
  "preset": "credential-issuer",
  "warnings": [],
  "affectedCredentialConfigurations": []
}
```

The wallet compares the certificate with the preset of the latest CSR of the key. It warns you about differences (`profile-mismatch`) but does not reject the upload. A new upload replaces the existing chain.

In the dashboard, choose **View Key** on the key, then **Generate CSR** in **Key Details**. Select the **Certificate Preset** and choose **Generate**. When the certificate arrives, choose **Upload Certificate Chain**.

### The built-in test CA (development and testing)

For development and testing, the built-in test CA issues a certificate and stores the chain on the key in one call: [Create Test Certificate](/docs/openid4vc-api/config-digital-wallet-open-id-create-test-certificate/). The body is the same as for a CSR, with an optional `validityDays` (the examples show the default of an installation, 365 days). In the dashboard, switch on **Use the built-in test CA** in **Generate CSR**.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys/{keyId}/test-certificate"
  method="POST"
  listenPathParamsEvent={KEY_CREATED_EVENT}
  jsonOptionLabel="Preset"
  jsonOptions={TEST_CERTIFICATE_PRESET_OPTIONS}
  onSuccess={refreshOrganisationKeys}
/>

- Each organisation has three test root CAs, one for each trust domain: `mdoc-iaca` for mdoc, `access` for access certificates (WRPAC) and `request-signer-san-dns`, and `provider` for all other presets. The first test certificate in a domain creates its root, and [Read Test CA](/docs/openid4vc-api/config-digital-wallet-open-id-read-test-ca/) lists the roots.
- For mdoc, the Document Signer, the IACA and the mdoc `issuing_country` must share a country. To choose that country, create the root first with [Create Test CA](/docs/openid4vc-api/config-digital-wallet-open-id-create-test-ca/).
- Verifiers on this platform trust a test certificate only if they add its root as a trust authority ([Create Trust Authority](/docs/openid4vc-api/config-create-digital-wallet-open-id-trust-authority/)), or use a trust list that contains the root.
- A new test certificate replaces and revokes the previous one. If a key has a chain from another CA, delete that chain first.
- The dashboard marks these keys with the badge **Test certificate**. Your installation can switch the test CA off, and the test CA requests then return `403`.

<NoteBox title="Warning:" variant="caution">
Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production.
</NoteBox>

<a id="step-8-register-the-certificate-in-a-trust-list"></a>

## Step 6: Register the Certificate in a Trust List {#register-the-certificate-in-a-trust-list}

Wallets trust your organisation when a trust list contains your certificate or its CA. To join the NXD trust list, follow [Register as a Wallet-Relying Party](/docs/trust-relying-party-registration/) and send the request to [support@igrant.io](mailto:support@igrant.io?subject=Trust%20list%20registration). [Trust in the Wallet Ecosystem](/docs/trust-overview/) explains how trust lists work.

- Issuers of PID, EAA, QEAA or PuB-EAA credentials belong in the list for that category. Verifiers belong in the Wallet-Relying Party Access Certificate (WRPAC) list.
- The EU lists of trusted entities (ETSI TS 119 602) and the EU trusted lists hold the CA certificate, not your leaf certificate. For access certificates (WRPAC), that is the Access CA of the trust service provider that issued them. The NXD trust list registers the WRPAC of a relying party directly.
- Signatures carry the leaf and intermediate certificates but not the root (OpenID4VC HAIP), so wallets and verifiers build the path to a CA on their own list.
- In tests, the roots of the built-in test CA take the place of these CAs.

<a id="step-7-list-the-keys-admin"></a>

## Step 7: Manage Your Keys {#manage-your-keys}

**Find keys.** [List Keys](/docs/openid4vc-api/config-digital-wallet-open-id-list-keys/) returns each key with its key store, public key, certificate details and usage count. You can filter by key store (`keyStoreId`), by keys with a certificate (`withCertificateChain`) or by text (`search`). [Read Key](/docs/openid4vc-api/config-digital-wallet-open-id-read-key/) returns a single key.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys?withCertificateChain=true&limit=10"
  method="GET"
  initialJsonData={{}}
  exampleResponse={{
    keys: [
      {
        ...exampleKey({
          jwk: EXAMPLE_JWK_WITH_CHAIN,
          hasCertificateChain: true,
          certificateSource: 'uploaded',
          certificatePreset: 'credential-issuer',
        }),
        usage: { credentialDefinitions: 1, presentationDefinitions: 0 },
      },
    ],
    pagination: { totalItems: 1, limit: 10, offset: 0, hasNext: false },
  }}
/>

**See where a key is used.** [Read Key Usage](/docs/openid4vc-api/config-digital-wallet-open-id-read-key-usage/) lists the credential definitions, presentation definitions and status lists that sign with the key. `canDelete` tells you whether the key can be deleted.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys/{keyId}/usage"
  method="GET"
  listenPathParamsEvent={KEY_CREATED_EVENT}
  initialJsonData={{}}
  exampleResponse={{
    keyId: EXAMPLE_KEY_ID,
    isDefault: false,
    hasCertificates: true,
    credentialDefinitions: { count: 1, items: [{ id: '7c2e4a9b1d3f4e6a8b0c1d2e3f4a5b6c', label: 'Person Identification Data' }] },
    presentationDefinitions: { count: 0, items: [] },
    statusLists: { count: 0, items: [] },
    issuanceRecordsInFlight: { count: 0 },
    verificationRecordsInFlight: { count: 0 },
    canDelete: false,
  }}
/>

**Delete a key.** [Delete Key](/docs/openid4vc-api/config-digital-wallet-open-id-delete-key/) needs the body `{"confirm": "DELETE"}` and returns `204` without a body. The default key and keys in use cannot be deleted. Only the record in the wallet is removed: the key itself stays with your provider.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys/{keyId}"
  method="DELETE"
  listenPathParamsEvent={KEY_CREATED_EVENT}
  initialJsonData={{ confirm: 'DELETE' }}
  exampleResponse="HTTP 204: the response has no body."
  onSuccess={refreshOrganisationKeys}
/>

- **Rename a key:** [Update Key](/docs/openid4vc-api/config-digital-wallet-open-id-update-key/). For a QTSP key, the same call changes the PIN.
- **Remove a certificate chain:** [Delete Certificate Chain](/docs/openid4vc-api/config-digital-wallet-open-id-delete-certificate-chain/) with `{"confirm": "DELETE"}`. This is refused while the key still signs with `x509`, so move those uses to another key first.
- **Renew a certificate:** a key with an expired certificate stops signing with `x509`. `jwk.x5c_expiry` shows when the certificate expires, so upload a new chain before then. An mdoc is never valid beyond its Document Signer certificate.

In the dashboard, choose **View Keys** on a key store, then **View Key**, **Edit Key** or **Delete Key**. **Key Details** shows the certificate chain, where the key is used, and **Delete Certificate Chain**. Next to the key field of a credential definition or a presentation definition, **Trust List Lookup** shows whether the trust lists know the selected key. The [Look Up a Key in the Trust Lists](/docs/openid4vc-api/config-digital-wallet-open-id-key-trust-lookup/) API returns the same result. In the developer guides on this site, the key label beside each signing key field lets you pick one of your keys.

## Credential Categories and Key Usage Types

Each credential configuration (each entry of `credentialDefinitions`) has a credential category, `credentialCategory`. The category is the eIDAS category of the credential, and it decides which certificate the signing key must have (ETSI TS 119 412-6). The wallet checks the key whenever you create or update the credential definition. The key that it checks is the `cryptographicKeyIdentifier` of the configuration, or the key of the definition if the configuration has none.

The categories, as the [List Credential Categories](/docs/openid4vc-api/config-digital-wallet-open-id-list-credential-categories/) API describes them:

- **None** (`none`): No category and no certificate check. Use it for tests or for credentials outside eIDAS. An mDL still needs an ISO/IEC 18013-5 Document Signer certificate.
- **PID** (`pid`): Person identification data: the identity data of a natural person (for example the name and date of birth) that a Member State, or a body on its behalf, issues to the EUDI Wallet. It needs a PID provider certificate.
- **EAA (non-qualified attestation)** (`eaa`): An electronic attestation of attributes that is not qualified, for example a membership card or a ticket. Any organisation can issue it as a non-qualified trust service. It needs an electronic seal certificate.
- **QEAA (qualified attestation)** (`qeaa`): A qualified electronic attestation of attributes. Only a qualified trust service provider (QTSP) can issue it, and it has the same legal effect as a lawfully issued paper attestation. It needs a qualified seal certificate. The platform adds the ETSI category urn:etsi:esi:eaa:eu:qualified.
- **PuB-EAA (public sector attestation)** (`pub-eaa`): An electronic attestation of attributes that a public sector body responsible for an authentic source issues, or that is issued on its behalf, for example a vehicle registration from the national register. It has the same legal effect as a lawfully issued paper attestation. It needs a qualified seal certificate with the public sector statement (the law and the authentic source). The platform adds the ETSI category urn:etsi:esi:eaa:eu:pub.

| Category | The certificate of the signing key must have | Preset to request |
|---|---|---|
| `none` | No rule | None |
| `pid` | QcType pid (`0.4.0.194126.1.1`) and key usage Type A, B, C or F (ETSI TS 119 412-6 PID-4.4.1-01) | `pid-provider` |
| `eaa` | Key usage Type A, B or F (ETSI EN 319 412-3 LEG-4.3.1-3) and `organizationIdentifier` in the subject (LEG-4.2.1-2) | `eaa-provider` |
| `qeaa` | QcCompliance, QcSSCD, QcType eseal and key usage Type A, B or F | `qeaa-provider` |
| `pub-eaa` | The QcPSB statement (`0.4.0.194126.1.3`, with all three values), QcCompliance, QcSSCD and key usage Type A, B or F. The QcType is eseal, or the QcType value of CIR (EU) 2024/2979 | `pub-eaa-provider` |

The same API also gives the entitlement (ETSI TS 119 475 Annex A.2) and the sources of each category.

**Mobile driving licences (mDL):** an mDL (`mso_mdoc` with the doctype `org.iso.18013.5.1.mDL`) always needs an ISO/IEC 18013-5 Document Signer certificate, whatever its category: key usage `digitalSignature` and extended key usage `1.0.18013.5.1.2`, both critical. With the category `none`, request it with the preset `mdoc-document-signer`. With another category, use the preset of that category and add the two extensions to the CSR. Because the Document Signer profile has only `digitalSignature`, an mDL in the category `eaa`, `qeaa` or `pub-eaa` may also use key usage Type C. This is a known deviation from ETSI EN 319 412-3 LEG-4.3.1-3.

**Key usage types:** ETSI EN 319 412-2 (clause 4.3.2, table 1) defines six key usage types. A certificate with any other key usage bit, such as `keyCertSign`, has no type.

| Type | `nonRepudiation` | `digitalSignature` | `keyEncipherment` or `keyAgreement` | Use for a credential signing key |
|---|---|---|---|---|
| A | Yes | | | A seal over content: EAA, QEAA, PuB-EAA and PID. ETSI recommends Type A. The presets `qeaa-provider` and `pub-eaa-provider` use it |
| B | Yes | Yes | | A seal over content: EAA, QEAA, PuB-EAA and PID. The preset `eaa-provider` uses it, because validators also check `digitalSignature` |
| C | | Yes | | PID, and the mDL Document Signer (ISO/IEC 18013-5). For an EAA, a QEAA or a PuB-EAA only when it is an mDL |
| D | | Yes | Yes | Not for a seal over content (EAA, QEAA, PuB-EAA) or a PID |
| E | | | Yes | Not for a credential signing key: the key cannot sign |
| F | Yes | Yes | Yes | A seal over content: EAA, QEAA, PuB-EAA and PID |

**When a key does not fit:**

- If the key of a configuration does not fit its category or the mDL rule, the save fails with `400` and `errorType` `signing_key_does_not_fit`. `errorMessages` explains each rule that the key misses and which preset to request:

  ```json
  {
    "errorCode": 400,
    "errorDescription": "credentialDefinitions[0].cryptographicKeyIdentifier: A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider).",
    "errorType": "signing_key_does_not_fit",
    "errorField": "credentialDefinitions[0].cryptographicKeyIdentifier",
    "errorMessages": [
      "A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider)."
    ]
  }
  ```

- A key with a PID certificate signs PID credentials only.
- `none` has no certificate rule, and it is the category of every configuration saved without `credentialCategory`. If a `none` configuration that does not issue a PID uses a key with a PID certificate, the check adds an information message.
- A key whose certificate is already in a trusted list can have a trusted-list exemption, which only the platform operator sets. While it applies, the key is accepted and the check result is `exempt`. A new certificate chain ends the exemption.
- The check never stops issuance. If the certificate of a key changes after the save, the configuration shows `does-not-fit` until you choose another key or request a certificate with the preset of the category.

**The category in the issued credential:** for QEAA and PuB-EAA, the issuer adds the EAA category of ETSI TS 119 472-1 to every credential: `urn:etsi:esi:eaa:eu:qualified` for `qeaa` and `urn:etsi:esi:eaa:eu:pub` for `pub-eaa`. In SD-JWT VC it is the top-level claim `category`, always disclosed. In mdoc it is the data element `category` in the namespace `org.etsi.01947201.010101`. In W3C VC (`jwt_vc_json`) it is an extra value in `type`. Do not add these values yourself: with the category `eaa`, `qeaa` or `pub-eaa`, the save rejects them with `400` and `errorType` `eaa_category_claim_reserved`.

**API fields:**

| Field | Where | What it tells you |
|---|---|---|
| `credentialCategory` | Each entry of `credentialDefinitions` ([Create Credential Definition](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition/)) | `none`, `pid`, `eaa`, `qeaa` or `pub-eaa`. If it is missing or `null`, the category is `none`. |
| `signingKeyCheck` | Each entry, in every response | `fits`, `does-not-fit`, `exempt` or `not-checked`, with messages. It matches the result that a save would give now. |
| `suggestedCredentialCategory` | Each entry, in every response | `pid` when a `none` configuration issues a PID and its key fits PID, else `null`. |
| `certificateAssessment` | Each key ([List Keys](/docs/openid4vc-api/config-digital-wallet-open-id-list-keys/)) | The key usage type, the categories that the certificate fits (also for an mDL), whether it is an mDL Document Signer, its public sector (QcPSB) data, and the save messages for each category. |
| `affectedCredentialConfigurations` | Upload certificate chain, delete certificate chain and create test certificate | The configurations that no longer fit after the change. The change still goes through. |

**In the dashboard:**

- The field **Credential Category** is directly below **Credential Format** in each configuration. For a new PID configuration, the dashboard selects PID only if the selected key fits PID.
- In the card **Credential Signing Key**, keys that do not fit are greyed out, with the reason on hover. If the selected key does not fit, a red message below **Cryptographic Key Identifier (KID)** lists each rule that it misses, and the configuration shows a red status. The dashboard does not show exemptions or information messages here, but the API returns them.
- For QEAA and PuB-EAA, the configuration shows **Added at issuance: category = &lt;urn&gt;**. For PuB-EAA, it also shows the law, the country and the authentic source from the certificate of the key.
- When a `none` configuration issues a PID and a key that fits PID exists, a hint offers **Use the PID category**.
- **Key Details** shows the key usage type, the categories that the certificate fits and the badge **Exempt** if the key has an exemption. Once the certificate changes, the keys table shows **Exemption does not apply**. If a certificate upload breaks a configuration, the dashboard lists the configurations that are affected.


---

# Organisation Wallet Suite - On-Premise Deployment
Source: https://docs.igrant.io/docs/organisation-wallet-on-premise-deployment/

---
id: eo-ow-on-premise-deployment
title: Organisation Wallet Suite - On-Premise Deployment
description: Run the iGrant.io Organisation Wallet Suite on your own infrastructure with Kubernetes or Docker Compose. Keep full control of your data and signing keys with OpenBao, hardware security modules (PKCS#11, Thales Luna, DPoD) and cloud KMS, for eIDAS 2.0 credential issuance and verification.
hide_title: false
sidebar_label: Deployment Guide
keywords: [on-premise deployment, on-premises, self-hosted, self-hosted EUDI wallet, digital identity wallet, eIDAS 2.0, EUDI Wallet, European Business Wallet, Organisation Wallet, verifiable credentials, OpenID4VCI, OpenID4VP, Kubernetes, Helm chart, Docker Compose, private cloud, data sovereignty, data residency, regulated industries, hardware security module, HSM, PKCS#11, Thales Luna Network HSM, Thales Luna Cloud HSM, DPoD, cloud KMS, OpenBao, high availability, enterprise deployment]
slug: /organisation-wallet-on-premise-deployment/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';

<head>
  <title>Organisation Wallet Suite - On-Premise Deployment | iGrant.io DevDocs</title>
  <meta name="description" content="Run the iGrant.io Organisation Wallet Suite on your own infrastructure with Kubernetes or Docker Compose, with full control of your data and signing keys: OpenBao, hardware security modules (PKCS#11, Thales Luna, DPoD) and cloud KMS." />
</head>

The Organisation Wallet Suite by iGrant.io lets your organisation issue, hold and verify verifiable credentials under eIDAS 2.0, with OpenID4VCI, OpenID4VP and the EU Architecture and Reference Framework. You can use it as a service from iGrant.io, or run it on your own infrastructure: in your data centre or in your private cloud.

An on-premise installation suits organisations that must keep their data and signing keys inside their own security perimeter, under their own compliance, audit and data residency requirements.

## Why run the suite on premise

- **Control of your data.** Credentials, exchange records and logs stay in your data centre or private cloud, under your data residency and retention policies.
- **Control of your signing keys.** The keys stay in OpenBao or in your hardware security module (HSM), and they never leave it. Organisations can also use cloud KMS key stores and qualified trust service providers.
- **A fit with your infrastructure.** Standard Kubernetes and Helm, your ingress controller or Gateway, your database server or the bundled one, and your monitoring and backup tools.
- **The same product.** The same components and the same API as the iGrant.io service, with the same eIDAS 2.0 and EU Architecture and Reference Framework capabilities.

## Deployment options

| Installation | Best for | Instructions |
| --- | --- | --- |
| Helm chart | Kubernetes: production installations | [Helm chart documentation](https://github.com/L3-iGrant/helmcharts#readme) |
| Docker Compose | One Docker host: tests, pilots and small production installations | [Docker Compose README](https://github.com/L3-iGrant/helmcharts/blob/main/docker-compose/README.md) |

Both install the same components, with one database engine for all components.

<NoteBox title="Note:" variant="note">
This page describes what an installation needs and the options that you choose. The documentation of the Helm chart and the Docker Compose README in the <a href="https://github.com/L3-iGrant/helmcharts">Helm charts repository</a> have the exact steps, each with a check. When this page and that documentation differ, the documentation of the repository is correct.
</NoteBox>

## Architecture

| Component | What it does | Public |
| --- | --- | --- |
| Gateway | The single entry point of the API. It checks every request (API keys, logins, roles) and sends it to the correct service. | Yes: the API host |
| API | Organisations, admins, credential definitions, webhooks and the OpenID provider. | Through the gateway |
| Webhook handler | Sends the webhook events of your organisations. | No |
| Consent management | Data agreements and consent records. | Through the gateway |
| Organisation wallet | Issues, holds and verifies credentials (OpenID4VCI, OpenID4VP) and acts as the wallet provider. | Yes: the wallet host |
| Enterprise dashboard | The web interface of the organisation admins. | Yes: the dashboard host |
| Database | One PostgreSQL or MariaDB server for all components, or your own server. | No |
| NATS | The messages between the services. | No |
| OpenBao | Keeps the signing keys of the wallet. | No |
| HSM signer (optional) | Signs with keys in an HSM on behalf of the wallet. Set up with each customer (see [Hardware security modules](#hardware-security-modules-hsm)). | No |

## What the installation needs

### Kubernetes (Helm chart)

| Item | Requirement |
| --- | --- |
| Cluster | Kubernetes 1.25 or later and Helm 3.8 or later, with a default StorageClass for ReadWriteOnce volumes. |
| Ingress | An ingress controller (for example ingress-nginx or Traefik) or a Gateway API implementation (for example Envoy Gateway, kgateway or Istio). The chart does not install one. |
| DNS and TLS | Three host names (the API, the organisation wallet and the dashboard) and their certificates. The API and the dashboard must have the same registrable domain. |
| Image registry | Access to the iGrant.io registry for customers and the release tag of your version, or your own mirror. Ask [support@igrant.io](mailto:support@igrant.io). |
| File store | A Google Cloud Storage bucket for the files of the organisation wallet (not public), or a server with the Google Cloud Storage API. |
| Key protection | A choice for the seal of OpenBao (see [Key protection](#key-protection)), and optionally an HSM for the signing keys. |

### One Docker host (Docker Compose)

A Linux host with Docker Engine, Docker Compose 2.24 or later, GNU Make, Bash, OpenSSL and curl; access to the iGrant.io registry; your reverse proxy with TLS and a DNS name for each public service; and outbound HTTPS for the image registries, the trust list service and the services of other issuers, verifiers and wallets. An SMTP server for the e-mails of the API is optional.

### Hardware

The images are for Linux x86-64. The minimum for tests, pilots and small installations:

| Item | Tests and pilots (one node or one Docker host) | Small production installation (Kubernetes) |
| --- | --- | --- |
| Nodes | 1 | 3 |
| CPU | 4 vCPU | 4 vCPU for each node |
| Memory | 8 GB RAM | 8 GB RAM for each node |
| Storage | 128 GB SSD | 128 GB SSD for the volumes, with backups |
| Network | 1 Gbit/s | 1 Gbit/s |

The resources grow with the number of organisations, the issuance and verification rate, the number of concurrent API calls and the size of the database. Production installations with high availability, many organisations, a high transaction rate or HSM signing are sized with you, based on your load and availability requirements. Contact [support@igrant.io](mailto:support@igrant.io). See [Prerequisites](https://github.com/L3-iGrant/helmcharts/blob/main/docs/prerequisites.md).

## Your options

### Database

The whole platform uses one database engine: PostgreSQL or MySQL (MariaDB or MySQL 8.0). Each component has its own database and owner user. The chart can run the database server for you (PostgreSQL 18 or MariaDB), or use your own server, with an admin user or with the databases and users that your DBA creates. All components connect with TLS and verify the server certificate. Choose the engine before the install: a later change does not copy the data. See [Database](https://github.com/L3-iGrant/helmcharts/blob/main/docs/database.md).

### Key protection

OpenBao keeps the signing keys of the organisation wallet in its Transit engine. The chart runs OpenBao with 3 nodes, or uses your own OpenBao. The seal of OpenBao protects its root key:

| Seal | Unseal | Availability |
| --- | --- | --- |
| Shamir | Manual: an operator unseals each node after each start | In the Helm chart. Plan an operator for each restart and each upgrade. |
| Static key | Automatic, with a key file on the host | In Docker Compose. Keep the key file safe: without it, nobody can read the data. |
| HSM | Automatic, through your HSM | Set up with each customer (see [Hardware security modules](#hardware-security-modules-hsm)). |
| Google Cloud KMS | Automatic, through a Google Cloud KMS key | Set up with each customer (see [Scaled deployments](https://github.com/L3-iGrant/helmcharts/blob/main/docs/scaled-deployments.md)). |

<NoteBox title="Keep the seal and the keys:" variant="caution">
Without the seal key, OpenBao stays sealed and its data is lost. Keep the backup of the seal key that your HSM or Google Cloud supports, and keep the recovery or unseal keys and the root token outside the cluster.
</NoteBox>

#### The local key store of the installation

Every organisation can use the local key store of the installation. By default, its keys are in OpenBao. With HSM support, the keys are created and used in your HSM partition, and they cannot leave it. OpenBao still keeps the holder binding keys and encrypts the key store credentials, so the installation always needs OpenBao.

#### Hardware security modules (HSM)

The platform uses the standard PKCS#11 interface for hardware security modules. It is tested with Thales Luna Network HSM (on premises) and Thales Luna Cloud HSM (DPoD). We support other PKCS#11 HSMs for each customer after a validation with your HSM and its client library.

An HSM can protect the OpenBao seal, the signing keys of the organisations, or both, so that the keys never leave the HSM. Organisations can also add their own Thales Luna Cloud HSM (DPoD) partition as a key store. We set up HSM support with each customer, based on their HSM, network and security requirements. Contact [support@igrant.io](mailto:support@igrant.io). See [Connect your on-premise HSM](https://github.com/L3-iGrant/helmcharts/blob/main/docs/on-premise-hsm.md), [Thales Luna Cloud HSM (DPoD)](https://github.com/L3-iGrant/helmcharts/blob/main/docs/dpod.md) and [DPoD key stores](https://github.com/L3-iGrant/helmcharts/blob/main/docs/dpod-key-stores.md).

#### Organisation key stores

The organisation admins can add key stores of their own in the dashboard or with the [Key Management](/docs/openid4vc-key-management/) API. The installation decides which types they can add (see [Key stores](https://github.com/L3-iGrant/helmcharts/blob/main/docs/key-stores.md)):

| Type | Key store | What the installation needs |
| --- | --- | --- |
| `vault` | An external OpenBao of the organisation (Transit engine) | Access to the address of that OpenBao. |
| `csc` | A qualified trust service provider (QTSP) for remote signing with the CSC API | Access to the CSC address of the QTSP. |
| `gcp-kms` | Google Cloud KMS, including Cloud HSM keys | Outbound HTTPS to `cloudkms.googleapis.com`. |
| `aws-kms` | AWS KMS | Outbound HTTPS to `kms.<region>.amazonaws.com`. |
| `azure-key-vault` | Azure Key Vault or Azure Managed HSM | Outbound HTTPS to `login.microsoftonline.com` and to `<vault>.vault.azure.net` or `<hsm>.managedhsm.azure.net`. |
| `dpod` | A Thales Luna Cloud HSM partition (DPoD) of the organisation | Set up with each customer (see [Hardware security modules](#hardware-security-modules-hsm)). Not in the default list. |

The default is `vault`, `csc`, `gcp-kms`, `aws-kms` and `azure-key-vault`. The cloud key stores call only the official endpoints of their cloud, and the wallet keeps their credentials encrypted in OpenBao. A cloud KMS with HSM keys and a DPoD partition are not certified qualified signature creation devices (QSCD).

#### The built-in test CA

The built-in test CA issues test certificates for development and testing (see [The built-in test CA](/docs/openid4vc-key-management/#the-built-in-test-ca-development-and-testing)). They are not on any trusted list. It is on by default. Turn it off when the installation must not offer it, for example in production (see [Key stores](https://github.com/L3-iGrant/helmcharts/blob/main/docs/key-stores.md)).

### Exposure

The platform has three public hosts: the API, the organisation wallet and the dashboard. The Helm chart creates an Ingress for each host (the default), an HTTPRoute for each host of your Gateway, or only the Services for your own routes. With Docker Compose, your reverse proxy sends the requests to three host ports.

Your proxy only routes the traffic: the platform does the CORS checks, the authentication and the rate limits. The proxy must accept request bodies of up to 10 MiB, wait up to 60 seconds for a request, keep the event streams of the API open for up to 3900 seconds without buffering, and pass the client address (the rate limits and the IP allow-lists of API keys use it). The repository documentation gives the settings for ingress-nginx, Envoy Gateway, kgateway and nginx. See [Exposure](https://github.com/L3-iGrant/helmcharts/blob/main/docs/exposure.md).

### Network policies

With the Helm chart, you can turn on Kubernetes network policies when your cluster enforces them. Only your ingress controller or Gateway then reaches the public services, the database and NATS accept only their clients, and the egress profiles name the external targets (for example a cloud KMS on a private address). See [Network policies](https://github.com/L3-iGrant/helmcharts/blob/main/docs/network-policies.md).

## Installation

With the Helm chart, the [Install](https://github.com/L3-iGrant/helmcharts/blob/main/docs/install.md) page of the chart documentation has seven steps, each with a check: the namespace and the registry access, the keys of the platform (a script of the chart creates them), the values files of your choices, the install, the initialisation of OpenBao, the wait for the platform, and the first admin with its organisation.

With Docker Compose, the [Installation](https://github.com/L3-iGrant/helmcharts/blob/main/docker-compose/README.md#installation) section of its README has the steps, from the settings in `.env` to the first admin and its organisation.

Each organisation gets the local key store of the installation and a default signing key when its wallet is deployed. The organisation admins then add their own key stores and keys (see [Key Management](/docs/openid4vc-key-management/)).

## Operations

To upgrade, set the release tag of the new version and run the upgrade of the chart: the chart and the images of one release belong together. After an uninstall, the volumes and the Secrets of the data stay, so you can install again with the same data. Keys in an HSM also stay: the HSM administrator removes the key pairs that no installation uses. See [Upgrade](https://github.com/L3-iGrant/helmcharts/blob/main/docs/upgrade.md) and [Uninstall](https://github.com/L3-iGrant/helmcharts/blob/main/docs/uninstall.md).

## Enterprise services

iGrant.io works with each on-premise customer on the parts that depend on their environment:

- access to the iGrant.io registry for customers and the release tags of your version;
- sizing for production, high availability and growth, based on your load and availability requirements;
- integration with your hardware security module (Thales Luna, DPoD and other PKCS#11 HSMs after a validation) and an automatic unseal through your HSM or a Google Cloud KMS key;
- advice for upgrades to new releases.

To plan an installation, contact [support@igrant.io](mailto:support@igrant.io).

## References

[1] Helm charts repository: [https://github.com/L3-iGrant/helmcharts](https://github.com/L3-iGrant/helmcharts)

[2] Helm chart documentation (contents): [https://github.com/L3-iGrant/helmcharts#readme](https://github.com/L3-iGrant/helmcharts#readme)

[3] Docker Compose README: [https://github.com/L3-iGrant/helmcharts/blob/main/docker-compose/README.md](https://github.com/L3-iGrant/helmcharts/blob/main/docker-compose/README.md)

[4] Reference files of the Helm chart (values, database, exposure, keys, network policies, HSM): [https://github.com/L3-iGrant/helmcharts/tree/main/docs](https://github.com/L3-iGrant/helmcharts/tree/main/docs)

[5] Organisation Wallet Suite overview: [https://docs.igrant.io/docs/organisation-wallet-overview/](https://docs.igrant.io/docs/organisation-wallet-overview/)

[6] Organisation Wallet Suite features: [https://docs.igrant.io/docs/organisation-wallet-features/](https://docs.igrant.io/docs/organisation-wallet-features/)


---

# Organisation Wallet Suite Overview
Source: https://docs.igrant.io/docs/organisation-wallet-overview/

---
id: eo-ow-overview
title: Organisation Wallet Suite Overview
description: Learn how the Organisation Wallet Suite enables businesses to issue and verify Digital Credentials for secure, trusted online interactions.
keywords: [Organisation Wallet Suite, European Business Wallet, EUDI Wallet, credential issuance, credential verification, OpenID4VC, OpenID4VCI, OpenID4VP, eIDAS 2.0, digital identity]
hide_title: false
sidebar_label: Overview
slug: /organisation-wallet-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Introduction to Organisation Wallet Suite | iGrant.io DevDocs</title>
  <meta name="description" content="Learn how the Organisation Wallet Suite enables businesses to issue and verify Digital Credentials for secure, trusted online interactions." />
</head>

The **Organisation Wallet Suite by iGrant.io**, recognised as the **European Business Wallet**, enables organisations to issue, hold, and verify digital credentials for legal persons and organisations. It is available both as an on-premise solution and as a Platform as a Service (PaaS) with multi-tenant capabilities.

The OWS suite is built on the **eIDAS 2.0 framework**, incorporating Regulation (EU) No 910/2014 together with its amendments in Regulation (EU) 2024/1183 and Regulation (EU) 2024/2977, as well as the latest Implementing Acts under the **European Digital Identity (EUDI) Framework**.

import NoteBox from '@site/src/components/NoteBox';

<NoteBox title="European Business Wallets:">
Learn more about how the European Business Wallets, shaped by real-life merchant-led scenarios that combine payments and data exchange, are enabling trust and scale in the European Digital Identity ecosystem in <a href="https://www.igrant.io/articles/business-wallets-enabling-trust-and-scale-in-the-european-digital-identity-eudi-wallet-ecosystem">this article</a>.
</NoteBox>

## Supported Attestation Types (EUDI Wallet Ecosystem)

The Organisation Wallet Suite supports the following attestation and identification data types as defined by the EU Architecture Reference Framework (ARF) under eIDAS 2.0:

| Credential | Description |
|------------|-------------|
| **PID** (Person Identification Data) | Core identity attributes for natural persons (name, date of birth, nationality) |
| **LPID** (Legal Person Identification Data) | Identity attributes for legal entities (company name, registration number) |
| **EAA** (Electronic Attestation of Attributes) | Attributes issued by non-qualified trust service providers |
| **QEAA** (Qualified Electronic Attestation of Attributes) | Attributes issued by QTSPs with the highest legal standing across all EU Member States |
| **PuB-EAA** (Public Electronic Attestation of Attributes) | Attributes issued by public sector bodies from authentic sources |
| **Payment Wallet Attestations** | Attestations enabling payment-related use cases within the EUDI Wallet ecosystem |

**Formats supported:** IETF SD-JWT, ISO 18013-7 mdoc/mDL, and W3C VC (JWT).

## Core Capabilities

The Organisation Wallet Suite provides three core functions: **Issuer**, **Holder/Wallet Unit**, and **Verifier/Relying Party**, all accessible within an enterprise tenant via the [OpenID4VC protocol suite](/docs/organisation-wallet-features/).

### Issuer

The Organisation Wallet Suite acts as a credential issuer using the OpenID for Verifiable Credential Issuance (OpenID4VCI) protocol.

* **[Intime](/docs/openID4vci-issue-credential-intime/) and [Deferred](/docs/openID4vci-issue-credential-intime/) credential issuance:** Pre-Authorised (with PIN) and Authorisation Code Flow with PKCE, supporting automated batch or invitation-based issuance.

* **[Dynamic credential issuance](/docs/openID4vci-issue-dynamic-credential-request/):** Request additional proof from the holder before issuing a credential.

* **Credential definitions:** Reusable configurations following JSON Schema, with visual branding (name, description, colours, logo), output format selection, and expiration policies.

* **Credential revocation:** Supports IETF Token Status List (draft 10) and W3C Verifiable Credentials Status List v2021.

* **Key configuration:** Configure signing keys via the integrated Key Management Service, and sign with `x509` certificate chains that wallets check against trust lists. See [Key Management](/docs/openid4vc-key-management/).

* **[Webhook notifications](/docs/openid4vc-webhooks/#issuer-webhooks):** Real-time updates at key stages of the issuance lifecycle (offer sent, received, issued, acknowledged, stored, deleted).

### Holder / Wallet Unit

The Wallet Unit (WU) enables organisations (companies, institutions, or departments) to securely receive, store, and present digital credentials, much like individuals use personal wallets.

* **[Receive and store credentials](/docs/openID4vp-receive-and-present-credentials/)** from trusted issuers (government authorities, regulators, data providers) with secure cloud storage.

* **[Present credentials](/docs/openID4vp-receive-and-present-credentials/)** to relying parties for verification.

* **Role-based access and delegation** for users within the organisation.

The Wallet Unit can also be integrated into a Natural Person Wallet that supports such integrations.

### Verifier / Relying Party

The Organisation Wallet Suite functions as a verifier using the OpenID for Verifiable Presentations (OpenID4VP) protocol, enabling secure validation of verifiable credentials held by individuals or organisations.

* **[Receive and present credentials](/docs/openID4vp-receive-and-present-credentials/):** Holders respond to presentation requests with selective disclosure support.

* **[Send and verify credentials](/docs/openID4vc-send-verify-credentials/):** Define credential requirements, initiate verification, and validate presentations.

* **Presentation definitions:** Reusable verification requests following Presentation Exchange v2.0, with support for multiple input descriptors and visual branding.

* **[Webhook notifications](/docs/openid4vc-webhooks/#verifier-webhooks):** Real-time updates throughout the verification process (request sent, received, presentation acknowledged, processed).

<NoteBox title="Digital Credential Query Language (DCQL):" variant="tip">
The Organisation Wallet Suite supports DCQL, which enables granular, multi-credential queries in a single request. This is particularly useful for merchant-led scenarios where payments and data exchange are combined in one flow. See our <a href="https://docs.igrant.io/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/">article on DCQL in business wallet payments</a> for practical examples.
</NoteBox>

## Platform Features

* **Multi-tenant with self-service:** Supports multiple organisations within a single instance with data privacy and segregation, and a self-service interface for credential issuance and verification management.

* **Interoperability:** Integrates with existing systems and supports data portability across platforms using OpenID4VCI/OpenID4VP (JWT/SD-JWT).

* **Multiple attestation types:** Modular architecture supporting various EAAs, QEAAs, and PuB-EAAs, with the ability to incorporate new credential types without system overhauls.

* **Multiple trust anchors:** Supports both ledger and non-ledger trust registries including [EBSI](https://ec.europa.eu/digital-building-blocks/sites/display/EBSI/Conformant+wallets), EU Trust List (ETSI TS 119 612), and others.

* **Webhook support:** Real-time notifications throughout issuance and verification workflows for enterprise system integration. See the [webhooks documentation](/docs/openid4vc-webhooks/).

* **Security and data privacy:** Cryptographic functions complying with SOG-IS/BSI CSP2 security standards, with data protected in transit and at rest. Privacy considerations adhere to [eIDAS 2.0 requirements](https://docs.igrant.io/regulations/reg-eu-digital-id-framework), addressing unobservability and unlinkability.

## Governance, security and operations

* **Role-based access and user management:** Access to the administration interface is governed by a role-based policy engine evaluated per route and method, with distinct administrator roles and separately scoped API keys for configuration, audit, service and onboarding operations. Administrator and team management, including creating, listing and removing administrators and assigning their role, is available through the Enterprise Dashboard and the configuration API. Access for external officials is delegated to the organisation's own IAM through OpenID Connect federation.

* **Audit logging:** Administrative actions, configuration changes, credential issuance and every lifecycle transition, together with authentication and authorisation events, are recorded with the actor, the action and a timestamp. Records are retained under a configurable policy and can be exported to an external logging platform so that the retained copy sits outside the control of the component that produced it.

* **Issuance statistics and reporting:** The administration interface aggregates issuance-related events into statistics, including issued attestations, active and revoked credentials, failed enrolment attempts and wallet-holder counts, filterable by time period and credential type and exportable for reporting.

* **Localisation and internationalisation:** User interfaces use externalised string catalogues per locale, selectable at runtime, with locale-aware date, time, currency and number formatting and locale collation. Catalogues are provided for Finnish (fi-FI), Swedish (sv-FI) and English (en-GB), and further languages are added by configuration.

* **Accessibility:** Public-facing interfaces are built to conform to Directive (EU) 2016/2102 and the harmonised standard EN 301 549 at WCAG 2.1 level AA, verified by automated checks in the build pipeline and by manual testing at each release.

## Deployment Options

The Organisation Wallet Suite is available in two deployment models. Deployable containers are published via the [Artefact Hub](https://artifacthub.io/packages/helm/organisationwallet/organisationwallet). See the [on-premise deployment guide](/docs/organisation-wallet-on-premise-deployment/) for setup instructions.

Both deployment models share the following defaults:

| Feature | Default | Configurable options |
|---------|---------|----------------------|
| **Key Storage** | iGrant.io Secure Vault, own HSM-as-a-service, QTSP (CSC v1.04.0) | Bring your HSMs via HashiCorp Vault, FIDO2, external QTSP |
| **Credential and Metadata Storage** | MongoDB / PostgreSQL | Not configurable |
| **Identity Management** | Pre-built IDAM (Keycloak). Customer IDAM integration available as an additional offering. | OpenID Connect |

The key difference between the two models is infrastructure:

| Model | Infrastructure |
|-------|---------------|
| **On-Premise** | Any Kubernetes Cluster: RedPill Linpro (Sweden), GCP, AWS, or Azure |
| **PaaS** | Kubernetes Cluster with region selection: RedPill Linpro (Sweden), GCP, AWS, or Azure |

### Key Management Options

| Option | Description |
|--------|-------------|
| **iGrant.io Secure Vault** | Default option where iGrant.io manages key storage and liability. |
| **HashiCorp Vault** | Bring your own key management systems (with or without HSM), offloading key storage liability to your organisation. |
| **External QTSP** | Third-party QTSP integration via a value-added reseller (VAR) model, transferring key management and signing liabilities to the external provider. |

## EUDI Wallet Ecosystem Roles

The following roles are defined by the [EU Architecture Reference Framework (ARF)](https://eudi.dev/latest/architecture-and-reference-framework-main/) under Regulation (EU) 2024/1183 (eIDAS 2.0):

| Role | Definition |
|------|------------|
| **Wallet Provider** | A natural or legal person who provides Wallet Solutions. Member States either mandate or recognise Wallet Providers to make a Wallet Solution available to Users. |
| **PID Provider** | A natural or legal person responsible for issuing and revoking Person Identification Data (PID) and ensuring that the PID of a user is cryptographically bound to a Wallet Unit. PID Providers are appointed by Member States. |
| **Attestation Provider** | A collective term for QEAA Provider, PuB-EAA Provider, or (non-qualified) EAA Provider. |
| **QEAA Provider** | A Qualified Trust Service Provider (QTSP) that issues QEAAs meeting the requirements laid down in Annex V of the eIDAS Regulation. QEAAs carry the highest legal standing with a presumption of accuracy across all EU Member States. |
| **PuB-EAA Provider** | A public sector body responsible for an authentic source, or designated by a Member State, that issues electronic attestations of attributes in accordance with Article 45f and Annex VII of the eIDAS Regulation. |
| **EAA Provider** | A non-qualified Trust Service Provider that issues EAAs, governed by sectoral rules rather than the eIDAS QTSP trust framework. |
| **Relying Party** | A natural or legal person that relies upon electronic identification, European Digital Identity Wallets or other electronic identification means, or upon a trust service. |
| **QTSP** | A Qualified Trust Service Provider who provides one or more qualified trust services and is granted qualified status by the supervisory body. |

For the full list of definitions, see [ARF Annex 1 - Definitions](https://eudi.dev/latest/annexes/annex-1/annex-1-definitions/).

## Getting Started

Ready to explore the Organisation Wallet Suite? Here are your next steps:

* **[Developer documentation](/docs/organisation-wallet-features/):** Protocol versions, API references, and supported features.
* **[On-premise deployment guide](/docs/organisation-wallet-on-premise-deployment/):** Set up the suite on your own infrastructure using Helm charts.
* **[Issuance workflow](/docs/openID4vci-issue-credential-intime/):** Issue your first credential using the OpenID4VCI protocol.
* **[Verification workflow](/docs/openID4vc-send-verify-credentials/):** Verify credentials using the OpenID4VP protocol.
* **[Webhooks](/docs/openid4vc-webhooks/):** Integrate real-time event notifications into your enterprise systems.

For access to the hosted platform or to discuss enterprise requirements, contact **support@igrant.io**.


---

# Passwordless Login with EUDI Wallets
Source: https://docs.igrant.io/docs/eudi-passwordless-login-flow/

---
id: eudi-passwordless-login-flow
title: Passwordless Login with EUDI Wallets
description: See how to enable passwordless authentication using the EUDI Wallet, improving security and user experience with Verifiable Credentials (VC).
hide_title: false
sidebar_label: Passwordless Login
keywords: [passwordless login, EUDI Wallet, authentication, verifiable credentials, Organisation Wallet, European Business Wallet, OpenID Connect, FIDO2, identity verification]
slug: /eudi-passwordless-login-flow/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Implement Passwordless Login with the EUDI Wallet | iGrant.io DevDocs</title>
  <meta name="description" content="See how to enable passwordless authentication using the EUDI Wallet, improving security and user experience with Verifiable Credentials (VC)." />
</head>

import YouTubeEmbed from '@site/src/components/YouTubeEmbed';

## Overview

By enabling the Passwordless Login extension in the iGrant.io Organisation Wallet Suite and configuring any OpenID Connect-compatible Identity and Access Management (IAM) system as a relying party (RP), organisations can allow users to log in without a password using their digital wallet credentials.

This guide consists of two parts:
1. **Enable and configure the Passwordless Login extension** in your iGrant.io Organisation Wallet Suite.
2. **Configure your IAM** to use iGrant.io as an OpenID provider with step-by-step guides.

![](./images/eo-ow-passwordless-diagram.png)

## Pre-requisites

Before implementing the passwordless login flow with EUDI Wallets, ensure you have:

- An iGrant.io Organisation Wallet Suite with administrator access
- EUDI Wallet available for testing the authentication flow
- A Presentation Definition ID, if you create the OpenID client with the API (create one [here](/docs/openID4vc-send-verify-credentials/)). In the dashboard, you can create the presentation definition together with the client.
- A running IAM instance that supports OpenID Connect (e.g. Keycloak 15+, Auth0, Ping Identity, etc.)

## Part 1: Configure the Passwordless Login Extension

### Step 1: Get the API Key (Organisation Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from '@site/src/components/ApiKeyManager';

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Enable the Passwordless Login Extension

To enable the Passwordless Login extension, run the code block below using the **Run** button. The response contains `metadataUrl`, the OpenID Connect metadata discovery URL (`/.well-known/openid-configuration`). Copy it for IAM configuration (Step 4).

import Enable from '@site/src/components/PasswordlessLogin/Enable';

<Enable
  requestBodyOptions={[
    {
      requestBodyJson: {
        enabled: true,
      },
    }
  ]}
/>

Alternatively you can do this step manually by copying the code block and using it in the body of the API request available [here](/docs/extensions-api/set-extension-enabled-state) (select https://demo-api.igrant.io from the Base URL dropdown and enter `oidc` as the `extensionId`). Copy the OpenID Connect metadata discovery URL (`/.well-known/openid-configuration`) for IAM configuration (Step 4).

The discovery document lists the authorisation, token, UserInfo and JWKS endpoints.

### Step 3: Create an OpenID Client

Create the client in the dashboard or with the API. Both give you the Client ID and Client Secret. Copy them for IAM configuration (Step 4). You will need the following from your IAM:
- Redirect URI
- Allowed origin (based on the redirect URI's domain)

**Note:** If you don't already have the Redirect URI it can be [updated later](/docs/extensions-api/update-oidc-client) and left blank for now, see the IAM-specific section below for instructions on where to find it.

A presentation definition can be used by one client only.

#### Option 1: Create the Client in the Dashboard

1. Go to **Issuer & Verifier** > **Extensions** > **Passwordless Login** > **MANAGE**.
2. Click the circled plus icon next to **OpenID Connect Clients**. The drawer **Create OpenID Connect Client** opens.
3. Enter the **Name** and set the **Presentation Definition** in one of the three ways in the table below.
4. Check the **Action**. This is the login text that the wallet may show to the user. The field is prefilled with "Login with EUDI Wallet".
5. Select the **Identity Resolution Method**. With **Identity Matching Attributes** (default), select the identity attribute for each credential. With **Callback URI**, enter the **Callback URI** and the **Callback Secret**.
6. Under **URIS & ORIGINS**, enter the **Redirect URIs** and the **Web Origins**.
7. Click **SAVE**. Copy the Client ID and Client Secret of the new client from the list **OpenID Connect Clients**.

There are three ways to set the **Presentation Definition**:

| Way | What it does |
|---|---|
| **Credentials** | Pick one or more credentials, for example PID. A new presentation definition is created from them when you save. The user logs in with any one of them. |
| **Existing presentation definitions** | Select a presentation definition you already created. No new one is created. |
| **Create new presentation definition** | Build your own. It is created when you save. |

#### Option 2: Create the Client with the API

You will need the Presentation Definition ID you created in the pre-requisites. Replace the `string` values in the request, then run the code block below using the **Run** button. A successful response has the status 201 and contains `clientId` and `clientSecret`.

The request matches the presentation definition of the [pre-requisite guide](/docs/openID4vc-send-verify-credentials/), created with the **OpenID4VP Version** "Version 01" and the **Credential Format** "W3C VC (JWT)" or "IETF SD-JWT".

import Client from '@site/src/components/PasswordlessLogin/Client';

<Client
  requestBodyOptions={[
    {
      requestBodyJson: {
        presentationDefinitionId: "string",
        name: "Login with EUDI Wallet",
        redirectURIs: [
          "string"
        ],
        allowedOrigins: [
          "string"
        ],
        identityMatchingAttributes: {
          "LegalPersonIdentificationData": "identifier"
        },
      },
    }
  ]}
/>

Alternatively you can do this step manually by copying the code block and using it in the body of the API request available [here](/docs/extensions-api/create-oidc-client) (select https://demo-api.igrant.io from the Base URL dropdown).

| Field | Required | Description |
|---|---|---|
| `presentationDefinitionId` | Yes | The presentation definition that the wallet receives at login. |
| `name` | Yes | A name describing the purpose of the client. |
| `redirectURIs` | No | The redirect URIs of your IAM. The redirect URI of a login request must match one of them exactly. |
| `allowedOrigins` | No | The web origins of your application. |
| `identityMatchingAttributes` | One of the two | The recommended way to configure identity matching. A map from the identifier of a credential to the dot-separated path of a claim within that credential. The value of this claim is the `sub` of the user at the token and UserInfo endpoints. |
| `callbackURI` with `callbackSecret` | One of the two | For identity matching with your own logic. Use an HTTPS endpoint. The endpoint receives the credential presentation and must return a JSON response with a `sub` field, the subject identifier used to link the user in your IdP. The secret signs the request with HMAC-SHA256. See [Webhook Security](/docs/openid4vc-webhooks/#webhook-security) for details on how to decode and verify the `X-iGrant-Signature` header. |
| `transactionDataAction` | No | The login text that the wallet may show to the user (e.g. `"Log in to your online bank account"`). Send it only when the presentation definition has Passwordless Login transaction data. |

Provide either `identityMatchingAttributes` or `callbackURI` with `callbackSecret`, not both. Add one identity matching attribute for each credential of the presentation definition.

## Part 2: Configure Your IAM

Organisations can configure iGrant.io as an OpenID provider in any OIDC-compatible IAM. Below are step-by-step guides for Keycloak and Auth0.

### Keycloak Configuration

Follow these steps to configure Keycloak as a relying party.

#### Step 4: Add an Identity Provider (IdP)

1. Log in to your Keycloak admin console.
2. Navigate to **Identity providers** > **Add provider** > **OpenID Connect v1.0**.

![](./images/eo-ow-passwordless-idp-1.png)
_Figure 01: Add Identity Provider_

3. Enter the following details:
   - **Alias**: e.g., `igrant`
   - **Client ID**: (from step 3)
   - **Client Secret**: (from step 3)
   - **Discovery endpoint**: Paste the metadata discovery URL from step 2
   - **Client Authentication**: Set to **Client Secret sent as basic auth**.

![](./images/eo-ow-passwordless-idp-2.png)
_Figure 02: Add OpenID Connect Provider_

Figure 02 shows the Keycloak default values. Change them to the values above.

If the discovery endpoint cannot be used directly, retrieve individual endpoints (authorisation, token, userinfo, and JWKS) from the metadata URL (Step 2) in the browser and configure them manually.

**Note:** You can find the Redirect URI in the settings, update the client [here](/docs/extensions-api/update-oidc-client) if not already done. The Redirect URI of the client must match the Redirect URI of Keycloak exactly.

#### Step 5: Create a Custom Authentication Flow in Keycloak

1. Go to **Authentication** > **Flows**.

![](./images/eo-ow-passwordless-authentication-1.png)
_Figure 03: Authentication_

2. Create a new basic flow, e.g., "Login with EUDI Wallet".

![](./images/eo-ow-passwordless-authentication-2.png)
_Figure 04: Add Authentication Flow_

3. Add execution steps required for OpenID Connect-based login.

![](./images/eo-ow-passwordless-authentication-3.png)
_Figure 05: Add Execution Steps_

4. Mark each step as required to enforce proper validation.
5. Save the flow.

Alternatively, add these steps to your current login flow.

**Explanation:**
- **Detect existing broker user**: On login from an external IdP, the authenticator checks for a local Keycloak account that matches the external identity (matched via the identity matching attributes configured on the OIDC client). Only users who already exist can continue.
- **Automatically set existing user**: If a matching local user is found, the authenticator "injects" the user into the authentication context and completes the login (no further confirmation, e.g. password re-entry or email-link is requested).

#### Step 6: Update the Authentication Flow and Sync Mode in Keycloak

1. Navigate to your Identity Provider settings in Keycloak.
2. Set the newly created (or updated) authentication flow for the identity provider (e.g. "Login with EUDI Wallet").
3. Configure the sync mode ("force" is recommended as it will re-apply the identity matching attributes on every login).

![](./images/eo-ow-passwordless-idp-3.png)
_Figure 06: Update the Authentication Flow and Sync Mode in Keycloak_

##### Sample Implementation with React (Keycloak)

A GitHub repository is available that demonstrates how to implement a custom "Sign with EUDI Wallet" button in a React application integrated with Keycloak IAM:

- **Repository**: [https://github.com/L3-iGrant/passwordless-login-playground](https://github.com/L3-iGrant/passwordless-login-playground)
- **Features**:
  - Complete React frontend with EUDI Wallet login button
  - Integration with Keycloak as the identity provider
  - Step-by-step setup instructions

---

### Auth0 Configuration

Follow these steps to configure Auth0 as a relying party.

#### Step 4: Create an Application in Auth0

1. Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**.

![](./images/eo-ow-passwordless-auth0-application-1.png)
_Figure 07: Applications list_

2. Click **+ Create Application**, give your application a name (e.g. `Auth0 App`), and select the appropriate type (e.g. **Single Page Web Application** for React apps). Click **Create**.

![](./images/eo-ow-passwordless-auth0-application-2.png)
_Figure 08: Create Application_

3. In the application **Settings** tab, note the **Client ID** and **Domain**. Scroll down to **Application URIs** and fill in:
   - **Allowed Callback URLs**: Your application's post-login redirect URL (e.g. `http://localhost:18080/dashboard`)
   - **Allowed Logout URLs**: Your application's logout URL

![](./images/eo-ow-passwordless-auth0-application-3.png)
_Figure 09: Application Basic Information_

![](./images/eo-ow-passwordless-auth0-application-4.png)
_Figure 10: Application URIs_

4. Under **Advanced Settings** > **Grant Types**, ensure **Authorization Code** is enabled.

![](./images/eo-ow-passwordless-auth0-application-5.png)
_Figure 11: Grant Types_

#### Step 5: Create a Custom Social Connection

Auth0 connects to iGrant.io as a **Custom Social Connection** using the OIDC endpoints from Step 2.

1. Navigate to **Authentication** > **Social** and click **+ Create Connection**.
2. Scroll to the bottom and select **Create Custom**.

![](./images/eo-ow-passwordless-auth0-connection-2.png)
_Figure 12: Social Connections - Create Custom_

3. Set the **Purpose** to **Authentication** and click **Next**.

![](./images/eo-ow-passwordless-auth0-connection-3.png)
_Figure 13: New Custom Social Connection - Purpose_

4. Fill in the connection details using the values from Steps 2 and 3:
   - **Name**: e.g. `Passwordless-Login`
   - **Authorization URL**: The authorisation endpoint from the iGrant.io OIDC discovery document
   - **Token URL**: The token endpoint from the iGrant.io OIDC discovery document
   - **Scope**: `openid`
   - **Client ID**: (from step 3)
   - **Client Secret**: (from step 3)

![](./images/eo-ow-passwordless-auth0-connection-4.png)
_Figure 14: Connection configuration - Authorization & Token URLs_

5. In the **Fetch User Profile Script** field, enter a script that calls the iGrant.io UserInfo endpoint to retrieve the user's profile. Replace the URL with your organisation's UserInfo endpoint (found in the OIDC discovery document from Step 2). The following snippet also maps the user profile to Auth0's format. It reads the claims from `presentation["0"]`, the first presented credential.

:::note
In the **Custom Headers** field, add the `Authorization` header with the value `Basic`, followed by the base64-encoded Client ID and Client Secret (formatted as `client_id:client_secret`).
:::

```javascript
function(accessToken, ctx, cb) {
    const request = require('request');
    const options = {
        url: 'https://<your-org-api>/v3/service/extension/oidc/<organisationId>/userinfo',
        headers: {
            Authorization: `Bearer ${accessToken}`
        },
        json: true
    };

    request.get(options, (err, response, body) => {
        if (err || response.statusCode !== 200) {
            return cb(new Error('Failed to fetch user profile'));
        }

        // Map the user profile to Auth0's format
        const profile = {
            user_id: body.sub, // Unique identifier from your IdP
            username: body.presentation["0"].email,
            nickname: body.presentation["0"].given_name,
            name: body.presentation["0"].given_name + " " + body.presentation["0"].family_name,
            email: body.presentation["0"].email,
        };

        cb(null, profile);
    });
}
```

![](./images/eo-ow-passwordless-auth0-connection-5.png)
_Figure 15: Fetch User Profile Script and Client credentials_

![](./images/eo-ow-passwordless-auth0-connection-6.png)
_Figure 16: Full Fetch User Profile Script_

6. Click **Create** to save the connection.

#### Step 6: Enable the Connection for Your Application

1. Navigate back to your application (**Applications** > **Applications** > your app).
2. Go to the **Connections** tab.
3. Enable the **Passwordless-Login** custom social connection you just created.

![](./images/eo-ow-passwordless-auth0-application-6.png)
_Figure 17: Enable connection for the application_

Once enabled, Auth0 will route authentication requests to iGrant.io and use the UserInfo endpoint to populate the user's profile in Auth0.

**Note:** You can find the Redirect URI for the iGrant.io client in your Auth0 application's **Settings** tab. Update the iGrant.io OIDC client [here](/docs/extensions-api/update-oidc-client) to include it if not already done. The Redirect URI of the client must match the Redirect URI that Auth0 sends exactly.

### Try It Yourself

Watch a short demo of the passwordless login flow with the EUDI Wallet:

<YouTubeEmbed
  videoId="WysMxTDcPSc"
  title="Passwordless Login with EUDI Wallets | Secure Digital Identity Login Demo | OpenID Connect"
  description="Watch how passwordless login works with the European Digital Identity Wallet (EUDI Wallet), using the iGrant.io Organisation Wallet Suite and Data Wallet. The demo shows how organisations integrate EUDI Wallet authentication into existing IAM systems via OpenID Connect to enable secure passwordless access."
  uploadDate="2026-07-07"
  duration="PT3M51S"
  thumbnailUrl="https://i.ytimg.com/vi/WysMxTDcPSc/maxresdefault.jpg"
/>

---

# Payment Authenticator
Source: https://docs.igrant.io/docs/openID4vci-payment-wallet-attestation/

---
id: openID4vci-payment-wallet-attestation
title: Payment Authenticator
hide_title: false
description: Follow the steps to issue verifiable payment wallet attestations using OpenID4VCI, enabling secure and trusted payment authentication workflows.
sidebar_label: Payment Authenticator
keywords: [payment authenticator, payment wallet attestation, OpenID4VCI, Organisation Wallet, European Business Wallet, EUDI Wallet, PSD2, payment authentication]
slug: /openID4vci-payment-wallet-attestation/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


<head>
  <title>Issue payment wallet attestations with OpenID4VCI | iGrant.io DevDocs</title>
  <meta name="description" content="Follow the steps to issue verifiable payment wallet attestations using OpenID4VCI, enabling secure and trusted payment authentication workflows." />
</head>

import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';
import NoteBox from '@site/src/components/NoteBox';

This workflow implements [European Wallet Consortium (EWC) RFC007](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/payment-rfcs/ewc-rfc007-payment-wallet-attestation.md), as specified by the [EWC Payment Task Force](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/payment-rfcs/images/EWC-EUDI-Wallet-PaymentTaskForce.png).

It uses the [OpenID4VCI Dynamic Credential Request](/docs/eo-ow-issue-dynamic-credential-request.mdx) protocol to issue a Payment Authenticator  by authenticating the user with an identity document (e.g., PID, Passport, etc.). The following steps outline the process using OpenID4VCI as illustrated below:

![Issue Payment Authenticator - PWA](./images/ow-issue-payment-wallet-attestation-with-individual.png)

### Step 1: Get the API Key (Bank Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from '@site/src/components/ApiKeyManager';

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Webhook (Bank Issuer Admin)

To create a webhook, you can run the code block below using the **Run** button. In the request payload, you must provide your webhook URL and a secret key:

* **`<yourWebhookUrl>`**: This is the endpoint on your server that will receive real-time notifications about subscribed events, such as when a presentation is acknowledged (`openid.presentation.presentation_acked.v3`).
* **`<yourSecretKey>`**: This is a secret key that you create. It is used to secure your webhook endpoint by allowing you to verify that incoming requests are genuinely from the iGrant.io platform.

Alternatively, you can manually copy the code block and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-webhook).

import Step2 from '@site/src/components/PaymentWalletAttestationUsecase/Step2';

<Step2
  initialJsonData={{
  "webhook": {
    "payloadUrl": "https://example.com/webhook",
    "contentType": "application/json",
    "secretKey": "<random secret value for verifying webhook origin>",
    "disabled": false,
    "skipSslVerification": false,
    "subscribedEvents": {
      "consentManagementWebhook": [],
      "digitalWalletWebhook": [
        "openid.presentation.presentation_acked.v3",
        "openid.credential.credential_acked"
      ]
    }
  }
}}
/>

### Step 3: Create Presentation Definition (Bank Issuer Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

From the API response, copy the `presentationDefinitionId` for use in Step 5.

<NoteBox title="Info:">
In the example below, a national passport is used as the identification document. This can also be a EU Person Identification Data (PID) or any other similar identification as required by the Bank Issuer.
</NoteBox>

import Step3 from '@site/src/components/PaymentWalletAttestationUsecase/Step3';

<Step3
  initialJsonData={{
    label: 'ID Check with National Passport',
    presentationDefinition: {
      id: '7c94e62d-82c2-41d7-a649-6c204bf59d1c',
      input_descriptors: [
        {
          id: '7c94e62d-82c2-41d7-a649-6c204bf59d1c',
          purpose: "Share your passport details to link your wallet with your bank account and receive your connection confirmation.",
          format: {
            'dc+sd-jwt': {
              alg: ['ES256'],
            },
            'vp+sd-jwt': {
              alg: ['ES256'],
            },
          },
          constraints: {
            fields: [
              {
                path: ['$.vct'],
                filter: {
                  type: 'string',
                  contains: {
                    const: 'Passport',
                  },
                },
              },
              {
                path: ['$.firstName'],
              },
              {
                path: ['$.lastName'],
              },
              {
                path: ['$.personalNumber'],
              },
              {
                path: ['$.expiryDate'],
              },
              {
                path: ['$.nationality'],
              },
              {
                path: ['$.issuerAuthority'],
              },
            ],
            limit_disclosure: 'required',
          },
        },
      ],
    },
  }}
/>

<NoteBox title="Tip:" variant="tip">
Once a presentation definition is created, the <code>presentationDefinitionId</code> can be reused to issue multiple credentials (Step 5).
</NoteBox>

### Step 4: Create Credential Definition (Bank Issuer Admin)

To create a credential definition as per EWC RFC007, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition). From the API response, copy the `credentialDefinitionId` for use in Step 5.

The definition sets `supportInteractiveAuthorisationEndpoint` to `true`. Step 5 links the issuance to the presentation definition from Step 3 (`presentationDefinitionId`), and the API allows that only for a definition with this flag.

import Step4 from '@site/src/components/PaymentWalletAttestationUsecase/Step4';

<Step4
  initialJsonData={{
    label: "Payment Authenticator",
    vct: "PaymentWalletAttestation",
    expirationInDays: 168,
    display: {
      description:
        "You requested that your bank account be linked to your wallet. By choosing to accept, you agree to add the confirmation certificate to your wallet.",
      backgroundImage: {
        uri: "https://demo-api.igrant.io/v2/onboard/image/67a3c594c160fb4839d3f1af/web",
      },
      textColor: "#000000",
    },
    claims: {
      additionalProperties: false,
      properties: {
        fundingSource: {
          limitDisclosure: false,
          properties: {
            aliasId: {
              description: "Unique identifier assigned for the funding source.",
              limitDisclosure: true,
              type: "string",
            },
            currency: {
              description: "Currency code (ISO 4217, e.g., EUR, USD).",
              limitDisclosure: true,
              pattern: "^[A-Z]{3}$",
              type: "string",
            },
            icon: {
              description: "URI to card logo.",
              limitDisclosure: true,
              type: "string",
            },
            iin: {
              description: "Issuer Identification Number (IIN).",
              limitDisclosure: true,
              pattern: "^[0-9]{6,8}$",
              type: "string",
            },
            panLastFour: {
              description: "Last four digits of the card number.",
              limitDisclosure: true,
              pattern: "^[0-9]{4}$",
              type: "string",
            },
            parLastFour: {
              description:
                "Last four characters of the Payment Account Reference (PAR).",
              limitDisclosure: true,
              maxLength: 4,
              type: "string",
            },
            scheme: {
              description: "Card scheme.",
              enum: [
                "Visa",
                "American Express",
                "Discover",
                "JCB",
                "Mastercard",
                "UnionPay",
              ],
              limitDisclosure: true,
              type: "string",
            },
            type: {
              description: "Type of funding source.",
              enum: ["card"],
              limitDisclosure: true,
              type: "string",
            },
          },
          required: [
            "aliasId",
            "currency",
            "iin",
            "panLastFour",
            "scheme",
            "type",
          ],
          type: "object",
        },
      },
      required: ["fundingSource"],
      type: "object",
    },
    credentialFormat: "dc+sd-jwt",
    supportRevocation: true,
  }}
/>;

<NoteBox title="Tip:" variant="tip">
Once a credential definition is created, the <code>credentialDefinitionId</code> can be reused to issue multiple credentials (Step 5).
</NoteBox>

### Step 5: Issue Credential (Bank Issuer)

When you run Steps 3 and 4 on this page, the `credentialDefinitionId` and `presentationDefinitionId` fields below are autofilled automatically (and updated whenever those steps are re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<presentationDefinitionId>` with the IDs obtained in the previous steps. The Bank Issuer issues the Payment Authenticator in deferred mode after completing the necessary validations. You can run the JSON code block below using the **Run** button.

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device, such as via a browser.

import Step5 from '@site/src/components/PaymentWalletAttestationUsecase/Step5';

<Step5
  initialJsonData={{
    issuanceMode: 'Deferred',
    credentialDefinitionId: '<credentialDefinitionId>',
    presentationDefinitionId: '<presentationDefinitionId>',
  }}
/>

From the API response, copy the `credentialExchangeId` and the `credential.id` for use in Step 6. The `credential.id` corresponds to the `id` field from the `credentialDefinitions` array in the create credential definition response.

Alternatively, you can manually copy the code block, update the placeholders, and use it in the body of the API request available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential/). From the response received, copy the `credentialOffer` and generate a QR code using a QR code generator tool, or paste the response into our tool [here](/docs/devtools-qrcode-generator/). The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the credential offer on their mobile device (e.g., in a browser).

<NoteBox title="Tip:" variant="tip">
Before scanning the QR code, ensure that the Holder Wallet has onboarded the user's identity credentials as required by banking guidelines, such as a national passport or Person Identification Data (PID).
</NoteBox>

### Step 6: Update Credential Offer (Bank Issuer)

When you run Steps 4 and 5 on this page, the **Credential Exchange ID** path parameter and the `credential.id` field below are autofilled automatically (and updated whenever those steps are re-run). If you are executing the APIs yourself, use the `credentialExchangeId` from Step 5 as the path parameter and set `credential.id` to the `id` value from the `credentialDefinitions` array in the create credential definition response. Upon receiving the `openid.presentation.presentation_acked.v3` webhook event and completing the requisite identity mapping in the bank backend, update the credential offer by running the code block below using the **Run** button.

Alternatively, you can manually copy the code block, update the placeholders, and use the `credentialExchangeId` from the response as the path parameter in the API request available [here](/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history).

import Step7 from '@site/src/components/PaymentWalletAttestationUsecase/Step7';

<Step7
  initialJsonData={{
    credential: {
      claims: {
        fundingSource: {
          aliasId: "123e4567-e89b-12d3-a456-426614174000",
          currency: "EUR",
          icon: "https://storage.googleapis.com/igrant-api-images/bancatransilvaniacardart.png",
          iin: "414011",
          panLastFour: "8027",
          parLastFour: "2345",
          scheme: "Visa",
          type: "card",
        },
      },
    },
  }}
/>;

### Try It Yourself (With Demo Video)

Watch the below demo to learn Payment Authenticator issuance and try it out yourselves:

<VideoPlayer
  videoId="YCi-IEdHNRY"
  title="Payment Authenticator Demo"
  description="Learn how to issue Payment Authenticator using OpenID4VCI protocol with iGrant.io Digital Wallets."
  uploadDate="2024-01-01"
  duration="PT10M"
/>

---

# OpenID4VP - Receive and Present Credential
Source: https://docs.igrant.io/docs/openID4vp-receive-and-present-credentials/

---
id: openID4vp-receive-and-present-credentials
title: OpenID4VP - Receive and Present Credential
description: Learn how to receive and present Verifiable Credentials with OpenID4VP, enabling secure and privacy‑preserving data sharing in digital services.
keywords: [OpenID4VP, presentation, verifiable credentials, credential presentation, OID4VP, EUDI Wallet, Organisation Wallet, European Business Wallet, selective disclosure]
hide_title: false
sidebar_label: Receive and Present Credential
slug: /openID4vp-receive-and-present-credentials/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Present credentials ssing OpenID4VP workflows | iGrant.io DevDocs</title>
  <meta name="description" content="Learn how to receive and present Verifiable Credentials with OpenID4VP, enabling secure and privacy‑preserving data sharing in digital services."/>
</head>

The Wallet Unit (WU) allows both individuals and organisations to act as holders of verifiable credentials, similar to how a physical wallet holds documents or ID cards. As part of the iGrant.io Organisation Wallet Suite, the Wallet Unit supports the secure and privacy-preserving sharing of credentials, based on the OpenID for Verifiable Presentations (OpenID4VP) standard. This page explains how a Wallet Unit receives a request from a verifier, selects the relevant credentials from its storage, and sends a verifiable presentation in response. The process ensures that credentials are shared only with consent, and that trust, data minimisation, and interoperability are maintained throughout the interaction.

Below are the steps for a verification workflow where the holder receives the presentation definition, selects the matching credentials, and sends the presentation to a verifier using OpenID for Verifiable Presentation (OpenID4VP).

The Organisation Wallet Suite signs the holder proofs with the keys of your organisation. To see your keys or add a key, see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

### Step 1: Get the API Key

To get the API key, contact [support@igrant.io](mailto:support@igrant.io).

### Step 2: Receive Verification

Copy the presentation definition received from a known verifier as per OpenID4VP. This could be obtained by out-of-band means such as email or by logging into the verifier's system. Use this [endpoint](/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3) to receive the verification.

### Step 3: Filter Credentials

Use this [endpoint](/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification) to filter stored credentials against the received presentation definition.

### Step 4: Send Presentation

Use this [endpoint](/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3) to send the selected credentials to the verifier.

:::info Trust status of the verifier
The wallet checks whether the verifier can be matched against a recognised trust list. The verification response exposes this through the `isVerifiedWithTrustList` and `trustServiceProvider` fields. If the verifier cannot be matched, the Data Wallet shows a **"Service provider not verified"** warning. See [The "Service provider not verified" notice](/docs/trust-untrusted-service-provider/) and [Trust in the Wallet Ecosystem](/docs/trust-overview/).
:::

---

# OpenID4VC - Receive and Store Credential
Source: https://docs.igrant.io/docs/openID4vc-receive-and-store-credential/

---
id: openID4vc-receive-and-store-credential
title: OpenID4VC - Receive and Store Credential
description: Step‑by‑step guide to receiving and storing Verifiable Credentials using OpenID4VC flows within the Data Wallet for secure digital interactions.
keywords: [OpenID4VC, receive credential, store credential, Data Wallet, verifiable credentials, EUDI Wallet, credential holder, OID4VC]
hide_title: false
sidebar_label: Receive and Store Credential
slug: /openID4vc-receive-and-store-credential/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
    <title>Learn to receive and store credentials with OpenID4V | iGrant.io DevDocs</title>
    <meta name="description" content="Step‑by‑step guide to receiving and storing Verifiable Credentials using OpenID4VC flows within the Data Wallet for secure digital interactions."/>
</head>
The Wallet Unit (WU) enables both individuals (natural persons) and organisations (legal persons) to act as holders of verifiable credentials, much like a personal or organisational wallet functions in the physical world. As a core capability within the iGrant.io Organisation Wallet Suite architecture, the Wallet Unit enables entities, such as companies, institutions, teams, or individuals, to securely receive, store, and manage verifiable credentials in accordance with the Openid for Verifiable Credential Issuance (OpenID4VCI) standards.
This page outlines how an Organisation Wallet Suite Unit receives credentials from a trusted issuer, whether in real time or via deferred issuance flows, using secure and standards-based mechanisms. It also explains how credentials are stored for future presentation and how trust, privacy, and interoperability are maintained throughout the process. Below are the steps for requesting a credential offer from a known issuer, using the wallet-initiated flow defined by OpenID for Verifiable Credentials Issuance (OID4VCI), and is as illustrated below:

![Issue credential - DCR](./images/eo-ow-receive-and-store-credential.png)

The Organisation Wallet Suite signs the holder proofs with the keys of your organisation. To see your keys or add a key, see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a>.

### Step 1: Get the API Key (Issuer Admin)

To get the API key, contact [support@igrant.io](mailto:support@igrant.io).

### Step 2: Receive Credential

Copy the credential offer received from a known issuer as per OpenID4VCI. This offer could be received out-of-band via email or by logging into the issuer's system. Use the provided [endpoint](/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential) to obtain the credential.

If the credential is unavailable, the issuer will respond with an acceptance token, indicating that credential issuance is “Deferred.” Otherwise, the credential is issued in “InTime” mode.

If the response contains the `acceptance_token` field, the holder's wallet can request the credential using the [deferred credential endpoint](/docs/openid4vc-api/config-receive-deferred-digital-wallet-open-id-credential). If the credential is available, the state will be set to `credential_ack`. If not, it will remain in `credential_pending`, and the holder's wallet will need to keep requesting the deferred credential until it becomes available.

### Step 3: Receive Credential with User PIN

If a transaction code (or user PIN) is needed, execute [this API](/docs/openid4vc-api/config-receive-user-pin-for-digital-wallet-open-id-credential) to request the credential using the transaction code.

### Step 4: Accept the Credential to Holder Wallet
Use this [endpoint](/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the Credential to the Holder Wallet.

### Step 5: List Stored Credentials
Use this [endpoint](/docs/openid4vc-api/config-list-digital-wallet-open-id-credential) to list credentials stored in the Organisation Wallet Suite.

:::info Trust status of the issuer
When a credential is offered, the wallet checks whether the issuer can be matched against a recognised trust list, such as the EU Trust List. If it cannot, the Data Wallet shows an **"Issuer not verified"** warning. This is a trust indicator, not a validation failure. See [The "Issuer not verified" notice](/docs/trust-untrusted-service-provider/) and [Trust in the Wallet Ecosystem](/docs/trust-overview/).
:::


---

# Verify Credentials with the DC API on Android (Chrome)
Source: https://docs.igrant.io/docs/openID4vc-send-verify-credentials-dcapi-android/

---
id: openID4vc-send-verify-credentials-dcapi-android
title: Verify Credentials with the DC API on Android (Chrome)
hide_title: false
sidebar_label: Send and Verify on Android (Chrome)
slug: /openID4vc-send-verify-credentials-dcapi-android/
description: Verify credentials in Chrome on Android using the Digital Credentials API, with Credential Manager picking the wallet over OpenID4VP or ISO 18013-7.
keywords: [DC API on Android, Chrome Digital Credentials API, Android Credential Manager, OpenID4VP dc_api, ISO 18013-7 Annex C, credential verification, verifiable credentials, Organisation Wallet, European Business Wallet, EUDI Wallet, Android]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcapi-android` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcapi-android
> ```


import Link from "@docusaurus/Link";
import NoteBox from "@site/src/components/NoteBox";
import YouTubeEmbed from "@site/src/components/YouTubeEmbed";

On Android, the W3C Digital Credentials API (DC API) is invoked by **Chrome** (or another current Chromium browser, such as Edge). When your page calls `navigator.credentials.get()`, Chrome passes the request to the **Android Credential Manager**, which presents the system wallet chooser and routes the request to the wallet the holder picks. Credential Manager is an open provider model: any installed app that registers as a digital credential provider can appear in that chooser, so the iGrant.io Data Wallet answers the request alongside whatever else the holder has installed.

This guide follows the same OpenID4VP send and verify flow as the <Link to="/docs/openID4vc-send-verify-credentials/">Send and Verify Credential</Link> guide, but configures the request for the DC API on **Android**. Chrome on Android carries both DC API protocols, OpenID4VP over the DC API (`responseMode: dc_api`) and ISO/IEC 18013-7 Annex C (`org-iso-mdoc`), so Step 2 below lets you choose the protocol, credential format and response mode rather than fixing them for you. For the same flow on iPhone and iPad, where the choice is narrower, see <Link to="/docs/openID4vc-send-verify-credentials-dcapi-ios/">DC API verification in Safari on iOS</Link>.

As a verifier on Android you will:

- Define the credentials or claims you require in a presentation definition, using a DC API response mode.
- Hand the request to Chrome, which invokes Credential Manager and the holder's chosen wallet.
- Receive the verifiable presentation returned by that wallet and validate its integrity and authenticity.

<NoteBox title="DC API prerequisite on Android:" variant="tip">
<ol>
<li>Chrome 141 or later (or a current Chromium-based Edge), where the Digital Credentials API is on by default. Versions from Chrome 128 need the flag enabled at <code>chrome://flags#web-identity-digital-credentials</code>.</li>
<li>A wallet installed on the Android device that registers with Credential Manager as a digital credential provider.</li>
<li>Google Play services 24.0 or higher for the cross-device flow (a desktop QR code scanned with the phone), plus Bluetooth enabled on both devices for the proximity check.</li>
<li>A Legal Person ID (LPID) credential in your Data Wallet before trialling; see <Link to="/docs/european-business-wallet-owner-id/">European Business Wallet Owner ID</Link>.</li>
</ol>
</NoteBox>

### Step 1: Get the API Key

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from "@site/src/components/ApiKeyManager";

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition). Select the protocol and transport, DC API version, credential format and response mode in the **Request** panel below. The request body updates to match your selection. For the W3C Digital Credentials API, choose a **DC API** response mode (which sets `responseMode` to `"dc_api"` in the request body). When using a **Signed** DC API variant, `expectedOrigins` is required. It is prefilled with the origin this page is served from, so you can run the request straight away. In your own application, set it to your verifier origin so the wallet can detect replay from a malicious verifier. A **Signed** variant signs the request with a key of your organisation that has an X.509 certificate chain (client ID prefix `x509_hash`), and `cryptographicKeyIdentifier` is filled in with that key. Wallets trust a signed request when the certificate is on a trust list for relying parties (WRPAC): see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a> to get a certificate. An **Unsigned** request carries no verifier identity, so the Data Wallet shows the "Service provider not verified" notice for it.

import Step2 from "@site/src/components/VerificationDcApi/Step2";

<Step2 />

<NoteBox title="Tip:" variant="tip">
Once a presentation definition is created, the <code>presentationDefinitionId</code> can be reused to verify multiple credentials (Step 3).
</NoteBox>

### Step 3: Create Verification Request (Verifier/Relying Party)

Now you can ask a wallet for the credential you defined in Step 2. When Step 2 succeeds it fills the `presentationDefinitionId` into the request below, and that id tells the wallet which credential to present, so check that it matches the one Step 2 returned before you click **Run**. Leave `requestByReference` set to `true`, which sends the wallet a link to the request instead of the whole request and keeps larger requests working smoothly. You can also copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

Once the request succeeds, the **Request Credential** button becomes active. Clicking it hands the request to the browser, which invokes the wallet. Step 4 covers what happens next.

import Step3 from "@site/src/components/VerificationDcApi/Step3";

<Step3
  initialJsonData={{
    presentationDefinitionId: "<presentationDefinitionId>",
    requestByReference: true,
  }}
/>

The presentation definition provided adheres to the specifications outlined in the DIF Presentation Exchange standard, as detailed [here](https://identity.foundation/presentation-exchange/).

### Step 4: Send and Receive Verifiable Presentation (Android Device)

When you click **Request Credential**, Chrome takes over and hands the request to Credential Manager. What you see next depends on where the wallet is:

- **Wallet on the same Android device**: Credential Manager shows the system wallet chooser, listing every installed provider that can satisfy the request. Pick the Data Wallet, and it shows what is being requested and asks you to consent to share it. There is no QR code or camera step in this case.
- **Wallet on another device**: if you are browsing on a desktop, Chrome shows a QR code. Scan it with the Android phone (through Google Lens in the Google or Chrome app, or a camera app that supports the code) to pass the request to the wallet there, then consent to share. The two devices complete a Bluetooth proximity check, so keep them close together with Bluetooth on.

Either way, the wallet shows which claims are being requested before you agree to anything. Nothing is shared until you consent.

Once you consent, the credential is sent back to the page and a green **Credential shared successfully** message appears above the panels. The **Request Credential** button also changes to **Credential Received**, and the **Response** panel shows what was received.

### Step 5: Send and Receive Verifiable Presentation (Verifier/Relying Party)

* The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
* From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
* From decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.

:::info Trust status of the verifier
The wallet checks whether the verifier can be matched against a recognised trust list. The verification response exposes this through the `isVerifiedWithTrustList` and `trustServiceProvider` fields. If the verifier cannot be matched, the Data Wallet shows a **"Service provider not verified"** warning. See [The "Service provider not verified" notice](/docs/trust-untrusted-service-provider/) and [Trust in the Wallet Ecosystem](/docs/trust-overview/).
:::

### Try it Yourself

Watch a short demo of verifying credentials with the Digital Credentials API in Chrome on Android:

<YouTubeEmbed
  videoId="5kh5R4RsyPE"
  title="Verify Credentials with the DC API on Android using Chrome and Credential Manager"
  description="An Android walkthrough: a verifier (relying party) requests verifiable credentials from an EUDI Wallet in Chrome on Android over the W3C Digital Credentials API, using OpenID4VP with responseMode dc_api and ISO 18013-7 Annex C. The demo shows Chrome handing the request to the Android Credential Manager, the system wallet chooser listing installed providers, the holder consenting to share, and the verifier receiving and verifying the presented credential."
  thumbnailUrl="https://i.ytimg.com/vi/5kh5R4RsyPE/maxresdefault.jpg"
  uploadDate="2026-07-18"
  duration="PT1M38S"
  watchLinkText="Watch the Android DC API demo on YouTube"
/>

### Where to go next

* <Link to="/docs/openID4vc-dcapi-overview/">Digital Credentials API overview</Link>, for what the API is, what iGrant.io has implemented, and the limitations to plan around.
* <Link to="/docs/openID4vc-send-verify-credentials-dcapi-ios/">DC API verification in Safari on iOS</Link>, which uses ISO 18013-7 Annex C only and behaves differently enough to need its own request.
* <Link to="/docs/openID4vc-send-verify-credentials/">OpenID4VP send and verify credentials</Link>, the redirect-based flow to keep as a fallback where the DC API is unavailable.


---

# Verify Credentials with the DC API on iOS (Safari)
Source: https://docs.igrant.io/docs/openID4vc-send-verify-credentials-dcapi-ios/

---
id: openID4vc-send-verify-credentials-dcapi-ios
title: Verify Credentials with the DC API on iOS (Safari)
hide_title: false
sidebar_label: Send and Verify on iOS (Safari)
slug: /openID4vc-send-verify-credentials-dcapi-ios/
description: Request credentials in Safari on iPhone and iPad over ISO 18013-7 Annex C, same device or by scanning a desktop QR code, and verify the mdoc response.
keywords: [DC API on iOS, Safari Digital Credentials API, ISO 18013-7 Annex C, org-iso-mdoc, mdoc verification iPhone, WebKit credential verification, cross-device QR, Apple Wallet identity, Organisation Wallet, EUDI Wallet, iOS]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-dcapi-ios` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-dcapi-ios
> ```


import Link from "@docusaurus/Link";
import NoteBox from "@site/src/components/NoteBox";
import YouTubeEmbed from "@site/src/components/YouTubeEmbed";

On iPhone and iPad the W3C Digital Credentials API (DC API) is a **Safari** feature. Your page calls `navigator.credentials.get()` from a web context, WebKit validates the call against the page origin, and iOS then routes it to the wallet layer, which asks the holder to authorise the release of the requested claims. Because every browser on iOS is built on WebKit, the behaviour you get in Safari is the behaviour you get everywhere on the platform.

Two things make this materially different from <Link to="/docs/openID4vc-send-verify-credentials-dcapi-android/">DC API verification on Android with Chrome</Link>, and they shape the whole of this guide:

* **One protocol, not two.** Safari implements ISO/IEC 18013-7 Annex C (protocol identifier `org-iso-mdoc`) and does not offer OpenID4VP over the DC API. Requests are therefore always signed mdoc requests, and the credential format is always an ISO/IEC 18013-5 mdoc.
* **No open provider chooser.** Android hands the request to Credential Manager, where any installed wallet may register as a provider. iOS has no equivalent open registry surfaced to the web, so which wallet can answer, and which document types it may answer with, is constrained by the platform rather than by your request.

This guide otherwise follows the same send and verify flow as the <Link to="/docs/openID4vc-send-verify-credentials/">Send and Verify Credential</Link> guide, and uses the same iGrant.io APIs.

As a verifier on iOS you will:

- Define the claims you require in a presentation definition, fixed to Annex C and to a signed DC API response mode.
- Declare the origins your request may legitimately come from, since a signed request without `expectedOrigins` cannot be checked by the wallet.
- Invoke the request from Safari, on the iPhone itself or by having the iPhone scan a QR code shown by a desktop browser.
- Decrypt and validate the mdoc response returned to your page.

<NoteBox title="DC API prerequisite on iOS:" variant="tip">
<ol>
<li>Safari 26 or later, which is when the Digital Credentials API first shipped in a stable Apple browser (September 2025). There is no flag to enable it on an older version, so older devices need a fallback path rather than a setting change.</li>
<li>A page served over HTTPS from the origin you list in <code>expectedOrigins</code>. The wallet compares the calling origin against that list and will reject a mismatch.</li>
<li>For the cross-device flow (desktop browser, iPhone wallet), Bluetooth enabled on both devices, kept near each other for the proximity check.</li>
<li>An age verification credential in your Data Wallet before trialling; see the <Link to="/docs/eu-age-verification/">Age Verification workflow</Link>.</li>
</ol>
</NoteBox>

### Step 1: Get the API Key

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from "@site/src/components/ApiKeyManager";

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition). On iOS, DC API runs over ISO 18013-7 Annex C only, so the **Request** panel below comes preconfigured: the credential format is ISO/IEC 18013-5 mdoc/mDL and the response mode is **DC API, Signed**. Because the request is signed, `expectedOrigins` is required. It is prefilled with the origin this page is served from, so you can run the request straight away. In your own application, set it to your verifier origin so the wallet can detect replay from a malicious verifier. A **Signed** variant signs the request with a key of your organisation that has an X.509 certificate chain (client ID prefix `x509_hash`), and `cryptographicKeyIdentifier` is filled in with that key. Wallets trust a signed request when the certificate is on a trust list for relying parties (WRPAC): see the <a href="/docs/openid4vc-key-management/" target="_blank" rel="noopener noreferrer">key management guide</a> to get a certificate. An **Unsigned** request carries no verifier identity, so the Data Wallet shows the "Service provider not verified" notice for it.

The protocol and response mode selectors are locked here on purpose. Choosing OpenID4VP or an unsigned response mode would produce a request that Safari cannot dispatch, so the panel removes those options rather than letting you build one that fails at `navigator.credentials.get()` time.

import Step2 from "@site/src/components/VerificationDcApi/Step2";

<Step2 platform="ios" />

<NoteBox title="Tip:" variant="tip">
Once a presentation definition is created, the <code>presentationDefinitionId</code> can be reused to verify multiple credentials (Step 3).
</NoteBox>

### Step 3: Create Verification Request (Verifier/Relying Party)

Now you can ask a wallet for the credential you defined in Step 2. When Step 2 succeeds it fills the `presentationDefinitionId` into the request below, and that id tells the wallet which credential to present, so check that it matches the one Step 2 returned before you click **Run**. Leave `requestByReference` set to `true`, which sends the wallet a link to the request instead of the whole request and keeps larger requests working smoothly. You can also copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

Once the request succeeds, the **Request Credential** button becomes active. Clicking it hands the request to the browser, which invokes the wallet. Step 4 covers what happens next.

import Step3 from "@site/src/components/VerificationDcApi/Step3";

<Step3
  initialJsonData={{
    presentationDefinitionId: "<presentationDefinitionId>",
    requestByReference: true,
  }}
/>

The presentation definition provided adheres to the specifications outlined in the DIF Presentation Exchange standard, as detailed [here](https://identity.foundation/presentation-exchange/).

The response the API returns carries a per-browser request object. The client library picks the Safari variant when it detects a WebKit user agent and passes its `protocol` and `data` straight into `navigator.credentials.get()`, so you do not build the Annex C payload by hand.

### Step 4: Send and Receive Verifiable Presentation (iOS Device)

Clicking **Request Credential** calls the DC API from the page. iOS then routes the request out of the browser and into the wallet layer, and what the holder sees depends on where that wallet is.

**Same device (browsing in Safari on the iPhone or iPad).** iOS presents the request in a system-controlled sheet on top of the page. The holder reviews the claims being asked for, authorises the release, and control returns to Safari with the response. There is no QR code and no camera step in this case, and the sheet is drawn by the operating system rather than by your page, so you cannot style or script it.

**Cross device (browsing on a desktop, wallet on the iPhone).** The desktop browser displays a QR code that encodes the hand-off, not the credential. Scanning it with the iPhone hands the request to the wallet on the phone. The two devices then establish an end-to-end encrypted channel and complete a Bluetooth proximity check, which is why both need Bluetooth on and need to be physically close. The holder consents on the phone, and the response travels back to the desktop page that made the call, so the desktop tab must stay open for the whole exchange.

In both cases the holder sees the requested claims before anything leaves the device, and because the credential is an mdoc, selective disclosure applies: an age check can return only an "over 18" result rather than a date of birth.

Once the holder consents, the credential is returned to the page, a green **Credential shared successfully** message appears above the panels, the **Request Credential** button changes to **Credential Received**, and the **Response** panel shows what came back. An Annex C response arrives as a base64 `Response` field holding an encrypted mdoc response, which is forwarded to the receive endpoint for decryption, so the raw value in the panel is not readable until the backend has processed it. If the holder dismisses the sheet, the API rejects with `NotAllowedError` or `AbortError`, which the page reports as a cancelled wallet operation rather than a failure of your request.

### Step 5: Send and Receive Verifiable Presentation (Verifier/Relying Party)

* The verifier (relying party) receives the requested credentials and can verify them. Read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
* From the response received, the `vpTokenResponse` can be decoded using the [JWT Decoder](/docs/devtools-jwt-decoder/).
* Because the credential itself is an ISO/IEC 18013-5 mdoc rather than a JWT, use the [mdoc Decoder](/docs/devtools-mdoc-decoder/) to inspect the namespaces and the individual disclosed elements.

:::info Trust status of the verifier
Annex C authenticates the verifier to the wallet through reader authentication, so the holder is shown who is asking before any element is released. On top of that, the wallet checks whether the verifier can be matched against a recognised trust list, exposed in the response through the `isVerifiedWithTrustList` and `trustServiceProvider` fields. If the verifier cannot be matched, the Data Wallet shows a **"Service provider not verified"** warning. See [The "Service provider not verified" notice](/docs/trust-untrusted-service-provider/) and [Trust in the Wallet Ecosystem](/docs/trust-overview/).
:::

### Try it Yourself

Watch a short demo of verifying credentials with the Digital Credentials API in Safari on iOS:

<YouTubeEmbed
  videoId="j8cts3VnKYY"
  title="Verify Credentials in Safari on iOS with the DC API over ISO 18013-7 Annex C"
  description="An iOS walkthrough: a verifier (relying party) requests verifiable credentials from an EUDI Wallet in Safari on iPhone over the W3C Digital Credentials API, using ISO 18013-7 Annex C (protocol org-iso-mdoc) with a signed request and expectedOrigins. The demo shows the system consent sheet on the device, the holder authorising the release of selected mdoc elements, and the verifier decrypting and validating the response."
  thumbnailUrl="https://i.ytimg.com/vi/j8cts3VnKYY/maxresdefault.jpg"
  uploadDate="2026-07-18"
  duration="PT2M1S"
  watchLinkText="Watch the iOS DC API demo on YouTube"
/>

### Frequently asked questions about the DC API on iOS

**Which protocols can I request in Safari?**
Only ISO/IEC 18013-7 Annex C, identified as `org-iso-mdoc`. OpenID4VP over the DC API is not implemented in Safari, so a request built with `responseMode: dc_api` for OpenID4VP will not reach a wallet on iOS. If your verifier supports both platforms, build the request per platform rather than sending one shape everywhere.

**Will this work in Chrome or Firefox on my iPhone?**
Those browsers use WebKit on iOS, so they inherit Safari's DC API implementation and its Annex C limitation. You do not get Chrome's OpenID4VP support by installing Chrome on an iPhone. Test against Safari and treat the others as the same engine.

**Which credentials can actually be requested on iOS?**
Requests are limited to ISO 18013-5 mdocs, and iOS recognises only a fixed set of five mobile document type categories defined by Apple's Identity Document Services: EU age verification, EU personal ID (PID), photo ID, the Japan MyNumber card, and the mobile driving licence (mDL). A document is only requestable if the holder has provisioned one of these on the device. The two EU categories, age verification and PID, are the ones most relevant to European Digital Identity use cases. See <Link to="/docs/openID4vc-dcapi-overview/">the DC API overview</Link> for the identifiers and constraints.

**Do I need a certificate or registration from Apple to act as a verifier?**
Annex C requires reader authentication, so your request is signed with a certificate the wallet can check, and signed requests must carry `expectedOrigins` matching the page that calls the API. Where the credential comes from Apple Wallet, Apple additionally requires the verifier to obtain a signing certificate from Apple and use the Verify with Wallet mechanism. Plan for certificate issuance and renewal as part of your release process, not as a one-off setup step.

**Can a native iOS app request credentials without a browser?**
No. The DC API is a web platform API, and Apple has not shipped a native app-to-app verification equivalent, so a native iOS verifier needs a web view to make the call. A native app can act as a credential provider, but not as a requester. On Android the same capability is also exposed natively through Credential Manager, which is a genuine architectural difference between the two platforms rather than a temporary gap.

**Why does my request succeed on Android but fail on iOS?**
The usual causes, in order: the request was built for OpenID4VP instead of Annex C, `expectedOrigins` does not match the origin actually serving the page (a staging host or a preview URL is a common culprit), the credential requested is not one iOS can present, or the Safari version predates 26. A cancelled sheet reports as `NotAllowedError` or `AbortError`, which means the holder declined rather than that the request was malformed.

### Where to go next

* <Link to="/docs/openID4vc-dcapi-overview/">Digital Credentials API overview</Link>, for the specification's maturity, browser support and the limitations to plan around.
* <Link to="/docs/openID4vc-send-verify-credentials-dcapi-android/">DC API verification on Android with Chrome</Link>, where Credential Manager and OpenID4VP change the flow.
* <Link to="/docs/openID4vc-send-verify-credentials/">OpenID4VP send and verify credentials</Link>, the redirect-based flow to fall back on for browsers and devices where the DC API is unavailable.


---

# Digital Credentials API (DC API) - Overview
Source: https://docs.igrant.io/docs/openID4vc-dcapi-overview/

---
id: openID4vc-dcapi-overview
title: Digital Credentials API (DC API) - Overview
hide_title: false
sidebar_label: Overview
slug: /openID4vc-dcapi-overview/
description: An introduction to the W3C Digital Credentials API (DC API), how it works in the browser, what iGrant.io has implemented for send and verify, and the practical findings and limitations to plan around.
keywords: [Digital Credentials API, DC API, W3C, OpenID4VP, ISO 18013-7, org-iso-mdoc, navigator.credentials, Data Wallet, EUDI Wallet, verifiable credentials, cross-device, Android, iOS]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

import Link from "@docusaurus/Link";
import NoteBox from "@site/src/components/NoteBox";

The W3C **Digital Credentials API (DC API)** lets a website request verifiable credentials directly from a wallet on the user's device, brokered by the browser and the operating system, without a redirect or a custom app link. This page introduces the API, explains how the iGrant.io Data Wallet uses it, and sets out the practical findings and limitations a new implementer should plan around.

If you want to try it, see the platform guides: <Link to="/docs/openID4vc-send-verify-credentials-dcapi-android/">DC API verification on Android with Chrome</Link> and <Link to="/docs/openID4vc-send-verify-credentials-dcapi-ios/">DC API verification in Safari on iOS</Link>. The two flows differ enough that they are documented separately; see <a href="#dc-api-on-android-vs-ios">DC API on Android vs iOS</a> below for the summary.

## What the DC API is

The Digital Credentials API is a browser API developed in the W3C Federated Identity Working Group. It exposes a single call that a relying party makes from a web page:

```js
const credential = await navigator.credentials.get({
  digital: {
    requests: [{ protocol, data }],
  },
});
```

The browser and the operating system mediate the request: they present a wallet chooser, hand the request to the selected wallet, and return the wallet's response to the page. The request carries a `protocol` (for example, OpenID4VP or ISO 18013-7 Annex C) and a protocol-specific `data` object.

For example, a relying party asking for proof that the holder is over 18, as an OpenID4VP presentation over the DC API, builds the call like this:

```js
const credential = await navigator.credentials.get({
  digital: {
    requests: [
      {
        protocol: "openid4vp",
        data: {
          response_type: "vp_token",
          response_mode: "dc_api",
          nonce: "n-0S6_WzA2Mj",
          dcql_query: {
            credentials: [
              {
                id: "age_check",
                format: "dc+sd-jwt",
                meta: { vct_values: ["https://example.com/age-verification"] },
                claims: [{ path: ["age_equal_or_over", "18"] }],
              },
            ],
          },
        },
      },
    ],
  },
});
```

The wallet returns a `vp_token` in its response, which the relying party then verifies.

Two design properties matter for relying parties:

* **Browser and OS mediation.** The website never talks to the wallet directly and cannot enumerate installed wallets. The user chooses which wallet responds, and the browser binds the request to the page's origin, which makes the exchange phishing-resistant.
* **Same-device and cross-device.** On a phone, the wallet on the same device responds. On a desktop, the browser shows a QR code that the user scans with their phone; a secure, end-to-end encrypted channel with a Bluetooth (CTAP/BLE) proximity check is then established between the two devices.

## What iGrant.io has implemented

The Data Wallet supports the DC API for the **send and verify** (presentation) flow, where a verifier requests credentials and the wallet presents them through the browser. The implementation covers:

* **Protocols:** OpenID for Verifiable Presentations over the DC API (`responseMode: dc_api`) and ISO/IEC 18013-7 Annex C (protocol `org-iso-mdoc`).
* **Response modes:** DC API **Signed** and DC API **Unsigned**. Signed requests require `expectedOrigins` so the wallet can detect a replayed request from a malicious verifier.
* **Credential formats:** IETF SD-JWT and ISO/IEC 18013-5 mdoc/mDL. W3C VC (JWT) is not offered over the DC API.
* **Same-device and cross-device** presentation, with the cross-device flow driven by the browser's QR code.
* **Platform split:** the Android flow supports OpenID4VP and ISO 18013-7, while the iOS flow supports ISO 18013-7 Annex C only. This mirrors browser support (see the findings below), which is why the Android and iOS guides differ.

## DC API on Android vs iOS

A verifier cannot send one identical request to both platforms. The table below summarises what changes, and the two guides show the resulting requests in full.

| | Android | iOS |
| --- | --- | --- |
| **Invoking browser** | Chrome 141 or later, and current Chromium-based Edge | Safari 26 or later; every iOS browser is WebKit-based, so this applies to all of them |
| **Wallet invocation** | Chrome hands the request to the Android Credential Manager, which shows an open chooser of installed provider apps | iOS routes the request to the wallet layer and presents a system consent sheet; there is no open provider chooser exposed to the web |
| **Protocols and formats** | OpenID4VP over the DC API (`responseMode: dc_api`) and ISO 18013-7 Annex C (`org-iso-mdoc`); IETF SD-JWT and ISO/IEC 18013-5 mdoc/mDL | ISO 18013-7 Annex C only, signed requests, ISO/IEC 18013-5 mdoc only |
| **Requestable credentials** | Any credential an installed wallet can present, in SD-JWT or mdoc/mDL; the verifier is not limited to a fixed catalogue | Only the five fixed mobile document types Apple's Identity Document Services defines (EU age verification, EU PID, photo ID, Japan MyNumber, mDL), as ISO 18013-5 mdocs; arbitrary OpenID4VP or third-party wallet credentials cannot be requested (see [the supported document types](#3-ios-restricts-requests-to-a-fixed-apple-controlled-set-of-credentials)) |
| **Cross-device support** | Yes, from Chrome 136 on the desktop; needs Google Play services 24.0 or higher and a Bluetooth proximity check | Yes: a desktop browser shows a QR code that the iPhone scans, followed by a Bluetooth proximity check |
| **Native app without a browser** | Yes, through Credential Manager's `DigitalCredential` API | No; a web view is required, as Apple has no native app-to-app verification API |

Full walkthroughs: <Link to="/docs/openID4vc-send-verify-credentials-dcapi-android/">DC API verification on Android with Chrome</Link> and <Link to="/docs/openID4vc-send-verify-credentials-dcapi-ios/">DC API verification in Safari on iOS</Link>.

## Findings and limitations

The DC API is promising but young. The points below are the main things to plan around, based on the current state of the specification and browser support.

### 1. The specification is still a draft

The DC API is a **W3C Working Draft** on the Recommendation track, having moved from the Web Incubator Community Group (WICG) to the W3C Federated Identity Working Group. It is stable enough to build against but is explicitly described as under active development, and breaking changes should be expected. The request shape has already changed once (from a `providers` array to the current `requests` array), and at the W3C TPAC meeting in November 2025 the open protocol registry was removed in favour of a fixed set of protocols named in the specification (OpenID4VP, OpenID4VCI, and ISO 18013-7 Annex C).

### 2. Android and iOS implementations differ

The two shipping implementations do not support the same protocols:

* **Chrome (Android and desktop)** supports both OpenID4VP and ISO 18013-7 Annex C (`org-iso-mdoc`), and uses the Android Credential Manager so any installed wallet can register as a provider.
* **Safari (iOS, iPadOS, and macOS)** supports the `org-iso-mdoc` protocol only, that is, ISO 18013-7 Annex C. On iOS the API is further restricted: Apple limits it to a small, Apple-controlled set of credential types, so the credentials that can be requested on iOS are narrower and gated by Apple, unlike Android's open provider model where any installed wallet can respond.

The practical consequence is that a relying party cannot send one identical request to every platform. The request has to be built per platform, which is why iGrant.io ships separate Android and iOS guides. The iOS restriction to a fixed set of Apple-approved credentials is covered in the next point.

The platforms also differ in whether a browser is required. The DC API is a web platform API, so on iOS it works only inside a browser or web view (Safari, and other iOS browsers, which are all WebKit-based). Apple has not shipped a native app-to-app verification API, so a native iOS app can act as a credential provider but cannot request credentials without a web view. On Android the same capability is also exposed natively through Credential Manager's `DigitalCredential` API, so a native Android app can request an OpenID4VP presentation directly, with no browser involved. A native verifier app can therefore use the DC API without a browser on Android, but not on iOS.

### 3. iOS restricts requests to a fixed, Apple-controlled set of credentials

On iOS the DC API can only request the mobile document types that Apple's Identity Document Services framework recognises, presented as ISO 18013-5 mdocs over ISO 18013-7 Annex C. There is no open provider model as there is on Android, so a relying party cannot request an arbitrary OpenID4VP credential or one held in a third-party wallet, only these document types.

Apple defines a fixed set of five mobile document type categories, enumerated as the possible values of the <a href="https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.identity-document-services.document-provider.mobile-document-types" target="_blank" rel="noopener noreferrer"><code>document-provider.mobile-document-types</code> entitlement</a>:

* **EU age verification** (`eu.europa.ec.av.1`)
* **EU personal ID (PID)** (`eu.europa.ec.eudi.pid.1`)
* **Photo ID** (`org.iso.23220.photoid.1`)
* **Japan MyNumber card** (`org.iso.23220.1.jp.mnc`)
* **Mobile driving licence, mDL** (`org.iso.18013.5.1.mDL`)

A document is only requestable if the holder has provisioned one of these types in a wallet on the device (for example a US state mDL under the mDL category, or the Japan MyNumber card). The set of categories is defined and gated by Apple, not open to arbitrary issuers. The two EU categories, age verification and PID, are the ones most relevant to European Digital Identity use cases.

Two further constraints apply. The verifier must obtain a signing certificate from Apple and use the Verify with Wallet mechanism, so the website is authenticated to the wallet through reader authentication (ISO 18013-5 and ISO 18013-7 Annex C) before any data is released. And because every requestable credential is an ISO 18013-5 mdoc, selective disclosure is supported, for example sharing only an "over 18" result, but the available set is fixed by Apple rather than open to any issuer.

### 4. Browser and OS support is recent and uneven

The API shipped in stable browsers only in late 2025: **Chrome 141** and **Safari 26** (September 2025). Same-device presentation on Android was available earlier, from Chrome 128, behind the flag at `chrome://flags#web-identity-digital-credentials`; cross-device presentation (a desktop QR scanned with an Android phone) arrived in Chrome 136. The DC API on Android also depends on Google Mobile Services: the cross-device flow requires Google Play services 24.0 or higher, and scanning its QR code was first available only on the Pixel camera, with other Android vendors now updating their camera apps to support it. Google Lens, reached through the Google or Chrome app, is one way to scan the code, but it is not itself the requirement. The dependency is Google Play services, not Google Lens, so devices without Google services are not supported for this flow. Firefox carries baseline code but Mozilla holds a negative standards position, so it should not be relied on. In short, coverage is improving quickly but is not yet universal, and older browser versions still need a flag.

### 5. The user experience has more friction than a redirect

Compared with a redirect-based OpenID4VP flow, the DC API adds steps and variability:

* The cross-device flow (verifier on one device, wallet on another) requires the user to scan a QR code shown by the verifier's browser, using the phone's camera or a supported QR scanner (Google Lens or a compatible camera app on Android, the Camera app on iOS), and then pass a Bluetooth proximity check between the two devices, so both must have Bluetooth on and be near each other. The camera or QR scan only appears in this cross-device case; it is the entry point for the hand-off, not a restriction on the API itself.
* The same-device flow, where the verifier and the wallet are on the same phone, shows an operating-system wallet chooser directly, with no QR code or camera step. Its appearance and behaviour still vary by platform and version.
* Until recently the API sat behind a browser flag, and the wallet invocation and consent screens are not identical across platforms.

For a first-time user this is less predictable than a single redirect, and it is worth testing the exact flow on each target platform rather than assuming a common experience.

### 6. Protocol and response-mode fragmentation

Even within the DC API there are several shapes to handle: OpenID4VP over the DC API, ISO 18013-7 Annex C (`org-iso-mdoc`), and encrypted response variants (`dc_api.jwt`). Signed and unsigned response modes behave differently, and signed requests require `expectedOrigins`. Getting a working end-to-end flow means matching the protocol, format, and response mode that the target platform and wallet actually support.

<NoteBox title="Why adopt it despite the rough edges:" variant="tip">
The DC API brings real benefits: in-browser, phishing-resistant presentation with no redirect, browser and OS mediation, and selective disclosure. Adoption is growing: the EUDI Wallet Architecture and Reference Framework <a href="https://github.com/eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework/blob/main/docs/discussion-topics/f-digital-credential-api.md" target="_blank" rel="noopener noreferrer">conditionally requires DC API support</a> (requirement OIA_08), and public issuers such as the California DMV have added it. Building on it now, while planning for change, is a reasonable bet.
</NoteBox>

## When to use the DC API

Use the DC API when you want an in-browser, phishing-resistant presentation without a redirect or app link, and your target users are on recent Chrome or Safari. Plan to build platform-specific requests (OpenID4VP plus ISO 18013-7 on Chrome; ISO 18013-7 Annex C on Safari), and keep a redirect-based OpenID4VP path as a fallback for browsers and platforms where the DC API is not available. Because the specification is still moving, isolate the DC API request construction so you can adapt to protocol and IDL changes without reworking the rest of your integration.

## Related pages and references

* <Link to="/docs/openID4vc-send-verify-credentials-dcapi-android/">Verify credentials with the DC API on Android (Chrome and Credential Manager)</Link>
* <Link to="/docs/openID4vc-send-verify-credentials-dcapi-ios/">Verify credentials with the DC API in Safari on iOS (ISO 18013-7 Annex C)</Link>
* <Link to="/docs/openID4vc-send-verify-credentials/">OpenID4VP - Send and Verify Credentials</Link> (redirect-based flow)
* <Link to="/concepts/openid4vci-credential-issuance/">OpenID4VCI credential issuance</Link>
* <Link to="/concepts/openid4vp-credential-verification/">OpenID4VP credential verification</Link>
* [W3C Digital Credentials specification](https://www.w3.org/TR/digital-credentials/)
* [Digital Credentials API on Chrome for Developers](https://developer.chrome.com/blog/digital-credentials-api-shipped)
* [Cross-device Digital Credentials API in Chrome desktop](https://developer.chrome.com/blog/digital-credentials-cross-device-ot)
* [EUDI Wallet ARF, Digital Credentials API (Topic F, requirement OIA_08)](https://github.com/eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework/blob/main/docs/discussion-topics/f-digital-credential-api.md)


---

# Verify Credentials with OpenID4VP
Source: https://docs.igrant.io/docs/openID4vc-send-verify-credentials/

---
id: openID4vc-send-verify-credentials
title: "Verify Credentials with OpenID4VP"
hide_title: true
sidebar_label: Send and Verify Credential
slug: /openID4vc-send-verify-credentials/
description: "Step-by-step OpenID4VP verification: get an API key, build a presentation definition, generate the QR request, and validate the returned presentation, with code."
keywords: [OpenID4VP, credential verification, OID4VP, verifiable credentials, presentation definition, DCQL, relying party, verifier, Organisation Wallet, European Business Wallet, EUDI Wallet, API, send credentials]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import Link from "@docusaurus/Link";
import VideoPlayer from "@site/src/components/VideoPlayer";
import NoteBox from "@site/src/components/NoteBox";

<head>
  <title>Verify Credentials with OpenID4VP: API Guide &amp; Code Examples</title>
  <meta name="description" content="Step-by-step OpenID4VP verification: get an API key, build a presentation definition, generate the QR request, and validate the returned presentation, with code." />
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp" />
  <script type="application/ld+json">
    {JSON.stringify({
      "@context": "https://schema.org",
      "@graph": [
        {
          "@type": "Article",
          "headline": "Verify Credentials with OpenID4VP",
          "image": "https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp",
          "author": { "@type": "Organization", "name": "iGrant.io", "url": "https://igrant.io" },
          "publisher": {
            "@type": "Organization",
            "name": "iGrant.io",
            "url": "https://igrant.io",
            "logo": { "@type": "ImageObject", "url": "https://igrant.io/assets/images/favicons/preview.png" }
          },
          "dateModified": "2026-07-18",
          "mainEntityOfPage": "https://docs.igrant.io/docs/openID4vc-send-verify-credentials/"
        },
        {
          "@type": "FAQPage",
          "mainEntity": [
            {
              "@type": "Question",
              "name": "What is OpenID4VP?",
              "acceptedAnswer": { "@type": "Answer", "text": "OpenID for Verifiable Presentations (OpenID4VP) is an OpenID Foundation specification that defines how a verifier (relying party) requests verifiable credentials from a holder's wallet and how the wallet returns them for cryptographic verification, typically via a QR code, deeplink or NFC tag." }
            },
            {
              "@type": "Question",
              "name": "How does a verifier verify a credential with OpenID4VP?",
              "acceptedAnswer": { "@type": "Answer", "text": "The verifier creates a presentation definition describing the required credentials or claims, sends a verification request (often as a QR code), and receives a vp_token from the holder. The verifier then cryptographically verifies the presentation and can check the issuer against a recognised trust list." }
            },
            {
              "@type": "Question",
              "name": "What is a presentation definition?",
              "acceptedAnswer": { "@type": "Answer", "text": "A presentation definition is a JSON object that specifies which credentials and claims a verifier requires. It can follow the DIF Presentation Exchange standard, or you can use the newer Digital Credential Query Language (DCQL) introduced in OpenID4VP 1.0." }
            },
            {
              "@type": "Question",
              "name": "Can a verifier request only specific claims from a credential?",
              "acceptedAnswer": { "@type": "Answer", "text": "Yes. Using selective disclosure, a verifier can request only the specific claims it needs, such as an age-over-18 boolean instead of a full date of birth, so the holder shares the minimum data required for the transaction." }
            }
          ]
        }
      ]
    })}
  </script>
</head>

# Verify Credentials with OpenID4VP

In the realm of digital identity, verifiers, also known as Relying Parties (RP), play a crucial role in validating the authenticity of presented credentials. Utilising the OpenID for Verifiable Presentations (OpenID4VP) protocol, verifiers can request, receive, and assess verifiable credentials in a secure and standardised manner.​
This guide outlines the process for verifiers to follow:

- Define the specific credentials or claims they require through a presentation definition.
- Initiate a verification request to holders, often facilitated via QR codes or direct links.
- Receive and validate the verifiable presentation returned by the holder's wallet, ensuring the data's integrity and authenticity.​

By following the steps below, verifiers can request digital credentials and verify them, fostering trust in digital interactions.

### Step 1: Get the API Key

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from "@site/src/components/ApiKeyManager";

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

import Step2 from "@site/src/components/Verification/Step2";

<Step2
  requestBodyOptions={[
    {
      label: "W3C VC (JWT)",
      requestBodyJson: {
        label: "Legal PID (W3C VC)",
        presentationDefinition: {
          id: "66e3e5b5-df50-4eab-a8ef-8945c3b68d2c",
          input_descriptors: [
            {
              id: "71cec094-d5df-4df0-b2a3-1f7ce938373e",
              name: "",
              purpose: "",
              format: {
                jwt_vc_json: {
                  alg: ["ES256"],
                },
              },
              constraints: {
                fields: [
                  {
                    path: ["$.type"],
                    filter: {
                      type: "array",
                      contains: {
                        const: "LegalPersonIdentificationData",
                      },
                    },
                  },
                  {
                    path: ["$.credentialSubject.identifier"],
                  },
                  {
                    path: ["$.credentialSubject.legalName"],
                  },
                ],
              },
            },
          ],
        },
      },
    },
    {
      label: "IETF SD-JWT",
      requestBodyJson: {
        label: "Legal PID (SD-JWT)",
        presentationDefinition: {
          id: "d70b761e-4f4d-4261-9c2a-b0ca05cc15dd",
          input_descriptors: [
            {
              id: "94e44bf9-fefb-4dad-8908-42950d268143",
              name: "",
              purpose: "",
              format: {
                "dc+sd-jwt": {
                  alg: ["ES256"],
                },
                "vp+sd-jwt": {
                  alg: ["ES256"],
                },
              },
              constraints: {
                fields: [
                  {
                    path: ["$.vct"],
                    filter: {
                      type: "string",
                      const: "LegalPersonIdentificationData",
                    },
                  },
                  {
                    path: ["$.identifier"],
                  },
                  {
                    path: ["$.legalName"],
                  },
                ],
                limit_disclosure: "required",
              },
            },
          ],
        },
      },
    },
  ]}
/>

<NoteBox title="Tip:" variant="tip">
Once a presentation definition is created, the <code>presentationDefinitionId</code> can be reused to verify multiple credentials (Step 3).
</NoteBox>

### Step 3: Create Verification Request (Verfier/Relying Party)

When you run Step 2 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 2. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

import Step3 from "@site/src/components/Verification/Step3";

<Step3
  initialJsonData={{
    presentationDefinitionId: "<presentationDefinitionId>",
    requestByReference: true,
  }}
/>

The presentation definition provided adheres to the specifications outlined in the DIF Presentation Exchange standard, as detailed [here](https://identity.foundation/presentation-exchange/).

:::tip Building queries with DCQL instead?
OpenID4VP 1.0 introduces the **Digital Credential Query Language (DCQL)** as the modern successor to DIF Presentation Exchange. Start with the [DCQL overview](/docs/dcql-overview/), then work through a runnable, step-by-step tutorial for your scenario:

- [Trusted Authorities](/docs/dcql-basic-credential-query-with-trusted-authority/) - restrict a credential to trusted issuers
- [Claim Sets (Selective Disclosure)](/docs/dcql-2-4-2-claim-set-age-verification/) - age verification with minimal disclosure
- [Credential Sets (Alternatives)](/docs/dcql-2-4-3-credential-set-proof-of-identity-alternatives/) - accept any one of several identity credentials
- [Combined Credential Sets](/docs/dcql-2-4-4-kyc-request-photo-id-address-proof/) - KYC with Photo ID plus address proof
- [Mandatory and Optional Sets](/docs/dcql-2-4-5-student-transport-pass/) - student transport pass with optional extras
- [Multiple Credential Instances](/docs/dcql-2-4-6-loan-application-multiple-bank-statements/) - request several recent bank statements
- [Values Constraint](/docs/dcql-2-4-7-delivery-service-restricted-postal-codes/) - accept a credential only for allowed postal codes
:::

### Step 4: Send and Receive Verifiable Presentation (Holder)

The holder wallet accepts (consents) to send the requested credentials.

### Step 5: Send and Receive Verifiable Presentation (Verifier/Relying Party)

* The Verfier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).
* From the response received, the `vpTokenResponse` can be decoded using [JWT Decoder](/docs/devtools-jwt-decoder/).
* From decoded response, the `verifiableCredential` inside the 'vp' can be further decoded to view the received credentials.

:::info Trust status of the verifier
The wallet checks whether the verifier can be matched against a recognised trust list. The verification response exposes this through the `isVerifiedWithTrustList` and `trustServiceProvider` fields. If the verifier cannot be matched, the Data Wallet shows a **"Service provider not verified"** warning. See [The "Service provider not verified" notice](/docs/trust-untrusted-service-provider/) and [Trust in the Wallet Ecosystem](/docs/trust-overview/).
:::

## Try It Yourself (With Demo Video)

Watch the below demo to learn verify credential API and try it out yourselves:

<VideoPlayer
  videoId="xD4TLfdnSG0"
  title="OpenID4VP Verification Demo"
  description="Learn how to send and verify credentials using OpenID4VP protocol with iGrant.io Digital Wallets."
  uploadDate="2024-01-01"
  duration="PT10M"
/>


---

# Payment Data Confirmation
Source: https://docs.igrant.io/docs/openID4vci-payment-data-confirmation/

---
id: openID4vci-payment-data-confirmation
title: Payment Data Confirmation
hide_title: false
description: Learn how to issue and confirm payment‑related Verifiable Credentials with OpenID4VCI, supporting secure transactions and data validation processes.
sidebar_label: Payment Data Confirmation
keywords: [payment data confirmation, OpenID4VCI, verifiable credentials, Organisation Wallet, European Business Wallet, EUDI Wallet, payment verification, secure transactions]
slug: /openID4vci-payment-data-confirmation/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
<title>Confirm payment data using OpenID4VCI with iGrant.io | iGrant.io DevDocs</title>
<meta name="description" content="Learn how to issue and confirm payment‑related Verifiable Credentials with OpenID4VCI, supporting secure transactions and data validation processes."/>
</head>

import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';
import NoteBox from '@site/src/components/NoteBox';

This workflow implements [European Wallet Consortium (EWC) RFC008](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/payment-rfcs/ewc-rfc008-payment-data-confirmation.md), as specified by the EWC Payment Task Force. It uses the OpenID for Verifiable Presentation (OpenID4VP) protocol with "payment transaction data" to confirm payments. The figure below, shows also aspects from [EWC RFC007](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/payment-rfcs/ewc-rfc007-payment-wallet-attestation.md) to fullfill the entire process.

![Payment Confirmation with PWA and Transaction Data](./images/ow-payment-confirmation.png)

### Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from '@site/src/components/ApiKeyManager';

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Payment Definition (Merchant Verifier Admin)

In this step, the merchant admin is creating a presentation definition for receiving the payments for transactions. To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

import Step2 from '@site/src/components/PaymentDataConfirmation/Step2';

<Step2 environment="demo" />

<NoteBox title="Tip:" variant="tip">
Once a presentation definition is created, the <code>presentationDefinitionId</code> is autofilled in Step 3 automatically (and updated whenever Step 2 is re-run). You can also reuse the same <code>presentationDefinitionId</code> to issue multiple credentials.
</NoteBox>

### Step 3: Send Payment Request (Merchant/Relying Party)

Here, the merchant requests payments from the holder the transaction data while requesting verification of the Payment Authenticator. When you run Step 2 on this page, the <code>presentationDefinitionId</code> field below is autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace <code>&lt;presentationDefinitionId&gt;</code> with the ID obtained in Step 2. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3).

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then confirm the transaction using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

import Step3 from '@site/src/components/PaymentDataConfirmation/Step3';

<Step3
  initialJsonData={{
  "presentationDefinitionId": "<presentationDefinitionId>",
  "requestByReference": true,
  "transactionData": {
    "payment_data": {
      "payee": "Fast Ferries",
      "currency_amount": {
        "currency": "EUR",
        "value": 5
      }
    }
  }
}}
/>

### Step 4: Confirm Payment (Holder)

The EUDI Wallet/Holder receives the request to payment (PWA+Transaction) from the merchant. The holder can now confirm the payment using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the "Pay" link on their mobile device, such as via a browser.

### Step 5: Validate Payment Confirmation (Merchant Verifier/Relying Party)

If a webhook is configured, upon receiving the `openid.presentation.presentation_acked.v3` webhook event, the merchant captures the payment confirmation data. It now sends it to the card/psp issuer via 3DS or any existing payment protocols for payment confirmation/validation. When you run Step 3 on this page, the **Presentation Exchange ID** path parameter below is autofilled automatically (and updated whenever Step 3 is re-run). If you are executing the APIs yourself, use the `presentationExchangeId` from Step 3. You can run the JSON code block below using the **Run** button.

import Step5 from '@site/src/components/PaymentDataConfirmation/Step5';

<Step5 />

### Step 6: Validate Transaction Data (PSP/Bank Issuer)

In this step, the PSP/Bank validates the transaction data against the Payment Authenticator key pair. When you run Step 5 on this page, the `paymentWalletAttestation` and `transactionDataBase64` fields below are autofilled automatically (and updated whenever Step 5 is re-run). You can run the JSON code block below using the **Run** button.

import Step6 from '@site/src/components/PaymentDataConfirmation/Step6';

<Step6
  initialJsonData={{
  "transactionDataHashesAlg": [
    "sha-256"
  ],
  "paymentWalletAttestation": "<vpTokenResponse>",
  "transactionDataBase64": "<transactionDataBase64>"
}}
/>

### Try It Yourself (With Demo Video)

Watch the below demo to learn Payment Data Confirmation workflow and try it out yourselves:

<VideoPlayer
  videoId="0xd_7peSNXU"
  uploadDate="2024-01-01"
  duration="PT10M"
/>

---

# Platform Admin Guide
Source: https://docs.igrant.io/docs/platform-admin-guide/

---
id: eo-platform-admin-guide
title: Platform Admin Guide
description: Administration guide for the iGrant.io platform.
hide_title: false
sidebar_label: Platform Admin Guide
slug: /platform-admin-guide/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


# Platform Admin Guide

Administration guide for the iGrant.io platform.


---

# Sandbox Organisations
Source: https://docs.igrant.io/docs/sandbox-organisations/

---
id: eo-sandbox-organisations
title: Sandbox Organisations
description: Create isolated test environments to simulate multi-party credential ecosystems
hide_title: false
sidebar_label: Sandbox Organisations
keywords: [sandbox, test environment, credential ecosystem, Organisation Wallet, multi-tenant, iGrant.io]
slug: /sandbox-organisations/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


**Prerequisite:** Your organisation must be onboarded as a tenant on the [Organisation Wallet Suite](/docs/organisation-wallet-overview/) by iGrant.io. Sandbox organisations are a built-in feature of every tenant account. If you do not yet have a tenant, contact [support@igrant.io](mailto:support@igrant.io) to get started.

## Overview

Sandbox Organisations allow your tenant to create up to five simulated organisations within your account. These act as independent actors in a credential ecosystem, such as issuers, verifiers, wallet providers, or registries. They enable you to build, test, and demonstrate end-to-end credential flows without any additional infrastructure, cost, or coordination with external parties.

Whether you are a government agency preparing a national credential rollout, a bank testing identity verification workflows, or a standards body validating interoperability, sandbox organisations give you a self-contained playground to get it right before going live.

## Why use sandbox organisations?

| Benefit | Description |
|---------|-------------|
| Zero additional cost | Sandbox organisations are included in your tenant subscription. No separate licensing or provisioning required. |
| Realistic simulation | Each sandbox organisation has its own issuer and verifier configuration, allowing authentic multi-party testing. |
| Rapid prototyping | Stand up a complete credential ecosystem in minutes, not weeks. Ideal for demos, proofs of concept, and pilot programmes. |
| Safe experimentation | Test credential definitions, presentation flows, and webhook integrations without affecting your production environment. |
| Ecosystem validation | Validate interoperability across different organisational roles before committing to a live deployment. |

## How it works

### 1. Access your sandbox organisations

From your main tenant dashboard, click on your profile menu in the top-right corner. You will see a **Sandbox Organisations** section listing all sandbox organisations available to your account.

![Profile dropdown showing Sandbox Organisations](/img/sandbox-organisations/dropdown.png)

### 2. Switch to a sandbox organisation

Click on any sandbox organisation to switch into it. The interface will update to show that organisation's workspace, and a **Sandbox** badge will appear in the header to clearly indicate you are operating in a sandboxed context.

You remain logged in as your main tenant admin (e.g. admin@abcbank.se) but can now configure and operate as the sandbox organisation. The screenshot below shows the Scandinavian Hotels sandbox organisation with its own verification history and credential data.

![Sandbox organisation workspace showing verification history with Sandbox badge](/img/sandbox-organisations/sandbox-workspace.png)

### 3. Configure issuer and verifier settings

Once inside a sandbox organisation, you have access to the core issuer and verifier tools. You can create credential definitions, configure presentation definitions, set up webhook endpoints, and manage extensions.

The sandbox organisation provides a focused set of features (Issuer and Verifier, Extensions, Account, Webhooks) rather than the full feature set available in your main tenant.

To work in a sandbox organisation through the API, select the sandbox organisation in the dashboard, then create the API key under **Account** > **Developer APIs** (**Create API Key**). The key is bound to the sandbox organisation, and every call with it runs there.

### 4. Return to your main tenant

To switch back, open the profile menu and select your main tenant organisation. The **Main Tenant** badge confirms you are back in your production environment with full feature access.

![Main tenant dashboard showing full navigation and Main Tenant badge](/img/sandbox-organisations/main-tenant.png)

## Available features in sandbox organisations

Sandbox organisations provide a focused set of features tailored for testing credential flows:

- **Issuer** - create and manage credential definitions, configure issuance settings, and issue test credentials
- **Relying Party (Verifier)** - set up presentation definitions and verify credentials received from wallet units
- **Extensions** - configure additional capabilities and integrations for the sandbox organisation
- **Webhooks** - set up webhook endpoints to test event-driven integrations
- **Account** - manage the sandbox organisation's profile and basic settings

Features such as Data Agreements, Data Marketplace, Wallet Unit (Holder), Consent Management, and Activity Logs are available only in the main tenant and are intentionally excluded from sandbox organisations to keep the testing environment focused and lightweight.

## Limits

Each tenant can create a maximum of **five sandbox organisations**. This is sufficient to simulate a realistic credential ecosystem with multiple issuers, verifiers, and other participants. The limit is by design. Sandbox organisations are intended for testing and demonstration, not as a substitute for production multi-tenancy.

## Example use case

Consider a government agency such as Bolagsverket (the Swedish Companies Registration Office) preparing to issue verifiable credentials for company registration data. Using sandbox organisations, they could set up:

1. A PID (Person Identification Data) issuer to simulate national identity credential issuance
2. Two verifier organisations representing banks that need to verify company registration credentials
3. A verifier representing a legal services firm with different verification requirements
4. A test wallet provider to simulate the holder's experience

This entire ecosystem can be configured, tested, and demonstrated from a single Bolagsverket tenant account. No external coordination, no additional contracts, and no extra cost.

## Getting started

To create your first sandbox organisation, navigate to your profile menu and look for the Sandbox Organisations section. If you do not see this option, contact your account administrator or reach out to support at [support@igrant.io](mailto:support@igrant.io) to have the feature enabled for your tenant.


---

# European Business Wallet Owner ID (EBWOID)
Source: https://docs.igrant.io/docs/european-business-wallet-owner-id/

---
id: european-business-wallet-owner-id
title: European Business Wallet Owner ID (EBWOID)
description: Issue European Business Wallet Owner ID (EBWOID) credentials for organisations using OpenID4VCI. Previously known as Legal Person Identification Data (LPID).
hide_title: false
sidebar_label: European Business Wallet Owner ID (EBWOID)
keywords: [European Business Wallet Owner ID, EBWOID, Legal Person ID, LPID, OpenID4VCI, credential issuance, Organisation Wallet, European Business Wallet, EUDI Wallet, legal entity, eIDAS 2.0]
slug: /european-business-wallet-owner-id/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```
>
> This page maps to the `igrantio-ebw-owner-id` skill. Install just that one with:
>
> ```bash
> npx skills add L3-iGrant/skills -s igrantio-ebw-owner-id
> ```

<head>
  <title>European Business Wallet Owner ID (EBWOID) | iGrant.io DevDocs</title>
  <meta name="description" content="Issue European Business Wallet Owner ID (EBWOID) credentials for organisations using OpenID4VCI. Previously known as Legal Person Identification Data (LPID)."/>
</head>

import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';
import NoteBox from '@site/src/components/NoteBox';

<NoteBox title="Note:">
European Business Wallet Owner ID (EBWOID) was previously called Legal Person Identification Data (LPID). The content below is based on the previous terminology. The data schema identifier remains LPID for backwards compatibility.
</NoteBox>

This workflow implements [European Wallet Consortium (EWC) RFC005](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/v2.0/ewc-rfc005-issue-legal-person-identification-data.md) and employs the [OpenID4VCI Issue Credential (In-Time)](/docs/openID4vci-issue-credential-intime/) or [OpenID4VCI Issue Credential (Deferred)](/docs/openID4vci-issue-credential-deferred/) protocol to issue Legal Person Identification Data (LPID). The steps below outline the process using OpenID for Verifiable Credentials Issuance (OpenID4VCI). This process adheres to the OpenID4VCI specification and is illustrated in the diagram below:

![Issue Legal Person Identification Data - LPID](./images/ow-issue-legal-pid.png)

### Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

import { ApiKeyManager } from '@site/src/components/ApiKeyManager';

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

### Step 2: Create Credential Definition (LPID Issuer Admin)

Copy the code block below to create a credential definition as per EWC RFC005. Execute the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition). From the API response, copy the `credentialDefinitionId` for use in Step 3.

import Step2 from '@site/src/components/LegalPIDUsecase/Step2';

<Step2 
  versionFamily="createCredentialDefinition"
  initialVersionKey="version_01"
  initialFormatKey="sd_jwt"
/>

### Step 3: Request and Issue Credential (LPID Issuer: E.g. Bolagsverket or similar)

Before the issuance validation takes place, the legal person submits a request for the issuance of an LPID. In this step, the legal person provides the Organisation Wallet Suite endpoint where the LPID should be issued. If the holder wallet does not expose a `<credentialOfferEndpoint>`, issuance can still proceed by sharing the credential offer manually (e.g., via QR code). When a `<credentialOfferEndpoint>` is configured, the issuer can push the offer directly to the holder wallet, enabling issuer-initiated credential issuance.

After completing the required validations, the Issuer proceeds to issue the Legal Person Identification Data (LPID) in deferred mode. When you run Step 2 on this page, the `credentialDefinitionId` field below is autofilled automatically (and updated whenever Step 2 is re-run). Enter your holder's `credentialOfferEndpoint` manually before running Step 3. If you are executing the APIs yourself, replace `<credentialDefinitionId>` with the ID obtained in Step 2. You can run the JSON code block below using the **Run** button. Alternatively, use the JSON code block below to structure your request and execute it via the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential/). From the API response, copy the `credential.id` for use in Step 5. This ID corresponds to the `id` field from the `credentialDefinitions` array in the create credential definition response.

import Step3 from '@site/src/components/LegalPIDUsecase/Step3';

<Step3 
  versionFamily="issueCredential"
  initialVersionKey="version_01"
  initialFormatKey="sd_jwt"
/>

### Step 4: Receive Credential Offer (Legal Person/Holder)

The holder's wallet receives the credential at the configured [Organisation Wallet Suite](/docs/organisation-wallet-overview/) endpoint.

### Step 5: Update Credential Offer (Issuer)

When you run Steps 2 and 3 on this page, the **Credential Exchange ID** path parameter and the `credential.id` field below are autofilled automatically (and updated whenever those steps are re-run). If you are executing the APIs yourself, use the `credentialExchangeId` from Step 3 as the path parameter and set `credential.id` to the `id` value from the `credentialDefinitions` array in the create credential definition response. Use the code block below to update the credential offer. This ensures the correct Legal PID credential configuration is updated. From the response, use the `credentialExchangeId` as the path parameter and execute the API available [here](/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history).

import Step5 from '@site/src/components/LegalPIDUsecase/Step5';

<Step5 
  versionFamily="updateCredentialOffer"
  initialVersionKey="version_01"
  initialFormatKey="sd_jwt"
/>

### Try It Yourself (With Demo Video)

<VideoPlayer
  videoId="C5FO0-PoAVo"
  title="Legal Person Identification Data Demo"
  description="Learn how to issue Legal Person Identification Data (LPID) using OpenID4VCI protocol with iGrant.io Digital Wallets."
  uploadDate="2024-01-01"
  duration="PT10M"
/>


---

# Account Information Access
Source: https://docs.igrant.io/docs/extensions/account-information-access

---
id: ext-account-information-access
title: "Account Information Access"
description: "Request consented access to a customer's payment account information using an SCA Attestation presented from their EUDI Wallet."
hide_title: false
sidebar_label: Account Information Access
keywords: [Account Information Access, AIS, AISP, PSD2, SCA, EUDI Wallet, TS12, Organisation Wallet, European Business Wallet, open banking]
slug: /extensions/account-information-access
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Account Information Access extension enables an Account Information Service Provider (AISP) to request consented access to a customer's payment account information using an SCA Attestation presented from their EUDI Wallet. The flow follows the [TS12 Electronic Payments SCA Implementation with Wallet](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md) specification.

## How it works

1. The organisation enables the Account Information Access extension from the dashboard.
2. An administrator configures the service description shown to the customer and the account attributes to request (e.g. IBAN, BIC, currency).
3. When a customer needs to grant account access, a verification request with an `urn:eudi:sca:account_access:1` transaction data payload is triggered using the configured presentation definition.
4. The customer reviews the service, AISP identifier and scope of access, and presents an SCA Attestation from their EUDI Wallet.
5. The system verifies the presentation, its Key Binding JWT and the dynamic link to the transaction, and completes the account access consent.

## Configuration

### Account access request

Configure the account attributes the AISP requests from the customer's Payment Account Credential:

| Attribute | Description |
|---|---|
| `iban` | International Bank Account Number |
| `bic` | Bank Identifier Code |
| `currency` | Account currency |

### Transaction data

The verification request includes an `urn:eudi:sca:account_access:1` transaction data object describing the AISP, what is being requested, and the service description shown to the customer:

| Field | Type | Description |
|---|---|---|
| `transaction_id` | String | Unique identifier for the account access transaction |
| `date_time` | DateTime | Timestamp of the access request |
| `aisp` | Object | The Account Information Service Provider requesting access |
| `├─ legal_name` | String | Legal name of the AISP |
| `├─ brand_name` | String | Brand name of the AISP |
| `└─ domain_name` | String | Domain of the AISP |
| `description` | String | Human-readable service description shown to the customer |

### Integration

Once configured, the system automatically generates an SCA Attestation **Presentation Definition** bound to the `urn:eudi:sca:account_access:1` transaction data type. This presentation definition can be viewed from the extension configuration page and is used when initiating account access requests via the API.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/account-information-access', description: 'Retrieve current configuration' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Account Information Access extension deletes its configuration. This action is not reversible.
</NoteBox>


---

# Age Verification
Source: https://docs.igrant.io/docs/extensions/age-verification

---
id: ext-age-verification
title: "Age Verification"
description: "Verify customer age using digital credentials presented from an EUDI Wallet"
hide_title: false
sidebar_label: Age Verification
keywords: [age verification, EUDI Wallet, digital credentials, PID, Passport, PhotoID, Organisation Wallet, European Business Wallet, compliance, identity verification]
slug: /extensions/age-verification
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

Age Verification extension enables organisations to verify a customer's age using digital credentials such as PID, Passport, PhotoID, or the EU's Age Verification credential, presented from their EUDI Wallet, ensuring compliance with age-restricted services.

## How it works

1. The organisation enables the Age Verification extension from the dashboard.
2. An administrator selects which identity credentials to accept and configures the required age limit.
3. When a customer needs to verify their age, a verification request is triggered using the configured presentation definition.
4. The customer presents the requested credential from their EUDI Wallet.
5. The system verifies the credential and checks whether the customer meets the age requirement.

## Configuration

### Step 1: Choose identity credentials

Select at least one credential type to accept for age verification:

| Credential | Standard | Description |
|---|---|---|
| **Person Identification Data (PID)** | EWC RFC003 | National identity data issued under the EUDI framework |
| **Passport** | ICAO 9303 | Machine-readable travel document |
| **PhotoID** | EWC RFC013 | Photo identification credential |
| **Age Verification** | EU Age Verification Blueprint | Age Verification as per the European Commission |

Each credential type can be individually enabled or disabled. Note that certain credential types may be automatically disabled depending on the selected age limit (e.g., Passport is not available for the "Above 18" age limit).

### Step 2: Set age limit

Choose one of the following age thresholds:

- **Above 18 years**
- **Above 21 years**
- **Above 65 years**

Only one age limit can be active at a time. Changing the age limit may affect which credential types are available.

### Integration

Once configured, the system automatically generates a **Presentation Definition** that encodes the selected credential requirements and age threshold. This presentation definition can be viewed from the extension configuration page and is used when initiating verification requests via the API.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/age-verification', description: 'Retrieve current configuration' },
  { method: 'put', path: '/v3/config/extension/age-verification/identity-credential', description: 'Update credential and age limit settings' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Age Verification extension deletes its configuration. This action is not reversible.
</NoteBox>

<NoteBox title="Tip:" variant="tip">
Prefer to set up age verification yourself using the OpenID4VC APIs? Follow the <a href="/docs/eu-age-verification/">Age Verification developer workflow</a> to issue and verify age verification attestations step by step.
</NoteBox>


---

# Document Signing
Source: https://docs.igrant.io/docs/extensions/document-signing

---
id: ext-document-signing
title: "Document Signing"
description: "Sign PDF documents using a Qualified Electronic Signature from an EUDI Wallet"
hide_title: false
sidebar_label: Document Signing
keywords: [document signing, PDF signing, QESAC, qualified electronic signature, EUDI Wallet, Organisation Wallet, European Business Wallet, eIDAS, digital signature]
slug: /extensions/document-signing
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Document Signing extension allows users to securely sign PDF documents using a Qualified Electronic Signature Access Credential (QESAC) presented from their EUDI Wallet.

## How it works

1. The organisation enables the Document Signing extension from the dashboard.
2. An administrator uploads PDF documents for signing and reviews the QES provider configuration.
3. When a user needs to sign a document, a signing request is triggered using the configured QESAC presentation definition.
4. The user presents their QES Access Credential from their EUDI Wallet.
5. The system coordinates with the QES provider to apply a qualified electronic signature to the document.

## Configuration

### QES provider

The extension is pre-configured with a Qualified Electronic Signature provider:

| Field | Value |
|---|---|
| **Provider** | Intesi Group Cloud Signature |
| **Version** | v1.0.4.0 |
| **Region** | IT (Italy) |
| **CSC Compliance** | v1.0.4.0 |

### Document storage

Documents are stored using the default iGrant.io storage provider.

### Document management

Upload and manage PDF documents for signing from the dashboard.

**Upload requirements:**

| Constraint | Value |
|---|---|
| File type | PDF only |
| Maximum file size | 1 MB |
| Maximum pages | 1 (single page) |
| Maximum files | 10 |

**Document actions:**

- **Upload** - Select a PDF file that meets the requirements above
- **View** - Open the uploaded PDF
- **Copy** - Copy the raw JSON data for the document
- **Delete** - Remove the document (with confirmation). Re-upload is allowed after deletion.

### Integration

Once configured, the system uses a **QESAC Presentation Definition** to request the signing credential from the user's wallet. This presentation definition can be viewed from the extension configuration page.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/document-signing', description: 'Retrieve documents and configuration' },
  { method: 'post', path: '/v3/config/extension/document-signing/file/upload', description: 'Upload a PDF document' },
  { method: 'delete', path: '/v3/config/extension/document-signing/file/{fileId}', description: 'Delete a document' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Document Signing extension deletes all uploaded documents and configuration. This action is not reversible.
</NoteBox>


---

# Extensions
Source: https://docs.igrant.io/docs/extensions/overview

---
id: ext-overview
title: Extensions
hide_title: true
description: Pre-built extensions for the Organisation Wallet Suite that add turnkey verification, authentication, and signing capabilities using EUDI Wallets.
sidebar_label: Overview
keywords: [extensions, Organisation Wallet, European Business Wallet, age verification, KYC, passwordless login, document signing, EUDI Wallet, turnkey solutions]
slug: /extensions/overview
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import {RegulationOverviewGrid} from '@site/src/components/RegulationCard';

export const extensionsData = [
  {
    id: 'age-verification',
    title: 'Age Verification',
    description: 'Verify customer age using digital credentials such as PID, Passport, or PhotoID presented from their EUDI Wallet, ensuring compliance with age-restricted services.',
    href: '/docs/extensions/age-verification',
  },
  {
    id: 'kyc',
    title: 'Know Your Customer (KYC)',
    description: 'Verify customer identity using digital credentials such as PID, Passport, or PhotoID presented from their EUDI Wallet, enabling streamlined KYC checks.',
    href: '/docs/extensions/know-your-customer',
  },
  {
    id: 'passwordless-login',
    title: 'Passwordless Login',
    description: 'Enable passwordless authentication using digital credentials presented from an EUDI Wallet, integrating seamlessly with existing OpenID Connect identity management.',
    href: '/docs/extensions/passwordless-login',
  },
  {
    id: 'document-signing',
    title: 'Document Signing',
    description: 'Allow users to securely sign PDF documents using a Qualified Electronic Signature Access Credential (QESAC) presented from their EUDI Wallet.',
    href: '/docs/extensions/document-signing',
  },
  {
    id: 'account-information-access',
    title: 'Account Information Access',
    description: 'Request consented access to a customer\'s payment account information using an SCA Attestation presented from their EUDI Wallet (TS12).',
    href: '/docs/extensions/account-information-access',
  },
  {
    id: 'payment-authorisation-for-banks',
    title: 'Payment Authorisation (for Banks)',
    description: 'Authorise payments initiated at the payer\'s own bank using an SCA Attestation presented from their EUDI Wallet (TS12).',
    href: '/docs/extensions/payment-authorisation-for-banks',
  },
  {
    id: 'payment-authorisation-for-merchants',
    title: 'Payment Authorisation (for Merchants)',
    description: 'Authorise payments at a merchant or PISP using an SCA Attestation presented from the customer\'s EUDI Wallet (TS12).',
    href: '/docs/extensions/payment-authorisation-for-merchants',
  },
  {
    id: 'payment-credential-issuance',
    title: 'Payment Credential Issuance',
    description: 'Issue SCA Attestations representing a payment account, card or user to the customer\'s EUDI Wallet (TS12).',
    href: '/docs/extensions/payment-credential-issuance',
  },
  {
    id: 'recurring-payment-mandate',
    title: 'Recurring Payment Mandate',
    description: 'Obtain consent for recurring or merchant-initiated payments using an e-mandate SCA Attestation presented from the customer\'s EUDI Wallet (TS12).',
    href: '/docs/extensions/recurring-payment-mandate',
  },
  {
    id: 'risk-based-authentication',
    title: 'Risk-based Authentication',
    description: 'Protect login and sensitive actions with Strong Customer Authentication using an SCA Attestation presented from the user\'s EUDI Wallet (TS12).',
    href: '/docs/extensions/risk-based-authentication',
  },
  {
    id: 'photoid-credential-issuance',
    title: 'Photo ID Credential Issuance',
    description: 'Issue Photo ID credentials derived from a machine-readable travel document to the customer\'s EUDI Wallet (ISO/IEC TS 23220-4, EWC RFC013).',
    href: '/docs/extensions/photoid-credential-issuance',
  },
  {
    id: 'pid-credential-issuance',
    title: 'PID Credential Issuance',
    description: 'Issue Person Identification Data (PID) credentials to the customer\'s EUDI Wallet under the EUDI framework (EWC RFC003).',
    href: '/docs/extensions/pid-credential-issuance',
  },
];

<RegulationOverviewGrid
  data={extensionsData}
  title="Extensions"
  subtitle="Browse ready-made extensions for the Organisation Wallet Suite. Examples include age verification, KYC, passwordless login and document signing, with more being added regularly."
  showSearch={true}
/>


---

# Know Your Customer (KYC)
Source: https://docs.igrant.io/docs/extensions/know-your-customer

---
id: ext-know-your-customer
title: "Know Your Customer (KYC)"
description: "Verify customer identity using digital credentials presented from an EUDI Wallet"
hide_title: false
sidebar_label: Know Your Customer
keywords: [KYC, Know Your Customer, identity verification, EUDI Wallet, digital credentials, PID, Organisation Wallet, European Business Wallet, compliance, onboarding]
slug: /extensions/know-your-customer
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The KYC extension enables organisations to verify customer identity using digital credentials such as PID, Passport, or PhotoID presented from their EUDI Wallet, enabling streamlined Know Your Customer checks.

## How it works

1. The organisation enables the KYC extension from the dashboard.
2. An administrator selects which identity credentials to accept.
3. When a customer needs to complete KYC, a verification request is triggered using the configured presentation definition.
4. The customer presents the requested credential(s) from their EUDI Wallet.
5. The system verifies the credentials and completes the identity check.

## Configuration

### Choose identity credentials

Select any combination of credential types to accept for KYC verification:

| Credential | Standard | Description |
|---|---|---|
| **Person Identification Data (PID)** | EWC RFC003 | National identity data issued under the EUDI framework |
| **Passport** | ICAO 9303 | Machine-readable travel document |
| **PhotoID** | EWC RFC013 | Photo identification credential |

All credential types are independent and can be freely combined. Unlike Age Verification, there are no interdependencies between credential selections.

### Integration

Once configured, the system automatically generates a **Presentation Definition** that encodes the selected credential requirements. This presentation definition can be viewed from the extension configuration page and is used when initiating verification requests via the API.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/kyc', description: 'Retrieve current configuration' },
  { method: 'put', path: '/v3/config/extension/kyc/identity-credential', description: 'Update identity credential settings' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the KYC extension deletes its configuration. This action is not reversible.
</NoteBox>


---

# Passwordless Login
Source: https://docs.igrant.io/docs/extensions/passwordless-login

---
id: ext-passwordless-login
title: "Passwordless Login"
description: "Enable passwordless login using digital credentials from an EUDI Wallet via OpenID Connect"
hide_title: false
sidebar_label: Passwordless Login
keywords: [passwordless login, EUDI Wallet, OpenID Connect, OIDC, authentication, digital credentials, Organisation Wallet, European Business Wallet, identity provider]
slug: /extensions/passwordless-login
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Passwordless Login extension enables organisations to offer passwordless login using digital credentials presented from an EUDI Wallet. It integrates with existing OpenID Connect (OIDC) identity management systems.

## How it works

1. The organisation enables the Passwordless Login extension from the dashboard.
2. An administrator creates one or more OIDC clients, each configured with a presentation definition, redirect URIs, and either identity matching attributes or a callback URI.
3. When a user initiates login, they are redirected to the OIDC authorisation endpoint, which shows a QR code.
4. The user presents the requested credential from their EUDI Wallet.
5. The system verifies the credential and redirects the user back to the application with an authorisation code.
6. The application exchanges the code for tokens. The system identifies the user with the configured identity matching attributes or callback URI.

## OIDC discovery endpoints

Once the extension is enabled, the following OpenID Connect endpoints are available. All paths start with `/v3/service/extension/oidc/{organisationId}`.

| Endpoint | Path | Description |
|---|---|---|
| **Well-Known OIDC** | `/.well-known/openid-configuration` | OIDC discovery document |
| **Well-Known JWKS** | `/.well-known/jwks.json` | OIDC JWKS document |
| **Authorization Endpoint** | `/auth` | Redirects users to present credentials from their wallet |
| **Token Endpoint** | `/token` | Secure server-to-server token exchange |
| **User Info Endpoint** | `/userinfo` | Returns the `sub` of the user and the presented credentials |

## OIDC client configuration

Each OIDC client connects to your Identity Provider and defines how credential-based login is handled.

### Client fields

| Field | Required | Description |
|---|---|---|
| **Name** | Yes | A descriptive name for the client |
| **Presentation Definition** | Yes | The credentials to verify during login. See [Presentation definition](#presentation-definition) for the three ways to set it. |
| **Action** | Conditional | The login text that the EUDI Wallet may show to the user. Required when the presentation definition has Passwordless Login transaction data, otherwise not available. |
| **Redirect URIs** | No | URLs where users are redirected after login. The redirect URI of a login request must match one of them exactly. |
| **Web Origins** | No | The web origins of your application. |
| **Identity Matching Attributes** | One of the two | A map of credential identifiers to claim paths used as linking values for identity matching. Each key identifies a credential, and the value is the dot-separated path to the claim within that credential to use as the linking value. This is the recommended way to configure identity matching. |
| **Callback URI** | One of the two | Endpoint for complex identity matching scenarios. Use an HTTPS endpoint. When set, the endpoint receives the credential presentation and returns the `sub` claim. Use this when you need custom logic beyond what Identity Matching Attributes can provide. |
| **Callback Secret** | Conditional | HMAC-SHA256 secret used to sign callback payloads. Required when **Callback URI** is set. |

Configure either **Identity Matching Attributes** or **Callback URI**, not both.

### Presentation definition

In the dashboard there are three ways to set the **Presentation Definition**:

| Way | What it does |
|---|---|
| **Credentials** | Pick one or more credentials, for example PID. A new presentation definition is created from them when you save. The user logs in with any one of them. |
| **Existing presentation definitions** | Select a presentation definition you already created. No new one is created. |
| **Create new presentation definition** | Build your own. It is created when you save. |

A presentation definition can be used by one client only.

### Identity matching attributes

**Identity Matching Attributes** allow you to configure which claims from presented credentials should be used as linking values for identity matching. It is specified as a map with one entry for each credential of the presentation definition. Each key identifies the credential: the VCT (SD-JWT), the document type (ISO mdoc) or the type (W3C VC). The value is the dot-separated path to the claim within that credential to use as the linking value.

For example, if your presentation definition asks for the PID with VCT `urn:eudi:pid:1` and the claim `email`, you could configure:
```json
{
  "urn:eudi:pid:1": "email"
}
```

This tells the system to use the `email` claim from the PID for identity matching.

### Transaction data and action field

If the chosen presentation definition has Passwordless Login transaction data, the **Action** field passes a free-text value (e.g., `"Log in to your online bank account"`) that is included in the transaction data sent to the EUDI Wallet. The wallet may use this value to display a custom UI to the user during the credential presentation (for example, showing a contextual message about what the login is for).

### Callback endpoint requirements

For most use cases, **Identity Matching Attributes** are sufficient. If you have more complex requirements for identity matching (e.g., custom logic, transformations, or external lookups), you can configure a **Callback URI** instead. When a **Callback URI** is configured, the endpoint must:

- Accept `POST` requests with a JSON body containing the credential presentation payload.
- Verify the `X-iGrant-Signature` HMAC-SHA256 header to authenticate the request. See [Webhook Security](/docs/openid4vc-webhooks/#webhook-security) for details on how to decode and verify the signature.
- Return HTTP 200 with a JSON response containing the `sub` (subject identifier) claim that maps the presented credential to a user in your IdP. This allows you to decide which field from the presentation (e.g., `email`) to use as the user identifier.

### Client management

From the dashboard, administrators can:

- Create new OIDC clients
- View and copy client credentials (Client ID and Client Secret)
- Edit client configuration
- Delete clients (with confirmation)
- View the associated presentation definition

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/oidc/clients', description: 'List all OIDC clients' },
  { method: 'post', path: '/v3/config/extension/oidc/client', description: 'Create a new client' },
  { method: 'get', path: '/v3/config/extension/oidc/client/{clientId}', description: 'Read a client' },
  { method: 'put', path: '/v3/config/extension/oidc/client/{clientId}', description: 'Update a client' },
  { method: 'delete', path: '/v3/config/extension/oidc/client/{clientId}', description: 'Delete a client' },
  { method: 'get', path: '/v3/service/extension/oidc/{organisationId}/.well-known/openid-configuration', description: 'OIDC discovery document' },
  { method: 'get', path: '/v3/service/extension/oidc/{organisationId}/.well-known/jwks.json', description: 'OIDC JWKS document' },
  { method: 'get', path: '/v3/service/extension/oidc/{organisationId}/auth', description: 'Authorisation endpoint, also accepts POST' },
  { method: 'post', path: '/v3/service/extension/oidc/{organisationId}/token', description: 'Token endpoint' },
  { method: 'get', path: '/v3/service/extension/oidc/{organisationId}/userinfo', description: 'User info endpoint, also accepts POST' },
]} />

## Integration guide

For a step-by-step guide on configuring an IdP (Keycloak, Auth0, Ping Identity, etc.) as a relying party with this extension, including Identity Provider setup, custom authentication flows, and a sample React implementation, see the [Passwordless Login with EUDI Wallets](/docs/eudi-passwordless-login-flow/) guide.

<NoteBox title="Caution:" variant="caution">
Disabling the Passwordless Login extension deletes all OIDC clients and their configuration. This action is not reversible.
</NoteBox>


---

# Payment Authorisation (for Banks)
Source: https://docs.igrant.io/docs/extensions/payment-authorisation-for-banks

---
id: ext-payment-authorisation-for-banks
title: "Payment Authorisation (for Banks)"
description: "Authorise payments initiated at the payer's own bank using an SCA Attestation presented from their EUDI Wallet."
hide_title: false
sidebar_label: Payment Authorisation (for Banks)
keywords: [Payment Authorisation, Bank, ASPSP, SCA, PSD2, EUDI Wallet, TS12, Organisation Wallet, European Business Wallet, dynamic linking]
slug: /extensions/payment-authorisation-for-banks
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Payment Authorisation (for Banks) extension enables an Account Servicing Payment Service Provider (ASPSP) to authorise payments initiated by its own customer using an SCA Attestation presented from their EUDI Wallet. This is the issuer-requested flow defined in the [TS12 Electronic Payments SCA Implementation with Wallet](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md) specification.

## How it works

1. The organisation enables the Payment Authorisation (for Banks) extension from the dashboard.
2. An administrator configures the payment details shown during authorisation, such as payee, amount, currency and execution date fields.
3. When a customer initiates a payment in the bank's channels, a presentation request with an `urn:eudi:sca:payment:1` transaction data payload is triggered using the configured presentation definition.
4. The customer reviews the payment details in their EUDI Wallet and presents the SCA Attestation issued by the bank.
5. The system verifies the presentation, validates the Key Binding JWT (including `amr` and `transaction_data_hashes`), and produces the PSD2 Authentication Code used to approve the payment.

## Configuration

### Supported SCA Attestation types

Select which SCA Attestation the bank accepts for this flow. Only the account and card attestations are supported:

#### Payment Account Credential

| Attribute | Description |
|---|---|
| `iban` | International Bank Account Number |
| `bic` | Bank Identifier Code |
| `currency` | Account currency |

#### Payment Card Credential

| Attribute | Description |
|---|---|
| `pan_last_four` | Last four digits of the card's Primary Account Number |
| `scheme` | Card scheme (e.g. Visa, Mastercard) |
| `scheme_logo` | Logo of the card scheme |

### Transaction data

The verification request carries an `urn:eudi:sca:payment:1` transaction data object. The fields below are cryptographically bound to the authentication (dynamic linking):

| Field | Type | Description |
|---|---|---|
| `transaction_id` | String | Unique identifier for the payment transaction |
| `date_time` | DateTime | Timestamp of the payment request |
| `payee` | Object | Recipient of the payment |
| `├─ name` | String | Name of the recipient |
| `├─ id` | String | Identifier of the recipient |
| `├─ logo` | String | Logo of the recipient |
| `└─ website` | String | Website of the recipient |
| `pisp` | Object | Payment Initiation Service Provider |
| `├─ legal_name` | String | Legal name of the PISP |
| `├─ brand_name` | String | Brand name of the PISP |
| `└─ domain_name` | String | Domain of the PISP |
| `execution_date` | DateTime | Requested execution date |
| `currency` | String | ISO 4217 currency code |
| `amount` | Number | Transaction amount |
| `amount_estimated` | Boolean | True if the amount is an estimate |
| `amount_earmarked` | Boolean | True if funds are earmarked |
| `sct_inst` | Boolean | True if SEPA Instant Credit Transfer |
| `recurrence` | Object (optional) | Recurring payment schedule |
| `├─ start_date` | DateTime | First date the recurrence is valid |
| `├─ end_date` | DateTime | Last date the recurrence is valid |
| `├─ number` | Number | Number of occurrences |
| `└─ frequency` | String | Frequency of the recurrence |
| `mit_options` | Object (optional) | Merchant-Initiated Transaction parameters |
| `├─ amount_variable` | Boolean | True if the charged amount can vary between occurrences |
| `├─ min_amount` | Number | Minimum amount per charge |
| `├─ max_amount` | Number | Maximum amount per charge |
| `├─ total_amount` | Number | Total amount across all charges |
| `├─ initial_amount` | Number | Amount of the first charge |
| `├─ initial_amount_number` | Number | Number of initial charges at `initial_amount` |
| `└─ apr` | Number | Annual percentage rate |

### Integration

Once configured, the system automatically generates a **Presentation Definition** bound to the `urn:eudi:sca:payment:1` transaction data type. This presentation definition can be viewed from the extension configuration page and is used when initiating payment authorisation requests via the API.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/payment-authorisation-issuer', description: 'Retrieve current configuration' },
  { method: 'put', path: '/v3/config/extension/payment-authorisation-issuer', description: 'Update payment authorisation settings' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Payment Authorisation (for Banks) extension deletes its configuration. This action is not reversible.
</NoteBox>


---

# Payment Authorisation (for Merchants)
Source: https://docs.igrant.io/docs/extensions/payment-authorisation-for-merchants

---
id: ext-payment-authorisation-for-merchants
title: "Payment Authorisation (for Merchants)"
description: "Authorise payments at a merchant or Payment Initiation Service Provider using an SCA Attestation presented from the customer's EUDI Wallet."
hide_title: false
sidebar_label: Payment Authorisation (for Merchants)
keywords: [Payment Authorisation, Merchant, PISP, Third-party provider, SCA, PSD2, EUDI Wallet, TS12, Organisation Wallet, European Business Wallet]
slug: /extensions/payment-authorisation-for-merchants
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Payment Authorisation (for Merchants) extension enables a merchant or a Payment Initiation Service Provider (PISP) to authorise a payment using an SCA Attestation presented from the customer's EUDI Wallet. This is the third-party-requested flow defined in the [TS12 Electronic Payments SCA Implementation with Wallet](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md) specification.

## How it works

1. The organisation enables the Payment Authorisation (for Merchants) extension from the dashboard.
2. An administrator configures the merchant/PISP identity shown in the authorisation request and the transaction fields bound to authentication (dynamic linking).
3. When a customer checks out at the merchant or via a PISP, a presentation request with an `urn:eudi:sca:payment:1` transaction data payload is triggered using the configured presentation definition.
4. The customer reviews the payment details in their EUDI Wallet and presents the SCA Attestation previously issued by their ASPSP.
5. The system verifies the presentation, validates the Key Binding JWT and forwards the PSD2 Authentication Code to the ASPSP to complete the payment.

## Configuration

### Supported SCA Attestation types

Select which SCA Attestation the merchant or PISP accepts for this flow. Only the account and card attestations are supported:

#### Payment Account Credential

| Attribute | Description |
|---|---|
| `iban` | International Bank Account Number |
| `bic` | Bank Identifier Code |
| `currency` | Account currency |

#### Payment Card Credential

| Attribute | Description |
|---|---|
| `pan_last_four` | Last four digits of the card's Primary Account Number |
| `scheme` | Card scheme (e.g. Visa, Mastercard) |
| `scheme_logo` | Logo of the card scheme |

### Transaction data

The verification request carries an `urn:eudi:sca:payment:1` transaction data object. The fields below are cryptographically bound to the authentication (dynamic linking):

| Field | Type | Description |
|---|---|---|
| `transaction_id` | String | Unique identifier for the payment transaction |
| `date_time` | DateTime | Timestamp of the payment request |
| `payee` | Object | Recipient of the payment |
| `├─ name` | String | Name of the recipient |
| `├─ id` | String | Identifier of the recipient |
| `├─ logo` | String | Logo of the recipient |
| `└─ website` | String | Website of the recipient |
| `pisp` | Object | Payment Initiation Service Provider |
| `├─ legal_name` | String | Legal name of the PISP |
| `├─ brand_name` | String | Brand name of the PISP |
| `└─ domain_name` | String | Domain of the PISP |
| `execution_date` | DateTime | Requested execution date |
| `currency` | String | ISO 4217 currency code |
| `amount` | Number | Transaction amount |
| `amount_estimated` | Boolean | True if the amount is an estimate |
| `amount_earmarked` | Boolean | True if funds are earmarked |
| `sct_inst` | Boolean | True if SEPA Instant Credit Transfer |
| `recurrence` | Object (optional) | Recurring payment schedule |
| `├─ start_date` | DateTime | First date the recurrence is valid |
| `├─ end_date` | DateTime | Last date the recurrence is valid |
| `├─ number` | Number | Number of occurrences |
| `└─ frequency` | String | Frequency of the recurrence |
| `mit_options` | Object (optional) | Merchant-Initiated Transaction parameters |
| `├─ amount_variable` | Boolean | True if the charged amount can vary between occurrences |
| `├─ min_amount` | Number | Minimum amount per charge |
| `├─ max_amount` | Number | Maximum amount per charge |
| `├─ total_amount` | Number | Total amount across all charges |
| `├─ initial_amount` | Number | Amount of the first charge |
| `├─ initial_amount_number` | Number | Number of initial charges at `initial_amount` |
| `└─ apr` | Number | Annual percentage rate |

### Accepted issuers

Select which ASPSPs (issuers) are trusted to issue the SCA Attestation for this flow. Only attestations signed by the selected issuers are accepted.

### Integration

Once configured, the system automatically generates a **Presentation Definition** bound to the `urn:eudi:sca:payment:1` transaction data type. This presentation definition can be viewed from the extension configuration page and is used when initiating payment authorisation requests via the API.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/payment-authorisation-merchant', description: 'Retrieve current configuration' },
  { method: 'put', path: '/v3/config/extension/payment-authorisation-merchant', description: 'Update payment authorisation settings' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Payment Authorisation (for Merchants) extension deletes its configuration. This action is not reversible.
</NoteBox>


---

# Payment Credential Issuance (TS12)
Source: https://docs.igrant.io/docs/extensions/payment-credential-issuance

---
id: ext-payment-credential-issuance
title: "Payment Credential Issuance (TS12)"
description: "Issue SCA Attestations representing a payment account, card or user to the customer's EUDI Wallet."
hide_title: false
sidebar_label: Payment Credential Issuance
keywords: [Payment Credential, SCA Attestation, ASPSP, issuance, OpenID4VCI, PSD2, EUDI Wallet, TS12, Organisation Wallet, European Business Wallet]
slug: /extensions/payment-credential-issuance
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Payment Credential Issuance extension enables an Account Servicing Payment Service Provider (ASPSP) to issue SCA Attestations to its customers' EUDI Wallets. The issued attestation represents a payment account, a card, or the authenticated user, and is later used to authorise payments or grant account access as defined in the [TS12 Electronic Payments SCA Implementation with Wallet](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md) specification.

## How it works

1. The organisation enables the Payment Credential Issuance extension from the dashboard.
2. An administrator selects which SCA Attestation types to issue and configures the attributes included in each type.
3. When a customer requests a payment credential, an OpenID4VCI credential offer is generated by the issuer.
4. The customer accepts the offer in their EUDI Wallet, authenticates with the bank, and the wallet completes the authorisation code flow.
5. The system issues the SCA Attestation as an SD-JWT VC with a key binding to the wallet, ready to be used for SCA.

## Configuration

### SCA Attestation types

Select which attestation types the issuer will offer:

| Attestation | Description | Key attributes |
|---|---|---|
| **Account attestation** | Represents a payment account | `iban`, `bic`, `currency` |
| **Card attestation** | Represents a payment card | `scheme`, `scheme_logo`, `pan_last_four` |
| **User attestation** | Represents the authenticated user only |  |

Common attributes on every SCA Attestation include the issuer and audience identifiers, the validity period (`iat`, `nbf`, `exp`), the credential type identifier (`vct`), and the key binding (`cnf`) to the wallet.

### Issuance settings

| Setting | Description |
|---|---|
| **Credential format** | `vc+sd-jwt` (SD-JWT VC) |
| **Validity period** | Lifetime of the issued attestation |
| **Issuance flow** | Authorization Code flow (OpenID4VCI) |
| **Batch issuance** | Whether multiple attestations are issued in a single request |

### Integration

Once configured, the system exposes the standard OpenID4VCI endpoints for discovery and issuance of SCA Attestations.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/payment-issuance', description: 'Retrieve current configuration' },
  { method: 'put', path: '/v3/config/extension/payment-issuance', description: 'Update issuance settings' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Payment Credential Issuance extension deletes its configuration. Previously issued attestations remain valid until their expiry but cannot be refreshed from this issuer. This action is not reversible.
</NoteBox>


---

# Photo ID Credential Issuance
Source: https://docs.igrant.io/docs/extensions/photoid-credential-issuance

---
id: ext-photoid-credential-issuance
title: "Photo ID Credential Issuance"
description: "Issue Photo ID credentials derived from a machine-readable travel document to the customer's EUDI Wallet."
hide_title: false
sidebar_label: Photo ID Credential Issuance
keywords: [Photo ID, PhotoID, eMRTD, passport, ISO/IEC TS 23220-4, EWC RFC013, OpenID4VCI, QEAA, EUDI Wallet, Organisation Wallet, European Business Wallet]
slug: /extensions/photoid-credential-issuance
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Photo ID Credential Issuance extension enables a Qualified Trust Service Provider (QTSP) or other authorised issuer to issue Photo ID credentials to customers' EUDI Wallets. The credential is derived from an electronic Machine-Readable Travel Document (eMRTD) and follows [ISO/IEC TS 23220-4 (E) Annex C](https://www.iso.org/standard/86782.html) as profiled in [EWC RFC013 - Issue Photo ID](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc013-issue-photoid.md).

## How it works

1. The organisation enables the Photo ID Credential Issuance extension from the dashboard.
2. An administrator configures the identity proofing method (PID-based matching or unattended eMRTD proofing with liveness) and the attributes to include in the issued credential.
3. When a customer requests a Photo ID, an OpenID4VCI credential offer is generated and shared via QR code or deep link.
4. The customer accepts the offer in their EUDI Wallet, completes identity proofing (presenting a PID or scanning an eMRTD) and the wallet completes the authorisation code flow.
5. The system issues the Photo ID credential to the wallet in SD-JWT VC and/or mdoc (ISO/IEC 18013-5) format, cryptographically bound to the wallet key.

## Configuration

### Identity proofing

Select how the customer's identity is verified before issuance:

| Method | Description |
|---|---|
| **PID-based proofing** | Customer presents a PID credential (EWC RFC003); data is matched against the eMRTD scan |
| **Unattended eMRTD proofing** | Customer scans their passport and performs a liveness and face-matching check |

### Credential attributes

Select which attribute groups to include in the issued credential:

| Attribute group | Examples |
|---|---|
| **ISO 23220-1 core** | `given_name`, `family_name`, `birth_date`, `portrait`, `issue_date`, `expiry_date`, `issuing_authority`, `issuing_country`, `document_number`, `sex`, `nationality`, `resident_address` |
| **Age indicators** | `age_over_18`, `age_in_years`, `age_birth_year` |
| **Photo ID namespace (`org.iso.23220.photoid.1`)** | `person_id`, `birth_country`, `birth_state`, `birth_city`, `travel_document_number`, `administrative_number` |
| **DTC data groups** | MRZ (DG1), portrait (DG2), SOD and additional data groups (DG3–DG16) |

### Issuance settings

| Setting | Description |
|---|---|
| **Credential formats** | `vc+sd-jwt` and/or `mso_mdoc` |
| **Validity period** | Lifetime of the issued credential |
| **Issuance flow** | Authorization Code flow (OpenID4VCI) |
| **Level of assurance** | Extended LoIP required for QEAA issuance |

### Integration

Once configured, the system exposes the standard OpenID4VCI endpoints for discovery and issuance.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/photoid-issuance', description: 'Retrieve current configuration' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Photo ID Credential Issuance extension deletes its configuration. Previously issued Photo IDs remain valid until their expiry but cannot be refreshed from this issuer. This action is not reversible.
</NoteBox>


---

# PID Credential Issuance
Source: https://docs.igrant.io/docs/extensions/pid-credential-issuance

---
id: ext-pid-credential-issuance
title: "PID Credential Issuance"
description: "Issue Person Identification Data (PID) credentials to the customer's EUDI Wallet under the EUDI framework."
hide_title: false
sidebar_label: PID Credential Issuance
keywords: [PID, Person Identification Data, EWC RFC003, OpenID4VCI, EUDI Wallet, Organisation Wallet, European Business Wallet, CIR 2024/2977, high assurance, identity]
slug: /extensions/pid-credential-issuance
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The PID Credential Issuance extension enables a government-sanctioned PID provider to issue Person Identification Data (PID) credentials to customers' EUDI Wallets. The credential is issued at high level of assurance and follows [EWC RFC003 - Issue Person Identification Data](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc003-issue-person-identification-data.md) and the attribute definitions in the EUDI Architecture and Reference Framework.

## How it works

1. The organisation enables the PID Credential Issuance extension from the dashboard.
2. An administrator configures the source of identity data (authentic source / civil registry), the attributes to include, and the wallet conformity rules.
3. When a customer requests a PID, an OpenID4VCI credential offer is generated (Authorization Code or Pre-Authorized Code flow).
4. The customer accepts the offer in their EUDI Wallet, authenticates at the PID provider, and the wallet submits a Wallet Unit Attestation (WUA) and a proof-of-possession JWT.
5. The system verifies wallet conformity and authenticity, then issues the PID credential cryptographically bound to the wallet key (in-time or deferred).

## Configuration

### Issuance flow

Choose the OpenID4VCI flow the issuer will support:

| Flow | Description |
|---|---|
| **Authorization Code** | Traditional OAuth flow with user authentication at the PID provider |
| **Pre-Authorized Code** | Issuer provides a pre-authorised code with an optional transaction code (PIN delivered out-of-band) |

### Credential attributes

Select which attributes to include in the issued PID:

| Attribute group | Examples |
|---|---|
| **Mandatory (ARF)** | `given_name`, `family_name`, `birth_date`, `gender`, `nationality`, `country_of_residence`, `address` (street, locality, region, postal code, country) |
| **Age indicators** | `age_equal_or_over`, `age_in_years`, `age_birth_year` |
| **Place of birth** | `birth_country`, `birth_state`, `birth_city` |
| **Issuer lifecycle** | `issuing_authority`, `issue_date`, `expiry_date`, credential status reference |

### Issuance settings

| Setting | Description |
|---|---|
| **Credential formats** | `vc+sd-jwt` and/or `mso_mdoc` (ISO/IEC 18013-5) |
| **Validity period** | Lifetime of the issued PID |
| **Wallet conformity** | CAB certificate validation before issuance |
| **Authentic source** | Connection to the civil registry or equivalent data source |

### Integration

Once configured, the system exposes the standard OpenID4VCI endpoints for discovery and issuance.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/pid-issuance', description: 'Retrieve current configuration' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the PID Credential Issuance extension deletes its configuration. Previously issued PIDs remain valid until their expiry but cannot be refreshed from this issuer. This action is not reversible.
</NoteBox>


---

# Recurring Payment Mandate (TS12)
Source: https://docs.igrant.io/docs/extensions/recurring-payment-mandate

---
id: ext-recurring-payment-mandate
title: "Recurring Payment Mandate (TS12)"
description: "Obtain consent for recurring or merchant-initiated payments using an e-mandate SCA Attestation presented from the customer's EUDI Wallet."
hide_title: false
sidebar_label: Recurring Payment Mandate
keywords: [Recurring Payment Mandate, e-mandate, emandate, SCA, PSD2, EUDI Wallet, TS12, Organisation Wallet, European Business Wallet, merchant-initiated transactions]
slug: /extensions/recurring-payment-mandate
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Recurring Payment Mandate extension enables an organisation to obtain consent for recurring or merchant-initiated payments using an e-mandate SCA Attestation presented from the customer's EUDI Wallet. The flow uses the `urn:eudi:sca:emandate:1` transaction data type defined in the [TS12 Electronic Payments SCA Implementation with Wallet](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md) specification.

## How it works

1. The organisation enables the Recurring Payment Mandate extension from the dashboard.
2. An administrator configures the mandate details (creditor identity, purpose, validity window, recurrence).
3. When a customer sets up a recurring payment, a presentation request with an `urn:eudi:sca:emandate:1` transaction data payload is triggered using the configured presentation definition.
4. The customer reviews the mandate in their EUDI Wallet and presents an SCA Attestation to grant consent.
5. The system verifies the presentation, stores the signed mandate and returns the PSD2 Authentication Code that anchors subsequent recurring charges.

## Configuration

### Supported SCA Attestation types

Select which SCA Attestation is accepted to anchor the mandate. Only the account and card attestations are supported:

#### Payment Account Credential

| Attribute | Description |
|---|---|
| `iban` | International Bank Account Number |
| `bic` | Bank Identifier Code |
| `currency` | Account currency |

#### Payment Card Credential

| Attribute | Description |
|---|---|
| `pan_last_four` | Last four digits of the card's Primary Account Number |
| `scheme` | Card scheme (e.g. Visa, Mastercard) |
| `scheme_logo` | Logo of the card scheme |

### Transaction data

The verification request carries an `urn:eudi:sca:emandate:1` transaction data object describing the mandate and the payment payload it anchors:

| Field | Type | Description |
|---|---|---|
| `transaction_id` | String | Unique identifier for the mandate transaction |
| `date_time` | DateTime | Timestamp of the mandate request |
| `start_date` | DateTime | First date the mandate is valid |
| `end_date` | DateTime | Last date the mandate is valid |
| `reference_number` | String | Mandate reference number |
| `creditor_id` | String | SEPA Creditor Identifier or equivalent |
| `purpose` | String | Short description of what the mandate covers |
| `payment_payload` | Object | The anchored payment |
| `├─ transaction_id` | String | Identifier of the anchored payment |
| `├─ date_time` | DateTime | Timestamp of the anchored payment |
| `├─ payee` | Object | Recipient of the payment |
| `│  ├─ name` | String | Name of the recipient |
| `│  ├─ id` | String | Identifier of the recipient |
| `│  ├─ logo` | String | Logo of the recipient |
| `│  └─ website` | String | Website of the recipient |
| `├─ pisp` | Object | Payment Initiation Service Provider |
| `│  ├─ legal_name` | String | Legal name of the PISP |
| `│  ├─ brand_name` | String | Brand name of the PISP |
| `│  └─ domain_name` | String | Domain of the PISP |
| `├─ execution_date` | DateTime | Requested execution date |
| `├─ currency` | String | ISO 4217 currency code |
| `├─ amount` | Number | Payment amount |
| `├─ amount_estimated` | Boolean | True if the amount is an estimate |
| `├─ amount_earmarked` | Boolean | True if funds are earmarked |
| `└─ sct_inst` | Boolean | True if SEPA Instant Credit Transfer |
| `recurrence` | Object (optional) | Fixed-schedule charges |
| `├─ start_date` | DateTime | First date the recurrence is valid |
| `├─ end_date` | DateTime | Last date the recurrence is valid |
| `├─ number` | Number | Number of occurrences |
| `└─ frequency` | String | Frequency of the recurrence |
| `mit_options` | Object (optional) | Merchant-Initiated Transaction parameters |
| `├─ amount_variable` | Boolean | True if the charged amount can vary between occurrences |
| `├─ min_amount` | Number | Minimum amount per charge |
| `├─ max_amount` | Number | Maximum amount per charge |
| `├─ total_amount` | Number | Total amount across all charges |
| `├─ initial_amount` | Number | Amount of the first charge |
| `├─ initial_amount_number` | Number | Number of initial charges at `initial_amount` |
| `└─ apr` | Number | Annual percentage rate |

### Integration

Once configured, the system automatically generates a **Presentation Definition** bound to the `urn:eudi:sca:emandate:1` transaction data type. This presentation definition can be viewed from the extension configuration page and is used when initiating mandate requests via the API.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/recurring-payment-mandate', description: 'Retrieve current configuration' },
  { method: 'put', path: '/v3/config/extension/recurring-payment-mandate', description: 'Update mandate settings' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Recurring Payment Mandate extension deletes its configuration. Mandates already signed remain valid at the receiving ASPSP but cannot be renewed or replaced from this extension. This action is not reversible.
</NoteBox>


---

# Risk-based Authentication (TS12)
Source: https://docs.igrant.io/docs/extensions/risk-based-authentication

---
id: ext-risk-based-authentication
title: "Risk-based Authentication (TS12)"
description: "Protect login and sensitive actions with Strong Customer Authentication using an SCA Attestation presented from the user's EUDI Wallet."
hide_title: false
sidebar_label: Risk-based Authentication
keywords: [Risk-based Authentication, SCA, login, step-up authentication, PSD2, EUDI Wallet, TS12, Organisation Wallet, European Business Wallet, fraud prevention]
slug: /extensions/risk-based-authentication
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';
import ApiEndpoints from '@site/src/components/ApiEndpoint';

The Risk-based Authentication extension enables an organisation to protect online banking login and other sensitive actions with Strong Customer Authentication using an SCA Attestation presented from the user's EUDI Wallet. The flow uses the `urn:eudi:sca:login_risk_transaction:1` transaction data type defined in the [TS12 Electronic Payments SCA Implementation with Wallet](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md) specification.

## How it works

1. The organisation enables the Risk-based Authentication extension from the dashboard.
2. An administrator defines the protected actions (e.g. login, changing beneficiaries, raising a transfer limit) and the description shown to the user.
3. When a risk engine flags an action as requiring step-up, a presentation request with an `urn:eudi:sca:login_risk_transaction:1` transaction data payload is triggered using the configured presentation definition.
4. The user reviews the action description in their EUDI Wallet and presents an SCA Attestation.
5. The system verifies the presentation, validates the Key Binding JWT (including `amr` with at least two different authentication factors) and approves or denies the action.

## Configuration

### Transaction data

The verification request carries an `urn:eudi:sca:login_risk_transaction:1` transaction data object describing the action the user is authenticating:

| Field | Type | Description |
|---|---|---|
| `transaction_id` | String | Unique identifier for the authentication transaction |
| `date_time` | DateTime | Timestamp of the authentication request |
| `service` | String | Name of the service requesting authentication |
| `action` | String | Short identifier of the action (e.g. `login`, `add_beneficiary`, `increase_limit`) |

### Integration

Once configured, the system automatically generates a **Presentation Definition** bound to the `urn:eudi:sca:login_risk_transaction:1` transaction data type. This presentation definition can be viewed from the extension configuration page and is used when initiating step-up requests via the API.

**API endpoints:**

<ApiEndpoints endpoints={[
  { method: 'get', path: '/v3/config/extension/risk-based-authentication', description: 'Retrieve current configuration' },
]} />

<NoteBox title="Caution:" variant="caution">
Disabling the Risk-based Authentication extension deletes its configuration. This action is not reversible.
</NoteBox>


---

# upload pdf file
Source: https://docs.igrant.io/docs/extensions-api/config-create-digital-wallet-open-id-upload-file

---
id: config-create-digital-wallet-open-id-upload-file
title: "upload pdf file"
description: "Uploads a PDF file for use in OpenID4VP transaction data signing workflows."
sidebar_label: "upload pdf file"
hide_title: true
hide_table_of_contents: true
api: eJzlVs1uGzcQfpUBTwmwWimOexGCoI6dFG6CxoCS5mAY8Gg52mXEJRmSK1kxdOuT9NH6JMWQq187P4feepF2l5zhNzMfv5l7ISlUXrmorBFj8dFpizIAwtXFG5gpTTCzHrpAoAy8d2QuL07/vILo0QSs2AokRoSgaqNMDUvr5zNtl6EUhbCOPPKeSynGorJmpupzTxjpQtUqov6EWlNMbmU++o3SJArh6UtHIb6yciXG9+lVeZJiHH1HBbuKZCIvtZ2OyqGPw5n17YDB8OdQNdSmp7hyJMbCTj9TFUUhnGdYUVHgVQ5xb1eIXplaFIKdYRRjMVUG/Uqs18Ueiutsd7Ne5+/BWROyw5PRiP8O08pRQZcCJAmhqyoKYdZpvRIHwaBzWlUpZcPPgU1/PhIlvxtH1ykp1kUCbrB9JOh+8fVdJG9Qv1Nm/n2PXj1Ii5Ji74hHHN6kjDWEkjzD5rfT0TM+6KfzsH8geW/9uZV8WHq+2Ev8TfGDnO2sd4EqE6kmz/7usHVMj9PRaP2I+0eSszURr1CCMq6L4NBjS5G8WGe+HF05g11srFdfiZN3mJpfMpv+p6m5NJk5EMgvyEM65ihH60IEqjqv4kqMr+/FmVNviR9v1hwj1oFzcWGrriUTYZJ1iuNvKTaWhcnZkOLH2IixGC6eD7NUDekukgmcadnbD3qdGzKxh/lGC0bA+EICcBjCBbW2hy8K0XktxqKJ0YXxcCiptQN0qlS1RxNLZcW6OHZw5a3sstB+w82PPEwi1izN3zAPefkYyM0urxOmV2bFJrvb8mL+UAjFR+XCiEJkhRFnPbMTXcVxec+uLmFOK2D+k4k9q0v40BAsUHcEdgaxIbg98HML+RhouxBhSuA8zdQdSViq2MBtxgi38MTYSMlB9Kh0yoHDip4WQGVdHrkdQ2/4YmU7z+kYzGn18rZkYXxF6Mnzfo59mt7ebITw908fHsTGMWCSeYh2TgZigzFjSa9kpLPKxE2IubXCuTWGqghb5oEKoaNQwoSMBBUBwwPcGRy8SJ4ZcJEVgSuQoYrtbeeqJ9VWZmY30oJVkhZqUTEzQuec9fHXHRu2BVW/7T4d0mifgUe52BrBk3/++vspKJ4vJkuSKjR5eqC7qkFTE6CRsCCvZj0ZEmlVxTW2CyXJl3AZeRwJEEjPBsEuyJOqDSjJFIqrorfHqSaoPKXPqEMBCDJPHbBMY0c6LFitJDgrIVLVGKttrSgUQAaniTEIhpagaUGaa8USmHQSp0qruEpOsIu2xcjbK9s6rdBUlNmYwvNUdzrFE3iMQkitH7CTKiacLRpDngunVUUmJNHd3CGHVUNwUo4e5Hy5XJaYlkvr62FvG4bvLs9f/zF5PWCbdSGiivqgeMA3byNpm7vJApbrdTI6OS2fl8/YlrWxRbOHJ4seODlL8+Ex8/ea1X88TfYMjnQXh06jMowvJeS+1+5rsXieB6qZyi2nv0UM8kjB++GEc5pV/KYQDTeC8bW4v59ioI9er9f8+UtHPnWUQizQJ2al/rJpREn25yyL4jzHPvjAWHm77hjzY0MqC3U2OqsqcnFv+4Mev95vV1fvJ6w30342blOPTmNZ8lvsHjNI7FVrp9jzpNj9A4PfLJnVHopj8c5g+ZehP2rygon1llYvt9vzyjcNtg0j7+aa8oT4L5jbYeg=
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>upload pdf file</h1>

<MethodEndpoint method={"post"} path={"/v3/config/extension/document-signing/file/upload"}></MethodEndpoint>



Uploads a PDF file for use in OpenID4VP transaction data signing workflows.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"file"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","format":"binary"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

File uploaded successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"filename"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"fileExternalLink"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"filename\": \"string\",\n  \"fileExternalLink\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete uploaded file
Source: https://docs.igrant.io/docs/extensions-api/config-delete-digital-wallet-open-id-file

---
id: config-delete-digital-wallet-open-id-file
title: "Delete uploaded file"
description: "Deletes a previously uploaded PDF file used in OpenID4VP transaction data signing."
sidebar_label: "Delete uploaded file"
hide_title: true
hide_table_of_contents: true
api: eJzlVsFuGzcQ/ZUBTwmwlhTHvQhBUCdyCjVFa8RJcwgMeLQc7TLmkhtyVrYq7K1f0k/rlxRDriRbtttTT9FBonY5wzdvhm9mozTFMpiWjXdqqmZkiSkCQhtoZXwX7Rq61nrUpOF89g6WxhJ0kTQYB7+15Oazk9/PgQO6iKW4AY2MEE3ljKtGqlC+pYDyZq7VVJXeLU2VD5qZyjDaz2gtcXKm3xlLqlAtBmyIKUQ1/bJRDhtSUyWHz7UqlBGwLXKtChXoW2cCaTXl0FGhYllTg2q6UbxuxSpyMK5ShVr60CCrqeo6o1VfHAQ/n4FfAteUg2QPOqFU/aWcElvvIkVxfDw5kZ/75qpQNaFOkDd9X6iTyQvZVXrH5FiW2LbWlImL8dcoVps7cPeBfFEUgg9vvRYu0np256zLYhuaX3ylkoWvICyzyfj21nsWjGOqKIi/W2xaS2p6Mpn0j7h/hLmdiXqDkvm2Y9ilSPXyOWTzk8OOax/MH6QfoebkO6bmA0XfhZLAeYal79xDgn6YTL5jguaOKTi0ECmsKEA65oCjvlCRyi4YXieJOG3Ne5LlpVxXxkqUQ8182TXkGC6yHkn8DXHtRYqG611kJZmq8erlOMvTmG6ZXBSu9eDhaFC0sYjDeJOlqFeCQjBmnTpU08YPIahCdcGqqaqZ2zgdjzU1/ghbMzJVQMcj41VfHDo4D153WVSfcPNfHi4YK+Oqp8xjfn0I5HLP7YWUWK6MLcO7FGN+MMhxTo4qtmJ9Olz/VLLqMMWn53O4pjWISJDjobJH8LEmWKHtaKvFV/f8XEE+BpouMixI+tTS3JKGG8M1XGWMcAXPnGdKDjigsYmDFkt6XgCNqtGB2ykMhq/WvgtCx9E1rV9fjaRLvCEMFGS/xL5I/95tW8nPnz8+iE1iwLKkGIH9NTngGjljSX/J6dYbx9sQcxuFt945Khl2tQcmxo7iCC7IaTAMGB/gzuDgVfIsgIcGKBnIUNXuxkvWlVwc45Z+Ky9YJnmhBo1URuza1gf+cV8Nu4San/aP7pfR3Qo84GJnBM/+/vOv52BkuLi4IW1inScFui1rdBUBOg0rCmY5FEMqWlNKjv3KaAojmLPMHhEi2eVR9CsKZCoHRksJ8boY7HFhCcpA6THaWACCzrMG3KRhIx0WvTUaWq+Bqaydt74yFAsgh4tUMQiObsDSiqzkSmQwaSUujDW8Tk6wY98gy/bSN6016ErK1ZjCC1R1NsUTZWRCWHbWSt1rwwlng85RkMRZU5KLSXi3d6jFsiY4Hk0ecH5zczPC9HrkQzUebOP4l/nbs18vzo7Epi8UG7b3kgdy87aitr2bImA5X8eT45PRy9ELsW195AbdHTx5bNtPhMs8ren7HWDXtf6feXKoZqZbHrcWjROsiZzNoORf1OqlKoZRM7Wg4UYJ1gM9l7kwRzEdxsvLQtU+srjZbBYY6VOwfS+Pv3UUUosp1ApDKrMs+ybKWqvpEm2kfyHk2YehUT+HJ8fNJyLciq4TxU0SmYfOa9Hk7WjcX/bbNpmQ5ZenZUkt3zF7MEz0d/vi7OyXs49nqlA4aN5e76+T3g8LOeBRVIfSn1HIt3SoR01eSVm+p/Xr3fb85kmDXbvJu4Wjy77v/wHUz3Ie
sidebar_class_name: "delete api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete uploaded file</h1>

<MethodEndpoint method={"delete"} path={"/v3/config/extension/document-signing/file/{fileId}"}></MethodEndpoint>



Deletes a previously uploaded PDF file used in OpenID4VP transaction data signing.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"fileId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"ID of the file to delete"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div></div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List uploaded files
Source: https://docs.igrant.io/docs/extensions-api/config-list-digital-wallet-open-id-file

---
id: config-list-digital-wallet-open-id-file
title: "List uploaded files"
description: "Lists all uploaded PDF files available for OpenID4VP transaction data signing."
sidebar_label: "List uploaded files"
hide_title: true
hide_table_of_contents: true
api: eJzlVs1u20YQfpXBnhqAlhzHvQhBUCd2AjdBasBJcwgMeESOyImXu8zuUJYq6NYn6aP1SYpZUr+W66LorT7IJGdn5puf/WYWpqCYB26EvTMj84GjREBroW2sx4IKuDp/CxO2FAGnyBbHlmDiA/zSkLs8P/31CiSgi5irCShQECKXjl05MJnxDQVUyWVhRib3bsKlOjnnkgXtF7SWJJkq3rIlk5lAsfEuUjSjhTk5PtZ/D0GCn2wgJngmU/NCTlQDm8ZynjwPv0VVW5iYV1SjPsm8ITMyfvyNcjGZaYLiFO6cqrmtUxgCzk1mWKiOT2tzsXUmSmBXmsxMfKhRzMi0LRdmmSUnH7Gmh4d74cVMKDi0H9jd/b3FwKqTB0Kh4ky2DrMTKimYbC+Dnx3PQLimKFg3qt02xb/WXmrRvrccqDCjr5qArfAOBLONddvzjVpqsGSHnaenUp23IZCTKyzpAOxlZsQL2su9uu3LVf0RueWaD2VkmZkK41WgKft2W3fsvSV0/YGPNJNDwr2EbYexg3kH4ArNruuNn5ul/mWmIiwoKCh9Oz1+njL1T2/GNi4KwYc3vlBU6fl8qw1usieKs9E+1FE0w7rRa3Z6fLw8YP5Aw69VzGssgF3TCjQYsCbRknTR73cqtlL5wL+RNuVuan7suOV/mppL191IiBSmFCC52cvRMjOR8jawzM3o68KcNfye9PFmqTFiGTUX5z5va3IC1x3ta/w1SeWV8UtK4aNUZmSG0xfDbgQMaSbkoia66NWP+qkxXLF5Bywmz7vYz6n2PW4lkGDNyFQiTRwNhwXV/ggbHnAZ0MmAvVlm+waugi/abmA9YuYpC9eiPFU+ph478T6Qm01Cr7WvunZYpXUzcboPmWF11VXEZMalcWHO+pbuSHK/rmdXl3BHc9DGJyd9Ow/gU0UwRduSTk6pCG537NxC5wbqNgqMCZpAE55RAfcsFdx2GOEWfnBeKBmQgGxTDhrM6VkGNCgHe2ZH0Cu+nPs2aDqO7mj+6nagDPmaMFDQ8xr7OL29XU21n798ehCbxoB5TjGC+DtyIBVKhyW9kisaz05WIXYrCrzxzlEusO454BhbigO4JlcAC2B8gLsDBy+TZQWcdVSQiDzJzPqaa9UTq7Ob+BWnYJ44hWpk7YzYNo0P8tOmG9YF5XebT7tttN2Be7lYK8EPf/7+xzPgCAjX91RwrLotjGZ5ha4kQFfAlAJP+mZITcu51thPuaAwgEuBNlKESHZyFP2UAnHpgAttIZlnvX5a/vJA6TPamAFC0W1ycJ9WueQsessFNL4Aobxy3vqSKWZADsepYxAc3YOlKVmtlXJfIkgcs2WZJyPYiq9R9Hju68Yyupy6bkzhBSpbm+KJwA4QJq212vcFS8JZo3MUBmlw5uRiYtvVHWowrwhOBscPcn5/fz/AJB74UA573Tj8cPnm4uP1xZHq6OrAYneKB3rzVmS2uptKYF29To5PTgcvBs9Vt/FRanRbeNJK+2CfLXZZfz2p/vs1vW9koZkMG4ucNpiUl0VP3l/N9EW3Yk+4Gzn9ZVKcexTeL31RJ0Hlo6j2YjHGSJ+DXS718/eWQpokmZliSI2V5spqACXWv1NWNGd5To1OkURfiR73xvRye+K8u1DiwJ5VNox6lxi1f1DrK5Gbb9neJ9cOgv7qDDio8lIL/57mr9bHO8mjCmtC705rsnV5+wtouLaC
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List uploaded files</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/document-signing/files"}></MethodEndpoint>



Lists all uploaded PDF files available for OpenID4VP transaction data signing.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

List of uploaded files

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>file</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"fileName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"fileExternalLink"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"file\": [\n    {\n      \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"fileName\": \"string\",\n      \"fileExternalLink\": \"string\",\n      \"createdAt\": 0,\n      \"updatedAt\": 0\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 0,\n    \"totalItems\": 0,\n    \"totalPages\": 0,\n    \"limit\": 0,\n    \"hasPrevious\": true,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Download uploaded file
Source: https://docs.igrant.io/docs/extensions-api/config-read-digital-wallet-open-id-file

---
id: config-read-digital-wallet-open-id-file
title: "Download uploaded file"
description: "Downloads a previously uploaded PDF file used in OpenID4VP transaction data signing."
sidebar_label: "Download uploaded file"
hide_title: true
hide_table_of_contents: true
api: eJzlVsFuGzcQ/ZUBTwmwXimOe1kEQZ04CdQUrREnzSEQ4NFytMuYS25IrmRV2Fu/pJ/WLymG3JVk2W5z6akXe0Vyhm9m3rzhVkjypVNtUNaIQlzYtdEWpQeE1tFK2c7rDXQtL5KEy4u3sFSaoPMkQRn4tSUzuzj77RKCQ+OxZEcgMSB4VRllqlxkwrbkkHdmUhSitGapqg+E8kJVKqD+jFpTiK7kW6VJZKJFhw0Fcl4UX7bCYEOiEHz1TIpMKAbbYqhFJhx965QjKYrgOsqEL2tqUBRbETYtW/nglKlEJpbWNRhEIbpOSdFnR8HPLsAuIdS0jzfGGizIIS+in/OFvrXGk+c7TqdT/nfX0y5NpTWBTBCZGL+KrcC21aqM+Zi0cslL34F5oQy6jej7vs/E2fQZH37E6VfPKA697nP0RZBz1r22ktMcvy8OsM+zEYFdfKWSkbeOyxdUindvvQerTKCKHPu7xabVJIqz6bR/wP0DAe5MxCtkSrVdgF31Y7j3CvXJYBdq69TvxGSoCWUkyjal5ux+QZhVYGyApe1MLP0PqW7/0wzOTCBnUIMntyIH8ZqjVPaZ8FR2ToVN7MHzVr0n/pxzEwSsuDXFhS27hkyAq9TuHH9Dobbc6RXF8LlPCzFZPZ+k1p/QbSDjOdFyMD8Z1GLCbTPZpkbvBUNggEkFjrSKGjvgF5nonBaFqENofTGZSGrsCbYqV5VDE3JlRZ/d61JnZZcE6xE3/+bhKmClTPWYuU/bx0Dm+8ReMb8SLcb07uqLaWEQu1QZkY1SeD50QOSrOK7v+eUMbmgD3CdkwkDrHD7WBCvUHY1Kd33HzzWka6DpfIAF8QxYqluSsFahhuuEEa7hibGBooPgUOmYgxZLepoB5VV+5LaAwfDFxnaO03FyQ5uX1zk34itCR47Pc+yL+OvtKHo/ff54LzaOAcuSvIdgb8hAqDEkLPEnGdlaZcIYYhpR8NoaQ2WAHfdAed+Rz+GKjAQVAP093AkcvIieGfAwXrgCCarYtTtXXXDXKLO0o7ZgGbWFGlTMDN+1rXXhxz0bdgVV7/ZLd2l0yMCjXOyM4Mlff/z5FBQP7qs1SeXrNIXptqzRVARoJKzIqeVAhkhaVXKN7UpJcjnMAs91D5708sTbFTlSlQElmUJhkw32uODJ5iguo/YZIMg0yWEdR3m8zFutJLRWQqCyNlbbSpHPgAwuImMQDK1B04o014o1MAolLpRWYROdYBdsg4GPl7ZptUJTUmJjDM9R1ekYj+fnCMKy05p5L1WIOBs0hhwXTquSjI+qO/ZQi2VNcJpP7+V8vV7nGLdz66rJYOsnP89ev/nl6s0J2/SZCCroO8UD7rxR1MbeZAFL9Tqdnp7lz/NnbNtaHxo0B3jG19fd98dxAxwMrf/qvTYwOtBtmLQalWG8MUHbQc2/iNXz9KpZqjSDhq5itEeazq+YFEcxPODmmaitD+xmu12gp09O9z0vf+vIxRmTiRW6SLUk/crztxTFErWnf0jJkw/DpH4K3/OgeyTYUYMNC3BUTFEIkYkblujxHdrP+3FkRpBp87wsqQ0HZsfvvf5wRL57wwqHg/ztpf8mSv/wwc4fRHQ8BRIC/svD6kGTF8zQ97R5uTuedh412E2edJrzM+/7/m/8sj2y
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Download uploaded file</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/document-signing/file/{fileId}"}></MethodEndpoint>



Downloads a previously uploaded PDF file used in OpenID4VP transaction data signing.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"fileId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"ID of the uploaded file to download"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

PDF file content

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/pdf"} value={"application/pdf"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

File not found

</div><div></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create OIDC Client
Source: https://docs.igrant.io/docs/extensions-api/create-oidc-client

---
id: create-oidc-client
title: "Create OIDC Client"
description: "Creates an OpenID Connect client. The client enables passwordless login with EUDI Wallet by requesting verifications from individuals. During client creation, a presentation definition specifies which credentials to request - appearing as a QR code or deep link on the authentication page. A presentation definition belongs to at most one client. Give exactly one of `identityMatchingAttributes` or `callbackURI` with `callbackSecret`. The answer holds the generated `clientId` and `clientSecret`."
sidebar_label: "Create OIDC Client"
hide_title: true
hide_table_of_contents: true
api: eJztWdty4zYS/ZUuPCVVtHyZ2RdVKrWO7c0qmZ1xRnbNw3jKhIAWiZgEGACUrHXpbb9kP22/ZKsBUKJutiepfcq+2CJxa/Tl9OnmE5PohFWNV0azIbuwyD064Bo+NKhHl3BhtEbhQVQKtR/ATYnpN6DmkwodNNy5ubGyQuegMoXSMFe+hKvbyxF84lWFHiYLsPhbi84rXcAMrZoqwelUB1NralBaqpmSLa/cAC5bS9PSOYKEUkZnwKGx6FD78AwSp0qr8NM1KNRUoYN5qURJayRqr3jlwJvubDgC3jTIw+7cAYdfPoIwEsFYkIgNVEo/gNHgSwTe+pL2iHJCwwscwPlBESZYGV2E47iH2jgPRuNKcT+qGQI+cuGrRRgwU8hVENIv/sG9KJUuzr23atJ6dDmJlAteVRMuHm4/jvKo1NWrMQqLPo8W4drN0UJpKumC7AVqtNyjhDwKMJI5cL167FazjCXd/GDkgg2fmDDao/b0kzdNlW5//KsjB3liTpRYc/rlFw2yITOTX1F4lm150v/suucrY4YJE+PLjBaHJ51O8iXWGSgHFqetQzm40yxjjTUNWq/Qkfx9O16uzDiSvbs5T56yczfS+OgynXPQH7yB1iFMjQVfKrdyhN/tQaPnzyuDQ3vLteMiDnLPwWPdVNxjFhZ3T1C3zsMEIQ8Be2+Ve7jvrb3XRt97d3oWDbN/Uj6A96YXalDzBQhTYzSG8g7MXO+K9M3N+PRsCA1f1BTf8wgR3Ht0PkW6M1M/5xaB3iBNy+CXq/H5RQbji/P+mWQq9+0QXCtK4DsK0caXaKFpbWMcgi+5jhhFLrHMmOY1vs7iNLOzeTQJrbcolUXhbz+OXG8fbi1fsIwpj7Xb3X+574BuK6C9kt/gBvDm3ZT71qqchOE6wJSxykWH6IIj2LemOINeTHQROSAJeFWZOcoPVhVK/1Hh5zgBE3eiwxamtdDDj3Dg4fDfhydcymBHXl1vxO0LwpxDzRsSoecj8eCpQhuCS1Rc1dBwXzoKUUmpgIA/pCZetRi134kb1ah0MYArLkp4wMV6R4q59UnDYLJ8JnxnnfHl0U+fbnpTYhzm0gi6SDetlkZsTDIWOORxSpApTIRPby5606JXxGEVgV8af+Sw4RH86Y504+hIdGuKTEX5jfsDGwVXodEwf4IU0HHv3LWTPGUycirU3i6CqpBv5FxQMYNeXvzyDn5r0S5eAMt4PimWclSYSJIHJ8ZH5Tx0Mq+3HMDVI6+bCoeQP92x1uohtlINGyWHp3dsCHcMa66qO7bMyczpDuFdnm6XpLoeXfalP2D8SwPaeHCoJSgP3hQYsGUzUVHuiukGo3jks5vCsWGUjC2XGeutex0O3X4cUXqIPIdHoyTTzVVVEagLXom2Ch5A+rToW6vpQQhjJbl58gmyxYZNBnDriE7A329urseAWjZGdfDTPYFFgWqWNNpf7shOHK4/jG9WSEQSBEMmkhLURbDeOjg7OQnjHH4af3gPMfajoSOXSS73vOqfoRUJ5TdZxOv07MLcCBCUkYUgfht8aMPW8BF/a5VFCfMS9RaJUQ4c+oB+vTR4yT0/F/GsXVFq/vgOdeFLNjx9e7JPNI+PSUtxbJJMEcl3sm3r0HaB2KPiWQzY6JuQvzMFxDUBso2ulEaYcP0QvKXVfueGf4CEEGHwkBLP63bTZme76I398oKM03i3ok2nb09AlNxy4dG6rXBkL985RKZNt2bDz4fJYmIQX5bLuMQ1RruYqM5OTunfVoXVq2mQlv9uvr3JZjuW/7XsNQnSYzT9AuGrIuXAjlEzJXKJNoh6wUWJRxdGe2uqvXdcnbW2mTZHzhuLuwl/pCUpLYQA90GEzgzgStNWMmBHgEVRohywINDbk5OvKneMxg9TNvy8awivfBDx2pqZkmgBrTV2R1NX9LYDwaSrVGR3Kwknnlb7nV+P0lbLLxvZJL4cMqVnvFLyPiEt6YtG7rcJUaqjQ2xWFrlcwARRryzVUc0miiHhuh+Pa3dn0ZSb2//AZQf1MS6bTg3xqi6BdBAt1aA7YuZrLJgYuSDYJJuF64XUkCVwPRSHeQY5BeJmHZmKRtquVs4pXaR9qGqkmfo1lWksm/uoToVJoWaoY+X5Eoytlb6u7zZ4fVe+c5d0c2Ek9nV1uVdV1/3Gy7uA/fjoUTs6NKkwNmkkFfrrEIz+f/pV/t9Hw5WMncv15GNfshegar16HfFKeyzQ9kP+7cnJcs/2z6IEOaPSTeuBGHCNHm0HQJtee6tT2fTPAMKbqvnLnwUabrbzdPodGif9lP9cgt7OzntRIpUXSsYtnq8Gstc0i2jKXkqVd02flAqCAmJBpYH8zGpeRe2BEaK1FmVsK01bx6teE80id6QNvQ+xYuSSIfbg3MvxqzwIrilCbSieevhrt4N1mTGHorXKL4KXnTfqZ6SfX8j6nheOgnKrYRuJBkVjjb40kg1ZY4InUGnFhux49uZYGD1VxfEKNY6NkuI4ZW461c6CEJ+3acwl1gbiMMtYays2ZKX3jRseH0uszRFv1EAVlms/UCb47uYG19bINjrNgW1e2mHseUGlzIHlLg5vC/JlrcsxBXCEpE6j6xZIfJExRUdFY3Rcb8jOE3YEx92JZvKJUMpu9I93SmyEfGOfHOIxq9ZcY3GqHikEg2NFGSGHb7TxGLt5lqsq6KDhAr/NAAfFYGvbIaSF3xHZJXUcPeDi+zzUJD8gt2hpPt19Ep7+ZmzNPRuynz7d7KV7XSVkHlCvOVd8XJWImyjWOWU/PbkW3QDGqaSj1LcldxQOvgs7fx961QFzyQJRVLZKNWT1QNoJnT+uO9pXa2g83O9dZ5Jk39XzZnfvczfwZbd51h97vs91qBew1QpYC7FdvK5HDpSUrypwyLWnpstzXIQ8F0UZMtc2jbH+r+vAWelG/bh+tRlx/WDdcpvVIvjmP//697eUYDiM5yiVK2PmwUdRcl1gAM3+96EQ30r00BFGPvZzHFbTI2dmaFEVetWyydJ6Ij79D0H0/UiqQnlerXrOWoIzRDIbI8GjKLWhIhpdFplT+FAEGudQ4QwrcuuQQojP8ImqqEMUGhitNzUPH7eEqZtKcS1SGzxcz2JBDZl1i2TaVhVBhFQ+yFlzrSPyV0qgdsFlO7hpqHCBs8HJjs7n8/mAh+GBscVxWuuO340urt6Pr45ozXLNQ9Z2IJCSRrR1FxIsY4T10V5nJ2dvB28Gp7SWskbNdU+e+JUQPowuL7o0s2XwHnn6/zfFP+E3xYTK1Kc6biquQhMueO5Toh+f2exN7H5MVeTwKTOwjBEJYV0jggC1JOIy/Myenibc4a2tlkt6HdrARIMyNuM2xHsgRR17CrzlgfI6u4jueHRDgtH0qo1pfovXE82IK85DS+nZuX1uRS1PlrFJ+opah/KGWT6nLMLnbMju2B2jy4UQCZkgvH9iFddFywuaH/elPMZTTl7zkYfAR9KPXrHB9aIn5TY1iZehv6F+2LfkO8KCn3Hx/Wp6HDm4YEWH4myyLvW//gvQH34R
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create OIDC Client</h1>

<MethodEndpoint method={"post"} path={"/v3/config/extension/oidc/client"}></MethodEndpoint>



Creates an OpenID Connect client. The client enables passwordless login with EUDI Wallet by requesting verifications from individuals. During client creation, a presentation definition specifies which credentials to request - appearing as a QR code or deep link on the authentication page. A presentation definition belongs to at most one client. Give exactly one of `identityMatchingAttributes` or `callbackURI` with `callbackSecret`. The answer holds the generated `clientId` and `clientSecret`.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the presentation definition to use for this client. A presentation definition belongs to at most one client. If the presentation definition has a transaction data template, the template must be `login_risk_transaction_non_ts12` or `login_risk_transaction`. No credential may come with its own transaction data (TS12: payment wallet attestation, software statement, QESAC, SCA credential types): such a definition has another purpose than login.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"redirectURIs"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The redirect URIs for the client. The `redirect_uri` of an authorisation request must match one of them exactly."}}></SchemaItem><SchemaItem collapsible={false} name={"allowedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The web origins of your application."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityMatchingAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A map of credential identifiers to claim paths used as linking values for identity matching. Each key identifies a credential: the `vct` of an SD-JWT credential, the `doctype` of an mdoc credential, or a `type` value of a W3C credential. The value is the dot-separated path to the claim within that credential. The value of that claim becomes the `sub`. Give one entry for each credential in the DCQL query of the presentation definition. The key and the path must exist in that DCQL query. Example: `{"urn:eudi:pid:1": "email"}` uses the `email` claim of the PID credential for identity matching. Do not send it together with `callbackURI`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"callbackURI"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI at which a `sub` value will be calculated and returned according to the sent presentation. Use an HTTPS endpoint. The endpoint receives the presentations in a POST request and must answer with status 200 and a JSON object that holds `sub`. Do not send it together with `identityMatchingAttributes`.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"callbackSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret used to access the `callbackURI`. Required when `callbackURI` is set."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataAction"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 140 characters`"} schema={{"type":"string","maxLength":140,"description":"The text that describes the login to the user in the EUDI Wallet, for example `Log in to your online bank account`. Required when the presentation definition has a transaction data template. Not allowed when the presentation definition has no transaction data. The EUDI Wallet accepts at most 140 characters.\n","example":"Log in to your online bank account"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

Client created

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Cache-Control</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Indicates that the response should not be cached.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the created client"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret of the created client"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"clientId\": \"string\",\n  \"clientSecret\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with `error` and `error_description` when the body is not valid JSON, when `presentationDefinitionId`, `name` or `callbackSecret` is missing, when both or none of `identityMatchingAttributes` and `callbackURI` are given, or when the presentation definition already belongs to a client. The answer has `errorCode` and `errorDescription` when the Passwordless Login extension is not enabled.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_request\",\n  \"error_description\": \"A client has already been created for the provided Presentation Definition\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The validation of the presentation definition, of `identityMatchingAttributes` or of `transactionDataAction` refused the request, or an internal error occurred. A refusal holds the reason in `error_description`. The API answers with `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_request\",\n  \"error_description\": \"Transaction data action is required when presentation definition has transaction data\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete OIDC Client
Source: https://docs.igrant.io/docs/extensions-api/delete-oidc-client

---
id: delete-oidc-client
title: "Delete OIDC Client"
description: "Permanently removes an OpenID Connect client and its associated configuration. This action cannot be undone. System-managed clients cannot be deleted."
sidebar_label: "Delete OIDC Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV8Fu20YQ/ZXBnhKAlhw7vQhBUMdyCzVBY9QOeggEa8wdkRuTu+zuUrIq8NYv6af1S4rZJSmZklPkUKBAc3Ak7s5o5s2bN8OtkORSqyqvjBYTcU22RE3aFxuwVJoVOUANHyvSsylcGq0p9ZAWirQH1BKUd4DOmVShJwmp0UuV1RbZ3whuc+UAU/4CKWptPNwT1FoaTSO42ThP5UmJGjO2DV7d3kVJBXmSI5GICi2W5Mk6Mfm8HUR9mxPMpmCW4HNq/YhEKD6r0OciERpLEhMRz2ZSJMLSb7WyJMXE25oS4dKcShSTrfCbiu86b5XORNPM+bKrjHbk+Pzs9DX/9zSGy4hJG7JIRGq05zgm2yYROaEMsW+bJhGvT0/Zwe6GwKoqVBpQG39x7HC7F9Au1M+CrDX20kgSSfw83QtjnnTBm/svlDIIlTUVWa9i6DvrXZ5Ke8rIsr9HLKuCxOT16WlzxP0BNnsm4h1KULqqPfS1Eg3/SwZI8UXOiJxnhhBco3NrY2VBzsEHkykN9OhJO6aNcsBsII33RaTCEMtX/2MsP2msfW6s+j1wbgjN+TdBM0zXKx+iubZmpSRZCEmIYQxX/BRQuzXZrgdbwegsR8fBOwbCYWeHq5AaSQksjYUWJlgovcJCybuWTIsEFtr4u6WptVyAsbBwZFdk74KHhejKcCe/XofDECyhMzr8uu8iEqEcfc36lMTS2HslJWlx9PdElD14KnuHqieOlPu2lzfuC/dUP1mOD70MSfHdN2qP0fRxGTT336RHk2x7fxfXsw7h+VGA96v6DMYz7clqLCDe3VXsANKjN6MuVV1iWDjTZuBgrXwOngeb8+hrB+ucNGjTFSZHF3LM1Io0zKbRV5s/Hy564ViEmi2G2rCILlVPCkuY5sFptddQ+3VtEuEora3ym1Cri0q9J/44Zww9Zjw2xWCMx5HFQleSz40UExFZE+atz8VEjFfn4zjTx70kj42S6ThmO952E7URSVuYYxN6SqVpERaJqG0hJiL3vnKT8VhSaU6wUiOVWdR+pEygw2AxsUbWcZF4xs0/ebjxmCmdPWfu4vEwkPkO2BvuiaheHbx9U2B80O4csTK7reOi1ejQYwcNwnx/oA2wkpP2bStG2qywqKnrmsUTPwuIPwNl7ULHV5aW6pFkZOgixggLeKGNp+DAW1RFwKDClF4mQKNsNHA7gdbwzcbUluE4eaDN2wX3qHhHaMnyfc79Pnz7wdgSvZiIn369PSqemKY82L15IA0+Rx9jCV9Jy8oo7QfC0DF0fw1wNbkR3FBYOoH7aBB3DA7eBM8ccLvTcQViqKIf6Vx1wV2j9NJ0eohp0EMqUTEzXF1Vxvrvd2zoC6p+3D16SqN9Bg6w6I3gxV9//PmSFRzhZk1SuRwkegR6THPUGQVZWJFVy5YMgbQq3et/mHmoHTlwVCxPnFmRJZVpUJIp5DdJa89bE6SWwmMsXAIIUmXKYwFrLAqKa7wzhZJQGQme0lybwmSKXBLXLmYMgqY1FLSigmvFe06Y53ivCuU3wQnW3pTo+XpqyqpQqFOKbAzpWcrqIuTjQGlAWNZFwbyXyoc4S9Q6aluhUtIuqH7XQxWmOcHZ6PQA8/V6PcJwPDI2G7e2bvxhdnn1883VCds0u3m1qwN3njRpXZL2XW+ygMV6nZ2evR6dj16xbWWcL1HvxTMNSgkfZ9PLTkgHBd8bsv/d96q2Hzw9+nFVoNKcbYB3286Az2J1Hl9nlipuqW1PikTwJOCzLv9J/341T0RunGfz7fYeHX2yRdPw499qsmEyJWKFNhA0DgzlwoovJkssHH0FzBe/tDv8S3jmze9oVp1Ua9bpIKxiIkQiHljJd2+Gzbx/XwtxxeOLNKXK7xkebE3N/hydXn24ur0SicBWK3dz4iHMifbD3l71NK7hyIhR8N+wKh0zecN0fk+bt/31ePKsQT+m4m1Gad40zd/OZJ7f
sidebar_class_name: "delete api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete OIDC Client</h1>

<MethodEndpoint method={"delete"} path={"/v3/config/extension/oidc/client/{clientId}"}></MethodEndpoint>



Permanently removes an OpenID Connect client and its associated configuration. This action cannot be undone. System-managed clients cannot be deleted.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the client","in":"path","name":"clientId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

Client deleted

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The Passwordless Login extension is not enabled.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The client is system-managed and cannot be deleted

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"forbidden\",\n  \"error_description\": \"System managed client cannot be deleted\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The provider also answers with this status when no client has the given ID. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Discovery Endpoint
Source: https://docs.igrant.io/docs/extensions-api/get-oid-configuration

---
id: get-oid-configuration
title: "Discovery Endpoint"
description: "OpenID Provider configuration endpoint that returns the OpenID Provider metadata as a JSON document"
sidebar_label: "Discovery Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJy9WNtu20YQ/ZXBPMUALbmO+0IERR3bDZSksRE7yINhSCNyRG5M7rK7S8mqwLd+ST+tX1Ls8iLq4iRu3ebFEblzdvbMzJlZrjBmE2lRWKEkhnhZsBydw5VWcxGzhkjJmUhKTe49sIwLJaQFm5IFzbbU0oBNGbbtcrYUkyUgAwRvry8/QKyiMmdpMcCCNOVsWRsMb1dbLtykDKNzUDMPrHRCUhi/PwYo3IqCbIoBSsoZQ+yvGMUYoObfSqE5xtDqkgM0Uco5YbhCuyychbFayASr6s4tNoWSho17f3x05P7speRMScmR3WQEA4yUtO5U4QqpKDIR+RfDL8YZr3Y3V9MvHHkStCpYW1FvLYwpWe86Gexh59PH9y09W7xjFSCVNlVa/O79GLchezLyBkwXebeBVff8L4C9+QZgaVgLOVP/HLNF2ID9srg341KLJ6P5dP3MU3jHS7hmD2YiVbAZm7IolLYuuTpQ0pqWLjct52ZPmu3brYaDDg6my8fi2Wbo2ME+nwctLHjY7/Ik0STtM7vhMZ/ggyl9/TyzFw3qE/wQ8biuAyMSKWQypiwZzykrn9OrGhooS5QWNs37rs2U9r6NzuuKwsr9CzBlir2wrtyvk1rRvluk1tp5i6y10mcqZgzq/5/3PLwLviFoa+v1YYW0nLB2eA+UFxljeHJ0VO2B31OynQm+phiELEoLXSNpT79JolvoTsTGDuBmq5uAMCCVhZkqZTzAXeZOnsTcNhtWWO9s1xL9GXek58I9BZJmwfoRUR/s5/b7ZM0vhUjFHPiUaViEiZBzykQ8bviZBDCRyo49GxNQGiaG9Zz12CNMsI3SOP56mPYpDRklu4StnffR6kLaHQk7H3DvfvihjRjuiXf3so72FRmzUDrO2Bh4rxIhgR8sS+Oin5IByXPWMGXfj2ia9cqqnym7yfHjE8tKSb6c+Vnnv0yTKlh1eKdXo5bpu71E96P7CNcjaVlLyqBeu47cDvF7V9ZBaHx2dE86TZgAybj53Sv7CSxSliAsRCRdbWqmKPWHLXrF0I9FFaCrjHb6CzFhezk6P9ua0iwlbtbcmW9f/EpCgmVJ0h44UcvZpqrB8ZOqTTHE4fzl0B1NRDzsUmioRBwNV5vzZzUcLDjLDu+lWsihKliK+HB7ZqxZ2jf8nnOuGhIxwFJnGGJqbWHC4TDmXB1SIQbCN82BUD7imwBXWsVl5PXtEZhvIVxbSlzXecTc1K+3Hblzp4pKLezy2qV9LVSnhXjHy34brB80g3wdyPUof9qfOXdqwKX0PS/9ZMrSNtVWZ5nvvG1hTDZwJlBvA3lpLExdKvFMPHAMC2FTmNQ+wgReSGW5HlE1icxzUFDEBwHwIBlswYbQGL5aqlI7Og7vefnTxJUhvmbSrN16d/ap//WL0jlZDPHt55u9OklR5ISqno/9DWt3XN6q/fZSspY1f48wA7hmGbtCcmW35XftHLzyyM7h5orkIlC7il1zd1FHV2Ruum4ljyIveZyTcJnRzCQ/r7OhC6h4s360mUb9DNziojOCF3/98eeB69ME1wuOhUnBXyr5IUpJJuxVZM5azJpkgKZI13IBI+tuBwYMZ7NDo+asWSQSROxSyC6Dxt6pP0Sa/WPKTAAEsUiEpQwWlGVs/WZGZSKGQsVgOUqlylQi2AR1+/CzGkheQMZzzlys3MTjWzdNRSbs0oNQaVVO1i2PVF5kgmTEdTb642lOysyfx4CQQDArs8zlfSys9zMnKWspzETE0nhhb2uooChlOB4c7XC+WCwG5F8PlE6Gja0Zvh+dXXy4vjh0NtW6Ja3j4Cqvvb63tekErI7X8dHxyeDl4AdnWyhjc5I9f86FiRzrS7ho72ZbAe/10f/p+0OT3JYf7LDISEh/C3VcrRrFv8X5y0aoReQH4LbCMECn+xhguPPloSf96PvSrvjfBZgqY90Oq9WUDH/SWVW5x7+VrJcY3t4FOCftE7JuEML40QTDGWWGv0Lei4/N9H4AX/2Isvf4rUBLp85eTjFEDPDe6ff2R5bqrrtpeB/rRadRxIXtme8MRVW/w765uMGq+hsJCIjL
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Discovery Endpoint</h1>

<MethodEndpoint method={"get"} path={"/v3/service/extension/oidc/{organisationId}/.well-known/openid-configuration"}></MethodEndpoint>



OpenID Provider configuration endpoint that returns the OpenID Provider metadata as a JSON document

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OpenID Connect configuration

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"issuer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"authorization_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the authorization endpoint"}}></SchemaItem><SchemaItem collapsible={false} name={"token_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the token endpoint"}}></SchemaItem><SchemaItem collapsible={false} name={"userinfo_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the userinfo endpoint"}}></SchemaItem><SchemaItem collapsible={false} name={"jwks_uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the JSON Web Key Set"}}></SchemaItem><SchemaItem collapsible={false} name={"scopes_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The scopes supported by the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"response_types_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The response types supported by the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"grant_types_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The grant types supported by the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"subject_types_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The subject types supported by the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"id_token_signing_alg_values_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The signing algorithms supported for the ID token"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"issuer\": \"string\",\n  \"authorization_endpoint\": \"string\",\n  \"token_endpoint\": \"string\",\n  \"userinfo_endpoint\": \"string\",\n  \"jwks_uri\": \"string\",\n  \"scopes_supported\": [\n    \"string\"\n  ],\n  \"response_types_supported\": [\n    \"string\"\n  ],\n  \"grant_types_supported\": [\n    \"string\"\n  ],\n  \"subject_types_supported\": [\n    \"string\"\n  ],\n  \"id_token_signing_alg_values_supported\": [\n    \"string\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Authorisation Endpoint
Source: https://docs.igrant.io/docs/extensions-api/get-oidc-auth-sandbox

---
id: get-oidc-auth-sandbox
title: "Authorisation Endpoint"
description: "OpenID Connect authorisation endpoint that initiates the authentication flow. Returns an HTML page where individuals can authenticate using their EUDI Wallet through QR code or deep link verification. After the individual presents the credentials, the page redirects the browser to `redirect_uri` with `code` and `state`. When the individual does not answer within 15 minutes, the page redirects with `error=interaction_required`. The endpoint accepts GET and POST."
sidebar_label: "Authorisation Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztWd1uG7kVfpUDAlkkwHikdbI3wmZbJ/am2qaxN3aQFoFhUTNHGkYcckJyJKuG7vok+2h9kuKQ86eRrCTedC+KXkmaIQ8/nvOdX92xFG1iROGEVmzEzgtU41N4qZXCxAEvXaaNsJxeA6q00EI5cBl3IJRwgju04DL0K1E5kYSlM6lXMbxFVxplgSv4y9XfXkPB5wirDA2CUKlYirTk0kLCVXc/QmmFmpNYYeDs3ekY3nMpkc41upxn8OtbSHSKoA2kiAVIoRawRCNm1fkxnMwcGo+sPQkKgxaVC4gTgymdyKWN/AOPzmAqDCbVmqnRK0tyNEzqNzelERNYCZfBhFBMgKsUJtZxh5MY3meo+uemGi0o7YAru0LjNwsF3/8AuVClw/0AwhFojDbPhXJoeEJ3uzH4qRQG00kMVxm2VuFJgoWz8OrsykO6OL+8ilnECm54jg6NZaMPdz2Dk4TxKeiZR6DNnKvK3CxiglYU3GUsYornyEasu2KcsojVaNjImRIjZpMMc85Gd8ytC9phnRFqzjabqH/2OyU+lQjCm2Em0NQwLFfpVN9uwYn346mWnpv516Px4j6VaNYdeYkucI+gXa35lTVi0r21QLvQOnb/wRFDVeZs9IHpApVI2TXJnvFSOtJueHYvOoO20MrijRf6JShpIYGsd0KK1u/4EohE722A/sm98BIpULkbsc8Sh2gX9h2AdEAhrVN+0aHv3o7Jm1eZSDJ/dqOYlZASpggUIWIYO8hL6yDnLslAq8bS9YkkyW5fAPCWJ06u44fcxMePz17hRIEuOHnNksuSIiWmdJ+cC+W4UODFwBTdCqs4VHHShwSPlUs55cniISCVVsk2yBmXdhclBEE9kNxanVDKAF5rzKK1lC98rOOKOOH0AlUU4GrIhRNz2mKwkHwN3DmeLOxB8NdR4yiW3h8Ph/SxjbHJTbDCqQ+9IZz6IGwzvQoZoE41tfZ8qvH5j3w1rOmkqCr+TxpPmICwUKqF0isVUcJa+ffbyaTJD4FtfItk2xzrZIoWpM8RHqLS7V7HF2ihkDxBYmSilSMvI4XhrRtkLpf04/4wsOs9PotXgmpchIVtNpuIZchTn2Xu2N+Pfqakc3Tud9vtc/CW54Wko07P3vyDbfonvZA6WdhwyZnROUyRyGRQpWgwBVGVEzM6IgJRfWI+xdTrWE8/kgJQYk7pPgKDc25SSSG6TjGCaOgc5oXzxYaGVIPVcbjK0+HxLmWuOt4kKNjPiNn+RBLZLUCopiGDWseNq4hl9FKkaL6uxKAl3gmhTeNVUTCJqi83HZjb1ciW2bct9FoHpIcp0Joqc66wo8Eg0DCuXsSJzgd1RPlTXassuRTpTaWq73YwPr9orvLoeEhh9tHxcIqPjoelrwi+8+if89lQzD5amS4+7nLkqheKW20FZ2i1VVn0WQgCHS/gRSErcw0+2r4m2hD3gXmRLyn1ReH7aQfLdVRrLdCOKi6jCzROhPDT7m4VTPXcHE1Xw8+Gw80e8QeN8oKTNxSla+9Lt93suhRPa+r22BhKUttEYHKINUx1ug6hqptCMi1TSzStqpCcyt8gr6psM16z82VbGvfvNGkldys88inymZkuVUrUbdkaDPjsqwzYN4oTzuvsor65h7UT5s6qWOqvUwWLqiuqd8b7TfxlITTQk3JKBDNtoDImTHpuQ96ttLvx2phQjJlYNEs0N8H5WU2Wm/QwW/b5DbfUo1VxK4D3pGmY1VyJNRjY3vPYm9pibA/tmpeBJBfc2pWuAvFrPRcK8Nah8iUAUUfhEg1MqXRBxacS0wblfT3BNkl++Eov1wrPZ74t+m/ShcqpWt7JxbjW+PVehXetfI/Ox9QNKi4hrG0tuGOAvSsf7LHC1XnNIK/q56LjFF1bbCLqZkzdKI7YHN35+PTlSemyy2BL0jKfU1fKeiqDx5d7zP2EYm2OLtOVPN/cuoyN2GD5dEBXFAkOGkoNtEiTwd12y7oZ3HV7xs2AJg9UTnoF7WuRTzHXlf5YxEojO9kwxVwf8ULEYm64crHQbLfPvTA6LX3vfp+Yz0m4dHxOVco922143QdyTbdKSiPc+pIYH2LVSSH+iutOpODhQdVeBxu2Jf9JGAH9s54J9Cr9izEscN0b/wSCheK/8onJlpwJhGNCjzUlFuFM3GJaDT0CRpjAY6UdegHOcCG9Dgqe4JMIMJ7HPbEjqDb+uNalIXUcLXD904Q8kL1AbtDQerr71P/6WZucU1/7y/urvaGy6ut9TxLKfo/F/2wGL9tuX8/O2sgmrC3RxnCJKiUfIo/r4Q7g4Ecv+adJ00GSBQJU1pQZZHVq0ZhQM11HO574aIc5F8QMWxaFNu7PLRsag4pX7aNtGnUZ2NNFswke//tfvz2hVM3hcoWpsBmk3HHA2yTjah46pa1SuPLLNlJQc11atGBRzo6sXqJBMVfVIMito2o/JYDtMR2HVMyF4xJWYSJIh1ktRQqFTsFhkikt9VzQSM1nEGIMB4UrkLhESbbyszQfm6ZCCrf2QnjpdM59K5DovJCCqwQDG/31DM5L6e9jqf/gMCulJN6nwnmcOVcqREEpElTWx/TahwqeZAjH8XBH56vVKub+dazNfFDttYPX45dnby7PjmjPps1GrR3I81KdlNTh1L5JASzY63h4/Cx+Gn9PewttXc5VF8/WWPes4nHfATpp9P9z4f/BuXAVTvwwoJBcKCKLZ+ddlVY/sOXTKjUKP/dpYhqLGCVXFrHRzkR41JvJ+gR7HbFMW0cy7+6m3OI7IzcbehxGTD7tCutrvv1TpS4dH7+t7voEPj+K3XvPBaXAZtrrUxUbsZB6HwrjwKz1AIb+TPfbYNkzXD2AoTu4/Tbn/1Fz1oOK3ZoN//57fdvh6yFaVrPgB0L+Q8avB+DXU+IW/jX9MD6h/z5Pv/evqr1w6gJXrbtoapi9wPVgWnz131gPwLoVUjfXzSjPazMsOfFhvrO5nfJuun3Tq7Mrttn8B+zljsE=
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Authorisation Endpoint</h1>

<MethodEndpoint method={"get"} path={"/v3/service/extension/oidc/{organisationId}/{sandboxOrgId}/auth"}></MethodEndpoint>



OpenID Connect authorisation endpoint that initiates the authentication flow. Returns an HTML page where individuals can authenticate using their EUDI Wallet through QR code or deep link verification. After the individual presents the credentials, the page redirects the browser to `redirect_uri` with `code` and `state`. When the individual does not answer within 15 minutes, the page redirects with `error=interaction_required`. The endpoint accepts GET and POST.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"scope","required":true,"description":"The scope of the access request","schema":{"type":"string","enum":["openid"],"default":"openid"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"response_type","required":true,"description":"The type of response desired","schema":{"type":"string","enum":["code"],"default":"code"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"client_id","required":true,"description":"The ID of the client","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"redirect_uri","required":true,"description":"The URI to which the response will be sent. It must match one of the redirect URIs of the client exactly.","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"state","required":true,"description":"An opaque value used to maintain state between the request and the callback","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"nonce","required":false,"description":"A string value used to associate a client session with an ID token, and to mitigate replay attacks","schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Returns a web page. The page shows the QR code and the link that opens the EUDI Wallet. When `client_id` is unknown, or when `redirect_uri` does not match a redirect URI of the client, the page shows the error and no redirect takes place.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>X-Frame-Options</strong><span style={{"opacity":"0.6"}}> any</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Blocks page from being rendered in HTML frame, iframe, embed, or object elements, regardless of the site attempting to do so.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"text/html"} value={"text/html"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"302"} value={"302"}><div>

The request is refused, or the verification cannot start. The provider redirects the browser to `redirect_uri` with the query parameters `error`, `error_description` and `state`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Location</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The redirect URI with the error parameters.

</div></div></li></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with an empty body when the request holds `response_mode`. The answer has `errorCode` and `errorDescription` when the organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Authorisation Endpoint
Source: https://docs.igrant.io/docs/extensions-api/get-oidc-auth

---
id: get-oidc-auth
title: "Authorisation Endpoint"
description: "OpenID Connect authorisation endpoint that initiates the authentication flow. Returns an HTML page where individuals can authenticate using their EUDI Wallet through QR code or deep link verification. After the individual presents the credentials, the page redirects the browser to `redirect_uri` with `code` and `state`. When the individual does not answer within 15 minutes, the page redirects with `error=interaction_required`. The endpoint accepts GET and POST."
sidebar_label: "Authorisation Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztWdtyG7kR/ZUuVHnLrhqRXNn7wlpvIktah4nX0lpyOSmXSgQHTQ5MDDAGMKQYFd/yJftp+ZJUA3PjRfRlnX1I5cnizKBx0H36NLp9zwS61MrCS6PZkF0UqEdncGq0xtQDL31mrHScXgNqURipPfiMe5Baesk9OvAZhi9Re5nGT6fKLHvwBn1ptQOu4S/Xv7yCgs8QlhlaBKmFXEhRcuUg5bq7HqF0Us/IrLRw/vZsBO+4Ukj7WlPOMvj1DaRGIBgLArEAJfUcFmjltNq/BydTjzYga3eCwqJD7SPi1KKgHblySXgQ0FkU0mJafTOxZunIjoFx/ea2tHIMS+kzGBOKMXAtYOw89zjuwbsM9fa+wqADbTxw7ZZow2Kp4fsfIJe69LgfQNwCrTX2udQeLU/pbLcWP5bSohj34DrDNio8TbHwDl6eXwdIlxdX1z2WsIJbnqNH69jw/f1WwMnC6AzMNCAwdsZ1FW6WMElfFNxnLGGa58iGrPvFSLCE1WjY0NsSE+bSDHPOhvfMrwpa4byVesbW6+Q+GvxYol21Fl1qCtxjaBdn+LKGSqd1DmgVOs8e3jhhqMucDd8zU6CWgt2Q7SkvlafzxGcPorPoCqMd3gajn4OSPiSQ9UoQ6MKKz4FIhNoEGJ48CC9VErW/lfsicSjQcd0BSAcc0qbBZ2369s2I8meZyTQLezeOWUqlYIJAOdmDkYe8dB5y7tMMjG4iXe9IltzmAQDveOrVqvc1JwkZ+8kjnGgwBf9YIiy4KkmbUNB5ci6151JDMAMT9EusMr/iZEjCgJUrNeHp/GtAaqPTTZBTrtwuSoiGtkBy50xKIg289phD50ihg7pwTZzwZo46iXAN5NLLGS2xWCi+Au49T+fuIPibpEkUR++PBwP6ZxNjUw1giZMgdlHAguy5zCyj5tbiXnsviHuoOJSr8ZtOUagUd9xkwhikg1LPtVnqhErEMrzflO9GkSPb+AbJNjnW0eYWZFDlAFGbdq3nc3RQKJ4iMTI12lOWkcPwzvcznyv68bAM7GZPqJuVoRoXYWHr9TphGXIRdP2e/f3oZ5L5o4uw2m3ug3c8LxRtdXb++h9svb3TC2XSuYuHnFqTwwSJTBa1QIsCZFXAp7RFArL6F/MJiuBjM/lADkCFORXYBCzOuBWKJLpC7STR0HvMCx/KuwFhwJlePMrTwfEuZa472SRJ7KfE7LAjmeyWfLpFUECd59ZXxLJmIQXaLyvq9ElIQmgLZ1WGx0n1x20H5mb93wj7ZoRemYj0MAXaUGXeF27Y70ca9qoXvdTk/VpR/lTfDhZcSXFbueq7HYzPL5ujPDoekMw+Oh5M8NHxoNTyY4nfBfTP+XQgpx+cEvMPuxy53pLi1lsxGVpvVRF9FkWgkwW8KFQVrv4Ht+2JVuLes2DylEpfEv8+62C5SWqvRdrRHceaAq2XUX7a1a2D6QY1Q9v18LPBYL3H/MGgvOCUDUXp2/PSade7KcVFTd0tNsZLoGsUmBJiBRMjVlGquiUkM0o4oml1C8npwhntVXfJjNfsPG0vo9tnGreWuxc4yinKmakptSDqtmyNAXz2RQHcDoqXPvjssj55gLUjc+eVlobjVGJR9SH1yt7+EH+ehEZ6Uk1JYGosVMGE8VbaUHZr42+DN8akMWOHdoH2NiY/q8lyKw6zZV/ecEddUaVbEXwgTcOs5kiswcD27sde1xFje2jXvIwkueTOLU0lxK/MTGrAO486XAGIOhoXaGFCVxfUfKJQNCi7TNklxw9fmN1G48U0NCD/TZrQNaq2d3I5qj19s9fR3eg+4OsR9V2aK4jftpHbcfzeL786U6Wv65lFXt2bi04ydGOxTqiLsXVLNmQz9Bejs9OTMjRuns+o8WNbvoLHv9Dt1aPm2j8hTc3RZ6ZaH9pGn7Eh6y+e9ulIMsV+Q52+kSLt3282g+s+jztGD+zrNs8wN5WDWMJKqzplTmBujnghe3JmufY9aUI0Nw1cWiPK0AY/ZOZTFq48n9H144HlLr7eBnJDp0pLK/3qiigdReikkH/DVUcCeHxQdc4xSO1d/iROU/5Zt9dbV/jLEcxxtTVJiQyKt/qK9OMNO2OI28TmaUI0wam8Q1HNDyJGGMNjbTwGA95yqYIPCp7ikwSwN+ttmR1CtfDHlSktueNojqufxpRi7AVyizbwa3jPJuHXz8bmnBrWv7673quBVcMemo14nw9Yws9mhrGZ1/UYqpUs6VyJrgdXqAUlCaXUFu4IDn4Mln8aN60hRSBCZc39gaJOvReTempqOeNpkDPMuSRmuLIojPV/btnQBFS+bB9t0qjLwC1fNIvg8b//9dsTqsEcrpYopMtAcM8B79KM61lsgTbuuFUitlJAXXPp0IFDNT1yZoEW5UyDDKMtv0qq9aTsmxMvDkLOpOcKlnG4Rps5o6SAwgjwmGbaKDOTNJ0KpYEYw0HjEhQuUFGswlgqiM9EKulXwQgvvcl5uOOnJi+U5DrFyMZwPIuzUoXzOGosOExLpYj3QvqAM+daR5lTMkXtgmjXOVTwNEM47g12fL5cLns8vO4ZO+tXa13/1ej0/PXV+RGtWbflpo0DZZ4waUmtS52bJGAxXseD42e9p73vaW1hnM+57uLZmJCeVzzeToBOnfz/iPV/cMRayUno8gvFpSayBHbeV3X0PVs8rUqjDAOdRtNYwqiasoQNd4aroaDeJCwzzpON+/sJd/jWqvWaHsdZUSiz0oXL2/7xUJd+j99UZ3sCn56p7j3XnEpeM7YNpYkNWSy1XwvjwND0AIbt4ey3wbJnSnoAQ3cC+232/6MGpgcduzHk/f3n+rZT1EO0rIa6Xwn5D5mjHoBfj3tb+Df0w4YC/vsy/cH/5dkLp77Q6lUXTQ1zS6jWN82kK2CMH50Esewsb4eg62678fL8mq3X/wGXnA0u
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Authorisation Endpoint</h1>

<MethodEndpoint method={"get"} path={"/v3/service/extension/oidc/{organisationId}/auth"}></MethodEndpoint>



OpenID Connect authorisation endpoint that initiates the authentication flow. Returns an HTML page where individuals can authenticate using their EUDI Wallet through QR code or deep link verification. After the individual presents the credentials, the page redirects the browser to `redirect_uri` with `code` and `state`. When the individual does not answer within 15 minutes, the page redirects with `error=interaction_required`. The endpoint accepts GET and POST.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"scope","required":true,"description":"The scope of the access request","schema":{"type":"string","enum":["openid"],"default":"openid"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"response_type","required":true,"description":"The type of response desired","schema":{"type":"string","enum":["code"],"default":"code"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"client_id","required":true,"description":"The ID of the client","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"redirect_uri","required":true,"description":"The URI to which the response will be sent. It must match one of the redirect URIs of the client exactly.","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"state","required":true,"description":"An opaque value used to maintain state between the request and the callback","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"nonce","required":false,"description":"A string value used to associate a client session with an ID token, and to mitigate replay attacks","schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Returns a web page. The page shows the QR code and the link that opens the EUDI Wallet. When `client_id` is unknown, or when `redirect_uri` does not match a redirect URI of the client, the page shows the error and no redirect takes place.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>X-Frame-Options</strong><span style={{"opacity":"0.6"}}> any</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Blocks page from being rendered in HTML frame, iframe, embed, or object elements, regardless of the site attempting to do so.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"text/html"} value={"text/html"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"302"} value={"302"}><div>

The request is refused, or the verification cannot start. The provider redirects the browser to `redirect_uri` with the query parameters `error`, `error_description` and `state`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Location</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The redirect URI with the error parameters.

</div></div></li></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with an empty body when the request holds `response_mode`. The answer has `errorCode` and `errorDescription` when the organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Discovery Endpoint
Source: https://docs.igrant.io/docs/extensions-api/get-oidc-configuration-sandbox

---
id: get-oidc-configuration-sandbox
title: "Discovery Endpoint"
description: "OpenID Provider configuration endpoint that returns the OpenID Provider metadata as a JSON document"
sidebar_label: "Discovery Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJy9WN1u2zYUfpUDXrWAYmdtdyMUw9IkK9wVTVG36EUR2MfSscRGIlWSsuMZvtuT7NH2JMOhfizLStt02XqTWuL5+PH8ftRWxGQjIwsntRKhuCpITS7grdErGZOBSKulTEqD/B5IxYWWyoFL0YEhVxplwaUEfbucHMboENACwqvp1RuIdVTmpJwIRIEGc3JkrAg/bXsU3qcEkwvQSw+sTYJKWr+/CITkFQW6VARCYU4iFN0Vk1gEwtCXUhqKRehMSYGwUUo5inAr3KZgC+uMVInY7YL+3h+U/FISyJiUk0tJpqFhUcULfXtAZzTMp156ZZJ7srnmxbbQypLl909OT/nPYIDOtVIUucP4iEBEWjn2cbgVWBSZjPyL8WfLxtvjzfXiM0U+JEYXZJystpbWlmSOSQYDsfrw7nXjpV4WiF0gsHSpNvIPz2PWJNC9kQ9g2jzkDZy+oX8B7M0PAEtLRqql/nHMBuEA9vP6xs5KI++N5ovnIy3gd9rAlDyYjXRBdmbLotDGcXK1oGgMbjgzHeV2IM2GdqvgoIWDxeaueDYZOmPYh2PQwIKH/S4miUHlHpiGx7wHB1v6+nlgFjXqPXjIeFbVgZWJkiqZYZbMVpiVD8mqggbMEm2kS/MutaU2ntvkoqooseN/gUgJY9/mt/zrWdXRvrtJ7XvnJ0HGaHOuYxJB9f+LDsPr4BsNbW+9P6xUjhIyjHeLeZGRCJ+dnu4G4AdKtjURLzAGqYrSQTvWmtMfOpEX8onIuhG87802kBaUdrDUpYp5svQ99+xenut7w0nnybYD2p/xqPVc8lNAZdf70ddLt9Gwb7+vrfmlEOmYAp8ytRdhLtUKMxnPav/MA5gr7WbeG3PQBuaWzIrMzCPMRROlWfz1MA11GrRatQlbkffRakPaHkm0HMTgfuJNEzExEO/2ZRXtt2jtWps4I2vhtU6kArp1pCxHP0ULilZkYEF+HuEi65TVXfLjMEl+vmd5aUVXS6/A/st0YZXV4J29nTQevx50eDfKd/h8ohwZhRlUa/cRPArA4MoqGDVndvu87Q1zQBXXvzvlP4d1SgqkgwgV16ghjFJ/2KJTFN1Y7ALBFdJo0lAk5K4mF+fnXbk2rYLK7saElfCR+n40HYj7Y+52OblU18BeULtUhGK8ejrms8qIxm1ujbWMo/H2UCbvxtuuTt2NR2vKspMbpddqrAtSMj7pa8vKi0OS/YJyXTtZBKI0mQhF6lxhw/E4plyfYCFH0g/XkdTiWHe/NTouI98H74D5FsLUYcLT6Q5zW73uE7nmU0WlkW4z5bKoGtpZIX+nTXdcVg9quV8Fei/4z7ra9KhGOOVvaOMVLN8qqmqsstBP6KZw5gc4c6i2gby0DhacarSUtxTDWroU5hVHmMMjpR1VUtagzLwPCozocQA0SkY92BBqw+cbXRp2x8kNbX6Zc5mKF4SGDK/nsy/8r9+0ydGJULz6+H6wn2IUcUOrdLS/Fx7L6l5vaC4v+/bn7xt2BFNSMRcal2WPd0UOnntkJlxfpTgCFVXRigCOOl/vBKvwpiVi5Fsi5Sg5M2rt8us+G9qAypf7R4dp1M3Ani9aI3j0959/PeZ5jjBdUyxtCv4qTLdRiioh32VWZOSyTgaoa3bfTmDi+BZhwVK2PLF6RYZkouqLqdsEtT1PCYgM+ceY2QAQYplIhxmsMcvI+c2szmQMhY7BUZQqnelEkg2qMeM1HShaQ0YryjhWrIz8iMeFzKTbeBAsnc7R8fJI50UmUUVUZaM/nqGkzPx5LEgFCMsyyzjvY+k8zxyVqlplJiNS1jf+poYKjFKCJ6PTI5+v1+sR+tcjbZJxbWvHryfnl2+mlydss9uPrH0cuPKajw5NbXIDq+L15PTJs9HT0U9sW2jrclQdPhfSRuz1DVw2d7hewDtz9n/6alInt6NbNy4ylMrfVtlX23oAfBKrp3WjlpEXyk2FiUDwGBCBCI++l4S9LxadUSD8HDseBteBSLV1vON2u0BLH0y22/HjLyWZjQg/XQdihcYnaDUwpPWSRoRLzCx9xZmP3tWq/zF89VPQoDuahq24W/v2KkIhAnHD/bz/qchPkR/hde/PRD/A9SAou+v2LuW9WS05iyIqXMf4SO7tulLh5eV7sdv9A9uiCrA=
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Discovery Endpoint</h1>

<MethodEndpoint method={"get"} path={"/v3/service/extension/oidc/{organisationId}/{sandboxOrgId}/.well-known/openid-configuration"}></MethodEndpoint>



OpenID Provider configuration endpoint that returns the OpenID Provider metadata as a JSON document

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OpenID Connect configuration

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"issuer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"authorization_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the authorization endpoint"}}></SchemaItem><SchemaItem collapsible={false} name={"token_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the token endpoint"}}></SchemaItem><SchemaItem collapsible={false} name={"userinfo_endpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the userinfo endpoint"}}></SchemaItem><SchemaItem collapsible={false} name={"jwks_uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the JSON Web Key Set"}}></SchemaItem><SchemaItem collapsible={false} name={"scopes_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The scopes supported by the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"response_types_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The response types supported by the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"grant_types_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The grant types supported by the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"subject_types_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The subject types supported by the OpenID Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"id_token_signing_alg_values_supported"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The signing algorithms supported for the ID token"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"issuer\": \"string\",\n  \"authorization_endpoint\": \"string\",\n  \"token_endpoint\": \"string\",\n  \"userinfo_endpoint\": \"string\",\n  \"jwks_uri\": \"string\",\n  \"scopes_supported\": [\n    \"string\"\n  ],\n  \"response_types_supported\": [\n    \"string\"\n  ],\n  \"grant_types_supported\": [\n    \"string\"\n  ],\n  \"subject_types_supported\": [\n    \"string\"\n  ],\n  \"id_token_signing_alg_values_supported\": [\n    \"string\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# JWKS Endpoint
Source: https://docs.igrant.io/docs/extensions-api/get-oidcjwks-sandbox

---
id: get-oidcjwks-sandbox
title: "JWKS Endpoint"
description: "JSON Web Key Set (JWKS) endpoint that provides the public keys used to verify the signatures of JWT tokens issued by this OpenID Provider. These keys are used by relying parties to validate ID tokens and other signed responses."
sidebar_label: "JWKS Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJzlWN1u2zgWfpUDXiWAYmfbzo0xWGwmyRRuB00wzqC7KIL6mDqW2FCkSlJ2tIbv5knm0eZJBoeSbPmnTVpgriY3jkTy4+H3nT9qJVLy0qkyKGvESLyZ3LyD9zSDt1TDhAKcvHn/dnIKZNLSKhMg5BigdHahUvIQcoKymmkl4YFqD5WnFIKFBTk1r+OwV5nBUDnyYOfw5v0dBPtAxoPyvqIUZjxNebgpyYyv4LaBdgO4y8lTA4uOGuhZDY50rUwGJbqg2AQLC9QqxUAwvurA0aRgQ04u7k8pOPKlNZ78QCSiRIcFBXJejD6s9ii4yyOQnUfzrcvQKI9xMBGKZ5QYcpEIgwWJkejPGKciEY4+V8pRKkbBVZQIL3MqUIxWItQlr/DBKZOJ9TrZ3/s3oz5XBColE9RckevM8GjSmX3cMWdw3J526o3LvtGae57cssTjL87P+edZDiISIa0JZAIvwbLUSkYjh588r1sd7mtnn0gGVsPZkqKYPMqC92ahc1jzQQMV/hmrVXp4tGTvDGz6+CqJxFYHjM+tiyMPVIt1Ih5C/TxEntFgSleXwWYOy1xJQJ1Zp0JewBwLpevGk5cq5P1tpFs8vc1l5RaU9ABIax6UIHkkBguDoc6eBrvo7GqM3pqpWMeU0shE5enA1srT0/C3m7TAGM0eG2RGbT17mz4Y+vFp4P+CtNalynDEd2LtERFzFeM9Q7v/PR+v/UtETpjG7LHip1dNoDw7ALYh+UGQc9Zd2pRE0vx/1TPuPnnC3bert8dkkjNyjPeIRalJjF6dn6+PwB+hZrNE/IQpKFNWATbZUrSn3+WPJ/KJyIeYtHdyFCgPxgaY28qknLD2mXv1TcztsxFUiMZ2VQPiGQ8kvua3gMYvtxl1v94c5/Zp9+ETx6kgbUpJ9KCWRZgqE2vTx5afaQJTY8PHyMYUrIOpJ7cg9zEiTEWn0sf06zIdmuAIvTVb/43GR7U2km6OJDY2iKP7iXedYuKI3pvBRu1b9H5pXarJe/jFZsoAPQYyntXP0YOhBTmYERkggzPdJpavVbVdJ/nhG8PLGrqZx8L+d7oLF+8O7+J23DF+f5Twvspf4HxsAjmDGpq5WwUPBDg6sxGjtZlpn25ywzR2Q9P98J/CMicDKoBEwzHqCGWT58teUPS1WCeCI6RrdUYio3AzvrrkFmDSaMksY8Z9ldijDE4mR+Q+5SRXUMhtixfbs5CLkRguXg75iErScONSQ6tSOVztNl3r4arf9ayHgyVpffZg7NIMPy0f/CB6SdLqcKzru6LCtoSKRFROi5HIQyj9aDhMqbBnWKqByhyaMFBWHLZut86mlYw57wswTyFMAmbc2X5huW+G9w2551PJyqlQTzgEmuR1Uaq31C9+2LxoO8ZG1G3PeFGF3Dr1/67N3esUbsexjmMVcm6TmshrPG6ButrU8ukOzhSabaCofIAZuxXN1WPXu0wbG2EKJ8YGigDBodKRgxIlnSZAg2ywBzuCduGPta0c03H2QPW/pxyS4idCR47n89ln8eln6woM3Lu+vzuaO1FKTl7x6tBccKIt8XFz8dnNA5fWGJKhl+ridcYPYEIm5aDiENyzuzEOfozIbHDbjbMCjaliU/BZdb4hCGXmtkt/KGP6owIVe4avytK68J+tN2wEVa+3r3bdqO+Be1xsFsHJn7//ccq1G2GypFT5HFIMCPQoczQZxYwSL3mtM0AbqNvUAePAbZ4HT3p+5u2CHKnMtJ12qJN2PVcEkI7ia9Q+AYRUZSqghiVqTSFu5q1WKZQ2hUAyN1bbTJFPmpLCHoNgaAmaFqRZK+6CYjnHmdIq1BEEq2ALDDxd2qLUCo1s29t4PEdZpeN5PCgDCPNKa/b7VIVoZ4HGNGlRK0mm6YO7GCpR5gQvBucHnC+XywHG4YF12bBd64e/jC+v302uz3jNeluetjpw5KVWVgWZ0MUmJ7BGrxfnL14NXg7+xWtL60OBpmcPJ2W4bt133+975fQfcudv4yrQYxiWGpWJNxmWadUWnA9i8bKtEUrGfrwLbpEILjsiEaOD2/5o777dKz0iEdvic5+I3PrA26xWM/T0m9PrNb/+XJGrxejDfSIW6GJANAVK+dguidEctaevKHjya3ujOIWvfr04ykFXIAxXh5jOxUiIhC/ih183YtX6Hru++cvGd9i6o8T6fnNPi2w2Uy6kpDL0Fh+0kut+P/L6+k6s138Btsm3Wg==
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>JWKS Endpoint</h1>

<MethodEndpoint method={"get"} path={"/v3/service/extension/oidc/{organisationId}/{sandboxOrgId}/.well-known/jwks.json"}></MethodEndpoint>



JSON Web Key Set (JWKS) endpoint that provides the public keys used to verify the signatures of JWT tokens issued by this OpenID Provider. These keys are used by relying parties to validate ID tokens and other signed responses.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

JSON Web Key Set (JWKS)

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keys</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID, the unique identifier for the key"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type, the cryptographic algorithm family used with the key"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Curve, used with elliptic curve keys"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm, the algorithm intended for use with the key"}}></SchemaItem><SchemaItem collapsible={false} name={"use"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public key use, the intended use of the public key"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the elliptic curve point"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the elliptic curve point"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keys\": [\n    {\n      \"kid\": \"string\",\n      \"kty\": \"string\",\n      \"crv\": \"string\",\n      \"alg\": \"string\",\n      \"use\": \"string\",\n      \"x\": \"string\",\n      \"y\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# JWKS Endpoint
Source: https://docs.igrant.io/docs/extensions-api/get-oidcjwks

---
id: get-oidcjwks
title: "JWKS Endpoint"
description: "JSON Web Key Set (JWKS) endpoint that provides the public keys used to verify the signatures of JWT tokens issued by this OpenID Provider. These keys are used by relying parties to validate ID tokens and other signed responses."
sidebar_label: "JWKS Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJzlWM1uGzkSfpUCTzbQlrxJ9iIMFuOxPQMls4kx9iK7CIyoxC51M2aTHbJaslbQbZ9kH22fZFDsVkuWlNhz2NPkkqhZ9bHqq19mpXKKOpiajXdqpN7efngPH2kK72gJt8Rw8vbju9tTIJfX3jgGLpGhDn5ucorAJUHdTK3R8EDLCE2kHNjDnIKZLdNxNIVDbgJF8DN4+/EO2D+Qi2BibCiHqYiZCB9qcuMruGmhwwDuSorUwmKgFnq6hEB2aVwBNQY2YoKHOVqTIxOMrzbg6HLwXFJI91MOgWLtXaQ4UJmqMWBFTCGq0afVHgV3ZQLys2S+DwU6EzEdZsqIRI1cqkw5rEiN1K7EOFeZCvS1MYFyNeLQUKaiLqlCNVopXtaiETkYV6j1+l6EO7vk/NX5ufz1opCoTGnvmByLCta1NTrZMPwSRW91eK+ffiHN4n/wNSX65FQo3pHCEHAprjJV8QXaJj90LdvzQUwfX2WJ0caZrw2BycmxmRkKMPMhnTzQUq0z9cDLlyGKRIupw7JmXwSsS6MBbeGD4bKCGVbGLtvcWRgud6/RYf78NZdNmFO2A0DWyqEGLScpPQUMbfE82MXGrtborZlG4phTnphoIh3Y2kR6Hv6mL0TBaO/okQW1S+ltwQr04/PA/wTtfciNkxrbBGuPiNQdBO8FsfvXy/G6P5kqCfNUryv59aYtlBcXwLYkPykKwYdLn5PK2n9f7Rh3nz2T7lvtrZtCckFB8B6xqi2p0Zvz8/UR+CPU9CrqJ8zBuLph6PuT6rx/yp8IikcUObXJJ00KTATnGWa+cbk0u33m3vwh5vbZYMPJ2E2fhuTjQYiv5SugiwsKm7zb7/DHuX0+fcTjJAra55SlDOpYhIlxaRp87viZZDBxnj8nNibgA0wihTmFzwlhojZR+px/P0yHJgTC6N02f5PxKVp9SHuXVG+DOnqfer+JmDoS7/6wjfYNxrjwIbcUI/zqC+OAHplclOiXGMHRnAJMiRyQw6ntGsv+ODtMjr/+wbLyjj7M0gj9f6bJOlv1eBc34w3T90eJ3o3uN7geO6bg0EIru43cAfFHJdsgdDYL3ZO+J0zS3jHZL/sJLEpyYBg0OqnNQKjb/l7vFMNuLNaZksrYLBUjVRB/GF9dyugXerGQ1UXtcQUnf0fjgMmh41NpZhVx6Tv9tPhwqUZqOH89FJeMpmGfOkNvcj1cPV1n1sPBgqw9e3B+4YZfFg9xkNIg64g+tkBdUeU7xlSmmmDVSJXMdRwNhzlV/gxrMzBFQMcD41N49wZZ8HmjUzP7BsxzCLeMhSyJ31CP7fG+IffilW6C4eWt5HjblS5q8452pxq2H7plsI3adh28aLj0wfx7szHurQA34zSgseFS9p+2tNqUmqNt+iE9eYIzgfYaqJrIMJW8oZl53Cwlk9ZGmMCJ80wJgAMamzioUdNpBjQoBnuwI+gUf1j6JggdZw+0/NtEak79RBgoiLz4Pk2/fvahQpal9OPd0aaIWktXSlt4+1ZItqSf/RviaaFfeudI804PSy+DOIBbcrlUjdTYnt2tcfBDQhaDuzVbItCaqvpJLlFXUlHGzfymv6FO/Y0qNJIZsalrH/jHbTb0ATW/bD89TaPdDNzjoleCk//957+nMpQRbheUm1hCjoxAj7pEV1BqGem91CUDdJW57Q0wZtnfIkSys7Po5xTIFK5boXmZdfrS6kEHSp/RxgwQclMYRgsLtJY4XRa9NTnUPgcmXTpvfWEoZu2skIxBcLQAS3OyEitZb9KcxqmxhpcJBBv2FbKIa1/V1qDT3d6a3AtUNDb5E8E4QJg11kre54aTnRU61/Y9azS5dsHd1FCNuiR4NTg/4HyxWAwwHQ98KIadbhz+Or68fn97fSY66+382cZBKi/3uqnI8aY2pYG18Xp1/urN4PXgL6Jb+8gVuh17pOvCdZe++3m/My//JM/nrq6YHnlYWzQuPVEkTKtuwnxS89fdjDA6Ldqb4laZkjmjMjU6eDjvjBqVqe2wuc9U6SML7Go1xUj/CHa9ls9fGwpLNfp0n6k5hlQA7UAyMe09ajRDG+k7ETv5rXsanMJ3H/5Hfd4MBCfTILVvNVIqkxf14X8MrO/7Z0yysRW60Jpq3lE/2LjWu2P8l+s7tV7/DqeLNcc=
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>JWKS Endpoint</h1>

<MethodEndpoint method={"get"} path={"/v3/service/extension/oidc/{organisationId}/.well-known/jwks.json"}></MethodEndpoint>



JSON Web Key Set (JWKS) endpoint that provides the public keys used to verify the signatures of JWT tokens issued by this OpenID Provider. These keys are used by relying parties to validate ID tokens and other signed responses.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

JSON Web Key Set (JWKS)

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keys</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID, the unique identifier for the key"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type, the cryptographic algorithm family used with the key"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Curve, used with elliptic curve keys"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm, the algorithm intended for use with the key"}}></SchemaItem><SchemaItem collapsible={false} name={"use"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public key use, the intended use of the public key"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the elliptic curve point"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the elliptic curve point"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keys\": [\n    {\n      \"kid\": \"string\",\n      \"kty\": \"string\",\n      \"crv\": \"string\",\n      \"alg\": \"string\",\n      \"use\": \"string\",\n      \"x\": \"string\",\n      \"y\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# UserInfo Endpoint
Source: https://docs.igrant.io/docs/extensions-api/get-post-oidc-user-info-sandbox

---
id: get-post-oidc-user-info-sandbox
title: "UserInfo Endpoint"
description: "OpenID Connect UserInfo endpoint that returns claims about the authenticated end-user. Requires a valid access token obtained from the token endpoint to be provided in the `Authorization` header. The endpoint accepts GET and POST. Error answers of the provider have an empty body, and the `WWW-Authenticate` header holds the reason."
sidebar_label: "UserInfo Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztWM1u48gRfpVCX3YGoCnPTy7ETLDO2LtwslgbsQdzsA2rxS6RPSa7Od1NyVpBtzxJHi1PElR3k6Ikev6QYHKILxbJ/qmqr6q+qlozgTY3snFSK5axiwbV+Sm800ph7uC9RXOu5hpQiUZL5cCV3IFB1xplIa+4rC3wmW7pCwJvXYnKyZw7FLTpqLVoUvg7fmqlQQscFrySAnieo7Xg9AMq0DPHpUIBc6Nrf054v71UwwyhMXohBQqQyi+anrSu1Eb+wUn4KZTIBV12XeJ2K13UOAu/nl0DVwIuL66uUzgzRhvgyi7RWNBzf14830DJFwhcAdaNW8FMi1Xi9/pLP3z4cHQyULO7F0pdCevXGORWq/RWsYQ13PAaHRrLspv1nrVJ0vPT7n5tCq6k9dqwhEla0XBXsoQpXiPL2HDFuWAJM8GugmXOtJgwm5dYc5atmVs1tMM6I1XBNptk/+73Sn5qEaQgReYSTSeG5UrM9OOOOOm4PHHphSm+UZo7WmwbrSxa+v7y+Jj+7Ulo0YBUc23qzia5Vg6Vo7W8aSoCQGo1+Whpw/rwQj37iLkjGIxu0DgZrrPt7FCq5IsGmmvjLUQ+nYBBq6sFClhKV/r3YalbQc1dXkpVAHfOyFnr0ELcm/OqmvH8obN2XklSKGH4yOumInk+coWp0PhzfJXmumYb0gEtKhdsMaIjF0LSN15d7mj7desIss2+Da59WPhrUUBu0GvIK0tRJi1IS3ESTk5AaUeP3Bi+SuGM5yU84IoWeesogY+kNoehJsApKwQMErCOGxcsB9NbdnzLpvGkBa9aHARZzD3ejNztHBmiVToL0V9AYINKWNAhc2wVgeBdIVZ7CNbMu+MidyxjrVEZtkJmjRTZC1pWc1k9iVP4S1jICgQAPb0ODv7V/rsNpRuGlKzeaYF0N/0+HWB0l3zB17e7t64glcMCzVDl18fHm5HjR6Jk66h/4ZSLm9ZBn+VY1H7XjWghaYTWhfTcp9ouBfsY2km5X5FxlyUq4N3JWyFA53lrLNTaIHmHAq1yDDeHC6HkFqa9aab+sum+9tNww35uJocmV5/rVgnKjFuo2b6so1lpzJTIDRpijqp+e7tPw5fRXLcsAS/k21smlWfS+6h9/+l+YPq3t+yy5x+oW+uIR1uf2G4ZGw33KEle8qpCVWAK5y6GXTDQ0FjDywbW6uEt5MKTfmREtgmx8GIk2Sse2RxFRGpYIkgLtbTW5wiyfagitAF8bChOwhbvN9IGL0p3+GLzg2HyajwF0hVaS45FXhkV+pHwvDqE5xdtZlIIVCPYCI0hIHzd5EuIXDcIU92gkmL6P4yNbedzmRMD33uZnwLoPKAIP/lVPwXy8XVogPXHYfX6m2hlnyqcdN52nXWC8gel0LBc7gqXaN9uZzpOPF8us3y17s/PtcDEF1kRVJjuJblpAlOl3b3PvFMK/6lFs0BzH8zJOgq7F5/nsEMRgln7Ei8I7208qAqiSqyXgY3ex37v2IGNkGH/McTFJbd2qY2oKKB+04VUgI8OVZ8QFC7QwAx9Q8RnFfVJUcqnSvXd2uNP31h7aIUXc9+t/DfdhTqS7ryTy/PO4nejBh+i/ITNz5VDo3gFYe0WwQMARld+d3UgHeRcUfozSHXqMGj3sdgkzGLeGulW3r4hQVCyY9nNHelOAdS1dxkr0F1q6y7OT991nfhVgJzA4AX1lGzPsvDsasQrnlOhWKMrNZ3baOsLRWrmMjZZvJqQKWSOk971JlqKfLLe7Tg3k/Ww5dtMqBOiDo0lEaKxLvcUax1tzRLWGqqdS+cam00mAmt9xBuZysJw5VKp2WGremm0aHNfej1xzJdOuHK8oK7iie02fN4X5G4L1xVFR8hrJ438G64GWYWHF7FDDnhve+SdIcVBqJDnU480GJxQDHtnDB1PjJ/xYUdf0zUG5/Kxa0anQUaYwjOlXeBkZ7isvA0anuPzBDAt0r1jM4gb36x0a8gcRw+4+vOUonXHWdds5p9+8d0Ty9hfP1yPptWdQsE3aiPjnd0U0TH2NgtKa1u0KVyhb+uoY9yXO1LtG38yCRynD4RAEJX1jRKhThMR5j03Zkae+8zY9Xa2bRpt3M9bb+gBlb9uX+260dAD92zRb4Jn//rHP5/7xhmuliikLUFwxwEf85KrAn2yWaCR8+gMEGNzm1WojGgtWrBYzY+sXqBBWah+/pDE/UQWw6Y9AQ5CFtLxCpZUkzh/mdVU2jRagMO8VLrShUSbBLbxvTgoXEKFC6wIK+oePdPzmaxo3EGH8NZpGtOoAnJdN5XkKsfgjV49g0VbeX0s1U0c5m1Vkd8L6bycNVcqZMxK5qisz/9dDDU8LxFepscHNl8ulyn3n1Ntikncaye/nb87+/3q7Ij2bLbMtcWBIk/ovK37kUrCKIEFvF4ev3ydvkpf+LmLtq7maiBPPxY9iy687/sDtv3/SPU/PVKNYezw0U2aiktFIHmvWEdKu2GLV5GSZO7HJl0uYQkjYmMJyw6GqdneOLMnt7uElcSY2Q1br2fc4ntTbTb0+lOLhqj8LmELbnzABQKU1ldqLJvzyuJnvONZxFE8h89Og0eV7ghIEft4umAZYwl7IH7anxZ7Vvweub55Uvwdsu6YfnPXd4TemmHJiXe7weaDKnYzrHHIK2nYGfkqXt9zQfwxqHJ3JXsTGeXaE0ovp48iEnCz+Tcqu+uG
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>UserInfo Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/service/extension/oidc/{organisationId}/{sandboxOrgId}/userinfo"}></MethodEndpoint>



OpenID Connect UserInfo endpoint that returns claims about the authenticated end-user. Requires a valid access token obtained from the token endpoint to be provided in the `Authorization` header. The endpoint accepts GET and POST. Error answers of the provider have an empty body, and the `WWW-Authenticate` header holds the reason.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

User information

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"sub"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the user, resolved with the identity matching attributes or the callback of the client","example":"jane.doe@example.com"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The presented credentials. This is an object, not an array. Each key is the index of a presentation as a string, starting at `"0"`. Each value holds the claims of that presentation, and its content depends on the credential format.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sub\": \"jane.doe@example.com\",\n  \"presentation\": {\n    \"0\": {\n      \"vct\": \"urn:eudi:pid:1\",\n      \"email\": \"jane.doe@example.com\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with an empty body and the `WWW-Authenticate` header when a request parameter occurs more than once. The answer has `errorCode` and `errorDescription` when the organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>WWW-Authenticate</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Bearer challenge. It holds `error` and `error_description` when the provider gives a reason.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized. The access token is missing, not valid or expired. The body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>WWW-Authenticate</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Bearer challenge. It holds `error` and `error_description` when the provider gives a reason.

</div></div></li></ul></details><div></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden. The access token does not have the scope `openid`. The body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>WWW-Authenticate</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Bearer challenge. It holds `error` and `error_description` when the provider gives a reason.

</div></div></li></ul></details><div></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# UserInfo Endpoint
Source: https://docs.igrant.io/docs/extensions-api/get-post-oidc-user-info

---
id: get-post-oidc-user-info
title: "UserInfo Endpoint"
description: "OpenID Connect UserInfo endpoint that returns claims about the authenticated end-user. Requires a valid access token obtained from the token endpoint to be provided in the `Authorization` header. The endpoint accepts GET and POST. Error answers of the provider have an empty body, and the `WWW-Authenticate` header holds the reason."
sidebar_label: "UserInfo Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztWM1yG7kRfpUuXNauGg3ln1ym7NQqlnaLye5aFWnLB0klgkCTA2sGGAMYUgyLt32SfbQ8SaoBzHD4I9ubSso5RBdxZgD039dfd2PNJDphVeOV0axg7xvU43N4Z7RG4eFXh3asZwZQy8Yo7cGX3INF31rtQFRc1Q741LT0BYG3vkTtleAeJW06aR3aHP6On1pl0QGHBa+UBC4EOgfePKAGM/VcaZQws6YO58T3W6EGpgiNNQslUYLSYdHkrPWlseofnJSfQIlckrDrErdbSVDjHfx4cQ1cS7h8f3Wdw4W1xgLXbonWgZmF89L5Fkq+QOAasG78CqZGrrKwNwj98OHDydnAzE4ulKaSLqyxyJ3R+a1mGWu45TV6tI4VN+s9b5Om4/NOvrFzrpUL1rCMKVrRcF+yjGleIyvYcMVYsozZ6FfJCm9bzJgTJdacFWvmVw3tcN4qPWebzR0tdo3RDh19f3l6Sv929aFwg9IzY+tOC2G0R+1pLW+aikxWRo8+OtqwPhRoph9ReDLcmgatV1Gca6eHWmX74rX61CIoSb6dKbQwMza4hlCUgUVnqgVKWCpfhvdxqV9Bzb0olZ4D996qaevRQdoreFVNuXjo3CwqRQZlDB953VSkz0euMZcGv0+vcmFqtiEb0KH20RdHbORSKvrGq8sda79uHYVss++D6wDEIBYlCIvBQl45wrVyoBwhM56cgTaeHrm1fJXDBRclPOCKFgXvaImPZDaHoSXAKQ9jDDJwnlsfPQeTW3Z6yybppAWvWhzAOmV7cCP3O0fG/FDeQcILSGxQSwcm5urWEIjoitnRh2DNAhwXwrOCtVYX2EpVNEoWL2hZzVX1ZJziX8ZiHlIA6Ol1BPhX43ebSjcMiR7eGYkkm36fD2J0l30B69vdWygo7XGOdmjy69PTzZHjj2TJFqh/4cR+Teuh5xWWrN+FES0ki9D5SIg9uXWkF3Joh+S+guOWJWrg3clbJcAI0VoHtbFI6NBgtMAoOQqEkjuY9K6ZBGGTfesnUcI+GxKgCeoz02qZs2Go2b6uR1npmCuRW7TE1VX99na/8F0md92yDIKSb2+Z0qF23Sfr+0/3A9e/vWWXPeND3TpPlasNxHbL2NF0T5qIklcV6jnmMPYp7aKDhs4aCht4qw/vXC1CmU01iG1iLrw4Qvaap/qJMkVqWJSVg1o5FziCfB/rtrGAjw3lSdwScKNcRFG+Uy823zhMwYyngnSFzhGwCJXJoG8ZnleH4fnB2KmSEvWR2EiDMSFCp0ICnDANwsQ0qJWc/A/HxrWzmRJUge+Dzk8FaByjCN+FVd/F4hM6vxjWbxer13+orOyXCq988F3nnWj8QSs0bFC7xiX5t9uZHy88X26zQn8czhdGYhaarBRUmOyR3CSDiTb+PjDvhNJ/4tAu0N5Hd7KuhN3Lz9ewQxWiW/sWLyoffDzoCpJJrNeBHZXHfumqAztSDPuPMS8uuXNLY2VFCfWTmSsN+OhR94SgcYEWphhGED6taDJJWg6r0m4hIrF/+oM9h9H4fhbmgv8mTDbZuj/v7HLcefruqKOH0X3C12Pt0WpeQVy7jdyB44+u/Le7AuVBcE20Z5H602Gy7sdikzGHorXKr4J/IzEQybHi5o5sp8TpBqmCzdFfGuffj8/fdTMvRYHPaWxjey6FZz9zYiLUXPvn1BDW6EtD5zTGhYaQxraCjRavRmS6EjjqITYySorReneW24xoxFFRbPTWsYHxHGuTnMky1lpqikvvG1eMRhJrc8Iblau55drnyoTI7x5waY1sReipnjjmSydceT6nceGJ7S5+3lfkbhuPK4J/JKyzRv0NVwO64PFFGn5jQLfj7868f5ALBG0afgZ3EJSkAW1xlEkJcvzeoG/WGosz9dhNmZOoI0zgmTY+FltvuaqCDxou8HkGmM/zvWMLSBvfrExryR0nD7j684TScQeNazYNTz+EsYgV7K8fro/y5U4HECawIzcluxzQleItvSnnWnQ5XGGY12gU3Nc71dA34WRSOF0rUASiqqyfgCjqjJItIDdRHxeB+rqhzbVNY6z/fouGPqDqx+2rXRgNEbjni34TPPvnb78/DxMxXC1RKleC5J4DPoqS6zkGNlmgVbMEBkjJuKUN6g9ahw4cVrMTZxZoUc11f7GQpf1UBYbTeAYcpJorzytYUrPhgzBnqGdpjASPotSmMnOFLotlJAzZoHEJFS6woljRWBhKOJ+qiu4x6BDeekP3L3oOwtRNpbgWGNEYzLM4b6tgj6OGiMOsrSrCvVQ+6FlzrSMlVkqgdoHguxxquCgRXuanBz5fLpc5D59zY+ejtNeNfhq/u/jl6uKE9my2pWkbB8o8aURb93clGSMCi/F6efrydf4qfxEuVIzzNdcDffobxosE4X3sD8rp/28n/9O3kymNPT76UVNxpSlIARXrVMNu2OJVKklKhPuQjktYxqiSsYwVB/eSfTG7y1hJJbG4Yev1lDv81VabDb3+1KKl2nyXsQW3IcFiwVMutFysmPHK4WfQ8CzFTT6Hz16kHjWyKziaqk0oD6xgLGMPVI/2L1o3d/3AFHSMi85C8AbbD5q9zbA1oNjSXWBi/aRAz6jpx6AZ3NXtTeLl60DLvaYBi6TgZvMvcY5p8w==
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>UserInfo Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/service/extension/oidc/{organisationId}/userinfo"}></MethodEndpoint>



OpenID Connect UserInfo endpoint that returns claims about the authenticated end-user. Requires a valid access token obtained from the token endpoint to be provided in the `Authorization` header. The endpoint accepts GET and POST. Error answers of the provider have an empty body, and the `WWW-Authenticate` header holds the reason.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

User information

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"sub"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the user, resolved with the identity matching attributes or the callback of the client","example":"jane.doe@example.com"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The presented credentials. This is an object, not an array. Each key is the index of a presentation as a string, starting at `"0"`. Each value holds the claims of that presentation, and its content depends on the credential format.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sub\": \"jane.doe@example.com\",\n  \"presentation\": {\n    \"0\": {\n      \"vct\": \"urn:eudi:pid:1\",\n      \"email\": \"jane.doe@example.com\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with an empty body and the `WWW-Authenticate` header when a request parameter occurs more than once. The answer has `errorCode` and `errorDescription` when the organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>WWW-Authenticate</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Bearer challenge. It holds `error` and `error_description` when the provider gives a reason.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized. The access token is missing, not valid or expired. The body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>WWW-Authenticate</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Bearer challenge. It holds `error` and `error_description` when the provider gives a reason.

</div></div></li></ul></details><div></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden. The access token does not have the scope `openid`. The body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>WWW-Authenticate</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Bearer challenge. It holds `error` and `error_description` when the provider gives a reason.

</div></div></li></ul></details><div></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# iGrant.io API documentation
Source: https://docs.igrant.io/docs/extensions-api/igrant-io-api-documentation

---
id: igrant-io-api-documentation
title: "iGrant.io API documentation"
description: "iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 2024.3.1</span>

<h1 className={"openapi__heading"}>iGrant.io API documentation</h1>



iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner.

<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}>

API key authentication. The value of the `Authorization` header must be prefixed with `ApiKey ` (note the trailing space), e.g. `Authorization: ApiKey <your-api-key>`.

<div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>Authorization</td></tr></tbody></table></div></TabItem><TabItem label={"HTTP: Bearer Auth"} value={"BearerAuth"}>

The access token that the token endpoint of the OpenID Connect extension issues. Send it as `Authorization: Bearer <token>`.

<div><table><tbody><tr><th>Security Scheme Type:</th><td>http</td></tr><tr><th>HTTP Authorization Scheme:</th><td>bearer</td></tr><tr><th>Bearer format:</th><td>JWT</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>iGrant.io: <a href={"mailto:support@igrant.io"}>support@igrant.io</a></span><span>URL: <a href={"https://igrant.io"}>https://igrant.io</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3><a href={"https://www.apache.org/licenses/LICENSE-2.0"}>Apache 2.0</a></div>
      

---

# List extension
Source: https://docs.igrant.io/docs/extensions-api/list-extensions

---
id: list-extensions
title: "List extension"
description: "Lists all available extensions in the platform"
sidebar_label: "List extension"
hide_title: true
hide_table_of_contents: true
api: eJzlVs1uGzcQfpUBT4mxlhQnvQhBUCd2AzVpGsAJekgMeLQ72mXMJRlyVrIq7K1P0kfrkxTDXf0rbXOuD/Lukt/8fvyGK1VQzIP2rJ1VY/VWR46AxgDOURucGgJ6YLJROxtBW+CKwBvkmQu1ypTzFFDAk0KNldGRrzfbVaYCRe9spKjGK3UxGsm/fY/b7SBoKiA2eU4xzhpjlipTubNMlgWJ3hudJ3fDL1HgKxXzimqUJ156UmPlpl8o5+T7a6MDFWr8SW1zULeZ8kHCZt2FtbN2wsp+tJdQowc3g7OzDQwmV/HsDBaViwRzNA1JoQoJlGBREVcUPlup2xaiI5CV6hafrcoUFoUWD2je74X2jyl1+BP59Atb/NQ5Q2iPspn0UUbQM+BKgjoRoWozZbGmHYORg7blkb0rmmlLMXFEEFKoTd5pT3sA+R6LOysnDPd/maoICwpSCXl7NnoiXv4zifYqHIILr1xBKuuer3Ziu82OunPQhg16m6W2TCUFsfeAtTekxs9Go/aE+ROV2UDUSyxAW98weAxYE1NQffb75ftoseHKBf07FeqwND90x/F/WpqJZQoWDUQKcwqQ3BzUqM1UpLwJmpdq/GmlLr1+Q/J420qOWEapxS9osSTYCJnkXxNXThSxpJQ+cqXGajh/OsydnelySLsq2YUQk49D/teuj1BlqglGjVXF7ON4OCyodufo9UCXAS0PtFNtdmjgfXBFk6cz8w0z/2bhhrHUtvwWPHbLh4Hcbkt3IwzqGr8u4KaD2H3IlBZXXe3VWm7UZU/exMhjLX4/gXtaglBcVKAj7gA+VL0Mr1Xibs/OHXRuoG4iw5TAB5rpBypgobmCuy5GuINH1jElAxxQm1QDjzk9zoAG5eDA7Bh64POla4KU4/yeli/uBqJ5LwkDBdkvuU/T208u1MhqrH7+7cNRbpIDpjEI7O5Jxi5yF0t6JVt4py2vU/zVk51cwStnLeW8J+OxoTiAG7IFaAaMR3F3wcHzZFkCzrpDnyZHWlObAy1dV3IutJ25tXpgntSDatTCjNh47wL/uGXDpqH69fbTPo12GXhQiw0IHv31x5+PZTIh3Cyo0LGCAhmBHvIKbUmAtoA5BT3ryZBIq3PpsZvrgsIAJgxNpAiRzOw8ujkF0qUFXQiFeJn1+HTzyQOlz2hiBgiFLjWjgQUaQ5ycRWd0Ad4VwJRX1hlXaopZNzqFMQiWFmBoTkZ6JSqXpBCn2mheJiPYsKuRZXvuam802pw6Nqb0ApWNSfmkGxhCuhoBNoXmFGeN1lKQxhmdk41JV9dnyGNeEVwMRkc1XywWA0zLAxfKYY+Nw7eTV9fvbq7PBdNmijWbveaBnLzC5U1NltdnUwSs69fF6OLZ4OngiWC9i1yj3YlHbphbfh4Sf2ccff9dtOco0wMPvUGdrhsp5VWvwJ/U/Gl3pZzpbm7sXgsrF1n2rFZTjPQxmLaVz18bCkn0MzXHkJiRRsB6ViTZvhdZU5d5Tl4EP+lP0reDidruDofX13LysZeFrSTeJ0nsH8T6eskud2wfqmMXgvyKiJ+EPJfOvaHli832buWbgI0id7ulpLdt2/4NheJGSQ==
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extensions"}></MethodEndpoint>



Lists all available extensions in the platform

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Extensions listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>extensions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A map of **extension IDs** whose values indicate whether
the extension is enabled


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if this extension is enabled"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the name of the extention"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Defines the description of the extention"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensions\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List OIDC Client
Source: https://docs.igrant.io/docs/extensions-api/list-oidc-client

---
id: list-oidc-client
title: "List OIDC Client"
description: "Retrieves a list of all OpenID Connect clients configured for the organisation, including their verification request settings and configurations. The newest client comes first. System-managed clients are left out unless `systemManaged` is `true`. Each client holds `clientSecret` and `callbackSecret` in clear text."
sidebar_label: "List OIDC Client"
hide_title: true
hide_table_of_contents: true
api: eJztGdtu28j1Vw7mJbsALcu5dAEhCOq13YV2czHiGHnIGuEReUTOejjDnRlKVg299Uv6af2S4syQEnVLHActUKB5cETyzLnf517k5DIray+NFiPxnryVNCMHCEo6D2YKqBS8q0mPz+HMaE2Zh0xJ0t5BZvRUFo2lHKbGgi8JjC1QS4eMMAGpM9XkUhf8TVqYkZVTmYWvYOnPhpwHR95LXThAna9QBhA3gA8lgaY5w0WqkJmKHEyldX4AVwvnqTqqUGNB+YoxtASKph5M46HRipyD1AXYNxE0Bekg9bahdAAXmJUd+tKo3EEan64os+TTwFmaoVITzG67l1JDpggteLrzA5GIGi1W5Mk6Mfp0v6Xat001IcsKtZQZmzvwBtytrIPqaiykDjIP4BQ0FejljLUJjbaEOU4UwQxVQzBFpRwwI4whHaZMWjKJPxuyC5EIjRWJkTDTqSMvEsGKlpZyMZqicpQIl5VUoRjdC7+oGVRqTwVZkYicptgoL0bDRFRSy6qpxGi4XCb3HVolK+m3SW7K+gbv+CDofTJb8o3VUFOQmgaPZfAkcrVJ+Yp80EowLP+KHkjBN91+Z5E6fGV/H8CpXoDxJdlW24qQw8GXVLEzHdL1hm89SKKJMYpQ9yUKoMvlDR93tdGOHB94Ohzyf5uCvm6jsxVCJCIz2pP2DIp1rdooO/7DMfz9LgNm8gdlm+7xSazRrT1S3CSitqYm62XkqINaI0NrkdUhPVVuH5FNBLUlR9oH9Oc0lVryr3HeO+m8lbrYcS3OB+NzlpxtFhl5spGJ+rghXyHnuDrwCSakDCcgbwA9VIZVqzvsA7HszPwQ5hhykz0+H389VsA1hph7HobFBdhdTJZyaSnz1+/HDzFhS2G5j8QMlcyhQwiMcVUJWu2FDJ52IJ8bK9NQVTRg40tj21qxqgZVw3/QZ2WwQeS+ArrDzKtFMAYqZeaUv7OykPp7RZjTBEzExMQWprHQi59AsMv81+/HD1P99fsxe9K8lFkJCKlrJmmbUOZSKZgQZKiyRqGnPFSXmBX5IeNMGUqmiVmLq1LfcwdwUdV+AfOSdE/T0DhykMqctJd+8YZVKHVx6r2Vk8aTSwe/6740j/ClxlEeoiTLuKQy8bSnnHQA79tkErnb+MgV11GMp8Nc7ksemOchUFFdbqSRr5j3FCqsQ5K0FOihgkh4KsmGcM8Uygpq9KWLwqEDJfUt6z/YK/pzx250TKmLtme4pcUaIzdNa0qjqJ1Z5jt/vzo/+vXjhx5IEkFyk7EgHViVm2wDyFh2oQgSfYgB4eOzsx5YjLP4WUbL5MYfOeKmhJ2MZexcKko9l74MtQ/9AUQh+PhrgJ9QbL0C0+zRX3bEDb/4nQsd3WFVq5BHG6tH1ORyVMt8dCJGgiqUSiyXifAWtcMslAb0eJpFa+56aYV3r0kXvhSjk+fDfV7LjVmUIH6btNwrU7DgURmNI9v1ABfX52P4iEqRT4LhW5YhfW0KiGdChjBaSU0wQX0bIrbRflcdh8pNiQ60gZ6gkKPHLSWJr5Nkl7+Vj6+at7RgFJvNy/4WpY9trHPOjuRY1NAr9YzPQb7ZZxkL2nBrtb8Bgwy1Np5zYlPnwVeNhZwUecpDsmhfn/oDDeGO2eW6BCt0vsW7KX7CoY5wreVdOOA8VjXr21FmdO76pjj56flPw5MXT4dDTp+WHs1NOMv2/k5WTv4yHC6XHC29Nm1P4vTSB1e6XEPt9HKNtaT9JRb0AIHOInTo3Nv2foM7jl/jUY23KvBBBTFwb04IlRtwhlLxyNPH/fRFh5x5fQxyZponJ87zRkM3yKwoPFsm7XTzddxvt1juxpkNbbC7lOguLc2kadw3hZYMHmLpCbtG3WLYIRFHhkDlLd35x1PQnCq3sfMUtYz/ElES5mG0vRdnmJV0dGa0t0btHS5WeWidzrQ5ct5Y2q3Ta5ZCrubA6AYgcKVpVA5tgsiYMCcFZuh5nIsePPcYTe+mYTI/GCbWzGROFshas2vzC34LqN08Wp4ZbTcj3UnOV/crfKeX4xYVD3W98hdfsneFDvpz2/yyvvjL5239xD77SZzon3B+fBIc9YmIttmE/xnzrp2O1bzu5Iq8u1D6IQ202uXGDt207eAizZRppoFm6OPYHtiGVqTRqoVrW0R2ZnLqIz/fwc36u0Tn5sbmYUXzOtRluvOkHWfJlhBpzgU5z95rJ4wecPJNHtCfdFc8dkrv8ccT75cH2PXpfaliZennoWLsoP9inLD1pK4bDsd2nySW+8x8rdsJ6u9h5bCpmhf/+8HhyM7Ifu7I7Y8MT1ajggjb4dujrL2Qj/ZcuepaLPEc4HtBtu2m3GBR1ljpF0G/p7X8jfjnDcvtseBtodjasJ7Faf0mERX50uRiJIqwy+M2XozE8ezZcdx5HK/C5djIPDteb3CipPt2kedUmVYRIhGNVWIkSu9rNzo+zqkyR1jLgSwsaj+QRuyu2S6tyZvYuR5A8zUMV55bkuLQcRc/bzNys9blFbtuDMZOo+s9QHzRruqiMda7utM2arp+aGtovByHsY5jiyeidg2wPRURpBt4Uohk4v5iEpr/qbzjQTjk2sgjpPCDNj6uI71FqYIOaszoxwRoUAy20I6gPfiSZwBWx9EtLV6loS/+mdCSZXiWfRKe/mZshV6MxK8fP+xtR7vR3dySXtfb+Eg6r43Ufit+O6fsJ2bXkBvAFemcg4FDZ4vvyBy8DJhfhSV1yDahNwnfxCrJstXD7Cf11HRpC7OQtuJgOBKuqWtj/V/X3rAyqPxl/WrTjfoeuKWL1SH44V//+OePXGsQruaUS1eGcQzoLitRFxQywcbNBTutzHohD+N26nWkpkfOzMiSLPRqb5C058Mafz1ruwQQcllI7lPnYewMxJzhcl+bHDxlpTY8r5JLYiFkj+F+bQ6KZqRCC8rJjcsTTqTiNQUjwcabCvlmha9MaiVRZxS9MYhnqeD9E1+z8KyBMG2UYr/PpQ98Vqh1TGdKZqRdSM5dDNXcicHTwXBH5/P5fIDh88DY4rg9645fj88u3l5dHPGZ5bqsrO3AkZebrKm6mVkkghNYtNfT4dPng2eDEz5bG+cr1D1+wjr83fj8rMucW+buVcL/X3J91yVXG7L8eFwrlGGlGDzgvi1On8TsWbyPmMrY2rRpQySCS5RIVhcIN4kojfN85v6eB7Nrq5ZLfh3vV0Lpki60f6urlIOG/c9ese0VnDcovZu2cFyMRCx4D2b8W+/LvsBKN9Q+kpP/xv3ZF7jfvkZbS3HDDzYk0NA6dT1WcJF4+DTLqO7LvtPxLvv91C8XXCCxrZ7rzuE2dA7tj15DjHrRw73dREQW4kLtwJGXnOB+o8WrFXj8cvDAqnGJ0Kyom+Vy+W/hsyTH
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List OIDC Client</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/oidc/clients"}></MethodEndpoint>



Retrieves a list of all OpenID Connect clients configured for the organisation, including their verification request settings and configurations. The newest client comes first. System-managed clients are left out unless `systemManaged` is `true`. Each client holds `clientSecret` and `callbackSecret` in clear text.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Set to `true` to include the system-managed clients in the list. Any other value leaves them out.","in":"query","name":"systemManaged","required":false,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

List of clients

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Cache-Control</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Indicates that the response should not be cached.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clients</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client's configured presentation definition. A presentation definition belongs to at most one client."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"redirectURIs"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The valid redirect URIs for the client. The `redirect_uri` of an authorisation request must match one of them exactly."}}></SchemaItem><SchemaItem collapsible={false} name={"allowedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The web origins of your application."}}></SchemaItem><SchemaItem collapsible={false} name={"callbackURI"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI at which a `sub` value will be calculated and returned according to the sent presentation. Empty when the client uses `identityMatchingAttributes`.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"callbackSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret used to access the `callbackURI`. Required when `callbackURI` is set."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityMatchingAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A map of credential identifiers to claim paths used as linking values for identity matching. Each key identifies a credential: the `vct` of an SD-JWT credential, the `doctype` of an mdoc credential, or a `type` value of a W3C credential. The value is the dot-separated path to the claim within that credential. The value of that claim becomes the `sub`. Empty when the client uses `callbackURI`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataAction"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 140 characters`"} schema={{"type":"string","maxLength":140,"description":"The text that describes the login to the user in the EUDI Wallet, for example `Log in to your online bank account`. Empty when the presentation definition has no transaction data.\n","example":"Log in to your online bank account"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client's key"}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the client is system-managed or not. A system-managed client cannot be updated or deleted."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The time of the last update of the client, as a Unix timestamp in seconds","example":1747015200}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The time of the creation of the client, as a Unix timestamp in seconds","example":1747011600}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"clients\": [\n    {\n      \"presentationDefinitionId\": \"string\",\n      \"name\": \"string\",\n      \"clientId\": \"string\",\n      \"clientSecret\": \"string\",\n      \"redirectURIs\": [\n        \"string\"\n      ],\n      \"allowedOrigins\": [\n        \"string\"\n      ],\n      \"callbackURI\": \"string\",\n      \"callbackSecret\": \"string\",\n      \"identityMatchingAttributes\": {\n        \"urn:eudi:pid:1\": \"email\"\n      },\n      \"transactionDataAction\": \"Log in to your online bank account\",\n      \"kid\": \"string\",\n      \"systemManaged\": true,\n      \"updatedAt\": 1747015200,\n      \"createdAt\": 1747011600\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with `error` and `error_description` when `offset` or `limit` is not a number. The answer has `errorCode` and `errorDescription` when the Passwordless Login extension is not enabled.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_request\",\n  \"error_description\": \"Invalid 'offset' or 'limit'\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Authorisation Endpoint
Source: https://docs.igrant.io/docs/extensions-api/post-oidc-auth-sandbox

---
id: post-oidc-auth-sandbox
title: "Authorisation Endpoint"
description: "Starts the authorisation flow. Takes the same parameters as the GET request, in a form encoded body. Returns an HTML page where individuals can authenticate using their EUDI Wallet through QR code or deep link verification. After the individual presents the credentials, the page redirects the browser to `redirect_uri` with `code` and `state`. When the individual does not answer within 15 minutes, the page redirects with `error=interaction_required`. The endpoint accepts GET and POST."
sidebar_label: "Authorisation Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztWN1u28oRfpXBAjlIAJrScXJuhJPTOrbPqU/T2I0dpIVhWCvuSNxoucvsLkWrhu76JH20Pkkxu6RI0bLzA/SqvbJFcmdmZ7755ueeCXSZlaWXRrMJu/Tcegc+R+CVz42VjtMrmCtTp3DFlxjfOl4glNzyAj1aBzw+/u30Cix+rtD5BKQGDnNjC0CdGYECZkasU3iPvrLaAdfwp6u/vIWSLxDqHC2C1EKupKi4cpBxHYxA7WXGPULlpF6QGmnh9MPJGXzkSqEHn1tTLXL463sgNWAsCMQSlNRLWKGVczovjU7haO7RBks7TVBadKiba2cWBWnkyiXhQbDOopAWs+abmTW1IzkGpu2b28rKKdTS5zAlK6bAtYCp89zjNIWPOeqhXmHQgTYeuHY12nBYavjxJyikrjzuNyCqQGuNfS21R8szutstuV1aFNMUrnIE1KI0UnvgWYaldyE0ZNLF+eVVyhLWBY9Nru8HOCAJZydg5sECYxdcN0hgCZP0Rcl9zhKmeYFswvpfnAmWsNYaNvG2woS5LMeCs8k98+uSTjhvpV6wzSYZ6v6g5ecKQYYwzCXa1gzHtZiZux1z0v32NJ+e28U3WnMTP0bn3xixpi+GZzOjPWpPr3hZqgZao7uDuq4PCO0HlVUN4OmjB7rM7BNmniJgTYnWS3TxO0OvhyYlDHVVsMk1MyVqKdhNwgTOeaU8yYrPkj3hC/Ja1xEInGtTk23olq402uFtVPe4WrrIrtLwZJ9KEkEaW9kg0AXXbRKWKYna30qxT9dT4IsHo8ldqn2dlA/vzyhJ61xmeRC2tayWSsEMgRI/hTMPReU8FNxnORi99VurkiS5XYsA73jm1Tol00Kaf9mmIw2m5ITuFVcVMRoKMrDgUnsuNQQ5MENfY8MXTchC6gblXKkZz5akVRudfY1WiC8GSrlzJpOkj7dXcugcsX3gGK4pCt4sUSdRvYFCermgIxZLxdfAvefZ0lEa9xLlugHzEGV9FAzC2brwZrPZ9NAZMuNwPKY/u5faFhGocRY4MvJeYEuXmzpSdVsTWveFmuBz7oFSJ37TqyUNUU+3dk5BOqj0UptaJ1RZ6vB+l/W3RB7xw3dgs4uaHqV3RgYyDyZq0531odiWimdILNfjHY93fpT7Qu3llyfyIZTbRlBrF9nCgtNz5CKUg3v2t4NfqTocnIfTblcP3vGiVKTq5PTd3wmIu5reKJMtXbzk3JoCZkjos6gFWhTUFwRD5qQiAdn8xWKGIvg4MiSgwoLqcgIWF9wKRRTW1gJJuPUei9KHrsCAMOBMGq/ycnz4EDJXvXSSRIZzSoWgkUT2OwVqPiigjvqhBljWrKRA+229AH3yuUK77jdLsXpPk+af256Zu23DTth3I/TWREufhkAXqtz70k1GowjDtHmRZqYYtZTyh7apWHElxW3jqh8e2Pj6YnuVZ4djIs5nh+MZPjscV6F0/xCsf83nYzn/5JRYfnqIkasBuXbeisnQeauJ6KtIAo9U309u6Ik+GwWRx7Fqhf9PerbcJF8ozN3pzsHUeC3Q9j38ajze7BH/ZFDecMqGsvLdfem2m4cpxUUL3QEaY+/otpRNCbEOjXakqn4NyY0SjmDakHJBfWqU17SgOW/Redz1sMM7TTvJ/VaMcopyZm4qLQi6HVpjAF99UwCHQfHSB59dtDcPZj2gudOGS8N1GrI4L1GfnUB7Mt0f4q+j0AhPqikJzTbQBBOmg7Sh7NbG3wZvTIljpg7tCu1tTH7WguVWPI2WfXnDHY1kDW9F4wNotsjaXoltbWB79bF3bcTYHthtX0aQXHDnatMQ8VuzkBrwzqMOPQNBR+MKLcyod0HNZwrF1srHmvddkPz0jVluNJ7Pw/zy34QLzSitvKOLs9bjN3sd3o/yIz4/o7FNcwXx2y6CDwKw98vvzljp27pmkTcdcdlLin4sNgkNF7ad6CasNM6fn50cH1U+v4zBJDfzBc2PbOAzeH65J94viGwL9LlpBYY51OdswkarlyO6pMxwtAXVyEiRje53p8vN6L4/3m1GtCSgBjK4aN80e4KFaTzIElZZ1auHAgtzwEuZyoXl2qfSsIcj6YU1ogpj9mNiviTh0vMF9SmPHHfx9dCQG7pVVlnp15eE+chWR6X8M657XMHjg2YSjlHsZuGjuMj5Rzu+D4aDizNY4rq/aQmbEoJYnBearJjuyJlCVBPnphnhCOfyDkWzn4g2whSea+MxCPCWSxV8UPIMXySA6SIdiJ1Ac/DntaksueNgietfpmHIeoPcoqXv6e6z8OtXYwtOQ+nvH6/2kmUz+YYxJjb+wZbwc7sj2U38Y6N16D+33Cadq9ClcIlaUBZRzg3sjsbBz0HyL6F1CzRFEYimsm2jQVEPI5PUc9PyHc8C32HBJSHDVWVprP9jh4ZtQOVv3aNdGPUROPDF9hA8//c///WCijWHyxqFdDkI7jngXZZzvYiz0k4z3ORlxxU0MFcOHThU8wNnVmhRLnSzs/HrpDlPJWB3o8ZByIX0XEEdl3ekzBklBZRGgMcs10aZhaTtV6ghhBgOGmtQuEJFsQprr8BOM6mkXwchvPKm4GEYyExRKsl1hhGN4XoWF5UK93HNZrJSinAvpA92FlzryINKZqhdYPU2h0qe5QiH6fiBz+u6Tnl4nRq7GDVn3ejt2fHpu8vTAzqz6epRFwfKPGGyimacNjeJwGK8DseHr9KX6Y90lpiy4Lpvz85y9rTB8TABeoX0/5vd/53NbsMyYUtQKi41YSiA9r6pttds9bKpmDILU1FLdSxhVHNZwiYPdrqTwVY11N2bhOVUyCfX7P5+xh1+sGqzocdh7GWT65uErbgNXBBrs3ShNWSTOVcOn8Ds8/fNzV/AkwvpvRdua6OmwhgqGZswlrAllc7hwjoU7O+x65uX1d9h647bNzfbPUDwZvzkONp2cBXXbK2ILy+o6eJRxFFAU+9wt2Xa9Ns2QhlL2KxZjxdhMGY9kUn/x+SaNnr/AReBV8k=
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Authorisation Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/service/extension/oidc/{organisationId}/{sandboxOrgId}/auth"}></MethodEndpoint>



Starts the authorisation flow. Takes the same parameters as the GET request, in a form encoded body. Returns an HTML page where individuals can authenticate using their EUDI Wallet through QR code or deep link verification. After the individual presents the credentials, the page redirects the browser to `redirect_uri` with `code` and `state`. When the individual does not answer within 15 minutes, the page redirects with `error=interaction_required`. The endpoint accepts GET and POST.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/x-www-form-urlencoded"} value={"application/x-www-form-urlencoded-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"scope"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`openid`]"} schema={{"type":"string","enum":["openid"],"default":"openid","description":"The scope of the access request"}}></SchemaItem><SchemaItem collapsible={false} name={"response_type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`code`]"} schema={{"type":"string","enum":["code"],"default":"code","description":"The type of response desired"}}></SchemaItem><SchemaItem collapsible={false} name={"client_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"redirect_uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI to which the response will be sent. It must match one of the redirect URIs of the client exactly."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An opaque value used to maintain state between the request and the callback"}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string value used to associate a client session with an ID token, and to mitigate replay attacks"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Returns a web page. The page shows the QR code and the link that opens the EUDI Wallet. When `client_id` is unknown, or when `redirect_uri` does not match a redirect URI of the client, the page shows the error and no redirect takes place.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>X-Frame-Options</strong><span style={{"opacity":"0.6"}}> any</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Blocks page from being rendered in HTML frame, iframe, embed, or object elements, regardless of the site attempting to do so.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"text/html"} value={"text/html"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"302"} value={"302"}><div>

The request is refused, or the verification cannot start. The provider redirects the browser to `redirect_uri` with the query parameters `error`, `error_description` and `state`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Location</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The redirect URI with the error parameters.

</div></div></li></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with an empty body when the request holds `response_mode`. The answer has `errorCode` and `errorDescription` when the organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Authorisation Endpoint
Source: https://docs.igrant.io/docs/extensions-api/post-oidc-auth

---
id: post-oidc-auth
title: "Authorisation Endpoint"
description: "Starts the authorisation flow. Takes the same parameters as the GET request, in a form encoded body. Returns an HTML page where individuals can authenticate using their EUDI Wallet through QR code or deep link verification. After the individual presents the credentials, the page redirects the browser to `redirect_uri` with `code` and `state`. When the individual does not answer within 15 minutes, the page redirects with `error=interaction_required`. The endpoint accepts GET and POST."
sidebar_label: "Authorisation Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztWFFvG7kR/isDAjkkwFrSObkX4XKtY/uuuuYSX+wgLQzDGi1HWkZcckNyJauG3u6X9Kf1lxRD7korWXGSAn1qn2wtyZnhzDffzPBeSPK5U1VQ1oihuAzogodQEGAdCuuUR16CqbbLHlzhnNKqx5KgQoclBXIeMH3+5fwKHH2qyYcMlAGEqXUlkMmtJAkTK1c9eEehdsYDGvjL1W+vocIZwbIgR6CMVAsla9QecjTRCDJB5RgIaq/MjNUoB+fvz0bwAbWmAKFwtp4V8Ps7YDVgHUiiCrQyc1iQU1M+r6zpwck0kIuWbjVB5ciTaa6dO5KsEbXP4odonSOpHOXNnomzS89yLIzbldvaqTEsVShgzFaMAY2EsQ8YaNyDDwWZfb3SkgdjA6DxS3LxsDLw/Q9QKlMHOmxAUkHOWfdSmUAOc77bLbtdOZLjHlwVBGRkZZUJgHlOVfAxNGzSxdvLq57IxDZ4Ynh9v4cDljA6AzuNFlg3Q9MgQWRC8Y4KQyEyYbAkMRTdHSMpMtFaI4bB1ZQJnxdUohjei7Cq+IQPTpmZWK9v0mby4ZWVK96xfza3JpAJvIRVpZtg9u+OlsvlEePrqHa6gRhveqDLTj5SHvjOzlbkgiKf9lle3jcpE2TqUgyvha3IKCluMiFpirUOLCt9yw44LMprfcZu975NBrHmW/rKGk+3Sd3n1fJFdpXGL4dUsgjW2MoGST66bp2JXCsy4VbJQ7oeC3c6mEzegvvrpLx/N+K0WBYqL6KwjWVLpTVMCDjVejAKUNY+QIkhL8Cajd9alSzJ71oEdId50KsemxYT68s2nRiwFX6qCRaoa+YQkmxgicoEVAaiHJhQWFKToU3IYrJE5aj1BPM5azXW5F+jFdLCnlL03uaK9WF7JU/eM7/GrEbDUQh2TiZL6i2UKqgZH3FUaVwBhoD53Iv1uptk1w2Y91HWRcFeOFsX3qzX6w46Y2YcDwb8Z/dSG9qGJU0iKyWmifzkC7tM5NiycOu+yMKhwACcOmlPh70bahxv7ByD8lCbubFLkzGXL+P6Ls9uqDPhB3dgs4uaDolujYz0GU00dns2xPJWacyJGbLDO4HuQr8IpT7IL4/kQyxwjaDWLrZFRKcXhDIS8L3429HPzMdHb+Npv6uH7rCsNKs6O3/zdwbirqZX2uZzny45dbaECTH6HBlJjiRX4mjIlFVkoJq/VE5IRh8nhgTSVHIlzMDRDJ3UTGGN1V4xbkOgsgqxDluQFrztpas8Hxw/hMxVJ50Uk+GUUyFqZJHd2szlngPquQNpgOXsQkly31Z9ecunmtyq256kejnOmn9uO2buFuqdsO9G6LVNlj4OgW2oihAqP+z3Ewx7zUIvt2W/pZQ/tWV8gVrJ28ZV3z2w8eXF5ipPjgdMnE+OBxN6cjyojfpU03fR+pc4HajpR6/l/ONDjFztkevWWykZtt5qIvoikcBnqu9Hv++JLhtFkaepasX/zzq23GRfKMzb01sHc6szI9f18IvBYH1A/KNBeYWcDVUdtvfl264fphTKFrp7aEzdmt9QNifEKra2iaq6NaSwWnqGaUPKJXeGSV7T9BXYovN02zXu32m8ldzttDinOGemtjaSobtFawrgi28K4H5QggrRZxftzaNZD2juvOHSeJ2GLN5WZEZn0J7sHQ7x11FogifXlIynCWiCCeO9tOHsNjbcRm+MmWPGntyC3G1KftGC5VY+jpZDeYOeh6CGt5LxETQbZG2uJDY2iIP6xJs2YuIA7DaLCSQX6P3SNkT82s6UAboLZGLPwNAxtCAHE+5dyOBEk9xY2UXKQ3D88I3ZbQ29ncZJ4b8Jk3V2v5F3cjFqPX1z0NHd6H7G1yMekAxqSHu3kXvg+IM7/+NMVaGtZ46w6YSrTjJ0Y7HOeKhw7ew0FJX14e3o7PSkjiNWwBmPaGLPWfD0N+5fAxk04RmTakmhsK2AOOGFQgxFf/G8z5dSOfU34OlbJfP+/e7ctu5jUpl8cGgwPKPSNi4Smaid7hQ6SaU9wkr11MyhCT1lYzx3BVw4K+s4sX5OzJckXAaccQPymeM+Le8bcsO3ymunwuqSQZ1o6KRSf6VVhwQwfWiG3BSm7Zh7kt5E/tFOwntd/8UI5rTqPlrERwfGUBoEGtiPd+SMIalJA9GEgUJTdUeyGfWTjTCGp8YGigKCQ6WjDyrM6VkG1Jv19sQOoTn448rWjt1xNKfVT+M4Pb0idOQiwIb3YhJ//WxdiTxt/vrh6iALNiNtnE9SRx9tiT83zw27mX1qjYmN5Ya0lPc1+R5ckpGcJpxUe3Yn4+DHKPmn2JNFHuIIJFPFpoPgqMdZSJmpbQkN80hoVKJiZPi6qqwLf96iYRNQ9cv20y6Mugjc88XmEDz91x//fMZVGOFySVL5AiQGBLrLCzSzNATtdLlNIm7JgCfh2pMHT3p65O2CHKmZARVfocIqa84zt+8+TiFINVMBNSzTOxgr81YrCZWVECgvjNV2pvghKRYHRgyCoSVoWpDmWMUXpEg/E6VVWEUhWAdbYuzyc1tWWqHJKaExXs/RrNbxPr555Ku1ZtxLFaKdJRqTiE6rnIyPtN3mUIV5QXDcGzzw+XK57GFc7lk36zdnff/16PT8zeX5EZ9ZbwvONg6cedLmNQ8vbW4ygaV4HQ+OX/Se977ns0yNJZquPTvvnOcNjvcToFMp//9I+r/zSNqwTBz/K43KMIYiaO+b8notFs+biqnyOO60VCcywUVWZGL44Hk01tmbTBRcqYfX4v5+gp7eO71e8+c4v4rh9U0mFuhi7qdarHzs8cRwitrTIxh9+q656TN49C334AXbWmi4EMbKJYZCZGLOpXL/rXd9sxmTo41p02my5OgqvUK1Qr78fsv1Pok4iTHpHN4+wqy73Q7HSmRi0rwel3FuFB2RWffH8JofvP4NqZnWJw==
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Authorisation Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/service/extension/oidc/{organisationId}/auth"}></MethodEndpoint>



Starts the authorisation flow. Takes the same parameters as the GET request, in a form encoded body. Returns an HTML page where individuals can authenticate using their EUDI Wallet through QR code or deep link verification. After the individual presents the credentials, the page redirects the browser to `redirect_uri` with `code` and `state`. When the individual does not answer within 15 minutes, the page redirects with `error=interaction_required`. The endpoint accepts GET and POST.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/x-www-form-urlencoded"} value={"application/x-www-form-urlencoded-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"scope"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`openid`]"} schema={{"type":"string","enum":["openid"],"default":"openid","description":"The scope of the access request"}}></SchemaItem><SchemaItem collapsible={false} name={"response_type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`code`]"} schema={{"type":"string","enum":["code"],"default":"code","description":"The type of response desired"}}></SchemaItem><SchemaItem collapsible={false} name={"client_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"redirect_uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI to which the response will be sent. It must match one of the redirect URIs of the client exactly."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An opaque value used to maintain state between the request and the callback"}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string value used to associate a client session with an ID token, and to mitigate replay attacks"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Returns a web page. The page shows the QR code and the link that opens the EUDI Wallet. When `client_id` is unknown, or when `redirect_uri` does not match a redirect URI of the client, the page shows the error and no redirect takes place.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>X-Frame-Options</strong><span style={{"opacity":"0.6"}}> any</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Blocks page from being rendered in HTML frame, iframe, embed, or object elements, regardless of the site attempting to do so.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"text/html"} value={"text/html"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"302"} value={"302"}><div>

The request is refused, or the verification cannot start. The provider redirects the browser to `redirect_uri` with the query parameters `error`, `error_description` and `state`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Location</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The redirect URI with the error parameters.

</div></div></li></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with an empty body when the request holds `response_mode`. The answer has `errorCode` and `errorDescription` when the organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Token Endpoint
Source: https://docs.igrant.io/docs/extensions-api/post-oidc-token-sandbox

---
id: post-oidc-token-sandbox
title: "Token Endpoint"
description: "OpenID Connect token endpoint that exchanges an authorisation code for access and ID tokens. Client authentication is required using HTTP Basic Auth with `client_id` as username and `client_secret` as password. The `sub` value is resolved during this request, with the identity matching attributes or the callback of the client. The ID token holds the claims `iss`, `sub`, `aud`, `presentation`, `iat` and `exp`, and `nonce` when the authorisation request had one. The access token and the ID token expire after 5 minutes."
sidebar_label: "Token Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztWc1uI7kRfpUCL2sDLck7PxdhN4jHniTabNbG2IYPHkOimiU112yyh2RLcgTd9knyaHmSoEi21GrLM54BEiDAnGx1k1UfWV/99poJdLmVlZdGsyG7qFCPzuHMaI25B28eUANqURmpPfiCe8BVXnA9RwdcA699Yax0nPZDbgTCzFjgeY6OFggYnUcprg9nSqL2YQ9qL/O4STqw+KmWFgXUTuo5/O36+hLecSdzOK19AUvpC5jkYfdYiglwB7VDq3mJQUfzzmFu0Yf3FXduaazow3WBMHH1dAILrmqM+pxRCxQgaksKfZFAoPNZVOcLBCkIpn+Ekvu8oIXceyuntUcHxoY1OVdqyvMHMLP4OyCJWpujQ2GUcOk1l6WDiXRukkVYGUx4LehPZdGh9uFa6LfkdBY6H66qSRb/1UbnOIFlgTpI3LdAOgQUXIDRGHEka0QsJMS3weGqkhaBzzxaeAul1HS+/kfNMlZxy0v0aB0b3q07XElHTAc3ds51gsEyJmlFxX3BMkZ2YkPWXjESLGON2dnQ2xoz5vICS86Ga+YfK9rhPJmHbTZZV/eNlp/qxkIzibaB4bgWU7Pag9M/jCctvbDzr0RzHxej8++MeKQV3b250R61p1e8qlSi+mDVWy6XvZmxZa+2CjX5i6BFT3SZ6e+Ye7KANRVaL9HR27nl2o/jmi6ujKGuSza8Y4kS/wxKx6SE3WdM4IzXyrPhoffZAduSeLrWoBSmSA5QOxRsQ+cX0mLux7WVh6A8lXbzYQTewLKQefQui64y2iEspVIwRSDuZ1DWzkeHS6uiorCftIOMvD9tHwI+RHsQtHCeF0HaF3FGwctijpIiw8ya8nN6Nm3C3LUN07mcBOh+s4l74qGDNV+dnNCffWCn0VmPYuw8Tk7a7GPPcut3R9tfTqUYFMZB/Muu65fb64Qm5IGc68ZqZNgUZCprPOYeRQiytc3RkVHCvmeJ+zz3yAJRp3SuRgFH75BbtMckNEYuN5btA0jtcY72oFRdl9MYKhzmRgsHtfZSBS3KzKUGh86RnZNo0iLFV19SuB6jPZfa7bKI1OT5kUd8amof9FIiY5vIjgK5CLF2zc54XmDvzGhvjTpo153br3hZKXqkTc95Y5Fg70MbaUFEQRfB7fmfK0ytBGhDTg45KRZ9FgC9iQx9MeWMxotZSBVd8nnpA8RLaxZSoAW01jy10nt6Cly75S6kp5qk2dlnlA4aeaeXoySKwvL2KtYsPiQ+LLiSYhw8lG6Lno+7txPWNNZn0Rr7a95x0WTXmFWr5iQRrUtlSpDfpO2urkncGp6HaskBtwiTBmRSQMm/1q6uKmM9JuzBe0JZkBbHUiOp2jtmUpOuseAuQaEQ14Z23kK2qyjaqZOqJSLGzNRaUB7dUTTy48ev4sd/kxXdAJcI8BKn3dkjC+VrotFBu2jjx+E2JlQCThzaBdpxtHoISk/59RIIFrkzOmj3DaLog5/hdGTAF0j9w14G+wGiBSHGInaA6Te6KRCwKZ/3REwaEcJgZEftMKCONXswN+6Thd3e3vZOd4U/vjSkRZEWuSp//thtTxrjf2RPI951qo1bnUYEtouA276Gclfl3TbovflO6v89qbcYnuHzb00YOsTZ7ctI2MvU/SkqSX4NmR1XHnXI7RQPNS7QwhRDd8uniiq+hPK5DmI/8r39/8+MTes6bhQeuvXApJWnZlsB8ULmZFdfW40C3p68Ppgsuz13znUqL5rWuw+3satPIG4+jCY7krRz4xbmjEuFoVHeR97OiU1Rk7JcKR1NFMYEpdHY1GP/SE396ban7wKg5PfEW/pw4QuKn1yq2qKDuVxgx2W+Of1K31yVRZ46oKoVDNoc3GTMYV5b6R8Dr0KkpBDLhnf3ZHKKG02zPWSVcf5idH52TbXsVeQ4sY/PqbdnHSrB0dUBNzimPrJEX5hGYpgRkEo2WLweJH4Mtr42MFLkg/V+578ZrNut92YQy2s6Dt3hoVHDOZYG4muWsdoqNmSF95UbDgYCS9PjlezLUPv0pWFP5wWX1og6j1ngsJgvSbjyfE4d8DPbXXzdBXK/M9JVyD4hip9W8u/42IqhPD5IY4po5d2gYi/7PgkM5OcP+NhJdpGC0ftStHgmi4eGe0o8w5lcoUh1bMQIEzjSxsf07i2XKtxBxXM8zgD7835H7BDSxp8eTW3pOnoP+PinCcUmFnu3yNE1m4Zff4l1yJD9cnt9MInsTa+2ubszmdwPiE19sIv5oXt0fbhCLcjLyCc7uCM4+ClIJsBpBEQWiFDJXaK9yOphBkA9XZMHeB7yAJZcEjNS+f7nHRu2BpV/3T3ap1GbgZ272G6Co3//8a9jCk4crpYopCtAcM+3k9kQYhZo5Wxb+aTAvY0lMApVmwOHatZzZoEW5Vxvm9Us7afUCLnF8JgrlwEHIefScwVLrhT6oMwZqjQrI8BjXmhDzTS6LObWMDgFjUtQuEBFtqImPdQ1fCoV9cYkhNfeUHus55CbslKS6xwjG8PxLM5rFc7jaAjEYVYrRbwX0gecJdc6xkklc6RpyXC99aGK+lp41T95cufL5bLPw+u+sfNB2usGv47O3v929b5Heza7PL2zA3meMHldNkNbljEKYNFer05evem/7v9IeylUlly38IQwDO8Tf7vEbxUW30fy30fy7ZF8ikAeV35QKS418SsQep1S8R1bvE7ZVOYYuqkUBlnGKCGzjA2fDOOHnXF4TMr3GSsozQ/v2Ho95Q5vrNps6PGnGi0VHvcZW3AbAkVM3NKFepoNZ1w5/Ayxjz4kjh3DZz8lHDxxkzg1Zc3AIjZkLGMPlFe7nxpCNv8WXF/9meEbsO7d++Z+OwYMtxmXnEVsves4X25EfPnTAh08ijgNLe4zm0O7smnXdpcXV5SNp+n7Rhlm6qwlOWv/oIJzs/kPmSYOdw==
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Token Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/service/extension/oidc/{organisationId}/{sandboxOrgId}/token"}></MethodEndpoint>



OpenID Connect token endpoint that exchanges an authorisation code for access and ID tokens. Client authentication is required using HTTP Basic Auth with `client_id` as username and `client_secret` as password. The `sub` value is resolved during this request, with the identity matching attributes or the callback of the client. The ID token holds the claims `iss`, `sub`, `aud`, `presentation`, `iat` and `exp`, and `nonce` when the authorisation request had one. The access token and the ID token expire after 5 minutes.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/x-www-form-urlencoded"} value={"application/x-www-form-urlencoded-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"grant_type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`authorization_code`]"} schema={{"type":"string","enum":["authorization_code"],"default":"authorization_code","description":"The type of grant being used"}}></SchemaItem><SchemaItem collapsible={false} name={"redirect_uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI to which the response will be sent, must match the redirect URI used in the Authorization Request"}}></SchemaItem><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Authorization Code received from the Authorization Request"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Access (and ID) token response

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Cache-Control</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Indicates that the response should not be cached.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"access_token"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JWT token that can be sent to access protected resources"}}></SchemaItem><SchemaItem collapsible={false} name={"token_type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the token issued (Bearer)"}}></SchemaItem><SchemaItem collapsible={false} name={"expires_in"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of seconds until the login session expires"}}></SchemaItem><SchemaItem collapsible={false} name={"id_token"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JWT that contains identity information about the user"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"access_token\": \"string\",\n  \"token_type\": \"string\",\n  \"expires_in\": 0,\n  \"id_token\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with `error` and `error_description`. The error codes are `invalid_request`, `unsupported_grant_type`, `invalid_client` and `invalid_grant`. The answer has `errorCode` and `errorDescription` when the organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_grant\",\n  \"error_description\": \"Invalid session\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized. The `Authorization` header does not use the Basic scheme.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>WWW-Authenticate</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The authentication scheme that the endpoint accepts.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_client\",\n  \"error_description\": \"Invalid 'Authorization' header format\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The `sub` value cannot be resolved. With `callbackURI` the error codes are `callback_failed`, `callback_error`, `invalid_response` and `missing_sub`. With `identityMatchingAttributes` the error code is `invalid_request`. Other failures give `server_error`. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"callback_error\",\n  \"error_description\": \"The external service returned 503\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Token Endpoint
Source: https://docs.igrant.io/docs/extensions-api/post-oidc-token

---
id: post-oidc-token
title: "Token Endpoint"
description: "OpenID Connect token endpoint that exchanges an authorisation code for access and ID tokens. Client authentication is required using HTTP Basic Auth with `client_id` as username and `client_secret` as password. The `sub` value is resolved during this request, with the identity matching attributes or the callback of the client. The ID token holds the claims `iss`, `sub`, `aud`, `presentation`, `iat` and `exp`, and `nonce` when the authorisation request had one. The access token and the ID token expire after 5 minutes."
sidebar_label: "Token Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJztWM1uI7kRfpUCL2sDLck7PxdhE8RjTxJvdtfG2AMfPIZEkSU1d9hkL8mW7Ai65UnyaHmSoEi21GrLM94ACRBgTraaZNVH1sevqrhmEr1wqg7KGjZmlzWai3M4s8agCBDsZzSARtZWmQCh5AHwQZTcLNADN8CbUFqnPKf1IKxEmFsHXAj0NEHCxXmy4odwphWaENegCUqkRcqDw98a5VBC45VZwF9vbq7gHfdKwGkTSlipUMJUxNUTJafAPTQeneEVRh/tmEfhMMTxmnu/sk4O4aZEmPpmNoUl1w0mf97qJUqQjSOHocwg0IciuQslgpIEMzxCxYMoaSIPwalZE9CDdXGO4FrPuPgMdp5+RyTJa7t1KK2WPg9zVXmYKu+nRYJVwJQ3kv7UDj2aEI+FfitOe6H94UM9LdK/xhqBU1iVaKLF/QjkTUDJJViDCUeORsJCRkIXHD7UyiHweUAHb6FShvY3/GRYwWrueIUBnWfju3WPK3mLeePWLbjJMFjBFM2oeShZwShObMy6My4kK1gbdjYOrsGCeVFixdl4zcJjTSt8oPCwzeY+TUYf3ln5SDP6a4U1AU2gIV7XOpNr9DBYrVaDuXXVoHEaDTFU0qQnvuzsVxSB9uxsjS4o9DS6cNyESZrTx1UwNE3FxncsB+Hv0emEnLD7gkmc80YHNj40Xhw4TTJP5xmdwgyJco1HyTa0f6kcijBpnDoE5am1jx8uIFhYlUokPjv0tTUeYaW0hhkCsa2AqvEhUTzPSo7ievIOKjHttLsJ+JDiQdDifl4Ead/EGcmFQ4GK7uLc2epLfjZdwtx1A9M7nAzofrNJa9KmYzRfnZzQn31gp+l6HCW1Os7Xol3HnuXWr56Wv5xK6RpOovmXHdePtzcZTVRewU0bNQpsvta1swFFQBllrXECPQUlrnuWuM9zjyKQfCrvG5Rw9A65Q3dMRpNW+InqbkCZgAt0B62appqhI7sehTXSQ2OC0tGLtgtlwKP3FOdsmrwo+bsPKR6PNYEr43e6rQzd/MQjPrNNiH4pdbBNYkeJXEZ1W7MzLkocnFkTnNUH47q79g+8qjV9Mnbgg3VIsPehXRhJREGfwO3dP1/aRkswli45CHIshywCepMY+mLKWYOX8yjOffIFFSLEK2eXSqIDdM4+jdJ7+grc+FWKEwHNVUC7csg2xXpr7/TqIpsiWd4exZqlj8SHJddKTuINpdOi75P+6cQ5bfRZisb+nHdctvks5bG63UlC63NhEO23ibLva5qWxu+xPvHAHcK0BZkdULptjG/q2rqAGXu8PTER58kpuWdXe9vMbvIxltxnKCRxXWjnHWS7HN7NjFSfEDHmtjFyyLoUTfz4/nfx47/Jir7AZQK85NLu4lHEgjHT6GBcjA2TeBpTKrqmHt0S3SRFPYrSU369BIJD7q2J3kOLKN3BL3A6MeArpP5uL4N9BymCkLSIHWD6R9MWCNgWrHsmpq0JaTGxo/EYUacqOYYb98nCbm9vB6e7UhtfKmnJpEOuqz986jcEbfA/saeKd5Or0U5tn4DtFHDbSVDuqoPfit6bb6T+35N6i+EZPv/SytAhzm4HE2Gvcr+lqST5KWZ2fAhoYm4nPTS4RAczjP0kn2mq+DLKrvw9Vby3//8ZsW0SJ63DQ6cdGfQQqK3VQHxQguIZGmdQwtuT1weTZL+7FdzksqJtcodwm/rnDOLjh4vpjhzdnLiFOedKY2xJ95F3c2FbzOTsVilPvfuEoLQe2zrs59w+n2675z4ASnpPbskQLkNJusmVbhx6WKgl9q7Kf5x2VWiPyiHPnU/dEYEuBzcF8ygap8Jj5FVUSJJWNr67p5CTXrRt7ZjV1ofLi/Ozm1jDFizwBbXPrMchOPqZU2eFhptwTP1ihaG0rYXYfZMLNlq+HmU+jLZ3amSVFKP1fk+9GYXsMx3Soa79HCsLaZgVrHGajVkZQu3Ho5HEyg54rYYqFjVDZSPP9w1cOSsbkeT9sJmvWbgOfEGt7TPLfRruA7nfReE6ppUoz6e1+hs+dsSRpw/5BSKFcfcGsZdWn9x8usif8bGXxRLH0vXKcvBMeo6d9IyIhHP1gDIXqAkjTOHI2JDydnBc6XgGNRd4XAAOF8Oe2THkhT882sbRcQw+4+MfpyQ+LDVliYRrNou//pwKjDH78fbmYHbYewjaJuXeI9++4rWJfyfmsS30Q7hGI+ka0aXr4U7g4IdomQDntx2KQIJK1yLFi6Iem3tq1lqh5yIKPVZcETNyXf6nHRu2AVV/2X3ap1GXgb2z2C6Co3/945/HpD4crlcolS9B8sC3j5xRQ5bo1Hxb0mRl3ooFXMRyzINHPR94u0SHamG2XWiR11POA+EwfubaF8BBqoUKXMOKa40hOvOWSsjaSggoSmOpS0ZfpKQZ3yDB4Ao0LlFTrKj7jgULnylNTS8Z4U2w1PeaBQhb1VpxIzCxMW7P4aLRcT+eXnc4zButifdShYiz4sYkIdRKID2DjNfbO1RTwwqvhidPzny1Wg15HB5atxjltX7008XZ+1+u3w9ozWaXiHdxoJsnrWiq9v2TFYwELMXr1cmrN8PXw+9pLWljxU0HT9RZeJ/52yd+p3L49rr97XW7+7qdFSjgQxjVmitD/IqEXufce8eWr3M2VQJjm5RlkBWMMjAr2PjJu3ZKwvcFKymPj+/Yej3jHj86vdnQ598adFRJ3BdsyV0UhpSolY+FMRvPufb4BSIffcicOoYvvsIf3GGbKA1lycgaNmasYJ8pj/Zf6Tf321eyiDFNOktIBjfp+bU18vWXdyoGkonT2AE+szhW9ZtuSXR1eU05bZaf/6v45Mw6lovuD6rLNpt/AzDtjNU=
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Token Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/service/extension/oidc/{organisationId}/token"}></MethodEndpoint>



OpenID Connect token endpoint that exchanges an authorisation code for access and ID tokens. Client authentication is required using HTTP Basic Auth with `client_id` as username and `client_secret` as password. The `sub` value is resolved during this request, with the identity matching attributes or the callback of the client. The ID token holds the claims `iss`, `sub`, `aud`, `presentation`, `iat` and `exp`, and `nonce` when the authorisation request had one. The access token and the ID token expire after 5 minutes.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/x-www-form-urlencoded"} value={"application/x-www-form-urlencoded-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"grant_type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`authorization_code`]"} schema={{"type":"string","enum":["authorization_code"],"default":"authorization_code","description":"The type of grant being used"}}></SchemaItem><SchemaItem collapsible={false} name={"redirect_uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI to which the response will be sent, must match the redirect URI used in the Authorization Request"}}></SchemaItem><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Authorization Code received from the Authorization Request"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Access (and ID) token response

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Cache-Control</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Indicates that the response should not be cached.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"access_token"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JWT token that can be sent to access protected resources"}}></SchemaItem><SchemaItem collapsible={false} name={"token_type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the token issued (Bearer)"}}></SchemaItem><SchemaItem collapsible={false} name={"expires_in"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of seconds until the login session expires"}}></SchemaItem><SchemaItem collapsible={false} name={"id_token"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JWT that contains identity information about the user"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"access_token\": \"string\",\n  \"token_type\": \"string\",\n  \"expires_in\": 0,\n  \"id_token\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with `error` and `error_description`. The error codes are `invalid_request`, `unsupported_grant_type`, `invalid_client` and `invalid_grant`. The answer has `errorCode` and `errorDescription` when the organisation is not found.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_grant\",\n  \"error_description\": \"Invalid session\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized. The `Authorization` header does not use the Basic scheme.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>WWW-Authenticate</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The authentication scheme that the endpoint accepts.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_client\",\n  \"error_description\": \"Invalid 'Authorization' header format\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not found. The Passwordless Login extension has never been enabled for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The `sub` value cannot be resolved. With `callbackURI` the error codes are `callback_failed`, `callback_error`, `invalid_response` and `missing_sub`. With `identityMatchingAttributes` the error code is `invalid_request`. Other failures give `server_error`. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"callback_error\",\n  \"error_description\": \"The external service returned 503\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Account Information Access extension (TS12)
Source: https://docs.igrant.io/docs/extensions-api/read-account-information-access-extension-ts-12

---
id: read-account-information-access-extension-ts-12
title: "Read Account Information Access extension (TS12)"
description: "Read Account Information Access (TS12) extension"
sidebar_label: "Read Account Information Access extension (TS12)"
hide_title: true
hide_table_of_contents: true
api: eJydVttu4zYQ/ZUBnxJAlrNJn4xg0XSTLtwt2qBO0YfAQMbSWOKGIrXkyI5r6K1f0k/rlxRD+SLbmxTdF1smNYdnZg7PeK1yCpnXNWtn1Uj9RpjDTZa5xjKM7dz5CmVL1igEOHuYvLs8B3phskFCEuUp1M4GCmq0VpcXF/L1/0B3aBt4lajMWSbLgoV1bXQWA4afgwCuVchKqlCeeFWTGik3+0wZq0TV3tXkWXd0dsgTRm5CL2DmnCEU/odcxzaXwyjAsiQuyQOX1GOoA5DFmaFctYnKPOVkWaP5GpdD5DcKoHtLuxIcZlJ7CmQ5vnNLc221PI3z3rmBvbbFybn3vUjYh8I4Mp9r8uDmMcs3GPYSbdu2la5/abSnXI0eT6p8UJdp2wUEyhqveaVGj2t1U+tPJI/TdpooxiIIzuvnq2miKuLS5WqkCoqNRi7VSA0XV8PM2bkuhjsaQ+yABr26DrADEiJ+QT5EHoeVuqXKQbetEtV4o0aqZK7DaDjMqXIDrHWqC4+WU+1UmxwD3HuXN1nk/QrMfyFMGAtti9fCQ7d9TGS6L+9EbkYnmW2RdwLBbiFRWo4qCfN4hMVKdm8aLp3Xf8Zynar3fgzPtAJsuJTOdhcyhYeSYIGmoa2Ing5wnqA7BqomMMwIak9z/UI5LDWX8NRxhCc4s44pArBHbWINaszoPAFKi/QIdgSbwOuVa7yUY/BMq/dPqVzKHwg9eXlfcp/FXz9GHaiR+umPh5PcJIdOHsDumSxwidxxiT/J5rXTlrcp/lqTHd/CB2ctZXxgDqGhkMKEbA6aAcMJ744cXEdkIZx0ZhY9Ke6pZNsv6bqSuyM6llzEFTGLrkgValFGaOraef5+r4ZdQ/XH/dKhjPoKPKrFLgjO/vnr73PxO4TJknIdSsiREeglK9EWBGhzWJDX840Yomh1Jj12C52TT2HM0AQKEMjMB8EtyJMuLOhoDrxKNvHipz2LCQkg5LrQjAaWaAxxPCw4o3OoXQ5MWWmdcYWmkHSGLIpBsLQEQwsy0ittmaKJ4kwbzasIgg07sQRbQOaq2mi0GXVqjOl5KhoT8xFfBoR5Y4zoPtcceVZoLXlpnNEZ2UDSju0dqjErCS7Ti5OaL5fLFON26nwx3MSG4c/jD3e/TO4GEtMmijWbg+aB3LzcZU21NXGVKDGwrl+XF5ffpVfpO4mtXeAKbY/PN0zeAzms94P4W/4abHTM9MLD2qC2wjKWZb3x70e1uOrG/VzL6OpHv+Hi00SVLrDEr9czDPS7N20ry18a8nGwJGqBPiorjplk63di+89iizJuqJZREv0r+uPRP422P3Y+3olz4MZW9pb6HC118yDo2y276mEfu2tHQT5lCHw15Fo6/4lW73evdzuvBuwcvXtbyi3T918Cj3P7
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Account Information Access extension (TS12)</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/account-information-access"}></MethodEndpoint>



Read Account Information Access (TS12) extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read Account Information Access extension (TS12)

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Account Information Access information (TS12)

</div><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Presentation Definition Identifier of the Account Information Access credential"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"credential\": {\n    \"presentationDefinitionId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read age verification with eudi wallet extension
Source: https://docs.igrant.io/docs/extensions-api/read-age-verification-with-eudi-wallet-extension

---
id: read-age-verification-with-eudi-wallet-extension
title: "Read age verification with eudi wallet extension"
description: "Read Age verification with eudi wallet extension"
sidebar_label: "Read age verification with eudi wallet extension"
hide_title: true
hide_table_of_contents: true
api: eJydVttu20YQ/ZXBPiUALbl2nwQjqGu7qZqgDeqkeQgMeMQdkROTu8zuULIq6K1f0k/rlxSz1IWSbKTNi0Ry98z17JldGksxD9wIe2dG5ndCC5cFwYwCTzlH/Q5zlhKotQxzrCoSoEchFxWSmUCx8S5SNKOlOTs91b99ozcfrsfw8QAJuXdTLtqQXJjM5N4JOVE4Nk219j38HNXG0sS8pBr1SRYNmZHxk8+Ui8lME3xDQbiLYOvgVlDa2ANMvK8I1dV+eGNn1RlFmJckJQWQkp4pwtOpcARyOKnImpXGQ5GcJNQ1TdmxPo1tL5QogV1hMjP1oUYxI9O2bI8ie9ezBDtTwJac8JQpqL/uTRZXgdITVv2sMQRcHFl+y1HATyG2TeODkIWNFch7ZjLDQnX8D1Vfp/+t1d45PSgmP1m2fZNXPfBeZRzW9HX4z22N7iQQWvXaDyXhVyvl+JeWg+b3aZtqim3t4251tOuAhk+3SXGKjJS3gWVhRp+W5rLhN6SPd6u7zAgWUQ0qH//o8dHcZaYmKb01I1NQaglKaUZmODsfdodruI1iiAWd9Ols1GmYUYjJ535Frqn20C2bzLShMiNTijRxNBxaqv0JNjzgIqCTAXuzyg4NvAvetnni6jNmvmbhVrBgVzwHj93yYSB3u1Leql505NwUdHcmug+ZYXVVEtrkoqOLuWyl9IH/3NRpP7DLd2N4oAVgK6W2sSvnAN6XBDOsWtJjpZS+37NzD50bqNsoMCFoAk35kWynK/ddjHAPL5wXSgYkIFepBg3m9DIDGhSDA7MjWAMvFr4NWo6TB1q8uh8o/X8kDBR0v+Y+SW8/bQTnl4/vj3LTHDDPKUYQ/0AOpETpYkmv5Gzj2ckmxd8acuNruPLOUb4viLGlOIBbchZYAONR3F1wcJEsa8BZJ/FJO9KayTb90q6nc8hu6jUXnRWYp1lBNbIyY61kP+zYsG0ov9592qdRn4EHtdiC4MU/f/39UmUJ4XZOlmMJFgWBHvMSXUGAzu6PCiUt59pjP2NLYQBjgTZShEjV9CT6GQXiwm1FN1vjDwQoZoBguWDBajN61Vn0FVtovAWhvHS+8gVTzDrdVMYgOJpDRTOqtFfshJJc44Qr1Xg1gq34GkW3575uKkaXU8fGlF6goq1SPhHYAcK0rSrlvWVJcdboHAVtXMU5uZikdnOGGsxLgrPB6VHN5/P5ANPywIdiuMbG4dvx1c2vtzcnilllRliqveaBnjzr87bejESTGRWwrl9np2ffD84H36UJ7KPU6HrxpHsN/q97zR4dlrvrybfckdY8FnqUYVMhO40ylWW5Vu1PZnbeXYKmrCOqjz7S7rvMlD6KopbLCUb6EKrVSj9/aSmk0ZGZGYbEpzRIso3Kqdg/qBiayzynRsdGUq2kige3rlV/xLy+Ub3AtZjshPQhCen6Qa1vltyiZ/tQU7sQ9Fel/0nIhfb7DS1ebbd3K88Ctjre7dYi63z9F68e0G0=
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read age verification with eudi wallet extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/age-verification"}></MethodEndpoint>



Read Age verification with eudi wallet extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

EUDI Wallet extension configuration

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the Age verification with EUDI Wallet extension is enabled"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"Presentation Definition identifier"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityCredentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of supported identity credentials

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the credential is enabled"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable credential name"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"presentationDefinitionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"identityCredentials\": [\n    {\n      \"enabled\": true,\n      \"id\": \"string\",\n      \"name\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read document signing with eudi wallet extension
Source: https://docs.igrant.io/docs/extensions-api/read-document-signing-with-eudi-wallet-extension

---
id: read-document-signing-with-eudi-wallet-extension
title: "Read document signing with eudi wallet extension"
description: "Read document signing with eudi wallet extension"
sidebar_label: "Read document signing with eudi wallet extension"
hide_title: true
hide_table_of_contents: true
api: eJylVs1uGzcQfpUBTwmwXrlOT0IQ1I3dQE3ROlWCHAwDpsjR7sRcckPOSlYF3fokfbQ+STFcrf6coGiqg8Rdcr6Z4XzzjdbKYjKRWqbg1Vj9jtqCDaZr0DMkqjz5CpbENWBnCZbaOWTAR0afxKRQEVMbfMKkxmt1cX4uP/8b1ATP6FmwdNs6MlqwRp+SAK5VMjU2Wla8alGNVZh9QsOqUG0MLUamPpwd5JQ1d+nAYBaCQy2ujmOdeCvOMMGyRq4xAtcI1x+uJvDxJEygBOj1zKFVG/GMCT3nQK9wTp5kNbEHThNH8pUq1DzERrMaq64j+ySGmwMk2EMBWfRMc8Io/j532smDvXZoOAZPZkqV19xFvIlhQRbjl3wf+3o3oMAeBnY4MACB1w2K16GMUw5RV//B0dWu/r0ltMfQG2HS544iWjW+fVK5u418CpXQdJF4pca3a3XZ0luU5d3mrlCsqySmO0/TnmnqrlANch2sGqsKM0s012qsRosXIxP8nKrRzt9oyPBsS1QlTuMCY8o+T7LCJkC/rQrVRafGqmZu03g0stiEM91SSVXUnksKalOcAtzEYDuTy/sVmH9DmLKupJ++Yp767dNA7vZXOZVm6vtluNBdMXX/olAkrmrUNrvIJRury47rEOmPzNQnFb+8mcADrkB3XAtx+x4u4X2NsNCuQwjz3F33Rzj30LuBpksMMyEKzukRba8Y932McA/PfGDMABw1uXwHrTb4vAAsq/IEdgxbw5er0EW5jrMHXL26L4XVP6KOGOW85D7LTz8NPfrzx/dPcpMctDGYEnB4QA9ca+5jyY/obRvI85Diby36yRW8Dt6jOdaQ1GEqYYreAjHo9CTuPjh4mZEl4KLXvyxjeU8VQ72k6rmXyM+D5CJCqk0WUmw0CTNS17Yh8g97NuwKSm/2r45pdMjAk7vYGcGzv//867nIoobpEi2lGqxmDfhoau0rBO0tLDDSfEuGTFoyezEoYcLQJUyQ0M3PUlhgRKoG7eNVsbUX2QUTMb/WLhWgwVJFrN0wT8RZCo4stMECo6l9cKEiTEWv28IYDR6X4HCBTmpFnjFPED0jR7zKILrj0GiW4yY0rSPtDfZszOlFrDqX80lAHjTMO+eE95Y4x9lo7zFK4RwZ9AmlHEMPtdrUCBfl+ZM7Xy6Xpc7bZYjVaGubRr9MXl//Or0+E5tNoZjYHRUPpPMGGRt6UwSsr9fF+cX35Yvyuzy0QuJG+4N4vmFYH9FhvZ/d34K15THjI49ap8lLlPla1lvVvlWLF/0/hDmJOB9Fcqrdd4WqQ2KxWq9nOuGH6DYbef25w5hHR6EWOmY+5UFSDConYv8gYqgujcFWxkZWrayKJ39JNocj5s216IXeisleSB+ykG4Xgj5s+dUB9qmm9iHIt0j/F01eSr3f4urV7ni/81WDnY73p+WSZb7+A6n2iN4=
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read document signing with eudi wallet extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/document-signing"}></MethodEndpoint>



Read document signing with eudi wallet extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read document signing with eudi wallet extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the EUDI Wallet extension is enabled"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"Presentation Definition identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"qualifiedElectronicSignatureProvider"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Qualified Electronic Signature Provider name"}}></SchemaItem><SchemaItem collapsible={false} name={"documentStorageProvider"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document storage provider name"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"presentationDefinitionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"qualifiedElectronicSignatureProvider\": \"string\",\n  \"documentStorageProvider\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read kyc with eudi wallet extension
Source: https://docs.igrant.io/docs/extensions-api/read-kyc-with-eudi-wallet-extension

---
id: read-kyc-with-eudi-wallet-extension
title: "Read kyc with eudi wallet extension"
description: "Read KYC with eudi wallet extension"
sidebar_label: "Read kyc with eudi wallet extension"
hide_title: true
hide_table_of_contents: true
api: eJydVttu20YQ/ZXBPiUATblOn4QgqGu7qeqgNeoEQRAY8Ig7Iicid5ndoWRF0Fu/pJ/WLylmqbvjJuiLRHJ3zpy57JldGkuxCNwKe2eG5k9CC9cfLmDOUgF1lmGOdU0C9CDkou7KTKDYehcpmuHSnJ2e6t8hzrvWopCFq3eXI3h/hJAcFN5NuOwCSo9ZeCfkRKGwbWsu0sLgU1S8pYlFRQ3qkyxaMkPjx5+oEJOZNviWgnDPZuvkVlC6uGcw9r4mVFeHVEfOqjOKMK9IKgogFT1BnCOQw3FN1qzUM0Vykohe0oQd69PI7jmNEtiVJjMTHxoUMzRdx/YRh5s9JNhBAVtywhOmoP76N1lcBEpPWO/HhyHg4hHyG44CfgKxa1sftCQbFCj2YDLDQk38jvyuw/+/ed05PUomfzVth5AXe8YHmXHY0LfNf+0adCeB0KrXfSrJfrXSzv7ccdD4Pm5DTdzWPu5Wj3YdNdzXy6R2ahmp6ALLwgw/Ls15y9ekj3eru8wIllEBr52fwwffBbjooviGgrnLTENSeWuGpqRUFJTKDM1g9mLQH6TBlsdguiiMegozCjE5OkzDJTUe+mWTmS7UZmgqkTYOBwNLjT/BlnMuAzrJ2ZtVdgxwE7ztitSgT8B8C+FWsGRXPmUe++VjIne7/N2qHPQducni7iD0HzLD6qoitMlF3yPmvJPKB/6y0Z1DYuc3I5jSArCTSmvXq1AObyuCGdYd6VnSPr4/wLmH3g00XRQYE7SBJvxAttfR+54j3MMz54USgATkOuWgxYKeZ0B5mR/BDmFt+HLhu6DpOJnS4tV9rj3/M2GgoPs19nF6+2WjMr+9f/soNo0Bi4JiBPFTciAVSs8lvZKzrWcnmxD/aMmNLuHCO0fFoQrGjmIOt+QssADGR7x7cvAyISvhrFfwJBhpzWSbemnV0+FjN/Eai44CLNIooAZZO2MtXz/tumFbUH69+3TYRvsdeJSLrRE8++evv5+rFiHczslyrMCiINBDUaErCdBZmFHgyboZUtNyoTX2M7YUchgJdJEiRKonJ9HPKBCXbqu02dr+SHViBgiWSxasN1NWnUVfs4XWWxAqKudrXzLFrBdL7RgER3OoaUa11oqdUNJoHHOtwq4g2IlvUHR74Zu2ZnQF9d2YwgtUdnWKJwI7QJh0da19b1kSzwado6CFq7kgF5O+bs5Qi0VFcJafPsr5fD7PMS3nPpSDtW0cvBldXP1+e3WiNqvMCEt9UDzQk2d90TWbOWgyowLW1+vs9OzH/EX+Qxq7PkqDbo9PurVMF8V/31oOOmC5u3B856Vn3a1CDzJoa2SnXFLwy7UcfzSzF/1NZsI6ffatVZTvMlP5KLpxuRxjpHehXq308+eOQhoEmZlhSI2SxkK2kS9V8amqnDkvCmp1BCQ5SnJ3dFta7Y+L11cqBLhWiZ1CTpNCrh8UfbPkFnvYx2LZU9Bf1fSvmrzUQl7T4tV2e7/ypMFWoPvdmledlv8CCpmzOA==
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read kyc with eudi wallet extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/kyc"}></MethodEndpoint>



Read KYC with eudi wallet extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Updated EUDI Wallet extension KYC configuration

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the EUDI Wallet extension is enabled"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"Presentation Definition identifier"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityCredentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of supported identity credentials

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the credential is enabled"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable credential name"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"presentationDefinitionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"identityCredentials\": [\n    {\n      \"enabled\": true,\n      \"id\": \"string\",\n      \"name\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read OIDC Client
Source: https://docs.igrant.io/docs/extensions-api/read-oidc-client

---
id: read-oidc-client
title: "Read OIDC Client"
description: "Retrieves details of an OpenID Connect client. The client enables passwordless login with EUDI Wallet by requesting verifications from individuals. The client configuration includes presentation definition that specifies which credentials to request - appearing as a QR code or deep link on the authentication page. The answer holds `clientSecret` and `callbackSecret` in clear text."
sidebar_label: "Read OIDC Client"
hide_title: true
hide_table_of_contents: true
api: eJztWd1uGzcWfpUD3mwCjGU7cVtACIp1bW+hNt1k7Ri5aI3MEXkkseaQU5IjWWvobp9kH22fZHHIGWn04yRNsdiL3Vwkknh4eH6+85tHoShIr+uonRVDcU3Ra5pTAEURtQngJoAW3tRkR5dw4awlGUEaTTYO4N2M2s9AFseGAtQYwsJ5ZSgEMG6qLSx0nMHV7eUI3qMxFGG8BE+/NRSitlOYk9cTLZFFCDDxrgJtlZ5r1aAJW49IZyd62vhEC9pK0yh+01MgG/Oviiba6vQxzjBCqEnqiaYAi5mWM5CeFNmo0QSIrhMEjgDrmtCzRBgA4W/XIJ0icB4UUQ1G23tITAmwiTPmkYWGGqeU5UQbFuRh5owKUGapb0h6iiWgVVBKNGaM8r77UVuQhtBDpIc4EIWo0WNFkXwQw58fd9zDT4wu2SdxbRRRCM1nNcaZKITFisRQ5LOREoVgDbUnJYbRN1SIIGdUoRg+irismTZE1lqsVndMHGpnAwU+f3Fywv9sy3CRXdHiQxRCOhtZjuGjwLo2rVGOfw1M/rj/nBv/SpLFrr2ryUedH2u1+SRd39mXa1+P1L5CxWdY709hDSpSTwFpAOdPYmxMxtlpghJGqFyI4GzHfSBWnUc+Rzim3HHuqti48osU3HDIkPs8LiHR7nPypLQnGW+vR6HHCb3HJQMxUhUOIOvQE3M0WkHHEJgjTJzvPZhDquxIPjRel20+4gB0Xofsji6Gq4b/wihnyQdZ+groAWU0y+QMNMYtSL3xeqrtH1VhQWNwmRM/tnSNh14IpAe7gL+9Hn2e6W+vR4yknKwQytCMSzZWQ7DQxsCYQKKRjcFIKiUVT7Hxlr9I6bziDBZdsiMjdgu5A7iq6riExYxsz9LQBApQ6pQY4/InNqG20/MYvR43kUI5+MX2tfkCLDWBVIoSKbk08ONlzzjlAK7bRJWl2zoEHSBQjqenpTyUPFCpFKho3m6lkU+49xwqrNmpm3IB+eGJJp/CXRrUFXDaDVk5DKlIpJrG/sp47sTNwNR2OoArlDO4p+WGIxeczUvDbJ25jB3eby6Pfnj/rkdSZBLlJCvSkVXKyS0i5xlCmSRjiAnh/cuLHlmOs3yss2eUi0eBuBYxyFjHDlJZay7pui2whxml4OPTRD8m6Spqvc6I/jgQt3DxixWFoAesapPyaOPtkBqlh7VWw1MxFFShNmK1KkT0aAPKVBow4rnM3txHaYUPr8lO40wMT89ODqGW63HWIJ+NW+lzS9MaownkQWcFeg1OkRzfigzlazeFfCdlCGeNtgRjtPcpYhsb983xVLmZYQDroKcoKIy4YyTx6ScZ8vf6y6vmPS2ZRViGSNVPaHFKfWZj5wyh3eM2soqzY+rGKM6on+9TkCd+R1VmyPi1LnL93TnoGkK01kXOiU2tElZTu2YokkrJov35vJ+rtI00JX9Q06g3JdhgiC3fbfWL3CHeWv2QLoSIVc32DiSdVaHvitNvzr45Of3qxckJp09PXyxNusv+/oOinH59crLKfwoxI1Sp1XwUFyhndHThbPTOHGzc1gDZ4My6oxCdp/0EunF0CiKWuOstIcxcYxS0npP8MHuLBTrLLedn95Sb5vZnQd47f+EUsYj8+bIn0V3xib5yc/uQb9YqnyVH7rH/qJW+QwXa1k2EdXcvWgdsG40J22Ym59K3/WnqdUo99BDJhjT/hGTCPHkpHh427sy2PP0ftuWtbZvEv5M6YJqz32WaXXWjjkmat97NtSIPSYm9GL7iX7uhsI3bdpTubg4OG+/z8nIiTWPqTsnRNrXXH1owlQWU1sUPE9dYVXKOLAP5OfkPiUMpOjd8UB/3w74InjA4u+7cs/DJHb2S3aok1jKIg+91syWjOpMd8Oseza5vv/qdKcRZejNJw/Z/0sur4nHN7/ztqDPU3UE79Z3zhKlGNpK3aCDTbgx/IBMfoNxeV2CAch2z7aZiNyzL3JzoddH1xG1sblY2WO77gvsDko3XcZnse17rH4k/3rHeEae84xA7u6XsX84xFcWZU2IoppRSDC84huJ4/vI4j+zH61R47LSSx7kiHj92A/NKFK0lD+1SLqlyrUlEIRpvxFDMYqzD8PhYUeWOsNYDPfVo40C75L9tBm+9U01uwZ5g8ykONxGnPC08cT3k411B7jZWvWEQ56zR2XYz0OYf2u1QdstmP3Te5sYUFHuIZoDyfLK959pr7wnKLT4l5GfyID5OXexEP/BExyvAMssIJTyzLlJiED1qk2xQo6TnBdBgOthhO4T24ituZtkcR/e0/LZMDd53hJ4807Pu4/TtL85XGMVQ/PD+3cGk1c2g7p7spj/JX8mq2mkbdyK5g2e//IaGwgBuyCoOCw6iHbmzcPAqcWaB2+1b6pDTmViXUvZ6GmK0nbgugaFMCSxPOEMRmrp2Pv55g4a1Q/X3m5+2YdRH4I4t1pfg2b/+8c/n3FEg3CxI6TBLcwXQg5yhnVLKCf1NbQKtlr3gh1E7vgUyk6Pg5uRJT+16AC7a+9yt9LewBSAoPdURDSzygpgfC473Q7VTEEnOrOPBi0KR2520pQVLCzA0J8O+4v4i1VEca8PzNjPBJroK05pZuqo2Gq2kjMaknqcpL1LS5llbQJg0xjDulY5JzgqtzYnNaEk2pDTdxVDNnSu8GJzs2XyxWAwwHQ+cnx63d8Px69HF1V9vro74zmpTYDZ+4MhTTjZVN/yJQnACy/56cfLibPBycMp3axdihbYnzzWhgjejy4suh+64u1cT/7/o/68v+tuw56/HtUGd9msJRY9tqftZzF/m/fpE5ya4TT2iEFzwRLfZFYUYrrfEd4WYuRD5+uPjGAPderNa8c+/NeRT9S3EHH2Kw1wXdUgThBhO0AT6CGqedSu65/DEf0Uc1KqrSJbLUaofYihEIXiH0PuvitXdeiJNcuXjcympjr2Le93cqt8rfH/FKR/berCphfepFrYfes3etlC7ZTGLkHcdT1x5xSH7Iy2/XZPnkycvrEtxpmYT3a1Wq38DnzWxew==
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read OIDC Client</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/oidc/client/{clientId}"}></MethodEndpoint>



Retrieves details of an OpenID Connect client. The client enables passwordless login with EUDI Wallet by requesting verifications from individuals. The client configuration includes presentation definition that specifies which credentials to request - appearing as a QR code or deep link on the authentication page. The answer holds `clientSecret` and `callbackSecret` in clear text.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the client","in":"path","name":"clientId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Client details

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Cache-Control</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Indicates that the response should not be cached.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>client</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client's configured presentation definition. A presentation definition belongs to at most one client."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"redirectURIs"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The valid redirect URIs for the client. The `redirect_uri` of an authorisation request must match one of them exactly."}}></SchemaItem><SchemaItem collapsible={false} name={"allowedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The web origins of your application."}}></SchemaItem><SchemaItem collapsible={false} name={"callbackURI"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI at which a `sub` value will be calculated and returned according to the sent presentation. Empty when the client uses `identityMatchingAttributes`.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"callbackSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret used to access the `callbackURI`. Required when `callbackURI` is set."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityMatchingAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A map of credential identifiers to claim paths used as linking values for identity matching. Each key identifies a credential: the `vct` of an SD-JWT credential, the `doctype` of an mdoc credential, or a `type` value of a W3C credential. The value is the dot-separated path to the claim within that credential. The value of that claim becomes the `sub`. Empty when the client uses `callbackURI`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataAction"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 140 characters`"} schema={{"type":"string","maxLength":140,"description":"The text that describes the login to the user in the EUDI Wallet, for example `Log in to your online bank account`. Empty when the presentation definition has no transaction data.\n","example":"Log in to your online bank account"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client's key"}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the client is system-managed or not. A system-managed client cannot be updated or deleted."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The time of the last update of the client, as a Unix timestamp in seconds","example":1747015200}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The time of the creation of the client, as a Unix timestamp in seconds","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"client\": {\n    \"presentationDefinitionId\": \"string\",\n    \"name\": \"string\",\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\",\n    \"redirectURIs\": [\n      \"string\"\n    ],\n    \"allowedOrigins\": [\n      \"string\"\n    ],\n    \"callbackURI\": \"string\",\n    \"callbackSecret\": \"string\",\n    \"identityMatchingAttributes\": {\n      \"urn:eudi:pid:1\": \"email\"\n    },\n    \"transactionDataAction\": \"Log in to your online bank account\",\n    \"kid\": \"string\",\n    \"systemManaged\": true,\n    \"updatedAt\": 1747015200,\n    \"createdAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The Passwordless Login extension is not enabled.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Client not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Client not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The answer has `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"server_error\",\n  \"error_description\": \"Internal server error\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Payment Authorisation - (for Banks) TS12 extension
Source: https://docs.igrant.io/docs/extensions-api/read-payment-authorisation-for-banks-ts-12-extension

---
id: read-payment-authorisation-for-banks-ts-12-extension
title: "Read Payment Authorisation - (for Banks) TS12 extension"
description: "Read Payment Authorisation - (for Banks) TS12 extension"
sidebar_label: "Read Payment Authorisation - (for Banks) TS12 extension"
hide_title: true
hide_table_of_contents: true
api: eJztVk1v20YQ/SuDPSUARTlOT0IQ1LHTwE3QGlWKHAIDHi1H5MTkLrM7lKwIuvWX9Kf1lxSz1LftBm3TWy82qd1583bm7RsuTUHRBm6FvTMj8wthAVe4aMgJnHVS+cARdREG8GTqA7xCdxufwvvxs1OgOyEXNTIzgWLrXaRoRktzenKi/74VtvVOyIlCYtvWbFPU8FNU3KWJtqIG9UkWLZmR8ZNPZMVkpg2+pSDcs9pCjgWli3sBE+9rQk11SPnSFZqMIswrkooCSEU7asARyOGkpsKsMtP2ZzsPVJATxjo+xOkww/uKHqnJVaBITvqXC5qyY32M9461SYuh2KX+ejW42NsTJbAr77H7W8zgMuWeMgWthsOGvnWGdzihWsE3Vf96Cz/sNe7hZLuiHfRzpZr+3HHQNB/74+wSX+/6fWat7/bb/n/t/+var453HF/tBy9jiltlJpLtAsvCjD4uzVnLb0kfr1fXmREso+I9zHbPpMx1ZhqSyhdmZEpKLUapzMgMZ8+H1rspl8Mtq+GazQD38QYcY0fBKKMwoxATocMSXlDjoV82melCbUamEmnjaDgsqPEDbDnnMqCTnL1ZZccAV8EXnU30H4H5GsJYsGRXPhYe++VjIte7Oo/Vn3vhb6q9lQ72P2SGNVVFWKQUvYDNuvxfUrnuyevs6hJuaQFaVO1xPxZyUE+dYd0R+GnS3s0Bzg30aaDposCEoA005TsqYM5SwU3PEW7gifNCCUACcp1q0KKlpxlQXuZHsCNYB75Y+C5oOQa3tHh5k+udeUUYKOh+Pfskvf3gQ4NiRubHD+8fnAtoLcUI4m/JgVQoPZf0Sq5oPTvZHPHnltzlBZx758jKwYiKHcUcxuQKYAGM93j35OBFQlbCWT9S09VOaybb9Eu7nu4nu6nXs+hsRptmMzXIqozYta0P8v1ODduG8pvdT4cy2lfgUS22QfDkj99+f6pOgTCeU8GxggIFge5sha4kQFfAjAJP12JIomWrPfYzLijkcCnQRYoQqZ4Oop9RIC4dcLIJWWTreLUasDv3yACh4JIFa5hjXZOkZNHXXEDrCxCylfO1L5li1luZKgbB0RxqmlGtvWInlEYBTrhmWSQQ7MQ3KLrd+qatGZ2lXo3peIHKrk7nicAOEKZdXavuC5bEs0HnKGjjarbkYjL/zR1q0VYEp/nJvZrP5/Mc03LuQzlcx8bhu8vz1z+NXw80ZpUZYakPmgd68wpvu2YzKExm1MD6fp2enH6XP8+fpW8iH6VBt8fnn38GHqhiufsq/BeQa1UL3cmwrZGdck5FWq79/KOZPe8/QaesI3Q/+i9d/TozlY+iCMvlBCP9GurVSn/+3FFIEyczMwxJaWn+ZBv/0zFwqzZpzqylVodL8rPkl0ffv6v9QfTmtToJrm1mZ7G3yWLXD4q+WXKLPexjt+0p6F8dCg+GvFAlvKXFy+32fuXRgK3D97u14DqW/wRV3meh
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Payment Authorisation - (for Banks) TS12 extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/payment-authorisation-issuer"}></MethodEndpoint>



Read Payment Authorisation - (for Banks) TS12 extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read Payment Authorisation - (for Banks) TS12 extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Payment Authorisation Presentation Definitions

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Authorisation Credential is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Authorisation Credential is enabled"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"paymentCredentials\": {\n    \"paymentCardCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentAccountCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Payment Authorisation (for Merchants) TS12 extension
Source: https://docs.igrant.io/docs/extensions-api/read-payment-authorisation-for-merchants-ts-12-extension

---
id: read-payment-authorisation-for-merchants-ts-12-extension
title: "Read Payment Authorisation (for Merchants) TS12 extension"
description: "Read Payment Authorisation (for Merchants) TS12 extension"
sidebar_label: "Read Payment Authorisation (for Merchants) TS12 extension"
hide_title: true
hide_table_of_contents: true
api: eJztVs1u4zYQfpUBTwmgyNmkJyNYNE3SRbrbNqhT7CEwkDE1lrihSC05suM1fOuT9NH6JMVQ/k+CtNjtrRdbEjnffPPDbzhXBUUdTMPGO9VXvxEWcIOzmhzDecuVDyaiLMLB2Af4mYKu0HE8hNvBmxOgRyYXxTZTgWLjXaSo+nN1cnwsf98OXXvH5FhAsWms0cmu9ykK8lxFXVGN8sSzhlRf+dEn0qwy1QTfUGDT8VpDDhi5jVsGI+8tobjaJX3tCnFGEaYVcUUBuKINNTARyOHIUqEWmWq66C4CFeTYoI3Pcdr1cFvRC1m5CRTJcfdySWPjjDzGJ2Gt3GIoNq5fz4YptvZEDsaVT9j9K2ZwnXyPDQXJhsOavrWHDzgiK+CrrL9ewo9bhXve2SZpO/VcSFd/bk0QN3ddOBvHw029z7X27XbZ/8/9f537xf6O/aP97GFMdotMRdJtMDxT/bu5Om/Me5LH4WKYKcYyCt4/Eio1zFRNXPlC9VVJqczIleqr3uS0p70bm7K3ZtZbMjrCbcyjegmnhFeYUIiJ1m4iL6n20C2rTLXBqr6qmJvY7/UKqv0RNiY3ZUDHufFqke0D3ARftDoF8QLMawgDxtK48iXz2C3vExlusj0Qle7af5XzdQNh9yFTRlxVhEVy0bWxWhbhS0rYkyY7v7mGB5qBpFUq3Q2HHERZJ2hbAj9OHXi/g3MPnRuo28gwImgCjc0jFTA1XMF9xxHu4cB5pgTAAY1NOWhQ02EGlJf5HmwfloZnM98GScfRA83e3udycn4gDBRkv8Q+Sm8/+lAjq7766ePts9MBtaYYgf0DOeAKueOSXskVjTeOVyH+2pC7voQL7xxp3hlUsaWYw4BcAYYB4xPeHTk4S8hCOOsGazrgaU1lq3pJ1dMpNW7sJRaZ0KjThKYajXRGbJvGB/5+0w3rgpp3m0+7bbTdgXu5WBvBwV9//HkoeoEwmFJhYgUFMgI9ykkqCdAVMKFgxstmSE1rtNTYT0xBIYdrhjZShEh2fBT9hAKZ0oFJYsGzbGkvggN6oyEZIBSmNIwWpmgtcXIWvTUFNL4AJl05b31pKGadoEnHIDiagqUJWamVcUxpIODIWMOzBIIt+xpZtmtfN9ag09R1YwovUNnaFE8E4wBh3ForfV8YTjxrdI6CFM4aTS6mEbA6Qw3qiuAkP36S8+l0mmNazn0oe0vb2PtwfXH1y+DqSGwWmWLDdqd4ICev8LqtV+NCZUoErKvXyfHJd/lp/ibdjHzkGt0Wn6+5Du70xXxzO/wq0GVnMz1yr7FonPBOiZovVf1OTU67y+jYyDDdtn5F24eZqnxkwZjPRxjp92AXC/n8uaWQpk+mJhhSv6VZlK1UUIbBg4ilOteaGpkTSdWSau7dhRfbA+ndlegJLsVmI7QPSWiXD4K+WnKzLex9ze0oyK+MhmdNzqQf3tPs7Xp7t/KiwVrnu92SchnRfwOgf3Bp
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Payment Authorisation (for Merchants) TS12 extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/payment-authorisation-merchant"}></MethodEndpoint>



Read Payment Authorisation (for Merchants) TS12 extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read Payment Authorisation (for Merchants) TS12 extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Payment Authorisation Presentation Definitions

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Authorisation Credential is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Authorisation Credential is enabled"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"paymentCredentials\": {\n    \"paymentCardCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentAccountCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Payment Credential Issuance (TS12) extension
Source: https://docs.igrant.io/docs/extensions-api/read-payment-credential-issuance-ts-12-extension

---
id: read-payment-credential-issuance-ts-12-extension
title: "Read Payment Credential Issuance (TS12) extension"
description: "Read Payment Credential Issuance (TS12) extension"
sidebar_label: "Read Payment Credential Issuance (TS12) extension"
hide_title: true
hide_table_of_contents: true
api: eJztV9uOE0cQ/ZVSP4E0O16WPFkIZQMEOaAExSAe0Epb7inPFNvuHrpr7DWW3/Il+bR8SVQ9vi8XiSjJCy/2eLrr1O30qfbKVJRs5FY4eDM0vxNW8AqXM/ICTyJV5IXRwSilDr0luPd6/ODiPtCtkE9qU5hIqQ0+UTLDlbk4P9evf45qgxfyomDYto4tKtjgfVLElUm2oRnqkyxbMkMTJu/JiilMG0NLUbiPZwc5FpQuHRhMQnCE6uo42JGv1BklWDQkDUWQhvahAScgjxNHlVkXpu2z2ieVPhXTkQffOXca5gbmTaK4h/p6dlwd7EkS2dd38vlS3Q/ePaUpe1YbGOV3U6aoGXqc0b/h5SVOyKmDbTW/3pq3Bw35ksPDFq2VoB86jurhXZ/N3ufVQQsxVt9r///U/tLa0HlJ3+v/n9Z/fbrjVC0/qW/Zbl2YRLaLLEszfLcyly2/IH28Wl8VRrBOiveFQM1VYWYkTajM0NSU+4vSmKEZzB8ObPBTrge7eAabOM54a67+45xiyu6Pa/WUZgH6ZVOYLjozNI1Im4aDQUWzcIYtl1xH9FJyMOviFOBVDFVnc6s+A/M1hLFgzb7+nHnql08DudpXdawDrmf6trY7jmD/ojCsrhrCKrvo2WouO2lC5I95YN7h0eWrEdzQErCTRlvSz9USXjcEc3QdQZhmkl0f4VxD7wZmXRKYELSRpnxLFSxYGrjuY4RruOeDUAaQiOxyDVq0dL8AKuvyBHYIG8NHy9BFLcfZDS0fX5d6OH4ijBR1v+Y+yb9+DnGGYobml7ev7+SmOaC1lBJIuCEP0qD0seSf5Ks2sJdtir+15EdP4UnwnqwczfjUUSphTL4CFsB0J+4+OHiUkTXgor+T5DOc10yx7Zd2PZ9G9tOguejlBm2+3NAMWZmRurYNUX7cs2HXUH6+f3VMo0MGntRiZwT3/vrjz/uqCwjjBVWcGqhQEOjWNuhrAvQVzCnydEOGTFq22uMw54piCSOBLlGCRG56lsKcInHtgfOplmWxsVdhAbvXigIQKq5Z0MECnSPJzlJwXEEbKhCyjQ8u1Eyp6IVLGYPgaQGO5uS0V+yFsvbjhB3LMoNgJ2GGotttmLWOs/xlNub0ItWdy/kkYA8I08455X3FkuOcofcUtXGOLfmUlX57hlq0DcFFeX6n5ovFosS8XIZYDza2afBy9OTZr+NnZ2qzLoywuKPmgZ68KthOdWx7NlXA+n5dnF/8UD4sH+RLZUgyQ38Qz7fcoI/4sNpfqL8JbMNkoVsZtA7Za5y5MKuNbr8z84f9vX3KOiMPre+o91VhmpBErVarCSZ6E916ra8/dBTzHCnMHGNmVJ4qxVbnVO5vVA7NpbXU6uDIupV18eSPwvpwyDx/poqBGznZS+lNltLNg6Jvl/zyAPtUVfsQ9FPF/5Mmj7TjL2j5eLe9X/mswU7J+91aZB22fwPXB8mD
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Payment Credential Issuance (TS12) extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/payment-issuance"}></MethodEndpoint>



Read Payment Credential Issuance (TS12) extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read Payment Credential Issuance (TS12) extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentUserCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Credential Issuance is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Credential Issuance is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountsCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Credential Issuance is enabled"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"paymentCredentials\": {\n    \"paymentUserCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentCardCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentAccountsCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Photo ID Credential Issuance extension
Source: https://docs.igrant.io/docs/extensions-api/read-photo-id-credential-issuance-extension

---
id: read-photo-id-credential-issuance-extension
title: "Read Photo ID Credential Issuance extension"
description: "Read Photo ID Credential Issuance extension"
sidebar_label: "Read Photo ID Credential Issuance extension"
hide_title: true
hide_table_of_contents: true
api: eJylVttuGzcQ/ZUBnxJgvXLtPglGUDd2AzVFa1Qp+mAIMEWOdifmkhtyVrIi6K1f0k/rlxTD1dWKUwR9kVZLzpkztzNaKYvJRGqZgldD9TtqC3d14ACjG3gb0aJn0g5GKXXaGwR8YvRJbhcqYmqDT5jUcKUuzs/l6//gmeAZPQuMbltHRgvM4GMSrJVKpsZGyxMvW1RDFaYf0bAqVBtDi5GpZ7KDHLPmLh0YTENwqMXVMc2Rt+IMEyxq5BojcH1ADSgBej11aNW6UGYXxpe4HCN/NXbysxCbHORJEHsnNzgjT3JpZA8cJo7kqxOHB372hjDK72aEEcIsB7clptbr9VpK+amjiFYN70/ydxTxZN0bJDRdJF6q4f1KXbf0HuVxsp4UinWVBOdrsatJoRrkOlg1VBXmImqu1VAN5pcDE/yMqsGOyKAVKLJntDUXAnGOMWX/xym4wSZAf6wK1UWnhqpmbtNwMLDYhDPdUklV1J5LCmpdPAe4i8F2JifuBZj/QhizrshXL5mn/vg5kck+rWPp9b4TtsndVV73LwpF4qpGbbMLrxs5ve64DpE+b9vqmNj13QgecQm641pK0o9YCR9qhLl2HW774+EI5wF6N9B0iWGK0Eac0RNaWBDX8NBzhAd45QNjBuCoyeUctNrg6wKwrMpnsEPYGF4tQxclHWePuHzzUMqY/Yg6YpT7Evs0//opz4saqp///HASm8SgjcGUgMMjeuBac88l/0Rv20CetyH+1qKX7gzeo+GjcU8dphLG6C0Qg04nvHtycJWRhXDRy1NWmXymim29pOpKZkbmPc928KxN1jlsNElnpK5tQ+Qf9t2wKyi92786bqPDDnyWi50RvPrnr79fi4JpGC/QUqrBataAT6bWvkLQ3sIcI802zZCblozUOMzJYixhxNAlTJDQzc5SmGNEqjxQnmpeFht7UUjYa0UqQIOlilg7WGjnkLOzFBxZaIMFRlP74EJFmIpeYqVjNHhcgMM5OqkVecasjXpKjniZQXTHQaTTV2BC0zrKipq7MYcXsepcjicBedAw65yTvrfEmWejvccohXNk0CeUcmxnqNWmRrgoz09yvlgsSp2PyxCrwcY2DX4Zvb39dXx7JjbrQjGxOyoeyOTZYLoGPW9nUwSsr9fF+cX35WX5ndi2IXGj/QGfb1ujR52w2m/Vb4TZdC/jEw9ap8kLt5yM1Uar79X8sl/bM5JNdGh9otiTQtUhsVitVlOd8I/o1mt5/anDmJdHoeY65i7Kq6TYaptI/KNIoLo2BltZFlmrshY++5+wPlws725FJfRGQvby+Zjlc/Mg6NsjvzzAfq6kPQX5FMH/osmVVPk9Lt/srvcnLxrs1Lu/LUmWDfsvj41ZGQ==
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Photo ID Credential Issuance extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/photoid-issuance"}></MethodEndpoint>



Read Photo ID Credential Issuance extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read Photo ID Credential Issuance extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Photo ID Credential Issuance information

</div><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Definition Identifier of the Photo ID"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"credential\": {\n    \"credentialDefinitionId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read PID Credential Issuance extension
Source: https://docs.igrant.io/docs/extensions-api/read-pid-credential-issuance-extension

---
id: read-pid-credential-issuance-extension
title: "Read PID Credential Issuance extension"
description: "Read PID Credential Issuance extension"
sidebar_label: "Read PID Credential Issuance extension"
hide_title: true
hide_table_of_contents: true
api: eJydVttuGzcQ/ZUBnxJgvXLtPglBUDd2AzVFa1Qp+mAIMEWOdiemyA05K1kR9q1f0k/rlxTD1V0xGvRFWi05Z87czmitLCYTqWEKXg3V76gt3I9u4V1Ei55JOxil1GpvEPCZ0Se5WKiIqQk+YVLDtbq6vJSv/wllgmf0LAi6aRwZLQiDT0lg1iqZGudannjVoBqqMP2EhlWhmhgajEw9iR3kmDW36cBgGoJDLa6OGY68FWeYYFkj1xiB6wNqQAnQ66lDq7pCmV0YX+NyjPxS2ORnIc5zfGf89/i3OCNPcmlkD3wljuSrM18HfvaGMMrvZoQRwizHdT+6VV3XdVK7zy1FtGr4cJa1ozgnXW+Q0LSReKWGD2t109AHlMdJNykU6yoJzgsRq0mh5sh1sGqoKsxV01yroRosrgcm+BlVgx2HQUP2gram4jcuMKbs9jjoW5wH6I9Vodro1FDVzE0aDgYW5+FCN1RSFbXnkoLqilOA+xhsa3KqXoD5L4Qx64p89ZJ56o9PiUz22RxLY/e13+Z0V2vdvygUiasatc0uvJ7L6U3LdYj0ZdtIx8Ru7kfwhCvQLddSjn6eSvhYIyy0a3HbEY9HOI/Qu4F5mximCE3EGT2jhSVxDY89R3iEVz4wZgCOmlzOQaMNvi4Ay6o8gR3CxvDNKrRR0nHxhKu3j6XM1I+oI0a5L7FP86+f8oSoofr5z49nsUkM2hhMCTg8oQeuNfdc8k/0tgnkeRvibw166czgPRo+mu3UYiphjN4CMeh0xrsnB28yshAuei3KkpLPVLGtl1RdyajIhOdpDp61yaKGc03SGaltmhD5h3037ApK7/evjtvosANPcrEzglf//PX3a5ErDeMlWko1WM0a8NnU2lcI2ltYYKTZphly05KRGocFWYwljBjahAkSutlFCguMSJUHyhPNq2JjL3IIe4lIBWiwVBFrB0vtHHJ2loIjC02wwGhqH1yoCFPR66l0jAaPS3C4QCe1Is+Y1VBPyRGvMohuOYhY+gpMmDeOsobmbszhRaxal+NJQB40zFrnpO8tceY5195jlMI5MugTSjm2M9RoUyNclZdnOV8ul6XOx2WI1WBjmwa/jN7d/Tq+uxCbrlBM7I6KBzJ5Nph2jp63sykC1tfr6vLq+/K6/E5sm5B4rv0Bn29el0dNsN5vz29H2PQs4zMPGqfJC6OcgvVGnR/U4rrfzDOSjXNofaTRk0LVIbFYrNdTnfCP6LpOXn9uMeYtUaiFjrlv8s4otmomov4koqdujMFGVkNWp6x+J38DusM18v5OdEFvRGMvmE9ZMDcPgr498qsD7FPt7CnIp0j8V03eSF0/4Ort7np/8qLBTq/725JgWaX/ArXpSK8=
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read PID Credential Issuance extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/pid-issuance"}></MethodEndpoint>



Read PID Credential Issuance extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read PID Credential Issuance extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

PID Credential Issuance information

</div><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Definition Identifier of the PID"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"credential\": {\n    \"credentialDefinitionId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Recurring Payment Mandate (TS12) extension
Source: https://docs.igrant.io/docs/extensions-api/read-recurring-payment-mandate-ts-12-extension

---
id: read-recurring-payment-mandate-ts-12-extension
title: "Read Recurring Payment Mandate (TS12) extension"
description: "Read Recurring Payment Mandate (TS12) extension"
sidebar_label: "Read Recurring Payment Mandate (TS12) extension"
hide_title: true
hide_table_of_contents: true
api: eJztVs1u4zYQfpUBTxtAkbNJT0awaJqki3S3bbBOsYfAQMbUWOKGIrXkyI5r+NYn6aP1SYqh/J8YQVu0p15sSeTMfDPf8BvOVUFRB9Ow8U711SfCAj6RbkMwroRbnNXkGH5EVyATvLkbvD09AnpiclEsMhUoNt5Fiqo/V6cnJ/L3T31q75gciytsGms0iqvelyj+5irqimqUJ541pPrKj76QZpWpJviGApsOzdrlgJHbuGUw8t4SSqhdqDeukGAUYVoRVxSAK9pAAxOBHI4sFWqRqabL5DJQQY4N2vgSpt0IdxVJLXT7Yi1uA0VynNKFKxobZ+QxPkttFRpDsQn/ekVMsbUnsmB4hvAwUwfQwU2KPzYUpCoOa/o3onzEEVkJsGLgdTo/b5F4OOCmgDv8LqS3v7YmSKj7Lq1N8OGG/wutfbvdBv/z8F/ysNjfsX/sXzyoyW6RqShwDM9U/36uLhrzgeRxuBhmirGM4u8gYjXMVE1c+UL1VUmJZuRK9VVvctbT3o1N2Vuj6YWVn+MlnuN66UdghAmFmFDs1u6Kag/dsspUG6zqq4q5if1er6DaH2NjclMGdJwbrxbZvoPb4ItWJ+oOuHnNw4CxlPQPmMdueR/IcFPcgQh21/mrEq97BrsPmTISqiIsUoiue9VFy5UP5tfUhc/66uL2Bh5pBthyJcR2cyIHEdkJ2pbAj1PTPez4eYAuDNRtZBgRNIHG5okKmBqu4KHDCA/wxnmm5IADGptq0KCmowwoL/M9t31YGp7PfBukHMePNHv3kMth+Y4wUJD9kvsovX3vQ42s+uqHz3cvDgrUmmIE9o/kgCvkDkt6JVc03jhepfhzQ+7mCi69c6R5Z2bFlmIOA3IFGAaMz3B34OA8eRbAWTdj05lOaypb8SWsp0Np3NhLLjKsUadhTTUa6YzYNo0P/O2mG9aEmvebT7tttN2Be7VYG8GbP377/UjkAWEwpcLECgpkBHrSFbqSAF0BEwpmvGyG1LRGC8d+YgoKOdwwtJEiRLLj4+gnFMiUDkzSBp5lS3vRF9AbycgAoTClYbQwRWuJU7DorSmg8QUw6cp560tDMev0SzoGwdEULE3IClfGMaVZgCNjDc+SE2zZ18iyXfu6sQadpq4bU3qBytamfCIYBwjj1lrp+8JwwlmjcxSEOGs0uZiUf3WGGtQVwWl+8qzm0+k0x7Sc+1D2lrax9/Hm8vqnwfWx2CwyxYbtDnkgJ6/wuq1XE0JlSgSs4+v05PSb/Cx/my5JPnKNbgvPX78P7nTDfHM9/Buull3M9MS9xqJxgjEVZb4U73s1OevuoGMj83L3sntIwoeZqnxkMZ/PRxjpl2AXC/n8taWQZkqmJhhSW6UJk63ETjT/UTRRXWhNjYyRJF5JHPduv4vtkfP+WmQDl5qy0dPHpKfLB/G+WnKzLd/70tpBkF+ZAC+anAvtH2j2br29WzlosJbzbrdUWwbvn5gJX1c=
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Recurring Payment Mandate (TS12) extension</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/recurring-payment-mandate"}></MethodEndpoint>



Read Recurring Payment Mandate (TS12) extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read Recurring Payment Mandate (TS12) extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Reccuring Payment Mandate Presentation Definitions

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Recurring Payment Mandate Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Recurring Payment Mandate Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Recurring Payment Mandate Credential is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Recurring Payment Mandate Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Recurring Payment Mandate Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Recurring Payment Mandate Credential is enabled"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"paymentCredentials\": {\n    \"paymentCardCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentAccountCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read Risk-based Authentication extension (TS12)
Source: https://docs.igrant.io/docs/extensions-api/read-risk-based-authentication-extension-ts-12

---
id: read-risk-based-authentication-extension-ts-12
title: "Read Risk-based Authentication extension (TS12)"
description: "Read Risk-based Authentication (TS12) extension"
sidebar_label: "Read Risk-based Authentication extension (TS12)"
hide_title: true
hide_table_of_contents: true
api: eJydVsFu4zYQ/ZUBTwkgy9mkJyNYNN2kC3eLdrFO0UNgIDQ5lrimSC05suM1dOuX9NP6JcVQtmPZaxTbSyKLnMc3b4ZvtBEaowqmJuOdGIlPKDV8MnExmMmIGu4aKtGRUZI3wMXj5M31JeALoYsckYmAsfYuYhSjjbi+uuJ/34W5B9uii0wo7wgdMZSsa7vdOfwcGW8joiqxkvxE6xrFSPjZZ1QkMlEHX2Mg07HZI09IUhMPAmbeW5RMv0917DQfhhFWJVKJAajEA4YmAjo5s6hFmwkVUHMi0n6Ly5EIZ/M3bu5DdajvSSJ1wIiO0p57nBtn+GmsD46NFIwrTo79eBAJr6EwTsTnBgP4eUryPMGDNNu2bbnkXxoTUIvR04nGPVWmbRcQUTXB0FqMnjbirjYfkB+n7TQTJIvIOGePF9NMVEil12IkCkxVllSKkRgub4bKu7kphnsWw7DHGcg+DtMISwwxsejLdI+Vh25ZZKIJVoxESVTH0XCosfIDWZvcFEE6yo0XbXYM8DF43agk1xmY/0KYkCyMK86Fx275mMj0VdwJ34quX3YS77tDdi8yYfioEqVORzhZ8SoL7oP5utOpT+zu4xgWuIa+nDk8lghLaRvcddBzD+cZumOgaiLBDKEOODcvqGFlqITnjiM8w4XzhAmAgjQ2aVBLhZcZYF7kR7Aj2Abern0TWI7BAtdvn3O+kD+hDBh4P+c+S79+TpdLjMQvfz6e5MY5SKUwRiC/QAdUSuq4pJ/odO2No12Kv9foxvfwzjuHinrGEBuMOUzQaTAEMp7w7sjBbUJmwllnZMmP0prIdvXiqgu+OWwOnAs7olTJEbGShjsjNnXtA/342g37gpr3r6/6bXTYgUda7IPg4p+//r5kr5MwWaE2sQQtSQK+qFK6AkE6DUsMZr6zCG5ao7jGfmk0hhzGBE3ECBHtfBD9EgOawoFJ1kDrbBvPXnpgMDEDCdoUhqSFlbQWKR0WvTUaaq+BUJXOW18YjFlnxtwxEhyuwOISLdfKOMLkoHJmrKF1ApENefZZV4DyVW2NdAq7bkzpBSwam/KJYBxImDfWct9rQ4lnJZ3DwIWzRqGLyOXY3aFaqhLhOr860Xy1WuUyLec+FMNtbBz+On738NvkYcAxbSbIkO0VD/jmaa+aaufgIhNsYF29rq+uf8hv8jccW/tIlXQHfL5/6Pa6YfM6g//HN8G2iwlfaFhbaRxzTKJstub9JJY33aCfG55avS+KsxY+zUTpI3H4ZsM7/gi2bfn1lwZDmimZWMqQ2ipNmGxnduz5C/ZEcacU1jxGknklczz6xGgPR877B7YNufWUVz9dJD/dPjD6bsmtD7CPrbWjwH95Anwz5JbL/gHXb/fbu5WzAXs773az2jx4/wWrJnFh
sidebar_class_name: "get api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read Risk-based Authentication extension (TS12)</h1>

<MethodEndpoint method={"get"} path={"/v3/config/extension/risk-based-authentication"}></MethodEndpoint>



Read Risk-based Authentication (TS12) extension

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Read Risk-based Authentication extension (TS12)

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Risk-based Authentication information (TS12)

</div><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Presentation Definition Identifier of the Risk-based Authentication credential"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"credential\": {\n    \"presentationDefinitionId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Toggle extension
Source: https://docs.igrant.io/docs/extensions-api/set-extension-enabled-state

---
id: set-extension-enabled-state
title: "Toggle extension"
description: "Enable or disable extensions in the platform. For example, enabling the OpenID Connect extension allows users to log in without passwords using their EUDI wallet. To enable the OpenID Conformance extension, the wallet makes its signing keys in the local key store; when the HSM partition of that key store has no room for a new key, the answer is `507`."
sidebar_label: "Toggle extension"
hide_title: true
hide_table_of_contents: true
api: eJztWNuO47gR/ZUCn7oBtdw7FwzgHQzS092TOJtNBn1BHmYbcFksydymSC1J2e00/LZfkk/LlwRFSrZ86dnsywbB5sWWxGLdWXWKz0KSL5xqgrJGjMW1wZkmsA6k8vGRngIZr6zxoAyEOUGjMZTW1Tl8sg7oCetGUwbEW5WpIs3fGjKTK7i0xlARtkwAtbZLD60n5yFY0LZivksV5rYN0KD3S+skU3S8lIPr+6sJLFFrCjnc2SSK9gSxSmiKgcZZpEj7oMZH8qCCB68qw7wfabWxSdsCNX8BH6yjb2E5p7Typ9vvoUEXFHsIbAlhjmFLCXP0YCw4a2sorQMEQ0teT9LR+CU5UB6mb8/fTXORCduQQ+Y2kWIsPIXrXuHkfXkbMJDIRIMOawrkvBh/ed6L1N2cYHKVFBrYLDKheLnBMBeZMFiTGIvN8kSKTDj6qVWOpBgH11ImfDGnGsX4WYRVw+Q+OGUqsV4/JGLy4aOVK6YorAlkAj9i02hVREtGP3pW6vmQlZ39SEVgYxzbHRR5Xk0RlAPCmbWakPXvMqrXbtfsiZEsk0PJlis/yC1+6fiu10Mzv2zkPazXack31viky6vzc/7blXPbFgV5X7Zar6BtJAaSu54G34Xpt3bJOhM1BZQY8N7pY2GLNs4JZUydZ357c/7NrwrfjvOcs+7SSjY2Pl8NXPWQ/ZJdm91bTZUJVJEbWvbm/Hx9hP2BdYMt4iNKUKaJdaM7Kr31u9G8N9iGuXXqH8QHYN81b37Hrrkhb1tXEBgboLStOXTQ23RAfqcOmphAzqAGT25BDqKYIz56d1hEJsa3ZakKRSbAbbAOKxq/1FXoP2kqOdxxzVM+deJ9Dsr4gFrHwEQZJ0eaG/c8hDk6uURH4KlonQorqK1sNZ1m3P1529Vne7UrAgdMbAkr2zqwrkKjfBTJ2hEEegqx4d0dGPoVu26otguC1rSeZJTToHIeTh7r1LKJZTVzNB608uGU1azUgvY8UbNyLCCfwkVkH9wKSlQ6+cxjzZhgNR62506v6Q0Ftzq7KAO5aQbegrTxXHgyqfp33RCwQmVgRmUvjQ0uHVECRcdikfBAav7WHY2Yiz5Ieh44ojN3P/Jbe6NkPBK2gzhlIElTOCKkh3jb7Z2TVRhKurV1b0pEhnyMQh96ZPd1yM0uTfw47pZ9gMsLOJl+QqW5odqIy4aLY/h62uR5Pj1NvpTUaLvqPTk0sAd9Q0Ed9QA0SlWpgLon5oTcYTK5gvdKfhgnmYBdDhSOMFA6Dx6NnNmn3X1HpB6j6/jmcAHOtoESsuRU91AgQ2Vv+wxXvk/VeGzMrsC4sXOSpBJbnRDqikIGMyqw9XSIhZMLt9T8XirnAwRVd9qoAIZIMnDOfw3U+V9uAQOSHfFvz98dkyD+y2VOHKC9dSb6oh4Hh4tGfUf8+MCAPmDF84T4Hg1WBJvhg0NRU5hbnkqaNkaCh4ixGC1ejwprSlWNNuh39DyYKdaCJXJ3PDapXFFtu+YpMtEyZBXzEBo/Ho0k1fYMG5WryqEJubJine0z+OysbIto9gtsfonDbcCKR74Xtvu0vK/Iw9aPt5zZKSF7b24yC9OHbvBKgdiOXhcd8IwnReyDi4vPk5gEDE/JhO5ApT66QN1SX92mO3ymkMRA3foAM4LGUameSMZBGqZJR5jCibGhK68OVRzPfYMFd3nKq3yP7Ri6je+5ZbA7zh5p9WGai3UmPhI6ckzPts/i2yeeuYMYiz///e7ANrYB4xQFwT5SV6aiLvGVjGysMqE38cU7A+V9Sz6HW+7CKgD6A72TcvA+cv4Qx+xYjOIYFdfEptBw1OOAyGXrZjveXg9OfT+LdfOWMqXtITAWsf5RjYpzyLdNY134wzZvNqFXf9x+2k24Ya7ueW2zCU7+9fM/TxlXINwuSSo/B575gJ6KOZqKYkNakFNllzYxvVXB2WAXSpLLYRL4qsWDJ12eebsgR6oyoCQnW1hl3f54nVI4ip9R+wxwvzuyMG+1ktBYCYGKubHaVor84OonFTpNC9IcVa7TsZjjTGmGmMwE22BrDExe2LrRKl7axLyN5jmqWt3hiohU0wyOrVQh6lmjMeQ4xFoVZHyMWH/aGizmBK/y8wOfL5fLHONybl016vb60V8ml9d/vb0+4z3rTAQV9E7wgM+otEVbkwn9KeZSl+L16vzVm/x1/g3vbawPNZqBPne2qvTu9YzcbU+blvr/u7ff4O6tKwEMSUeNRmU4bG26RUnd7otYvE5Ip1QJLmxDNx7eoz1kYm594B3PzzP0dO/0es2ff2rJxXabiQW6eLhSW0xhlWJcovb7V1vDVDi56fDTKbx8z3fUlr4nGW5IsYOIsRCZeOSWtXMPuH7YwIaoXaK4TDqc3TGfLYcDtMc9Nu24KApqwldph8ji8z13ill3nVhHZCUcLvleEpdiLH4QP4h4SxpLQAST/P1ZaDRVixXTJ7Zcw7HrR9te/Bh7cffAhh11yX5bTrbwL1t2dMt7LgTf0erDhjytvLhhAwUSNQeI7x//DfUHPCM=
sidebar_class_name: "put api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Toggle extension</h1>

<MethodEndpoint method={"put"} path={"/v3/config/extension/{extensionId}"}></MethodEndpoint>



Enable or disable extensions in the platform. For example, enabling the OpenID Connect extension allows users to log in without passwords using their EUDI wallet. To enable the OpenID Conformance extension, the wallet makes its signing keys in the local key store; when the HSM partition of that key store has no room for a new key, the answer is `507`.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the extension","in":"path","name":"extensionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true,"description":"Indicates if this extension is enabled"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Successfully updated the extension state

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"metadataUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"enabled\": true,\n  \"metadataUrl\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"507"} value={"507"}><div>

Insufficient Storage: the HSM partition of the key store has no room for a new key. This is the partition of the installation HSM (the local key store in a hardware security module), or the DPoD partition of a key store of your organisation. The text is `The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.` A new try fails the same way: the answer has no `Retry-After`, so do not send the request again before room is free. For the installation HSM, the operator of the installation removes the unused key pairs or gives the partition more room. For a DPoD partition of your organisation, delete unused key pairs in the partition or give it more room. Some operations put the text after their own text: the test CA (`Failed to make the test CA: The HSM partition has no room ...`), the deploy of the organisation wallet (`Failed to deploy the OpenID digital wallet for organisation ID <id>: ...`) and the create of a sandbox organisation (`Failed to deploy sandbox organisation: ...`). A route that signs can also give this answer for an organisation that has no default key yet, because the wallet makes the default key the first time that it needs it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 507,\n  \"errorDescription\": \"The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update age verification identity credentials with EUDI Wallet extension
Source: https://docs.igrant.io/docs/extensions-api/update-age-verification-identity-credentials-with-eudi-wallet-extension

---
id: update-age-verification-identity-credentials-with-eudi-wallet-extension
title: "Update age verification identity credentials with EUDI Wallet extension"
description: "Update the identity credentials for age verification using the EUDI Wallet extension"
sidebar_label: "Update age verification identity credentials with EUDI Wallet extension"
hide_title: true
hide_table_of_contents: true
api: eJy9V81uGzcQfpUBTw2wklynJyEI6thuqyZtjTpuDo4Aj5ajXcZcckNyJauCbn2SPlqfpBhyZa1WcuJLe5GXP/PLb+Ybr4UknztVB2WNGIubWmIgCCWBkmSCCivIHcVP1B7m1gEWBAtyaq5yZDFovDJFlLm8uZjAB9SaAtBDIONZbSYCFl6Mb8VZQfBHR1RMM+Hoc0M+vLFyJcbruFSOpBgH11AmcmsCmcBHWNe6FRx98uzvWvi8pAr5K6xqEmNhZ58oDyITtbM1uaDI8+k2mvNdMMeE9rPxC9Zg58cy0e7NFTkPwQIZnGmSMNccaSZQSsVKUF913Jij9tT3rFay48nMWk1oDly5IudZHUxaw23uLzCg2GSiRu9r68JzVLVXO+FEDaUNdnLxHAV8EyYXPQVY0N7bfl3RWR9JXYWbrIOF25imTpg7fw8NT/uyxx5/utmka762xqenOD054T/HSkIex/ZhMeTWzFXRuOTK/4RfdA5XB+l9p3xg/G5dInm0qEUmVKDqaD30nejc8cEpUxwYPT9WIwwPgxV9XfynpkIzcISSC6pbcVF+k4m21J4Br4mRnG7ysCwplORij+oWsd8W7gHcItqiyZ3F6ebZwNpkwlPeOBVWYny7Fme1ekv8Od1MM1FRKK0UY1E3MckYSjEWo8XLUXqq0SO+RljQoIuv0dbkoFMrbMwtyPloaz8JF1RZSMciE43TYizKEGo/Ho0kVXaAtRqqwqEJQ2XFJusruHJWNnnE9hNqvqbhOmDBDPGEuE/HfUemuxRec5EkCG4TuYN+2siEYlMloYwmEtrEWRNK69Sf22rs9Z+rCdzTCrAJJacypXgI70uCBeqGuHoYM3d7eu4gmYGq8QFmBLWjuXogCUsVSrhLPsIdfGNsS6bBodIxBzXm9CIDGhbDntoxtIKvVrZxnI7BPa1e3w0Z9W8IHTm+z7HP4uoH6yoMYix+/vD+IDaOAfOcPPPTPRkIJYbkS1ySkbVVJmxD/K0mM7mAc2sM5d0Op7xvyA/hmowEFQD9gd/JOXgVNbPDWeprsTjjGc8A6b341WO1cQf8fcf9lw9Y1Zq+0OsiUaahYMd27XrLXWl5wES8zTaVmVtWxU0Z89iUqULFaPRNzRq/3yHwEUTqx93WPnS7qO/l/1EIvvnnr79fcK9BuF6SVL4EiQGBHvISTUGARu5zCBeKyhlXdqEkuSFMAjSePHjS84G3C3KkCvPYzrNWvtczfQYIUhUqoIZloi425q1WEmorIVBeGqttochnqRkyShEMLUHTgnQcgEygSAQ4U5rZg5VgE2yFga/ntqq1QpNTqoAYnqOi0TEeD8oAwrzRmmtNqhD9rNAYcgwWrXIyPr79tm5rzEuC0+HJQc6Xy+UQ4/HQumLUyvrRu8n55a/XlwOW2WQiqKD3Hg+42qXNm4pM2PYDbprpvU5PTr8bvhx+G0ch60OFpuNPOxcfsP3RITnm4KlReA8l69148J+N3qnsAj2EUa1RGQ4wZnTdEs+tWLxMg8pcMSF3pfv0w332CAFNM1FaH1jXej1DTzdObza8/bkhF3kvEwt0EaCRBbNtq2bGuueOLs5TKgbv2WO+rpvU4HtTExNMkjjLc6rDF+922fbqhtvkrP1Ho7KSRRwuRRZ/x+Kj+ChEJmx8ndhz4v5aaDRFgwXfT2q5mWDbjHdEdB+JqP3gwLZHZtVxss9JKRb+5ciOirxi7L6l1evH6+nkSYFHHky3+dV5LvkXL1TnGA==
sidebar_class_name: "put api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update age verification identity credentials with EUDI Wallet extension</h1>

<MethodEndpoint method={"put"} path={"/v3/config/extension/age-verification/identity-credential"}></MethodEndpoint>



Update the identity credentials for age verification using the EUDI Wallet extension

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Map of identity credential identifiers to enabled flags

</div><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Personal Identification Data"}}></SchemaItem><SchemaItem collapsible={false} name={"passport"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Passport credential"}}></SchemaItem><SchemaItem collapsible={false} name={"photoID"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Photo ID credential"}}></SchemaItem><SchemaItem collapsible={false} name={"ageVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Age verification credential"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Updated EUDI Wallet extension age verification configuration

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityCredentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of configured identity credentials

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable credential name"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the credential is enabled"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"identityCredentials\": [\n    {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update KYC identity credentials with EUDI Wallet extension
Source: https://docs.igrant.io/docs/extensions-api/update-kyc-identity-credentials-with-eudi-wallet-extension

---
id: update-kyc-identity-credentials-with-eudi-wallet-extension
title: "Update KYC identity credentials with EUDI Wallet extension"
description: "Update the identity credentials for KYC using the EUDI Wallet extension"
sidebar_label: "Update KYC identity credentials with EUDI Wallet extension"
hide_title: true
hide_table_of_contents: true
api: eJy9Vs1uGzcQfpUBTwmwllynJyEI6shuqzptjTpGEDgCPFqOdhlxyQ3JlawKuvVJ+mh9kmLIlbX6ceJD0Yu0u5wZzgy/+T6uhCSfO1UHZY0YiNtaYiAIJYGSZIIKS8gdxUfUHqbWwdXHITRemSKaXd5ejOADak0B6CGQ8RwpEwELLwZ34srYBXy0jYNh44OtyIlxJhx9aciHt1YuxWAVX5UjKQbBNZSJ3JpAJvAS1rVWOXJ+/c+ek1wJn5dUIT+FZU1iIOzkM+VBZKJ2tiYXFHle3ZQw3FZwzGm3Bb9iDXZ6rPz221SR8xAskMGJJglTzbVmAqVUHAT1dSeNKWpP+5nVSnYymVirCc1BKtfkPIeDUbtx6gNcYECxzkSN3tfWheeEak075cQIpQ12dPGcAGwJo4udAOusc3R3sapOVtvw433LYyczXq+Tma+t8alPZ6en/HcMpPI49CI8c2umqmhcbJf4n/CEzuHyoG/vlA+Mp01KJI9OlsiEClQdxed+Eh0bH5wyxcGmw2OY5fM2WNG33X9uKjQnjlAywLsTEP3XmWih/wzcjIzkdpOHRUmhJBdZoztUfjNIB3iKcIpbbnccr5+NpXUmPOWNU2EpBncrcV6rK+LH8XqciYpCaaUYiLqJTcZQioHoz1/101H1HyHVny3z/maXkw7+Ob6bk/Mx/G7dF1RZSMsiE43TYiDKEGo/6PclVfYEa9VThUMTesqKdbYf4NpZ2eRx3p8I860INwELpukn3H1a3k9kvO3aDc9FQt2md1u0pw+ZULxVSSjjFglg4rwJpXXqz80A7iZ2fj2CGS0Bm1ByK9M49uB9STBH3RAPDMPkfifOPaRtoGp8gAlB7WiqHkjCQoUS7lOOcA8vjG1FLDhUOvagxpxeZkC9orcXdgCt4+ulbRy342RGyzf3PQb6W0JHju259kl8+9G6CoMYiF8+vD+ojWvAPCfPEjEjA6HEkHKJr2RkbZUJmxJ/r8mMLmBojaG8y2PK+4Z8D27ISFAB0B/knZKD1zEyJ5wlKovzGNdYiNN58anHAWPS+2Mrv5cPWNWavkJvUauSLm8Fp33fyAe/cnBlppZ9mHAxj4RLFSqGnW9qdv1hC7VHtKiftp92MdqF916jH53gxT9//f2SeQThZkFS+RIkBgR6yEs0BQEaCXNyWwHliVA5A8jOlSTXg1GAxpMHT3p64u2cHKnCPFJ11vrv8aHPAEGqQgXUsEhKxJt5q5WE2koIlJfGalso8lkiOoYjgqEFaJqTjpcNEyiSPE6UZmXgINgEW2Fg89xWtVZockpQj+U5Khod6/GgDCBMG615qKQKMc8KjSHHqNAqJ+PjIW8GtMa8JDjrnR70fLFY9DAu96wr+q2v778bDS9/u7k8YZ91JoIKeufwgMda2rypyITN4DM7pvM6Oz37vveq9128dlgfKjSdfNqLJ4v30YtnLPupu+YOMFZbtf8vr7NpigI9hH6tURkuI/Zt1UrHnZi/SleNqWJJ7XrPljkz5REJGWeitD6w+2o1QU+3Tq/X/PlLQy6KVSbm6CLyonRlG7JlzZkxJ4thKvjkPSfJ5rpJFL131WGJSB7neU51+KptVyKvb5noJu1tvbKSXRwuRBZ/B+KT+CREJmw8g8ga8ftKaDRFgwXbp7DMEtjS6VZKZlFK2gcubLNklp0k91Ul1cK/XNlRl9cMyitavnk0TytPOjwqWbLmg+bLxL/agpwL
sidebar_class_name: "put api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update KYC identity credentials with EUDI Wallet extension</h1>

<MethodEndpoint method={"put"} path={"/v3/config/extension/kyc/identity-credential"}></MethodEndpoint>



Update the identity credentials for KYC using the EUDI Wallet extension

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Map of identity credential identifiers to enabled flags

</div><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Personal Identification Data"}}></SchemaItem><SchemaItem collapsible={false} name={"passport"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Passport credential"}}></SchemaItem><SchemaItem collapsible={false} name={"photoID"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Photo ID credential"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Updated EUDI Wallet extension KYC configuration

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityCredentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of configured identity credentials

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable credential name"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the credential is enabled"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"identityCredentials\": [\n    {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update OIDC Client
Source: https://docs.igrant.io/docs/extensions-api/update-oidc-client

---
id: update-oidc-client
title: "Update OIDC Client"
description: "Updates the configuration of an existing OpenID Connect client. Allows modification of the client's name, presentation definition, transaction data action, redirect URIs, web origins, identity matching attributes, or callback configuration. A presentation definition belongs to at most one client. System-managed clients cannot be updated."
sidebar_label: "Update OIDC Client"
hide_title: true
hide_table_of_contents: true
api: eJztWltvGzcW/isHfNkEGMuXpFtAKIpVbW9Xbdq4kY08xIZFzRxJrGfIKcmRrDX0tr9kf9r+ksUhOVeNbCdpgW63frKGt3P9zoV8YAmaWIvcCiXZkF3lCbdowC4RYiXnYlFoTmOg5sAl4L0wVsgFvM1Rjs/gVEmJsYU4FSjtAEZpqtYGMpWIuYirlW47N+UvBiTPMIJco0Fp/ZQE50IK+jcCq7k0PPbfueXg/49AYyI0HXb1bmwiWOMMlBYLIU0EIkFphd1Axm28JAK5tVrMCosmAqUh5mk64/Fdm6sBjPYRAjNMlVwYsAq4hUwZC0pixelkYyxmBxmXfIFJ+Gwg5lIqCzOEwokyGbCI5VzzDC1qw4YfHjoiv1wijM/aUmIREzSWc7tkESOJsSHzY+OERUzjL4XQmLCh1QVGzMRLzDgbPjC7yWmusVrIBdtub/xkNPYblWxoRvv4kYUUeWAuEDFXpEaS4lxgmhjICuN4yrVaiQQTmCvtGaRJNd1DmBKt0wimTbGeVVIdJzTWUPEZt3zk/qOBUsWkYfrNiQ5M3no105dS0T8EPY8qNdNoqeWrd+OpU3v1ZYKxRjsdXMse6cVKWpL68IHxPE+D4R7+bEhCD7vCVbOfMSYltUU5QZmAkunGC9GLziqIl1wucACjuUXtxrxtNATnJbzkKwS857FNN6U+HuO4xSHxDGthl3uYzrXKUVuBhjjxJtU1ly5HZJs0s2OdW9qtX73P27O2933eZxUUBp2d2aUwlduNbcPFMMvtJgIuk0f3crL1S8ilnUdLZZeo620fp2bJDfBdZLKY5Sm3GLnF5a/KW6apWgh5q4W5u22svZVK3lpzfOL11z9pOoAfFcQanfZ5ChnfQKwy9CoW1oBay12SXlxOjk+GkPNNRma15mmKlsAQjWcrAqPmds01An1BmhbBT+eT0WkEk9NR80xSpHk5BFPES+A7AgkyzAudK0PWzCU4bghWJa73ilMYWPFUOHwEvuBCGutE+BiMV2reEyDaNko2vyVPrwGlYZpca74hkLWYmR7U7LPZVvjpHAY0oUKv20KLaQiYvLBLpYXxMghI7C3E8diA3ax0/QER0Ia+z6S9ESvpsI0qNDSQzh24H2f6kI8nidMlTy9auPIEMSPIeE4kNKzMHzwXqD1aplxkQJHPEAQkwA2kQt6RNax4WqBxqLBjKgM45/ES7nBT70heW580dCqbrmJbamdydvDd+8vGFO/J00TFxEg5LUtU3JqkNHCY+imOJjcR3r86bUzzVuGHhU+pEmUPDFI6QJZPPBLH3pCIa/JtIcmT7J6NnKnQqJs/Q4IEv/fUFLPpAL4VK3RGhdLqjRMVklyaApduwdnpT2/glwL15gkw9ueTYCukJcqdEbuEEEqa6y0HcH7PszzFIUwfrlmh5RCLRAxzkQyPr9kQrhlmXKTXbDslNQce3Ldp4C5QdTE+a1K/R/kTtC4ZERY0ZmqFphMaifZuZIS5VlkHNSKGnnIy5zbdbOiJZtttxBqbPy/oXb0bUya5XgqHpk5fQatrkaYUMWKexkXqYVEmoNEWWtKPOFY6ET52Ebmkppa6BnBlkGz1H5eXFxNAmeRKlMhU/gKNMYpVEHZzuSEVcrh4O7msQIoocDrm0qxR+8BDMaMwcHJ05MY5fDd5+yN4WPA2sFSU9gRr7NPKYwlNjz4aovZae560jZvrEYQCfhyjCUbWNIsBvAvJIKyXKDs2IwwYtA4ee3PWPlIyfv8G5cIu2fD49VEfaRbvg6z82CwoxMXOUsOFQV166vnV2Rjeu1AeeY/2FgrTN2oBfo3DdCVTIRFmXN45mymkLSFBWM/gZ6Q5pE7SufSJF3iWn7etVDv7etts8OaUlFtT1VvHr48oedY8ptqp45zsad7Z1v1RGmByJY0PUSdHR7tl0KlPw0PRxj6jJmjn2SFjfnLer5VPV1V2WedSnNkH659a/JI/fG4BURWzn8RgvcMnYMLOTr9ilujy2k6u6IuYP1Sy+HsLfucOkCokCkW1yyseize/o/jyZ/r9h0i/HzPEll18RKb5P5x6dMTxsRnCJ0T8iN2JT4+ad7ihLYxr7v7ge7uNzWZKpcjlzm5jmRA6oiFWXVOkoXxy8nazWGlqR1H8NX1d5N0mMq1IMEXXT95GLHweNbFKSIsL1L2cWlGH4JSavaEB2WI/Apf+XUlx7xYYy7Oc5G0wVjIxTVUcf/n6y6PjL06Ojgg+NX4yNW7tTvfm40k5/uvR0bZM95bIE9dsf2CnPF7iwamSVqu0N3GrDKS2M6kOjFUadwG0VrRzIuv6Qj63BLNURZqERiPEdDBpiwh67VPOZ+eUSuLbubsr6AK/FdaReOE78RpQa7Ur5nP6WhZuQbThyqZcSYb0UO03uhiHrejGoIFL/iMp1KU2tyErIXnRyG2nBe7sGZ68FWFeUe3F3/CkTHo85uYlk54RE9rb7uBQ0O8QMa3RZqaSDXkfHe3zMl+s6lCjSuWb9NEOXu+4bJiy/1aDlviqiOSeauTJppVFtxrOUScZKNsR5SYuxHWJWjvzcncEM2WXHkWecUnQanz4nISEG4yDoNdL8VQl2JTqWa9QL7gxa6WTlNKdNy5s4L1FaUJjl4SNks9Sf/VVu6L3g+OP8oP6ouYDq2gsTa9BH7uJnqiv6tV9GFXZ+2sHaDvbP4oWZLZC5oWF6p6Pbfvs+0qGBP+frsLsiub1R4nmtwSGXuE9L6a6qRCrBDvpQgc/6LZOKns7V4VM/EWIQb1Cfeu9m217AeY5JGjkRsmq6gqoRjLugbWKhj2AFvoCZNV+Wo9ed+Z0dfvF/wv8X+65mhEGdKsMeiwR7GaBvbGiqrVb2cPeRwXPuEilKf0X06Bx7us8Z11OAL4IkUAYoiVPg+GrOC60xoRyO7eKpyHY2NoyheyLWx6VSRE90e5pbBZV2qhdv9824mcXiCnDxbjQwm6clY1y8T3SvzekfcsX9E6BdZ54eCsnpM3QLlVCzxMKB7T0SGHIDlevDn3T6bAKCIdKJPGhj1+HD2XLZ8vofHL2vvcQZ5gp8MMsYoVO2ZAtrc3N8PAwwUwd8FwMxEJzaQdCOStub3ChVVJ489mzzVM7TCxfUL27Z7nxw11CbmqpTsiVPXaWsq1bMv5DeOHh1VK/8RiFCOFMeMevyTrcPUxhl2TMoSPTLVARpq19puCPabzjwLm4J2d0JuZphCm8kCo8S7Cai9TJIOcxvowAB4tBZ9shhIVfUTlG4ji4w83XU1eifINco6b5xPvM/fq70hm3bMi+e3/ZC91lF0XdoawzbP+zusRo41lpns0kxBRoQrNaWColunR74uArtzMRHF7QuBrPjbEqoSCtuzKccPpd/ZTmvAbJoLsqJu1v5tZz2j3HD+XAzW4zrzn2eJdoXw+h06+rieg2vuqRPT2HZ5bgQs5VGfF47CKeJ2XITJHnStu/1Y5T2b74tv7U9rims3bMploEL/7zr3+/pFDDYbLGRJilj0F47x/gOPhcoa5fppF/i7iBk/S8xPVqDKbzA6NWqFEsZNXtisJ6Sm8bHSIT0esIsRCWp9WTC5mAUVR05CoBi/FSKuqy0Hs0lx+71w3umUSKK0zJrF0wocSLz0RKzTV3xVZYlfmHVrHK8lRwGYdXII49jQvqmtaXePMiTQkiEmEdnRmX0seAVMQoTdNkRzmVqXAyONqR+Xq9HnA3PFB6cRjWmsM349PzHyfnB7RmW2cktR4IpBIVF1npAixihPVeXydHJ68HrwbH7hGRMjbjskGPf38Ib8dnp2XA6Si8kUb9+VrxN3mtGHCPWoWHecqFa5E723gIsf4DW73yV2Rz4WuhgL0sYhTxWXk5wyI2rC56biK2VMbS8oeHGTd4pdPtlj67FwOUfkRsxbXzLp8YCOMKSTac89TgI5bwouyyv4Q97yl7uSpDsqR47AIoGzIWMWoDNt5bbm+qppKjyw+f+tMPLmmTevlOak/5hV8xcvebj85tplcXVxQlZ+HZZuaKV6b5mqIHX7Mhu2bXRK1yAnERwH1/YCmXi4IvaL7fluIXD7G4zkPuXB4S/mmUG215dFMSz4vvlO5Z8hVhwPe4+bqa7kf2LqjSID+btHOz3W7/CwMo2P0=
sidebar_class_name: "put api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update OIDC Client</h1>

<MethodEndpoint method={"put"} path={"/v3/config/extension/oidc/client/{clientId}"}></MethodEndpoint>



Updates the configuration of an existing OpenID Connect client. Allows modification of the client's name, presentation definition, transaction data action, redirect URIs, web origins, identity matching attributes, or callback configuration. A presentation definition belongs to at most one client. System-managed clients cannot be updated.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the client","in":"path","name":"clientId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

At least one of the following fields must be provided for updating the client: `name`, `presentationDefinitionId`, `transactionDataAction`, `redirectURIs`, `allowedOrigins`, `identityMatchingAttributes`, `callbackURI`, or `callbackSecret`.


</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the presentation definition to use for this client. It cannot be empty, and the presentation definition must not belong to another client. If the presentation definition has a transaction data template, the template must be `login_risk_transaction_non_ts12` or `login_risk_transaction`. No credential may come with its own transaction data (TS12: payment wallet attestation, software statement, QESAC, SCA credential types): such a definition has another purpose than login. A new presentation definition is validated against the identity matching attributes and the transaction data action of the client.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"redirectURIs"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The redirect URIs of the client. The `redirect_uri` of an authorisation request must match one of them exactly."}}></SchemaItem><SchemaItem collapsible={false} name={"allowedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The web origins of your application."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityMatchingAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A map of credential identifiers to claim paths used as linking values for identity matching. Each key identifies a credential: the `vct` of an SD-JWT credential, the `doctype` of an mdoc credential, or a `type` value of a W3C credential. The value is the dot-separated path to the claim within that credential. The value of that claim becomes the `sub`. Give one entry for each credential in the DCQL query of the presentation definition. The key and the path must exist in that DCQL query. Example: `{"urn:eudi:pid:1": "email"}` uses the `email` claim of the PID credential for identity matching. Setting it removes `callbackURI` and `callbackSecret` from the client.


</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"callbackURI"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI at which a `sub` value will be calculated and returned according to the sent presentation. Use an HTTPS endpoint. The endpoint receives the presentations in a POST request and must answer with status 200 and a JSON object that holds `sub`. Setting it removes `identityMatchingAttributes` from the client.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"callbackSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret used to access the `callbackURI`. Required when `callbackURI` is set."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataAction"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 140 characters`"} schema={{"type":"string","maxLength":140,"description":"The text that describes the login to the user in the EUDI Wallet, for example `Log in to your online bank account`. Give it when the presentation definition has a transaction data template. Send an empty string when the presentation definition has no transaction data. The EUDI Wallet accepts at most 140 characters.\n","example":"Log in to your online bank account"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Client updated

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Cache-Control</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Indicates that the response should not be cached.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>client</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client's configured presentation definition. A presentation definition belongs to at most one client."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret of the client"}}></SchemaItem><SchemaItem collapsible={false} name={"redirectURIs"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The valid redirect URIs for the client. The `redirect_uri` of an authorisation request must match one of them exactly."}}></SchemaItem><SchemaItem collapsible={false} name={"allowedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The web origins of your application."}}></SchemaItem><SchemaItem collapsible={false} name={"callbackURI"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URI at which a `sub` value will be calculated and returned according to the sent presentation. Empty when the client uses `identityMatchingAttributes`.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"callbackSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret used to access the `callbackURI`. Required when `callbackURI` is set."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityMatchingAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A map of credential identifiers to claim paths used as linking values for identity matching. Each key identifies a credential: the `vct` of an SD-JWT credential, the `doctype` of an mdoc credential, or a `type` value of a W3C credential. The value is the dot-separated path to the claim within that credential. The value of that claim becomes the `sub`. Empty when the client uses `callbackURI`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataAction"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 140 characters`"} schema={{"type":"string","maxLength":140,"description":"The text that describes the login to the user in the EUDI Wallet, for example `Log in to your online bank account`. Empty when the presentation definition has no transaction data.\n","example":"Log in to your online bank account"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the client's key"}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the client is system-managed or not. A system-managed client cannot be updated or deleted."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The time of the last update of the client, as a Unix timestamp in seconds","example":1747015200}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The time of the creation of the client, as a Unix timestamp in seconds","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"client\": {\n    \"presentationDefinitionId\": \"string\",\n    \"name\": \"string\",\n    \"clientId\": \"string\",\n    \"clientSecret\": \"string\",\n    \"redirectURIs\": [\n      \"string\"\n    ],\n    \"allowedOrigins\": [\n      \"string\"\n    ],\n    \"callbackURI\": \"string\",\n    \"callbackSecret\": \"string\",\n    \"identityMatchingAttributes\": {\n      \"urn:eudi:pid:1\": \"email\"\n    },\n    \"transactionDataAction\": \"Log in to your online bank account\",\n    \"kid\": \"string\",\n    \"systemManaged\": true,\n    \"updatedAt\": 1747015200,\n    \"createdAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The provider answers with `error` and `error_description` when the body is not valid JSON or holds no field, when the client is system-managed, when `presentationDefinitionId` is empty or already belongs to another client, when `callbackSecret` is empty, or when the client would have both or none of `identityMatchingAttributes` and `callbackURI`. The answer has `errorCode` and `errorDescription` when the Passwordless Login extension is not enabled.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_request\",\n  \"error_description\": \"System managed clients cannot be updated\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Client not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"string\",\n  \"error_description\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"error\": \"not_found\",\n  \"error_description\": \"Client not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The validation of the presentation definition, of `identityMatchingAttributes` or of `transactionDataAction` refused the request, or an internal error occurred. A refusal holds the reason in `error_description`. The API answers with `errorCode` and `errorDescription` when it cannot reach the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Provider error"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error code, for example `invalid_request`, `not_found` or `server_error`"}}></SchemaItem><SchemaItem collapsible={false} name={"error_description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason for the error"}}></SchemaItem></TabItem><TabItem label={"API error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"invalid_request\",\n  \"error_description\": \"Transaction data action is required when presentation definition has transaction data\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update Payment Authorisation - (for Banks) TS12 extension
Source: https://docs.igrant.io/docs/extensions-api/update-payment-authorisation-for-banks-ts-12-extension

---
id: update-payment-authorisation-for-banks-ts-12-extension
title: "Update Payment Authorisation - (for Banks) TS12 extension"
description: "Update Payment Authorisation - (for Banks) TS12 extension"
sidebar_label: "Update Payment Authorisation - (for Banks) TS12 extension"
hide_title: true
hide_table_of_contents: true
api: eJztV81uG0cMfhViTgmwkhynJyEI6jhu4SZojchBDokAUbvU7sSzM5sZrmRF0K1P0kfrkxSc0b/l/DS+FGgOzu7OkPxIfvzRQhUUcq8b1s6qvnrbFMgEVzivyTKctVw5rwPKMXTg0cR5eIH2JjyG68GTU6BbJhtENlOePrUU+IUr5qq/ULmzTJblEZvG6Dwq6X0MYmihQl5RjfLE84ZUX7nxR8pZZQeI3iStMHbFHMR8KxC1Le8BmTs70WXr41sXzhgMYWBwlsBNYNQkqXP0xbmngixrNCNAW2zOzvLctZZ3j0PlWlPAmKDxbqoLKroqU413DXnWFMSPo5qPObgvRhbHhoqdi2PnDKG9E4qLeBOch0KH+MjVfbm68hTIcnp5SRNtdQyIWi5TprQXm+835ofLTN3n/3/IifhPDkPjbEjgTk9O5L+HY/q/pvZB0NYqB4zchm8I3qUtxBgFmFXEFfkYvI0e0AHWodimc5vH8PVyu/7eZISHqgO9y57AXtvyDrrvQgaX0fZEk5doWKzpoS28xjEZUf7t/H+3k7jjxrZB28vnAeWjO9kDle//sf+x2C/vNKSD0j5ajMNVswqUt17zXPXfL9RZo1+RPA6Xw0wxlkH0HUe706TUMFM1ceUK1VdNG1OMXKm+6k2f9tJQ7G1Q9VZoOrirr6NDaMkrQeSn5EMEtB/Cl1Q7SMcqU603qq8q5ib0e72CatfBRnd16dFyVzu1zA4VXHlXtHmEf4+ar2kYMJYy/+8RD+n4EMhwG+eB9OdE/HW0N9TB9CFTWkxVhEU0kQisVuH/HMN1h15nV5dwQ3OQoEqO89UOIj11iqaNC4hwb7SnZwTJDNSt7DmyYtBE31IBM80VjBJGGMEj6ziNS/aoTYxBgzk9zoC6ZfdAbR9Wgs/mrvUSjs4NzZ+PulIzLwg9ebkvvo/j2y/O18iqr357d310LmCeUwjA7oYscIWcsMRXskXjtOW1i380ZC9fwrmzlnLeG1GhpdCFAdkCNAOGO7gTOHgWNQvgLI3UWNrxTGXrfEnWY33K8H2z3UAvbrFuDH1xHm0aB/uWvtI/9+8uhR8Tt15zMY+7ANWohYmhbRrn+ect+zYE0r9uP+3TdpfxB7HfCMGjv//867F0JoTBjAodKiiQEeg2r9CWFNfYKXk9WZEvFonON2ur78IlQxsoQCAz6QQ3JU+6tKCjszzPVvJxNcu33SoDhEKXmtHADI0hjsaCM7qAxhXAlFfWGVdqCllqncJQBEszMDQlI9zQlimOHhxro3kelWDLrk5Lfe7qxmi0OSX2R/c8la2J/gTQFhAmrTFSZ4XmiLNGa8kLUYzOyYaY93XNNphXBKfdkzsxn81mXYzHXefL3ko29F5fnl/8PrjoiMwyU6zZ7CUPpNILl7f1ejCpTEnDTPk6PTn9qfu0+yTuYC5wjXYHz48snnu82PmJ9UNKV5XEdMu9xqC2gjsGarGaIe/V9Glaeydaxvau9BcnyTBTlQssGhaLMQZ6681yKZ8/teTjlMvUFH1kW5x52brnyui5kdaszpOXnWvBKddNmzr1weYtkyJJnOU5NfzFu7vj8uqt9Lvx6ndr7QoR8TiT37Q4U331QX1QKlOuSQtvf5G+L5RBW7ZYyv2kVjoDrrrqdqLcxImyehDH1kd2vgPycLgkX+SveHZU5JkQ8RXNn2+up5N7BTYDLd2WXMsW8g/A7auF
sidebar_class_name: "put api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update Payment Authorisation - (for Banks) TS12 extension</h1>

<MethodEndpoint method={"put"} path={"/v3/config/extension/payment-authorisation-issuer"}></MethodEndpoint>



Update Payment Authorisation - (for Banks) TS12 extension

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Payment Authorisation Presentation Definition."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Payment Authorisation Presentation Definition."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Update Payment Authorisation - (for Banks) TS12 extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Payment Authorisation Presentation Definitions

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Authorisation Credential is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Authorisation Credential is enabled"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"paymentCredentials\": {\n    \"paymentCardCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentAccountCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update Payment Authorisation (for Merchants) TS12 extension
Source: https://docs.igrant.io/docs/extensions-api/update-payment-authorisation-for-merchants-ts-12-extension

---
id: update-payment-authorisation-for-merchants-ts-12-extension
title: "Update Payment Authorisation (for Merchants) TS12 extension"
description: "Update Payment Authorisation (for Merchants) TS12 extension"
sidebar_label: "Update Payment Authorisation (for Merchants) TS12 extension"
hide_title: true
hide_table_of_contents: true
api: eJztV81uGzcQfpUBTwmwkhynJyEI6jhu4SZtjchGDokAjXZHu4y55IaclawKuvVJ+mh9kmJI/duOk8aXAvVB5i45w29mvvnZhSoo5F43rJ1VfXXVFMgEFzivyTKctFw5rwPKNjyZOA+/ks8rtByewuXg2THQDZMNIp0pT59bCvzKFXPVX6jcWSbLssSmMTqPanqfgly1UCGvqEZZ8bwh1Vdu/IlyVtkBpndJK4xdMQeB0ApIbct7YObOTnTZ+vjUhRMGQxgYnCVwExg1SeoUfXHqqSDLGs0I0BabvZM8d63l3e1QudYUMCZovJvqgoquylTjXUOeNQWx407Ndxm4L0YWx4aKnYNj5wyhveWKs3gSnIdCh7jk6r5oXXgKZDk9vKaJtjo6RC2XKVLay50fNtcPl5m6z/7/kBHxTzZD42xI4I6PjuTfY3L9X5P7wG1rlQNGbsNXuO/cFnIZBZhVxBX56L6NHtAB1s7YBnQbyfBwwl1+azjCY2WC3uVPYK9teQvdNyGD83j3RJMXb1is6bFveItjMqL86zPg/U7g7r5s67S9eB6QPpqTPVIC/+/77/P98lZJOkjtO5NxuCpXgfLWa56r/oeFOmn0G5LlcDnMFGMZRN9XFSo1zFRNXLlC9VXTxjAjV6qvetPnvdQaextkvRWiDu7q7NQrdUpw+Sn5EGHtO/I11Q7StspU643qq4q5Cf1er6DadbDRXV16tNzVTi2zQwUX3hVtHo24R81DGgaMpcwB94iHtH0IZLj19kCqdKL/2ucbAmF6kSktV1WERbwi0VitgvBHdNgtkp1cnMM1zUHcKpHOV7OIVNYpmjYOIsLA0Z6eEaRroG5l3pFRgyb6hgqYaa5glDDCCJ5Yx6ltskdtog8azOlpBtQtuwdq+7ASfDF3rRd3dK5p/nLUlcx5RejJy3mxfRyffnK+RlZ99cv7yzu7A+Y5hQDsrskCV8gJS3wkWzROW16b+HtD9vw1nDprKee9RhVaCl0YkC1AM2C4hTuBgxdRswDOUmONCR73VLaOl0Q9Zqm04HfbSfTsBuvG0Be70qZ8sG/pgSq6f3Yp/Ji49biLeZwIqEYtTAxt0zjPP27ZtyGQ/nn7ap+2u4w/8P1GCJ78/edfT6U+IQxmVOhQQYGMQDeSuSXFcXZKXk9W5ItJovPN+Oq7cM7QBgoQyEw6wU3Jky4t6Ggsz7OVfBzR8m3NygCh0KVmNDBDY4jjZcEZXUDjCmDKK+uMKzWFLBVQYSiCpRkYmpIRbmjLFBsQjrXRPI9KsGVXp+E+d3VjNNqcEvujeZ7K1kR7AmgLCJPWGMmzQnPEWaO15IUoRudkQ4z7OmcbzCuC4+7RLZ/PZrMuxu2u82VvJRt6b89Pz34bnHVEZpkp1mz2ggeS6YXL23rdnlSmpGCmeB0fHf/Qfd59FicxF7hGu4Pn+wbQPWbsfGx9p9pVNjHdcK8xqK1gj85arDrJBzV9ngbgiZYGviv9QD8ZZqpygUXHYjHGQFfeLJfy+nNLPna8TE3RR87F/petK680oGsp0Oo0Wdq5FKRy3LSpXh9M4dIvksRJnlPDXzy72zYvrqTqjVdfsbUrRMTjTL5wcab66qP6qFSmXJOG3/4ivV8og7ZssZTzSa3UB1zV1m1fuY59ZbUQw9Zbdr4D8rDFJFvkVyy7U+SF0PENzV9ujqedewU2bS2dlmjLRPIPXTO0TQ==
sidebar_class_name: "put api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update Payment Authorisation (for Merchants) TS12 extension</h1>

<MethodEndpoint method={"put"} path={"/v3/config/extension/payment-authorisation-merchant"}></MethodEndpoint>



Update Payment Authorisation (for Merchants) TS12 extension

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Payment Authorisation Presentation Definition."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Payment Authorisation Presentation Definition."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Update Payment Authorisation (for Merchants) TS12 extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Payment Authorisation Presentation Definitions

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Authorisation Credential is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authorisation Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Authorisation Credential is enabled"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"paymentCredentials\": {\n    \"paymentCardCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentAccountCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update Payment Credential Issuance (TS12) extension
Source: https://docs.igrant.io/docs/extensions-api/update-payment-credential-issuance-ts-12-extension

---
id: update-payment-credential-issuance-ts-12-extension
title: "Update Payment Credential Issuance (TS12) extension"
description: "Update Payment Credential Issuance (TS12) extension"
sidebar_label: "Update Payment Credential Issuance (TS12) extension"
hide_title: true
hide_table_of_contents: true
api: eJztWM1uGzcQfpUBTwmwlhynJyEI6jhu4SZojchGDokBj3ZHu4y55IaclawIuvVJ+mh9kmJI/azkn6SuewgQH2SK5Mx88z/UXBUUcq8b1s6qgTpvCmSCU5zVZBmOPBVkWaOBkxBatDnBk7Phs4OnQNdMNghVpjx9binwK1fM1GCucmeZLMsSm8boHIV7/1MQEXMV8opqlBXPGlID5UafKGeV7WB5l7jCyBUzGDsPrYDTtrwXXu7sWJetjzJ7cMhgCAODswRuDFwR5GuyAKFyrSlgRNB4N9EFFT2Vqca7hjxrCgKzSeLOA/mNxNvwb5ORxZGhonNx5JwhtDc0PY43wXkodIhLgXmflp291zTWVkdt1WKRnKG9yP2whnCxyFZaHKEvvn8tDvPctZa/W0XinxyGxtmQAB7s78u/x0jIB2fgjslWLIeM3IZvMN2JLUQYBZhWxBX5aLo1H9ABVkbohOQmH79eFc46rjhsuXJeh6jd7U4Ij5XNuhs5gb225Q1s/zpE4CTujTV5sYfFmv4PKW9xREYEfHsOvO+47z6BXYfuRHvUJnuMGvTD9o9n+wdUzh/m/8/mX9xoBTul9dZieLFsE4Hy1mueqcGHuTps9BuS5cXiIlOMZRB+9wBVF5mqiStXqIFq2uhf5EoNVH/yvJ/mpf4aT3+JY0+vyEW+n5APUfy2rV5T7SAdq0y13qiBqpibMOj3C6rdHja6p0uPlnvaqUW2y+DUu6LNo6vuYPM1DkPGUobCO8hDOt4FcrGx6lC6YYr0lW3XMYJpI1NaRFWERRSRolUt+8+X2H9uxNHh6Qlc0Qyw5Upcki9HUulgEzTteh693OJzCUkM1K0MvzKY0lhfUwFTzRVcJoxwCU+s4zSasEdtog0azOlpBtQreztsB7AkfDFzrRdz7F3R7OVlT5LjFaEnL/dF91H89ovzNbIaqN/en93ahTHPKQRgd0UWuEJOWOJXskXjtOWVin80ZE9ew5GzlnLeGghCS6EHQ7IFaAYMN3AncPAichbAWRpgYg7HM5Wt/CVej9koo867zbPk+BrrxtC9/X9dIdi3dF+zuuPirZV1++5CAmnsVo8kzOOIRjVqCdnQNo3z/PMmTNeRpn/dbG3Hdzc1dpy0JoInf//511MpWAjDKRU6VFAgI9B1XqEtCdAWMCGvx8sojdmk8/WryPfghKENFCCQGe8FNyFPurSgo7I8y5b0cV7uvLAyQCh0qRkNTNEY4igsOKMLaFwBTHllnXGlppCliiqhjGBpCoYmZCSItGWKTQlH2mieRSbYsqvTkzB3dWN0rMsxTaJ6nsrWRH0CaAsI49YYSchCc8RZo7XkJaKMzsmGGCCr5G4wrwgOevs3bD6dTnsYj3vOl/0lbei/PTk6/n14vCc0i0yxZrPlPJCSULi8lXBZFQ2prMlfB/sHP/We957F0dgFrtF28DzsJbAVEZ2n+QPZLdOM6Zr7jUFtBWs0znzZVD6oyfP0AhlraeBd6hut5SJTlQssVPP5CAOde7NYyPbnlnxscpmaoI9RFVtetirC0ouupFaro6TT3plgk+umTaV75+EjrSNRHOY5NXzv3W7PPD2XAjha/rpRu0JIPE7llw+cqoH6qD4qlSnXpBfHYJ7258qgLVss5X5iKxUAl2V202KuYotZLkSx1ZGddUDudpuki3yKZreSvJCAe0Ozl+vr6eROgnWHS7fFvzKE/AMAZ2hk
sidebar_class_name: "put api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update Payment Credential Issuance (TS12) extension</h1>

<MethodEndpoint method={"put"} path={"/v3/config/extension/payment-issuance"}></MethodEndpoint>



Update Payment Credential Issuance (TS12) extension

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentUserCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Payment Credential Issuance Credential Definition."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Payment Credential Issuance Credential Definition."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Payment Credential Issuance Credential Definition."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Update Payment Credential Issuance (TS12) extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Payment Authorisation Credential Definitions

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentUserCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Credential Issuance is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Credential Issuance is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Credential Issuance Credential Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Payment Credential Issuance is enabled"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"paymentCredentials\": {\n    \"paymentUserCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentCardCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentAccountCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update Recurring Payment Mandate (TS12) extension
Source: https://docs.igrant.io/docs/extensions-api/update-recurring-payment-mandate-ts-12-extension

---
id: update-recurring-payment-mandate-ts-12-extension
title: "Update Recurring Payment Mandate (TS12) extension"
description: "Update Recurring Payment Mandate (TS12) extension"
sidebar_label: "Update Recurring Payment Mandate (TS12) extension"
hide_title: true
hide_table_of_contents: true
api: eJztV81uG0cMfhViTgmwlhynJyEI6jhu4SZtjchBDokAUbvU7sSzM5sZrmRF0K1P0kfrkxSc0b+lJHDTQ4H6IK92huRH8uOP5qqgkHvdsHZW9dTbpkAmeEN56722JVzjrCbL8CvaePLopv/k7DHQHZMNIpMpT59aCvzCFTPVm6vcWSbL8ohNY3SOorv7MYiBuQp5RTXKE88aUj3lRh8pZ5XtIXmTtMLIFTMYOw+tQBNIx8Hlzo512fposQPnDIYwMDhL4MYwbNL9C/TFhaeCLGs0Q0BbrM/O89y1lrePQ+VaU8CIoPFuogsqOipTjXcNedYUxJeDmg85uStGFkeGiq2LI+cMob0Xjst4E5yHQof4yFXMU94eDMW1p0CWYyTgJY211TEoarFIGdNe7L5fQxgsMnUsBv8xR+KfHIbG2ZAAnp2eyr9/zvYH03svYCuVfUZuwzcE7soWYowCTCviinwM3FoP6ACrEGxSuclh+HrJ3TwkEeF71YLeZk9gwXCgKRzL1BF0cBXtjzV5iYrFmv4NK69xREYMfHsdvNtK4nGDmwDu5HeP+tGt7DuV8v95+H55WNxrUntlf7BQB8sGFgSO5pnqvZ+r80a/InkcLAaZYiyD6DuKWA0yVRNXrlA91bQxzciV6qnu5Gk3DcruGk3Xr/ScLPGc1Es9AsNPyIeIYjd2L6l2kI5VplpvVE9VzE3odbsF1e4EG93RpUfLHe3UIttXcO1d0eYxdUfUfE1Dn7EU94+Ih3S8D2SwCW5fGnZi/irEa85gepEpLaYqwiKaSOxV5y1XzuvPkYX3eHV+fQW3NANsuZLE5sulRJrsBE0bNxIh3XBHzxCSGahbWX5k56CxvqMCpporGCaMMIRH1nGanexRmxiDBnN6nAF1ys6e2h4sBZ/NXOslHCe3NHs+7EixvCD05OW++D6K335yvkZWPfXLu5uDgwLznEIAdrdkgSvkhCV+JVs0Tlteufh7Q/bqJVw4aynnnZkVWgod6JMtQDNguIc7gYNnUbMAztKMjTUdz1S2ypdkPRalTOM3m7X08g7rxtAXh9O6Y7Bv6SsNdPfuQvgxdqvdF/O4HFCNWpgY2qZxnn/csG9NIP3z5tUubbcZvxf7tRA8+uuPPx9LO0LoT6nQoYICGYHu8gptSXGvnZDX4yX5YpHofL3H+g5cMbSBAgQy45PgJuRJlxZ0dJZn2VI+7mn5pkVlgFDoUjMamKIxxNFYcEYX0LgCmPLKOuNKTSFL/VIYimBpCoYmZIQb2jLF2YMjbTTPohJs2dVp089d3RiNNqfE/uiep7I10Z8A2gLCuDVG6qzQHHHWaC15IYrROdkQ876q2QbziuCsc3ov5tPptIPxuON82V3Khu7rq4vL3/qXJyKzyBRrNjvJA6n0wuVtvZpIKlPSMFO+zk7Pfug87TyJS5kLXKPdwvOQDXSHD1u/tx6kbFk5THfcbQxqKzhjYObLgfFeTZ6mvXesZUbv/vQ7NjYGmapcYBGfz0cY6K03i4W8/tSSj3MsUxP0kVpxqmWrBitz5lb6sLpIrp3cCEi5btrUlvf2bhkLSeI8z6nhL97dHozXb6W5jZa/XGtXiIjHqbiGU9VTH9QHpTLlmrTq9ubp/VwZtGWLpdxPaqUN4LKFbsbHbRwfywdxbHVkZ1sg9ydJ8kU+xbODIs+Eda9o9nx9PZ0cFVhPr3RbEi17xt8hEKaA
sidebar_class_name: "put api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update Recurring Payment Mandate (TS12) extension</h1>

<MethodEndpoint method={"put"} path={"/v3/config/extension/recurring-payment-mandate"}></MethodEndpoint>



Update Recurring Payment Mandate (TS12) extension

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Reccuring Payment Mandate Presentation Definition."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the Reccuring Payment Mandate Presentation Definition."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Update Recurring Payment Mandate (TS12) extension

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"extensionStatus"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the extension is enabled"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCredentials</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The Reccuring Payment Mandate Presentation Definitions

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentCardCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Recurring Payment Mandate Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Recurring Payment Mandate Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Recurring Payment Mandate Credential is enabled"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>paymentAccountCredential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Recurring Payment Mandate Presentation Definition Identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Recurring Payment Mandate Presentation Definition Label"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Recurring Payment Mandate Credential is enabled"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"extensionStatus\": true,\n  \"paymentCredentials\": {\n    \"paymentCardCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    },\n    \"paymentAccountCredential\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"enabled\": true\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Get Started with Digital Wallets
Source: https://docs.igrant.io/docs/intro-main

---
id: intromain
title: Get Started with Digital Wallets
hide_title: true
sidebar_label: Our Service Libraries
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


This guide provides an overview of iGrant.io’s service libraries and enterprise solutions tailored for developers. Familiarity with iGrant.io’s commercial policy is recommended to fully benefit from this guide.

## 📚 Our Service Libraries

Our comprehensive suite of service libraries is designed for seamless integration with your existing applications, forming an integral part of our commercial enterprise offerings.

### OpenID for Verifiable Credential Issuance (OpenID4VCI)

- [APIs](/docs/category/openid4vc-api/issuer): Interfaces for credential issuance.
- SDKs - [Android](https://github.com/decentralised-dataexchange/eudi-wallet-oidc-android) / [iOS](https://github.com/decentralised-dataexchange/eudi-wallet-oidc-ios) / [Cloud](https://github.com/decentralised-dataexchange/eudi-wallet): Tools for integrating credential issuance functionalities.

### OpenID for Verifiable Presentations (OpenID4VP)

- [APIs](/docs/category/openid4vc-api/verifier): Interfaces for credential presentation.
- SDKs - [Android](https://github.com/decentralised-dataexchange/eudi-wallet-oidc-android) / [iOS](https://github.com/decentralised-dataexchange/eudi-wallet-oidc-ios) / [Cloud](https://github.com/decentralised-dataexchange/eudi-wallet): Tools for adding credential presentation features.

### Selective Disclosure - JWT (SD-JWT)

- [Playground](https://github.com/decentralised-dataexchange/sdjwt): Sandbox environment for exploring SD-JWT technologies.
- [APIs](/docs/category/openid4vc-api/issuer): Interfaces for working with SD-JWT.
- SDKs- [Android](https://github.com/decentralised-dataexchange/eudi-wallet-oidc-android) / [iOS](https://github.com/decentralised-dataexchange/eudi-wallet-oidc-ios) / [Cloud](https://github.com/decentralised-dataexchange/sdjwt): Development tools for SD-JWT support.

### Consent Management

- Code Repository: [Github wiki](https://github.com/decentralised-dataexchange/bb-consent-docs/wiki) with code repositories for the microservice.
- Developer Playground: [Sandbox enviroment](https://github.com/decentralised-dataexchange/bb-consent-playground) for testing consent management features.
- APIs: Interfaces for managing user consents.
- Privacy Dashboard SDKs: [Android](https://github.com/decentralised-dataexchange/bb-consent-android-privacy-dashboard/) / [iOS](https://github.com/decentralised-dataexchange/bb-consent-ios-privacy-dashboard/) / [Web Client](https://github.com/decentralised-dataexchange/bb-consent-privacy-dashboard/): Tools for integrating consent functionalities.

---

# Powered by MDX
Source: https://docs.igrant.io/docs/mdx

---
id: mdx
title: Powered by MDX
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


You can write JSX and use React components within your Markdown thanks to [MDX](https://mdxjs.com/).

export const Highlight = ({children, color}) => ( <span style={{
      backgroundColor: color,
      borderRadius: '2px',
      color: '#fff',
      padding: '0.2rem',
    }}>{children}</span> );

<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.

I can write **Markdown** alongside my _JSX_!


---

# Accept credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential

---
id: config-accept-digital-wallet-open-id-credential
title: "Accept credential"
description: "Accepts a received credential in the holder's wallet. The wallet changes the credential status to `credential_accepted` and sends an OID4VCI notification to the issuer. This operation has no request body."
sidebar_label: "Accept credential"
hide_title: true
hide_table_of_contents: true
api: eJzlW1tz2ziy/isovqxdS8uX2MnGtbV1PLYzUZKdqGIn3lNJyoSIloSYBDgAKFmb8n8/1QBIghfZSmbqPOzmIZYootFoNPrydeN7xECniheGSxGdRmdpCoXRhBIFKfAlMJIqYCAMpxnhgpgFkIXMGKi/aLKiWQZmRK4X4D+TdEHFHLR9LxipDTWlJkaSpHl6S+1swBJCBSMaBNOECvJ+fHH86XxMhDR8xlOKvOFQpMm1LkHhlFwTWYByvy6oJkISBb+XoA2ZSrYeRXFUvzBm0WmUSjHjc7fECz7nhmY3luv3BYgxO68Zi+KooIrmYEDp6PTz946UPgr+ewmE29dnHBSRM0Lb65UK2CaBRXHEkU5BzSKKI0FzQPbq4WMWxRGuhStg0alRJcSRTheQ0+j0e2TWBb6vjeJiHj08fMWXdSGFBo2/Hx0c4J82z9c1H6QSe2eTkK1UCgPC4HBaFJkX/v43jTS+93mQ02+QGpSXQlkb7jhoiFpKWfZ+ZsXYHdVmsdkA1D6pkEFqAglWSmalq1t6R7MVXWuiwJRKaAJLUGsy45CxETlzHxw1rylLmuEOViOAkRU3C8KNJpAXZu1eOCXJl+hLlJCZVIQSJ/GYJAfVE1HmU1AxSWY001A9nUqZARVWqxNRZpn/QRC3cuK+UKWoVdO28Djrb3JXVIMa2DlzTob+qDgJoBjd2dQ0By8EqsNDOWbJKHqI29r4E/zggntG4NFD0Zr08t5Zkm0mHz8mBfCE3O4XSrIytarPdUv3W7NfyzsQT0+M+qfoiry5uY7J1cWe/SsVyS9kSgzSqBiyZouRT6D4jNNpBiRQdqobaztTMg8M3V80scbpwspzcLgmY61LKlIgO95y7obULwUrJBddAQ8dYsoYx6XRbBJopDM/7ZVfQCoZMFLQdSYpq5Y5vD4riRE5l8JQLpz+FVRpdC4Z5bluVn3z7Jx8Oic7b26ud2Myvrx+5eVKPp1b0Y6v3pPDvx0cPts7sWLezy/ehftobYJTdq6rw7da8AwsfW8tVhQPel9FOzK6sl5rSA9AlHl0+jlCHzObgbrVaDWrL9VuRnFk137rtj8KaQ8+K0AwN0HLS95136ssePspgwzcQ+414paB4MCirz1TWyoFwlR+uX9sNrn6s+oUB+8KqXKaZWtvXqQAR1CBNzF61HL7fpUJyYGKXqggAJgmuVRAtIFCx3af4J7mRQaEEqOo0DS1bh+V0BpTktIsq2KEKn64gBko5HXoNHQCkTuMQhp+vJ7Ux9LGJ27hHY3ZENA0pJ5wulZhpVmA8rIiqcyhbQfs4c74DNJ1ijIQjKToP4oCqAq0u7Z1XOMGFkrOFWhttdrNj5S2NG5n9QBvynYCyd9ya8dre1N7UdwrVsm94r3lqUttw0Nuo8FC4rYt4PG9Qv4rotXDLXzSh3eVYm+nERMFeIw3rKHjFK15fpqJYCI3hATeimqchwsIhTki1+uCp/ZAtRzBlGoguKgSLafBaFfLbOm2vj/PP8FQRg21jBcKzkqzkIprYOeSwdOcTxTsUTfm33je8ajVWhmcV2vy2sILRY5kzhoyODd5lcmVZavUoCZ8G0/bPfQ75v4WP+ySKk7+sZlTBdQAOwv1iAsDc1BDwc09MTwHbWhekB0uiIZUCqZ3yWoBohtMVNHritqnOA9Ged6ERaeHL04O3D8UQcH+XxjJqDYklww1b5Cd55Yd55V+jBuy0+Wi0toq7uknGsOzS5uIvVdzKriuE7efDoZ96CQDemSHucyvMkcMikyucxBm1ycIPkbux4fyz+KrxdATk/oj8qHOButZfZbRm/YG9yDBqC2JQw+Ul9oGwEvOBv1oc6SMRCdUYDSx1Yki1qWQDy777ljKVxgdDJrrIIhapn/VbO/bCmOoZdF8ZsHzbytzu0xvbS5afYviKNfyNmcy7Qc5buZK6EOAxgYDnARTOWzCP0kIVe0gFa1OTo2OSVKvIcEvRfPFEqhX4mi0Q9uGin23WlKCjhx5H4x63ZhOxOuS11IYnoWBzJ2QK0fKj/JOAU321voceK6Mizsu5j2DYyShJKRbxyQx4bMgntKYARiHm7C1oDlPm1BnhjrFxVJmS5xkOAOahLPsuHeOP0127dJ41z1vgBwuuC4yuiZcOLkgLTqVpenFw5ZgXPncIFHb7HlbyZ96DK6wG8OXfh917MAIt5duM7Qzrdxg5CekaTn/vHb1IWz02QFLcZRJB+NYfGdpLXkm57IjjK9dHMLBUk8pRSVBfLuzYNyIeu4nCb3zbw4QcVz/SMBXB012KOE5nYPnZy5/jhKODAi1BjwppOZbb3kPLWt5bjHK0qGW+o8l6YFmpiHZH9dd56QsIgjapVltT2V1+w7WmFRneHpDt1Gpp7c97YQuWabWYDKZ4krxYyulnXFhl+vtMHPq5jAqc98JZTec8n70mHhfl+ySBuklhqIbq6VT8R9I6b0LduvVlhqIFvQOSIrR+RRSio/MAtYk50p1QtIVV9Cy23We6exA8v1LlIGYm8WX6JQcxORLxEVRmttcMsBHiEbi02B91eOHpIm+bExeQZ1dR99HHN2UW4R8v1m4E3UjXVBFUye1CqTtRRQL6kHaGm1F5HR7Lusg8RhNei2ILTwVvot6t5BNXtCdId7o/kWZg+Lo7X05xMaMiGxk6xFJDNyb5jeaFQvqRwRiae2vA6wtF04Utcz8+apqH4wwCSgPrKRAeke46UjQOYWfkGHkefxh4zUW2qjSUa1k6UNKuwy4LzKL6y3w3Esyh2F1QFvX9k9e71p723FKiFz4iNPargswlGehYbQoeh+9CAcR5kb1xF7DFh7uqs5pFc+6osowqFiJYnOaGUfcQD5oxNvMvsfx5Gh0QOgA2y7fx+kq9jpxCcZMXWX+8OqcvHz28vmfY6t6FsOt50kIaWg1OKRrFTDv4+y2WVddMHlkyVW1r63lPVLtbOS25Qlvt6m1PFpeaDtWr0Zbh4QtzicLaWSrDNnmvMkjh9S/q2pVdfCRoCAg+IdORmXkrA2r0V/QFfo7IJYmVeyYBMv94xu2UShfHbGlDyQ3o/fDWHgz0sPiI5K8rwrIqJIO013SjLOYJB9gKQPUuACVUwHCZJhN2JcQ14lJclVqRLwDVBjyQiqqePvVwUyuNvReyAIrm843eFzF8WqLI/XLgYLW/kSXRSFVuMxROwcP1hrFkV9eFEc1/9YaZzCn2YSzM2MQhtoytsdBZAJKS1EDoF7WO+8m44tdQht6bXQx0Mq4hj6XmAd28FHLmVdqs66U7vLjxZi4Mj+BVOq1NpC7VKC/kokstgFGpZwhYxOpNWhtFzGRk93aJdQs4dLClcUOf7GJc33UsOauZObCA6q1TDmqAykUX1JjjXeLX5cDbwUFjQVDMYPNHm2N4VH2bBwxBRBEl2kKWs9KRKGXfkJXRyiN9Kn3z2BRVf5bGonptoO5PWDQA8CcQlOSU5MuGiTg+NOEtF2LNyeunu8gBsvsEpTeSkE/uRe79YLa1RRKGpnKwBcPZkAMZrTMLB8JU3Rmbg+fJeEx8wzdHhzaw5SqdWHkXNFiwdO3sG5czdMsv4V1CC3uJHecJbvVCjSfC5RYpTzdmTajco9haAHVU8zF2OkdrBM0Pcn9ycHLpGNR/AtRHOGvdsVwX6Cpb1yBdSh/xKGd4fvIYKFgyWWp0ao62LkFTOE0VQvIEmtllhErnB5T2/CzRUK+mVfm6+d+5pBTX1J3VTvvGvWlsBvY1uWtD13t0x0xAo4asKEUt/LtelDNHbhWmaAbbhbXqtTmHdc/ZQ48Z1a9Okef6trwEDrHBMNgnddHA+gGcGKScY84269XoJY8hYlDuQcBwB9pcnBZg1d+N592M1RAuiIgjFo7xbJ2yrtlvzJWKmvua179orwH3tCu0Pb5M1kKhvmdpe9KEWj/MMt4+gQ3yYWFVWsDNhBRj0gyU1IYRGwFZImr1U6VXGmrPowrSC3WPaXpXfstlAuoPSP33CesIOSlGF6oi222yaACaxKyFsVRwEI/TfQO4Uek0069qk5CRAIrPts+p11P5NrFGB8FN8Oh0ZZnon0KOLZi+ugFSZOANtm5+Xi2a0EDjO+wZXNeZlS1vNIH6KZL2tYf7AjX4YdgupGINOBCwqbLbYoCSTjglrOk28IUN4VZ773Px+S3sLWzVecPyW1f6x+kN4Akh9Svtgth3NYQOjM+fGrSHZcxPdKmWjVeaG3d3PVWWTO+VbHuBvsGjEHB1jjqFKgC5ZzxxUROHETKClm8Wd09jUG8uXr/G7mBKcG4YufNzVusrPvArApY626gopxmPMUwwPKA05Ept109fayAZvMtoIJsLhU3i5wg9ojZhqWMAIWthZiFD4TDjPny6ujkuYtultu0YgQhEElLtewAZJM9T+5uG1gA5TS+qDMSa5uxR7SAFNWhz62T3p6X097h7Nmzw2cwe0npy2P7Fw6ODw7oi/Rw9vyApnvTkxNI6cuT9OXx0fHJdDY9nB5Pj57Bi6PpyQt29MxyatbbcWpRl7bwzpHA/dPD/0VSKRXjApOR6ixfnodKsPML1fD8GI0lCBvZ7LYnm9GPry9OzpbPZ+PJ5Kp8fbWWl6v04+HZvw7LX24Vn/7z+Uv1+tX06m9nyNUWi/rfP4Gr+fHbo1+XBys+f51Pvt3wF0fHU3X26vf57X0Gb425uX91cpKd/Xp9ddwDKlDyTvFQiMjy1+4rHaxi3P4adLj2W09bnZoDLYn9fq6BDqmBfqWhTqCmDSdsiwk7UzY0ZvQ6IvrdCgONAL26c12tfaQOVtd6NsDBA7jPMFSxMe0fyK/byW6TTfpY80ykC4lc39mN3pTZDKYXg5H95sh6Q3QbxoEbAqDNkcnXh17DxEe348NN5EGxaqZAL8DVQ3ztGgO7pKumSYzNiam13oLoBfYgDLZLjsilbdh3fZDdXvVOycQ3NS0oI1OYYZ+oe1ojirakugDKHFKK347dlYitrzeExxgQGvfKZz8H1Vysmj9+FaIZPVReaypctv+pR36oa6Y2X79QhGex0lXXMKvV9/vUWz1H3EGCHsrsIIbjC/y9FNgzIiyu2MohZ87jdQKfEXntSkL1lRsXZ9JMSxdsLinPbKzp71JQwabyvsUXWufuvh3+F+/bR9E0YPZEc/JfrdJjYUAJvFTisk07TUdGD3GkIS0VxyDp8/forOBvAT9a02foHO92Rf4mWJVl1Z1E57tRHDmlRpG4YjJe2iqtRPDq1mm0vzzad5DEvu8r3HNWct/VofY1+7Yy+83p2v8eBgQP+84ERsgprmPottkF5NIvEz2syjCWNKbQp/v7DHK5Rws+4nNFhRlxGT3EXQITe+nFFTaGyTxF4crQOSYBG4Zr93OXka+N/K9QDZ32VLvQAGzugb8T5zawuRXXSrr7acNkbEM9PCco1BBtcG7DJ1JJi05C3DSuJ3KKaA7M+H11CyxxPJKE7AjpeyCNojyzMihoCrsxgdF81CF7SvzAv69lqVAce3ew/kfiylzYY1adWJraEws55ShIX5v5n0Z49fr5r82jttTDDeuIpR5UwVTaQme+pZPj37zunWs3y/7YPSMEH36sPa+G0rW/mYZbCALHaO8M/u39B4IS6HViGwu43khf+KmaeNOAvVLb7TFUMKqY3rPr5RR70jOMPOzWVlUw5Pbxy0Y42xO3jaq2TfRbGU9BaGga56KzgqYLQGypt3Wr1WpE7c8jqeb7fqzefzc+v/zt6nIPxyCkyU3W0gErLCbTst69ICw9jY4Ojo5Hz0aHtrlTapNTEfJjTQ1pJRadRpDamfynXQT2pgY7d/Ztt4ptrVb2Fpwz5Z+j5ZG7ADvjNttsmXOfAtlA35r0boZ22snzvF3/GkcLiTjk5+j7d7zA8VFlDw/4+PcSlPVFcbSkyp4ZZ/u5xs8sOrVXSh/Zop0qy9olf8KF5EEJVRZaoHm29jQ6RSgWizqdC8sPX+ug267DvXJWubdqcC9GeQh96+TjtU9k2v7BFZH8h+AicZuxrqtwLOD/6NEGh/wdD9RbWP+jft39snFA7Z7c2yimrw8PD/8HkaxWXg==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Accept credential</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/{credentialId}/accept"}></MethodEndpoint>



Accepts a received credential in the holder's wallet. The wallet changes the credential status to `credential_accepted` and sends an OID4VCI notification to the issuer. This operation has no request body.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a credential stored in the holder's wallet.","in":"path","name":"credentialId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The holder accepted the credential.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential record that the holder wallet stores. The wallet always returns every field. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request.","items":{"type":"string"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of previously issued credential tokens that have expired.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of decoded expired credential payloads.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": {\n    \"id\": \"string\",\n    \"credentialId\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"credentialToken\": \"string\",\n    \"credential\": {},\n    \"credentialStatus\": \"\",\n    \"acceptanceToken\": \"string\",\n    \"deferredEndpoint\": \"string\",\n    \"credentialIssuer\": \"string\",\n    \"preAuthorisedCode\": \"string\",\n    \"userPin\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"issuedAt\": 1750000600,\n    \"openIdOrganisationId\": \"string\",\n    \"organisationId\": \"string\",\n    \"userPinRequired\": true,\n    \"credentialFormat\": \"\",\n    \"presentationId\": \"string\",\n    \"issuer\": {\n      \"name\": \"string\",\n      \"location\": \"string\",\n      \"cover\": \"string\",\n      \"logo\": \"string\",\n      \"description\": \"string\"\n    },\n    \"credentialConfigurations\": {},\n    \"txCode\": {\n      \"length\": 4,\n      \"input_mode\": \"numeric\",\n      \"description\": \"string\"\n    },\n    \"authorizationDetails\": [\n      {\n        \"type\": \"openid_credential\",\n        \"credential_configuration_id\": \"PhotoIdCredential\",\n        \"credential_identifiers\": [\n          \"string\"\n        ]\n      }\n    ],\n    \"revocationStatus\": \"\",\n    \"legalPidAttestation\": \"string\",\n    \"legalPidAttestationPop\": \"string\",\n    \"legalPidVerified\": true,\n    \"autoPresent\": true,\n    \"version\": \"version_01\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"\",\n    \"expiredCredentialTokens\": [\n      \"string\"\n    ],\n    \"expiredCredentials\": [\n      {}\n    ],\n    \"requiresEncryption\": true,\n    \"isVerifiedWithTrustList\": true,\n    \"trustServiceProvider\": {},\n    \"oAuthFlow\": \"\",\n    \"authorizationRequest\": \"string\",\n    \"isWalletUnitAttestation\": true,\n    \"notificationId\": \"string\",\n    \"notificationEndpoint\": \"string\",\n    \"notificationSent\": true,\n    \"accessTokenType\": \"string\",\n    \"dpopJwk\": {\n      \"alg\": \"ES256\",\n      \"crv\": \"P-256\",\n      \"kid\": \"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23\",\n      \"kty\": \"EC\",\n      \"x\": \"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A\",\n      \"y\": \"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the credential ID is unknown, or the issuer refused the notification. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Configure auto presentation for the credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-configure-auto-present-for-digital-wallet-open-id-credential

---
id: config-configure-auto-present-for-digital-wallet-open-id-credential
title: "Configure auto presentation for the credential"
description: "Configures whether a credential should be automatically presented when a matching OpenID4VP Authorization Request is received. The wallet applies the same setting to the related credentials that the same issuance created, but returns only the credential that you gave in the path."
sidebar_label: "Configure auto presentation for the credential"
hide_title: true
hide_table_of_contents: true
api: eJztW+tv2zqy/1cIfbkJruO8222wWGxOkp6m7bZGkzS76AkiWhrbbCRSJSk73iD/+2L4kKiHE6enuF/29kNjy+JwOBzO4zfDhygFlUhWaCZ4dBSdCD5h01KCIosZ6BlIQkkiIQWuGc2ImokyS8kYCC21yKlmCc2yJSkkKOAaUhzGCSU51cmM8Sn5XAA/Pz34OiLHpZ4Jyf5NcS7yBX6UoDRhikhIgM0hHZLLGZAFzTLQhBZFxkARPQOiaA5EgdZIUAvzTEJGcb6aOXyX6noAU6qkPAF8BV8dkHGpiQRdSq6I4NnSvBuszoxfipJM6RwI4+b3gurZMBpEogBpWD9Po6MoMYKqxHVcajGyMngr5CmbMk2za7MSI4D0pJolGkQFlTQHDVJFR98eWltwxdmPEggzr08YSCImrU3QQkLq+ZuJLAX5P8oJDlllSAf5jgYRpzkgv9Xw8zQaRBJ+lExCGh1pWcIgUskMchodPUR6WeD7SkvGp9Hj4419GZT+TaRLfKPJ7idY1Lrg9cBusd+xiZAtSQ97WEgE18A1zmD2PjFEtr8rnOahy6EYf4dEozQlbo1moMzYeieCl8dCZEB5NGhxf43aGiMD8cDw6LTPrQNViqlQ9k21ZxNC+bMqbs4CKML0kNgJJzRTfka7fyQvlVF6KeZAgCazhixRYHBP8yIDK6/Hx1CC3xrLvnl8tD+rQnBlxbK3s9Pdu+C4KTqH1PDDn91QZOYX7VYtWUMpyz5PzJFoj2pZqXo/JCRCpvXJd9L0q8KTopp2JVvQparMAMxBLsmEQZYOybH9YKnNqCJckDnN8DT6EWjhmJ4RphWBvNBL+8IRif+I/ohio+uU2NMzIPGOf8LLfAxy4LfePXVqSShPSczLLHM/cGJXTuwXKiVdDjvCY2n3wLZF1WtNWmbPyhClxJSTAIoxsL1WCFSROLQj8TB6HDQty0/w07UOzxm4xqRn98mM8imsM/n5U1IAR8jufiFFWibmSDQMQGv2S3EH/PmJUf8kXZD315cDcnG6Zf4KSfJTkRCNNDxD6LQgJV9Bsgmj4wxIoOy09pVkIkVej0DxWDNk5Nk7XJFz7xE3PqO9OjnfDKmf8bQQjLcF3HeIaZoyXBrNRoFGWjveXPkpJCKFlBR0mQma+mX2r89IYkhOBNeUceXcr1To5jPKclWv+nr/hHw9IRvvry83B+T87PKtkyv5emJEe37xmez+ZWd3f+vQiHk7P/0Y7qOxCVbZmfKHbzFjGYR+YEHxoPc5sIaMLjTVperTA+BljvYZA4jJBOStsdD+i9/NaBCZtd/a7Y9C2r3PCuCpnSB4SJO79ns0SaDQ7acpZGAf+hjpNgXOII1uOqa2lBI4WlJcYc+xWXFIybE/xcG7XMjc+E1rXgQHS1CCMzFqGFoYv8qY5ECdOoTUAFJFciGBKA2FGph9cl6SUKIl5YomxnOhEhpjStBx+xjSnQJyChOQyGvfaWhwZEQc8uP0pDqWaMndwlsa06Jj9yUk5VyX/6kzHhVWmJDcyookIoemHTCHO2MTSJYJyoCnJEH/URRAZaDdla1jCjewkGIqQSmj1XZ+pLSmcTuuBjhTthFI/pYZO17Zm8qL4l6lXu6e94anLhW4+EsLUgjcthk8vVfIvyfqH67hk7589Iq9nka4QGvFGlpO0Zjn55kIJrJDSOCtqMJ5GIdQmENyuSxcINpwBGOqgOCiSrScWhAJSmRzu/Xdef4BmqZUU8N4YXIZDGIVpCcihec5H0nYoi7wxfOOR63SyuC8GpPXFF4ociRzXJPBucnbTCwMW6UCOWLreNr2od/Q97f4AVXPhssvm9klj8ehHjGuYQqyL7i5J5rloDTNC7LBMGROBE/Vps2L29mEi14XVPkktRHo774+3LH/UARF+n/CSEYxZREpal4vO68MO9YrvYwbstHmwmutj3u6aWL/7MIk1Z/llHKmqqz8p4NhFzqJgB7ZSG0W781RCkUmljlwvekSBBcjd+ND8av4ajD0zKTuiHypksKXJ79hKoqJKEt7/Wh9pLRAJ1RgNLHWiSLGpfjEuGUp32J00GuugyBqnvyvSre+LzCGmhf15zR4/n2hb+fJrclF/bdoEOVK3OapSLpBjp3ZC73y5WHa32+A42Cq2GZx9klMqGwGqWh1cqrVgMTVGmL8UtRfDIFqJZZGM7StqZh3/ZJidOTIe2/Ua8e0Il6bvJZcsywMZO64WFhSbpRzChUI8MI8K2P8zqB2LYOjBaFNcMHHJANEVep4SmEGoC0Gli45zVlShzoT1CnG5yKb11hjOwMahbNsVGDNplkaa7vnFZDDKVNFRpeEcSsXpEXHotSdeNgQHHifGyRqqz1vI/mTT8EVZmPY3O2jGlgwwu6l3QxlTSvTGPlxoRvOP69cfRM9MiDhIMqEhXEMvjM3ljwTU9ESxk0bh7AQ43NK4SWIb7cWjBtRzf0soY/uzR4iluuXBHxV0GSGEpbTKTh+puLnKOHIgFBjwLNCqr91lvfYsJYeejaiUH8uSQ80MwnJvlx3rZOqsHvR8VRGt+9giUl1hqc3dBtePZ3taSZ08TwxBjMVCa4UPzZS2gnjZrnODqdW3SxGpe9boeyKU96NHmPn6+JNUqP2RFN0Y5V0PP+BlD7bYLdabamAKE7vgCQYnY8hofhIz2BJciZlKyRdMAkNu13lmdYOxA9/RBnwqZ79ER2RnQH5I2K8KPVtLlLAR4hG4tNgff7xY1xHXyYm91Bn29F3EUc75Roh3ycDd6JuJDMqaWKl5kHaTkQxow6krdBWRE7X57IKEg/QpFeCWMNT4buodzNR5wXtGQYr3T8vc5AMvb3JgRUxMaMtLg1JrOFe17/RrJhRNyIQS2N/LWBtuLCiqGTmzpcCniqj4akAlIcmyQySO1NcaEjQOoWfkGHkeHyx8TrnSsvSUvWydCGlWQbcF5nB9WZ47gWZQr86oK1r+iend429bTklRC7C6sspaMqy0DAaFL2LXjRKNqkd1RF7BVs4uMufUx/P2kpLP6joRbE6zRxETEPea8SbzH7G8WRvuENoD9s238fpPHutuARjprYyf3l7Qt7sv3n1a2xVx2LY9TwLIfWtBoe0rQLmfSy9rddVFUyeWDKRPt8ItbxDqpmN3DY84e06tZYnywtNx+rUaO2QsMH5aCa0aJSUm5zXeWSf+rdVzVd6nwgKAoJ/6mR4I2dsWIX+gvLob49Y6lSxZRIM909v2Eqh3FhicxdIrkbv+7HweqSDxYck/uy7A1AlLaY7pxlLByT+AnMRoMYFyJxy4Brrx9y8ZLsT4otSIeIdoMKQF0JSyZqv9mZylaF3QuZY2bS+weEqlldTHKleDhS08ieqLAohw2UOmzl4sNZoELnlRYOo4t9Y4wymNBux9FhrhKHWjO1xEBmBVIJXAKiT9cbH0fnpJqE1vSa6GGjloII+55gHtvBRw5lTar30Snd2dXpObMsGgUSopdKQ21Sgu5KRKNYBRoWYIGMjoRQoZRYxEqPNyiVULOHSwpUNLP5iEufqqGHNXYrMhgdUKZEw0wJTSDan2hjvBr82B14LCjrnKYo5aPt5kj0TR4wBOFFlkoBSkxJR6Lmb0NYRfkkjRm+bUbct4890HSGzc5BqLQX9al9s1wsqV1NIoUUiAl/cmwGlMKFlZviIU0kn+nZ3Pw6PmWPodmfXHKZELgstppIWM5Z8gGXtap5n+QMsQ2hxI75jabzpV6DYlKPEvPK0Z1qNyj2FoQVUjzAXS4/uYBmj6YnvD3fexC2L4l6IBhH+alYM9wWa+toVGIfyZxzaMb6PDBYS5kyUCq2qhZ0bwBRO41tAsBfHMmKE02FqHX7WSMhX85q6+rmbOeTUldRt1c65RnXGzQY2dXntQ1f5dEuMgKUGaV+K63276lVzC655E3TN9OxSlkp/ZOqnzIHjzKhX6+hTVRkeQqeYYGis8/rWvJRonJhkzCHO5usFyDlLYGRR7l4A8CVNDjZrcMpv51N2Bg+kSwJcy6VVLNsRloYrS0tpzH3Fq1uU88Ar2hWaPn8iSp5ifmfo21IE2j/MMp4/wXVyYWDVyoD1RNRDEk+k4BoRWw5ZbGu1YykWyqhPyiQkBuse0+Su+RbKBeSWFlv2E1YQ8pL3L9TGNutkUIE1CVmLBlHAQjdNdA7hJdJppl4utzD1Vs9n0+c064lM2RjjijPdHxqteSaap4ApQn30gqRJQJtsXF8dbxrQAOM7SiRMy4zKhlf6Au10SZn6gxlhO/wQTNcCkQZcCBd1bLZOUSAOB9yyNG63MA3qwqzz3ifn5FMwqFnnD8mtX+vvpdeDJIfUL9YLYezWEDrRLnyq0x2bMYU0fQtKMCU1kZRxc5drZc34lmfdDnYNGL2CrXDUMVAJ0jrj05EYWYg0LUTxfnH3PAbx/uLzJ3INY4Jxxcb76w9YWXeBmQ9Yq26gohxnLMEwwPCA05ExM109XayAZtM1oIJsKiTTs5wg9ojZhqGMAIWpheiZC4TDjPnsYu/wlY1u5uu0YgQhEElKOW8BZKMtR+5uHVgA5XR+WmUkxjZjj2gBCapDl1srvS0np63dyf7+7j5M3lD65sD8hZ2DnR36OtmdvNqhydb48BAS+uYweXOwd3A4nox3xwfjvX14vTc+fJ3u7RtO9XI9Tg3q0hTeCRK4f374P0kihEwZx2TEn+Wzk1AJNn6jCl4doLEEbiKbzeZkE3r17vTweP5qcj4aXZTvLpbibJFc7R7/c7f87Vay8T9evZHv3o4v/nKMXK2xqH/9Aq6mBx/2fp/vLNj0XT76fs1e7x2M5fHbH9Pb+ww+aH19//bwMDv+/fLioANUoOSt4qEQkeWb9istrOK8+TXocO22njY6NXtaErv9XD0dUj39Sn2dQHUbTtgWE3amrGjM6HREdLsVehoBOnXnqlr7RB2sqvWsgIN7cJ9+qGJl2t+TXzeT3TqbdLHmMU9mArm+Mxu9KrPpTS96I/vVkfWK6DaMA1cEQKsjk5vHTsPEld3x/ibyoFg1kaDw5kN12cYGdnEgrnhIzkwPvm1tbLeft6ogrk9pRvEO0gRbP+3TCiQ0VdIZ0NSCn/jtwF59WPvGQngyAdFup0/mc1CgxUL407cb6tF9FbO6aGVamjrk+xphKov0G0XEFYtXVVnSr77bet5oI2IW5XPoZAsEPD/F30uObSDcQIWmbYDylGrhL0o09w8H5EwpdOnknS33VHelbAxJMyVsIDmnLDNxpLsnQXk6FvcNBtHytjdw9794A6943VzZEc3hf7Vun3MNkuOFEZtJmmlaMnocRAqSUjIMgL49RMcF+wD40Zg1Tad4By9yN/Z8BlV1CZ1sRoPIKjWKxBaK8XJdaSSCV+yOou353raFG7Zdz+CWtYDbtsa0rdLvC71dH7Pth9DZP25XWEWEzOJS+i4GnkIu3ErRgcoMQ0WtC3W0vZ1CLrZowYZsKinXQyaix0GbwMjcabF1i34yz1G40HSKMf6K4cr+3Gbkpt6CC9REq0B+I2r8zD5w1xftHtYXGBs5dTcrGJ2bSA6PCso1BBOsC3F5UtygExM7jW15HCNYAxN27y95xZZHEpMNLlyLo5aUZUYGBU1gc0BgOB22yB4RN/CvS1FKFMfWHSz/FtsqFp7KL/WVyjOv9627iw4XxIYzf8RpYo445JSh2F2h5u+1qCtpsd/rR809Cre3JcRqkMeslMHRXH8nw7951UjX7Jx92aUjRCJe1qtX4erKXVPDDQeOY5TzHv92DgcRCgwTByaKsI2SrgrkO3rDO8OlMpup0cXJVG2Z9TKKDeoZtkIaRfAlMeT26ZtHONszV498Dyc6uowlwBXUXXTRcUGTGSDQ1Nm6xWIxpObnoZDTbTdWbX88Pzn7dHG2hWMQ32Q6a+iAEVYqkrLavSBGPYr2dvYOhvvDXdPpKZTOKQ/4qa44m1JMs2Wzey+qfTAD1/T/d8tX3y13FhD7hbZNj4xp6Jbm7p11Mt+i+Z69djthJsdtOBqXeJn0wjibdl541M4uK49zM4hmAgHQb9HDA94cuZLZ4yM+/lGCNI5yEM2pNOfTeiWm8HMaHZm7rE/s+IZP7zbJL7jV3isk7zs4Og5j6aMjxICxmtS69f54U6UGZh32lRPL7dal7SfwJDphFDpDO8Led3ry3TBUGF1dIgjtLs/btrRIUkzE8P+jCHvyzAZq38lpnj9EGeXTkk7xfUv20aHXTadpC2fuQ3B5uimTtv+0a8H/cWW9Q/6KduMDLP9WvW5/WTmg8tn2bdwhvIv+H4ozeeE=
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Configure auto presentation for the credential</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/{credentialId}/configure"}></MethodEndpoint>



Configures whether a credential should be automatically presented when a matching OpenID4VP Authorization Request is received. The wallet applies the same setting to the related credentials that the same issuance created, but returns only the credential that you gave in the path.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a credential stored in the holder's wallet.","in":"path","name":"credentialId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

New automatic presentation setting for the credential.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet presents this credential automatically if an OpenID4VP Authorization Request matches it. When `false`, the holder must approve each presentation.","example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet saved the new automatic presentation setting.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential record that the holder wallet stores. The wallet always returns every field. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request.","items":{"type":"string"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of previously issued credential tokens that have expired.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of decoded expired credential payloads.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": {\n    \"id\": \"string\",\n    \"credentialId\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"credentialToken\": \"string\",\n    \"credential\": {},\n    \"credentialStatus\": \"\",\n    \"acceptanceToken\": \"string\",\n    \"deferredEndpoint\": \"string\",\n    \"credentialIssuer\": \"string\",\n    \"preAuthorisedCode\": \"string\",\n    \"userPin\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"issuedAt\": 1750000600,\n    \"openIdOrganisationId\": \"string\",\n    \"organisationId\": \"string\",\n    \"userPinRequired\": true,\n    \"credentialFormat\": \"\",\n    \"presentationId\": \"string\",\n    \"issuer\": {\n      \"name\": \"string\",\n      \"location\": \"string\",\n      \"cover\": \"string\",\n      \"logo\": \"string\",\n      \"description\": \"string\"\n    },\n    \"credentialConfigurations\": {},\n    \"txCode\": {\n      \"length\": 4,\n      \"input_mode\": \"numeric\",\n      \"description\": \"string\"\n    },\n    \"authorizationDetails\": [\n      {\n        \"type\": \"openid_credential\",\n        \"credential_configuration_id\": \"PhotoIdCredential\",\n        \"credential_identifiers\": [\n          \"string\"\n        ]\n      }\n    ],\n    \"revocationStatus\": \"\",\n    \"legalPidAttestation\": \"string\",\n    \"legalPidAttestationPop\": \"string\",\n    \"legalPidVerified\": true,\n    \"autoPresent\": true,\n    \"version\": \"version_01\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"\",\n    \"expiredCredentialTokens\": [\n      \"string\"\n    ],\n    \"expiredCredentials\": [\n      {}\n    ],\n    \"requiresEncryption\": true,\n    \"isVerifiedWithTrustList\": true,\n    \"trustServiceProvider\": {},\n    \"oAuthFlow\": \"\",\n    \"authorizationRequest\": \"string\",\n    \"isWalletUnitAttestation\": true,\n    \"notificationId\": \"string\",\n    \"notificationEndpoint\": \"string\",\n    \"notificationSent\": true,\n    \"accessTokenType\": \"string\",\n    \"dpopJwk\": {\n      \"alg\": \"ES256\",\n      \"crv\": \"P-256\",\n      \"kid\": \"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23\",\n      \"kty\": \"EC\",\n      \"x\": \"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A\",\n      \"y\": \"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the credential ID is unknown, or the mandatory field `autoPresent` is missing. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create credential definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition

---
id: config-create-digital-wallet-open-id-credential-definition
title: "Create credential definition"
description: "Creates a new credential definition for OpenID for Verifiable Credential Issuance (OID4VCI) 1.0. Each entry of the `credentialDefinitions` array holds one credential configuration, with its credential format, claims and issuance settings. The issuer publishes every entry in the OID4VCI Credential Issuer Metadata and uses it as the template for the credentials it issues. Upload the card artwork with the update logo image and update cover image operations after this operation returns."
sidebar_label: "Create credential definition"
hide_title: true
hide_table_of_contents: true
api: eJztfYly3Da26K+geKcqUl2qLXlJJnqp1JMl+Y4mTuyxrHG9clRNiER3I2aTDIFWu29K//7qnAOQAJdepPYySc+tO2OxsePg7MsfQSJUXMpCyzwLjoPTUnAtFOMsE3MWlyIRmZY8ZYkYyUxCKzbKS/aqENnFGf7z36KUI8lvUsFO6/YXSs14Fgu29+ri7Om/Ty/22dHgcMDOeTxhItPlguUjpieCRfUsZ9UkKmK8LPmCTfI0USzPhLuYOM9GcjwrOTQN2VzqCZNauU1GeTnlOmRxyuVUMZ4lTNolKaG1zMZqwN5OBH4WJStmN6lUE6GYuBXlwqxRZrhGs4fmBkXJfhaaJ1xznGGmhGJSM66wlxbTIuVa4DHBh3p92AxnVgN2VaQ5T6gFLxPGSz3Pyw+0L/g6KxIYJs3HOZNTPhY0G32N81tRms95IehQFOMjLWBWqeqvrBR6VmZq8GsWhEH1+SIJjgM6U7r/MzmWmqfveJoKjVednHZcUhAGpfh9JpR+nieL4PgP/FOWIgmOdTkTYRu4OsBJ53AuXIsBu5wVRbpgUcpvRBrR/rlmqeBKsycsnvCSx1qUKsQDAKjogx66Pjh4ARDXBzyDIISda5FpWD8vilTG+Muj3xQs+o9AxRMx5fAvvShEcBzkN7+JWAdhoKVORd++gvV2/6DHBOCr84Kl4lakbCQFvBV4MQg1FsztQ5tP8lSwUsR5mVDfdZ/emofJ9IRrnKr1ptZ+RwSaRQnAqaVQcO4IDs4FKF3KbByEwVRmL0U21pPg+EnzuP8xm/LsoBQ8wdPEMRg1uZHZmJYJF58IfLh0SlL1IL09MRgP2De4WvY6LzWOepbHs6nINDs5+mZ/wK6USACeJQ4wWjQevTueORA6qG8US7ia3OTc3swtT2eCTWdKwxFrLrPuh0CtcXOKRa/5AldzpUTpnHEU1j+dAoLp/ukkjvMZNPF/vTir4C/CZxe9nuQ6Z/73EiBLifJWJBW6A+QHeBgemfjIpwW+lv4jDO7CoBMinbtH0KSrv9BiqoLjoyUPzQNPtfyKK/TzEIjHGzNgP2BnOctyzUpRCK5ZdCtKJfMMTlWXM6VPsniSl/DnB5lELC9ZJLJRXsbi3dVJBCDCM1oJ4buEhlO0TN5YCj5/pmbxBOiP87RfICmk8YkcRsysukIeIbsRMYdn4GymFIDoiJYZRE/PU9LJtzGifxGvllBtJjMlEwG76L6MbtJccw8cmBQlCl4iEeyfZl3Ew84duo/3aI9D8algEZ/pSV7K/8Vx39BxvF0U5lHU7VScFyLaCI9tH3M1iNwdPMBCGnKfnfGFe33ZbHojytY6fsHPMHrCF4rNMi3TGjwSdzocHFiZMzHisxRgJmdPDr1bjHkaz1LkLmEQ7LJgyMKMynxajYyETsupwGUDsOelfiNuc6LLzrpv8jwVvE1p301Ehk9MRCETGZyidzhlNRgzw/sLj0Y8VSLC+eu2Pws9yZPV10ft4GIIE3ZOPGCR0lzP1DCVSkfEOcIJXJy/fcHe5h9Exi6xAXsplWaqELEcya7Ow8eHj4+cEd49OfW6ws9+f8MNA5GRwEWlCzbHI2vjDKlY9NtcD2/jIfBDEUw9l0oNNSxx6C7j1l3EJTRiRZmPZIoA2tpS48jd00B6kc2mwfH7wPkehEFz2/CpdznB9Z3tAROelotC5+OSFxMZ/yQWtMXV90ntLBOl5DiDR/hBLI5ZlMjk+INYEG79+Ozwe2/t5tcgDOCnFcu5IJ5BinL1kn4SC8tjSFGyPaQf+x1LHLD/l89YzDOgG/GEZ2PCaMRekIiwgBbIgPezK4RBiDbVKPQqk7/PRCaU2vxRqllp8bkz4yxLrNDSQOOAf2A2VogSOVNR9j9a86rrlb4RFrNsulKepvlcmRlxIkMJWVmNCQdPGDABQMgELw8MenMkvv7l1o2eyyyR2ZhQSBfb0+R0HBiC+2Y3NACb0ghb4cgtDCGtieJciSHB/CrEMVX5cJrkMT6KJs9QgXb7tfw2/4BiGU0UXN/dhUEf9V39WM6EFuVUZgJucU6SEAq29iYV8wZnyay0ZNaeTnXTozSfDxq8wDARmstUGfT35sUp+/7J99+yNzKesBNv6DfVjBkShxuZqIpjMP8Y3nAlEjPYK+jPHg8OGf5GD5e6G1nb6e/BV/cSXfTU2QIwar0Kwlnw9+pz7lyqkQWWMSeW7cZWxMQ6kNXPdUnlH9iAvRFGi8JvuUyReTLnVWlSUiSmuL5K/YFvMJGqSPliNVN7Rg1Zzdp1qHdIjyMzC2lXF76yiScJ0cm8HPNMKoIO1O/A1boqHTwGwNE+9x9B48GslEYmu+Hxh3GZz7LkArrhL4MWB5rx6TovxmwRWndtzt8Xnp7bf0P+1vnRUjBnrmJWFrkiXrDe42me5mvQyX+IjyyGpizOk86t4D3V4xoxP/qvF/ifaB/n1eKjfsCM4qNmedY5s53uEP9jpoObXQ2HL2tlYPvUYPD27c9KuXoHV29e2gFrfSOui6f6rfi4Bsd0kmpRZlzLW0G7twfvDXjn3ShC7epdP6+v6tPu/aYxES74ziPWb4Qq8kyJi0yL8panqyWqn2Ump7MpK/I0BRIjTU+2JzOmRJxnidqvTsu8MUQAM9UkSWdiJErgOBzKfZ4lRS4z3eAq1uV0nZFGDtPbZMYGvkgAiBhkjn+fsr1/vnu7P2BREv+3Sg5+mxMfgCLN5dnBP9+9Zf8+HTh8Af56+Yod/f3w6MnBMzY9y+NH07OXhCvNGpKafs8nQFLzEYtgI6A4uY21QYBJHuNHxJUovhOmdCmes2zYvF0lqJPMkpDgoVyEW33NQbe46tz+efnqF2gJTGAplKoUQ0qklQKl4KXuwm98YZT/PqNm1gC0fsxlpuhHUt+gopFFfxvcxtHakhupkKK/Le/h3ByINB4HZ08R5g3C4G94VtrnwSyf2sPtNUmFC3LQklE7NUBOCRnqzfZHPFUisuoV5XoiSgNLRIRVzUYVheClZYUJqCwLMnJVHT58OzIVssRkJ7nKpD7RWoCIB1o+NhElIc7beI3H1635B1bHEfXWPJf6Ftc6FUuGZmV2LGYDMSvzgg9EPBCzRB4XMjk+MqTJPLI1WAir1dX32kAFdxutPy/HA6nyAaKTwbPB0SAtQDAe9CmWrzYgCqCK/Yh0LbVGRbIMeYxdks8zeM/Kea5WvSUVu3rzsovfhfcNvCtgNquhRW1tx5ojev2IUkpxK8Xcse+BLW0i4g/4c2Lv4EaM8lIgYrQqTVgIncpXoBRpLuLrV4XUv5xyLcZ5iYIDT9NXo+D4fXvNbUuh7XeRtLaE4ITAwH2+hnqwvUqQaf8K4kgFDvvHpGm9ODu5rLu3xm3Q9izPRMT2spzFwD6h0lCwcpaK/ZBF8KDYXiFKBVoZc/BGrQjaAmgjOMcBsoPfZzyFi0kYrzEjNPmd2nT/joBTzG4OqJHzk8XHNwtoA8iAk0ojBvZJ5yW7yZPFvgtvsB3gBiUctOA8CIPf6X/MDMG1a52CD3fXYZDNUpQguy3Zb5ssZ322Hcqrh1+Y79ygwlqghXtxJFDnxrqegLk+sOkVZX4rQdvm9KkvTwme0iSgVZopYLWRFp2E7Dmc/YvOW4RuCCXV5fm/1ev+V/z68jmDaxWAo+jOa9BDcANgnKUpIhIUfQGZAXnAdr5xAbCeWuMMKhbMv6GoHweBujI1aNMZoMYI+yDdGbRBbgnGNSM0epoRqnI49kY+L8mFwh2NpKYjiZ4eHhpGVpRlXpKKIzILBzXYEDoNs1wPR1JHA3aCw5GLBIMLdfcN/RSpUcirxICSuf/qrPcH7CRj07OXbM/hynFQQ+q7qOr07GW0z3iqcpYJkditVXd7cfnq0cX5acXWV8zApRxnoIQks0DI5hOuBao6AL7NIgfsBayPYAtPxEJT6DLIlQrl/OTEeyvnby8v2NtLdnT0PXv63eODI6CKqGhu2a0G7B0ePg1upnSRT2jt2HEFS950UlVW72PfcmrvHMl5fTQFiAnR+18DO8SvwXXE9irpaD9c0gduQmglB4dH3z/97vHh0eDwCP7v1yBkzRHhJvfDyjRpeFvD9xKnp5U8FvD/nB+L2XH1Us2pd7UpZjcR2yNueD9cCrqC86Fd0hB3NLRHBdCbEQdH1FdPeAb7ro41CQm8omkCTghjeQurxon2up1WBj/ILBEffxy0SfMxiYM3Ai37+YgB6IesgFkE5yH7Hf/b3vm+r6mLY1FoVT3Fn8TiFHCN2bGajcdCaZG0KXtElBb0XIxnai4qQcNaEMimb1CB0sCj6YmYuiYMR6B4Xeb5aFPzhW7vhINW1ZVTChiY7cETdqmwu4x/zvXWpkexzc6aj1iRK2WE5j3yhEL9xtHgkEXYaAgzqqFZirAM/QexcE5Hvalcz1a6JeBnYxJdWLrgchlGtQ44S6HBiRZLEqpdBjAhsL+W5aStfHLGXr28n5YtxhL6b5wW3zjLa88NpANgy1evdduTTvCORIIHYjoBYzUrpV6Qo4gRtkIXyT99xm64kvH+WnYeqfIhdhpiJ+hSfRHZBMwsyUH7p2meAJckvI8TOZ74/FtzdFDZzZQoh2BIgGtqeRGsOArozPzOzSP5KrcNGwfd1pbg7be5/rxw9lUe6l8WllDzjZqJ1QB1SlqPlq4zBJ8t4m2QpUFVNfowtjUi99FRIj3tsJT1aH6iyj9PbTS9q3T8P8Ym3qWnsVqdLk+w1lF2Aw460LUOzHFLxN96bfxdsFTdmb+gwld097gbtJfSUnPTkmTL3GX03DYAIEX8AufJjc6XpPmM0QIBMwD3iiaSsdkzMInomYysXkgiIwqIeCLkvmdGJo0dNh+wd+upGmHJI1kq7a4PPoJdAq2hquCxCGuunFykK89cPc9tV+OiTovCtvZMPMGzcphC30FvcoIbz8+1usxOhoaO7D4HRP6B5v2/D3iSgBkDfTBm4A6JWropzxKujarrvkxgOgdXQpnF6SwRDsR4PDewzAAYU6nQ7EVvEpxacUQyksqp1GdSxWkOrkT3WRP59KBnS0IDCQeECajlrQAT0t1d6MQ2vKfnch3CSeFj5+lr5znBHHfNLubJX/eoor88WvVsehujUnzWOL/SvNTG5cLpcDnDbUWdnsa1tctRm9+INJ8bM9dfEYl6+/8iePNtF0LsuNPBF0JUrZXAXdXGg68Na20RiTS/N2392MLEG6xle1SO+8194pF8B+Pma0IyZ2WJhjPdpahDI4aHR5ETEmUVAQN2QlfQ4tQ6sQmp3jImeJmCUejW356/1Mq/Kp9CSJ7emp0IMZbl2Ov9+by2831njXugY/K7q5MHPPLKndJhDXQONlY0O3DjLf/OOL5lUjNH/cT23l2d7He5jrp+cy7gI9nGjYjE8obnV2cXdoaTMp5ILWI9KwV7A84+Arq+KPlUQHToSu9ndEviyMIYJ1RyM7ROQg84q9qL2FAaM491pDX+jMLM1OkE6sb69O1kfadMGoAl3c6ZRFB6Y4RWhIW5Zqa8kKLPc1NmsHzfL7PV0nXtpA5dnps1VkoFvyW1MBPTQgNRztmMAoYX+axk+TyzAcNhZd6/f8Dw+qht51m68yzdeZZuzbO0wdFRrGBfPOx1zQfjGsD+e9BwtITvSE6d0MPgNTluWJpueKAzSGAAXgH7gcM1usyJT2QRRffG6r5fa7oDMFoHXXGJR38/7Iz7I0eMdkBeI0ZsaZiSWfnSAKFqd93MmMMzLWOVgmBZYE873OXjM1DWfpAJigS90S69URsOrSRcvM5d+0AKLBkEcvObfKYp1CkW8NSQ0KwajiJyb2uBIaEsEl5WDvCE4wyjn0ViqGqIotMCJrwxZgCRkl0AHIMyE0spM1qHwyTBY2yh7uC/RvifwEOvgcGEwQoX7mddjtOeqzB6cwZLfCUDV1Vu/wWPoqmyIoB2JFT6QGqEWg13fRfev7Onw3vIMGke81TqB49TijFA2wNHUboUQg8fdEQ3stQT4Iju111MuUzv13XEpzJdDPGd3msAcIjIHtBfqiEwgcOjvz+s/+Ojh/X/9tn9+heTPBNDE2VxfXd9d4cKD0MGOyIKdsRwRwx3xHA7xLCKlXHiAYIWLRwUMhlsjRb2D8/H4mG4bI2h74vm1hj6vhiwf2gka8MH0LXekR9A8foHfTAt7B/6oVSyf+QG/dnq2KVQqEJ9GHOzxvjxvbm5dQZ/CNe5xvjoOf4JRwf2ssVZuGFgXzlHYafblKNoxj7aaL8dp7HjND47p+HH6xKn8X6p6H3d713hcB+9qKHLoOyh4Xv1bMjg9xzDF8DvOYgrfd9ziC7Re6OhGnL3Rn0dFmSjfi0uY6PeTUZio85NWftenS0Heq/OlsfcqHOPiH3+/N2rdZXN5/BCBc/Yc0hfIJSyts1XcwgDujhjezTctuniRhO3KeSTnci9OSHchlL1pRjzlAieT++A3G1LlPQdhDbvn8IifyFc0H4V6+qedm9j9zY21bF05zfY1rtojd5yptvOmEvfz0oJa/dudu9mbYmhT5i1ksRyevMJZInme9qoc/vhWLcBOhtEAI8PD9t+t64HE/r2JP3OPSj5WQevBMsUrJ8p8m1nuQH2+PAwRD9yiFneJON+w+G75zaW5mZwKw00vFLNWQwqiOhz7JZrpP2t30mH54jvTla541P4SBX+YZwfVbef/UUS+YnUvx8dxY/5k6cHz26+TQ6eiu9GB3/n3x8eHN08jp8kT8Wz0beHfZlvLtbYEeEY15+TK3DhpBz3/QA0K2w+BNwvZauBTF9npNywroz9I8hspQ+y6nJCrr3Z7ndSOZa6eOX4661zTu2bN4s3rmyJKNKcUuwjBNpb7/U4NJcGsHniOkX1ZJW7yuRHTJitNJ8Wfi45QNHwurIxuRQuqXAw58p9EdXpHX33jHQ4hxD+iC6En3tZKQRXTfME0xN0Le5bXNxnzK++YWWIT1AAYUs1Dz5/mv26vAWmcqmiPrgpTeI+EkhC1CzX8umLD6BrttGDmiB/OqIvcFz3okVtzL2yRIC7s7HIME5Y1S75hMZrZsChUOr99QCyyrTz5vmp75Hho6jI9iAOrDeH41nluNz5/mxlikZeLnd398PivbfHlcsgbQb5hiaYuE9Kwg8ZUOq84kvvyY0w8ONogs+LAL9QgYmtlIRwWEAzlnJrQuQjr1BXnb2vvec/Y3WILZZ42NVx+IrDpbZSx+FB9Ru2XKrB1miAgO57F2n4T6jH4NRg8Ku42GgIJycGpUj9ogUY/vG1VF3YoMLCZ6+TsBGDpoRW7bD+DUolfJ6KB58tSAxN42uM/Pz09dPvWMqz8QwifDQfV+O3Iwf9NHAm/hgOPhLZwf88N6mJ5TjLSwyEXDBaBr1xwMZKZL60GmDPXVjbLqztLxPWtiuY8FkKJvwZixz4iiKqdgBX3VPWAH9yDhK/OwUMPmGxgpWkeXXGna1UJth2sYF77su5hM9ZWeCeq60f1+coI4D5vTvrCHQlTUFLy81MmorOsZMCqlMfsUsgskvnv0vn35HO//Ok76+O2xi1mtn+JpxMGlVi6lYNZ9A1mnIdLS6tmhCGMTnwUYXiZ6buBN1WzfrLRqfOI8JSIt059PthLmRTDrYVU2FaTiuek7JgD9iFphwkChMmYgUDAu2O1P0w3UjavGh9dyaaS7C5V+xqTZL7lUnt4Wj1+insiegoSNHSPBPXIO4lecRTDZkiE3opFCSukcr9CykBp3Ep93kGCpC3dYsI8oYfZLk+gGoAXhbxotKbtJl66r0aDTsz2fOFVR+zCO4CcuV78wOS+AjpaSJTxkEfYHtM9U5dei/YhavqohEmBo1Z2kN4dRQ49gop4Q8hAC85mNsxnnCZuSBGFCQxhEObS4XkZMDcMm7S1WPmurysM7h7o1YZ+yPMGqUvkqg6vgrbm4R807OXJo8oNoVM93l8YEv2HKCfRQm56O3JLt99yG5mutoNQDHWK4KeVN/CxH6Axvrcfo6cE2gPL1EnWUeNAAbcr+AWYbNaAdU7wOxp3u0f+5uvandU77OlJYbR7PFAfQnCDwzdhHy1HAALukfWIIK6FthcEAbOMnySgP0gM6BQUNZktVYXHgNI5cp7CyFWE6iySOIqKw4OLsG/ngo2RvIjUZTqVLArpllEiCDCAejKFEE5ySj1E9EgFHPwSZlCGQY+QpOpMaLrPcbWZJ/8Af75I5gtf4ACDDIWP0bOVOaxvWg+XcwjWc+MgI/5vkjWRQEQlBUVsatAr1WPpPu6qxMiazF2W6qpblv4YQGNrJCt5IgG6Tk3ft3DErj0bgWqsgJr1OYdEbpD5j50V7xduzrKEgraQP9qAjWqPejLcpbmGWYAlZCM2MWKhOQ4y8S8jRUHtWOVR1WMtaa33EXXfS0vokTMZ1M0q0+xwhaEKKnWo7VwVOUepYW3PSNlVoJluFzuBKLVHQkaOYVTWuQJV01ZK71XTJV4rK9CVboIUGiamnp1MVc+DkM2Fhq6GAr+3lUA2VUA2VUA2VVt2FUA+coO9S8LS5+2AsjDNc2tcsV/rWTxX1nFjRfedaxdWsM7vz9fkYsvU7hiaX75z1iOYitWsrXrTPz1UIBfL2KT2g1/lXINazyHu/+cwgle0QSp2jUTvICK2hiWVLJqZ4EEqdjJ6wvELoBoKt2niQNov+LK6KarqC9SWoAMnWF9V1KvKlAQBrvyB3+l8gftIIX/uPIEuOiF0mL6M8/42FMwrL20IuUa9KZsimMsjf/rAI68ZIlIBahSGa3FDJQsA4yPWmQKzxQQ0cbrRhOCGYJKr9jiB+6ckIlqjRN8iLtpN5NxrxgcAmBlKyXUHjc6Z0nJ5+s5x23HkRXUtpnvzkqhZ0QSNtqYh1Yxrn1J5rCdz+xX5jPr7td8/tx+tN4S6qRtG/vWElB3T9vNPbQrqVTVT/zyc5xdvbnoAjGbZwBHwxWGtoa5RNaIrFi1V0anmb4KOcUSLl+1M3ADjYEsbVuCll0peSMhV1y76Bjsol7M9ad0KV592W4lmi9852335U/hEN2+i5a1EklLhZ798dvYycUR5rG2b/T6s0VnOkjkyeEXDdXs5UO+jpDNcOMgzfA+YZnbjMD8hGGDBqKc6EE3GcgudPCLhg52Jmyo0KpRMdR41Fv1FuIOtxGV4aWwcYvumSOjUrlk06Uu6rgRs7FnHO3Bzz70Xdz9cA341XEp74rW2N+Fa3zBcI2Ouov25TTi4LcQkeEyLlBgtK31dh6RqVtqfEWaULzl6A6iZ+sZ1wbsgpSpdeoOdMYhvbO//UbwkidXLMvcvI0YkNV7qgGskovbKg2zx66nazHKylART4LtSTh/FwaV5Wv1pn+xTd0NwyvqXKdLmPynSXyxse413G160uG4brS+wc6a8XxLA9DL2lQCtouvLnaGnhwta2fV/lpNWjur9s6qvbNq76zaO6v2A63avo6JkkZ3PBAMX+zMgulmpHTTQIZVpVpr4OnQNXVIcf3cQEvWqe3xYYDBKCdZPEF91weKAqztn10apw6Vz3JlxnLNwvoGTJe7a1oQO4xzKO36TwsvbiI46CaC4z/gr6eU33ftDLqr4//OyzJva//goQn4pQpsw0CIcr1cfOh7MJopnnbFTpj4GZD4uNuOmydvcFCR8rhSLp+fnFS+9iHjqcrZBEKQIlwkpblBERL/fgH4twNZ4o+neeISKMMZuBz7U0wnio3PNjE6EXYSaVKFDxRlfpOK6YC9Q4ReL9YyDyJNnFAcQm1kuBmZ5j+bqJVG9t/u3ImH14N+B4ZjdsL+BQeZCZEAx1TH6yoBLHUdC2LSFDvBZHgBTrAIRBT/Kz7Np0UqUUmGFbkAWUKqZ/av+PLy9Kz1EYVQAbPtD2xepr4oOhMZhysuyvxWAnuwB9G+B/ZPigOoTnX1DUUGDkG/NIT4lmGW62F3dGFv4Gt3EBPEILbMIEuDVI3KzY9RNTHCawegQnj20E40xAc0hIMrbzH+rrnc6nSrtWF8dxXD7cVqUzDXeo8Svp2/vbxgby/Z0dH37Ol3jw+OKNLNUrDEJLu2XfYH7BXqOvACFT3oLHefiafA7rk6CgTvOwPfs7l3DAtGiDk2eelWLoXOTphfkSvpWZu78r9W6LInE+oPyJn8uOxNG0VaL1ivMTYykBHxPyvaGq0XBuqTnosiy5YC4YPxVnU5P68bsnmSkqnKC9s0lKY3cHNrAZuvQKE+byB8Iz32XhQMssA6cNpGikOYfyO4f2BjGKNuwEIS6CCxE4ysAsQxsMuv6AnbQ3E28XPlVj9Xfmvgr7ZU7eoww39CAtOy0NZMRAePcI08W1c0PS0Fo6qRwfVEx9qaLRUj45sRH5G9RplxKhUmtcpLcLIojcyUsSfgJAacqChV6PcijTKzT7H2QkNtYNiSUH2jVWTMOo7RiJ5+Szdt4htxOa6CBMfnPWglMjmzS1EIDj5Chs0HYuTw+fAn+FEifqp5/Xr0RgoNxMpSVa6LNzk4u5pY2rygKBubhhpc3GARYa2Mh79BKWz8EPi4FAL8WZbkV8SHDfkV60VZgPGpRPvg6ntt34YXCotrcULpEzuV2cFnp+wu570U/4ceU/6J6BFRo33sVft8kDZnxGXKaqFywN5VDVaze/Z4PT4PA4E7LqqHp6MRNuPsSECggG/K+OKedz8ZaQpBD+EtwqYIUuVH8QkrJBDoT37A9lxaamKroybmrMf2JahaJPK0P3iiLbJtsqVUDBkIorCcyuF9VUaMffvUKKNFMvgVFAhNEfxoIxF8fdqxqg7N1sXXmi17zgEfFjMNRmE+FRrYrrsOYnaVWTyIagz/aJ5tqJ34cx0NaoTANoWIz4g1jTMCvxUT74n5mU4K+ZNYYNoK2CMfYyGtM1PD17jb11HxUFyMnDrgSKa2WliRo1MPqV6DR7ePHxFRfGSKAR+Qh/EjUO3J5JFKfpvrRzVeOKhVOKCpwtVTdauG3VVMc7M5UAKWUBdtonWhjh89SsQ0P+CFHMhxyTM9kHkAFa78AV6XeTKLNUW9dg6zaoRLzceAnnu6K/q5uZDr+tQvAfgIZuzZ18IEfQgDCVPRtRk1HggVLv1vixyvLyiLgBfc69peDbaMvHEiRtOw6UxpKMRclGIkP9ognYjWyDABm4kE0SWXmA0VVYv7ISNbtDfsMTMdf4DizXAcBx/E4seIlMXwEA0D8zxPFucW1Otqd0tq1KxTLM95RU23wwfVwVtdBcDxJlovR7/rj7TEwY0WuNTljJr0e4DVnk73q4Zn8os7KolW7fEebUX1uV21u85p6BTtrj5a72/0fa0/V77MjhDY4Ubs9VqVCvhwC/X8zFTXtp5sfRxVDc3qU68zgtvkYdUSO+aqs+WY5IW9WV48gKuzr9DnJZlPGplGvKQM7bwB1z35DDpa1tkktjjmXU/xUlsHscOe3VFutLMs6d31Eitwx1Sr7HitebEIY2+R0a0Bjxve5wHF6gg6k3XpPwtN3AH5HeWWj+Tk8UaF34/t3v9vTdwr+iz/p/7kcwUuQ9HYc9XJaoBQLgalEwTbSfhfIHyVu/k6Yb6dtQlBnunu+JoUFSaQ0rJ6r/dhRTqPc/LgMmG5Aq2FysRR/K8p8qZzUiSRJzNJWLcww4IZDtDzk6fk6EoDPJeJOoiNkk1jlKbxPjAn7UjX5NMYNlz8aLYVTmjWrRYUiamMRaaEA48nBY8nAmpitK5uPp8POP48yMvxI9NXPXp5cXr+y+X5AfS5q82a9XXCYdl0ipZjq5/q48PHTwdPyAcPmOcpz5z1nJK1s9PG2Xw1jrRj+imbWq3TRArHeZ84cQzpPq8rzVluske1Rp4NpL/Ll5TCM4puUGi0biu0ChRUltklKaF1K+25UwyP/CZwjWs7puMMqKyERJ5WxTAFdWVXRB02w5nVgF0VxllZUGgbL/U8Lz/U+jBjsa7Dp2g2Y8d2QpDq8qFVHtCucrakEzD8BODDR0XKZQaghLBbk5Tbx1TsdiSJXXNlMeNogR4MKI95fIIrkV2HwQTku+P3wR9/QAGXqzK9u4PPv89EibIjsEalpFR7768rpwGkb0BrjoNTAtID5DFDW1e7LZ6DxEU9KGfR0rauCPr61eVbIB15gpRmiqJ4UPI5OGDweXAc/Br8GuCutS1pid9BaqDgUuD3cFxbb8gXzYhomn84uY15tnBW2ZTSaDPw37C1zi4/AK74SSx+rJrTL70dKsmQWsPdg97//wMV5L8+
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create credential definition</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition"}></MethodEndpoint>



Creates a new credential definition for OpenID for Verifiable Credential Issuance (OID4VCI) 1.0. Each entry of the `credentialDefinitions` array holds one credential configuration, with its credential format, claims and issuance settings. The issuer publishes every entry in the OID4VCI Credential Issuer Metadata and uses it as the template for the credentials it issues. Upload the card artwork with the update logo image and update cover image operations after this operation returns.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Credential definition to create. Supply `label` with at least 3 characters, and one `credentialDefinitions` entry for each credential configuration.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 3 characters`"} schema={{"type":"string","minLength":3,"description":"Human-readable label describing the intended use of this credential definition (e.g. 'Issue Portable Document A1'). Used to identify the credential definition in the issuer's dashboard. The value must contain at least 3 characters. The labels `Payment User Credential`, `Payment Card Credential`, `Payment Account Credential`, `PID Issuance` and `Photo ID Issuance` are reserved for the platform.","example":"Issue Portable Document A1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitions</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

**Possible values:** `>= 1`

</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configurations of this credential definition. Supply one entry for each credential configuration that the issuer must publish. Do not repeat `version`, `trustAnchor`, `kid` or `enforceWUA` in an entry, and do not supply a configuration field such as `credentialFormat` or `claims` at the top level, because the issuer rejects the request.


</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label describing the intended use of this credential configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"expirationInDays"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Number of days until the issued credential expires. Defaults to 30. The issuer calculates the expiry date from the issuance time."}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, enables credential revocation support. Defaults to `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationMethod"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`status_list`, `status_list_2021`, `swiss_token_status_list_v1`]"} schema={{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List specification. `status_list_2021` uses the W3C Status List 2021 specification and is valid only when `credentialFormat` is `jwt_vc_json`. `swiss_token_status_list_v1` uses the Swiss profile of Token Status List. Defaults to `status_list`.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]}}></SchemaItem><SchemaItem collapsible={false} name={"statusListCryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"statusListCryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"enforceCredentialUniqueness"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, ensures each credential under this configuration is unique per holder. Defaults to `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialReissuance"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, allows holders to request reissuance of expired or near-expiry credentials. Defaults to `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. You can use `cose_key` only when `credentialFormat` is `mso_mdoc`.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`authorization_details`, `scope_based`]"} schema={{"type":"string","description":"Determines how the wallet requests authorization during the OID4VCI issuance flow. `authorization_details` uses RFC 9396 Rich Authorization Requests and forbids `scope`. `scope_based` uses OAuth 2.0 scope values and requires `scope`. Defaults to `authorization_details`.","enum":["authorization_details","scope_based"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value for this credential configuration. Supply this field only when `authorizationRequestType` is `scope_based`. Read the available values with the list scope operation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display properties for the credential card in wallet UIs. The issuer adds the organisation logo and cover image when you do not supply `logo.uri` and `backgroundImage.uri`.

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`)."}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format of this configuration. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL. The format determines which of `type`, `vct` and `doctype` you must supply.","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]}}></SchemaItem><SchemaItem collapsible={false} name={"validationPath"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`$.vc`, `$`]"} schema={{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. Use `$.vc` when `credentialFormat` is `jwt_vc_json`, and `$` when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.","enum":["$.vc","$"]}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential type strings. Required when `credentialFormat` is `jwt_vc_json`, and forbidden for the other formats. These values appear in the `type` field of the issued W3C VC (JWT). You cannot use `WalletUnitAttestation` here."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type identifier. Required when `credentialFormat` is `dc+sd-jwt`, and forbidden for the other formats (e.g. `urn:eu.europa.ec.eudi:pid:1`)."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type identifier. Required when `credentialFormat` is `mso_mdoc`, and forbidden for the other formats (e.g. `org.iso.18013.5.1.lpid`)."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of an external claims schema. The issuer downloads the claims from this URL. Supply this field instead of `claims` or `credentialDefinition`. Use the preview operation to check the document before you use the URL."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialCategory"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}></SchemaItem><SchemaItem collapsible={false} name={"supportAttestationProof"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer accepts an `attestation` proof (key attestation)."}}></SchemaItem><SchemaItem collapsible={false} name={"supportJwtProof"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer accepts a `jwt` proof of possession (OpenID4VCI 1.0 `proof_types_supported`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyAttestationsRequired</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Object specifying key attestation requirements per proof type supported by the Credential Issuer.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key attestation requirements for the 'attestation' proof type.

</div><SchemaItem collapsible={false} name={"key_storage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted key storage security levels (e.g., ISO/IEC 18045 basic).","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem><SchemaItem collapsible={false} name={"user_authentication"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwt</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key attestation requirements for the 'jwt' proof type.

</div><SchemaItem collapsible={false} name={"key_storage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted key storage security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem><SchemaItem collapsible={false} name={"user_authentication"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. Supply this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc` and you do not supply `credentialDefinitionUri`. Do not supply this field when `credentialFormat` is `jwt_vc_json`; use `credentialDefinition` instead.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"undefined[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. When `credentialFormat` is `mso_mdoc`, the first element is the mDoc namespace, the path holds at least two elements, and every path in the configuration uses the same first element.\n","minItems":1,"items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim. The issuer reads a missing field as `true`."}}></SchemaItem><SchemaItem collapsible={false} name={"limitDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. Supply this field when `credentialFormat` is `jwt_vc_json` and you do not supply `credentialDefinitionUri`. Each path starts with `credentialSubject`, because the issuer validates the claims below `$.vc`.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"undefined[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. The first element is `credentialSubject`.","minItems":1,"items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim. The issuer reads a missing field as `true`."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OpenID for Verifiable Credential Issuance (OID4VCI) specification that the issuer uses for the issuance flow. Set `version_01` for OpenID4VCI 1.0. Always supply this field, because the issuer uses an earlier version of the specification when you omit it. You cannot change the value after you create the credential definition.\n","enum":["version_01"],"example":"version_01"}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"enforceWUA"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires the holder to present a valid Wallet Unit Attestation (WUA) during the OID4VCI credential issuance flow, as defined in the EUDI Wallet Architecture Reference Framework. Defaults to `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"supportInteractiveAuthorisationEndpoint"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes an interactive authorisation endpoint for this credential definition. Defaults to `false`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Default display properties for every credential configuration of this credential definition. The issuer copies the organisation logo into `logo.uri` and the organisation cover image into `backgroundImage.uri` when you leave them empty. To upload your own artwork, use the update logo image and update cover image operations after you create the credential definition.


</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`)."}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The issuer created the credential definition and published it in the OID4VCI Credential Issuer Metadata. This operation returns 200, not 201.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential definition that the issuer created.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition. This field holds the same value as `credentialDefinitionId`.","example":"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier assigned to the credential definition upon creation. Use this ID to reference the credential definition in OpenID for Verifiable Credentials Issuance (OID4VCI) operations.","example":"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that holds this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) indicating when this credential definition was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) indicating when this credential definition was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label describing the intended use of this credential definition (e.g. 'Issue Portable Document A1').","example":"Issue Portable Document A1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configurations of this credential definition. The issuer publishes each entry as a separate credential configuration in the OID4VCI Credential Issuer Metadata. The value is `null` for a record that holds no configuration.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this credential configuration. The issuer generates the value. Use it in the `credentials[].id` field of the issue credential request, and in the `credentialDefinitions[].id` field of an update credential definition request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialConfigurationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration as published in the OID4VCI Credential Issuer Metadata. The wallet uses this value to request this credential configuration during the issuance flow."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label describing the intended use of this credential configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"expirationInDays"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Number of days until the issued credential expires."}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer supports revocation of credentials from this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationMethod"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`status_list`, `status_list_2021`, `swiss_token_status_list_v1`]"} schema={{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List specification. `status_list_2021` uses the W3C Status List 2021 specification. `swiss_token_status_list_v1` uses the Swiss profile of Token Status List.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]}}></SchemaItem><SchemaItem collapsible={false} name={"statusListCryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"statusListCryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"enforceCredentialUniqueness"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, each credential under this configuration is unique per holder."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialReissuance"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, holders can request reissuance of expired or near-expiry credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. `cose_key` is valid only for the `mso_mdoc` format.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`authorization_details`, `scope_based`]"} schema={{"type":"string","description":"How the wallet requests authorization during the OID4VCI issuance flow. `authorization_details` uses RFC 9396 Rich Authorization Requests. `scope_based` uses OAuth 2.0 scope values.","enum":["authorization_details","scope_based"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value of this credential configuration. The issuer sets this field when `authorizationRequestType` is `scope_based`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display properties for the credential card in wallet UIs.

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties. The issuer always sets `en-GB`, and ignores any locale that you send.","example":"en-GB"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`)."}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format of this configuration. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL.","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]}}></SchemaItem><SchemaItem collapsible={false} name={"validationPath"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. The value is `$.vc` for `jwt_vc_json`, and `$` for `dc+sd-jwt` and `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential type strings. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. These values appear in the `type` field of the issued W3C VC (JWT)."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type identifier. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` (e.g. `urn:eu.europa.ec.eudi:pid:1`)."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type identifier. The issuer sets this field when `credentialFormat` is `mso_mdoc` (e.g. `org.iso.18013.5.1.lpid`)."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the external claims schema that the issuer used to build the claims of this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialCategory"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signingKeyCheck</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The check of the signing key of a credential configuration, made at the time of the answer. It covers two rules: the certificate of the key fits the credential category of the configuration, and the key of an mDL (doctype `org.iso.18013.5.1.mDL`) has the ISO/IEC 18013-5 Document Signer profile. The save of a credential definition uses the same check, so the result is the result that a save gives now. The result `does-not-fit` does not stop issuance.

</div><SchemaItem collapsible={false} name={"result"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`fits`, `does-not-fit`, `exempt`, `not-checked`]"} schema={{"type":"string","description":"The result of the check: `fits`, `does-not-fit`, `exempt` or `not-checked`. `fits`: the certificate of the signing key fits the rules. `does-not-fit`: the certificate does not fit a rule, for example because the certificate chain of the key changed after the save. Select another key, or request a certificate with the `presetId` of the category (for an mDL, the preset `mdoc-document-signer`). `exempt`: the certificate does not fit, but the key has an exemption (`trustedListExemption` of the key: the certificate is in a trusted list), so the save does not refuse it. `not-checked`: the category is `none` and the configuration is not an mDL, so no rule applies.","enum":["fits","does-not-fit","exempt","not-checked"],"example":"fits"}}></SchemaItem><SchemaItem collapsible={false} name={"messages"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The texts of the check, one for each rule that the key does not fit, with the fix (the category rule first, then the mDL rule). An empty list for `fits`. For `exempt`, first `Exempt: listed in <list> as <service>`, then the rules. For `not-checked`, an empty list, or an information text when the key has a PID certificate and the configuration does not issue a PID.","example":[],"items":{"type":"string","description":"One text."}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"suggestedCredentialCategory"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`pid`, `null`]"} schema={{"type":"string","nullable":true,"description":"`pid` when `credentialCategory` is `none`, the `vct` or the `doctype` is a PID (`urn:eudi:pid:1`, `urn:eu.europa.ec.eudi:pid:1`, `eu.europa.ec.eudi.pid.1`), and the signing key fits `pid`. Set the category with an update. `null` in all other cases.","enum":["pid",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"supportAttestationProof"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer accepts an `attestation` proof (key attestation)."}}></SchemaItem><SchemaItem collapsible={false} name={"supportJwtProof"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer accepts a `jwt` proof of possession (OpenID4VCI 1.0 `proof_types_supported`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyAttestationsRequired</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Object specifying key attestation requirements per proof type supported by the Credential Issuer.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key attestation requirements for the 'attestation' proof type.

</div><SchemaItem collapsible={false} name={"key_storage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted key storage security levels (e.g., ISO/IEC 18045 basic).","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem><SchemaItem collapsible={false} name={"user_authentication"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwt</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key attestation requirements for the 'jwt' proof type.

</div><SchemaItem collapsible={false} name={"key_storage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted key storage security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem><SchemaItem collapsible={false} name={"user_authentication"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. For `mso_mdoc`, the first element is the mDoc namespace.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><SchemaItem collapsible={false} name={"limitDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. Each path starts with `credentialSubject`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. The first element is `credentialSubject`.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the OpenID for Verifiable Credential Issuance (OID4VCI) specification that the issuer uses for the issuance flow. `version_01` is OpenID4VCI 1.0. A record that you created with an earlier version of this API can hold another value. The issuer sets the value at creation time and never changes it.","example":"version_01"}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"enforceWUA"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires the holder to present a valid Wallet Unit Attestation (WUA) during the OID4VCI issuance flow."}}></SchemaItem><SchemaItem collapsible={false} name={"supportInteractiveAuthorisationEndpoint"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes an interactive authorisation endpoint for this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the platform manages this credential definition. You cannot change or delete a system managed credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"extensionEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, an extension supplies the credential data for this credential definition."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display properties of the credential, as published in the OID4VCI Credential Issuer Metadata. Wallets use these values to draw the credential card.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential shown in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata.","example":"Legal Person Identification Data"}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties. The issuer always sets `en-GB`, and ignores any locale that you send.","example":"en-GB"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`).","example":"#FFFFFF"}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`).","example":"#000000"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image shown on the credential card. The issuer sets the organisation logo when you do not supply a URI. The issuer always returns the object, and `uri` is empty when the credential definition holds no logo.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image. Wallets use this text for accessibility."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card. The issuer sets the organisation cover image when you do not supply a URI. The issuer always returns the object, and `uri` is empty when the credential definition holds no background image.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"expirationInDays"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Number of days until the issued credential expires.","example":30}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer supports revocation of credentials from this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationMethod"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`status_list`, `status_list_2021`, `swiss_token_status_list_v1`]"} schema={{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List, `status_list_2021` uses the W3C Status List 2021, `swiss_token_status_list_v1` uses the Swiss profile.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]}}></SchemaItem><SchemaItem collapsible={false} name={"enforceCredentialUniqueness"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, each credential issued under this definition is unique per holder."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialReissuance"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, holders can request reissuance of expired or near-expiry credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. `cose_key` is valid only for the `mso_mdoc` format. The value is `null` when the record holds no binding method.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format identifier as defined in OID4VCI. Supported formats: `jwt_vc_json` (W3C VC JWT), `dc+sd-jwt` (IETF SD-JWT VC), `mso_mdoc` (ISO 18013-5 mDoc/mDL).","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]}}></SchemaItem><SchemaItem collapsible={false} name={"validationPath"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. The value is `$.vc` for `jwt_vc_json`, and `$` for `dc+sd-jwt` and `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential type strings as defined in the OID4VCI specification. These values appear in the `type` field of the issued W3C VC (JWT). The issuer omits this field when the record uses another credential format."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type identifier used when `credentialFormat` is `dc+sd-jwt`. Included in the `vct` claim of the issued IETF SD-JWT VC.","example":"urn:eu.europa.ec.eudi:pid:1"}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type identifier used when `credentialFormat` is `mso_mdoc`. Identifies the credential in the ISO 18013-5 mDoc/mDL format (e.g. `org.iso.18013.5.1.lpid`).","example":"eu.europa.ec.eudi.pid.1"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Namespace identifier for ISO 18013-5 mDoc/mDL credentials. The value is empty for an OpenID4VCI 1.0 credential definition, because the mDoc namespace is the first element of each claim path."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the external claims schema that the issuer used to build the claims of this record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. For `mso_mdoc`, the first element is the mDoc namespace.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><SchemaItem collapsible={false} name={"limitDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. Each path starts with `credentialSubject`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. The first element is `credentialSubject`.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialDefinition\": {\n    \"id\": \"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60\",\n    \"credentialDefinitionId\": \"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60\",\n    \"openIdOrganisationId\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"label\": \"Issue Portable Document A1\",\n    \"credentialDefinitions\": [\n      {\n        \"id\": \"string\",\n        \"credentialConfigurationId\": \"string\",\n        \"label\": \"string\",\n        \"expirationInDays\": 0,\n        \"supportRevocation\": true,\n        \"revocationMethod\": \"status_list\",\n        \"statusListCryptographicKeyFormat\": \"did:key\",\n        \"statusListCryptographicKeyIdentifier\": \"string\",\n        \"enforceCredentialUniqueness\": true,\n        \"supportCredentialReissuance\": true,\n        \"credentialBindingMethods\": [\n          \"did:key\"\n        ],\n        \"authorizationRequestType\": \"authorization_details\",\n        \"scope\": \"string\",\n        \"display\": {\n          \"name\": \"string\",\n          \"locale\": \"en-GB\",\n          \"description\": \"string\",\n          \"backgroundColor\": \"string\",\n          \"textColor\": \"string\",\n          \"logo\": {\n            \"uri\": \"string\",\n            \"altText\": \"string\"\n          },\n          \"backgroundImage\": {\n            \"uri\": \"string\"\n          }\n        },\n        \"credentialResponseInterval\": 0,\n        \"credentialFormat\": \"jwt_vc_json\",\n        \"validationPath\": \"string\",\n        \"type\": [\n          \"string\"\n        ],\n        \"vct\": \"string\",\n        \"doctype\": \"string\",\n        \"credentialDefinitionUri\": \"string\",\n        \"cryptographicKeyFormat\": \"did:key\",\n        \"cryptographicKeyIdentifier\": \"string\",\n        \"credentialCategory\": \"eaa\",\n        \"signingKeyCheck\": {\n          \"result\": \"fits\",\n          \"messages\": []\n        },\n        \"suggestedCredentialCategory\": null,\n        \"supportAttestationProof\": true,\n        \"supportJwtProof\": true,\n        \"keyAttestationsRequired\": {\n          \"attestation\": {\n            \"key_storage\": [\n              \"iso_18045_basic\"\n            ],\n            \"user_authentication\": [\n              \"iso_18045_basic\"\n            ]\n          },\n          \"jwt\": {\n            \"key_storage\": [\n              \"iso_18045_basic\"\n            ],\n            \"user_authentication\": [\n              \"iso_18045_basic\"\n            ]\n          }\n        },\n        \"claims\": {\n          \"claims\": [\n            {\n              \"path\": [\n                \"address\",\n                \"country\"\n              ],\n              \"mandatory\": true,\n              \"limitDisclosure\": true\n            }\n          ]\n        },\n        \"credentialDefinition\": {\n          \"claims\": [\n            {\n              \"path\": [\n                \"credentialSubject\",\n                \"identifier\"\n              ],\n              \"mandatory\": true\n            }\n          ]\n        }\n      }\n    ],\n    \"version\": \"version_01\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"enforceWUA\": true,\n    \"supportInteractiveAuthorisationEndpoint\": true,\n    \"systemManaged\": true,\n    \"extensionEnabled\": true,\n    \"display\": {\n      \"name\": \"Legal Person Identification Data\",\n      \"locale\": \"en-GB\",\n      \"description\": \"string\",\n      \"backgroundColor\": \"#FFFFFF\",\n      \"textColor\": \"#000000\",\n      \"logo\": {\n        \"uri\": \"string\",\n        \"altText\": \"string\"\n      },\n      \"backgroundImage\": {\n        \"uri\": \"string\"\n      }\n    },\n    \"expirationInDays\": 30,\n    \"supportRevocation\": true,\n    \"revocationMethod\": \"status_list\",\n    \"enforceCredentialUniqueness\": true,\n    \"supportCredentialReissuance\": true,\n    \"credentialBindingMethods\": [\n      \"did:key\"\n    ],\n    \"credentialFormat\": \"jwt_vc_json\",\n    \"validationPath\": \"string\",\n    \"type\": [\n      \"string\"\n    ],\n    \"vct\": \"urn:eu.europa.ec.eudi:pid:1\",\n    \"doctype\": \"eu.europa.ec.eudi.pid.1\",\n    \"namespace\": \"string\",\n    \"credentialDefinitionUri\": \"string\",\n    \"claims\": {\n      \"claims\": [\n        {\n          \"path\": [\n            \"address\",\n            \"country\"\n          ],\n          \"mandatory\": true,\n          \"limitDisclosure\": true\n        }\n      ]\n    },\n    \"credentialDefinition\": {\n      \"claims\": [\n        {\n          \"path\": [\n            \"credentialSubject\",\n            \"identifier\"\n          ],\n          \"mandatory\": true\n        }\n      ]\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is invalid. The issuer returns this status when `label` is missing or shorter than 3 characters, when `label` uses a reserved platform value, when `credentialBindingMethods` holds `cose_key` for a credential format other than `mso_mdoc`, when a `credentialDefinitions` entry repeats `version`, `trustAnchor`, `kid` or `enforceWUA`, when a configuration field is present both at the top level and in an entry, when the entries do not agree on `authorizationRequestType` or `scope`, when a required field of the credential format is missing, when `credentialCategory` is not a category id, when an entry with the category `eaa`, `qeaa` or `pub-eaa` has a claim at the place of the EAA category of ETSI TS 119 472-1 (`errorType` `eaa_category_claim_reserved`, `errorField` `credentialDefinitions[<index>].claims`, or `credentialDefinitions[<index>].type` for W3C VC), or when the claims fail validation. When the certificate of the signing key of an entry does not fit its `credentialCategory`, or the key of an mDL entry has no ISO/IEC 18013-5 Document Signer profile, the answer has `errorType` `signing_key_does_not_fit` and `errorField` `credentialDefinitions[<index>].cryptographicKeyIdentifier`, `errorMessages` has the texts of the rules that the key does not fit (with the fix), and `errorDescription` has the field and the first text. The first entry that does not fit gives the error. A key with an exemption (`trustedListExemption`) is not refused.


</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The field and the problem. With `errorType`, the field, then the first text of `errorMessages`.","example":"credentialDefinitions[0].cryptographicKeyIdentifier: A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider)."}}></SchemaItem><SchemaItem collapsible={false} name={"errorType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signing_key_does_not_fit`, `eaa_category_claim_reserved`]"} schema={{"type":"string","description":"`signing_key_does_not_fit`: the certificate of the signing key of a configuration does not fit the credential category of the configuration, or the key of an mDL has no ISO/IEC 18013-5 Document Signer profile. `eaa_category_claim_reserved`: a configuration with the category `eaa`, `qeaa` or `pub-eaa` has a claim at the place of the EAA category of ETSI TS 119 472-1 (the issuer adds the category). Other errors have no `errorType`.","enum":["signing_key_does_not_fit","eaa_category_claim_reserved"],"example":"signing_key_does_not_fit"}}></SchemaItem><SchemaItem collapsible={false} name={"errorField"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The field of the error, with the position of the configuration in the request. `credentialDefinitions[<index>].cryptographicKeyIdentifier` for `signing_key_does_not_fit`. `credentialDefinitions[<index>].claims`, or `credentialDefinitions[<index>].type` for a W3C VC, for `eaa_category_claim_reserved`.","example":"credentialDefinitions[0].cryptographicKeyIdentifier"}}></SchemaItem><SchemaItem collapsible={false} name={"errorMessages"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"All the texts of the refusal, one for each rule that does not fit, with the fix (the category rule first, then the mDL rule). Only with `errorType`. For `signing_key_does_not_fit` they are the same as `signingKeyCheck.messages` of the configuration and `certificateAssessment.categoryMessages` (or `mdlConfigurationMessages`) of the key.","items":{"type":"string"},"example":["A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider)."]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"credentialDefinitions[0].cryptographicKeyIdentifier: A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider).\",\n  \"errorType\": \"signing_key_does_not_fit\",\n  \"errorField\": \"credentialDefinitions[0].cryptographicKeyIdentifier\",\n  \"errorMessages\": [\n    \"A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider).\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create trust authority
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-trust-authority

---
id: config-create-digital-wallet-open-id-trust-authority
title: "Create trust authority"
description: "Creates a trust authority for the organisation. A trust authority points to a trust list. The service uses the trust lists to validate issuers and verifiers in OID4VCI and OpenID4VP flows."
sidebar_label: "Create trust authority"
hide_title: true
hide_table_of_contents: true
api: eJzlWG1v4zYS/isDfkoA+TXJvhhF0dRJ79ym3WDjbA7YBmdaHEvsSqSWpOy4gf/7YUjJluUk7aLXQw/9YlsWOZyXZ54ZziMTaGMjCye1YiM2NsgdWuDgTGkd8NKl2ki3hoU24FIEbRKupOW0oQvnB+sKLZWz4PRWRiat68I0RbBoljJGKC1aL2y3wO9Y8kwK7hCktSUaC1wJWKKRC0lPUsG7ycXph/HEv3hXoKLHa1hkemW7LGK6QOM1mwg2YrFWC5kEky5kIh3P7niWofM7xZQOP68VZxEz+LlE677VYs1Gjy3PTPfU9fYJQV8HTqkkSYOCjZwpMSJNHCpHUnlRZDL2K3u/WBL9yGycYs7pl1sXyEZMz3/B2O0J+hjeRWzJsxLZfcQKQ+Y6iXa3cyvBOiNVwiKGqsxp9+X0ZvLv6RVtbBm2LhD0ohWP/YDxOMbCWZhVUmagVbbuNp4lBQvoEbxfUcAV+Ukq+NePV4SenLeExilXSQUEbxR5sywKNBBzi+RHfOB5kZE9tfqb2gFPmJpLdYUqcSkbDSKW84f6adg/fdM2+0qHIDxl+ncV1nfm0VERJHKJZOY/p9Nr0MZ/38Dt+ytwKXdg0JVGNZCNIoBF6LjMUbl9k1LnCjvq9QxfdRPp0nJeWjQVVLqxznuXd+NOrJXVxsky7+Eq7ni5HZLaM7iwvRS5sL2cS+VXT6+6D3lGXlI8f9pJDbecnbW98hPPW2DYZvZ+8GyqV2SptEAnUZxpj+A2nWtuBK2WFhYSM0Hg0P4EnkU+dV1TktMGPXowL9wagqawSlHBWpeQIV8iSAe6bDnw8jZgzSONbTabxsut4TVwtrj5M/1eu/1QtQ3lsi20siFdh/3B0xyzzQ5PW+LJSLA/wCgt1tjnwBdYb8fwHuvuUFVS6+XTpHgKkfsn3ir5uUSQApXzvP8MHMFgrAln7/233anVJOOtG1MCEYfb28lFALJbaZiXMnMdgm6jDvmVJGengoVZf+aBOxvMAoIJmTFXSlPacxFBWVDlisDpJMlICRCYofOiclhJl3qhBZpO07a6YNl9aM9fi8HilA87b+IT7Jzyt4PO28XZsNMXJ/ErfM0H89MzyvL/MesfBYK/gcHgLbwaDPdo7jgUhS+m7T/Oy56GZCDeQ25uCvorMvIXMnAolfIZxqRtAfPkhABKqBobSAjaSnvGfpFKIyak5fMMmwk71zpDrg40vqNzZ9TozKpQtFNVWqjl+eShrCktCt9UxgZ9PvCMNK67vUpG1RH6XvPFrOXZiq9tVYJhtuCZxdmejf6vTcQqRjh3DdNUmc/RPMVFD+BkjtbxvIAjqcBirJWwx7W3n7B2xUmPRFqHBsWX6d3f13nw+vR1fzB41e9vIhaC+ScrnnHrINeCgvBf032z38hKUVeKmhWq5GgGp2lvA473bWGtCnbvSy3lIBqqOfR02u+Ty353yWyKR2O0GWtByvnfFw1H3/9Wwdvt3oVMKoeJj9nWVac+vgfin+L1bcZ+ywVIVZQOCm54jg6N7zM2B0zfLomTC0pIykGfXZHnjJW/GNUvDFqdLbF6NyMtZvW7LflGUNOxD+J2ASfWJSi0ozD4G0fhVlV59iuKA9ec/a0BOlEOjeKZ7zvQgD+m5aNNxCzGZWhSPz6y80L+gPTzfkM28sSSL6pLPoRbPhzVE4LxMYtYqG/nKk61Icfk6FJNY4JCW+8YTnci1lsOe2Fw0BNBXCfkRk8XqKTohXrPG3ODoLf1iu2bdoG5rswiQjNZo8kQmOsOL2RXJoYr15WabaK2gGujRRn7tH1GzG9JuHE8oe7gme02vG4rcr/z9w3BLqCl9vo27Dz8ETFJR4WA7S5BFSv/6mF8UKPOryfwCde+/lD9jxtlPvQ4VRc025Mzg3AM5BTOOUJhcCEfUIQeexZ0hBkcKR26b3CGy8z7oOAxHkeA3aTbEjuCauNXa10ackfnE66/nnUZYY9S8P1uOnT517xlUhgWumYSHnsmwZxLCrgti0Ib980uyFsx8h+7v/bR0QRWK3zbTVAYvZTCDw1jTX6hAR59U4O918uHfPRd3wff51FNh/G2AbQwsbbkKkY4qiZ9x41RX3vjtUG7PWKb7NfHpJHTsc5sNYUgqKGiPbYqhSHofujoZ40RpDoT0W7guIYq+xv9qYXSehg5rgQ3wna8vZIrF0aQAYKVp722dydj+DCGo+/vpscRTC6n38HNRef7uyl8GIfTJjfvYPCmPzjpnEF+oeNefnHV7InD5MxfDzMZo7IednWGFTxOEYbd/kHoVqtVl/vXXW2SXrXX9q4m48ufbi47tIcukNJlexjwzqqvR3XmEr2FsA/7w9PuSXdAe4k4c64a+oRZa7uxbKd+o9L9vw+cq/R3+OB6RcalIr/4QDxWBeUjWw7DvGYh/W1vr6iEmbUKHXGrsNxHLKXSNPrIHh/n3OKtyTYb+vtzicYXP6Ib45PBl8K6ZvpK9ImYmo2DpzvTZrs9OuwvqHCEHef+1v/i2mb1vH53M2URm1dD89z3EszwFU2v+YqN2M/sZ+bt9Cnn+xf6/5FlXCUlT2h9kEtUS/bvV5hPvsJUP8iy+pVaN7RsF5tgDH2SaU9u+Yqg/gOuv94uD2+e3bAtcGE1RZvuG/8BQq/JOQ==
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create trust authority</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/trust-authority"}></MethodEndpoint>



Creates a trust authority for the organisation. A trust authority points to a trust list. The service uses the trust lists to validate issuers and verifiers in OID4VCI and OpenID4VP flows.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The trust list to add to the organisation.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ETSI_TL`]"} schema={{"type":"string","enum":["ETSI_TL"],"description":"Type of the trust list. The service accepts `ETSI_TL` only. `ETSI_TL` is an ETSI Trusted List in XML format. The service changes the value to upper case.","example":"ETSI_TL"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 2048 characters`"} schema={{"type":"string","minLength":1,"maxLength":2048,"description":"Location of the trust list. For the `ETSI_TL` type, give an HTTP or HTTPS URL that returns the trusted list document.","example":"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 255 characters`"} schema={{"type":"string","maxLength":255,"description":"Name of the trust authority. The service shows this name in the dashboard. This field is optional, and the service stores an empty string when you leave it out.","example":"EU Trust List"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The service created the trust authority.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustAuthority</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust authority that the service created.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the trust authority record. Records that the organisation created have a UUID. The two built-in trust lists have the identifiers `0` and `1`, and you cannot read, update, toggle or delete them with the per-identifier operations.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ETSI_TL`]"} schema={{"type":"string","enum":["ETSI_TL"],"description":"Type of the trust list. The service accepts `ETSI_TL` (ETSI TS 119 612 trusted list) only.","example":"ETSI_TL"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the trust list. For the `ETSI_TL` type, this is the HTTP or HTTPS URL of the trusted list document.","example":"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the trust authority. The value is an empty string when the create or update request gave no name.","example":"EU Trust List"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this trust authority is disabled and not used for credential or verifier trust validation. The two built-in trust lists always return `false`.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was registered. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was last modified. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"trustAuthority\": {\n    \"id\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"type\": \"ETSI_TL\",\n    \"value\": \"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml\",\n    \"name\": \"EU Trust List\",\n    \"disabled\": false,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation ID is not valid, the wallet is not resolved, the `type` is not `ETSI_TL`, or the `value` is not a URL.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Send verification request
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3

---
id: config-create-digital-wallet-open-id-verification-request-v-3
title: "Send verification request"
description: "Sends an OpenID4VP Authorization Request (V3) with enhanced features including transaction data, data agreements, and PDF signing support."
sidebar_label: "Send verification request"
hide_title: true
hide_table_of_contents: true
api: eJztPdty20aWv9KFKm/kGpIiKcm2tJnsKro4VBxbkWTZE8slNoEm2RbYQNBNSoxLVfu0H7AfsR82X7J1Tl/QAAGStuyZ7K4zNYmIS/fp0+d+aXwMIibDjKeKJyLYC86ZiCShgrxKmegdbl+ekv2pGicZ/4PCI+SM/T5lUpGNy63H5JarMWFiTEXIIjJkVE0zJgkXYTyNuBgRlVEhaYhvRlTRBv6b0FHG2IQJJRuEioicHh4TyUcCXpHTNE0y1boSV+JizPQQcIVsHPKMhYqcJlKRmWyRN1sH5JCPuKIxOchYxITiNJZk/7T3mHBJIqZYNuGCRQRuZSyek8GcqDEjGRuyjCHYacYkE0ovL2JDLjj8+Z0k/YzJNBGS/ZJErL8HEDVJP0IortNEqj7ZLPxufbhVffL3//wvYt8kYSIU5UKS/iy9SG6Y+DU7gNFw3faaQWqfbLw+65FNcvLm4nGL/JTEEcuIDKmQCPSvZyTJyDCJ4+RWX4kYS0nMxc2/klsax0wRAEOaJRoQVAIrMWBOM95v6XWE1zTlegn451Loo3A/5Tmcgyy5lSxrypSFfMhDIsc0ZZIMk4wcjLNkwnCB53RIM/5YLxaHOM0SlYRJ3G8R2N0Zy/iQs4wMs0QoJoCKWFSarxXiiH2ykWSlOxIn6D8mXMAyBZ3xEVVJ1gpzemiNmNp4rDE+TLJbmkUaQxpl38kiqk5fnV+QzVl3M0zEkI82I01hTf30ZpIywaNNGX24VZsa/BBpZ3PMpUqy+eZHn6KO7sIxFSPWi+43MxYyPmP91nrEQDNG2CRVc8IFOTwAsiZD2HrHG5lhxkESzQlXksVDEtIs40wSkbh3OIsj2SiRc6OIyYt5itfYXcpCxaJXGR9xIfuaQftMhNk8VSw6M2McifCSxlMmzzW/skgDrJE2zVhEqCrwVjPnLRJmTPOb4oZSuBizjCsQI1kyKfPo6SGu+Zwp0uci4jMeTWnci/rAEP0JTVOWwS+VkHQqx/h6tdxSiWGcGQ8ZSYaEkhuR3AqSD6spM/9NJlOpyJjOGKF6eJEot+1Ewaa1yGECl4lksB1qTNIsSVmmOMpDkgi3W7iSM0Yj0q8mlL6PAo3tFjmasWxOEjVmGfGpjsAsBhB6w4CwqSIz2BpCJRAFSSmAQzM6AXnoIJ1KRvo86jfI7ZiHYxCYFNCgWCZoTDIWJllEOHIRsKimutvEX1kyNGDis+MkjoDu9OxzpghANeY5g+2Rfs6Y/oph8viWzqWmeEN1BmNHdynPWOGp/pDGEjgJEenBgCqp//wIWHjri7MwUtiIKUJJmEzSKdBrGcoG0CTcBXYo3JxfcJBiCCKAHE6zjAmFTNC6EkEjcJvZi4K9QEN/ALzCjJ57gytA5RxdepAb8r7cChqBmfLHJJoHex/xJwAW7KlsyholhX/IYq5JC69oCV7LPi2CLOhj59BxtWFAQScMRwBU1utXTahAMloY53RBDMRoILSCBuBBMaFgMTRNY7tZHySs4GMgwzGbUPhLzVMW7AXJ4AMLVVBe6pkvLWGZzszBXxqddBAzcuqDvOFMocc1SHGiaSlenDgjdAVqtACSLJuxjGSMGgwdHvz6gvw+hc0C7lAF40gypbgYSSs7qDIcAYNxCawDLyQinlsTi0Xkls6RovmMLduEPUL92UMqQIAMAEahCBcxF4aAc9kA+1GHD2+vpMq4GC3sVc+JHS2jH4iwRtEimiQRa+QI9AxUotgkjaliDsVGiZbxi0LN4tfNzUciAQuYGhkox4BnYCgKBJ8xRsIxzWioWCbtFIJQIW/hAkqGny4uTsl2u90gAxZSkNIiKewG6tmYDRXwBrujkzQGTHbCreGTQSdstsPtZ83tQWfY3A07tPn06XA37ERPaIe2g/tcPMzPLEF62zFIkphRgfsxpNNYBXsoacv78wbA7oNA6WtEGgSkVEoml+jfwdxjBCcJrZhE89TXVRfOTNOYGjFj3Q6ncezsn5zmX5/1WuQ1WHKwQ1qmIXfHNBvVwCQLeIQ13TcCjzAOqaqULjSKkPpofOpRfZWQvVigsoTQKLLGSI2ohbWPtQ+AFghN0yyZmaXhMAM2TDLm2bLAkIb4fVZBCfWc23cNk87J7ZgJrWpRLuif5ZcXZPYSMQeyXwKvAAvU8xZgssA3lQyA8BhrzUFgx/aHcryKkn1M0fjtl3bQWLI0lkn9wCJZNfLCsM4YlyqbhuAAm90CHzen8JPzVy/JOWoqazUVZzIX6yTclQDeFUmRXWuk5wHY6skoo+mYhwRfWqXXvc2YoB1JzXt8SObJlETGvJ2maTwHc7ZFLrcIE1GacKGQfori6I/t8PLFmfx9N/35rv1y9OvTo63xyQgWMc3i04wN+d3qhbw+e0FQvSNihvxu+TJyf1hTqvK1gppmAm3xkvOl127EHejJvrYPt2fp3uZmX4sTSiI+RLGlLCQqAdtbgHKyTrBmwlWY8YcHfPgOzSdrRt9xgcWhks9GVHBJF1Sjlg5VToyj0zW9JpQjX9BlKnl1aP37bt2IgedThdn7RmAfXI28ozvj3eRujaaUCU0lSuV/Gj6pKuDzS+EGwmoYljtXdJJ+SU0/RUE845KDyezmIRImsqiDy0wH+BxHQgxDC5lVMB8kSRZxQZUv82iW0fnCzp7SEQQf7PPONc3hWoCoAQ5y/91dp0HmnQa56zbIvPu+Dw8iQFLvNc5nCBocXHZHQxWDBzHN0F0esaxyJY2AKzaRHujmaaRZLnr67jYQ8F3+wwmKd512uwH/78J/d9rv7xsB6NF9Gz19mFFyWIjE6u0BR0Aa5ZRNrDPIZTHkwIxDXLl9xsLUHue7ehcAVmOWiiiCyHNxGmPdwU20ppd7FMH3dfd+CKqNXo0UTxuVJDP+A69qrwGh7Lbb8J+Seefrzogt4XvgXUlnTBsVlUi1bsVD/N6iF+ZP85MOcKx2li+XwUYu8oCLymh4IzHA9YnOtA9XI495LZWYJQKR0zjPFJQ0PcOwhrN1rdKSxgYT5gEXcmnAMlmqyrHuytj1fj6wjmNoozOPfOWBDR3C1XcANRCSA9zvkf5VcBX0dSiCaI3VIP22vSKmkwHLGjbWZa4aua3BEtM47ttYht5Jon+g1Frlk+eRrTVMMcF/nzJfcRoJWyMacnfDBSPR06uLeRajlDpgQqMGiVjMFOhgkrEZjXmEFrOjP23V49MYXMdIBXrsztvXSC/aYM/Ybtimu9vNrcHTqLk97IbN3ajTaXaHO7Q96ITPoi2Gttk6FlltyHTBCtWmNbofXOmghvQW0yIvEy+gS0OgR+lhURujtTjUbmXGZGHQwsKfPOt2BtuD9nBn0Am7dCvaZjvDJ/QpLLZgF69e96oUIeSymAiTiGHeBdJX8INEXKYxncOWOnvd93a/k86bxdQXhFNjDkIGEaESgqLd0kHBYwLbokWOkOUQzVMJScUySUAASJINlwPTeSWXBHvc8tBhlnOuimZIDVLwMY+Orb+yAlkNCMcjHYdJlrE4J3KNS2dPuozAIoSrgTuGoMk625ZAJGceJzT6Usj0d+l8OphwKblWY8v10JsMLd1ytLigVPLxnAwcekERVBAYC6wOguqg5jDJJiZEoAOHZezYlGieX6sBokFkUuV6Gmk9ZpmWSVr/FMQnrpK6xEBdGEYqmoF5um9kK8Z08FG9NpAdgoCxapW0Hvewd1wE2goPf3AwYUxepSBoXO6jGCh2lrZm3lUq51p+wubXw7u45Z4btww+a0gUAqoFTQau1M9gB8Ae5TiUzqovLi7H3PVaymJBfxYWeFiKtWmTJV/scBoPeRxL5Ck7cpJdT2i6aJfuo+eSDMmhe5D8QlMohkASBicSGJrRcGwlDYv8JADIWiVJnBj6ND5UjXUHyCk5aWUPqMZEBeajawiwvMqD6FcsEidUheMi7BusNWqR/odbdT0Lr8Fo1jnvv8ioCXKpQfoTmVxPoiQ0Murz9q8n0qnyUews2dU7CzsxJxBZkEPO9K6CIbQaDognnoLJxO6AvZA40A/DspukvE0e4kCVLN9HE5+xwFwLpIvV7PpS0w9acpGHD1DgHj/eokiHlD9hYsbiJGVmN6XZtJM3F4QLySMw5y5PdT3MlycasUDv/xtoxkD9dUknrKQXN7XetUVv32wJosWA837dZ9bB5KIT4iIUNcp4EcaiwF6QogjIe/T8paJqKqugYmI6gbFs2gpmzqMM18YXwfX5ui9lItIDFC7T8IZFwfvyYl/wIQvnYYwhNTWVSx2uvSvRaeV5NBi8v0eqIhMr7D9tiTuP/5aCArBWrNPxXW8uu1ozn7Hdi1p3lCisiwCLXrCosSQVcSW2WkXLw+KtOAEaQSwqWMVkMFUFVU4iHmEgNS/aQHeyxribo7W4XZ4fN8jMbhYkdcysXobazJGDJM2SkEmw8rnSVlLulRXoCAx7/ZLPEX68tljVAEGQStow1+q0tU8d4ZhpBwtY308eufipbJQFg6FKu1CDMRCoMeUTSegISgdVuXZhRaILlo/lYSza94W7joZUSYQ7LKDRYecNDpm8MBGRfGzTfOXwpa0UopKYiXDSaRr9YyaNqVTgNOEOLzhHD6mTWJa6Rf+yOp5rC9MAlARLi155GY/PAyOXMn72xOY5tPserYBFs9qiXXtgq1LR8mOKYnZZPzMAJUatoCLH4GeBTn9JJ6zhDFn4a5QQ1lKtMDdaa4xTSGp/Dgp8GFoIxGHvEIQgwEKSAazB1juGMQeB4hbDh4TOKI+BaxdVGEL0vkQ4FSmSWuu7Pktwv+CDMR3B8S04F9YywtCxvpEpUAsMWEDHQhsqftVyWDbIWtY3ngrFY39kUxhQjHZoYb3Ges1WLaxpqd3rLS8vqlB+LkiHISDibdeW6aX6npMdoyYRIG80O1Ys3czqL/3rVqNgnWE2YZGtjjfIj6YZmoSVQbYKsH6kkj3ZXs0q+rlpFuvwIMxhSyIWSkaWoxF3wqqMhbLSz2Fabwu5lFPobMiNodwIL8gsY4k0gGtdghPexjIKb0Q61MVgRT3dIvte6auumfVMGpvIhPyYiw0XlDdGBCCgzAWByGHWyCtc3CIQKBM4Cry01gUiaGWsF/BPuq22VyvvVa1UW3KeoTxLr5G50Lx2f+r897UdEkUaj5DL1w0/k4NECIj/9A4Jvpi7Ulb+nvqhMURM3188lhX3LVR949XhWEb2PTDPagSoCag6F9DCW9QWQTnJ+3lkXGyzKYQB6/O5RXNIrldSUTW3HA8SmkVgc2Sg8LySCgQhN92Xqf9iXfUaprCuUshpH5oZ+toaBdgWGiywhEWLN2odHyN8TYkrVF9SQBCCsMxhgmQVmsIxlyrnU2nrxP1UmAVwbmS8ZWahR/DyXN44pvBdB5Nd/XsZT1hi/skGbG6/5sirFrgaE7Ky4Natz3Hgig1oYbLTzWhzHSaXilMVS6c6T7eftjs73Xa7ZPtcAsK4mn8lG+hS70eec65U+ZaWPLgaeeImL0RBX0t7U3qN+opzpDI2S3LNoqbSUtgiWZBb6JnBYj12a7AP+YX1DCptdPYiLEtcp6xQG6m9Q1uThz6FsRmcn2vQsCrMUIii5M1pMCmGZex411QpIFOEoRHc7bR3ryUV15GQ9ueYyjHqDj0M9AeemSFfZ3ydKsOeb3hZcHRBGKps6KqzplB16OBL5cn8Hq1PScEWZnGdjwDGOLldArfuk8QeEBbtLTQ47uUPog6dcarrc7FLrlCUgYnbYqMhUn8yVcS0j+lC1uZiz+TyaVzzGRQRUHLy5qjQwei97FZCkpmxtJY0iXrtExbQkzdHPrDkAPp4FFa4ISdja1df15CZ0pCpsD8XG+o0S0of3PJ6PxvkOqxwmjUr906Ns2Q6GpsAtGLQhgAVE4YwZKngZgE35U20E1Xu4OdOVrkqT1Z4lBM0ghIdwRVEsvvDXLWgen/infd5rC3b9+TMSsa7tNLOewvTFnrxiSdyGxD5m1np4fEK9Rmy9dBKYFUswC1Xnrh4ZW15FdJ3RS1rQbI5T8QqaxtfXSxU/QKluX+SZbli20Xr/J9egvnArgDU4OtpbEAmExIsmGHG5FhAmRFIwDRjM+1kYFkPVQoqAjWu/LK51RDWCT3noKRmKJ9ItEUMzWx2J+tCoFz67cmA2EoV3boSjrVsL42ZdkYzToXSaHOm3TJ5vbG0J/2x1riu7rQ56zSdPtH5huq9gIoPismEqchFppE7pjn/O2nWp+1HcxVcG0iuprpoIje7AR8Zl2CH0nguudTFZkMs08KEHxDpJog7jNhANcQi9OvBboqwS6bjd5LcMN3caBZHsSc5SSlk/TTR1C/yFMQsmFjOFAUJCwi3HH/GwmQyYcJWpKVZEk3DXKMl2ajJZdLE/O6yJdhoZu/8Fek8a3e2mk/JvhDsjhwU3MhCXxM4km6rDn58dUb6R+W2emgnegVxClvPU4xXYOc+xitqjMiisqykK91mXN4xuOqtXpvTnjmzfnutqcexKcMlzNHIe6b0flgS5cJ5QGAJLmWh1pVw+YCFUyk82sbygsrjKb4IyospA31gxRoFTjVSowh3DjafTpoDil6XXqpmUldaiwyQyb7XjJauYVRafLkqnlKJk35t/eWU2oiRKrz28rqlVBSOmQWtbP9wpU4VU7tRGtpl16ud60SRE+3U1/5U0ar+jZoEUfp1FZwpSqkSs4063fHYjwyt3riLNdS/Kwg9d7QF6pBJEOMWbtRnkPCq0QqOVfsfyZWF7yrYI1fB9/qh5smbix+uAnIPDZvapF6iLFrV83k6tJAsxK7h6uUZsaXPj9CRkWubjtNFQL/H15jBhl9oPfW9M1WuJ+ZQFXcBMG6Ew5JQ071tM9En2XxRkaHF2xKBYd7x5cXX5/5qqBamtbA9hPX9CQ3zmxONgPl1jBwNWE28n8DyUTELt6TSqqnvYbJ/OWeRDQ2pM2mIPoxHet0h4JO4Vo/HurKZmRwaV2SOR/1odwaSzLkaQN/CqD5TsKObYQ2q+qs4dw2GXc2Mjgf1mRHLWXGjxEtV3Ob4sMiei/z79//478emifpPKq7vc1lgcv3yyEVc1sh+9EQEGlz3l+A5QcudOuvyQGPjgFUFXoifUKkyiMonn5UtI9e6tMYI/tv99VtXF1tV9ZSNUtDdJDokGfMoYljJnHeCyj9X2+lX6RwdctNouXQ9LzB7NST4NBkxAYkGFvmlAMW2vfysP7NCEKiWrrHvN0rCqTvKZ03xmovyB2fxqZRJqKuNjMPOJS4P95xlWZJVzQDpEygQqQ7cHMFrupuJD93RhUPKYygDgHf1UV23XHrzHPpjfOqUh0zh8ASHIhMmJdDeetPr7TjmcWWYyBZSByb/snAEg0fUZlMdAu1WP3TsAsmY0VEWFsoRf2bzfLNXE8bPbF4RToQYg65Dk67rCibHm7moN2UlxdmP16w5Py4UmtsdumHzhk4dak4FARjt3bC5Fn6QzOq3ekqfRWLzNiZxlzGZxDY0qBel5mShc6XPZYIRieun11Bqe3cd9onQZyrq8QvBdJzd5NEWKsryUsRzQVM5Th4Y7jxI0lXln8SEd/FcQHe6nK0JKJXB8XKBtVf6U1PJuKTWsrrhb6HJrtwm6crEvapdV7rol7L6FaY19Up1FVU2xFuq2smLZRZyuaVEYnWWoy5hWmmAlLITXmh/QVMvVrC4cpKFqo6q8oWFloGqDvby+QH+4bAbnl3xGFvlp5MJhbb3oHCoavkYzrrTVQF/9gSCmm566F6ob66tJdM1O5GXlQivd/DXQndv4bCDfzMGM4/+6idwH23tj5VK5aOt/Ufd40fdYyxqy1oG760wmTzqHvsFvo+6x3fzPx51jyE/w0P2L97BXn994FiPusc+8h91j9fBnQ8BOATjJPqrSQWW22fXREmr1Sosq9Vq1QiPvWAnejbshruDZtil283tYTts7tKnUbMTdgdbdDvaYU+GZWbdKyU5y2Ua5XqJKm/BHOViMkN1hzHVlXsHT4e7gw7rhk2Asbk92GHNZ+HusNmmnUE31HSdS769ch9M3r5g4MgruXUxdbBYgVgsETQ1gEGN5MIbNdUeQZ10xTs1JatBhdDCi7YMLigLQLySpzeDRTFoF1+uY6u4bMq28vqmQg+Evtx5Ape9LoX8MhpKJmbw2hpSG9qXKsk/l7h2By5DsB1OJVh+eLKOixVOxnigVHy2TCp2aHewFW5HTWCQ5lP6bNDcDdtRs8O6wy26PdgJnyxV5p8tFavEQi13D7dYN+qE7eZglz5rPn2ys93c6nbazSGLwgHdfQZXKrjblih8TcYuZV5rU0HlHE+eufDifl4c/p0f7q4d1Qs8F2I4RTYvRHN8xKyxOhvtKXqLGkCkulOWyUQ0rbugSbMJPN887R36nolr7wSGZjquNwvVta7dAftDj1UcCuvw32MVHXQ7acxg/+W7YEgnPJ5f2zaN/AYk94W9Dv+zROBCVbgefcmIyiPjK1jORWq8Nhmta3eMAW6ZWwnwPP51TeORt5Kj8+7OE2g1vBnU38Uo1PtiUNqjhjwyux4x6GUFH6+KtHAV7F05argKGldFesDbmiLwJtIEXqymCnwop4urYO/jlU8ZVwDuVcAjHGM5deBYGsMGDINXvAFbpYfPqQRGv6qlkyuggitDKQYQIAn9lkct+GDhZk4xV5Zkrso0Y9aaUw0CXaabq+D+PrjXna3f1P6fSe0/QNufa13/F+IqCazehwhsSfebh6uD7idvLhp5BawJDt/yOIbgsKuxsbHhB+r+3WW6f3f4jD2NnoTNncE2zRVq02pUuPLP1/0d80+z2+12m1tbW1vN7e3t7eaO90+d7jdViZ+j/3VcxSrI6eWHdrr/+3b42+Twpjt/8eTs7sfZSvX/NZR/teq3WGTzk/Hgechf8ZPj13/0Oi95T/YmKv3toPek9+GIvzg4abO3+3B/9re3l2160BlHb88Sxjvz394eZVRE7R6/5ezw8kPvQzro3XROzl/3Wq0WSMUWm598GDyP44E4G9I3v8Iw89/enKXh5PJDdLzbCSc3T+hPZ+3wp1+evJjvdn97e5L+NonjkO/E7PmxCp/fxS8mL2eD857siZM43PpxNhAv47dbZzvh89cwXjc83m0Puioe8NIz3c7sN/3Mzd86u+Pw+c3UgjuYXG6Hzy8/RM8vb952d+f0TZQOxC/8VSz5evCcRC8OTm7+tnUs324dd357e7LT+5A+fcG3p8O37ZaTPMGD9XWltrbJvquvuIFuDVfBN/X0f0Q94SaOGTWlO/BrWx+cufaRln74DzMeJti6kEh5v6p9O397MZ3m5cy2salonTxNfmzDjxTcZzjKxR34FpjVL9bXFPrgIfUg8MMzOlFp2NUq4IilcTLHomA48SVRNvxvTs4oHHReexw7lAvUBtrH1DQ65wkSb+yIS6xLlnmVa/1x7stD+njuR8UaMzbU2Rc/xL9INp3/x2TzWtgeAZ1UKKBm5/81R7lDN00jAE5T/KYAnPRfKMDVh6npU0tcsTiSOybc1jtn2++t9k4K9/g5ySofMexadxp6aX9BmbNwmmFT47uPwX7Kf2bw5/t72B86QofdFqjozwLlp+sePA4aLtQHG6oD38FeYGLKOiARfM43kqBPAtQKYlkbFeVM9SQxmxDg+crBXoCh/73NzYhNkiZYwHyUUaFaPAkgPlIqqnBl2XXDrBrhXNER1iRUvy717TIg73Oca5Mcqd1iPq+c0BdA88KYuGkQtNI2RMG7WixWO+3pGvdSZTp+Cw/bN40w7RfGgVMjqfsQyMB+DcHWNPQ1jKRPNkRiTg5VGeUx4iClIXvc0MegFIfdI+bF7+fJNAN0NG/Y/Ie+TrWCCDnLvyV1ZJl06Snca7pe9edxLx51cb9GQLD2FO8F+8gJHc9KctdqbKXKyqCFIpvF1iA81kwMEyunaYhymk0oB3I0sbt/z0nQURF/nl8q0q5P9iXici/ZkmfpH3nF4b8Tp6AL5/SUz+z2C9569gSJjVcoWnr6c46feNi39Tuk+R4VltEJeEcay+gP0+gOZ05CarCBlQ/6SFYUQHNnQfhn0eheW6moiODDjk1cLzbp4LcSNYMYTCO0UAh/eUA24FDBBukdXRyT80MoYiSXB3q2vKtjh0wOk3Bzcvhi8dAarGeKecjMWTSW/1MajhkclbGwdbe3ty2Kt1tJNto078rNF72Do5fnR014B05V4Sou0AAiy5ZRWbkCwldve7fd3W5ttTpY25hINaHCg6f+XP0S+XimxLfPwH77DOy3z8B++wzst8/AfvsM7LfPwP7jPwNrHA3F7tRmGlMuzGfT0PY2qeTZlv5CzJBjvL+wNNfiCSZtpJMN/gLRfRN45OwY/MG9d8HHj9CQ8zqL7+/hssmtv3sPeZ6M67Lkd+9dWA/dPigd1acxMqGapiTRpIUWgxHgpek39vG7Fkuf9V1WkMRBIxiY79maYoGM3oIfQW+DvQC+o4JrRgsSgx1w/WMQUzGa0hE8r8cFixx8r6I7p2tgzR+wMntLzD0oy56dXgz8G5ZW+cr3IHh/ZvMf3OP6Tu0LzpvUT8POQ0j8fwCL3mtT
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Send verification request</h1>

<MethodEndpoint method={"post"} path={"/v3/config/digital-wallet/openid/sdjwt/verification/send"}></MethodEndpoint>



Sends an OpenID4VP Authorization Request (V3) with enhanced features including transaction data, data agreements, and PDF signing support.

The transport (Direct Post vs. W3C Digital Credentials API) is determined entirely by the referenced presentation definition's `responseMode`:

- `direct_post` / `direct_post.jwt` → response contains `vpTokenQrCode` and `vpTokenRequest` (URI / JWT). Holder scans the QR or follows the deep link; wallet posts the response to `redirect_uri`.
- `dc_api` / `dc_api.jwt` → response contains `dcApiRequest` (browser-specific shapes for Chrome and Safari) and `dcApiProtocol`. The verifier frontend feeds `dcApiRequest.chrome` (or `dcApiRequest.safari`) into `navigator.credentials.get()` and forwards the wallet's response to `POST /v2/config/digital-wallet/openid/sdjwt/verification/history/{presentationExchangeId}/receive`. `vpTokenQrCode` and `vpTokenRequest` are empty in DC API flows.

The request body itself carries no DC API fields, `responseMode`, `dcApiRequestType`, `expectedOrigins`, and `encryptedResponseEncValuesSupported` are configured at presentation-definition creation time and inherited from the referenced PD.

Set `individualId` or `mapperId` to push the Authorization Request to the device of a known individual. The individual must have a push notification token. Do not set both properties in one request.

Read `presentationExchangeId` from the response. Every other verification operation takes that value as its path parameter. Do not use `id`, which is an internal record identifier.

Two properties of the record hold no value yet on this response: `credentialExchangeId` is always empty, and `requestExpired` is always `false`. Read the record with `GET /v3/config/digital-wallet/openid/sdjwt/verification/history/{presentationExchangeId}` to get a computed `requestExpired`, or compare `requestExpiryTime` with the current time.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Delivery options for the Authorization Request. Set `presentationDefinitionId` to name the stored presentation definition that holds the credential requirements.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a stored presentation definition. The server reads the DCQL query, the response mode, the transaction data template and the DC API settings from this record. The server ignores a value shorter than three characters and then answers with HTTP 400, because no requirements are left.","example":"1c3f6b1c-0c48-4b1f-9c1a-77f9c1d6a1a0"}}></SchemaItem><SchemaItem collapsible={false} name={"requestByReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"When `true`, the server passes the Authorization Request by reference with the `request_uri` parameter. The wallet then gets the full request from that URI. Use this option for large Authorization Requests.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data to add to the Authorization Request. The holder must approve this data before the wallet sends the presentation.

Give this property when, and only when, the presentation definition that `presentationDefinitionId` names sets a transaction data template type. The server answers with HTTP 400 when the definition sets a template type and the body has no `transactionData`, and also when the definition sets no template type and the body has `transactionData`.

The structure must agree with the JSON Schema of the template type of the presentation definition.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data to add to the Authorization Request. The holder must approve this data before the wallet sends the presentation.\n\nGive this property when, and only when, the presentation definition that `presentationDefinitionId` names sets a transaction data template type. The server answers with HTTP 400 when the definition sets a template type and the body has no `transactionData`, and also when the definition sets no template type and the body has `transactionData`.\n\nThe structure must agree with the JSON Schema of the template type of the presentation definition.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce for the Authorization Request. The server makes a nonce if you do not supply one. V3 endpoint only.","example":"z4cVLRsq9pKx0NgQ7E3hJg"}}></SchemaItem><SchemaItem collapsible={false} name={"urlPrefix"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL scheme prefix for the Authorization Request deep link that the server returns in `vpTokenQrCode`. The default is `openid4vp://`. Use a different prefix to open a specific wallet. V3 endpoint only.","example":"openid4vp://"}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of an individual in the organisation. The server sends a push notification with the Authorization Request to the device of this individual. The individual must have a push notification token. Do not set `individualId` and `mapperId` together. V3 endpoint only."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier that maps to an individual in the organisation. The server sends a push notification with the Authorization Request to the device of that individual. Do not set `individualId` and `mapperId` together. V3 endpoint only."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"When `true`, the server puts a visible signature stamp in the signed PDF that the flow makes. V3 endpoint only."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Page coordinates of the signature in the signed PDF, as `[x1, y1, x2, y2]` in points. The array must hold exactly four integers. V3 endpoint only.","items":{"type":"integer"},"minItems":4,"maxItems":4,"example":[100,100,200,150]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement that gives the terms for this verification exchange. V3 endpoint only.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Data agreement that gives the terms for this verification exchange. V3 endpoint only."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server made the Authorization Request and saved the verification exchange record.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>verificationHistory</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Verification exchange record. The record tracks one OpenID for Verifiable Presentation (OpenID4VP) verification, from the Authorization Request to the verification result.

The server returns every property of this schema on every operation, except `dcApiRequest` and `dcApiProtocol`. A property that has no value yet holds the empty value for its type: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.


</div><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the verification exchange. Give this value as the `presentationExchangeId` path parameter to read, delete or revalidate the record, and to receive a DC API response for it.","example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier that the server makes when it stores the record. No operation accepts this value. Use `presentationExchangeId` to address the record.","example":"6821b4b0f5b1c2a3d4e5f6a7"}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenQrCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID4VP Authorization Request URI encoded for QR code display or deep link. The holder's wallet scans or clicks this to initiate the presentation flow. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State parameter for the OpenID4VP Authorization Request, used to correlate the request with the response."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Full OpenID4VP Authorization Request URI or payload. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wrapper that holds the Presentation Submission object of the wallet.

DCQL is the only supported query form, and a DCQL Authorization Response carries no Presentation Submission, so the server returns `null` here for every verification that a current presentation definition starts. A value is present only on an old record that a DIF Presentation Exchange definition made. Read `presentation` to get the credentials of the holder.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation_submission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

DIF Presentation Exchange Submission object that maps the credentials of the holder to the requirements of the verifier. Kept for old records only.

</div><SchemaItem collapsible={false} name={"definition_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Presentation Definition that this submission fulfills."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>descriptor_map</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of Descriptor Map entries mapping each requested credential to its location in the Verifiable Presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the matched credential (e.g. `jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Definition that this entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression pointing to the Verifiable Credential within the Verifiable Presentation token."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>path_nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Nested path descriptor for credentials wrapped in envelope formats (e.g. JWT inside a VP JWT).

</div><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the nested credential (e.g. `jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Definition that this nested entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression pointing to the credential within the nested envelope."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for this Presentation Submission."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`request_sent`, `request_received`, `presentation_pending`, `presentation_acked`]"} schema={{"type":"string","enum":["request_sent","request_received","presentation_pending","presentation_acked"],"description":"Lifecycle status of the verification exchange:\n1. `request_sent`: The server made the OpenID4VP Authorization Request. The exchange waits for the holder.\n2. `request_received`: The wallet of the holder got, or scanned, the Authorization Request.\n3. `presentation_pending`: The wallet started the response but the verifier did not get a complete Authorization Response yet.\n4. `presentation_acked`: The holder sent the Verifiable Presentation and the verifier processed it.\n","example":"request_sent"}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Result of the verification of the Verifiable Presentation. The server checks the cryptographic signatures, the credential status and the presented claims against the DCQL query of the presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this verification record was created."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this verification record was last modified."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation definition used for this verification request."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VP organisation that initiated this verification request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Contains the metadata describing a holder. For e.g. Name, location, logo e.t.c

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder. For .e.g. DID or Name obtained from client metadata if available."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"presentation"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Decoded credentials that the holder presented. The shape of each entry follows the credential format. `null` until the holder answers."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenResponse"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Verifiable Presentation tokens that the wallet sent. The array holds one entry for each credential that the Authorization Request asked for. `null` until the wallet answers."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data confirmed by the holder during the presentation flow.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data confirmed by the holder during the presentation flow."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base64url encoding of the transaction data that the Authorization Request holds."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential issuance exchange that this verification started, if the flow issues a credential after the verification. Always empty on the response of the send operation. The server fills it in later, when the issuance flow starts."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token from the holder. Present only when `responseType` is `id_token`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token of the holder.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the ID Token of the holder."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement record that this verification exchange created."}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the dashboard user or individual that started this verification request."}}></SchemaItem><SchemaItem collapsible={false} name={"requestExpired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `exp` claim of `vpTokenRequest` is in the past. The wallet cannot use an expired Authorization Request. The read and list operations compute this value when they answer. The send and revalidate operations always return `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"requestExpiryTime"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the Authorization Request expires. The server reads this value from the `exp` claim of `vpTokenRequest`. `0` when the request has no expiry.","example":1747015200}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Validation result for each credential in the presentation, with the signature check, the expiry check and the revocation status. The revalidate operation writes a new value here. `null` until the holder answers."}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme used by the verifier in the OpenID4VP Authorization Request.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI the wallet redirects to after posting the Authorization Response. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`, `iar-post`, `iar-post.jwt`]"} schema={{"type":"string","description":"OpenID4VP response mode determining how the Authorization Response is delivered:\n- `direct_post`: Response sent via HTTP POST to the verifier's `redirect_uri` without encryption.\n- `direct_post.jwt`: Response sent via HTTP POST encrypted as a JWE.\n- `dc_api`: Response delivered over the W3C Digital Credentials API transport without JWE encryption. Compatible with both `signed` and `unsigned` `dcApiRequestType` values.\n- `dc_api.jwt`: Response delivered over the W3C Digital Credentials API transport encrypted as a JWE.\n- `iar-post`: Response sent through the Interactive Authorisation Request transport without encryption.\n- `iar-post.jwt`: Response sent through the Interactive Authorisation Request transport encrypted as a JWE.\n","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt","iar-post","iar-post.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifier Attestation JWT sent to the holder, proving the verifier's authorization."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual that the server sent the Authorization Request to with a push notification. Empty when the send request did not set `individualId`."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier of the individual that the server sent the Authorization Request to with a push notification. Empty when the send request did not set `mapperId`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement that gives the terms for this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Data agreement that gives the terms for this verification exchange."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce used in the OpenID4VP Authorization Request to ensure freshness and prevent replay attacks."}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiProtocol"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openid4vp-v1-unsigned`, `openid4vp-v1-signed`, `org-iso-mdoc`]"} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier returned when the presentation definition is configured for DC API response modes.\nIdentifies the protocol variant used with the W3C Digital Credentials API (`navigator.credentials.get()`):\n- `openid4vp-v1-unsigned`: The Authorization Request is passed unencrypted to the browser's DC API. The browser can inspect the request for risk analysis. Use for development/testing only.\n- `openid4vp-v1-signed`: The Authorization Request is signed by the verifier's key and passed as an opaque string to the browser's DC API. Provides verifier authentication. Recommended for production.\n- `org-iso-mdoc`: The Authorization Request follows ISO 18013-7 Annex C. The wallet answers with an encrypted CBOR `EncryptedResponse`.\nOnly present when `responseMode` is `dc_api` or `dc_api.jwt`.\n","enum":["openid4vp-v1-unsigned","openid4vp-v1-signed","org-iso-mdoc"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcApiRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Request object for the W3C Digital Credentials API, structured for browser invocation via `navigator.credentials.get()`.
Contains browser-specific request formats for Chrome and Safari.
Only present when `responseMode` is `dc_api` or `dc_api.jwt`.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>chrome</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials API request format for Chromium-based browsers. Uses the `providers` structure per the W3C Digital Credentials API specification.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>digital</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital credential request options for Chromium-based browsers.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>providers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credential request providers, each specifying a protocol and request data.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"protocol"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier (e.g. `openid4vp-v1-signed`, `openid4vp-v1-unsigned`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>request</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The OpenID4VP Authorization Request payload. Structure varies by protocol:
- For `openid4vp-v1-signed`: Contains `{ "request": "<signed-JWT>" }`, a JWT signed by the verifier's key.
- For `openid4vp-v1-unsigned`: Contains the full Authorization Request object with `client_metadata`, `dcql_query`, `nonce`, `response_mode`, `response_type`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The OpenID4VP Authorization Request payload. Structure varies by protocol:\n- For `openid4vp-v1-signed`: Contains `{ \"request\": \"<signed-JWT>\" }`, a JWT signed by the verifier's key.\n- For `openid4vp-v1-unsigned`: Contains the full Authorization Request object with `client_metadata`, `dcql_query`, `nonce`, `response_mode`, `response_type`.\n","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>safari</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials API request format for Safari-based browsers. Uses the `requests` structure.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>digital</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital credential request options for Safari-based browsers.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credential requests for Safari, each containing data and protocol.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"data"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSON-stringified Authorization Request payload (Safari's DC API expects a string, not an object).\n\nDecoding it yields the same structure that Chrome receives in `request`:\n- For `openid4vp-v1-signed`: `{ \"request\": \"<signed-JWT>\" }`.\n- For `openid4vp-v1-unsigned`: the full inline Authorization Request object (`response_type`, `response_mode`, `nonce`, `dcql_query`, `client_metadata`, …).\n"}}></SchemaItem><SchemaItem collapsible={false} name={"protocol"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier (e.g. `openid4vp-v1-signed`, `openid4vp-v1-unsigned`)."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the OpenID4VP Authorization Response must be encrypted as a JWE. `true` when `responseMode` is `direct_post.jwt` or `dc_api.jwt`. `false` when `responseMode` is `direct_post` or `dc_api`."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `false`, the signature stamp is hidden in signed PDFs."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Page coordinates of the signature in the signed PDF, as `[x1, y1, x2, y2]` in points.","items":{"type":"integer"},"minItems":4,"maxItems":4,"example":[100,100,200,150]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>files</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of files generated during the verification, including signed and unsigned PDF documents.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential associated with this file."}}></SchemaItem><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Error code if signing failed, null otherwise."}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Detailed error message if signing failed, null otherwise."}}></SchemaItem><SchemaItem collapsible={false} name={"signedFile"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL of the signed PDF file."}}></SchemaItem><SchemaItem collapsible={false} name={"unsignedFile"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL of the unsigned PDF file."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the presentation definition at the time of the request.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the presentation definition at the time of the request."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"verificationHistory\": {\n    \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n    \"vpTokenQrCode\": \"string\",\n    \"vpTokenRequestState\": \"string\",\n    \"vpTokenRequest\": \"string\",\n    \"presentationSubmission\": {\n      \"presentation_submission\": {\n        \"definition_id\": \"string\",\n        \"descriptor_map\": [\n          {\n            \"format\": \"string\",\n            \"id\": \"string\",\n            \"path\": \"string\",\n            \"path_nested\": {\n              \"format\": \"string\",\n              \"id\": \"string\",\n              \"path\": \"string\"\n            }\n          }\n        ],\n        \"id\": \"string\"\n      }\n    },\n    \"status\": \"request_sent\",\n    \"verified\": true,\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"presentationDefinitionId\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"holder\": {\n      \"name\": \"string\"\n    },\n    \"presentation\": [\n      {}\n    ],\n    \"vpTokenResponse\": [\n      \"string\"\n    ],\n    \"transactionData\": {},\n    \"transactionDataBase64\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"responseType\": \"vp_token\",\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"dataAgreementId\": \"string\",\n    \"userId\": \"string\",\n    \"requestExpired\": true,\n    \"requestExpiryTime\": 1747015200,\n    \"presentationValidity\": [\n      {}\n    ],\n    \"clientIdScheme\": \"redirect_uri\",\n    \"directPostRedirectUri\": \"string\",\n    \"responseMode\": \"direct_post\",\n    \"verifierAttestation\": \"string\",\n    \"individualId\": \"string\",\n    \"mapperId\": \"string\",\n    \"dataAgreement\": {},\n    \"nonce\": \"string\",\n    \"dcApiProtocol\": \"openid4vp-v1-unsigned\",\n    \"dcApiRequest\": {\n      \"chrome\": {\n        \"digital\": {\n          \"providers\": [\n            {\n              \"protocol\": \"string\",\n              \"request\": {}\n            }\n          ]\n        }\n      },\n      \"safari\": {\n        \"digital\": {\n          \"requests\": [\n            {\n              \"data\": \"string\",\n              \"protocol\": \"string\"\n            }\n          ]\n        }\n      }\n    },\n    \"requiresEncryption\": true,\n    \"signatureStamp\": true,\n    \"signatureCoordinate\": [\n      100,\n      100,\n      200,\n      150\n    ],\n    \"files\": [\n      {\n        \"credentialId\": \"string\",\n        \"error\": \"string\",\n        \"errorDescription\": \"string\",\n        \"signedFile\": \"string\",\n        \"unsignedFile\": \"string\"\n      }\n    ],\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"presentationDefinitionSnapshot\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Direct Post (direct_post)"} value={"Direct Post (direct_post)"}><Markdown> Holder scans `vpTokenQrCode` or follows the deep link</Markdown><ResponseSamples responseExample={"{\n  \"verificationHistory\": {\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n    \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n    \"presentationDefinitionId\": \"1c3f6b1c-0c48-4b1f-9c1a-77f9c1d6a1a0\",\n    \"vpTokenQrCode\": \"openid4vp://?client_id=redirect_uri%3Ahttps%3A%2F%2Fissuer.example.com%2Forganisation%2Fxyz%2Fservice&request_uri=https%3A%2F%2Fissuer.example.com%2Forganisation%2Fxyz%2Fservice%2Fverification%2F8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e&request_uri_method=post\",\n    \"vpTokenRequest\": \"openid4vp://?client_id=redirect_uri%3A...&request_uri=...\",\n    \"vpTokenRequestState\": \"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f\",\n    \"responseMode\": \"direct_post\",\n    \"clientIdScheme\": \"redirect_uri\",\n    \"requiresEncryption\": false,\n    \"nonce\": \"z4cVLRsq9pKx0NgQ7E3hJg\",\n    \"openIdOrganisationId\": \"7f9b1e2c-3a4d-4b5e-8c9f-0a1b2c3d4e5f\",\n    \"status\": \"request_sent\",\n    \"verified\": false,\n    \"holder\": {\n      \"name\": \"\"\n    },\n    \"responseType\": \"vp_token\",\n    \"idToken\": \"\",\n    \"verifierAttestation\": \"\",\n    \"directPostRedirectUri\": \"\",\n    \"credentialExchangeId\": \"\",\n    \"transactionDataBase64\": \"\",\n    \"dataAgreementId\": \"\",\n    \"userId\": \"\",\n    \"individualId\": \"\",\n    \"mapperId\": \"\",\n    \"signatureStamp\": false,\n    \"requestExpired\": false,\n    \"requestExpiryTime\": 1747015200,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"DC API Unsigned (dc_api)"} value={"DC API Unsigned (dc_api)"}><Markdown> Verifier frontend invokes `navigator.credentials.get()` with `dcApiRequest`</Markdown><ResponseSamples responseExample={"{\n  \"verificationHistory\": {\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a8\",\n    \"presentationExchangeId\": \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n    \"presentationDefinitionId\": \"1c3f6b1c-0c48-4b1f-9c1a-77f9c1d6a1a0\",\n    \"vpTokenQrCode\": \"\",\n    \"vpTokenRequest\": \"\",\n    \"vpTokenRequestState\": \"f3e2d1c0-b9a8-7654-3210-fedcba987654\",\n    \"responseMode\": \"dc_api\",\n    \"clientIdScheme\": \"redirect_uri\",\n    \"requiresEncryption\": false,\n    \"nonce\": \"z4cVLRsq9pKx0NgQ7E3hJg\",\n    \"dcApiProtocol\": \"openid4vp-v1-unsigned\",\n    \"dcApiRequest\": {\n      \"chrome\": {\n        \"digital\": {\n          \"providers\": [\n            {\n              \"protocol\": \"openid4vp-v1-unsigned\",\n              \"request\": {\n                \"response_type\": \"vp_token\",\n                \"response_mode\": \"dc_api\",\n                \"nonce\": \"z4cVLRsq9pKx0NgQ7E3hJg\",\n                \"dcql_query\": {\n                  \"credentials\": [\n                    {\n                      \"id\": \"Person-Identification-Data-PID\",\n                      \"format\": \"dc+sd-jwt\",\n                      \"meta\": {\n                        \"vct_values\": [\n                          \"PersonIdentificationData\"\n                        ]\n                      },\n                      \"claims\": [\n                        {\n                          \"path\": [\n                            \"family_name\"\n                          ]\n                        },\n                        {\n                          \"path\": [\n                            \"given_name\"\n                          ]\n                        }\n                      ]\n                    }\n                  ]\n                },\n                \"client_metadata\": {\n                  \"client_name\": \"Example Verifier\",\n                  \"vp_formats_supported\": {\n                    \"dc+sd-jwt\": {\n                      \"sd-jwt_alg_values\": [\n                        \"ES256\"\n                      ],\n                      \"kb-jwt_alg_values\": [\n                        \"ES256\"\n                      ]\n                    }\n                  }\n                }\n              }\n            }\n          ]\n        }\n      },\n      \"safari\": {\n        \"digital\": {\n          \"requests\": [\n            {\n              \"protocol\": \"openid4vp-v1-unsigned\",\n              \"data\": \"{\\\"response_type\\\":\\\"vp_token\\\",\\\"response_mode\\\":\\\"dc_api\\\",\\\"nonce\\\":\\\"z4cVLRsq9pKx0NgQ7E3hJg\\\",\\\"dcql_query\\\":{\\\"credentials\\\":[{\\\"id\\\":\\\"Person-Identification-Data-PID\\\",\\\"format\\\":\\\"dc+sd-jwt\\\",\\\"meta\\\":{\\\"vct_values\\\":[\\\"PersonIdentificationData\\\"]},\\\"claims\\\":[{\\\"path\\\":[\\\"family_name\\\"]},{\\\"path\\\":[\\\"given_name\\\"]}]}]},\\\"client_metadata\\\":{\\\"client_name\\\":\\\"Example Verifier\\\"}}\"\n            }\n          ]\n        }\n      }\n    },\n    \"openIdOrganisationId\": \"7f9b1e2c-3a4d-4b5e-8c9f-0a1b2c3d4e5f\",\n    \"status\": \"request_sent\",\n    \"verified\": false,\n    \"holder\": {\n      \"name\": \"\"\n    },\n    \"responseType\": \"vp_token\",\n    \"idToken\": \"\",\n    \"verifierAttestation\": \"\",\n    \"directPostRedirectUri\": \"\",\n    \"credentialExchangeId\": \"\",\n    \"transactionDataBase64\": \"\",\n    \"dataAgreementId\": \"\",\n    \"userId\": \"\",\n    \"individualId\": \"\",\n    \"mapperId\": \"\",\n    \"signatureStamp\": false,\n    \"requestExpired\": false,\n    \"requestExpiryTime\": 0,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"DC API Signed + Encrypted (dc_api.jwt)"} value={"DC API Signed + Encrypted (dc_api.jwt)"}><Markdown> Signed Authorization Request JWT, wallet response will be returned as a JWE</Markdown><ResponseSamples responseExample={"{\n  \"verificationHistory\": {\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a9\",\n    \"presentationExchangeId\": \"9f8e7d6c-5b4a-3210-fedc-ba9876543210\",\n    \"presentationDefinitionId\": \"1c3f6b1c-0c48-4b1f-9c1a-77f9c1d6a1a0\",\n    \"vpTokenQrCode\": \"\",\n    \"vpTokenRequest\": \"\",\n    \"vpTokenRequestState\": \"11111111-2222-3333-4444-555555555555\",\n    \"responseMode\": \"dc_api.jwt\",\n    \"clientIdScheme\": \"redirect_uri\",\n    \"requiresEncryption\": true,\n    \"nonce\": \"uVj0pAq4cZmDk2yL6RxBvg\",\n    \"dcApiProtocol\": \"openid4vp-v1-signed\",\n    \"dcApiRequest\": {\n      \"chrome\": {\n        \"digital\": {\n          \"providers\": [\n            {\n              \"protocol\": \"openid4vp-v1-signed\",\n              \"request\": {\n                \"request\": \"eyJhbGciOiJFUzI1NiIsImtpZCI6IjEiLCJ0eXAiOiJvYXV0aC1hdXRoei1yZXErand0IiwieDVjIjpbIk1JSUI...\\\"]}.eyJjbGllbnRfaWQiOiJyZWRpcmVjdF91cmk6aHR0cHM6Ly92ZXJpZmllci5leGFtcGxlLmNvbSIsInJlc3BvbnNlX3R5cGUiOiJ2cF90b2tlbiIsInJlc3BvbnNlX21vZGUiOiJkY19hcGkuand0IiwibmV4cGVjdGVkX29yaWdpbnMiOlsiaHR0cHM6Ly92ZXJpZmllci5leGFtcGxlLmNvbSJdLCJkY3FsX3F1ZXJ5Ijp7Li4ufX0.signature\"\n              }\n            }\n          ]\n        }\n      },\n      \"safari\": {\n        \"digital\": {\n          \"requests\": [\n            {\n              \"protocol\": \"openid4vp-v1-signed\",\n              \"data\": \"{\\\"request\\\":\\\"eyJhbGciOiJFUzI1NiIsImtpZCI6IjEiLCJ0eXAiOiJvYXV0aC1hdXRoei1yZXErand0IiwieDVjIjpbIk1JSUI...signature\\\"}\"\n            }\n          ]\n        }\n      }\n    },\n    \"openIdOrganisationId\": \"7f9b1e2c-3a4d-4b5e-8c9f-0a1b2c3d4e5f\",\n    \"status\": \"request_sent\",\n    \"verified\": false,\n    \"holder\": {\n      \"name\": \"\"\n    },\n    \"responseType\": \"vp_token\",\n    \"idToken\": \"\",\n    \"verifierAttestation\": \"\",\n    \"directPostRedirectUri\": \"\",\n    \"credentialExchangeId\": \"\",\n    \"transactionDataBase64\": \"\",\n    \"dataAgreementId\": \"\",\n    \"userId\": \"\",\n    \"individualId\": \"\",\n    \"mapperId\": \"\",\n    \"signatureStamp\": false,\n    \"requestExpired\": false,\n    \"requestExpiryTime\": 0,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the digital wallet deployment is not resolved, the body has no `presentationDefinitionId`, no presentation definition has that identifier, the body disagrees with the transaction data template of the presentation definition, or the digital wallet refused the request.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The server also answers with this status when the body sets `individualId` and `mapperId` together, when the individual is unknown, or when the individual has no push notification token.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create wallet unit
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-wallet-unit

---
id: config-create-digital-wallet-open-id-wallet-unit
title: "Create wallet unit"
description: "Registers a new wallet unit with the wallet provider. The wallet provider uses this registration to issue a Wallet Unit Attestation (WUA) to the wallet instance. The organisation must have the wallet provider capability enabled. To enable it, use `PUT /v2/config/digital-wallet/openid`."
sidebar_label: "Create wallet unit"
hide_title: true
hide_table_of_contents: true
api: eJztWWtPG7sW/SuWv1yQhkB4lUZHRxcSaAMUQkmglCLFGe8kJjP2YHsSBpT/frTtSTJ50KLeh6507pd2mPixX15rbc8r5WBCLRIrlKQV+hV6wljQhjAiYURGLIrAklQKS0bC9ontw+RlotVQcNAl0lx+SVIDhti+MES7NTXDLYhVRBiTAmHk1s9o4dqH1oKxfsjabetwHQcW9hLSWCZD8Hsp3WNSGD88To0lfTaEVbaRkCWsIyJhMwKSdSLgJdJU+TMRNkBDSbvRapLN4fZmqGRX9Da56AnLog2/2qZKQAreLv2QuLsGkyhpgPRVxI3btc2MAY3mNNUAZJuornu/EEK0XhhicQwRhhgINdgSuQbJibBEySh7y3EaUJWAj2Kd0wr1plY1MAs1b6+P6GUCss79MwaXBlTDUwrGHime0crrQs5rYJmIzMTmYsqtyrMHupQvIzRwWrE6hQBNsCAtLsmSJBKhs27z0eC6r9SEfYgZPtksAVqhqvMIIdpjhY3whbd+ztREo5tWgMGJYSRAWvR3uoixWsgeDRa8qLqRRHCQVnQFaNJVelUSyFqtXiNKk9bX8/USHQf5Ji0d/XqX1tdzApInSki7ELBZiV660SwqLN5IO5EIzyBbFQ3GufAzGgXnfYjnt/fLkAFk5PT27A0DnOOhzhKrepolfRGSIWjRzdPjj5ABPRQhFnM3P6n47KqEjPog/dH1JmKpQpzYzDkkzGFq+0oLA8W0dJSKgEkXsS5LI0srXRaZJReuwZVVG91r4xPzq72A37KYqTRRkoRYI87uSzweTE5mGOBzo0MmSQ/s28hSouNxsYjvZ+W1nKeHcUDhmcUJFmqxECkXvDKArPKyzeOX2kE57DWeD24G4sNpJ02/xCd3+rbRu1OZzQat7zuQPfVt+fHjWccc3w25fnz+8ni1axP5CB+PakfNl/Si1tgZSLn/dP79WL/w3c7pXk9tV6t91Xjke58OP++8JCenjb1uOroe7O+39hpP+8f9k115Jj+/1OSLPG4cdL99/Ci/f+qNOof9svrw6bH8bW+7yfvdD63ds89HJxcXV3Su0Gnf2sRUNjd9BEu5q6VQxSuCUXmlA5vRCj2u4q96iLW4sb23TwP6TCv04K67M/x80pGn3fPkpCMHje8HnwYHd7osr566W/xq51tUHlx0r4Z3NKC40O7Z4OPJaLtfPo/3O0fhFXz9YJpb6c3O6Fv2nR2FNTjpfRang/P4YrnosHbGY59Mj8UOLLa3ysvotoqbJpgGfBHxEOV+G9XmoWs0Q7WfGeVKV0OoNBrD7GoWczjJ0bq3oPQnICreAZ8tKZ5SWAWfy3aWSMvkp3XIIuTynAVnLtd5myTM9knCNIvB8ccUDH8PzleDXUBsloiQRQgNZIbszkbu5IZfIivO5iluSi7rtd2bap0wyYljzdruTQOjblWoIiKkBc1CtMj8B4jCSQ/u4syFRpwNVRyncoLT/wb2kGkUodD5F9gkt9IqTyLZm7KtoZXq4iINZQwYM3HhHXxRNOoWycezQ7DMCMLM+MJnN8/RTJ3m9jXys/MPM+E6n8N5pfbuQpxOI6e3zRVSqZDMS/SXbJe2SJjPTW0fa3DGv9OTUxCBTTzjqAIZiu9Qg6tbFrnq5IpIZclIC4uqFT2PVG+VR03nza+8wlETL8JFD50+9eXncefQFlbEiPdA04B2lY6Z9a/2d1dByjOxIsYKiROyJiT6qiQ36wWJMddhMFPAZmdBmvD/pgU5EKMhETOWxIoj+nhbZvBWAyyoRsQsWvDrcPvxJMknrKgfr8oGUo2kLw1DmAbSFsq0A9JmkmsleNsVQ7vY/7Tn9RxXYFyphH0IB24XtxxSx1TOUKHMvEN1DKkWNnvnqcgdEpNpeU9jUiRM4KSTLXFHjrnFbjBw5yU3C5XdYZLkmIIw3ohYRurzWywk4gyy97BJfYlG5vUxQuAi+eb1MFUKaCqbE5NFQ76AZZzZlbrg9xH6cDqTxPkGq+2cBn5FlJdlr5gJ3oL2RV5bZpwFAF8C0JX4U0SO4hn+yRn6STUuJ3xl5B8W3SwosAenFvvAOGjURPjX7taWU/bvlXvFpUFrpauKo6vuuVbI28OySpsXZLPZq0Btekx3t7bGK5ZfUe2zk33EOBEySe1MedGx18rLEnTS8HUUz5CKEDeGLBI8IO2FOmhPm8CA5MJw7hYmn82WLofoctjLf+Owt+RMvyyFZu9vXZF46jVCHXIZaOK2WYjROKAGwhSxgVbuX+lhIpwsvn8Yo4+sZzAW+XXYRAquTbR9dZ0GdEEfYmxisH2FrX2ijIsNs31aob+6EMx7541JrU/+Tn0T5t0wzs5F9oxV7iXC41w/ziFWGywRJdHTTNqSUHQcLC7Q0IqnrjF5a5lfrXBtWQ+J4o3pxv+8aMjDLPzXWIW+eCZJmFYB8y8CKnArnz8aUMli/DVnkxdX1UtUfdioOzpeFs25kpkweHtunTbx2/jr4A6QRENXPOMVETYGbW8jaZM1qay/KraaicjFIGEhrAcESr3SwrIVkk/8I1OpxnBsDCD7s+05FU/k19nV6vHK66LpkSjeviy8LDZ4Sy2Tu0bDt7KrJvDAQgcPEDPhlkuTRGn7z1mqptEWn2av5nNcLI+FJEwnTXDctSQKvcP+A/+PQeaNX54Pf8icTLpx143uhr067WMMqRuTugvKtbzxXi903osTGxrMdIvpCW6sT9tzkzdSWDD+Ot/klORTZ6bfGgJ3Ux+4zfImNj/PhTbLkNS4YrBMcqa52XD+CiYt6UZqZHwh5ZF21t7uVMlNlayd3jbXA1I/bp6Q69oG9oc3Vb9b/fqSlA+2yjsbeySuqXAzrp0XWzvfvxgkyUiEII0rnsk5SVjYB2wkl1I3Go1KzP1cUrq3mc81m+f16vHF9fEGzhnP7oZm6cRgcRWm0+zRgCJI+bRvb23vlnZKZZyLUBgzWbDHX9YXZefi4S1Q1/+/JP0vf0nKcdrCs91MIiaka7X9vZYnv3s63PZ3oV3h+qk5P/zHKClmSnxKgrM3rkIeAtpHUq3c09fXDjPQ0tF4jK+fUtCOuQM6ZFr4Juj+YSrTHW8OEBJp1VfVRt5bOBpwNLMgjpDm/IzDMITE/nRskfcbl9dNGtBO/n0sdkKIajbCj15sRCv0B/1BndcOWpz4wvevNGKyl7IejvfrIjEgec3z4cDxYf6Ank1+klnBykVq9M7gv+jayil/4JE+g+zP6XD/y5sTpnTsR2PusTv6C49vllk=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create wallet unit</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/wallet-provider/wallet-unit"}></MethodEndpoint>



Registers a new wallet unit with the wallet provider. The wallet provider uses this registration to issue a Wallet Unit Attestation (WUA) to the wallet instance. The organisation must have the wallet provider capability enabled. To enable it, use `PUT /v2/config/digital-wallet/openid`.
The response holds the `assertionToken` of the new wallet unit. This token is secret. Send it only to the wallet instance.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Details of the wallet unit to register.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier for the new wallet unit (DID or URL)."}}></SchemaItem><SchemaItem collapsible={false} name={"clientUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL endpoint of the wallet instance. Optional."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientPublicKey</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key JWK of the wallet instance for cryptographic verification. The service refuses the request when this object is empty.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public key JWK of the wallet instance for cryptographic verification. The service refuses the request when this object is empty."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAuthorised"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Set to `true` to authorize this wallet unit upon creation. Only an authorised wallet unit can get a Wallet Unit Attestation."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The wallet provider registered the wallet unit.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnit</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The wallet unit record that the wallet provider created.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the wallet unit record. Use this value as the `walletUnitId` path parameter."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the wallet instance, typically a DID or URL. Used to identify the wallet during OID4VCI and OpenID4VP protocol interactions."}}></SchemaItem><SchemaItem collapsible={false} name={"clientUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL endpoint of the wallet instance, used for direct communication."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientPublicKey</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this wallet unit is authorized to interact with the Wallet Provider's services."}}></SchemaItem><SchemaItem collapsible={false} name={"assertionToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client assertion JWT of the wallet unit, used for OAuth 2.0 client authentication. This value is secret. Treat it as a credential and do not write it to logs."}}></SchemaItem><SchemaItem collapsible={false} name={"assertionTokenType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when this wallet unit was registered."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when this wallet unit record was last modified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitDevicePlatform"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device platform of the wallet unit. The known values are `ios`, `android` and `organisation`. The service does not check the value.","example":"ios"}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitIntegrityToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device integrity token supplied by the wallet unit during registration, for example an App Attest or Play Integrity token."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitKeyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cryptographic key that the wallet unit registered for attestation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Additional metadata that the wallet unit supplied during registration.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Additional metadata that the wallet unit supplied during registration."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"walletUnit\": {\n    \"id\": \"string\",\n    \"clientId\": \"string\",\n    \"clientUrl\": \"string\",\n    \"clientPublicKey\": {},\n    \"isAuthorised\": true,\n    \"assertionToken\": \"string\",\n    \"assertionTokenType\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"walletUnitDevicePlatform\": \"ios\",\n    \"walletUnitIntegrityToken\": \"string\",\n    \"walletUnitKeyId\": \"string\",\n    \"walletUnitMetadata\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request body is not valid, `clientPublicKey` is empty, or the organisation is not a wallet provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create sandbox organisation
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-sandbox-org

---
id: config-create-sandbox-org
title: "Create sandbox organisation"
description: "Creates a sandbox organisation for the organisation. A sandbox organisation is a separate wallet inside your organisation. It has its own credential definitions, presentation definitions, webhooks and keys, so you can test an issuance or a verification flow without a change to the main wallet."
sidebar_label: "Create sandbox organisation"
hide_title: true
hide_table_of_contents: true
api: eJztGtly27b2V87gyfbIWhy76dV0Mte1klt1iydWkockM4LIIwk1CbAAKEX1+N87BwApkqK8NXebpg+pTIJn3w9uWIwm0iKzQkk2ZBcauUUDHAyX8Ux9BqUXXArD6QDMlQa7xNrDLpy3HxYODGZcc4uw5kmCFoQ0IkbYqFw3oIwtLLkBYQ2otYRIY4zSCp5AjHMhBZ0yHcg0GpTWo6i9WeNsqdS1AS5juMaN6YBRhAkiLsGiscCJKpNzGREPwGGFWsxFFLhL1BrWwi5VboFDtORygWCVYznlQgYmuh/lRzmpPwM135EMpLmxMEOIMUvUBmOY4Vxp9DQ5Se8RdBcIvOQpljByKX7PEYTcVUBBjkG9ElGBjqQvcV3QV6iuVVUksUhlAo07k6iFApHyBbo39ChSK9ThWRurVoGwXZgoWCt9TWTuMSG71CpfLB2E88txBwwmGNn9tAWOY26WM8V13KE/ZSG/AIb0DbmMUcPR0XkUqVzaoyN4AUdHI1xhojLUdM4cHcHB0ZE3c/fhT7g5Ojr0AicgwsBM5cS12ktTx4kFV6g3EPEkcUYDwoLOpZOgxi7rMELqzo9jNmSRknOx8JivPNDXesE6TOPvORr7vYo3bHjTcMjJPrFYFUTQDSCExpgNrc6xQ7gsSkvgeJYlwcB7vxmCecNMtMSU0y+7yZANmZr9hpGtAfrAzJbITx2WaWLHCjQOwvbdE0luYrbCJlhGoK2AXin9OkMSYZ06co5dutzTLV/GaiFJxnUKfyXHCla8z/2EgbnAJCaDSLmMuVV68zi/hPF8nxc4g/Ho0wAQPwtjTcc/DZ68ECs08MNkcgmn/T6JDT/zNHOCOo9ShAlFtbExOWp222DzPimMtn89RhjKfcGTThkbCmqNVZpyhwRMM7sBjxfW5K4U8hLkKyQ3Ubmt83K1L9mU0ZrCt2G39F/lw6YhevXviqbJ+iPxaTSZksab2El/sMfmgxi8jcf7Bcr+Zx10yW1No4EVb/almtH6NDEV8dTb61Q5Fx25xJOitOPyjbHc5mZaGosVKRrL08y0RYE6EyK+34rfBv9zxcJcoL7LlslHHhYiRsJkCd9417wH4qO87oc85RI08pjPEsrVD3JCQrMr4/uxjXfEwo1RkXAG6uLqKJQLBJGweH1VIAtpcdHmQ+4gRCq+V0AJxgvUNXr3Qb2TYA+HIAo519xYnUc213ip1UrEqB8X+eswICuA3HbYCrV5kDbf+YN3CQB84s91KQ6tkgdY4BuV3CnYIuVgpMzGWEwJtNW5secyWqoHCGNCh4G70zUH0jAaj5yYzXtXPbYIeKZUglzuKlDGFM3QUNynUggspY/2sjOyBjgVqqFIrerAYJRrfMfzxD7JbjItUq434OHAygGqw62aOdeab1iHyTxJyDOLUmofGlPqpgLfVEJoG8O5QeODqU+nS5XEBqaEc+rz5N5PqTeSqoaNAqiwmLZ5K6UtKuPHVLE/LVJsu4AqydTVzagDexi9FSAkfNdG/AWaKm3IXyCqCoVVBfVWJ/dTdZnPEhHB2zc/l03Vlss6k0+FVyHQAfRp+PwhjjAp8us9olhzU6R3QpFn8b8FRcKNhQDcR5RfuJBPjyPCbLvxepq5rRdHghoGl+vrkFvzaJn2Krlqb5LZpocQyuthtyVq1oNZw96a9lJVd1Uvpew+3V0DU9HEvvn223/ggJ9GZ7OT+bN+vz/gz+Lng34hky9YI7cXJvsoGGxlPTypVgb9/UmdiX9pLm1F8EM26Pa7/UIBQ9bQgXuwm7zmPDHYyCz9ZkagYNyIne3MfDPvs2ZE23dy0NT6kC2tzcyw14sxVcc8E12xIC67QvVWJz0l3bCj52JAbx/+3hpnOwb0RUAPCtDb0DN4fnb6/PTs+TentXBRfVx4txO0752WyGPUlKLor9N+n2z0we1P1aNRa6UvVEwO535XGlhqgO7uJbZftwW40ptO+/3bFvAtQXzbvX7PYxAyyy3QrDNF6/Kv43638bpvZigoQ9lyZBi6KHLaqRtFCGOEXHSeMFgIuSXg1jjPTehSwwSKJrnuMU8K0sLha8TMB17vu9tuDj/b+tkO8LlFDdNXXCToxmiel1Z6hzDtAE+McpGFS+UifUBil1zC9LTfn9YbUDf/05iqVZhX7uuym7Y3+Bvb3lvJc7tUWvyB8Y5ozv7WbjmWFrXkiTMw1ODQtMjo5G8so8k2GERcUoSaUdzg0RLj4YOd/S4oDSd/vH+f9U+/KohEG4vY5RAuzZraCOmGbk/SUjuoL6Cq57tjybE0+XwuIkF93JVVmi9w6ID+cPULsW9FdUxGyxo3cS66Oq1U6tOI23td4yaMrkPPsANBSGN5kvjESTgOfC8X8aQC3a2yllzHa65Dty/sBlIV5wkelml1dKlGdRS8AkTN21aekyKDCgPTyQ6jd/D1xokcculyOOHJuNAGDq5TA0YspBvjZEsuDSTC2EMik7YJDUmkRBwh6E7h3IG3egNzLhKzrSLWfOP1EKwg0DV9g1Zvjs8p3U/drjVWzlgMylpdAXxBRU9Yfjp2aKGgEbvwKoivqQtf9/gNmtKtGqua3Y4gArtNzW/5dZh5i9p29NSBGBO0LUjCBK7yeRCysFVMVyotWKFNNZA3l8WTr5bsEoV2e296OAyvjYWLczio+G3Kr7H60jvrfrPpdrvTQy/L4PJtNWdw9oPdAEFHizGxWAjLk+o+uQZkPILvRPxi6HFuF8d+1ar2rsJasLaHJQfX1agqd5tfbp2pG7ffd0VksHAaB3lT9VVly5YjCCnGObV9TqcbKl5nGPHcYLX4JZmbIMLtaeuGT9pYFxE9UGFBIsZ0ieFRS57/50xUm0RU0J/1n7dhYP/lMMd2mtJiJCzshg0/3LDzTPyE9PPTLYmbLwypZRSs/31wFe8Up+8uDlmnGJWgIQWlaJeKRgGZMk5B3C7ZkFHn7TcBvWDex8qt/33RaRzu5oI2VaEmpUnQPa09u+00AVxqFeeRk8AeMPdBuLJ8QTvcPZ8b/7pJyKetSK/IyL1tFoLdjtz9Axr8EEynk8qAKrQrPIzt6oQVdz6oqaEhcVRJqSue5OXqZFqDMwWPplzfZxrn4jPGvnGeehphCgdShdslVnOROBlkPKKEj91FtwF2COHD7yh7kDiOr3HzYtp1Y0ly+DfbSx4v/3PbazdTU0VVzCMXizDlgpRo8ixT2v5zq7hS9n7g5h/VNV41lgZZ5UfFGocWO5EiXi2CoP+n5c2toJ2QW4j4d+4qlluKXpR3v4yTgePp4LXzt7FPLe0fXlYvh5U+enlIFFkVqcSEkpDMByV9Y4IY/wjJmS4ykdg7bjnjLzm4W2KbMgNGFfJy40zD0g0RHZtjx6/g0rrbZMabVZC0o/b9swt4dwEHP76fHHZg/HLyCq5Gxz++n8C7C49tfPUaBt/2B8+OzyAdqaiXjn6uXoebK51y69bniYhQGqwaT0bNFJy44Whddev1usvd667Si1741vR+Hl+8/PXq5TF9c7u9iLNVJwkrVlFeaq82iT3pn5x2n3UH9C2FvJTLCj3hplXrZnhnc14mzK/3EL/eQ/x6D/FL3UMM6ZY6i16W0ID+NsSGm1CdfGCrE1+wzoWrSSoVyqcOW1IlM/zAbm5m3NCO4faWHv+eo3aFUoetuBZ+a/7hU1lfuZLmmlI+u/CefTwhUuh4kvsKoFEWUwXivziPIszsnWerxdbl66sJ67BZuESZuhqUab6mHRFfsyH7yD4yt6xyburKbnp+wxIuFzltWofMw6W8SXVFvVS5dqVK+EGcFa/kpkJls2rxzNC/xFrrJ98F9b8oj/s3ez8oKyV/mvRJO8E/AXXhIi8=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create sandbox organisation</h1>

<MethodEndpoint method={"post"} path={"/v2/config/sandbox-org"}></MethodEndpoint>



Creates a sandbox organisation for the organisation. A sandbox organisation is a separate wallet inside your organisation. It has its own credential definitions, presentation definitions, webhooks and keys, so you can test an issuance or a verification flow without a change to the main wallet.

The main wallet of the organisation must be deployed before you create a sandbox organisation. The name must be unique in the organisation.

The service deploys a new wallet for the sandbox organisation and copies the logo image and the cover image of the organisation to it. To work in a sandbox organisation through the API, select the sandbox organisation in the dashboard, then create the API key under **Account** > **Developer APIs** (**Create API Key**). The key is bound to the sandbox organisation, and every call with it runs there.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The sandbox organisation to create.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The sandbox organisation to create.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the sandbox organisation. This field is mandatory. The name must be unique in the organisation. If a sandbox organisation with the same name exists, the service gives HTTP 400.","example":"Acme Test Issuer"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the sandbox organisation. This field is optional, and the service stores an empty string when you leave it out.","example":"Sandbox organisation for issuance tests"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The service created the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The sandbox organisation that the service created. The service sets the `id`, the `openIdDeploymentId`, the `status` and the timestamps.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human readable description of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdDeploymentId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the associated OpenID deployment"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Status code of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the associated ledger"}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the infrastructure provider"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the sandbox organisation configuration"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role of the sandbox organisation in the ecosystem"}}></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trust anchor identifier or DID"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this sandbox organisation acts as a wallet provider"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVault"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the primary secure vault"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVaults"} required={false} schemaName={"integer[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Identifiers of the secure vaults that the sandbox organisation uses. The field holds `null` when the sandbox organisation has no secure vault.","items":{"type":"integer"}}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the logo image. The field is absent when the sandbox organisation has no logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cover image. The field is absent when the sandbox organisation has no cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the logo image"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the cover image"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was created"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was last updated"}}></SchemaItem><SchemaItem collapsible={false} name={"isMain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this is the main organisation"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"openIdDeploymentId\": \"string\",\n    \"status\": 0,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"string\",\n    \"version\": \"string\",\n    \"role\": \"string\",\n    \"trustAnchor\": \"string\",\n    \"isWalletProvider\": true,\n    \"secureVault\": 0,\n    \"secureVaults\": [\n      0\n    ],\n    \"logoImageId\": \"string\",\n    \"coverImageId\": \"string\",\n    \"logoImageUrl\": \"string\",\n    \"coverImageUrl\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"isMain\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"6889e1a4c5b2f30001a3d710\",\n    \"name\": \"Acme Test Issuer\",\n    \"description\": \"Sandbox organisation for issuance tests\",\n    \"openIdDeploymentId\": \"6889e1a4c5b2f30001a3d711\",\n    \"status\": 2,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"iGrant\",\n    \"version\": \"1.0.0\",\n    \"role\": \"\",\n    \"trustAnchor\": \"\",\n    \"isWalletProvider\": false,\n    \"secureVault\": 0,\n    \"secureVaults\": null,\n    \"logoImageId\": \"6889e1a4c5b2f30001a3d6f0\",\n    \"coverImageId\": \"6889e1a4c5b2f30001a3d6f1\",\n    \"logoImageUrl\": \"https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f0/web\",\n    \"coverImageUrl\": \"https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f1/web\",\n    \"createdAt\": 1754745764,\n    \"updatedAt\": 1754745764,\n    \"isMain\": false\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The main wallet of the organisation is not deployed, the `name` is missing, a sandbox organisation with the same name exists, or the wallet refused the request. A refusal of the wallet keeps the status and the text of the wallet, after `Failed to deploy sandbox organisation: `, also for another status than `400`. The service then removes the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"502"} value={"502"}><div>

The wallet cannot be reached: `Failed to deploy sandbox organisation: The wallet cannot be reached`. The service removes the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"504"} value={"504"}><div>

The wallet did not answer in time: `Failed to deploy sandbox organisation: The wallet did not answer in time`. The service removes the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"507"} value={"507"}><div>

Insufficient Storage: the HSM partition of the key store has no room for a new key. This is the partition of the installation HSM (the local key store in a hardware security module), or the DPoD partition of a key store of your organisation. The text is `The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.` A new try fails the same way: the answer has no `Retry-After`, so do not send the request again before room is free. For the installation HSM, the operator of the installation removes the unused key pairs or gives the partition more room. For a DPoD partition of your organisation, delete unused key pairs in the partition or give it more room. Some operations put the text after their own text: the test CA (`Failed to make the test CA: The HSM partition has no room ...`), the deploy of the organisation wallet (`Failed to deploy the OpenID digital wallet for organisation ID <id>: ...`) and the create of a sandbox organisation (`Failed to deploy sandbox organisation: ...`). A route that signs can also give this answer for an organisation that has no default key yet, because the wallet makes the default key the first time that it needs it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 507,\n  \"errorDescription\": \"The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create SSE ticket
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-sse-ticket

---
id: config-create-sse-ticket
title: "Create SSE ticket"
description: "Exchanges the `Authorization` header of the caller for a one-time ticket for one Server-Sent Events (SSE) operation. The browser `EventSource` API cannot set request headers, so the client puts only the ticket in the SSE URL, in the `ticket` query parameter. The access token or API key then does not appear in a URL or in an access log."
sidebar_label: "Create SSE ticket"
hide_title: true
hide_table_of_contents: true
api: eJztWG1z27gR/is7yIfaM9SLLV+b6m5u6pPdnBP37EZOPG3sGcHkSkRMAgwWlKx69N87C5AUJcuXc3tfbib54FB4WSyefXbxAI8iQYqtKpwyWgzF6UOcSj1DApciTI5Llxqr/iO5ewIpygQtmKnvjWWWoYWpsSDBaOw4lSM4Fd+j861GI4zRztF2xqgdnM5RO4K98fh0H0yB1pvtwlWKcGfNgtDCxA8am9LGOIHjyzOIpdbGAaEDi19KJFf5QRGQCZ5kiu0XpSMwOlv6xsoRpf2v8fgUPrw/j+rfk9A9gS8l2iUU0socHdrgjYxjJAJn7lGDsd6Pe/R2NSQGCdglWRQoLVuUbJsH8reup2dm1r3RN/rVq1d+/WbLjK50fljhQFau8tA3ao4et4AxIRTSpcR2J/w1Gd7oDkx688NebPRUzXqJmikns86Co+F6pkCtkp42Tk1VHFbrEeEEOkDOosxhow+8tcFLrBUWCbXzvzrkpCu3V5ijbcZDGFHj8L7M0P/oeKArDuUlObhDkFlmFpiAMwzWOnINcoxLAKILx3WINc7RwkzNkSA3Fm80NBFMORwNcZwJyK/tLZRL/TIk8+cI3629rSlFMJeZSjzJJ/hQKIt0pidAGBudEOwN+vsgddJkQWv94L2naReONfta6nttFjqCkjBhFgWTSbVeBD7DWokltXEpWs+NqNr4Uf8AzA7EGue5tfaj2XVl1JaaQFI7rT0BFa0NDXeVBHa/XRUUNWvIosgUUuRThadWWVuXj5Y/3sc3yKmgcdHeKco4hdhojTGvF4HMyMAirbhRJb7Fagh1RSQaj88SMRSB2COL0uGY8MrbFpGolv7JJEsxfORhDrXjT+94IG/vM3FZfBQUp5hL/nLLAsVQmLvPGNd2OFhi+ElwPMRtJArLPjiFxDN863omOav0TERblfdSuhT2msDM0RLzs7A4VQ/7bdDW5PVcdhvEnBrLGKAuc/bo5YVCROL3qQcMBD7IvMh41/+DIyv+1wbY2RJ9AxVGUwD3sH/wu4XP1dxoUvppMKsxXw3nxeZ52IXL0oFyXzt+dsd5XfREG9Mvg7cP/bu/XL2OD+f/OtDvvsuv/1qcH9H7P5enffnvw/Tk9fTN4PPowP1TrNq7WnuvtMMZ2ifun6spevcrf9aHaVXjNjwZ9KtYbRoJSZd0n62dW6XxKxuv6ocYPvJSR/3+iwLfDjRaa+zIJEx2/33S8vs2ekKSTQqsZ+/CsQHlqN9f7TC/gznriP4kE1C6KN2aEcID2wzZWP6o39+1gq84jLQXKTpUWlM6FDuC5MWXSZb1+Lfji1/8iVMdVFXzWpNsSxl5Z+a4Kz4vS8w/cnx2o/qMelYEuSJSesYoM7Y+IXYhOPi/StsmKr8FkMEqEv9AIjnDX8fhg5bV3jCppNb3H1i+szbWf3KQyjkCalPOUijQ+g0bTd8/j1YlO2rWvkAIbgG3igRhXFrllmL46VEcF+od8uftiqkjZ8QUOwmHEFz7Qwj2LgrUZydHH0f7IhI/myxBy0zL0aWGZURhyGPqz/L2aUbEhb46OMjfdsivu7nFE8wNhG4RidJmYihS5woa9noJ5qYjC9VVMyu16yojVtG2gUtrkjIOinq3ma9ZGDs5Y9Y9M51C97Yjt2s4x0y1wKYa1IYkMjREQvFSIR4iElrm3LuRCU8Om/p2xZxC7SqGh2NjLrOyqTzPZFR9ewhaCZMgbyfBR5jAnjYOwzFmpco8BoWMcT8C7M66W2aHUE38YWlKy3B07nH546QrmFqcdu/X0vF0XZefUuM3Cx1GbWrqZJexT3bMpeL4UFkUxrq/rWPSwKrerJs2g9nmwRbazSQorJmrBAkkxIa34RAU/5/Xcq4GPmSHP7M/+rudvMsQRhYTjpfMCM6ISqljhL0Ln0Zn4QK0e+JlSzGuU+9ynz1yJjYZcfAV+Xs3ap5DYOxM6ipGfDUHRVRiBKnJksgv5q+dS6hgh7jlXunrLTmpE2kT6vj9KqkdTDOzoMCYCmnv7fVgBB9HsPf2+mo/grPTq7/D+KTz9voKPo7CamfjCzh43T8YdL6D/MTEvfzkvLUmW8lluJFkKkZNniV1QhQyThEOu/0noVssFl3pu7vGznrVXOqdn41OfxmfdnjOKhJOuWyDAx6sxMRlEz0RieoaIYbisH941B10D3guF7Nc6pY/Qar5EtsUs2TzVGzOoW+PRN8eib49En17JPpDPxJVssXhg+sVmVSa66IvxPVJ/knMD0VUvR+xtlsLvdtIpKwHh5/E4+OdJPxgs9WKm32hYK0Zibm0/rTzyrOWqF4Z3rNyEqNQTztX7AkPz8ogpLY0Pgu5MOPYl4JfHduWrJcX4ysRibvqhSv3FwBh5YKfPeRCDMWNuBH+wcznrL+FcfujyKSelf4WIIJdlj4szzYV371XfNUH76zu0suWl9viL2yG//LWdk75gWvpO1z+2AwPPc9OaARnGM3hvF2tVv8FQCq1PA==
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create SSE ticket</h1>

<MethodEndpoint method={"post"} path={"/v2/config/sse-ticket"}></MethodEndpoint>



Exchanges the `Authorization` header of the caller for a one-time ticket for one Server-Sent Events (SSE) operation. The browser `EventSource` API cannot set request headers, so the client puts only the ticket in the SSE URL, in the `ticket` query parameter. The access token or API key then does not appear in a URL or in an access log.

### SSE operations that accept a ticket

Give one of these paths in `path`:
- `/v2/config/digital-wallet/openid/notifications/sse` - stream notifications - `/v3/config/digital-wallet/openid/notifications/presentation-status/sse` - stream verification status

### Rules

- The caller must be allowed to open the SSE operation of `path`. A ticket never gives more
  access than a request to that operation with the same `Authorization` header.
- The ticket is valid for `expiresIn` seconds (30) and for one request to `path` only. An
  unknown, used or expired ticket, or a ticket for another path, gives 401 on the SSE operation.
- The SSE request with the ticket runs as the caller of this operation: the `Authorization`
  header of this request applies, not the headers of the SSE request.
- Get a new ticket for each connection, also when the client reconnects.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`/v2/config/digital-wallet/openid/notifications/sse`, `/v3/config/digital-wallet/openid/notifications/presentation-status/sse`]"} schema={{"type":"string","description":"Path (with the version prefix) of the SSE operation that the ticket is for.","enum":["/v2/config/digital-wallet/openid/notifications/sse","/v3/config/digital-wallet/openid/notifications/presentation-status/sse"],"example":"/v2/config/digital-wallet/openid/notifications/sse"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

Created. The ticket is valid for one request to the SSE operation of `path`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ticket"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"One-time ticket. Put it in the `ticket` query parameter of the SSE operation of `path`.","example":"q3Jx0b7T8c2vY1nK5mW9pL4sR6uE0aZ2hD8fG3jC1tQ"}}></SchemaItem><SchemaItem collapsible={false} name={"expiresIn"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Lifetime of the ticket in seconds.","example":30}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"ticket\": \"q3Jx0b7T8c2vY1nK5mW9pL4sR6uE0aZ2hD8fG3jC1tQ\",\n  \"expiresIn\": 30\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The body is not JSON, or `path` is not one of the SSE operations above.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"path is not an SSE route\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

The `Authorization` header is missing or not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The caller is not allowed to open the SSE operation of `path`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"Code"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":403}}></SchemaItem><SchemaItem collapsible={false} name={"Message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Unauthorized access;User doesn't have enough permissions;"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"Code\": 403,\n  \"Message\": \"Unauthorized access;User doesn't have enough permissions;\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create webhook
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-webhook

---
id: config-create-webhook
title: "Create webhook"
description: "This endpoint creates a webhook. The webhook sends the events that you subscribe to, to an external IT system. The payload URL must start with `http://` or `https://`, and it must be unique for the organisation. Subscribe to a minimum of 1 event type."
sidebar_label: "Create webhook"
hide_title: true
hide_table_of_contents: true
api: eJztW1tz27YS/is7fEo6lHxLclKdNHNSO23VJnWmduKTJh4LIlcSahJgAdCy6vF/P7ML8CbJkZK2L6d+SUQQWOwu9voRvolSLAwmwmEaDSYisxhHKdrEyMJJraJBdDqTFlClhZbKQWJQOLQgYI7jmdaXfTidYfUAFlVqwc0Q8AqVo5/CwUKXYMsxUR0jOB2D0yAU4LVDo0QGw1OwC+sw99QKsci0SOHtL68gL60D64RxMJduBqOZc8VgZ2cE2vgHS08xCJWCdH7+GKFU8vcSYaINs6PNVChpBQnVh5MWMyAgl0rmZQ56AnuecXCLAvsf1UdF/Fg0VzLBIB2KZBZmCUti/HB6+gbeHJ+cEjXX5d8LNNbpAmY6Sy08honELLUDGKWYySs0i+HRKIZRUKF/cDJH60Re8MOiwBHLN0qFEyNPMwwztUB7jyQgBmplpy1xrNcRvfd0OmvrMwM9/g0T14fvtCHpjodHj94d+ndxtdKvGbW1Okz5EECz4YgMRlaodKyvj800vPObJwZTVE6KDMLhFAYtKsdkwGCiTbqqezlVQfeV3rxBsDz/7Q2/N0K53omcKuFKgyOYoUjReGVdiaxEkBZG7ptntXKfx1ZOv3k2w+vnoxjmMzQII/9Ic4lypudoEmERZngtUkxkLjL44fWLw97JDy/2Hz8hlY9aJPvPfrNa9YIJPB81TFpMDDq4xIXnqZJMZHOxsEFAmvjjyfHPlQ3FIDKriTfllaeVqw6U5RFFkcmEVbdz3ZvP572JNnmvNBmqRKeYjvowVN4PSY6YvSpFeud1F3Yaka/kwSbGONEG2XGTGSaXXoBKtyuHk4tLJPOrT0Y4h3nh2P0af2G5DfOtNIjS6Vw4mYBBZxY1UYO20Moieb0rLTCnbNjSgi7QeDsh4fd3d0cxKO3o515wjHp9Y9iN6kEqSDIUBhxeu/5HFcVRTXOYRoMo0Woip4cc5868T0ZxZPD3Eq37VqeLaHAThWOgn+0DoKOnMZvMMBf0qzBE3Um09BR8nJdl2fEkGny4YdLSUPz9EIWzeGuyKK42OV0UGMVR49MvObTSEIv1Ey6i8zgii4gGkffeKI6cdBkNeEmOzdsi7Ui0HOWbIO41UAY9Ox2CPnurhpLpdE1YTpU2aGEkydEpLLDHdyOAj2BNZAM58ZkBfWDI+zB04NiUlkM2TIzOvbn64T+qmFO5eRQv6bqlysFNpR3rjFTTtdJTFD8hGTmck5OwzxhMUF4FlioNBdrt2LJlnmIlbJOjojjCa5EXfIbV8jDST3S+Q4zYHTmlsBfddq1lK4E7oSQkjhUBKQlsEWPilcBF/klBnRxOgJVqmmE7wiiRY9oEH5ZXlTk5wYpHxdFGDqLz2zUu0uhhxS3WuNOqilrJ01tDW0eVZcQk4gFMjS4L24cX3XIiKPYAhDEU5vnsKTJ9ou7o+JbBSWmRC41miueG4yhrmFOVtI5ISWc9M106qUY/3WCurxDS0qs0GLBd9aCEoqhyr4USU8xRubMmfAW1slArqjv0CyGvV7Y1yWzZukLUSVIan+CEAqlSeSXTUmQwZbfTptZA4CemMWEvLUWjFDN0GEOq54rNTpsQoUgn0gDVKySadJjbzY5xslQ5tcySKYXoJ5V0kovmuDOeCJVglvF4YLcvMioi2iOptKuDlA4v8LqQZlER9cKtblYJu+aNX9Fmo7uieXN+extHqZxKJ7IzkWW49fEe+UUw51Xdo33J6b9dMwKfHSdvtsp/hzBeoJJp/6tRMD8QxtcjWmWLaoytvK5Bh3S4xwUqenoDUjmchiSlEFMb6uIgk+eutcEYM62mVY2usxQNHA2PDnWeQ2G004nO6iKk4q8pVolSMNmJptNjMtLaEg1Y6WuUFq94ncyEmgZvrujNeN+NZP00Jttd3y6V+1/1rw6WVxMHtYoqHgYwCgXMBa2m1Fw9hyhWpec2/QuRXNKLROfYJOArNHIiA3PxmlUFqlSq6dYE27JyPfbnXXX18PRkgoaF9wXf2teVLtZOaX5e8KFvnMXCbp6UYOE2z/OOvX4asUNufZGiknfMcfoS1Qrjq9bY2jKc45azl6TdMHdZ6I5Zt021f3WwYVZ1aHfPXDXBLecGDdBsHy2FE6+FuURXZCLBreOlcALyZt12ydC1cneFutTJjQAY4gZSaZNM29IgiKlBn2xDC/2XZb0W7316vmh2vah3vfC7kqZ8ZrFiTHmm2XysdYZCrex+RuKOnCkx1JFVhdUqWfiMg+JClylJe8cBbejDEU5EmTmuCkaMZHFRmfrhAG7dtpumzWpp2sbSYsqtkM6L0uHdqEMbGvCtSdMEV+1x1aeyUMYnSOmYfN1si9LNyF0S6RZVEVlX5Uea1VJaBBH6Dz0BW4iEjERli0HHfLy/8R7jkotYFbAspZuuvu6kSEmXsjix2TuO9b7u/pKDJAbQNOfIuWPBr05fnUBCtebEF6FdET109rmHe3t7/gV9bT8ie2134VWbvtJVe8veboN+1CZKSuFdPDbBPrm/u/t3YgmS4yu13lTZfxawUDtv213WWwV1VKGj/xQKcRfu8OKO0wnm0IVt16FmHpLlqtM3ljVSxCzEVANh4ZawiNVmR6ab48Fb369LzmNcA3Xb5m7T/uSp2JvsJwfpI3w8eSL+NX6afJ3u4h75lz+WL9+wg41wlaznynZ5ITduyfwndgtkPnEaFe4vbXUKVMVT4Ks/FHg2fRFuPe5e0U2xyPQiZ4TwxUp/7Wm1vimEHlfPFdhEF8iifg7csx248/ciMIdboC/3mMg9JnKPidxjIveYyD0mco+J3GMi95jIPSZSl6xKd+GQha/4vwjdqOu4Srk+P2lIRJaUmfgU4BFADj1Zh3Gs6Q/CVYz2Z3h68i1cI6Xvk2OwmhMRJp7B+uO+sPzxuP2Oblb8xeBFp0j8PPSCOGla4809yekh0PS7DD1tWwGX16P379+/771+3Ts6Op3NBnk+sPZXf4tDuDvqXJ/62gehucQMpVqn5dnf3X/S233a2/36dG93sLc32Nv/NdqEsXQsCU3FfMMOZTV0vuPy1wWqr/rVFQF+bl0T8Pel/hxKc/xTFEfeUsn1acKjz0Rf2lujMdoc6pTgE/591NptDQrS7SGa1Y1VcOGGpn0Aj3Z3b9eQX2NJzZl9Sx/eVVE6KIQROTo0pI5VhdDEkC2WzqZ2VN6ZLmlQoFapcLrGWKSFXFr6qB/ThCXTb8xtm3t7vEFlPs1lKZF3aeK1tM7G9aWR9g2+OhSSYrgVkpOl3pCRiOXLU+zUIpOcFpatY+8fbB1vFcHP2sg/uCDpqubxP9pxhircWQ0Ow9ss6cjn4dJIt2BU9kUhOSN/OKfg6cTUki7OmviVo5tpunxWaMtiCzeLBtHO1f6Oh0V35jV+6ve1THippsJcB7aiOCoJCatxqxRz3ROF7Hu4qi91dBsvE3hjdFom3DzeQWYThRMnplJN71pu/etlRs4bfZ2Q2fjTrrTWVJJ+II4kbeUVHsUR3SQiJDlYbAVLL+HMb4Zc6dSfVVogZv0BhTNPh05d3lRXtgqDE3mNaQhqnkcYwQOlQ5HkjJAZ64A+xzyMAfvT/hLZAYSFzxa6NKSO3iUuno98kiMX+qW5b/iyMtIO5t/GOzejk0vg5Do4cR1QeDfadRf0c34XfrKhAT2/u5P4onq7XWyHa+2t0riJAGtrxfA1iQxtoqtYJxKOdZgLmTFWWhTauP80Zlxbovy+Geraf9t1lgy0XkQl7ZVMuZ2hr43U44Kk//P6jnSwVQ9qMMzuBSCB4bBWsIVhaIPhQYBgHnKJtX7hm/Y17Ac1YvKwRoK4M5MWyJlQ0RoL7euY3DJwPx0zguGRkFA2B7NoXf+2UFp2FEflhUltj+WVQjmYZHpuvZMFTTO3ZweH8O4QHvx4dvowhuHL0+/g5Kj349kpvDv0uw1PjmHv6e7eQe8x5Ec62cmPXrWvnPvymJHdTCaoLDtWFUMKkcwQ9vu7K0c3n8/7gl/3tZnuhLV259Xw8OXPJy97tOa2gdKb4yRlpTop69OL4ogCuD/2/d39R/2DPn8UouCfC9Xix9/dhfn6j2etHHz/Vxr3f6Vx/1ca93+l8X/8VxqhCKSBnSITUlHILP3nXl8vf4iu9n2lM5GU21sAwYzq6sGH6OZmLCy+NdntLQ3/XqLhujyOroThLMhVelXOc5F9yRVD+F7bC5cm2FTXFVJUE/sVLxjR/eTcdulPoSmKo3H4C5Oc25zIiDndIxHzaBB9jD5GDNFyruXWisZvokyoaSmmNN/TpdqFKt1u8XzJxXP4QZJVr9SixeVyHe2FoX9JtLVLnlGO+wkXz+vp/s2dC+ra3c+msySI9H+RryjP
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create webhook</h1>

<MethodEndpoint method={"post"} path={"/v2/config/webhook"}></MethodEndpoint>



This endpoint creates a webhook. The webhook sends the events that you subscribe to, to an external IT system. The payload URL must start with `http://` or `https://`, and it must be unique for the organisation. Subscribe to a minimum of 1 event type.

The service sends each event as an HTTP POST to the payload URL. The body holds 5 fields: `deliveryID`, `webhookID`, `timestamp`, `type` and `data`. The `type` field holds 1 of the subscribed event types, and the `data` field holds the event object. For an OID4VC event, `data` holds `organisationId`, an optional `sandboxOrgId`, and the credential or the presentation record.

The service signs each delivery with the `X-IGrant-Signature` header. The value is `t=<timestamp>,sig=<hex>`, where `<hex>` is the lowercase hexadecimal HMAC-SHA256 of `<timestamp>.<json-payload>` with the secret key. The service always signs the JSON payload, also when the content type is `application/x-www-form-urlencoded`. In that case, URL decode the `payload` form field before you check the signature.

The service makes 1 delivery attempt for each event. There is no automatic retry.

The response status code of this operation is `200`, not `201`. The response holds the secret key in clear text.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The webhook configuration.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The webhook configuration to create or to update. The service ignores `id`, `orgId`, `sandboxOrgId` and `timestamp` if you send them. It takes the organisation from the `organizationId` header.

</div><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTPS or HTTP URL that receives the webhook payload. The value must start with `http://` or `https://` and must be unique for the organisation.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"The content type of the webhook payload. For `application/x-www-form-urlencoded`, the JSON payload is sent in a single form field named `payload`.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook does not receive event deliveries. Optional. Defaults to `false`.","default":false}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key used to compute the `X-IGrant-Signature` HMAC-SHA256 header for each delivery. The receiver uses it to check the authenticity of the payload. Do not use a value of spaces only: the service accepts it but then sends no signature header."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the server does not verify the TLS certificate of the payload URL. Optional. Defaults to `false`.","default":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The server sends this error if a mandatory field is missing, if the payload URL does not start with `http://` or `https://`, if a webhook with the same payload URL exists, if you subscribe to no event type, or if an event type or a content type is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete all notifications
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-all-digital-wallet-open-id-notification

---
id: config-delete-all-digital-wallet-open-id-notification
title: "Delete all notifications"
description: "Deletes all wallet notifications for the organisation. There is no filter and no confirmation parameter. Unlike the delete operation for one notification, this operation keeps the credentials that the notifications refer to. The wallet keeps no response body."
sidebar_label: "Delete all notifications"
hide_title: true
hide_table_of_contents: true
api: eJztVm1v2zgM/isEP7WA46RdBxyCYbhe0rvLNmwF2rUfhgJVbSbWIkueJCfLAv/3gZKT2GmH+wG7fEgUSXzRQ/Iht5iTy6ysvDQaxzglRZ4cCKVgLZQiD9p4OZeZ4BsO5saCLwiMXQgtXdhN4bYgSyAdaANzqTxZEDrnf5nRc2nLcA8qYUVJnmwKn7WSSwqq8mATTEU2XmMbRlPPcgK+kK5zaUlUuSCfWcpJeykU/xc+bPa9tjQnC94ET3cPixq0AUuuMtoRPJl8k2KCeyuzHMcYnrCIyFwqNZUL6YW6D0o+VaRn+ceOMUxwp8/heIvnowv+6cPc8SK+Pg+I95xmRwoSOVnW0zQJXoxGrCoz2pP2vBRVpdr7w6+OVW/RZQWVgleWvtXSUo7jL0jWGjsxOWES19OOQw8J+k1FOEbz9JUyjwlWlkHwMj7iID3e7q5K7WlBlvV9F2WlCMcXo1HzgvqDjPNW6kVXBP8SOUhd1f6QHdjwJ3kBs27WcbrVeqnNWifQZmWLaSa0Njton6fDS8ie/cbIftai9oWx8gflz6B5/Vsn3Ux7sloocGRXZCGYOcKoSdBRVlvpNzj+ssXLSr4nXj40/EaxcIxFSxsQeQNOAnNML+4mp5jgv0blZBmSknxhmHVi8jIowhc4xuHqfBiZaJhHVYOY7UNTkZb5sJfiyD6xxy64dEzypWkfhAnWVuEYC+8rNx4OcyrNQFQylQsrtE+lwSY5VnBtTV5noQh/oea/NNx4sZB68StxF4+PHXk4IH3DCRfzZIf3PuAibiQo2VQMFSaoRcmnl22u79i679jl9QyWtAGuCG4q2aHDwUqomsDMA6M89vQ8QjQDZe08PBFUlubyO+Wwlr6Ax+gjPMKJNi0leSukChhUIqPTBChdpEdqx9AKvtmY2jIcgyVt3j6myFkn9dzsalNkoTapFJKBdHVVGev/PIC3f7/857DVR70bsCNY9kJQWbOSOY8IkBkuJ08g+bck7SMxtwjFDA/d/I6snEvxpAgmnW49c64WOiM4+RRKYXYaxoaXBa8tub2Jfflcn7JH3mRGOY6SdMAhJM0yrm0YP9oxwBuQztWUQGFUngRjK7awgbamesNE7UJ4vNC5sLkbhPdKoT3MlVm7GNoW6eDt/asJ3E3g5N397WkCs6vbv+FmOnh3fwt3k2htdvMJzv4Ynb0avIZyarJhOf3QsclaSuFDh1IyI+0C+e0ytxJZQXCejp6Fbr1epyIcp8Yuhq2sG36YTa4+3lwNWKZJ0EuvejkQwMpNVu+jhwkybcSwn4/OL9JX6RnLVsb5UuiOP3Ekej65HBdVp3v8P2CGAbMlKk/f/bBSQmoGOER02/L9F1ydY9LOngxoj/PjjKolt+s+9A8JFsZ5VrDdPglHn61qGt7+VpMNXSnBlbChpkKP2jWz0CiWTKR4mWVUsZHAeIFRj1p+021V06sPV7dXmCCTZp+Hl4GH2wUb2B3pTUf9MSVHL/ibO8eLIm84cd/T5u3+ejz5pcC+DcTbDPlD0zQ/AU1Ii+s=
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete all notifications</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/notifications"}></MethodEndpoint>



Deletes all wallet notifications for the organisation. There is no filter and no confirmation parameter. Unlike the delete operation for one notification, this operation keeps the credentials that the notifications refer to. The wallet keeps no response body.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The wallet deleted all notifications.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, or the wallet cannot delete the notifications.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete credential definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-credential-definition

---
id: config-delete-digital-wallet-open-id-credential-definition
title: "Delete credential definition"
description: "Deletes a credential definition and removes its credential configurations from the OID4VCI Credential Issuer Metadata. The issuer also deletes every credential issuance history record of this credential definition. Credentials that the issuer already gave to a holder stay valid; revoke them first if you must withdraw them."
sidebar_label: "Delete credential definition"
hide_title: true
hide_table_of_contents: true
api: eJztV0tvGzcQ/isDnmyAethxgEINgrqWWyiPxqgd+5AaML0caRnvkhtyVooi7H8vhlw9LaWXHgqkPliL3RnOzDePb7gQGkPmTUXGWTEQQyyQMICCzKNGS0YVoHFsrGEJUFaDx9JNMYChsCmVOTs2k9orFgww9q4EyhE+jIZntxcjuFiLjkKo0cN7JKUVqS7c5AgmvVRFcKBbN3CKfr5phIWUzRByE8j5OXjMnNfgxkC5Cfu97m7YDkC5oujYyqBHpecwUVMEcqAgd4VGD4HUHKaqMPpn8Dh1T8hqJYyNDwRmDHNXQ1kHgpmhXHs1i9+7f1khhaswITHSYiASNgncoZkYUsWdKgqkDxXakV67N1w5LaSolFclEvogBp8WO5n6aM2XGsFExbFBnzDAA4mLUYcKM5YNu4Jj50tFEmheoYxJzgplygCBfJ1R7ZFFVqlcZqErpDDsTKUoF1JYVSJHuyeckRZSePxSG49aDMjXKEXIciyVGCwEGxYDEcgbOxFNc8/CoXI2YODvp/0z/tmGYKNqUsHowwCkGlueCY9Oz8EEwLKiOYeRo9IR6EXTSHHW77O5zFlCS/yoqqowWcxo73Ng84sN99eBfRLovfMXTqOQ6Xm44fS9XIbqHj9jRpxlz7VCJgW61l6jYizhBD2f91WVVYFicNbvN3uOf4bkhor4VWkwtqoJVoUlGv6Te3B1fqKsCTFgBqq2T9bNrATrDlRYqSjLMcDD/vQ/SHB+s+8yZa2jNnPfSdye5Jz8wMn5aFVNufPmG+pn0Lz8oet2ZAm9VQUE9FP0EM3sYNRIETCrvaF5HKrnlXmL/HjPM4fUhGetaGc0pCENR3FM8+w7FlIk9mJISqTc8XxPRRxHNuViIHrT016a+T2djurM4lE9V6E1uhf05xn11gXfWRd8b7G/gRrBrnNg++hgiKVr4xZS1L4QA5ETVWHQ62ksXUdVpmsmXlnqGicauXvAlXe6zmInHzjmn064JjUxdnJIPaTPu47crxNyzXWZymmZllVdqPSi5ZuU0TXjnLctoVrm3Hbs/GoETzgHbhzGNbVDYoSpKmpcUufD1jkPkMwkjn9EqDyOzVfUke/hIfkID3BkXTvByCtTRAwqleGxBOxOujvHDqBVfDV3tWc4Ok84f/3QFVycxo7dsoVVFlsYS2UYyFBXlfP0yxq8Vfzm9/WrbdQ3E7YDy0oJKu+mRqe1z3HXEYLh3xItJQpoEUqNEJeBW/RmbNRjgVvr1Wi5oR2128Jx3Cf2K155DCsTqy67OmaPyGWuCJwlE4BTiJZ1QktN39o9k1wiFBnXtrS8TNnCHNrW2+CVAHWI6SFltfI6dGK8RlmCceFmIaW2RTp6e/fiAm4v4OjN3c2xhNHlzW9wPey8ubuB24tkbXT9AU5+6p+86LyEcuiyXjl893y5CkxkhcnQhjgjl5VbqSxHOO32n6VuNpt1VfzcdX7Sa3VD793o4vKP68sO6zRSkKFiqwYiWNpl9Sp7QgoeGyntp/3Ts+6L7gnrVi5QqeyGP2lH3U/Fu421QTT/Xxz+rYtDO+8Iv1KvKpSxnKdYGIuWXT6J6amQ7Z2Cc7LFMOnuYQ0vB5FlWHQfzwgpBgc29XspcheITS0WjyrgR180Db/+UqOPbCnFVPnYxImMTOBnLQZjVQT8TqEc/dnuHMfwX7nC7IV8yTuWSSeyhBgIIcUT09KhK05z3yzXjQhLEj7PMqxo45hnS1mzuUwML99d3lwKKZivtinwKVJg+8AG9nq5y4bJC/7PpL1X5RXPjLc4f70ST18OKqwYOEkzZvdN0/wN/7i96A==
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete credential definition</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/{credentialDefinitionId}"}></MethodEndpoint>



Deletes a credential definition and removes its credential configurations from the OID4VCI Credential Issuer Metadata. The issuer also deletes every credential issuance history record of this credential definition. Credentials that the issuer already gave to a holder stay valid; revoke them first if you must withdraw them.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential definition that specifies the credential format, type, and claims structure for OID4VCI issuance.","in":"path","name":"credentialDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The issuer deleted the credential definition. The response body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, no credential definition matches `credentialDefinitionId`, or the issuer cannot delete the credential definition.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete issuance history
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-credential-history

---
id: config-delete-digital-wallet-open-id-credential-history
title: "Delete issuance history"
description: "Deletes a credential exchange record from the issuance history. The issuer marks the record as deleted and no longer returns it in the issuance history list. The issuer tells the issuance backend in the background, so the response does not show the result of that step."
sidebar_label: "Delete issuance history"
hide_title: true
hide_table_of_contents: true
api: eJztV0tv20YQ/iuDPdkALcqOAxRCENS13FZJkBi1Yx8CAV5zR+RG5C6zO7SsCvzvxexS1MNKeusl9cFakTuvbx7faCUU+szpmrQ1YiTGWCKhBwmZQ4WGtCwBn7NCmhzBYWadgpmzFVCBoL1vpMkQCu3JuuUAbrun6KCSbu7DtU5MelBBvQJpFBgLpTU5OnBIjTMeNIE2BxVDqT3taCcsS79791FmczRqrYO/5s42RiXgbeeIr63xCMqiB2MJfGEX61dNSWBnQIUk8IT1QCTC1ugkYzNRYiQya2Y6jxiNda5JlveyLJE+1Wgm6rKH7M/otkhELZ2skNB5Mfqy2kP7s9HfGgQdpGYaXbSPPwKfnMzm2uQgwWuTlwifJuPzu8vJtlCPSalnmC2zEjkYzTZrSYVIhJEVckS9zFVnZ6JEIhx+a7RDJUbkGkyEzwqspBitBC1rlvPktMlF2075ckTV8/uz4ZA/duPcytu6An4cZUx1n65Hq5agPWBV05IjKVCqAOmqbRNxHm1m1hAa4qOs61JnIXHpV88+rLZi2ET3RaBz1l1ahSKJ5/GW59NkHa99/IoZcT4dlwTpGO1GegONNoQ5Otb3LKu6RDE6Hw7bA+pfwLklIn6TXMl1Q9CXkGj5LzkArnW5NNqHgBmoxsyNXZiEm6yrm0pSVqCHh0Mpf0jAur6b0EEmDbdHzNZWEx8C//QnBv+zkQ0V1um/Ub2A5vVPXZcTQ+iMLMGje0IHwcweRm0iPGaN07QM4/Gi1u+Rj1MeLCRznpqiG7UQZy0chWnLM+9YJGISCpYhqZAKy2M6Vm0YvlSIkUifztI4ulMVVZ0sgqrU1mi0Sr36uqB00xhpRzvp6lCztIK95pgOzfQxVrYLWSSicaUYiYKo9qM0VVjZE1nrgc6dNDTQVrTJvoJrZ1WThU7+jpp/03BDMmeG+I64j6/3HZlucnHDJRkraZ2RviRkfNCxSUzmhk8uum4IJS72S+LiegJzXAL3DKMaOyEO+ydZNrjmv4cdPQ8QzUDVeIJHhNrhTD+jgoWmAh6ij/AAR8Z204qc1GXAoJYZHieAg3ywp3YEneCbpW0cw3Eyx+Xbh4HgutRmZtfdK7PQvVhJzUD6pq6to1834PXx6z82j3ZR307YHiy9ENTOPmkV9y/LDUcImj8rNBSne4dQ7AGYWQd36PRMy8cSYbOBeJisd4CjbkE4DmvXYcFrh7430TfY9TF7RDazpecsaQ+cQjQs4zvWiWB6IBvJI4HClioJxp7YwhK6rtsifA+ND+khaZR0yp+EeLU0BLPSLnxMbYd08Pb+1SXcXcLRu/vb4wQmV7e/w8345N39LdxdRmuTm09w+svw9NXJa6jGNkur8YftJWNmXSXJM4eVOkPjw3hcV24tswLhbDB8kbrFYjGQ4fXAujztZH36YXJ59fHm6oRl2kSQpnKnBgJYymZNnz2RCB4bMe1nw7PzwavBKcvW1lMlzZY/cct8sQnv99QWvfy/vO8t793EInymtC6lNox0SO2qo4Yv4ulMJN1ez9Du0EPc/41mZg8UwVd7ZJnK+pyMDi7S00QU1hPbWa0epcfPrmxbfvytQRd4LhFP0oUejFyiPZ+VGM1k6fEHyT76q9sWjuE//hlxENY1OxhGI8xyMRIiEXMmj8M/M9ppu94GQuzx6kWWYU1bSl7sTO0214+vPlzdXolEMKfs0tQ80FR3YAMHfdxnrOgF/2diPSjyhvv6PS7f9tfjm+8K9CwZbzNi07Zt/wFo1GxQ
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete issuance history</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/history/{credentialExchangeId}"}></MethodEndpoint>



Deletes a credential exchange record from the issuance history. The issuer marks the record as deleted and no longer returns it in the issuance history list. The issuer tells the issuance backend in the background, so the response does not show the result of that step.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential exchange record tracking a single OID4VCI credential issuance lifecycle.","in":"path","name":"credentialExchangeId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The issuer deleted the credential exchange record. The response body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, no record matches `credentialExchangeId`, or the issuer cannot delete the record.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-credential

---
id: config-delete-digital-wallet-open-id-credential
title: "Delete credential"
description: "Deletes a credential from the holder's wallet. The wallet marks the credential record as deleted, no longer returns it in the credential list, and no longer uses it for presentations. The wallet tells the issuance backend in the background, so the response does not show the result of that step."
sidebar_label: "Delete credential"
hide_title: true
hide_table_of_contents: true
api: eJztV99v2zYQ/lcOfFkCyD+SZsBgFMUyO9vcFmuwpMlDYSC0eLZYS6RKnuy4hv734UjZlh1328PeujzEtMQ7Hr/v7r7zRij0qdMlaWvEQIwwR0IPElKHCg1pmcPM2QIoQ8hsrtD94GEl8xypC/cZNmsopFv4sKtl6TC1ToH0oIJjlYCxkFszRwcOqXLGgybQ5tgy154SkEa1DCqPYffMOigdejQkOW5/EAhhnsdAtPeVNCnCVKYLNGp7DH+dO1sZlYC34ZFDX1rjEZRFD8YS+Myutq+qnMDOgDJJ4AnLrkiELdGF08dKDERqzUzPI3ojPdck88cQzocSzVgNdxcTiSilkwUSOi8GnzZHBHw0+kuFoMP2mUbHBx+w4ck63N3lmBKRCM1+SkmZSISRBXJ4O/OxEolw+KXSDpUYkKswET7NsJBisBG0Lnm/J6fNXNT1hDdHaDy/v+xf8cdhzC3wG5qP2Iz87DDOJEMMU6vWHG+GUgUwNnWdiKt+n09IrSE0xEtZlrlOA9a9z55P3LQi3t/lk0DnrBtahSKJ61ErzkmyvZ2dfsaUmAnHLJKOd9tb74HQhnCOjv09y6LMUQyu+v36hPsX4LVMxC+SCSsrgh35oua/5ASU1s2l0T5cGHTMxqXMtQLrjstkPOIdlVkYuzJd+D1kA+xy04N0CDL3NniRS6lzOc0xlJAEL42a2ueDE08xcvEdM/LRyIoy6/RXVC+g+fG7TtaxIXSGWxK6JToIxxxhVCfCY1o5TevQ7a5L/Q55OeHeQnLOTVA0LRNiz4Sz0DVHVw/Dc5GImNQMSYGUWW63sc2EXkqZGIje8rIXW3BPRVed2JB6tkSjVc+rzyvq7Qunt2m3xFpwlHyHUy15hIVtrigSUblcDERGVPpBr6ewsB1Z6q6eO2moq62ok2MHt86qKg3l/A03/+ThjuRcm/m3zH18fRzIZI/9HadgzJwtA7sUkPFBIxyRvL10XDfZH1JaHKfA9e0YFrgGrhFGM2Z+7PdLmVcYdRPh6cDPE8RjoKg8wRRZzmf6GRWsNGXwFGOEJzgzljA4ICd1HjAoZYrnCWB33j1yO4DG8PXaVo7h6Cxw/eapKzgPtZnZbbXKNFQrFlIzkL4qS+vo5z14u/vr3/aPDlFvE3YEy84ISmeXWsWJynKBEYLmz2I7vWwRijkfOvMDOj3ToVHvJwcP4+08c/YhFMf4PAxIpw1vWwPSvqBuzzkisqnNw9SkPTCFaNjGN0LwtdEOsmGEwiRMGXEaW/IJa2iqrCVFHiof6CFplHTKd8J9tTQEs9yufKS2QTpE+/hqCA9DOHv7eH+ewPjm/le4G3XePt7DwzCeNr77ABc/9S9edX6EYmTTXjF6fzCZWldI8qxZuU7R+NAOt5lbyjRDuOz2X1C3Wq26MrzuWjfvNba+9348vPnj7qbDNnUiSFN+kAMBLGXTaseeSAS3jUj7Zf/yqvuqe8G2pfVUSNOKJ06HrfCPq6klJP8P4v96EG+6GOEz9cpcasPoB7o3jTx8EstLkTQzOoN+IBFxljea1T3IBG9tczQ4mJ4nicisJ/a62Uylx48ur2t+/KVCF5QtEUvpQhVGNdGe10oMZjL3+Dekn/3ZzAfn8B/8DjgJzLbnG274oUOLgRCJWLAkHP5OqCf1VsvDPeKW6zTFklrGLyaeuq3Uo5v3N/c3IhGsEIeiswii0yz4gJOxHetPjIL/s0yeNHnNVfoO12922+ObbxrsNC/uZqQmdV3/Bb/rRRw=
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete credential</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/{credentialId}"}></MethodEndpoint>



Deletes a credential from the holder's wallet. The wallet marks the credential record as deleted, no longer returns it in the credential list, and no longer uses it for presentations. The wallet tells the issuance backend in the background, so the response does not show the result of that step.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a credential stored in the holder's wallet.","in":"path","name":"credentialId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The wallet deleted the credential. The response has no body.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid or the credential ID is unknown. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete notification
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-notification

---
id: config-delete-digital-wallet-open-id-notification
title: "Delete notification"
description: "Deletes a wallet notification. When the notification has the type `credential_acked` and the related credential is still in the state `credential_acked`, the wallet also deletes that credential. The wallet keeps no response body."
sidebar_label: "Delete notification"
hide_title: true
hide_table_of_contents: true
api: eJzlVkuP2zYQ/iuDOe0C8mt38xKCoFt72zoJkkX3dQiMmhZHFmOJVEjKjmvovxckZVv2Ou2pp+xhTYic1zcz38wGOZlEi9IKJTHGEeVkyQCDFctzsiCVFalImLvvwlNGEmxGB58hY8Z/tOuSYJpo4iStYPlfLFkQnwKT3N9rypklDvsXIAwYK/IcRNBrLLOndET+tvGJ5UYBbzy1GbMtjV243z9cEJUGpAJNplTSEMwUX3cxQlWS9s6POcaYKJmKeYh9JObCsvzJa/hckhzzT61gMcKSaVaQJW0w/rI5AvBBim8VgfDupII0qBSYhM/j0dXjcNyOPRcpJeskpyOQXQBLllcERWUszAgYPDyMR85v4WyUzGYYoWQFYYxt4THHCDV9q4QmjrHVFUVokowKhvEGXYIwRmO1kHOMMFW6YBZjrCrBsY6QvrOizN2bl7zPBukldS5mr5LOVfKadd6kg0Hnks1eJC/5K3qdvsF64qwFaI0zcNG/cj+HkLQSEpLGn5WQCy0jxj2mm7qO8Krfd5oSJS1J646sLPPmee+rcZo3rdD2QX9B0lrpoeKEUTiPWv5Moi0MavaVEusSql05WBFi2EvvERPS0pw0thC66vfrE+pPoLwH9VfGQciysrCrIazdX3QCsoMWG49cq1RyIdXqJFqDnxitB8kqmykt/ib+DJoXP3UhjaUlLVkOhvSSNHgzRxjVERpKKi3s2hPadSk+kDtOXH9bNnc8hw0vQiBGOPPU6DjtHCP8Q+WctIOkIJspx6mh1T1d2gxj7C0veoFnezyo6gRS6KmSpOC9dr33NoesVqPz0UVwinNHVKgmQIyw0jnGmFlbmrjX41SoDitFV8w1k7YrFNbRsYJbrXiV+Eb7gZr/0nBn2VzI+Y/ETbg+dmSyR/7OFWComy3+uwJg4UPD/iF1e/6/bmp/O54OHbu+HcOC1uA6xM2d50NGpZ6Opwd6phDM7EZQqSkV34nDStgMpsFHmMKZVJbC9NdM5B6DkiV0HgF1590jtTE0gm/XqtIOjs6C1u+mXXRVKGSqtr3KEt+rVDDhgDRVWSptf9mDt4tf/L7/dIh6O2FHsOyEoNRqKbhfeRLl2ssSCPdbkLSBfBuEQsVDqjQ8khapYLOcYLgb6AbGxlRMJgRnzbg/97vPacFbTWZnYtdOt+fOI6sSlRuXJWHApZCkkzGg9JzJBkwDVoEwpqIIMpXzyBtbOgtraHqstW8YqIxPj2WSM81Nx8crmLSQ5mplQmobpL23T5dDeBzC2fun+/MIxjf3v8HdqPP+6R4eh8Ha+O4zDF73B5edF1CMVNIrRh/bO07YMIybWLlISBpPhtvKLVmSEVx0+89St1qtusxfd5We9xpZ0/s4Ht58urvpOJk6QitsflADHiyukmqXPYzQ0UZI+0X/4qp72R042VIZWzDZ8icsgAeD97ifWoPkp9mVGxay9N32ypwJ6dDz6do05P4FlxcYNWu0g+yA4MO6LYWbzUfYxkfL6yTCTBnrNG42M2boQed17T5/q0j7mRThkmnfQWESCOPOHOOU5Yb+JV1nfzaT/Rz+5yX9JGBbLpeOyL0kxogRLhzVHy/x9aTezmgfZXh0nSRU2pb4s02mbk/g0c3Hm/sbjNBx/+E4Wfhx0hycgZPeHU+W4IX77wbgSZG3rv8+0Prd7nm4+aHAbpqF1w6rSV3X/wBbXBFT
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete notification</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/notification/{notificationId}"}></MethodEndpoint>



Deletes a wallet notification. When the notification has the type `credential_acked` and the related credential is still in the state `credential_acked`, the wallet also deletes that credential. The wallet keeps no response body.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of an OID4VCI credential lifecycle notification. The value must be a UUID.","in":"path","name":"notificationId","required":true,"schema":{"type":"string","format":"uuid"},"example":"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The wallet deleted the notification.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The notification ID is unknown.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete presentation definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-presentation-definition

---
id: config-delete-digital-wallet-open-id-presentation-definition
title: "Delete presentation definition"
description: "Deletes a presentation definition."
sidebar_label: "Delete presentation definition"
hide_title: true
hide_table_of_contents: true
api: eJzlV21v2zYQ/isHfkoAWnLSFBiMolhmZ5vbYgkWN8HQGggjni02EqmSlB3P0H8fjpRfY2dfh9UfbFriHe+ee3mOSybRZVZVXhnNemyABXp0IKCy6FB7QS9A4kRpRcvkq/6q/zI1ZEJr40EGgeP7wefCg9CAzx61oye1Q8dBaAmLA3rcwnksoRRaTFEeNQOGGh6NzyETDh34HMGhnaEFod0crYO58jn8PhrdwEW3m3zVjDNToQ2ahpL1WGb0RE2jxwM1VV4U96Io0F9XqIfyZuvkwfpgxlklrCjRo3Ws92W5B+Bnrb7XCEqi9mqi0IKZBOtexcdVmNHu6EhmMYiLIqCUFUKVDix+r5XFErV3MDEWgpmDi7sbmKFVE5UF3QnjTJEllfA540yLEunfQW+GknHWKpas522NnLksx1Kw3pL5RUWyzlulp6xpxrTZVUY7dPT+vHtBP7sIjDahiEGVr/mfAO1faYVcONAGHo1ckCM5ChlwXjYNZxfdLh2XGe1Re1qKqipav9Nvjo5fbpm/cewLQ2uN7RuJjMf1YMvoMV+5ah6/YeYpyJaSxavo6EZ6g4rSHqdoSd+zKKsCWe+i220OqH+B5JYI+0VIULqqPazzijX04QdwNXYqtHIRROWg1k/azDUPCMuYwzAPSQwSq8IsKF1oJ9WYRWeKGUpOEB/LR4pAqKaasEUJD8dS54G/rOvXQs1frQPl9kqfg7GH/LI4qV2bVDHBDmXK2Q+cKZ+1qH1urPob5Qto3v7QRTTUHq0WxapDhWP2MGo4c5jVVvlFaPCXlfqItBxTA/RiSn2ftYwBkTLgZNWN+6eMs7vQkNESKCX63BDfxGQNBOJz1mPp7DyNHJS2Kd6JKZ6aCrWSqZPf5j7dLpjOpmDS5bG6bBg5QO4dIqgBlqb1nnFW24L1WO595XppKrE0HVGpRE2t0D5RhjV8X8GNNbLOQs0eUfNvGm69mCo9PSbu4ut9Q8absNxSdsakWgVnnR0iPmhJMMZ1Q4OXbWGIlst3Dbu8GcITLoDKhwi4ZdRAUTNR1Lgi84cdPQ8Qj4Gydh4eQ4+bqGeUcQZ5iDbCA5xo4zEo8FaoImBQiQxPOWAyTfbU9qAVfLcwtSU4Ok+4eP+QMEpRpSdmVcgiC4WMpVAEJLVuY/3PG/DW/qvfNo92Ud8O2B4sayGorJkpGebDzFDteQRFv+W6pbcIxXIIc0osBvFYIPTXk42DoXO10BnCyXWom+FpmHYOC24PY5tauzkli7zJTOEoSsoBhRA1ybiWLSOYDrwB5VyNHHJTyDiAhsFpsWaYbMu82oXweKGlsNJ1gr9KaA+Twszb8bJFOlh7/6YPd304+XA/OuUwvBr9CreDzof7Edz142nD22s4+6l79qbzFsqBydJy8Gl72JsYWwrviM4KlaF2oVOuMrcSWY5wnnRfhG4+nycivE6MnaatrEs/DftXf9xedUim4cwrX+zkQABLmqxeR49xRm0jhv28e36RvEnOSLYyzpdCb9kT5+ZjdL5fWluE8z+/Y7RtyOOzT6tCKE3whXgt28b/hc3OGW+vHwTUTvOP1xStiLkDAQQePUgBjLPe0bl+zFlunKfjlstH4fCzLZqGHn+v0QY642wmbKivyBPK0Vqy3kQUDl+J4Mmf7VBwCv+J+85BzFd8oIkMQvdmPcY4eyK6OH4fasbNahwIqMTtl1mGld9S9GJoarapfnD16Wp0xTgjJtklp6dATu2CDjho5z5PRSvom+j0oMg7quaPuHi/3h7fHBVYc2PcTaiNm6b5B8+OrCc=
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete presentation definition</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/sdjwt/presentation-definition/{presentationDefinitionId}"}></MethodEndpoint>



Deletes a presentation definition.

You cannot delete a presentation definition that an extension uses, and you cannot delete a system managed presentation definition. In both cases the server answers with HTTP 400.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the presentation definition that specifies the credential and claims requirements for OpenID4VP verification.","in":"path","name":"presentationDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The server deleted the presentation definition. The response has no body.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the digital wallet deployment is not resolved, no presentation definition has the supplied `presentationDefinitionId`, an extension uses the presentation definition, the presentation definition is system managed, or the digital wallet refused the delete.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete trust authority
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-trust-authority

---
id: config-delete-digital-wallet-open-id-trust-authority
title: "Delete trust authority"
description: "Deletes one trust authority of the organisation. Give the trust authority ID in the path. The ID must be a UUID, so this operation does not delete the two built-in trust lists. After deletion, the service no longer uses this trust list to validate issuers and verifiers."
sidebar_label: "Delete trust authority"
hide_title: true
hide_table_of_contents: true
api: eJztV1lvGzcQ/iuDebKB1Wm7SYQgqCu5gZKgMerrIRAgajnSMl6RG5IrRxH2vxdDrk7LbV+L1A8WweUc/Ob4hiuU5FKrCq+Mxh4OKCdPDowm8LZ0HkTpM2OVX4KZgs8IjJ0JrZxgiSa8VwsK24enhwNQOnwphM+acJsR78351IRAwN3dcJCAM+Az5cAUZINKkIYcaONBBl+i8icDk1LlvsE6g6VcOe+acDn1ZONRZXQSTjuyC5USaAO50TOyUDpy0c5WGLyBhciVFJ5AOVeSdSC0hAVZNVVkXRMT3Pg1lNjD1OipmkWQBmqmvMgfRJ6T/1yQHspbVn65hgATLIQVc/JkHfa+rA6wvtPqW0mgJGkfDDLC4t/BzmguRF7ScUB3tToYt8fhYuPOeK3tJUBBWArgB2QgI0uMgmJ/OY6YoBZzwh76vbsOJSZo6VupLEnseVtSgi7NaC6wt0K/LFjGeav0DBOcGjsXHntYlkpilSB9F/Mi5zOTV7IzPRfdxuv0jBrn4k2n8WZ60W205Vn6C70Sncn5BVYjtuYKox05NtBtt/lnH+DbnVyIySSPpWpEc60OMsHpBxMjl3z1jIQM8VtVVYLn0U5qtCfteSmKIldpCEvrq2O7q52LbyH5gmStsX0jCZO4Hux4O0rWIJnJV0o9J4/l5PMq3nArvcVTaU8zsriD33m7XR1RfyQGW8h/ExKULkoPm3zFiv+SI4Du5mEocrfNl1h+T6Ei1h8sOZMvSCZg7LNEXoN9mPNPymexXoeDY0Ho/MRBuNM1Tj9IPoPm4qfOz6H2ZLXIQ9WThWDmAKMqQUdpGRo09+TLQn0kXo64qXgx41aNdXOH2N3hJPT3wfl9/xQTDG0eLnWaGcvAzMlnhukhNpnQ932GPWwtuq1IGS0ZFTZicbRMQVrJVsj7xibvW6vDrlohu8uXOcYgA5qb+q6YYGlz7GHmfeF6rZakuWmIQjXVzArtm8pglRwquLZGlmmoxBfU/JOGGy9mSs9eEnfx86Ejo20QbjgXYwqtQ7HJBRE3av6JUdwyUA3Tj5DbeJgLl9dDeKRlaCpMhekz5qypcLynZwzRzIZXC0tT9Z1k7Enj6COM4USb9XBihcoDBoVI6TQBas6aB2p7UAu+XZrSMhyNR1q+GzeRE1LpqVmXrUhD2dJcKAbSlUVhrP91C97m/ur9dmsf9d2AHcCyEYLCmoWS5EBAarjSeAzi3zlpH7tzjVBMfpgaC/dhNhKTnKBvKcwYIncwdK4UOiU4+RyqZHgaBo7jgteW3MbEprKuT9kjb1KTO46ScsAhJM0yrmaNCKbj0S1MbAlkJpfJdmxbQl1okO64V7oQHi+0FFa6RrivEtrDNDdPLoa2Rjp4+3DWh/s+nHx4uD1NYHh1+zvcDBofHm7hvh+tDW8+Q+d1u3PWuID5wKSt+eDTjk2IE04YIXOVknahL64ztxBpRtBttp+F7unpqSnC56axs1Yt61qfhv2rP26uGixTJeiVz/dyIIAlTVpuoocJctuIYe+2u+fNs2aHZQvj/FzoHX8G9aS9z8KHJbVDK/+/Ew7fCXXH8vTdt4pcKM1Ih9Cuajb4gosuJvUTgrHdY4T41NCKKf2AFTAJA/X+tD1KMDPOs9rVaiIc3dm8qnj7W0k28FmCC2FDyUXqUI7XEntTkTv6m+Ce/FlPBafwH3qjHI3Amkg0oxicwR5igo/MM8/fMNWoWk8LAbN47DJNqfA7Cp7NVNXuFDC4+nR1e4UJMj77bPYY2KxesIGj/h0SW/SC/zP/HhV5y+X/kZbvNsfjlxcFNmQaTzNao6qq/gJlCZgj
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete trust authority</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/trust-authority/{trustAuthorityId}"}></MethodEndpoint>



Deletes one trust authority of the organisation. Give the trust authority ID in the path. The ID must be a UUID, so this operation does not delete the two built-in trust lists. After deletion, the service no longer uses this trust list to validate issuers and verifiers.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a trust authority of the organisation. The value must be a UUID, so the identifiers `0` and `1` of the two built-in trust lists are not valid here.","in":"path","name":"trustAuthorityId","required":true,"schema":{"type":"string","format":"uuid"},"example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service deleted the trust authority. The response has no body.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation ID is not valid, the wallet is not resolved, or the organisation has no trust authority with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete verification history
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-verification-history

---
id: config-delete-digital-wallet-open-id-verification-history
title: "Delete verification history"
description: "Deletes a verification exchange record."
sidebar_label: "Delete verification history"
hide_title: true
hide_table_of_contents: true
api: eJztV99v2zYQ/lcOfEoA+kecFGuNolgWZ5vXYg2WNHloA5gWzxYbiVTJkx3X0P8+kJRl2XHaPRbo/GDLIu94/L47fsc1k+gSqwpSRrMhG2GGhA4ELNCqmUqEHwB8TFKh5wgWE2Nl95P+pG9SBId2gRZyYR8cULoZB+FABk8ShPZ/62Gp5opEBkuRZUggscjMKkdNQKa2AEUOElOsunATHLrCaIeQCgfawNTIVbN8phyBKdCGKB1kKBYIpiQQzfoxIg7TkuoIhWzbOFJZBhaptBoUxVXrfUmDflGCpVAEM2O/vQkOzoAAVyYJOjcrMxDaLdt+CmsWCJSKGEvjIYba7PyTZpw1MY4lG7LE6JmaR3pGMYC7YP2+QD2Wty22/lSOjF0xzgphRY6E1rHhx/Ue1R+0+lIiKIma1EyhBTMLUX2TebhJlQMV6ZwUFh1qClMv65ljOfH7LNDSauNyQ4LHwO9yolqTuowz5SMqBKWMMy1y9P8O+macWfxSKouSDcmWyJlLUswFG64ZrQpv6cgqPWcVZ/go8iLz717iq6QvXp11Tqe/yM7ZbJB0XsmTk85g9kL0pyfJS3mKrLr33mPCOe9w0O/7n13g2glSM/dfYHsmlxlnKQoZOFpXFWdncc3EaEJN/lEURVY77n12PoZ1a9NbOD4ytNbYCyOR8fg8akV+zzcAmelnTMgnSKRAxd1urbdYKk04R8taWJ71+9UB90/wb8P/m5CgdFESNDnJKv/hB8A1di60chFJ5aDUD9osNf/OEaJijVl0JltgyLZvkhJo8C5d6QFG+Ww+czhc+hZnpavpj6lwiM6Tn5jOD1qUlBqrvqJ8As2LnzrTx5rQapFtzpKwzB5GFWcOk9IqWoUT/LxQb9E/3vujisTcH+ys1gOIggBHQRJGZ7cXx4yzqAxoPSg5Umq8msRkDQpBKRuy3mLQiwrTq1O8E1O8ZwrUSvac/LykXruaemmUmd76cNFUzMfud3ZIfEaYm3rjjLPSZmzIUqLCDXs9ibnpiEJ11dwKTV1lWMX3HVxZI8sklPUzbr7n4ZrEXOn5c+YuDu8Hcr9l5NonZsynDS9NYoj4oha2SOlW2s7rmgiQsf3EOL8awwOuwFeO1+aId5SQhchK3KjqZMfPBOIykJeOYIpQWJypR5SwVJTCJMYIEzjShjA4ICtUFjAoRILHHLA77+65HUJt+HplSuvh6Dzg6s2ky3x2Kj0zmxoWSahhzIXyQPpT1Vj6dQtes3/1x/bVLuptwvZgaYxCF6Vk6FIT48vOd43+N9+k4QahWAmhc4t1IKYZwoXF0PSIzMHYuVLoBOHofSiZ8XHoWA8bXrUyfVtmV8c+IjKJyVzdH3kKUXsbV6vZ17rdJAPKuRI5pCaTPCwWymrViEvSCq90gR4SWgorXSfsVwlNMMvM0kVqa6RDtHenF3B7AUd/3d0ccxhf3vwO16POX3c3cHsRVxtfv4eTl/2T084LyEcm6eWjd601vZdckPNKlqkEtQuH5CZzC5GkCINu/wl1y+WyK8Jw19h5r7Z1vXfji8u/ry873qbijBRlOzkQwJImKRv2GGf+2Ii0D/qDs+5p98TbFsZRLnQrntgQ78p82vS/cvfQboTm/2vOj3PNqQ9MwkfqFZlQ2hMdMmtdq9NHthgwXt+APKs7ChVvSlr59iKoVMyehlSvqE1CDJ+5VNxzlhpHfq31eiocfrBZVfnXX0q0QXA5WwgbjoEoZ8r5Z8mGM5E5/EauHf1Tty3H8ENduQ4Cv5Ev7dEKYsOGjHH24NXtuStZdV9t2paATZx8niRYUMvNk+auarcko8t3lzeXjDMve7tK+hCUtH7wCxyMcl9UYxT+22v/QZPX/uh5i6s3zfQ48qxBI+RxtsfsvqqqfwHdHRSA
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete verification history</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/sdjwt/verification/history/{presentationExchangeId}"}></MethodEndpoint>



Deletes a verification exchange record.

The server marks the record as deleted and asks the digital wallet deployment to delete its copy. The response has no body.

The list operations leave out a deleted record, but the read operations still return it. The server does not wait for the digital wallet deployment, so a successful answer does not prove that the wallet deleted its copy.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the verification exchange record. This is the `presentationExchangeId` property of the record, not its `id` property.","in":"path","name":"presentationExchangeId","required":true,"schema":{"type":"string"},"example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server deleted the verification exchange record. The response has no body.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the digital wallet deployment is not resolved, no verification exchange record has the supplied `presentationExchangeId`, or the digital wallet refused the delete.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete verification
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-verification

---
id: config-delete-digital-wallet-open-id-verification
title: "Delete verification"
description: "Deletes a presentation record from the wallet of the holder. The response has no body."
sidebar_label: "Delete verification"
hide_title: true
hide_table_of_contents: true
api: eJztV1tv2zYU/isHfEoA+RLHXVujKJbF2ea2WIPl9tAGMC0eW2wkUiEpO66h/z4cUpJlx+leB3R5iCWR58KPH893uGECbWxk7qRWbMTGmKJDCxxygxaV4zQABmNtBMyNzsAlCCuepuhAz/1bolOBpgvXCYJBm2tlERJuQWmYabHuflVfFQ1aNEs0kHHzYL1l5ZdbED6wAK7otRoWciEdT+twAvNUrzNUDpyuLEA6C7HO1yF8Kq0DnaPxeVtIkS8RdOGANyFC0DC/ykhopGwdrLh0MNfmx+EjsBo42CKO0dp5kQJXdtX2kxu9RHAJd2286gyanCtgDIL0aN2ewhKNJcg9ttJuF9OFG0vLBZ5a7XPkNX4+zloXkHGBsJIu8VFvT2kCSkKg8fJVsYg1rxPBRizWai4XYevHYc13PuHPOaqJuEUj5zL281nEcm54hg6NZaMvmz3+3Cj5WCBIgcrJuURTc+QQnaT6IZmkJVTo27RtPRFTgjdH49a1UXAYeegJ3KlsTeqyiElKLucuYRFTPEN62/HJImbwsZAGBRs5U2DEbJxgxtlow9w6JwvrjFQLVkYMn3iWp/TtdD7gr+OTN523syF2hqLPO2/iX+adE3w1G/C3Yhi/PmXlPXkPB8OSw0F/SD+72F0/J8oLyNGKEuTC78GmLCM27PfJYayVQ+Xoked5Wm1a75ulAJvWirZr/cLQGG3OtUAWhedxK637qF69nn3D2BEBAq4yLGVrvQVKKocLNKwF1LDfLw+4fwZuG9vfOHEkLxw0nGMl/UUHkNuBaTIm6hTqQemViqA6z9osuJK2QrJQlhhouRIz/QSZFtiFPz372hWEG/S04ksuUz5LkWpPbdT2aA/tyslPvCs3ihcu0UZ+R/EMmlc/NWEnyqFRPK31x4fZw6iMmMW4MNKtfaE9y+VHpMd7KieOL6j+sqpeQyjYcORL9nh4e37MIhbYTJBk6BJNtT5UFl/GXcJGrLcc9EL971Vy1wk1qKdzVFL0rPi2cr1lSwN6m93SWTLKlNZxSBHGmOlqmSxihUnZiCXO5XbU6wnMdIfnsisXhivXlZqV0b6DS6NFEfsz+4Kbf/Nw5fhCqsVL5jYM7ydyv8X/imgY2FPvQkMDHj5UEhM2cCsyZ9UJqMVzN7Gzywk84BronJBgxpXQUz1b8rTAWt+mO36mEMJAVlgHM1/75vIJRZD+acgRpnCktEPvwBkuU49BzmM8jgC7i+6e2xFUhu/WujAER+cB1++nXUZclGqu6xPLY39iMeOSgLRFnmvjft2C16xf/rH9tIt6e8P2YGmMfBslhe9HY02HjBo++s2aUl8hFHjv26LQr/hSfW7QdyI8tTCxtuAqRjj67A/I5Ng3m4cNL9tq0hyqy2PKyOlYp7bqUGgLUZGNrdTgeyUcToO0tsDItzSRD+aP0bppLONWeoX12+O4EtwI2/HrlVw5mKd6ZcPWVkj7bO9Oz+H2HI4+3F0fRzC5uP4drsadD3fXcHseok2uPsPJm/7JaecVZGMd97Lxp1ZM8pJx53UrlTEq60tizdycxwnCoNt/tnWr1arL/XBXm0WvsrW9T5Pzi7+uLjpkU0bMSZfucMCDJXRcNLvHIlb1u2zEBv3BsHvaPSHbXFuXcdXKJ7SnsNxtRsVuaW7k5P+LzM9xkamKsMMn18tTLhWRx7N1UyncF7YcsKi64xBjdlQu3IWUpAbFK11gZJtio72Lwn3EEm0ded5sZtzijUnLkj4/Fmi8QEdsyY0vJEEQpaVnwUZznlr8AWuP/q7anGP4r96kDiJea6EiIfTKxUaMReyBpHL/plXel3Wn4+EJk87iGHPXMn/WD5btPmZ88eni+oJFjLRzV44fvBxXDxTgYHb7yhyyoP/UQBw0eUf16yOu3zfTw8iLBk03EGYTVvdlWf4DzU0e7w==
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete verification</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/sdjwt/verification/{presentationId}"}></MethodEndpoint>



Deletes a presentation record from the wallet of the holder. The response has no body.

The server marks the record as deleted and asks the digital wallet deployment to delete its copy. The list operations leave out a deleted record. The server does not wait for the digital wallet deployment, so a successful answer does not prove that the wallet deleted its copy.

There is no V3 version of this operation. Use it also for a record that you made with the V3 receive operation.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the presentation record in the wallet of the holder. This is the `presentationId` property of the record, not its `id` property.","in":"path","name":"presentationId","required":true,"schema":{"type":"string"},"example":"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The wallet deleted the presentation record.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The presentation ID is unknown, or the organisation runs in sandbox mode. Holder operations are not available to sandbox organisations.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete wallet unit
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-wallet-unit

---
id: config-delete-digital-wallet-open-id-wallet-unit
title: "Delete wallet unit"
description: "Deletes one wallet unit that the wallet provider manages. The organisation must have the wallet provider capability enabled. The response body is empty."
sidebar_label: "Delete wallet unit"
hide_title: true
hide_table_of_contents: true
api: eJzlVktv2zgQ/iuDOSWA/EiaAguhKDZrZxdui02weR0KA6HFscVGIlWSsuM19N8XQ8rPONvLHhaoDzYtcV7fzHwzK5TkMqsqr4zGFIdUkCcHRhMsRFGQh1orDz4X/LV5WFkzV5IslEKLGbku3OUExs6EVk6wMihr5yEXczoql4lKTFSh/BJIi0lBMqqw5CqjHcHEyCUoB1RWftnFBE1FNmgeSUwxM3qqZtHdoZopL4rHYOK6Ij2S8XyvlccEK2FFSZ6sw/Tr6iDie62+1wRKkvZqqsiCmYLYC97STDlv27BCwBImyxBXNAQ3bVzsqGK1lfA5JqhFSZjiYuPOSGKClr7XypLE1NuaEnRZTqXAdIV+WfF9563SM2yaMV+OiDh+f97v889+CHdH8JUBGbmLPcfyI5BzEjLgtGqaBC+itcxoT9rzUVRVobKARO+bY+urHe+3cX1FstbYgZGESTwPd3weJ+tIzeQbZSFJlhPsVYxzK70FRWlPM7Ks70WUVUGYXvT7zRH1r4DcEcHfhASlq9rDpi6w4U/yNqyhDKQhB9p4oBflfALGBnT3il7FG+IwH8ewPfuJsb3Xova5sepvkq+gef9Tl91Ie7JaFODIzslCMHOAUZOgo6y2yi8DpV1W6jPxccyM4cWMmQ5bXlxz1EmgxuHFw+AUEzwgLsamJJ8bJtdIHoE5fY4p9ubnvUi4PRl1dmJ990xFWsle/NdZV/v6P7dNb7VLfg2y5xzXMS4eUmnasDHB2haYYu595dJeT1JpOqJSXTWzQvuuMtgkhwpurJF1FjrxDTU/0nDrxUzp2VviLr4+dGS8zcctl2WspnVWNmUh4oN2RMSEbofEZdsRoczxsCwub0bwTEvgvuFRFbsh8vlcFDXx3GI+etrT8wTRTBzHE4LK0lS9kISF8jk8RR/hCU608XFUeytUETCoREanCVB31j1Qm0Ir+GFpastwdJ5p+fGpi1ybSk/NuoNFFjqYSqEYSFdXlbH+1y14m/jVH9tH+6jvJuwAlo3QmmodCMgMN50nUPxbkvaRnVuEYh/A1Fh4IKumivcPGFgKO4AoHIycq4XOCE6uQ8OMTkFo+YbgjSW3MbFpsptT9sibzBRhO1IOOIVx2XHt1IhgOvAGlHM1JZCbQibB2JwtLKFtOMh23KtdSI8XWgorXSfEq4T2MC3MwsXUtkgHbx/fDeBhACefHu9OExhd3f0Ot8POp8c7eBhEa6Pbazj7pX/2rvMeyqHJeuXwy45N1lIK73iOFSoj7QJFriu3EllOcN7tv0rdYrHoivC6a+ys18q63pfR4OrP26sOyzQJeuWLvRoIYEmT1ZvsYYJMGzHt5/3zi+677hnLVsb5Uugdf+JauDu8D9tpZ7r8n3feljc8vfheVQilOd4A8Krl5q84P8ekXYc5yj1+jmuzVjxjDzh6+6TFJ91bUscJ5sZ5NrBaTYSje1s0DT/+XpMNoybBubChBSKVKxdiwnQqCkf/AvjJX+3APoX/fvs+CtmafzWTb2BLTBETfGZ63t/Om3GznrUhrHjlMsuo8jvCrzaSZneADq++XN1dYYLM1vsD4DkMgPbABo76djgLohf8zSPrqMgH7pjPtPy4uR7fvCmwmT/xNiM1bprmHz0z6Cc=
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete wallet unit</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/wallet-provider/wallet-unit/{walletUnitId}"}></MethodEndpoint>



Deletes one wallet unit that the wallet provider manages. The organisation must have the wallet provider capability enabled. The response body is empty.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a wallet unit registration managed by the Wallet Provider.","in":"path","name":"walletUnitId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet provider deleted the wallet unit. The response body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The wallet unit does not exist, or the organisation is not a wallet provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete sandbox organisation
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-sandbox-org

---
id: config-delete-sandbox-org
title: "Delete sandbox organisation"
description: "Deletes one sandbox organisation of the organisation. Give the sandbox organisation ID in the path. The service removes the wallet of the sandbox organisation and all the data in it."
sidebar_label: "Delete sandbox organisation"
hide_title: true
hide_table_of_contents: true
api: eJztV1tv2zYU/isHfEoMRXZSDxiMolhmZ53bYgkWN8HQGggtHktsJFIlKTueof8+HFK+RumwtwFtHmJBOjd+5/IdrplAmxhZOqkVG7AR5ujQglYIlisx00+gTcqVtJxEQM/BZXjwLoa3coH+davKeARS+c8ld1kMExJEs5AJgsFCL9D6r0ue5+g2HlpNcSWA57kXENxxMixd/Fl9Vn/pChKulHYg/CG8UMGlagzHMA6WU7nAEJU9lomC6yY4ErTw+2RyA/1ez3u5nDs0wT05kVpFwBVc3ozhEVfgMu7I7ExXSoDT4DJp24+iNORapWhgqc2jjWGi/RMdiberuMzoKs28+8ubcQQWc0zcy3A1sAtus5nmRvjjKUgM8gafTeCVEmig07lMEl0p1+nAG+h0RrjAXJdoSM52OnDS6QyDMim+x1WncxoSSkYOD94eU+RziAs0K0golUvpMpAOTKV8OgzGLGLk1MuPBRuwRKu5TENt3gaj1yZlESu54QU6NJYNPq2Pavmjkl8rBClQOTmXaL5VWuRUkhbVKIuY4gWyAbNbb2PBImbwayUNCjZwpsKI2STDgrPBmrlV6eWdkSpldT0lYVtqZdHS94ten34OI9zvhFC04uUAPcwbm5BxSyU002JFoWfIhUdhXdcR6/d65CzRyqFy9MjLMpeJN9T9Ysn5ei/43bE+MTRGm6EWyKLwPNoLeRptDqpnXzBxlAJDuXIyHHOnvcNEKocpGrL3xIsyRzbo93p1i/lnOO6psF+5AKnKysE266ymv6gF1W/2OFXgfp8fjg3p2gA9/44B/ah45TJt5N8oWqDpf8fQTI64cNOXrePYjzrPCOPR8xr76btu2rFyaBTPfVOiAe/mCKM6YhaTyki38uP+spTvkR6nNG4dT4kF2Eim0vEc7sM6cXJdohqP+nfDUxaxhj3QEioFukwTv4TO93ziMjZg3cVFN3BOt0nkmTZpd73PBjWjaCjWNu4ZYaGbo7CIVSZnA5Y5V9pBtyuw0Ge8lLFMDVculprV0bGBG6NFlfiyecHMv1m4dTyVKn1J3YbPx4FMdxjfUqmFCtkgvU01Dy8azgxJ2rHmZTMufOmy41Rvdg4aKkTNyR6/LXhe4YanHw7sPEBwA0VlHcwQSoNz+YQi9NVDiBEe4ETpZrtxhsvcY1DyBE8jwDiNj8wOoFF8vdKVITjOHnH15iFmVG9SzfWmK3niuxILLglIW5WlNu6XHXjb88u3u1eHqO8n7AiWrRKURi+kQAscEk2NRKxEvwUqd7CGh9qGuTZwh0bOJZ/lCEODfufhuYWxtRVXCcLJtW+C8amnv3bFG4N262LbODenFJHTic5pTaX5RSlERTq2GXEBTEurn7S2wggynYvAtQvysALRNGayF15lfXocV4IbYc/8eSVXDua5XtqQ2gZpH+39qyHcDeHk3f3kNILx1eQ3uB2dvbufwN0weBvfXsP5z73zV2c/QTHSSbcYfdjzSVYK7iwN4FwmqKwfe5vKLXmSIVzEvWepWy6XMfefYxoGja7tfhgPr/64vTojnTpiTrr8oAY8WEIn1TZ7LGI0NkLaL3oX/fhVfE66pbau4GovnrDzttLJcV/tUcePa9yPa9z/4hrXsIXDJ9ctcy4VVblvq3XDtZ/Y4oJFzQ2PKHXHtyxig4P71zRimbaOlNbrGbf40eR1Ta+/Vmj8IhCxBTd+mAVSlpaeBRvMeW7xGx1z8mezTp3Cf743tp5yQ5SKWNLTGhswFrFH4tHDe2U9rTeLjo86iFwmCZZuT/nZOljv7zCjqw9XkysWMaLVQ6Z+9EzdPJCD1tiOSTtEQf9pt2hVed2Uz5utePjyosJ2UQjShNS0rut/AO/wcFQ=
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete sandbox organisation</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/sandbox-org/{sandboxOrgId}"}></MethodEndpoint>



Deletes one sandbox organisation of the organisation. Give the sandbox organisation ID in the path. The service removes the wallet of the sandbox organisation and all the data in it.

You cannot delete the main wallet. If the given ID is the main wallet, the service gives HTTP 400.

After the deletion, an API key that is bound to this sandbox organisation no longer works. To work in a sandbox organisation through the API, select the sandbox organisation in the dashboard, then create the API key under **Account** > **Developer APIs** (**Create API Key**). The key is bound to the sandbox organisation, and every call with it runs there.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The service deleted the sandbox organisation. The response has no body.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The given ID is the main wallet, and the service cannot delete it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no sandbox organisation with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete webhook
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-webhook

---
id: config-delete-webhook
title: "Delete webhook"
description: "This endpoint deletes a webhook. The server disables the webhook and marks it as deleted. After the delete, the webhook sends no more events, and the other webhook endpoints do not find it. The response contains the webhook in its final state."
sidebar_label: "Delete webhook"
hide_title: true
hide_table_of_contents: true
api: eJzlWW1zG7cR/isYfLIzxxdJtuuwmUxdUc0wliuPRVt1bI0IAUsewjvgDOBIsRr+984CuDeSqpQ0n5ovNnW3Czx4drFvd08FFAY4cyDoaM4yCwkVYLmRhZNa0RGdptISUKLQUjkiIAMHljCyhttU62WfTFMgFswKDBHSstsMLHEpVAKEKUFyZpaWSEeYjUuIPnkzd2C8aHiUdNQsKGGJ0iTXBgisQDmb+MVQSrsUTC1bwbNEaKK0I3OpBJEugDNgC60sEK6VY1J14UlFpLOowTJiHXPQpwnVBRiGDEwEHVGu1Vwuxh7lVdCjCS2YYTk4MJaOvtzv0QZkMiZ63tnM6XhW3APuWF5kQEf01Wt2ND/mJ+IFvJy/Yn+5fc2/F0M4ogmVuFjBXEoTqliO0nGxiaAJNfCtlAaN50wJCbU8hZzR0T11mwKFrTNSLeg2odZt/GZW+l2316gdmLGocDwc4n9IEiiHP1lRZJJ7Gga/WjzWfWuDwiBJTgbtCMqrZdnF3FPSoPtCJcLVZuFhF2yTaSY+mowm1Y5TBJxQW94ij7cgzrzNaUKjW6GiBW7AvYUN/l7K4tJmn8DIeYRJE+pkDtaxvKDXSUWCvv0VuPMvneegMWLXam9qSwWTl8EJKjNqs2BKWv+scXzJgbBszTY2Oi2swGzIXEImgqa0JEBICNxxKByZWabErb67QEJm6A1dOqXYt+Eu2I9KfiuBSAHKybkEs+NtT/SxbWWW379hmxfiUuaIXnevWd97YOvM/8NucZn/Yo1gBs97tILKNmSuTRO3AsxbyLRaWLyXrF5XQJHpTQ7K9UnjEAY4yBXYsBbiCDEJUWEA0WtFLNcF+KO2HPzxg344D2jqLdohI67UNWbqXGFHg0F80uc6H6C0HciFYcohhPa1ehTDaRAmKLUbtNoIVJnjZd6LDEnn0V1vvV735trkvdJkoLgWIOj19sDtbpDtXdJDkWAvxnojeNg2kNhGXhGaYJQ/IQujy8KiUXOpZF7meNKj6rgnhBmDlzgvrSOpzgRhXcFmr667GZiXFpOiaokENNL6fCSV3yKT1lX+4sF01xEagriBXK+AiDJQCmTFshLsfpjgGL2Ve8cUWwB67FUThiOt/lCH7I2KJK8120x6WLbxcM5LQ9YpKDyiVEKupChZRhbhQpiagYgnwWfMLm2T8BIi9FqhH+G7shB4LJeCNEQwx/Bo0kFuH3fVy9otAr6WW/qVwtp9qaSTvq5JOs85UxyykE0i3D7LMr3uPMGUs/eQlU7fwF0hzaZaNGbzvc2qwx54EzTaMLoazZvr7RaT30I6ll2xLIMnm3cclMjaa3VNe+az08Vk/OLTaXzjbefDpffKv3pnnekClBT972bR/QgzEMI9RsD4zHs5U3G9CRr3ogCFf70nUjlYxBSqAERwLDKLZwroWhuEcIxO47fJBBgynoxPdZ6Twminuc76X9VXNW3h4wZ8imAZrhRddq7Ren4ZaW0JhlgpfGRrYYU7njK1iLe5Wi/1+z66bBDzy3b1CwPoLSEtfddfnexqI4KaogrDiMywWgLrblB7ljR/xygmZr76nbXXv2F8iS+4zoHMjc49tJWviCK45IBWAUpItXjygu2zflV/yFXdN56ez8H4w4f6++DriouDIs3PG2/0R6X8YR8XwortcbnY1xwUQzh4rW8EKPmAjNNLUHvA972xtWW04xOld077iOzuoTtu3XbV/urkEanKaA9L7rvgE2UjAygdoiVz7B0zS3BFxjg8OV4yx3yTGvWelgxdK3dzA8yFZBgSDfbIiAabYp5pWxogbGEgJFsDXBvxx2W9FvY+/n3T7HpT73oTdkWmQmaJbVWz+a3WGTC1t/sVHneGLeYsOVhhYaMeOBOQScwwoeKv27XHD+hFyRI2TR1XkRvykyacZbzMYuVAZv/qTX7Card3KReKudLAjKTARGgVgPG0QfNQf+AzD9ZnPANmiIM7X62FFq45ZeiTE2K1T0TAA8B6tMAs2eiy824JkYMDbervYHyvSPRRPnQi0/NLwrEqnIdyMVa0sXAnHz+ceyRNa/x4TzI9JSj+kKOLthf48nr2+fPnz71373rj8TRNR3k+svaXGTZdOXMP1Lkh9bUNoX2JGUu1TstzPDx+1Ru+7g2/nx4NR0dHo6PjX+h2i2OM/a6gnj3tjJjq+iN4/iy2h9JWDXxgvE/xfrSnF9V4Y2+mEG5SB8DFW5rQ4Id4sVHgxfDoN81W2luDMdqcaoHDEf973NrtwIyj2yE02o3NfVkGpk3vi+Fwe2D5A37SWOTvTBCpitKRehKGdOwT8lGx0qXayH/7hLJLzYs/MTUfwOrScAhTS10qEVy0M1FJmY+vlVOvpUu9T2P7pchk7NutzkyzmbLu8f3yN475/r/4nigHxk96w8Tab7PDUchbpZFu46eYbwrpM9iXaww2ji1w3luPEK8TmoNLNc6JA+l+vulSOqKD1fEgDBIH0TSD+3p6u/XjTERxaH48hlxHkDShJc6R6qmPgFz3WCH7YdjTl5puk90F3hstSu7954FlHlvh0rGFVIuH1G14vQvkumHvEp0o2L7isKnDwoM44A70NyPuNzFeVEPdnSnt+4mvEzCqYL3KWyPAmEZCApx11qmLAz/guQVSGJjLOxDhRs0CRjIjz5SOJYYzTGaeg4JxeJ4Q6C/6O8uOSFT8YaNLg3T0lrD5MSYRqea6um+M+/sGOZOZn28VhTbubw159fnlT82jLuttg+3QUithGbKSwpegXOMVcUD81D+vCueKodCI+tFoKFAwL5LTuhGwZBJbF/Ists3Pfdd4WPF9qzYnz+ou93ndvftqWlqCJgQVPhaFWBfI9GWe74ES33WG7jWWOnFsQHgLXmm9eRxTghlhe/68kilH5ple22DayLRHe3VySj6dkmc/X02fJ2RyNv0HuRz3fr6akk+nYbfJ5QU5ej08Oum9JPlY80E+Pm/tGUsaP43LJAdlfUCrPLdgPAVy3B/umW69XveZf93XZjGIunZwPjk9++flWQ91ts34szEnkiU0L2vr0YRi2AhmPx4ev+if9P0gv9DW5Uy18ISPVlVm2L1KrTzwJ/3QF8MR1v2DImNSIY1lGNuHKP6Fro7DEHAuMes0VI6aL3HXCU21dSh9f3/LLHw02XaLj7+VYHzySOiKGX9NQrivu69Dn13bhnn2Iabg5+QJXxUPHqgKugojrg+RdERpQpcYk1sfFLc4o4/BGEGG92/8MKCluVcxbNtZcHx2fjY9w08CJfLXDvlLH/LjD9zgILDd6B9Q4L+YpA6q/IB35C1sfqzFw5sHFeqME6SRJmyL/wMmDfkV
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete webhook</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint deletes a webhook. The server disables the webhook and marks it as deleted. After the delete, the webhook sends no more events, and the other webhook endpoints do not find it. The response contains the webhook in its final state.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to delete.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Deploy digital wallet
Source: https://docs.igrant.io/docs/openid4vc-api/config-deploy-digital-wallet-open-id

---
id: config-deploy-digital-wallet-open-id
title: "Deploy digital wallet"
description: "Deploys the OID4VC digital wallet for the organisation. The service registers the organisation with the OpenID wallet backend and returns the endpoints of the new deployment. Call this operation once, before you create a credential definition or a presentation definition. The deployment also makes the issuer, holder and verifier global configurations with their default values."
sidebar_label: "Deploy digital wallet"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v27YW/isH/JQAiuy4ydoaRXHTuN28dWtQp+2HtoBp6cjmLJEaScX1gvz3i0PSerGVNsPd7sXF9qV1JJLn7Tmv1C1L0SRalFYoycZsgmWutgbsCuHNdHL2/hJSsRSW57DheY4WMqXdW6WXXArDaWMM1ysEg/pGJAgal8JY1OZgHWyEXfmzS5TTye7MBU/WKFPgMgWNttLS70WZlkpIa0Bl7oHEDaSOxQKljeGS5znYlTCgStSehpIJRrDATGmEraog0cgtAqcfKUoreA4pZkIKv14Dh1KjQWn9Cc1LL1hDEXhuFBR8jZ5BYUyFOoKVylPUjv8b1CITqGGZqwXPIVEyE8vKM2dqDQhNZHiVW7jheYUm/iQ/yet9hRWVsbDiNwhStfnYoo1hmgFvP8QvwpCudPexxt8qNBa8lmTkON8Zi0uzIVM5vn64vr6Cs+HQia1JPCLbqNauOB1XqBs0HRoRGOV1zaVUNrxxhIKJORhMlEzBigJjFrH61GnKxsxryaNv4gH3wW10QElZxIIUL1S6ZePbPdi+cT94DgYxrSG6xi0U3KImiwcEeXZimHm8ARal3cJCpVuwCojTtnbI0u5BS52kKVV5iTCNA2tCY8rGGc8NRiSNRWmJT16WuUicoINfDTF7y0yywoLTL7stkY2ZWvyKiWURKzWpxQo09DbR29KqpeblSiQzJAL1FmO1kEsW7SmCVnkztcWoDJoHaeWaXCkTmKceLV6rXfd2h9Emh1tQMt/CZoUShHV+YEBJhGTFNU8saoJjoTRGzjuEBYMydbhytnI7CTlLcYONQcLZGnIk8BM5z5aqiE3yaO/3fiE3HmAa7RjWiCURIiOpDHK1NI52+PsGtSEwk5G0ysmA+IUXZU5qHaan2Yg/Wpwl5+l3+Dh7Mnx6ykeLR8lZeo7fZY/Z3d1da32vjR50yB3BxpRKGm/r0XB4COu22j0CnXXr8LkXmpvwGZa1UJui5SI3JO2fhE6+RGlnnruXIVB/G6AvuEF49/b1Dnk+yUwd716qs/dXtdBhUSfXdOy1srY048GAlyIWS82ljYUa3IwG7S2D70bpUxwunuL54pQ/GQ6Hp+kwe7I4HQQ67C5iTXJ4k2WoHy5RjzCXTaJxh9WJ7K9gftBwfqKIGkkTQP6AgKEyu+Eaa7cIotRwc2bu8n0aD+MhUTGW28q0iAhpcYn6gMqkAaLfsyPjT4cLMFWSoDFZle+SB883fGvAoPXhJmy0CiaBN5d19rJ/2EXRxMB8NHecy6pg44+jzy0hRjX7M6u/raavC0Dxx+KXXQC9j5sd322m2O4ha3PXPL2LWI7pEvUvvMBv80mrahMKWrSoLKbgz2gyg2e7zguT6SSUbbrHyV5W5PhcwotcJetkxYWE4PgGpjLT3FhdJbbS2PD77u3rP+Q7h9z2O8uqWsS4MCLGatBQm04egMKpcxNXnAWiQS0S7UbpdTfPpQopTVHCCrnGZyCKVMGuu1p1Ppx3mB3eRUx09HKl1Y1I8QFI6+oTyrDRm26lTPCGHrcU34cQQmppQv9bXD4oEnyPuzTmoNCEAo+VVtndA44xvNJcrrNKW6IujK/eesReKJUjlwfkP1AhMLe6wnl02DgISvAhzdUqIUskXPoqHDxFeCeFhQtr0fhq3lB06fYNB+ZzZds8hnfGlxpVmVLH0O4pPAJKTtW7ApR8kfu1CS/5QuTCbjt6cUf6LL8rDj/2p8z7U08TxutQ2w5ancjQdruWU9yLwx6E9JjtsytUVshT1BTn6a8zX6k8uIpoKwC1VvpSpcSv+z1pYeBz9I2Ko9nd5+u16s+G5H8Hx/c4QIPiFzwFIcvKQsk1L9BSGvVl2mFJto/MSq6l2sge2PJcI0+3sOL7/dJ9Hdpuh+/UQskegK8xq0wo7cIWArd7vF/Luyq4kzjJW+hPSlTdtRHwjCr1+SsucjpftRu4/lqTskZH1OkEnon0+Rjmke+SaQWXyq5Q17l7xSXMz4Y+XO7D6vRvDKt3kld2pbT4HdMD1Zz/rT1uKi1q39vrG6qliUyPjkZ/Yx1dN34fJjALChE8WWE6/pP8+ms0evz5fHj2j0FIWalIXRnpJ20gpBuB/QVW6SfUa5rHh7OGqTRVlolEUEKaWaX5EseOpR9mP5O4NoxLs3qKZCyNWCm3SQVaqcLHfFdtrXEbuiHhs9DBCUIay/Pcy0M0jlxFrhKet04XEjisuE5dk2owqbSwWyhUWuV4XGfIyZWadEnw1iEqoxGT7plZu2QoDMyvDwT9ilxv3QgUKunSMdEpudAGjtaFASOW0o29yhWXBnJh7DGx6QZcXU3QXMwRiOehSLV6CxkNanzmpm5uw7feDsGuga/5W7R6e3JBmXvuOuFUhXZFdkoE4Etq2MJA3IlDvYxGjOFVUN++LUIp4+pfpXstthsDu3p5XxFB3H3LN/I6yrzHbAd2iiDFHG0PEQJ4F1hBycK2Kc1U0SrlDZD31nWQL3z8PF5tpHs4Dq+NhcsLOGr5aT0ODi+9+90PmziO58dRa57SN9Daue/RnxMQHM262At3H84fDJfpQn3p7uuh2rcunOvKTVVZ9O0oQd24FsxVfAHhVMV6qPoSsEvQ97FeSbsbELLplurQBSa8Ck1YkLS5bGmv9gNhbayLcf5QYUEipgaE/UNjzv/nzNOZRbfInw8f91Fg/+Mwxw76SRrDhaDOxh9v2UUpfkL6+fmO1M2Xxg3JAvpDj3+0mxRfHrOIhYdN0xqxAu1K0Si+VMaZidsVGzOarfqbpkHwpxOPsgG1W4Iqb19kGsfL/giwUKEGZRGrdN4aSqVYqJPOGJfdRfsHXGmVVonTyD3HfOuEmeVLIZf3bTf+9T4jnxsVzwj0Hqs7Rdeg4/4BTQzoTGcjFjHp5o7sIrQnzokOhjcXV1OHD2piaJKRtFJsuMrxgW/eOWcOnoy/5lzQtAsz8YWuheg6cu55hDkcSWVD5NVc5E4HJU+oAMB4Ge8dO4aw8RllE1LHyRq3z+cEv4hRAHjbXCa+/E/vctyIRe1qXZ64iIMFF2QaU5Wl0vZfjTlqjTbjun07tiGwp+h6024KRnOFRJEEFkHQ/0V9j727lfAZhJz7vbucdrOr5o7CwNSYissE4SjcYBy37mP2N161r8prT7w6Jo6sSlRuQuFHoPCDMhNSwO8hBVvlZ3b+4jxq7s23dZ5LWuxVxhnccplynZoTJ6/g0kKWq024uw6adtx+eHQJ7y/h6McP18cRTF9ev4LZ5OTHD9fw/tJTm87ewOmT4emjk3MoJioZFJPX7e8DMqULbt11WS4SlMYBZOcLJTU9MIqHB6bbbDYxd69jpZeDsNcMXk8vX/4ye3ky8hcnVtjuyNYpK1VJVVuvNf0bs9FwdBY/ik9pL4W0gssWP/6yYK9E2PfRViv2z1ce/3zl8V/6yiPkFiqrB2XOhSQEO5e5DUn5I7sZ+WotE+5SopOY/YcilJo/R4xuP2jD7e2CG3yn87s7evxbhdpVDBG74doFKVc/7AoNl8vXlOvYpXeBk2tii5bnlU99e/UhpV6/4yJJsLRfXduuN67ezK5ZxBbhK5XCFWNM8w19JsI3bMw+sU/MSeWQ4upPen7Lci6XFV/Sen8uJStKqN0cvXY5OvwgyXav5LbF5X669sLQvyRa75ZnFIJ+wu3zerl/c++GukTwq8m2dF/wb9MHfkY=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Deploy digital wallet</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid"}></MethodEndpoint>



Deploys the OID4VC digital wallet for the organisation. The service registers the organisation with the OpenID wallet backend and returns the endpoints of the new deployment. Call this operation once, before you create a credential definition or a presentation definition. The deployment also makes the issuer, holder and verifier global configurations with their default values.

The organisation must have no deployment yet. If a deployment exists or a deployment request is open, the service answers with HTTP 400. There is no operation that removes a deployment, so you cannot deploy the wallet a second time.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Optional seed for the key material of the wallet. Send an empty body to let the service make the deployment without a seed.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"cryptographicSeed"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Seed that the service uses for the key material of the wallet. This field is optional. The service uses the value only when it holds one character or more, and it sends no seed when you give an empty value or leave the field out. Treat this value as a secret: keep it out of logs and out of version control.","example":"0d1f2a3b4c5d6e7f8091a2b3c4d5e6f7"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service deployed the OpenID digital wallet and returned the deployment details.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"agentServiceEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the OID4VCI and OpenID4VP service of the organisation.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Credential Offer endpoint.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/credential-offer"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Software version of the deployed agent.","example":"1.0.0"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** [`2`]"} schema={{"type":"integer","description":"Deployment status of the agent. A successful deploy always sets the status to Deployed, so this operation always gives `2`.","enum":[2],"example":2}}></SchemaItem><SchemaItem collapsible={false} name={"statusStr"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`Deployed`]"} schema={{"type":"string","description":"Deployment status of the agent as text. This operation always gives `Deployed`.","enum":["Deployed"],"example":"Deployed"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the distributed ledger that the agent uses for DID registration.","example":"European Blockchain Services Infrastructure"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerURL"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the distributed ledger.","example":"https://hub.ebsi.eu/"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerID"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the ledger network. The service does not set this field and always returns `0`.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Infrastructure provider that hosts the agent.","example":"iGrant.io"}}></SchemaItem><SchemaItem collapsible={false} name={"deploymentRegion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Geographic region of the agent deployment.","example":"Europe: Frankfurt"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the organisation is a wallet provider and can issue Wallet Unit Attestations. A new deployment always returns `false`. Use the update operation on this path to enable the capability.","example":false}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"agentServiceEndpoint\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service\",\n  \"credentialOfferEndpoint\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/credential-offer\",\n  \"version\": \"1.0.0\",\n  \"status\": 2,\n  \"statusStr\": \"Deployed\",\n  \"ledgerName\": \"European Blockchain Services Infrastructure\",\n  \"ledgerURL\": \"https://hub.ebsi.eu/\",\n  \"ledgerID\": 0,\n  \"infrastructureProvider\": \"iGrant.io\",\n  \"deploymentRegion\": \"Europe: Frankfurt\",\n  \"isWalletProvider\": false\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the organisation already has a deployment, a deployment request is already open, or the wallet refused the request. A refusal of the wallet keeps the status and the text of the wallet, after `Failed to deploy the OpenID digital wallet for organisation ID <id>: `, also for another status than `400`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"502"} value={"502"}><div>

The wallet cannot be reached: `Failed to deploy the OpenID digital wallet for organisation ID <id>: The wallet cannot be reached`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"504"} value={"504"}><div>

The wallet did not answer in time: `Failed to deploy the OpenID digital wallet for organisation ID <id>: The wallet did not answer in time`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"507"} value={"507"}><div>

Insufficient Storage: the HSM partition of the key store has no room for a new key. This is the partition of the installation HSM (the local key store in a hardware security module), or the DPoD partition of a key store of your organisation. The text is `The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.` A new try fails the same way: the answer has no `Retry-After`, so do not send the request again before room is free. For the installation HSM, the operator of the installation removes the unused key pairs or gives the partition more room. For a DPoD partition of your organisation, delete unused key pairs in the partition or give it more room. Some operations put the text after their own text: the test CA (`Failed to make the test CA: The HSM partition has no room ...`), the deploy of the organisation wallet (`Failed to deploy the OpenID digital wallet for organisation ID <id>: ...`) and the create of a sandbox organisation (`Failed to deploy sandbox organisation: ...`). A route that signs can also give this answer for an organisation that has no default key yet, because the wallet makes the default key the first time that it needs it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 507,\n  \"errorDescription\": \"The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create key store
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-create-key-store

---
id: config-digital-wallet-open-id-create-key-store
title: "Create key store"
description: "Adds a key store of a provider to the organisation: an external OpenBao or HashiCorp Vault (`vault`), a key ring in Google Cloud KMS (`gcp-kms`), one region of AWS KMS (`aws-kms`), an Azure key vault or managed HSM (`azure-key-vault`), a Thales Luna Cloud HSM partition (`dpod`), or a remote signing service with the Cloud Signature Consortium (CSC) API (`csc`), for example a qualified trust service provider. Give the provider in `provider`: an `id` of the providers of the list key store types operation, of the same type. The type `local` cannot be added: each organisation can already use the key store of the installation."
sidebar_label: "Create key store"
hide_title: true
hide_table_of_contents: true
api: eJztPGlv3Diyf4XQJxtQd9qZzGK3Nwiep52Z8ebyxk4CvMSAaIndzbVEKiRlpzfxf19U8RB1dNuezCzew/hD4pbEo1isu4r8mhRM54rXhkuRzJPDotCEkku2IdpIxYhcEkpqJa94wRQxkpg1I1KtqOCaQqc5oYKwL4YpQUvypmbiJyqJVORXqtd8IVVN3tOmNGQvu4K/2X7qJlBcrAgX5BcpVyUji1I2BXnx6pTsZau8nlxWGtpKwYhiKy4FwHL44dQ1odfaN6GCHP67UQxHxUlg/ooKumIF+fX0FTSHBpNLtplEUJytack0edkI6qaHxjVVhsPSyF5W1LJAKBShRLFKGkY0XwkAXTN1xXNGrrlZI1rsEKd8JagBcBZSaKkMbyqytzhd7JPDk2Oyl+U6hyGXUhH2hVZ1yQglnxta8iVnBTGq0SYM7lE/Jb/wK4bThN3ggmT+IcN9yHiRAZriZtq/KLk20c6aTc00kTVTuI+pb6ZpZT9Oydna/iJZKXNaZiSnQkhDLhihRcGKOWE0X3fIAZoQWipGiw1ptIW4Q07wggttaFlij+kn8UnATNe0LJkh+ZrllxqbLaWqqAmAMWO4WGlCReHf5YoVTBhOS53CC0EKyYCCcykEyxEiw7SZkmNDNL1iug+QKDfkGjrCe2hKaqo10wjWN3IGy/8GWxkPR759Et8mkwn+g2aOtsk38lIiUQeioA2AZXhu0VMxs5ZFSgBB+H3NaGnWfj2WemGBuFsO1rCFZ4oKzQ2pZCPMlNipPbPA5GOdPK/59p5ztrW33BZa9xiHfCO/MEMoMfKSCd+H1nXpl7hUsiKveK6klktDngujKDk+2r4qHNjPhxxHvpGTxgy2ilBkPqaIXlNVpGQVeCLwrBNRwMiureeHkhogqJRcU27IHgU0akP+NiOa5VIUep80wvCyNyDXhOaGXzFHYDAqruWKKb7c2J2mRDOtoTnAa9bUWEIEbtGGboAkOsNOyYcO0S0pdyTs+aBgJTMDeqUrysPegCTx+yHIm8PGrMnj6cxtTQffEaNg70/ikCi+WhsLbHeSALrFr4zBgleaZMCwPR7DNYBQeME2TvpWTLSiTLFlo1nhaOxzw7TJrIxxQ9sGwN8gXhTTGtAG6odfUcOIYOZaqsuUNKKEj31JQmhZymsd2rtBmLaz5EHBWNEH0gnZH1XacslzTkvCRFFLLozuy9EgpyJUEqoYuVbcsAmMNCWvJaFCXzNFFDONEghkNSWHYigl1/SKEU+FoOY6YhIlayv9D4mmoriQXwbjwD7Rooi19vSTSNIkiPbjIpknuRRLvjriK25o+QERDsr6uFgoRg17wTan0DVJE7c3P8lik8y/9gwErxIsqQpauV8d4dwjuFgQWfjcLFyxIpkb1bAU4DNMGJgxEiaP/qVh2q+JztesovALZk/mibz4F8tNkia1goUaznT7NbTSBiRfkvZXAVJ9DCommiqZf0xQJCVp4mRrkiZOasKvrkSEwWtZJGmS6zw5TxOn1JO5G+UGYcR9HIOsol9eMrEy62T+lycDQGN93wc4/U6VPyVv3SZYBgkTVWCBOEW/5kXBBLnYDNgtxb3mRlsbATtdMJLBU4bIDIiQNRMXVAIqgGRuQcPBbNbHw2swSkbW77jnYDYj+ZoqmhumNCp7D04j+OeGefkbM08XxEWjjayYImHTPEkPmeDUE7uDqLWWhpKsEZdCXoPiry6YQpSNWjjI71e0bBjZi01DaAVWr9XKltmstWuYoMJ4zWoth3dvX9omHaO6VhKYhRwf7aMo4uKKlrxw0zmJ/mQ2y6wyy54uOSuLZ3PytFbyomTVM9xPKdibZTL/OORBw01E8P3Ni9F1R2fBIbYj6/asKers9w6+QSfr1ubyZpJmuWJGEyZWXLCuudERQR8TpyuAvTsGW3J+k25fbysedqx4t7OzY6XBC7JrDcMgabMvHMza2HCmJcjarRqNZKgBLys9XSEUtOZ6mssq6yPD0UuSJmD345rS5JJt3gKr7kRIKyW3I6Tr0YHz9uGU0DwHm3YXOoLHd6dVe08xrL5n3R5HFlowxqGTVZSNcsYsBw9RKvzMxBVXUqBV04rcnGndx6Cd5RZcDfXILra5xcXdhbi+79tB4Ao4BKUYWI36vhZ9D/9BDN2i9J2KfadKwAhKsmPUoSVn7ud9GNFp4F1c2Fr0+Dju+3tbdQc20UFJff8jaig5UdI4Q1gKcsQqKooxAWXWSjar9S0OilPGAVyvZRdqUxtJ3gCFg4Epy1bpcsHB1OJgXy+50obsHZ3II0ueRaPYfh/9uNsv6QUrd2MWjJrdiL0tdEH2/nl2erKPAY9eCOWeoRO7ARg/6S8n17mlpYiAGs3UcZGc35zfpElkjw4V+odgwo/ZrVa9h/hL3CI4T8H+Ba8CFbgPCcD2DVgw3WYjj4YL9r9H+25fWy/OF6vX0eXuhHHM96FR52nyWxTpPYH3GvP7gNmmxO4JjNdXdq9pDnoC21l5fnz4CohFfSestyiR+8Lco9MtZP/HEcKoIL/nIlBCWylqZaFZK8astWtdducNgHIn2WKtNtrISz4F1R+cKS/GrEAhNc0v6SpoBpSursmUHJYlWcpG4eBeLNmw4kY2ADTEI7rq8DY0dXQ0d5HLymnaOwS51jxfk0vG6rgjR0dEqo0L7saIkcshLoInaIMVYBwZJcvW2UpJ9vcsJdnXDAyS7CZLQwQg+EKV9HFXXdMct0A2tlHVWWaAlpwcvyZUE24g/AarF+i4NHUBiLTtYmxZQQy4LhlAKhuzm87G1No9yQz00B2I/fzmpqd5AaQoJuB84sjhBH3l/D9UVt59hjhIU1VUbZJ54rynlBzW9VtZwgC4kZFz7UVCG34IQ3lHvPV73XhJ1/H1ftE8WRtT6/mjR26EqQMQHIj5Xx/PZm5I3OJkLpqyTBNjHbFXYNonc/84tO3mXxMrPECi1bWyy4E/GLt6upGNeotPz5KboTK3fl7b9NQ9Q+ObNFmDc5lLVaNv2cViz/FMUSRjXAvpGHIB11IVd0NumCgI4z6S/fvdKLYe6h+FYFghrMtZSA5Ey4Jj2A04cNg9cc8Ou6u8flHpLlb7Xm4apKn38y7ZZgSnrRkQYdU6qxN0Xt1XB3N/mh5ivRs7T6rNZMSnnSesgeDh5JppcxC5uPNEXuuJM1ItMM6+f8muWAlkc/oqGaNDXOShXeMLBqh4akP8X0xfr0SYQEXk0Emv9QCdzpdNIyNiBHmt2RIhr33pcObG6qHK+auAkUnOwL8rJwe38CnCAoscoZnwsWXKw/bVM5wdeDS87LJueO2RAmbJC7YZYWDrFkPKwTGw09d2/DE0DSymGF2Djx5t3Wl66Au+bMvDlRtiav/HgacCIQrurlvzmXt+Frsv7tvCPT+z5Hlm1/B8MQEK3Lk/diSLz7Et6nzvzGbfOdSjQdbB+LjnjP7mfuu2jmDe2XYRug0ONXEfHKpHx+8hPPJe+8yqmeK0fN1AuNWKyRHybMz6DIZYYLDnneKAgcPe27fHzxyK7dtoaw77L0datqg9HPsAPWouAurRu3fO/QkXDv1gp3SwfywM05z8omRTp2RxukDX+GA6mz6ZzkaQbg2dCOccB2jRHQ/Yw7JzqluidrJLTyHf96TiogDtBEuv+XumtJUhVwe3ELJzzN2Xd/j0bESe3olEb26sgaVrKbS1lx7PDsYzV172AvisQA0PRQHFMK9SOHOOQewF3O/fnJ/yFmeUYevV3MQZGjBj17IsdIiRxJnyTvoCLWdnewp2xRRZ055VPBaD6+bLeHF7tuydS6HgqEs+komaugqRiTMOwSOwLwpq6AXVzLoH9t1aVxlGg/pm9SDBxEoNXse7d8dH3WxNZzagnO/J+4XyFj6ofRqkmPd80sLlGLope7fY1AeMoUrhGnxCzfJGcbMhlSyacnTo/Sl5PlpNAxElmMj7VcDvbd43BV9MgGOqXMkAEGyIPnH9HSmXaVRcEnCzLZMxjSpLuN4d5d9zVsj+dKTAxIK8O9w99YUiCNa9QrtWUU1d9QT2/z0Ku+5b0OWionHSGakQRfjvkXy2o92SfAb1SC+gvc3C/xezz900ZxZJjp4bBa/6PoAVJ1aVQT4jg4V4oeLZOeLwY+NZxnLLsCIDZefdijFiSeTsi98xq43Acn3nxPVLWGybtbbb3oJyIWXJqBjG8NdQKpPBtt9JGPvou8XtfgcGGAQS5oaaRt8uhU+x3ZgctoVWWVuQ14IElT96SjKmlFQZoUsD2fRBDRIqUFuIBDKCa6BuKycUAx5kRcxydkKA0LWEbzBDl5dcs5vYFbw/O31YM+VLOG2FUqvbuY6LvBAZkGsD5ZHNPRH4N21IaqTMas+TfxBfFzS/ZJCF8DyGzBM0c+qVRRqJ+9C5XTApwfkl2embn88+HL59Du0Hwjv0wzo4pJjnC+RQ0PphJfdRjLtWBIO6wSf4srBz0LjaC0iiDS0izrnYCkIgzNzXTjh53UNO9uvpK0RBCPNvwUZmvTWEs2AFWI6smAR00O3I6Oi1YT7SVSdPu1XApiOMfSC4YDkvmCZreQ1RVberEUZcXfJQMLZkCSIS2mctTaDwh+RkO58rzoOXISlmZ48Zz5NykiZrXdn/3Q6ivIjQFLsvHa4MY9yrWKerkKbkNZrO1AUM7pZp85r6tqqPO0tTtOU7DbRLy1ejhp+z+Vxx4VDj4V4J2Sn73BkPf6jceajceajceajceajceajc+b9bubNwHM6KsUhbd6k/g3cJflsUD8O61nFDIPW+UPA9HAHYoBqGVbeE3Cz34PfnVW02iC/TOzvl6xFYWeh5CM9kPrkG5qNPY8Jv3GT4YbFyYh2GF2yT/T2y0rNBxgk+hzBMFqVh2glCcgXb9k3WLA66tgAsIGS4RKNsG1Q2IJMNY+toGvcD5iMv2zlrLmBEjNAMAALiOOECdR8tCmQ1Wp6MHAMIzu9NZDZ+xbA6rekFL3mvPVWKboZ1AcMTMhCXK2R0Qi6Ya200ca9HZDgKvQTNxa7R6N6fk8zWhsC6eFVLhSsEJkMsa4V/Wtwv1pTjJ3B2M7InZOi3wzuKAZJmzdRu4xTAuisIIdK4ZSmKLZliImd3XBfEjE6c+HnBNjpMlJKMFRz/2jBnFkUnb3HDsAQPybMD5R8IW2dnfLBxvmXK+6w5SRNuWDUaZfG+lV0htMT5Ud66aSHBw1cC44VQedJfJhiOPWhQy2sYBWBB5gBQ4iKV8UlvmwhHhVE+67wY8dswQMX7snroyMd6TAc9hPCAEi6YDYv883SBYd8lLTHoATGQ4Df3RDbsFnjOPl4DatC70J3IFw52gyb2wtZghG2B4OQKy3t6QT/MTALfbcvs+CBJ92SSn/IHwJhf8OnWkNvuUNQbsPpGon7RWW8buwgzZV4/7sEerqTakOyz0XUG0iJqheoTVOPG1zp294/raLucZ2tfUwPFW234NSWZkGbSH9tCzNH+dxmizB2yyTqBYAtET97NwSvuy8C8pLzSXUJCxE7JKWO4cJC27VriSEboA0iP4QU7xsLVCVu4iHFJtVnAQSBWHJrfEJrnbegYhuoHQlMgondni4CRC7aUjppdUSQcix4JZQfA3jLtqi1oWd4SEPHJzbhjH2T72lJZP2zbjZgM05Ty8r4h7WDG9afC493FWPy6YlrT1Wgc/7bA7mZ0KhuHTglakJoubSEQerBxwtaaZd5VLZihvCS9pErYx5Gz6sXYNua/D21tI6tOCuLx7PFfJgezyePZ2cFsPvtxPpv9b9Ive5SXSYviGL7zm/PbIGpJZxu930bn1o+AkOJvwcjCKxPDR88h3gEpM4uUNLE1rL8T07vU73cA1NslDmJra4Wqj3u6TE8nHRLFYLf5bD2722n+SHsONVtfUA7lU7yxMXbPbe0no5CSdGb/k9kM60ruWssRYwbTQgtZMJ8iOor25jwdiMauAGt7j1kIYZOezGY3I8OPGXthX3+iBeGibkAaKFoxw1TiqmKG6dwLWWx6J7ad3Okfa4fwmj0mujd2IBQvUOkXYHfGFQyKZzSpuNYQMtjL4mj0UyCpZ/NQLQ8DBgOMa++0pB0pGA2X+pO16Y4jyrA2jMFZjd8eXO+aW1Y8D4/XhzqOccFO9nZeg/DUCbtn6AD09zQjhkH87Xq9GSiIZEi3B39iun0nIFAgFf83ypA+an74E6NmkDYKkfHSXgrSIfTeNREh84w8Z4m5GxQjT+H/Z87atvdrAFML269zjY+9JsmWwfhQ64AfXVoqCqHCtL2hRlrBoDYs6oOrempDiX1q+NufnBq6G+4uYrJ2ZlRMYUNFsK14g8dY+QfXce77zkP3+1qdYYdBkT+2bT/+qfUyVOBiWhXrUxSxBShDHP3ZBd3WUrQgn64oR/N5XBK18kSPhT3tGTchyRIOxYGlmnPjoyTtxU29jcHaA1u2gR7yYc3xOMNHdGsMhZKEj4m7d4fYi3dsFenx0ZP3i/0kBeeZvAqFPLAfoYi/lhh5qylUkCWPrh4/sknOR4UdcGKTFHgoixePIObZlgThIyJI27r4KwT6Yz/SdsQq6WgPLOhOxXfBKjmhNZ/ylaLCTLnEMoLuACdKFk3uyhZGh7lthFNDV770cqS7tp/7gJy3uD8Furfk6negjerbF2mC1fZ286KTHc628NnyXnH2yTHSWTelaQP/9voUR0lZZ5yM2GlCmq9WbMm/wKFQDKtZGAnGid3JUKMoLxEHcMBrPyVsupr2hp0T1xFL4QEdEOaG21mADkEGvG0vb3oeMh6/6Tzgf+2oWk6j5JJvPcg6+Q93O9hW2Vlsl+Ept/ZsoW2BBw5t5OQ+59/SHScPU5unDWd84KE94NNmzrrnGtr3J6yyZx25WEov+GmOgp9VlAN76KaGWPv/tCwRtpH/0r7q8lLMhj1iD528qLU3KcLWQlk5/AW5QuOSNCvJUEq+hwvxOMhfsoicyWOtGyogBP8GRd7xPsZ9xzueQJWmnyKIyZN9rFiTuSzxMjeuMa3MBPTRzjCxLKLhcDTXumEpHqRI47v6nNTs+LoNOqfaUFFQVegJrpfDzUpLvE0OGdZhGqH98MOCvF+QvX98ONtPyfHzs5/J6dHkHx/OyPuFne349A05+Ovs4IfJj6Q6kvmj6uhlJw2Ntz5hJqHkORMamdTLo5rmawb3+A227vr6ekrx81Sq1SPXVz96ebx4/vr0+QT63LRB2XY7AVmFzJuwe1BlHs7rPJ49fjL9YXqA9a1Sm4qKCB57P1yrbPsiMjJJHq6Pfbg+9uH62IfrYx+uj324Pvbh+tj/59fHOp8BAtKP6hJKNm6cPfLV+aMfk6vH9mTskuMpn45Pam+gFdwleCK/1L1wnul5mqzBy51/TL5+hQMp71R5cwOvPzdMoScNR+IUt3mxj+chq4Ou7CWa0AtrgkzObObKHYIeRkjA87Q9oAquNjvbxo74yZvTsyRNLtyluBVGQxJFr8GXoNfJPPmUfEpwzWiFYgQG3n9NSipWDeaVEzsu3mjQAAZjF9Ve6uB+RLl2KqLLHgbeql0M/B+Vgna7PAW7Ae9S8M3tl60dgodsW8POQzLtP6TVyg0=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create key store</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/key-stores"}></MethodEndpoint>



Adds a key store of a provider to the organisation: an external OpenBao or HashiCorp Vault (`vault`), a key ring in Google Cloud KMS (`gcp-kms`), one region of AWS KMS (`aws-kms`), an Azure key vault or managed HSM (`azure-key-vault`), a Thales Luna Cloud HSM partition (`dpod`), or a remote signing service with the Cloud Signature Consortium (CSC) API (`csc`), for example a qualified trust service provider. Give the provider in `provider`: an `id` of the providers of the list key store types operation, of the same type. The type `local` cannot be added: each organisation can already use the key store of the installation.

The wallet checks the format of the settings and of the credentials, then does a connection test. It saves the key store only when the test passes.

| Type | Connection test |
|---|---|
| `vault` | Log in with the authentication method, read the health of the vault and list the keys of the Transit mount. |
| `gcp-kms` | List the keys of the key ring. |
| `aws-kms` | List the keys of the region. |
| `azure-key-vault` | Get a token of the application from Microsoft Entra ID and list the keys of the vault. |
| `dpod` | Put the key store on a signer shard, give the partition to the HSM signer of the platform, wait (at most 90 seconds) until the partition is active, then sign and verify with a session key that does not stay in the partition. When the test fails, the wallet deletes the key store again. |
| `csc` | Get an OAuth 2.0 token and list the credentials. |

A right that the key store does not give to the wallet gives `The connection test failed: Key management service refused the request`. The wallet refuses an address in a private network, unless the installation allows private addresses. The cloud KMS types use only the official endpoints of the provider.

The credentials are write-only. No answer returns them. An organisation can have at most one key store of each provider. A sandbox organisation cannot add a key store.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The type, the name, the settings and the credentials of the key store.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store.","enum":["vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"vault"}}></SchemaItem><SchemaItem collapsible={false} name={"provider"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 64 characters`"} schema={{"type":"string","maxLength":64,"description":"The provider of the key store, an `id` of the providers of the list key store types operation. Required. The provider must not be hidden by the installation, and its type must be `type`.","example":"openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Name of the key store, at most 100 characters. It must be unique in the organisation.","example":"Customer vault"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>settings</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Settings of the type. The wallet refuses an unknown member and checks the format of each value (for example the AWS region, the Azure tenant ID and vault URL, the Google Cloud project ID). An invalid value gives `400` with `<field>: <problem>`.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"vault"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"address"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the vault, with `https://`. The wallet refuses `http://` and private network addresses, unless the installation allows private addresses (for example on premises).","example":"https://vault.example.com:8200"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Namespace in the vault. Leave it out or send `null` when the vault has no namespaces.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"transitMount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the Transit secrets engine. The default is `transit`.","example":"transit"}}></SchemaItem><SchemaItem collapsible={false} name={"caCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM bundle of the certificate authorities that the wallet trusts for the TLS certificate of the vault. Without it, the wallet uses the system certificate authorities.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"clientCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM client certificate for mutual TLS. Required for the authentication method `cert`. With another method, send it when the listener of the vault requires mutual TLS. The private key of the certificate goes in the credential `clientPrivateKey`.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to the vault.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`userpass`, `approle`, `cert`, `token`]"} schema={{"type":"string","description":"Authentication method. `userpass` needs `username` and the credential `password`. `approle` needs `roleId` and the credential `secretId`. `cert` needs `clientCertificate` and the credential `clientPrivateKey`, and can have `role`. `token` needs the credential `token`.","enum":["userpass","approle","cert","token"],"example":"userpass"}}></SchemaItem><SchemaItem collapsible={false} name={"mount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the authentication method. The default is the name of the method (`userpass`, `approle` or `cert`).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"User name, for the method `userpass`.","example":"wallet"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Role ID, for the method `approle`.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Name of the certificate role, for the method `cert`. Optional.","example":null}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"gcp-kms"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"project"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Google Cloud project ID of the key ring. A domain-scoped project ID (`example.com:my-project`) is also accepted.","example":"my-project"}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Cloud KMS location of the key ring, for example `europe-west1`.","example":"europe-west1"}}></SchemaItem><SchemaItem collapsible={false} name={"keyRing"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 63 characters`"} schema={{"type":"string","maxLength":63,"description":"The name of the key ring. Letters, digits, `_` and `-`, at most 63 characters.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"protectionLevel"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`HSM`, `SOFTWARE`]"} schema={{"type":"string","description":"The protection level of the keys that the wallet creates. `HSM` (default) keeps the keys in hardware security modules of Google Cloud (the key store `protection` is `hsm-backed`). `SOFTWARE` keeps them in software (the key store `protection` is `software`).","enum":["HSM","SOFTWARE"],"example":"HSM"}}></SchemaItem></TabItem><TabItem label={"aws-kms"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"region"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The AWS region of the keys, for example `eu-central-1`. Free text with a format check, not a fixed list.","example":"eu-central-1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to AWS KMS.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`accessKey`]"} schema={{"type":"string","description":"Authentication method. `accessKey` (the only method) needs the credentials `accessKeyId` and `secretAccessKey`.","enum":["accessKey"],"example":"accessKey"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"azure-key-vault"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"vaultUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the key vault (`https://<name>.vault.azure.net`) or of the managed HSM (`https://<name>.managedhsm.azure.net`), without a path and without a trailing `/`.","example":"https://my-vault.vault.azure.net"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Microsoft Entra tenant ID, a GUID or a domain name (for example `contoso.onmicrosoft.com`).","example":"00000000-0000-0000-0000-000000000000"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The application (client) ID of the app registration, a GUID.","example":"11111111-1111-1111-1111-111111111111"}}></SchemaItem><SchemaItem collapsible={false} name={"keyType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EC-HSM`, `EC`]"} schema={{"type":"string","description":"The key type of the keys that the wallet creates. `EC-HSM` (default) keeps the keys in hardware security modules (the key store `protection` is `hsm-backed`). `EC` keeps them in software (the key store `protection` is `software`). A managed HSM has `EC-HSM` keys only.","enum":["EC-HSM","EC"],"example":"EC-HSM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the application logs in to Microsoft Entra ID.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`clientSecret`, `clientCertificate`]"} schema={{"type":"string","description":"Authentication method. `clientSecret` needs the credential `clientSecret`. `clientCertificate` needs the credentials `clientCertificate` and `clientPrivateKey`.","enum":["clientSecret","clientCertificate"],"example":"clientSecret"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"dpod"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"tokenLabel"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 32 characters`"} schema={{"type":"string","maxLength":32,"description":"The label of the partition, at most 32 bytes in UTF-8, without a control character, `;`, `{` or `}`. The wallet removes the spaces around it.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^[0-9]{1,16}$`"} schema={{"type":"string","nullable":true,"pattern":"^[0-9]{1,16}$","description":"The serial number of the partition, a string of 1 to 16 digits. Optional; an empty string is the same as `null`, and a number is refused. When given, the HSM signer checks that the partition has this serial number.","example":null}}></SchemaItem></TabItem><TabItem label={"csc"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"cscUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC API of the QTSP, with `https://`.","example":"https://qtsp.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"apiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"Version of the CSC API. The default is `v1`.","enum":["v1","v2"],"example":"v1"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client ID that the QTSP gave the organisation.","example":"client"}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID that the QTSP registered for the organisation.","example":"user-1"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>credentials</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Write-only credentials of the type. Give the credentials that the settings use (for `vault` and `azure-key-vault`, the credentials of the authentication method).

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"vault"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"password"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Password, for the method `userpass`.","example":"<yourPassword>"}}></SchemaItem><SchemaItem collapsible={false} name={"secretId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret ID, for the method `approle`.","example":"<yourSecretId>"}}></SchemaItem><SchemaItem collapsible={false} name={"token"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Vault token, for the method `token`.","example":"<yourToken>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientPrivateKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PEM private key of `clientCertificate`, without a password. Required for the method `cert`, and when you give `clientCertificate` with another method.","example":"<yourClientPrivateKeyPem>"}}></SchemaItem></TabItem><TabItem label={"gcp-kms"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"serviceAccountKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JSON key file of a Google Cloud service account, as one string (the text of the file, not an object). Required. The wallet checks that the text is JSON, that `type` is `service_account`, that it has `client_email` and a PEM `private_key`, and that the service account is of `googleapis.com`. The wallet never sends a request to an address of the key file.","example":"<the text of the service account key file>"}}></SchemaItem></TabItem><TabItem label={"aws-kms"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"accessKeyId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The access key ID. Required.","example":"<yourAccessKeyId>"}}></SchemaItem><SchemaItem collapsible={false} name={"secretAccessKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret access key. Required.","example":"<yourSecretAccessKey>"}}></SchemaItem></TabItem><TabItem label={"azure-key-vault"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The client secret of the application, for the method `clientSecret`.","example":"<yourClientSecret>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The PEM certificate of the application, for the method `clientCertificate`.","example":"<yourClientCertificatePem>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientPrivateKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The PEM private key of `clientCertificate`, without a password, for the method `clientCertificate`. It must be the private key of the certificate.","example":"<yourClientPrivateKeyPem>"}}></SchemaItem></TabItem><TabItem label={"dpod"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"authTokenConfigUri"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 2048 characters`"} schema={{"type":"string","maxLength":2048,"description":"The value `AuthTokenConfigURI` of `Chrystoki.conf`, an https URL.","example":"<AuthTokenConfigURI>"}}></SchemaItem><SchemaItem collapsible={false} name={"authTokenClientId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 512 characters`"} schema={{"type":"string","maxLength":512,"description":"The value `AuthTokenClientId` of `Chrystoki.conf`.","example":"<AuthTokenClientId>"}}></SchemaItem><SchemaItem collapsible={false} name={"authTokenClientSecret"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 2048 characters`"} schema={{"type":"string","maxLength":2048,"description":"The value `AuthTokenClientSecret` of `Chrystoki.conf`.","example":"<AuthTokenClientSecret>"}}></SchemaItem><SchemaItem collapsible={false} name={"pin"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 256 characters`"} schema={{"type":"string","maxLength":256,"description":"The PIN of the Crypto Officer of the partition. The HSM signer logs in one time with each new PIN. After a wrong PIN it does not log in again until you give a new PIN, because the partition locks after too many wrong PINs.","example":"<yourCryptoOfficerPin>"}}></SchemaItem></TabItem><TabItem label={"csc"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client secret that the QTSP gave the organisation. Required.","example":"<yourClientSecret>"}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PIN of the user at the QTSP. Optional. The wallet uses it for a referenced key that has no PIN of its own (`providerSecret`), and for document signing.","example":"<yourUserPin>"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The service tested and saved the key store, and returned it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else a UUID.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store. `local` is a key store of the installation (OpenBao Transit, the wallet database, or the hardware security module of the installation). Each organisation can use it, and the API cannot add, change or delete it. `vault` is an external OpenBao or HashiCorp Vault of the organisation. `gcp-kms` is a key ring in Google Cloud KMS. `aws-kms` is one region of an AWS account (AWS KMS). `azure-key-vault` is an Azure key vault or managed HSM. `dpod` is a partition of a Thales Luna Cloud HSM service (DPoD). `csc` is a remote signing service with the Cloud Signature Consortium (CSC) API, for example a qualified trust service provider (QTSP).","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"provider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The provider of the key store, an `id` of the providers of the list key store types operation (for example `openbao`, `hashicorp-vault`, `google-cloud-kms` or `intesi`). `null` for a `local` key store. It cannot change. An organisation has at most one key store of each provider.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Name of the key store. It is unique in the organisation.","example":"Local vault"}}></SchemaItem><SchemaItem collapsible={false} name={"local"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` for a key store of the installation (type `local`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`active`, `disabled`, `error`]"} schema={{"type":"string","description":"Status of the key store. `active` when the key store works. `error` after a connection test that failed. `disabled` is reserved.","enum":["active","disabled","error"],"example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`, `hsm-backed`, `dedicated-hsm`, `provider`]"} schema={{"type":"string","nullable":true,"description":"Where the private keys of this key store are. `software`: in the software of a key management service (`local` with the backend `openbao` or `database`, `vault`, `gcp-kms` with the protection level `SOFTWARE`, `azure-key-vault` with the key type `EC`). `hsm`: in the hardware security module of the installation (`local` with the backend `hsm`). `hsm-backed`: in a cloud KMS that keeps the keys in hardware security modules of the cloud provider (`gcp-kms` with `HSM`, `aws-kms`, `azure-key-vault` with `EC-HSM`). `dedicated-hsm`: in a hardware security module partition of the organisation (`dpod`). `provider`: at the provider, which decides how it protects the keys (`csc`). An organisation key store has the `protection` of its provider, unless its settings decide.","enum":["software","hsm","hsm-backed","dedicated-hsm","provider"],"example":"software"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>settings</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Settings of the key store type. Never a secret.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"local"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"backend"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openbao`, `database`, `hsm`]"} schema={{"type":"string","description":"Where the installation keeps the keys. `openbao` for OpenBao Transit (`local-openbao`), `database` for the wallet database (`local-database`, legacy, no new keys), `hsm` for the hardware security module of the installation (`local-hsm`). With `hsm`, the new local keys of the organisations go to the HSM; the keys in `local-openbao` stay there and keep working.","enum":["openbao","database","hsm"],"example":"openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`]"} schema={{"type":"string","description":"How the key store protects the keys. `software` for the backends `openbao` and `database`, `hsm` for the backend `hsm`.","enum":["software","hsm"],"example":"software"}}></SchemaItem></TabItem><TabItem label={"vault"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"address"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the vault, with `https://`. The wallet refuses `http://` and private network addresses, unless the installation allows private addresses (for example on premises).","example":"https://vault.example.com:8200"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Namespace in the vault. Leave it out or send `null` when the vault has no namespaces.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"transitMount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the Transit secrets engine. The default is `transit`.","example":"transit"}}></SchemaItem><SchemaItem collapsible={false} name={"caCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM bundle of the certificate authorities that the wallet trusts for the TLS certificate of the vault. Without it, the wallet uses the system certificate authorities.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"clientCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM client certificate for mutual TLS. Required for the authentication method `cert`. With another method, send it when the listener of the vault requires mutual TLS. The private key of the certificate goes in the credential `clientPrivateKey`.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to the vault.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`userpass`, `approle`, `cert`, `token`]"} schema={{"type":"string","description":"Authentication method. `userpass` needs `username` and the credential `password`. `approle` needs `roleId` and the credential `secretId`. `cert` needs `clientCertificate` and the credential `clientPrivateKey`, and can have `role`. `token` needs the credential `token`.","enum":["userpass","approle","cert","token"],"example":"userpass"}}></SchemaItem><SchemaItem collapsible={false} name={"mount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the authentication method. The default is the name of the method (`userpass`, `approle` or `cert`).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"User name, for the method `userpass`.","example":"wallet"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Role ID, for the method `approle`.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Name of the certificate role, for the method `cert`. Optional.","example":null}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"gcp-kms"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"project"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Google Cloud project ID of the key ring. A domain-scoped project ID (`example.com:my-project`) is also accepted.","example":"my-project"}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Cloud KMS location of the key ring, for example `europe-west1`.","example":"europe-west1"}}></SchemaItem><SchemaItem collapsible={false} name={"keyRing"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 63 characters`"} schema={{"type":"string","maxLength":63,"description":"The name of the key ring. Letters, digits, `_` and `-`, at most 63 characters.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"protectionLevel"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`HSM`, `SOFTWARE`]"} schema={{"type":"string","description":"The protection level of the keys that the wallet creates. `HSM` (default) keeps the keys in hardware security modules of Google Cloud (the key store `protection` is `hsm-backed`). `SOFTWARE` keeps them in software (the key store `protection` is `software`).","enum":["HSM","SOFTWARE"],"example":"HSM"}}></SchemaItem></TabItem><TabItem label={"aws-kms"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"region"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The AWS region of the keys, for example `eu-central-1`. Free text with a format check, not a fixed list.","example":"eu-central-1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to AWS KMS.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`accessKey`]"} schema={{"type":"string","description":"Authentication method. `accessKey` (the only method) needs the credentials `accessKeyId` and `secretAccessKey`.","enum":["accessKey"],"example":"accessKey"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"azure-key-vault"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"vaultUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the key vault (`https://<name>.vault.azure.net`) or of the managed HSM (`https://<name>.managedhsm.azure.net`), without a path and without a trailing `/`.","example":"https://my-vault.vault.azure.net"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Microsoft Entra tenant ID, a GUID or a domain name (for example `contoso.onmicrosoft.com`).","example":"00000000-0000-0000-0000-000000000000"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The application (client) ID of the app registration, a GUID.","example":"11111111-1111-1111-1111-111111111111"}}></SchemaItem><SchemaItem collapsible={false} name={"keyType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EC-HSM`, `EC`]"} schema={{"type":"string","description":"The key type of the keys that the wallet creates. `EC-HSM` (default) keeps the keys in hardware security modules (the key store `protection` is `hsm-backed`). `EC` keeps them in software (the key store `protection` is `software`). A managed HSM has `EC-HSM` keys only.","enum":["EC-HSM","EC"],"example":"EC-HSM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the application logs in to Microsoft Entra ID.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`clientSecret`, `clientCertificate`]"} schema={{"type":"string","description":"Authentication method. `clientSecret` needs the credential `clientSecret`. `clientCertificate` needs the credentials `clientCertificate` and `clientPrivateKey`.","enum":["clientSecret","clientCertificate"],"example":"clientSecret"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"dpod"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"tokenLabel"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 32 characters`"} schema={{"type":"string","maxLength":32,"description":"The label of the partition, at most 32 bytes in UTF-8, without a control character, `;`, `{` or `}`. The wallet removes the spaces around it.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^[0-9]{1,16}$`"} schema={{"type":"string","nullable":true,"pattern":"^[0-9]{1,16}$","description":"The serial number of the partition, a string of 1 to 16 digits. Optional; an empty string is the same as `null`, and a number is refused. When given, the HSM signer checks that the partition has this serial number.","example":null}}></SchemaItem></TabItem><TabItem label={"csc"} value={"6-item-properties"}><SchemaItem collapsible={false} name={"cscUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC API of the QTSP, with `https://`.","example":"https://qtsp.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"apiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"Version of the CSC API. The default is `v1`.","enum":["v1","v2"],"example":"v1"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client ID that the QTSP gave the organisation.","example":"client"}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID that the QTSP registered for the organisation.","example":"user-1"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialsConfigured</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential field of the key store type, `true` when the wallet has a value. The answer never has the value. Empty for the type `local`. The fields: `vault` `password`, `secretId`, `token`, `clientPrivateKey`; `gcp-kms` `serviceAccountKey`; `aws-kms` `accessKeyId`, `secretAccessKey`; `azure-key-vault` `clientSecret`, `clientCertificate`, `clientPrivateKey`; `dpod` `authTokenConfigUri`, `authTokenClientId`, `authTokenClientSecret`, `pin`; `csc` `clientSecret`, `userPin`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"capabilities"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`create`, `import`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete`]"} schema={{"type":"array","description":"What the key store can do. The type sets them. `local` (the key store that takes new keys): `create`, `import`, `sign`, `csr`, `certificateChain`, `test` (no `import` with the backend `hsm`). `local` (the other key store of the installation): `sign`, `csr`, `certificateChain`, `test`. `vault`: `create`, `import`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete`. `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`: `create`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete` (no `import`). `csc`: `reference`, `sign`, `listProviderKeys`, `test`, `edit`, `delete`.","items":{"type":"string","enum":["create","import","reference","sign","csr","certificateChain","listProviderKeys","test","edit","delete"]},"example":["create","import","sign","csr","certificateChain","test"]}}></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the keys in a qualified signature creation device (QSCD). `false`, or `provider` for the type `csc`, where the QTSP decides.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"keyCount"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of keys of the organisation in the key store.","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"qualifiedStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","nullable":true,"description":"Only for a key store of a provider with `qualified` `true` (category `qtsp`): `qualified` when every key of the key store is qualified and there is at least one key, `not-qualified` when a key is not, else `unknown`. `null` for every other key store: no other key store claims a qualified status. See `trust` of the key.","enum":["qualified","not-qualified","unknown"],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"lastCheckedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the last connection test, in UTC. `null` before the first test.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lastCheckResult</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Result of a connection test of a key store.

</div><SchemaItem collapsible={false} name={"ok"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the connection test passed.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Why the connection test failed, as a safe text. It never has a secret or the detail of the provider. `null` when the test passed.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the connection test, in UTC.","example":"2026-10-20T10:05:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Creation time of the key store, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the last change of the key store, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"local-openbao\",\n  \"type\": \"local\",\n  \"provider\": null,\n  \"name\": \"Local vault\",\n  \"local\": true,\n  \"status\": \"active\",\n  \"protection\": \"software\",\n  \"settings\": {},\n  \"credentialsConfigured\": {},\n  \"capabilities\": [\n    \"create\",\n    \"import\",\n    \"sign\",\n    \"csr\",\n    \"certificateChain\",\n    \"test\"\n  ],\n  \"qscd\": false,\n  \"keyCount\": 3,\n  \"qualifiedStatus\": null,\n  \"lastCheckedAt\": null,\n  \"lastCheckResult\": {\n    \"ok\": true,\n    \"message\": null,\n    \"checkedAt\": \"2026-10-20T10:05:00Z\"\n  },\n  \"createdAt\": \"2026-10-20T10:00:00Z\",\n  \"updatedAt\": \"2026-10-20T10:00:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The body, the settings or the credentials are not valid (`<field>: <problem>`), a credential that the settings need is missing (`credentials.<name>: required`), the type is `local`, the provider is missing, unknown, hidden by the installation or of another type, the organisation is a sandbox organisation, or the connection test failed (`The connection test failed: <message>`). `errorDescription` tells why, as a safe text.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The installation does not let an organisation add a key store of this type (`The key store type <type> is not allowed in this installation.`), or, for `dpod`, the installation has no HSM signer (`This installation has no HSM signer for DPoD partitions.`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div>

The organisation already has a key store with this name, or a key store of this provider (`The organisation already has a key store of this provider: <provider name>`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The provider of the key store is not available, or, for `dpod`, the HSM signers of the installation have no free capacity for a partition.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create key
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-create-key

---
id: config-digital-wallet-open-id-create-key
title: "Create key"
description: "Adds a signing key to the organisation in one of two ways:"
sidebar_label: "Create key"
hide_title: true
hide_table_of_contents: true
api: eJztPWtz27ayfwXD80XuULIlP5qoOZmryEqq5uVaTnJ60kwJkZCEmiIUArSsZvzfz+wCIMGHZMWnnXvnNjOZiSyBwGKx710sv3gRk2HKV4qLxOt7gyiShBLJ5wlP5uSabYgSRC0YEemcJlxSGEh4QkTCiJgRtRZkTTey/2vya9Im3303TBlVjFB49rvvYCR+JFKJlBG1oIqENCGhHnbNNpK0QrqiUx5ztSGB/iHokyAWIY0DnwQ3NIsVfJiHq/b1UsJHupb5xz+ylLWv2aatBxKaRCSIViIKDjrkaoGrEC4JTchoeD4ZkIt27/QMv11ztcDt0XguUq4WSxKMJr3Ts8DHaThCmwhFpoyw25VIFYs6ZBDHZMZZDMhKGRGIPhr3cT6RKRJcs80EdjyOApx/TeOYKZJJJvFv3FwVMYpeM0kStka8+ERq1LPlSm3IVEQbEny5CwzupEGsWrCU6X0OLsYkYTcsJSlTWZropVYpvzG4hhPDpzr6sC7ZjKUsCYvz0nDgU+KGRywlNE4ZjTZkQSsnldqH4bC+8ox8c0D6rEIZwlG94DesjDn81ULykm0u2SzokBdMg5gDIItzjLlUBexIXmLFUiRbjSRzErApg59sGvMQ0TNLxbK0+w55LlICKN0QtVkBDYRspTTIPpAHjaVAfoHzUEwqsmRS0jlD4G9YymfcnDmMoiqD04JZKfn5anKB67Y0CnwyBxTA2IvxG2SvBSPDyRCOPGKJ4jQGjspRMmFhygCbIiUxozcMIAL6UwJIDR8PMsnSC54Edr6c6CwYBRUieeTYQ6QGnzMawx6igAQqzVjguwQdLlh4bUia0RkJWar4jIdAcGY9B3Y6pzyR+vRG74hKM6lYhIcmEV8u3aZMZrHC/eJAdwMdEDcfLK0aWJbIPusFS5BvXS5xKJSSq5Qmkivcd8DCSNL2Cli+oCL4ZXxOqCRcSZLQJfvBpWy9q81KCT2HWMv2k2u2GUdPA9JaZelKSEaCweSX169HV5fj4W+T8Ys3sLYjZfSXv130Ts9+m/w40DLH0J5iIcrZmN2wuHZuBz+4vKXPLxgNh7+9GU+ucMKABDj5+9Hl+PkvgSvmOJUkwP8OXbB/aOJRu2plgyg+i1+RL5pgRA4HAAt5u6I8hRPFfdJUcdxmwb10ymJcrm+Xw5N+YdkC5qB4IEgX8CHwyQx49JYuVzEjayAKrjRLFuIf5QJQGMwSUbmYCppGRC7EmnDl5z9lqyiXlVZukHBBkzkDYiAxVSAVSoJkhlKdJiRLrhOxTrRqKIOlCXopblhkSPFqs2JBhwyIpEk0FbdlDWu0Do2iXGB7vpeDNI68vheKZMbn53zOFY0/IDRvVywZR1oHv2Qbz/dS9jljUj0T0cbrf6mo+yv3yHIcIHrNgRplhBJGNY7OpXBFegDQZn2essjrz2gsmQ9QK5YoAIauVjGICi6Sw98lQPTFk+GCLSl8Arry+p6Y/s5C5fkejSKu9exFCohQnMl81pXz1Rev0CHORFKlPJl7vrekt69YMlcLr3924ldQ8tIVhlbakLdGw2vpshGZNWA097WQqtiMosDaW8MfdMilQU8xcero5CoyDTV5fQ9nb4sVS6ZUeHe+B4d2z2a7R0fV3b5xjhqPeQcrWRz4hCqyFFKR7tER8EZKQ8VSWQbwYnxOuJQZhZ30jnpnAGQu/5ogLUM2scrSEZpIYAZ5BTwda7JZzIsk3pAbGmcMQUqypdf/6OEY75MLo/7qDqnHMTHuQeNpt1cF9rLMA9osqxpSCyr9wsLYbaigwANdDltRokQUuHnQ3IErp12mdRScGVnoLupqrhuWSpA2jvSG/dakOWmByQF8KA+fmE9PD4EGAVx5+MR+fHp4zTaXPJnLwyfm09NDveBLttFfOl+81+vLwycGkqdgByLEVQU3uMwNopTNK0AjkHbk+BylFU2MtmsZdfcEUPQ0OPjBtRmuGVvJfJ7B5Ru7fE0Z2sntuvh9HVOoy8BqsLhtBU9w6Ls0RuxYQBr2bBRmoQlzamrWm60u0Ea398jhQp8kgoCMTUVcfI3fBof5Stp8hdmKDZXtTNBMZdGeCHA1QEIs0U6VJDg5OgrKbG88R8Rc12Utbarew1pgV1RY60PKFWsjH0icQiMlBy0y6gkGzMpb22pDu7Ljg/HYwAhoctR2mc9vBKGJXDv+FldldDzZiAyefurd3d3lP6CO0goEVV62XNJ04/U913m2x13RI57voWiDB7XMbxK1d76Zf5y8B+LbvQxNCLtVLAUFh7TqLuLqUu9J8ddTz98OQEnUWzl7B9aAObbBWr5cyjJYFW8UED74MCEvX0/2hacqxz2aJn26lv3rpeyzrB2yRKU0bnf73W632+v1esfHx8f9a7Y57PaOT+g0jNrdHp22j0/CqH16xmZt+P707PtHj4/otNixgQvALO/rRbi6d1+O1H0hxDxmZBiLLPqvNpqL5+WmbT478pllYB6110yqbiGhwao3/OrKaDhJljYI6W6x/yrcdUTce7Ta/X3whp8U7FyiRetTe3XRU+bGOw2uXIlEao7sHXWbTWTJ0hsOsEcRiwo/JPdXWWQY/8G2bc18bbZcy6C9S/jnjBGOaJhxllaMdu2mIHqtaSTBSgAP8Pf1deea2xALDMZFK9L8eNajj7vhyffTR9EJO5vRo/A0+p51H00f905mx0cg4H9fXzftqAzqRRFjKcMI4uenyds35AObErC9Wz99eHmASoYiSputfghE1LCmNvfj7KVxWCu4CUbDytZHQw+F6M39c47iGD6HJMzSG/c8KhZx21ibt/dP+S8SCpFGPHHiKKy8zErwRPmAvymV7OwkS2MHbY4Kyn9u37aLWZ8CJHsg7Je/BJJNFZJrvgfBw+E52N1B3g8lZhrPH+aazAr/uEJHRvfBHtmmiVMUVzhyokWxdtvLK75NWCkmb87BjRj45eiV43MuBMSpeRH+OB+fSxOJF0umXRKuNDqNPQPBXicuuoSoBwTwwMzqkLEyYWYY5oaYwTQtuZO1AIGFz9qy1gHCQKQ28Dp/ujzMZWEpUGjDPkWMX8d59hGbX09Z2/zzJItjOoVptEz7Sn8dDPGETDfo7kRLnnCpUqpEqgMKqsh+aHswAkznlNIU7eqQAGAKyhPASScCvcw9/Hyru+9XDFfb6NVhpjIx7CModlGCMd53R1P09Pctc9UU+XRjDjgvmjjaqDZuOKg17d7Cp7KnCYusRATGhAzL4Qo92w5a2kkrTft+hb6FXlebQzZY9xHwbPBgFvx053si5XOe7EPHZVh+FOscjhDgasgqdmzyL6qkGAzhVkSHE5zAHAxmGsPcIEWBcn4hzh1/uUFsHnRIwJc6r2eW1X9WQsB2TMF5yESGmcCBpKXcR7igHHZU+KlOPH1NZZ5Wq+3GAGklYxGaNujQuSYTZjDZP4fkDLY837Mge45VHpUpyg6+LzS3+3C3hOp2qUPfk4qqTO6hbHHcNknuIMMJu1m1pNcgAQ0Vv2EVoa2/BFC4PNehWweaqRAxo0kdnIVYS5MIKyRkHRq14BIBmm5sYLi0PEzwAON5p7VMXF9FsiSSOixiFPmSLacQpi3Utx5TzRHrcSTQWu6/trFz5ymGOoF8TS7NQnmORufSK7ZlKRH+V5vrZUjyrFUTAPhj8M3A/zsa+OUsiU0+zFDj5ESzRezdnobO+jRNad3aH1b1iKvFMScN6EBtEeGpYOYdsgRCKCJSsKdbGhwsSHD0kl9k6q1awSHw5EGHjGgIWoUtsVzGnDZhSSgg8HE+unTnqrB3VGZrLXpqNmSjloR5gtvTMCALRiNtrdGiXCIHdRmJEAfCYwFZUJMVLu2HJ4qlSxZxXKBYTPq5qsZtQ0kBoUm4EOinw673UEfgid2DFrSkbk8bY90VOvtx0O4StciW01XKk9x1qlZS/GmY3satckG77QKOp5pS1T+QavfaBlD9Pht5I5QpS/lHYG0fsw30LXCn2SoWNKrD79hjOgGRiwQtJEAw3J6q32RdNpc32zs9q283/I3drni6h8gc4TiieGFgV3eKfPnuavjXHF3vqPd9u9tt97pX3aP+Efz7d82AB10NNnvEI3mvzGmKCVgb5ivZI2ImzM4lBEYLH6x1Pj4/6Hh3zk4+AnQQf+//0YuWf5w/6obzi9tH76/59z9Ns+z18vkv6YeL+S9iozbX7/59zDafF6r7++OX08//7nQ6uL8FlY7EHAK2HmzI5SeQkH91To8eb5FWxWCoZQRBVfjUwe3p0eOgST9iqQJYKcWcE5Gl4V5xgUpWDMx+XYe0S1nAWUo8zA4JNFfljsj9TLana2Ss7xKbB6BV2iE1z00zHqs2sDsom+FAF0yYEoqqjiqmPtCaNoIqKLFassTEsJhUmKXGYFTwWcmVLcqqV59hPsBN/e2IbjRznXGsLPrKnpXZp+d7AIbnw+SuiwV/3+lhDpF+LX0WYiKoEQ+WPeT41vKmhm/M6URVHPlkveCg8eUeeNYFRtIta0wlFBtKHjEtK1YxVZgejgSBeJrWsfxeLrhImWzODe/mgiv0XODZvNZwFze08roLd5iewKm+OLB1kc3GU7EgZPlNeZV5JCGWSvTq1SdM4gMPZXJZcmorZJmiyZuIpByxMeTkADWQkkm5tFmnOH478/oft0eZh42P1uWLqV7ZVtSJpmgcQ6Ue4gH+zrDsFRa2JZJ54Sc8CpY0M0qGKzLjSupxy/NX5FyEGRIe2N4shfDHjMegRpUkP4cXk2fozTMY4zu2663KYwMSzEGsR9X2OdiyZt3NltLfXeQCBRC2RHxLfMfPg6nU2OCVilQTV4YFfVszcc027wBRWP9njt03Nd5YCOuTYBnFFiEaHwEJkG+gcPpzeCGn9knDqIAGmYULNIEGCRkNBiRhTBfzMziA8hECvHMakxVLpS6MNuGKuiTUNWpAsmUM5ArPkDcsmYfzW4zStv3roBMg+jWYRjaEIkscS5xFbeRMdguYKJf39HWBAvxgg9m2yh1KL6PGhEGO44eJlTI9b7PySGt0NRmT0Rty3H1MTrq9do+EMYXS65POcafnEwXLkC6EGQdBHxj6kq0ycE60gn1W+xJPNNJFnZOiYjwYBv2mr88bvsYprtlmlIR8tQBvCExyrDIbzFOGTARVc0F/j1HPaxD6D12wonldRGqjS1cYFbhvlcoRgeCu2QYkGKx8ACskohjuauuB53vPPN8ber537vneyPO953X17D0DcxRE0TAXVsNcVt1rNV/tlnLVTcI6rhZqfNK1fvLrJKAIsFgY0i21KdE8CFY8MrdWaG2YFlI1/CJt4xTA81ZW7jL3czVSRRdk6JrQwyMtb+qb3XwFKvo6LDU+H0yKx2vzYj10VqSxAGmkVTHs0ixmB75GF2lpAZh7Kbpgg0RUURjDKMUJknZ+C4JQBXaBPaHgsx7T/DtQaLDKpm09yPnJWmTTDYzRwRoTp5UshPwd3Pc5cEkatgOSDhMzjKLNqf8zK5Rj+/BF2dXCITvI/blIX0fxX0L0M20dgaYvnVKdxGF2OCIdg3Vjfljdtw32wCdTmAUQnZ+Kvj5k0Y9ZIhri/Z2CBTCHN7TK3lzkaYDUtcEb1DPPbXVrm7hkin+XZuNSRz+4RAb4xnP/z3muRjIPDlFUtSZWdDRbz3Ba48nbw/FoSLqPjrrH7VNyhQbJs84xaRVMEFQVuiZjKApNIl1ia0d2O0cdnKtz2ul2esB3Qi1ImHLFQxofNHJSKxIh6ppApPMOl8KZYnn+Kjgw3JVnzswGGh1HtH/3dHZk+jOObuKSildRub4iZoTFLFSpSHjoEhj6G1SplE8zuF+2F1GR1kX2rD0aDA76BE3GqwnpGpPxzJqMjzrHiPZBkrBbMvAd2N6Oz0lw1DkB5D8+6fbOOt3Osb49lI9BEyqOiVqkzEREzQUoY6FbrsgN88D4CLyh5gbt83TzdvaKzbmMqUbcvRURKOjwydxmpmuwSoAQyXH37KzdJTReLSiYyiJi6EMFo3c6gTLCQlWakHcJ3n+ja2Nil/B1MXnWftQ5bh+dIrldQBAXyHqi8tsLa+HUxNtAcylK7/LtZIS5oUwtdExlXBJN+207S+hyyueZyGRVtBlMwPzwfUgkrkJa+UZODspJJapFtJiRlAHubxiJOEZjMi4XLMJgueyQgbmJ0zs6uf8SQHnPYfLPkVntEo4YbgmI/KvBMz/8p0ZLXBDAQ/DSjAs42SzBW6YYglLFRVyXbThEWLBEl4PYskm4HZjsHXTIOwkYfHc5Jq3L50Ny/PjR2YEWoHBrnd3iddPikeOD/wqRC6VWsn94uF6vO+bbjmSHMV0fQj0UVJDXYvON3LWDAnedwqe7T/t4tFVx16rLkwMtA42ockpQtPtQky33OXSJqK7qBlW0pC8A0hpD33iCM3ZFriYVsCRRJARbsQHGXxNygwMUrabWUTZQULAN+XAve5fMxoyGNZBe68vfck/9VLPo8uerR/g8D2nVjTp/ZzAMrXJatWZntheDMezmEAMtla70kVtg1iKeBoZcYebDSUYCLjQKjOc5Nagzftshg8SJa5Uj7mDHd5yoUNXYh9u9Mi+IHcJGOuZivdTGCYxgaSrS1/nX9mYQBIUQA3W1hgZd3cPZYnsD265KhQt7PAAm31c98Pmrn7DG51c8VBFAexi2IFb+LBrUdlGZBHUgWBOPthNz/wGqD3S5EHVJCDltGcVDd55vHPeN475xXDPHNcUxWsFSit+glMb0hbjfN6tQboc856np4pFTM9Jpy8ZoS8EVE3mBbBGLdBhne5jmALelybbqu1bdXFgzlxlgcOTGQ+PIeoWEmybYEQa+N2TW5N9bR7XBNtghxBpo4Ctycc798t2prXFRJPuVmbum8N7D0ngPyeKNsBOPTVThDQ6krfsydag5TKLpFZdqZNNM+2mNq6Ynm4zs7bks04ZmS5WCSWthDbvbFQe9Y9yBhAI/7RayiAwHHfJhwU1jkWIhvHUIpW5UM6RFqnN3yFFRTRrFqazSI00bnkAvork1EVroQz3FVQkALslUZHCwoplmSwsvaFQoqWISqI+HgAXY+XQ2wXqt4KBfzmLAT9BZSu9YR2B1jlQLlJRRKZKASDAj1gt9XxNbWigBSchW7r0AGuF6lJ4JUnWA5XcpzztKGB/BVsdaQPVxvrt8ZX+pHR1F4q769ikLoUozglIpLjFw+tZKrryGQgdiBVRpA3ekpn0MUL3uYADdvkoXl/JLXBpBpt6772ynVQUSoqmmOM38akvVrJ9uBrllJ/o89HBb+zfjyZylpeK/BjK3sy2pChcBaS3MtZAtHIHDTNlKAa0aKLsTvswL7bR/Bz8/2wSktV4IJCGel7XqeZdYsTVlxnetmysGV/tkjeshAOv+h2J5qOJDN9YmO7dLvLxjEPx1C9iwjOuWe5VSMjyW+6fFiI7lqr2G4zHsNRIPp2mkrobz+h7cN2vDue3cro6bHLV7Pbe+Eed/1lifWYPEMHNjlL16CUNLij2mrZgPdo09AzD31jmQFmhJlxeaVMLBzhK2fF7UeJ9lGNWvtOu8Aq92Lim3QsF1iwxLUYyNVXuYsGEoKFo/T4bnAJQtUMH8Sx5hnuUt5lAJFjPq4jArborKEec2IFql2BmvbypNzCCQm5GNbuva36LUsbytxhQCrr2f6n/JNqj9G9W9g5/8mpKz2Upjvfv2riupahpzV9O8Ul2T6cXHVe3up9MtRWtBG7ATSWJazdUa2YDqY7BSXUbue3fL6R1Yt3xcq6bATGnjmVrA7YsNaVlUIUkMB4c/DwvH16B+ntJEsQhSSU2oyu/64s2G5gVRSxdJn5zmUf26PzAag00BXf7cm1OWXZvYBhU52NPb2CcRql3FV7lBoqQbkgio5NV95swgIA4a6zCnFQOVzRsDxrd5haKnqS5Nc5q7rak2BZGYWEQ2+kK2TYjmEIJ0dCH2fM+AVU6JFgNAXelJm3XEPRLUKbbHaYoK+yZxuG0bdRXTLauYiCnK4wfAByEYGirjJs3t3RRtPtebATYTeu4S1Sh3vWBo1VV/tWfnzocmb8nQtpQJxFbGw897cQIQ/A9GBtfpHWbVFtnP4QQ+l5KqFeh+qG/B5grgUUsvOpeK5tsYG9L0yfDNP8eJYpKTF6nIVkDkBfSjAtoJ8NlwQF4ck9FwSFooL3wrIPwK+mZkfHVQjw0YGefSbE4ceyj8t7Yf1XZ1cF+fVei2a4IrusZdh0YalU4eBtipKwyjzPKWtnk9GFoLGAXY78p+kunrKzM3VBCxGU+4TtgAyWLaOVFW3BU/ImmWb03ojn7WCcKTKffEc1rDOldHB83r6xw0xINQ6EGIAKWDhG3T2BZvlwJjKOThW4NVLXNtF9384jEITCdm0nQjSVOJbMip57CeF9hwEA5X1+YYOqrc5L8P21sQ6jJ6D3uxFQfyUAi+9lBdGLq1NGgjQrYD+inva7ZFh+zlZ1RuW1qF7F7nwlueRr80q42jstrQnTT+PKhcdRdTmbv4D4OvHvfEyjFs6+B068j7O7jtAPxCFBYX5fXNdXO3rPkKVtM9p/pFmKZ7INvuN2yJ4Bk3x1r1LoW45/JpGxb0TqA5zycM2us7qMAV8NfJ0ZEuh9mzs5e7AiZLhiKCbeLnc+eMP/k1OVuWFsXTTfyZH/nJ0dFdw/QNZOhUPVPI5qwyBc0x6JIpiCbojmh1WW8LMcCcuqExj8pl2dW+x1jnV27ZDk/rRjWN/fFF0UhonYpkrltM2loPHZWutjwvpjQXnbFK31hINHHbQLoNWMHMwHsSuuv6hdN/VQdAIXZpFa29a6DzkywBbo3MDW8nomrzMFI55n4eUsWrUptiQm0A2LidvgGHwT3bJEk3HCgBbhNs2p7Eyxi5zV5+LwPe92joJw1CokrX3b8xXb9LjM39B3ouVdSc/I1Rc1UlKsM2lRa3aIaNz5sI6/E37JWxh9kxesuX2dKxnDWjuy5CjZ9tkyDnTRe2PLbUF7x8Aqd/a5UFLiJ2soWYEUsJLtOAo+O/MY6uSq33GiJ/qPNuKEcLtYnCvq+HlceJzGYzHnLM/yqR0jnTEaofJ6/rXbiK9YyASYVYGm3uNDCFGIPpUVSdoRT4gjX03YZK332MUCxoGq2h4kWyMMNIy1JE+lKC0aP1VmEVhx16x1b6ldliGsw9XtU2umNfl5jLI1mCet12+Jakdb2UaEVgS8TVgibaEcVbDfnLYYollgAcLNAJyACnh8rrGbifRXHPmprEs9PcEdqBXzKVbtqDmWJpgC2OzNVMaNHk2ho6qkCmbGZXwxvjKTNvkGk6C23B5DnMphOz+Uy1aECE2W715Iv9mjva9WOrnZNPIhYz1bBIraG6RTJX7koT6IiRO/rQGFPldQuEAvrgT54SsIHhy35hEUKvg+A55WA5KoGdJ90f+2Q32XQ6HWuNRmwVi2Y1YeL/7kJmNAzFd4Kc2zubdjAQZGmS8Tl5wqOnfb1mcY3JmKizLZZl06pN48y82FZeZLYQQNf8htirXwpL4fiuLiRVU8VUWjBv8ZaI/J0bcKYbpnwyZSG1MZtSt0/lvKFDN4qD2hUsYwJX295Kdy9E/C2UgzOktPzp0fdNK3j/y2LOq7nomBbWQh0TeYMVhxa6/Y8YpVV0LuFYzFtyTBcL0tJMcfJ+eOD52HbsNU3oHGPWcEpLphYC2pCvBIYUVhQasnqHN71DHTQ8NOzU1kR2CL1DeQS91dvLfCZ83YOnU/4I7seqzjxnS2EMFQhWpLFTTBCxpWjTFe9wjFx3OHQmrU5wkYoo0xm8LdPcN8NE0Tl4slsel/rnKiCfCqxPgA80+VrcF0WS+gvfg5485ticLvrGB7N3HCrvIrwY65i2LdV3tK7O+RpZGJTmyZuILSHHOsXbTzN+C6/YwTi7hpHgHUPTi0qllMeIgxUNwSZgnXmnMm2fmAexiTygA3q2Pg105gBkwmXxpqVRwVKlpvblPrNf+f6Ehib45bdt7O54D2cwE9bopSHKNbbEZJcnsxW0tPmf4oRz4PiL4qsyabhUVTm7/CFrZmJTKwFIUdhGKEYGKV0JMnoKRMh77C+DNxWLqkuJiSDEUest8u5Yq6nmBy/cQHXO7xcH+H41EYpYGvMS6EwHd6RRNH8YRa+Evt3nY09iv2h9s8m1aeiAl0mkIUWTiKaRbON+OU0UmUFxpqY/g2mE9sPxkLwfQhPPqwOfjEdXz8nkvP3ThyvyfqhXg0tztvp1eS7CQ6znLZIAOrKMqYaYhyyR7ntBBisaLhjpdY5qRwd3lSj+3BHp/NA8Kw9fjYejN5NRG565K4ogiuMEZEWmyNOyrXmfhY4+Q98L/eIXIdWSJg48w/ydn1Vedxyxb68g/fYK0m+vIP32CtJvryD99grSb68g/b/3ClJj2EOY43AVQ6L3zhgXX4yX9NG76WnvecaxJrDkKem3mCZ4C6rsLekvJLhfC/C6+h+9L1+gbeu7NL67g68/ZyxFzw7eqJBynT3/+Cl3CNHBwreseENtT7TN1R7zjqm6Hw/+kH5igJ1hdo51HcOLt5Mrz/em5r2qS3SavZSuod0+XXt971fvVw93mxdZ4PdfvJgm8wxLbTw9751pPlB2nLSdZD44Jao02ThQVn0ovRl8HZe/5ZEnoKRfss3TfLj+ZesDud+mR8OZQ6r8P0l88SY=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create key</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/keys"}></MethodEndpoint>



Adds a signing key to the organisation in one of two ways:

- **Create a key** in a key store that can create keys (capability `create`: `local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`). The key is an ECDSA P-256 key with the algorithm `ES256`, and it cannot be exported. All fields are optional: without `keyStoreId` the wallet uses the local key store that takes new keys, so the empty body `{}` creates a key there. The API never returns the private key of a key.
- **Reference a key** that the provider already has (capability `reference`: `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod` and `csc`). Give `keyStoreId` and `providerKeyRef`. Get the references with the list provider keys operation. The wallet reads the public key from the provider. For every type except `csc`, it also signs a test message and verifies the signature. For a QTSP key (`csc`), give the PIN of the CSC credential in `providerSecret`, or leave it out to use the `userPin` of the key store. For a key store of a provider with `qualified` `true`, the wallet checks the leaf certificate of the credential against the EU trusted lists and returns the result in `trust` of the key.

What the wallet makes when it creates a key: `vault`, a Transit key `ecdsa-p256` with the key ID as its name; `gcp-kms`, the crypto key `ows-<keyId>` (purpose `ASYMMETRIC_SIGN`, algorithm `EC_SIGN_P256_SHA256`, the protection level of the key store); `aws-kms`, a key `ECC_NIST_P256` `SIGN_VERIFY` with the alias `alias/ows-<keyId>`; `azure-key-vault`, the key `ows-<keyId>` (P-256, the key type of the key store); `dpod`, a P-256 key pair in the partition with the label `ows:<keyId>`.

Give the key a name in `name`, for example what it signs. The key list and the dashboard show it, and the update key operation changes it later. The wallet refuses an unknown field, for example the removed `vaultType`. A sandbox organisation cannot add a key.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The key store and the name of the new key, or the key store and the reference of a provider key.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"keyStoreId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 64 characters`"} schema={{"type":"string","maxLength":64,"description":"Key store of the key. Optional when you create a key (the default is the local key store that takes new keys). Required when you reference a provider key.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Name of the key, for example what it signs. Optional, at most 100 characters.","example":"PID issuance 2026"}}></SchemaItem><SchemaItem collapsible={false} name={"algorithm"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ES256`]"} schema={{"type":"string","description":"Signature algorithm of a new key. Optional. `ES256` is the only value.","enum":["ES256"],"example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"providerKeyRef"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 512 characters`"} schema={{"type":"string","maxLength":512,"description":"Reference of a key that the provider has, from the list provider keys operation. Give it only to reference a key. For `vault`, the name of the Transit key. For `gcp-kms`, a crypto key version of the key ring of the key store (`projects/<project>/locations/<location>/keyRings/<keyRing>/cryptoKeys/<key>/cryptoKeyVersions/<version>`). For `aws-kms`, a key ARN of the region of the key store, a key ID, or an alias (`alias/<name>`); the wallet keeps the key ARN. For `azure-key-vault`, a key ID of the vault of the key store with its version (`<vaultUrl>/keys/<name>/<version>`). For `dpod`, the label of a key pair in the partition (1 to 128 characters, no control character, no `/`). For `csc`, the ID of the CSC credential. A reference of another form gives `400`.","example":"signing-key-1"}}></SchemaItem><SchemaItem collapsible={false} name={"providerSecret"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 256 characters`"} schema={{"type":"string","maxLength":256,"description":"Write-only secret of a referenced key, only for `csc`, the PIN of the CSC credential. Optional. Without it, the wallet uses the `userPin` of the key store. No answer returns it.","example":"<yourPin>"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The service added the key and returned it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the new key. The value is the same as `jwk.kid` and `key.keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key of the new key in JSON Web Key (JWK) format.

</div><SchemaItem collapsible={false} name={"kty"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type. The value is `EC`.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve identifier.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier. The value is the same as `keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm for the key.","example":"ES256"}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Public key of the new key in JSON Web Key (JWK) format.","additionalProperties":true,"properties":{"kty":{"type":"string","description":"Key type. The value is `EC`.","example":"EC"},"crv":{"type":"string","description":"Elliptic curve identifier.","example":"P-256"},"x":{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"},"y":{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"},"kid":{"type":"string","description":"Key identifier. The value is the same as `keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"},"alg":{"type":"string","description":"Signature algorithm for the key.","example":"ES256"}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>key</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One signing key of the organisation, with the key store that holds it and the DIDs that come from it. The answer has public key material only. It never has the private part of the key, the reference of the key in the provider or a secret.

</div><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key. The wallet makes it, and it cannot change. The value is the same as `jwk.kid`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","nullable":true,"maxLength":100,"description":"Name of the key, given by an administrator when the key is created or with the update key operation. `null` when the key has no name.","example":"PID issuance 2026"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyStore</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key store that holds the key.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store.","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the key store.","example":"Local vault"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`created`, `imported`, `referenced`]"} schema={{"type":"string","nullable":true,"description":"How the key came to the organisation. `created`, the wallet created the key in the key store (also in a cloud KMS or a DPoD partition of the organisation). `imported`, the import key operation imported the key, with or without a certificate chain. `referenced`, the key was already in the key store of the provider, and the wallet signs with it there.","enum":["created","imported","referenced"],"example":"created"}}></SchemaItem><SchemaItem collapsible={false} name={"algorithm"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Signature algorithm of the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the key. The wallet signs with a key that has the status `active`.","example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"isDefault"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the wallet signs with this key by default.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key in JSON Web Key (JWK) format. The service sends only public members. It never sends the private key member `d`.

</div><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type. The service always sends this member. The keys are elliptic curve keys, so the value is `EC`.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve identifier. The keys are P-256 keys, so the value is `P-256`.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier. The value is the same as `keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm for the key, for example `ES256` for a P-256 key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Certificate chain of the key as it is stored, in leaf to root order (for a test certificate, the leaf and the test root). Each item is a base64 encoded DER certificate. The service adds this member only when the key has a certificate chain. The `x5c` header of a signature and the mdoc `x5chain` have the leaf and the intermediate certificates, without the trust anchor.","items":{"type":"string","description":"One base64 encoded DER certificate."}}}></SchemaItem><SchemaItem collapsible={false} name={"x5t"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-1 thumbprint of the leaf certificate. The service adds this member only when the key has a certificate chain.","example":"<base64url-sha1-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5t#S256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-256 thumbprint of the leaf certificate. Note the `#` in the member name. The upload certificate chain operation gives the same value as `x5t_s256`.","example":"<base64url-sha256-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c_expiry"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry time of the leaf certificate, in UTC. The service adds this member only when the key has a certificate chain.","example":"2027-11-21T10:00:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dids"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"DIDs that come from this key.","items":{"type":"string","description":"One decentralised identifier (DID)."},"example":["did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ..."]}}></SchemaItem><SchemaItem collapsible={false} name={"hasCertificateChain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the key has an X.509 certificate chain. Then the key can sign with the `x509` format.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSource"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`uploaded`, `imported`, `test-ca`, `qtsp`, `null`]"} schema={{"type":"string","nullable":true,"description":"Where the certificate chain of the key comes from. `uploaded`, the upload certificate chain operation. `imported`, the import key operation with a certificate. `test-ca`, the built-in test CA (the create test certificate operation), for development and testing only. `qtsp`, the certificate of the QTSP credential. `null` when the key has no certificate chain.","enum":["uploaded","imported","test-ca","qtsp",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"testCertificate"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` only when `certificateSource` is `test-ca`. The built-in test CA issued the certificate, which is for development and testing only. Wallets and verifiers outside this platform do not trust it.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificatePreset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The preset of the certificate chain of the key (the list certificate presets operation). For a test certificate, the preset of its request. For an uploaded chain, the preset of the newest CSR of the key. `null` when there is none.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>certificateAssessment</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

What the leaf certificate of the key allows: its key usage type, the credential categories that it fits, the mDL Document Signer profile, its QcPSB statement, and the texts of the save check for each category. The wallet reads the certificate chain of the key. A key without a certificate chain, or with a leaf that the wallet cannot read, gives `keyUsageType` `null`, empty lists, `mdlDocumentSigner` `false`, `qcPsb` `null` and texts such as `An EAA needs a seal certificate of a legal person. This key has no certificate. Request a certificate with the preset EAA provider (eaa-provider).` The texts do not count the trusted-list exemption of the key: an exempt key is never refused.

</div><SchemaItem collapsible={false} name={"keyUsageType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`A`, `B`, `C`, `D`, `E`, `F`, `null`]"} schema={{"type":"string","nullable":true,"description":"The key usage type of the leaf certificate (ETSI EN 319 412-2 clause 4.3.2, table 1). `A`: nonRepudiation. `B`: nonRepudiation and digitalSignature. `C`: digitalSignature. `D`: digitalSignature and keyEncipherment or keyAgreement. `E`: keyEncipherment or keyAgreement. `F`: nonRepudiation, digitalSignature and keyEncipherment or keyAgreement. `null` when the certificate has another key usage (for example with keyCertSign) or no key usage.","enum":["A","B","C","D","E","F",null],"example":"B"}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategories"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits (the list credential categories operation), without `none`. A PID certificate fits only `pid`, and a PID certificate with another key usage type fits no category.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategoriesForMdl"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits for an mDL configuration, without `none`. The rules are the same as for `fitsCredentialCategories`, but `eaa`, `qeaa` and `pub-eaa` also accept key usage Type C. A key signs an mDL configuration only when `mdlDocumentSigner` is `true` and the category of the configuration is in this list.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"mdlDocumentSigner"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the certificate has the Document Signer profile of ISO/IEC 18013-5 Table B.3 (key usage `digitalSignature` and extended key usage `1.0.18013.5.1.2`, both critical). A key signs an mDL (doctype `org.iso.18013.5.1.mDL`) only with this profile.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` when the certificate has no QcPSB statement. A key with this statement signs only the attestations under its law (`legislationIdentification`, `countryOfLegislation`) and from its authentic source (`authSourceIdentification`), ETSI TS 119 412-6 clause 8.3.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>categoryMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for a configuration that is not an mDL. `none` is always an empty list.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mdlConfigurationMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for an mDL configuration (`mso_mdoc` with doctype `org.iso.18013.5.1.mDL`) of that category. First the category rule (with key usage Type C also allowed for `eaa`, `qeaa` and `pub-eaa`), then the ISO/IEC 18013-5 Document Signer rule. `none` has only the Document Signer rule.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustedListExemption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trusted-list exemption of a key: the certificate of the key is in a trusted list, or chains to a listed CA. While the exemption applies, a rule of the signing key check that the key does not fit gives the check result `exempt` and no refusal. The exemption is bound to the leaf certificate that the key had when the exemption was set (`leafSha256`): with another leaf, `applies` is `false` and `reason` says why and what to do (`null` while it applies). `listUri` is the source of the exemption: the URL of the trusted list, or a text, for example a recorded decision. Only the platform operator sets or removes it; the API cannot change it. The other members: `listUri` (the trusted list), `service` (the service of the list), `certificateSha256` (the SHA-256 fingerprint of the certificate of the list), `match` (how the certificate of the key matched the list), `setAt` (the time, in UTC) and `setBy` (who set it). Each of them can be `null`.

</div><SchemaItem collapsible={false} name={"listUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"https://example.com/tl/eaa-providers.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"service"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"Example EAA provider"}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"leafSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"match"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"setAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"example":"2026-10-22T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"setBy"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"applies"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the key in a qualified signature creation device (QSCD). `false`, or `provider` for a key of a qualified trust service provider (key store type `csc`): the provider decides. The value comes from the key store.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trust</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The qualified status of a key of a key store of a qualified trust service provider: its leaf certificate against the EU trusted lists. The wallet checks it when the key is referenced and when the connection of the key store is tested.

</div><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","description":"`qualified`: the certificate chains to a qualified certificate authority (service type CA/QC with the status granted) on the EU trusted list, and it is a qualified certificate for electronic signatures or electronic seals whose private key is in a qualified signature or seal creation device (QSCD). `not-qualified`: the trusted lists say no. `unknown`: the installation has no EU trusted list source, a list cannot be read, or the key was not checked yet.","enum":["qualified","not-qualified","unknown"],"example":"qualified"}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the check, in UTC. `null` when the key was not checked yet.","example":"2026-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The facts that gave the result, for example the certificate authority and the trusted list, and whether the trusted list or the certificate says that the key is in a QSCD.","example":"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The number of credential definitions and presentation definitions that sign with the key. Only the list keys operation returns this member. A credential definition counts once, also when several of its configurations or its status lists use the key. The read key usage operation gives the details.

</div><SchemaItem collapsible={false} name={"credentialDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of credential definitions that sign with the key.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of presentation definitions that sign with the key.","example":1}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Creation time of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Time of the last change of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keyId\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"x\": \"<base64url-x-coordinate>\",\n    \"y\": \"<base64url-y-coordinate>\",\n    \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n    \"alg\": \"ES256\"\n  },\n  \"key\": {\n    \"keyId\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n    \"name\": \"PID issuance 2026\",\n    \"keyStore\": {\n      \"id\": \"local-openbao\",\n      \"type\": \"local\",\n      \"name\": \"Local vault\"\n    },\n    \"origin\": \"created\",\n    \"algorithm\": \"ES256\",\n    \"status\": \"active\",\n    \"isDefault\": true,\n    \"jwk\": {\n      \"kty\": \"EC\",\n      \"crv\": \"P-256\",\n      \"x\": \"<base64url-x-coordinate>\",\n      \"y\": \"<base64url-y-coordinate>\",\n      \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n      \"alg\": \"ES256\",\n      \"x5c\": [\n        \"string\"\n      ],\n      \"x5t\": \"<base64url-sha1-thumbprint>\",\n      \"x5t#S256\": \"<base64url-sha256-thumbprint>\",\n      \"x5c_expiry\": \"2027-11-21T10:00:00Z\"\n    },\n    \"dids\": [\n      \"did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...\"\n    ],\n    \"hasCertificateChain\": false,\n    \"certificateSource\": null,\n    \"testCertificate\": false,\n    \"certificatePreset\": null,\n    \"certificateAssessment\": {\n      \"keyUsageType\": \"B\",\n      \"fitsCredentialCategories\": [\n        \"eaa\"\n      ],\n      \"fitsCredentialCategoriesForMdl\": [\n        \"eaa\"\n      ],\n      \"mdlDocumentSigner\": false,\n      \"qcPsb\": {\n        \"countryOfLegislation\": \"SE\",\n        \"authSourceIdentification\": \"cn=Example Register,o=Example AB,c=SE\",\n        \"legislationIdentification\": \"https://www.example.se/law/2026-123\"\n      },\n      \"categoryMessages\": {\n        \"none\": [\n          \"string\"\n        ],\n        \"pid\": [\n          \"string\"\n        ],\n        \"eaa\": [\n          \"string\"\n        ],\n        \"qeaa\": [\n          \"string\"\n        ],\n        \"pub-eaa\": [\n          \"string\"\n        ]\n      },\n      \"mdlConfigurationMessages\": {\n        \"none\": [\n          \"string\"\n        ],\n        \"pid\": [\n          \"string\"\n        ],\n        \"eaa\": [\n          \"string\"\n        ],\n        \"qeaa\": [\n          \"string\"\n        ],\n        \"pub-eaa\": [\n          \"string\"\n        ]\n      }\n    },\n    \"trustedListExemption\": {\n      \"listUri\": \"https://example.com/tl/eaa-providers.xml\",\n      \"service\": \"Example EAA provider\",\n      \"certificateSha256\": \"string\",\n      \"leafSha256\": \"string\",\n      \"match\": \"string\",\n      \"setAt\": \"2026-10-22T10:00:00Z\",\n      \"setBy\": \"string\",\n      \"applies\": true,\n      \"reason\": \"string\"\n    },\n    \"qscd\": false,\n    \"trust\": {\n      \"status\": \"qualified\",\n      \"checkedAt\": \"2026-10-21T10:00:00Z\",\n      \"detail\": \"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT).\"\n    },\n    \"usage\": {\n      \"credentialDefinitions\": 2,\n      \"presentationDefinitions\": 1\n    },\n    \"createdAt\": \"2026-10-20T10:00:00Z\",\n    \"updatedAt\": \"2026-10-20T10:00:00Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The body is not valid (for example an unknown field), `providerKeyRef` is given without `keyStoreId` or has the wrong form for the type, `providerSecret` is given for a type other than `csc`, the provider has no such key (`Provider key not found`), the key is not an enabled P-256 signing key, the test signature does not verify, the key store cannot create or reference keys, the provider refused the request, or the organisation is a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key store with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div>

The organisation has the maximum number of keys, or a key of the organisation already references this provider key.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The provider of the key store is not available.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"507"} value={"507"}><div>

Insufficient Storage: the HSM partition of the key store has no room for a new key. This is the partition of the installation HSM (the local key store in a hardware security module), or the DPoD partition of a key store of your organisation. The text is `The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.` A new try fails the same way: the answer has no `Retry-After`, so do not send the request again before room is free. For the installation HSM, the operator of the installation removes the unused key pairs or gives the partition more room. For a DPoD partition of your organisation, delete unused key pairs in the partition or give it more room. Some operations put the text after their own text: the test CA (`Failed to make the test CA: The HSM partition has no room ...`), the deploy of the organisation wallet (`Failed to deploy the OpenID digital wallet for organisation ID <id>: ...`) and the create of a sandbox organisation (`Failed to deploy sandbox organisation: ...`). A route that signs can also give this answer for an organisation that has no default key yet, because the wallet makes the default key the first time that it needs it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 507,\n  \"errorDescription\": \"The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create test CA
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-create-test-ca

---
id: config-digital-wallet-open-id-create-test-ca
title: "Create test CA"
description: "Makes the test root CA of the organisation for one trust domain, with a country. For development and testing only. The organisation has one test root for each trust domain (`mdoc-iaca`, `provider` and `access`, see TestCa), and a second create for the same domain gives `409`. The first test certificate of a domain also makes its root, so use this operation to choose the country before the first test certificate of the domain."
sidebar_label: "Create test CA"
hide_title: true
hide_table_of_contents: true
api: eJztW3tvG7kR/yrE/iUBq4cdJ9dT06CKpLS6y8Wu7VyAJkGX2h1JrHfJPZJrRTX83YsZcl/S2nGLa4siZwSxvEsOh/P8cYa6CxIwsRa5FUoGk+AnfgOG2S0wC8YyrZRlsylTa3qm9IZLYTgOZmulmZLArC6MZYnKuJAh2wm7ZZzFqpBW74fsjdIsgVtIVZ6BtIzLhEgLuWFKpvshuz4kvOXGEa44wKWAx9vWWqwXZYmKB4LHPApZlGt1KxLQEa0R8TgGY6KQGQB2DcbOeD+kV5wZiJVMWKyBWyDquDvDMyhpb8QtGBadjb+PHIdroY11LMWgrViLGOeqNePlHJ4axTISoLCGOA+ZUawwwOxWGKZy0G6LVrF4qxS9gFJYbAVrpd2jh5fDt27B4Sf5SV435vu3uPAE3w1YQ0ITFvlxEROGafilEBqSIVtenY+Wixk7+d345NngOZMAiakFUhLvzfpMSHo+V3FByrwSGwk6LJ+TrnrL6WzaJ0H7x8gDi4QxhZCbv5VMOF1U04RhtzwVCWnje7YHrs2QttCt14PtKDJgng7ZB2G3qrBM2LCmvgFrWqL2opKwQxGnwNctOdstt4yj5SPb4Lji7Ab2Xa4QMkgNsGjxPiKdTJnhMlmpL227jrmUypKFMO50O5sOP8kgDCrLWCbBJIiVXIvNXGyE5ekHnqZgz3OQy2RGBuuMOQgD1CEY+1ol+2Byd+DJaBgtdynF3WEtQ08MDSKYWF1AiExYkBYJ8zxPUS5CydHfDVK/C0y8hYzjJ7vPIZgEavV3iG0QBrnG3VgBhpiixRvjjNVCboIwkEWa8lUK5YJfYb/JbqVkjkZTQNg0dNwMyCILJh+D6qnji+woCANnQ0GILHwOA/jCsxwZaYy/RwmQoP493ptu02AdrR49jj07efFicMJ4mm/54JTFKgH0lyLPQbOYGxiyS68RMr7GBlkPqR05VLkMuVusIQFpBU9NP6y8w1HqdigSWyWIq0Vwf39fPSFVIuElygbVX2QZR9kE6O6tpQ+igwnCgJTUtIaWYio5u1UbmmotVC9Tvjc+3eCzG6l2spR655IV1Xv6QYs3uZLGbe50fNLtQzvyP5bxBOq8OJvW4cuAvhUxMA220BISJsiffiX/sc7ZO8ZZYUlVVTho8z79agYPyRz+Y8nZfYj6Q7a4Bb13g3E6RtHC8A2w6Ab2M9AWLcVbY3z51v3Vi7WwIuZpP2QrbkTMYiWN1VxIa3BHpPqc2y1LQW7slo1bczgzBYmK1hPkDWuB2Yq7TCMsxUCfazwyuBicPn+BM9zWm15X8e9NcC1Sl//lUQoln+hdY4Rgr4cn/Qmbhew8ZLN3LHrZFOcrQia4m96782v25vySXVyez9/Prpfn7/pOJFy6JKQZTy1oya24BSYxN/dcPJeWx7bvOe72buLesC2/Bc/LEZ6rRcR2W5BMUFImv3LG/hD3F37Fh7eBUadr5pSYe3Ce25FPurzCCR5WpCrmKb01FmGTt3AhjeVpSssM2dKWaXcFDL7kSltIQr83fMyZERuJBv9Acme9enC5sjBkVQ1E16/jQVfORwgonKsouwXN8kLnyoAZHjm8SLoSTtu330vxSwFNjXnGS1DRiuXj1Yv17+CUD57FJ8ngDJ6vB9/z71aDk/g0eQZn6+f8xQrz3cOp+umpuRZDrsEg6tptCeYeIFnjVGAKMKwXuSA3dwGjjvJIoD9kLZiPb76ackKmgWOCIG6M5bYwTmvGDRg2/MTRrCleLOehj/ohW0ynROMv+KGRdyjwH9MtaVzNBz98uGY/z2jyh2cz/NjIyY5A/cB7uPExsDBWZdGwcYgRkuUpjysrrz3HP3Aj2yLufbi8mM4cFi915CBjJYcnY6VHYFK95NNsh/y4MYt2d7H4Cd0j43bIrpW3r8qkW9uirQjj44HEeA664QbCoKwsUgsZTzAhM24QchNRXtit0sLu214ywJ/Xiz8t37HZ4vJ6+WY5m14v6Okn+XLFDbw4GzT4GPgE/+qTpEGLd/OOiSggn4eeJpwyabV8yscdC18ohmT49vLNjJ09Pzlr72L27g8L9webvn40uYTnjZHh7A+IvcJAKvuaTqFd3Dr9BJMgwf1bkcFXofCV5braTDPttjb3/nrW3sbp+PTF4GQ8OD25PhlPxvjvr5696do6ZPgrcLeoHeNf4e3Z8y7eYp2+1+nTtPz+8m25UPPYqeFWOZzookpvdvm237J3ymgCjTkvVqmImVZFXRcoo9auPB4VdosBJvbZEJfm0uxAIw0Ke5dvcZPzxaX3PtaLmnA1vxFfBrFOo37oYkbCVvvGQWxBwO+BMkUDMQlDe+auNIKrJgLlsypot7kS0jr+3IaM5XvD+C0XpD6HSA7TOzM7YeNts2BFAXHdVtjW2txMRiMnnaF/MYxVNmrm6lELoSyTVyOP7EdIeRDz0UuXp/BVrNOD2Pfv6P4wEv7a2m3q5OtaBm0jjyIfCLpPgpeVsl3UErqOuExItz4qz2cs+GJBGgJaMV+6NNj/vzKFRv5zx8qykPIRwVyFq9qZsk4LzaDbiHBVQDmyss/3YbDjGkGraZgc15rvOy0uclzXVCLm56N0hIXMPHbAnNUTP7hpHYdNqZyN4bGLFLsuUm+NoQPakoHWSnvVehwiDEuUhGMYjAWRp/nTjXBRvNxSx3Yd3Kp8g1Cn0sxs1Q6drSN0rQqR2gFasDOlSZ2A0T/THdpk9chPKs0JvQSx60DdgtYiQQZ8peoQh/mDhSv5foGkPcqR+X1rhhtA3gsex+JJdJAJk3Ebb/1mm3tKFPjDzkYD1DUTR75cjA69kT+YDDQUBjpoxdsG4scj05aglSNVo38JOza7ugw7coP2NIo8VTxx86U/FRGVCR2XsMiA9KvyguesCVkPFU1W1JK8s6uWgPBRc5NtaHtE8j4MMjBYrnjiyahhEN4kQ18+zkEbJdsRaf7V8suhKZY2gyFU7h2ohYQAg5O/C27uLFEiY8NUYY1IoI2PWaKc/REyFnbI5u6BP7DisUOrpIgpwxyFN3LSWj6f7w8H2LI2VcUrN2brjmfB5A7/OhuPncs/sWLWXIFiyszxQZ/nDY18Dr9SXatn17oV0sKGAnClpbPx+L6DfIc91Ip9zbEBkheW5VzzDGxZeTw0mrJQVlckOgtpE/IItWbV4SusDqShT6aI0ur+EBJsFrBK31ypxLmtVI0mSq/8OKl6Q1VnzNOraLnC00EBunUiT8oTuT9o9pG1VsfGF19IcM3FhXR9IJRs1Mdw4bPHQ1XzxtzHRjoe3Qy7U67SPsBKO0vBWjrVU6zxh6KrBfHsJdCulGHE62zx9KKrYlX5nwbHUZqqHSTU9HMdx7r7UwIu0km8hfjGsFhl0OwFln5Pr6mjiCVBLyaaWHUrx5HrQlYYiRBmq2vI4Iswlk7+h1548g174XvpUeo/IOkQzbNvWDTXD2Dt5BBrs170UMKqpuAwOhhQIbdRqo36XSb5/Tcu91Z04SmWNfdVE6J2boLRPl08Oq2KPIex/aX7/apTD8+/6QS9lNR2SanTB9odYzpk9K3HiCc0ZBpHEXcY60VvuEhdcqSLEY2QMmE/wp5lXPINOCzhO60leihLAt0m+91xP3cpTbFei1hQr8AqzTfgTnZ/vvoJt2gFcdk43riteLSklco8lscDjm8TYiTzXcFDCq294xq9rs4VHZu3XCc7hAwG4oKKJZlKihRqDDK/UPP2Erwt7b0qdMv1y2KOO7VSZGhv9JF9XUKmboEVsjCQ0Do5F9qw3k1mPKpjSudbLl0LhKAaApEDSWTIHC4wjNiUyCMOW3ORNi4Z7fh+0jyjl+j0EqzeD6ggEhHy8ecVA+XdIX8q5hsMYh400XaEYWsN4G6gdenCt0Cpg6d0p8Y0ycDxeSQIv91Dzdf7pZV5h9qO9BSyBFKwHYv4yn9juheysM2VrhAyVs1Iw9Bjq+oER/H5UhxeksCHk1buftwLHzeb4XBYHTsgT1V3E9Xfomgu5EfjULrdNGeJu/FUDqZuaZPIcs5eiuTVxK1ZX2hyoJr84QFUfrRq1zhPd8imvvJIt8DQ1A32cR2y9haORwBnquQ2sr0gTfRCSmDNi9TdQthjiWQFMS/8zb/qckl567I5unEPUGSeG2H9/bx/8ZLJ/3O2aQxpLf98/F3XCsH/OMwFRxUO7AH6oB5MPt4F01z8CPjx8z2Km2MZ92Pg7/uxD95VnFOc/TzrB2GAmfCnKhOiljKwW4W3BXNlSEvcboNJMLo9Hbn7gyPvTgNnZCOVgxTJ6Ab2gzqnlgVtrEcTujHEYTttziFTHvwEYVBgo6OqpCeQqQHPxVBsNJd2KFRwHx4SuKhqSA+R+RqFK8s3WCh4YLpxrw8Z+VwL/gpdwVlwKf66cu4ehAHdE3Oaw1I8z/Dt1J8LybWOK98XS7KarmZMq5YbtehEzC3DMiz1rKgW6wrAVJ2NHI8sYj0qrFM81lykJIOcxwgLYIjF7hbZCfMTX2KOQXEMbmD/KnKlOwwLl/Wd0UXtVU+4l4fSWasS4nLXz4aMC9SDKXK8WvPHWvaV+MSf6kdtpTX1fSDValJZ4qIyvUJ2sc2Av9F6eRNr+SSC/v0zVT2pWzSrL10w7C5xGQPrnZNjLV0O6Z54gYXkconKGS/6yJFVsUqNx35oASBxjvFZ4B8+C1vlmg0h26o0CeuC7L5KdY07IawwpF3LZcJ1Yga0X8GlZesUGxVkGV7SxK2/V9L74cN1P2TLxfWb+uKJWw0rYeWltGyu4lE2f9u8duK6cVQMSkUM0pA1lIaf83gL7HQ4PlLdbrcbcno9VHoz8nPN6O1ytnh3tRjgnPu6g1SrE4VV1gZLh8Ko49R+Oj49Gz4bnuBcDGsZlw1+3O3nEpccemLj6PXbtxh++xbDb99i+O9/i8GnUzxfjPIUE8q9Dxx3Hp58DG5PHWxdC2qftSCK+yKEpKZ5G6YgcQ9UPofBFhHP5GNwd4fXst7r9P4eH/9SgCZUhbe/tXDXfj5+rsAYIZsboLvkLlQMrpHj6rL4MYZGIOJm4IW73D46tgnKLs6vroMwWPmvZmQEWAPNd/hNC74LJsGn4FNAG6ZcQRgdn98FKZebgtqNgaOLqRvhRRux3BBi8R9wZ+Ur2bj+fgRe3Gbwf9xa55SXGKN/hP2rarh78+CECjC50ah27PL9E+lO704=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create test CA</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/test-ca"}></MethodEndpoint>



Makes the test root CA of the organisation for one trust domain, with a country. For development and testing only. The organisation has one test root for each trust domain (`mdoc-iaca`, `provider` and `access`, see TestCa), and a second create for the same domain gives `409`. The first test certificate of a domain also makes its root, so use this operation to choose the country before the first test certificate of the domain.

The country of the root:

- `mdoc-iaca`: `country` is required. ISO/IEC 18013-5 needs the same country (C) in the Document Signer, in the root (IACA) and in the mdoc `issuing_country`, and the root is valid for 9 years.
- `provider` and `access`: `country` is optional. Without it, the root gets the country of the newest leaf certificate that a CA issued for a key of the organisation, else `EU`.

A sandbox organisation cannot make a test CA.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The trust domain and the country of the root.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"domain"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`mdoc-iaca`, `provider`, `access`, `null`]"} schema={{"type":"string","nullable":true,"description":"The trust domain of the root. Without a value, `mdoc-iaca`.","enum":["mdoc-iaca","provider","access",null],"example":"mdoc-iaca"}}></SchemaItem><SchemaItem collapsible={false} name={"country"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The country (C) of the root, an ISO 3166-1 alpha-2 code in upper case. Required for `mdoc-iaca` (the `issuing_country` of the mdoc credentials), optional for `provider` and `access`.","example":"SE"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The wallet made the test CA, and the service returned it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>testCa</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A test root CA of the organisation, for development and testing only. The organisation has one test root for each trust domain (`domain`). Every root has key usage `keyCertSign` and `cRLSign` (critical), basic constraints CA with path length 0 (critical), a subject key identifier, a validity of 9 years and a P-256 key. The `mdoc-iaca` root has the profile of an ISO/IEC 18013-5 IACA (Table B.1): C, O, CN `<organisation> Test CA (NOT FOR PRODUCTION)` and an issuer alternative name (the contact). The `provider` and `access` roots have C, O, the organisation identifier when it is known, and CN `<organisation> Test Provider CA (NOT FOR PRODUCTION)` or `<organisation> Test Access CA (NOT FOR PRODUCTION)`. The key of a root is in the local key store of the installation. It cannot be exported, it is not a signing key of the organisation (it is not in the list keys operation), and the organisation cannot use it for other purposes.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the test CA.","example":"0b6f8e2a-3c1d-4e5f-9a7b-1c2d3e4f5a6b"}}></SchemaItem><SchemaItem collapsible={false} name={"domain"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`mdoc-iaca`, `provider`, `access`]"} schema={{"type":"string","description":"The trust domain of the root, and the presets whose test certificates it issues (`testCaDomain` of the preset). `mdoc-iaca`, the IACA of the mdoc Document Signers, readers and status list signers. `provider`, the CA of the PID, wallet, EAA and QEAA providers, the status list signers of the SD-JWT VC and W3C VC credentials, the credential issuers and `custom`. `access`, in place of the Access CA of the access certificates (WRPAC) and of the request signers.","enum":["mdoc-iaca","provider","access"],"example":"mdoc-iaca"}}></SchemaItem><SchemaItem collapsible={false} name={"certificate"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The root certificate, in PEM format. To trust the test certificates of this root in a verifier of this platform, add it as a trust authority.","example":"-----BEGIN CERTIFICATE-----\n<base64-certificate-content>\n-----END CERTIFICATE-----\n"}}></SchemaItem><SchemaItem collapsible={false} name={"subject"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The subject of the root, in the text form of RFC 4514.","example":"CN=Example AB Test CA (NOT FOR PRODUCTION),O=Example AB,C=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"notBefore"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Start of the validity of the root, in UTC.","example":"2026-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"notAfter"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"End of the validity of the root, in UTC.","example":"2035-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"crlUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the certificate revocation list (CRL) of this root. It is a public route of the wallet, without authentication. The answer is the CRL in DER format (`application/pkix-crl`), signed by the root. Each test certificate of the root has this URL as its CRL distribution point. The route stays available when the installation switches the test CA off.","example":"https://wallet.example.com/organisation/<organisationId>/service/test-ca/<testCaId>/crl"}}></SchemaItem><SchemaItem collapsible={false} name={"certificateUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the root certificate. It is a public route of the wallet, without authentication. The answer is the certificate in DER format (`application/pkix-cert`). The test certificates of the `provider` and `access` roots have this URL in their authority information access extension (caIssuers). The route stays available when the installation switches the test CA off.","example":"https://wallet.example.com/organisation/<organisationId>/service/test-ca/<testCaId>/certificate"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>warnings</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The `test-certificate` warning.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`test-certificate`, `preset-override`, `profile-mismatch`, `purpose-reuse`]"} schema={{"type":"string","description":"The kind of warning. `test-certificate`, the answer issues or shows a certificate of the built-in test CA: the text is always the text of the example. `preset-override`, a value of the request is not the fixed value of the preset; the request value applies. `profile-mismatch`, the certificate does not agree with the preset of the key. `purpose-reuse`, the certificate chain of the key has a preset, and the new CSR, test certificate or chain upload has another preset: use one key for each purpose.","enum":["test-certificate","preset-override","profile-mismatch","purpose-reuse"],"example":"test-certificate"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The text of the warning, for a person.","example":"Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"testCa\": {\n    \"id\": \"0b6f8e2a-3c1d-4e5f-9a7b-1c2d3e4f5a6b\",\n    \"domain\": \"mdoc-iaca\",\n    \"certificate\": \"-----BEGIN CERTIFICATE-----\\n<base64-certificate-content>\\n-----END CERTIFICATE-----\\n\",\n    \"subject\": \"CN=Example AB Test CA (NOT FOR PRODUCTION),O=Example AB,C=SE\",\n    \"notBefore\": \"2026-10-21T10:00:00Z\",\n    \"notAfter\": \"2035-10-21T10:00:00Z\",\n    \"crlUrl\": \"https://wallet.example.com/organisation/<organisationId>/service/test-ca/<testCaId>/crl\",\n    \"certificateUrl\": \"https://wallet.example.com/organisation/<organisationId>/service/test-ca/<testCaId>/certificate\"\n  },\n  \"warnings\": [\n    {\n      \"code\": \"test-certificate\",\n      \"message\": \"Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

`domain` is not a trust domain (`domain: one of mdoc-iaca, provider, access`), the domain is `mdoc-iaca` and the body has no `country` (`country: required for the domain mdoc-iaca (the issuing_country of the mdoc document signers)`), `country` is not a string (`country: invalid type`) or not an ISO 3166-1 alpha-2 code (`country: not an ISO 3166-1 alpha-2 country code (two upper-case letters, for example SE)`), or the organisation is a sandbox organisation (`Subwallets are not allowed to create a test CA.`). The body checks come before the test CA check, so an invalid body gives `400` also when the root of the domain exists.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The installation switched the test CA off (`The built-in test CA is switched off in this installation.`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div>

The organisation already has the root of this domain (`The organisation already has a test CA for the domain <domain>.`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The local key store of the installation does not answer (`Failed to make the test CA: Key management service is not available`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"507"} value={"507"}><div>

Insufficient Storage: the HSM partition of the key store has no room for a new key. This is the partition of the installation HSM (the local key store in a hardware security module), or the DPoD partition of a key store of your organisation. The text is `The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.` A new try fails the same way: the answer has no `Retry-After`, so do not send the request again before room is free. For the installation HSM, the operator of the installation removes the unused key pairs or gives the partition more room. For a DPoD partition of your organisation, delete unused key pairs in the partition or give it more room. Some operations put the text after their own text: the test CA (`Failed to make the test CA: The HSM partition has no room ...`), the deploy of the organisation wallet (`Failed to deploy the OpenID digital wallet for organisation ID <id>: ...`) and the create of a sandbox organisation (`Failed to deploy sandbox organisation: ...`). A route that signs can also give this answer for an organisation that has no default key yet, because the wallet makes the default key the first time that it needs it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 507,\n  \"errorDescription\": \"The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create test certificate
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-create-test-certificate

---
id: config-digital-wallet-open-id-create-test-certificate
title: "Create test certificate"
description: "Gives a key a certificate of the built-in test CA of the organisation, in one call. For development and testing only: the test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it."
sidebar_label: "Create test certificate"
hide_title: true
hide_table_of_contents: true
api: eJztff1z27ay6L+C4f1Ffk+iLX8lUXMyV5GdHp+miWvZzTm3zZQQCVmoKVIhKNs6Hf/vb3YXAEESkmWnfe/e13Y6E5kE8bHYXew3fgsSoeJCLkqZZ8Eg+FbeCsU4uxErxlksilJOZcxLwfIpK2eCTZYyLXsyY6VQJRsNzfO8uOaZVBz66TKZsTwTLOZpGrJ3ecEScSvSfDEXWcl4luDXMrtmeZauBtiB6U8qluUlyzPGsxUri6UqRcJSqcoufnnH01SUCn/fikJOpSgUy5elkolg5Uwqtkh5Oc2LOUty7As7YbIMf85+zi5hEXmygoE4G6niQnxZwtgdmMW1yEQByx2NL1i+gN8yz3a67E6WM1oogoqnLLrlqUxkuTrhKxWF7NIsoshh/gQWGjrJ5xxAQs8WhVCiZJ0IWo/4Cb6MzFtYaQ3w1Fw5s2FSqaVQ2NxpOWDRPMnjnuQxj9g0L7ABPDJ9dFnE41goVb3+dHE+HNkxAKhRQQDpKXmdiaKneNZLMhUR+KNFkd/KRBRVF3k5E4XpImSfZiJroQSbcdhXBzbcgKWLjWlb2VQWqmRzfiMUk6UFu1QszpdZWawGsIc9d6WEPpFaTn4VcRnqdhaeejVdJlIlCGTUwjTIxB3sWir4tAZ3nCInlFRLkeB6iTK8OI/9R6dXUYgTrOCEYNNwH/zhM3gCMPRkiSb0BhDooS1QgMX6G7Gi/cdeYBMdHMSJ26a3PIUX9REHGvPzqUxFgxDEPY/LdEUUhH3zJKGe+bKc5YUsV7homYisRIInnNGrbLyz0xxdvGeJVGUhJ0vEwUUuM6C7uEivirQCSp6XOyEbZjX6wUXxVOWIujyjBReMp6UoMl7KW8EyPhfEN+I8K3lcul122dn44+7Z6Yj1X+71D3pHbJhl4p69hbFc/MiLiizro9ZBIDNgakRO1J6J+1JkCh4g+GN+hpNUBJ/IQabmglnn9HJ8xk4/sIP+K3bY3+/ts29PP/QOw8Ow39vfod1QopA8ZdlyPhEFAQLxVJXs+JAVPEvyOZtI4CwG6rgCqRhyRzYt8jnrs7nMlqVgEzHNC0JRhCYNYr7IxK0o9Hd8WorCTraJpKrMC8P/ZsBZO3ZkMw3LiXfgKNEoPKiBZJwvi1hEMDSy4h5sOxIrMuaqoW5SLIVm84BwMcduMwZsssL+6P5o7xXyxjkvqXV0fxRHbCZ44iAnsmV4MzPMn2NPvFwWgs34raigCYckscJ8WTrHCs/iWV4ANsGEkFvgFtHiXU5yjcwdGA2cy13CMNwbiw8wg4xYueHLNViOhqwQt7nhDnlKhzjNsDO6eL9jJoKwqAsPtEs4oBlkNARKbO9GtFykOU9EEnVZJOeLvChFQkTypVSLCE4/VojpUolkwBKRCsMp9SBwgiDCNMkvE0KzFQV0a5iwJPQ4yeMliidjPPa65jkRy9lwNNxBgOjHtH+AxTK7/sXwWRJ2iI0kukN9jmrUwlcF4gKcqB5WjWvRUpDnsHB5FM7tGkU2OkOLDISqSPPZ3lyqOS/jGaBtzuJZnrePQE69OKRJZ3ALh/Ipk6WyyLE0XRUCzyojDhopRdOsdAQXWBUcYTdipQCOdJQhMVcEFPMFn8hUllIoFsXKAM6ZyghpZsCiNI95Cnhyy5dpCT+u40XvZg7CSsTvlP3572Uhejdi1aOG1GOyyJMIkFbxLJnk93WBJeZZZo45D0mFP2dBN7BLO0uCQRDn2VRen8hrWfL0E7KqjwuRnSUjhNFlnasE3WDBCz4XpShUMPjpt4YofpXJL0vhHmwaA27EKugGEtoseDkLugGcQ8EguBGrsyToBnDmykIkwQB4VjdQ8UzMeTD4LShXC2gIZ2J2HTw8fKbGQpVv82QFLepzuKxOacMM6se7iyCdSpjeqZiHlZeNuBx6ZgjHp8hKmABfLFLoT+bZ7q8KZvGbswCeph+nCCy9lBypJ+gGpSxTeFBNIuh6VlNNv86hgEiBdgqjDYzGFzsh+0S8LCIgIMXOBR6GSKaOhMOSXBDRAkGy0spRi0JMZZpagEzlvUgaYDQqwZYKACAtdtBiFk7njb69bALe9PJbURQyEVEXu+EZE0WRF468p1dI3eIGCUWwgQOJ6yG6tcZwZMZLVeZzfWhaWcWuGiRMXgB11aREh0bY0Eo/HWDAiYhlIhS7g2VfA8BlVuZNTAQMWxQALmAigDY0wTYFdINsmaZ8AphDmNjGGJkQtmg4bq2moUS5zG6y/C6DTmgDosO9vYh1NOwHtgH9/Q2yVVCd8yl77eyeTNSbaAcWJrLlPBj8FNwVCx73UnHN06Cr/0LpAf9eyKRnJEx4jczI80SVvFyqHqxGn1MwBOdu0y+NvxfLSa/xyHfgmcd02Jm/vAN6H8aFQNbH0x6J3oFlVg3VFBojpgVd2M7P3UDc8/kC2YF3Zg/dQB+7Dkr4OMl4aR628cJoH21OGLJTHs8YL0n1ECiVwaYiASFeVO+ezEdqZB2yCJYcEQ8wAziissjiPNE9mBnLjP0zPNrbY3mRgKRjBUEjFhiSyufzPEMtR6sDugOtzEdizmU6TJKCVNuFlk7xMShx8BxGM0LOMC0/QGfYIGqTqR7/6XQ60hPvjPDkAc2LHfSPj3t9xtPFjPf2GYAB5rJcLETBYq5EyM4yVOwctfLbQohYIPM6fa/FOZ6RtNeSED3SmRYIHa2ts15a3LEcttELSJuk+AQuLo9PEXNLXoqPxTlQXxaLpwNrXKI4ByYb6oJ1xpcAt5LNc1Wy/v5LkKULHoNksgUM7MJ+XRZSJTKGgSJ2ZwxBdjmGEGrLgsk+dAOU5WT5jM1/r79knffrV+EZkcS9f3Pq5qmjfnSFxc7HHXP6XUtVikIkZBzw2mnMFPePjtdNMTilX2z4NmhMladXmXzGWeZOmKdsmcmSdT5eOSA7Pqzt+zif+w9jkMwNrTviqeFkK3Zt1Ne6CVAU3p0nNvMBZdinE75lUawz+rB+MVdaXVm3K0AP+rESxa2MgYvfimJlTmAtsoJZct1ONamjuXNnFlZfiW4ux9pItWbyqF1FolRyvMpKfh9pc0aXydJamhS+Aig0TUN9FqccJJOjsB8edlGJ0wBg0Y/Dy/Fp7+jo+PjFi5cvX73a60fE9GCB+BpUsA+XF/DP+fgE/nl/egb/nH68IM3+9J+jqM5PgV13WdSLLI+sFr1T34D2BJBNounqA1qunsEja4YvlP+0cMUWolAuFdcQjcwobDj+EPbZeSGzEsYY46B/4J4cNPbk8uzD+LTX3z84PDp+8fLVXm1HzodjAP7ZyQh35MNH+Ofy7IPeirOTZ2+FJmgQXJ5Jz+B/yiyRrgf649xdLYvsWVMY04dfN/5DJWJqoWc7SdM03iRwNi3QPmW8munRnqNrCpBLYRagQSI2fK346Yia8UzEN9SYzJ92RK04Zok23ClU+RZgFNHKalsWBLm+AhkvCr56dOtOPow1RDrJhzEAElXlGcABnldGVJARz42ISqsgs1fKJyJF4+5EsOh/RSEDlEQxMdNgx+MTUUTbAoc9+gpWbU2+e69+UTz7BTxnLE4lnArOWYnQRLpGC9HJ4Y/njn0SJ6wBbXyc9viUpZgrH1o3DoxMMAOPEBiiRdCftPIX6idhnM+Dzw/dYFnIJ4P86uJMsc4yk7D4C6HQinvm8AfUdiYqT0HZubo4M+ZhtOk4eLq/d+iSVJ2hkfayAGMwuxMTJUtNn4VIVyBvL3hRroxXpGEKeALAri7OGrACuKC68mTInLpaEKBkMY1f7u8jVlrrMrqpyY7ZgzX8J5lXoyfOu6ZxeVawmOWZePIKLkUq8Et9Dioz6zop4BryKTu7vOpdstOwv988jv734TF7yfr7B+zw6Ji9ePnU5ZWNibRWCOz2RqyuFL8WW5sJvzMf+JgtWKaX8LayW1nfj0Kr1ekIf3eZyll0I1anWSwXM1GAAGgszLzkjceFICNbmuZ3ImGdi3cjdnT4co8pgWoTO0CW1fIFa5V7NHRm1oFhQUAHcRMO8fjiPf7cabNTOgM8KDCX2RntRH8jHFSXeDnsQinnT6WsataTFfoRwALxSnOnyqqVkPF8bDxhgKN5diEWy0SSooYbPbwuhACIIt9yOFvre3gfg84Sc5eEJ3meCp49SgIkkpFdsnK2QjiC7tM1gyKMteykX4NaWrfDavMphH9A15WWrN+DBRe2OhN12QpaA5pXpvOfzKZ+Bjv+44ZML0rXzEe+FkRqpcgSkXz3VBI7bX7om5fp3T/874nIi2WxyFH8UOzj2QnysyQvSwqtmLuHURPbUXa3DK0f7oXoVgxB+t6PWKfpbPRZS3a6zS+PPV8W2lG8BO9yqV0hOyib98OD8Djsh0fhUfgiPAgPjyLWucxvRMbGaEJl78EsTVbOnSdS6MezkwY8mmJDY9X/nWlrylP1f5W4NiJxnco24zvAtOL753kqY+nF98fnVHNP6I6+GvX3wkNAg1eH/f5LjfsfRue9tCeWibwrFl3SVC/HrI+aar/38nfHREC8LzHaMYG81Nb86Af3Ix/IfhgxZVv41O4jqwT/EJ+P31atbWO78v3eMRzlT/UXepx3FoGACWjUJlyyw7cZ5Zf4EgHxHJ/XD/htF3GgvRusQ+/rfo2dtYiyDzwLrELnZyfMeI2AGTaaAC5pXdK2wiXrdi+P94FnYjuRirgs8kzGTAmeeu0QX+JRPl+kktfN5M/hTz84XTl73qlPrR+R++H0in1Z8hQ0oKSpjbQnOVZx8tXTG49HJ+sndhhp+/SikLfADjBkTgdhVFOtApDyAsFK0R3AlhMBNlHW+WE8OlkD7HM1eQIhQms/6rXIilt0QItCtfO8hLAMnCBZ3oxXTZmIyckKlkJxk4vlJEV0icu8oBjgzvnybe90ONwZtGnX2NdehgdI8xS9N+w6cwPSaCLxAYWU2DYYkZWmrJwVwoQfkCahz6So6U+NtCVAeoha2+Q+Tt+DoyFd67vwHAZ1F1PK7zZ5yrpkC7yiKN/TJUyCZ+wqA1xI+Z0OH6zB63z8tvcyPOjtHaEK07B+4sB3uWsr1drkOgLR/i4QhMY1s0L8hGUvMz6fyOtlvlTW/hJri//UBliioMXIeME6diGHO3VFlpPbP5+C3YEMcBBgKrPrpVQz7fNRIRuus2lkOUaKFnlaPa6vOc7+ZhwKF9qX1M3/VvkYuvHfCCxphQDPgYsfFrCzywwI7W4mYwrI8pANRuCpRZ4pOUmFDQTfAEkIKAUXDEcTEGq9B69eHu+QhAZniLiXqlTOJ6gIPx+Qs7JcqMHu7t3dnTV0KbGb8rvd/b39YzCOB02Rz0tdGzBw0y5sKTc22V2nzU92iAdqVmV5oQ6Ob/OWmrDZ6P+bKtBuLfvpmh62CBkKg4eHLRf6e0tW9WWOXFHowZUWq+ifdWEqTiyIjUAA5tN0EbtO2brb8hEnYNsTgNbtNYbYh4du++xsKcE29cShd7DLXeOSmvsxl5mcg4ml3w3m/J5+Hxwf7a2JkcPebRJLMxQUxEEOpi+jNFBgKr//0U2JacqwXmXOjiUJ05qx1xt63D5czmUMB8dHgLIVhiAAATPMxul9g7jD5XzOERt86nzQJR3x61BsazQyzEoo7wwrP4JRMGhw1nF9ETtd9moPN887+7XxVWsx2LgnWs6EOoq+2nt4cEO6KE+hvoLxSe8fny7ZjyNWtWM29Ks92XaA2AP+B2DCw4m2dn9vzx/YWmWcoajY9qBpduQmHSRO0kGVVxAGTwhh3UzZENy7wVM4pjDV7zAEuK05myjWtSlCbkKPjrymvIE8RYnTLvoEbAQUVg9hIBgiJrW/j2fqTqeDaOEAepvzkpzmkK4QsrNSJ3QYV7ZRPcDN4YQym7iZqSgEKFfVGyMfVsI/SPFKxIXwSMYU/Pyo7LMpqrrmzaxy0DDqvzQB4fGMZ9c6Ho5UdekkFXDFol/vbsIbmUR1eeRgus9f9ePDF5OXyaE4nvK9+Ch5IfovJ6/2D6cHe3BObOuwnvP79yK7LmfBoL/XYuEfnBAXBDD640EV4hnjCRwFqiw4SHPWPqb1QQrmTwDSFlOWi8RojE5sqz59ax1oH4W16du1g94PVIbaM0hfAflrxoCAPnT3m29b+OqQXx0Z5FdiAg1VXwQ56fKFyCY8hwWUa8wrjcmDocTbs3Z5YL/I4JYprF2nMIDcSRkM8KuewACDLHII9Y9VHHxuzXITLm3EFd+6MbyO0bhNgVnCHHAEPeBnDHmS1/IZEXV/z+/sPGKYlw5DdTlYyCKNo1Etb9QgboN1VFjTwZQntHfEab5M2Hffj4mhnJznJ8iUpKsJuYPuhE4mEg1Lf9aJgpk2FeUhEWliItGnlRUVQsKtZn6md8yiQrsBOAM8q7FykFEFmmeVvM4UjS5ROqujnIYWWGX1lDG22syijlGmMaji6TXE/83mz4iqsaYl24nLeesRdeP9o2MT6rrcwmisnR9rOLkDDF7PlEO2Td9GPAZ9vsG06SFMRaoTMUUa8FnqGtOZ5XcmYbDikO3ZYF4zTGiyYgn13vZKdINf724e55Hn1UEsM/aP8ccP7JOYsO/EinX+8em7nVpGoo5wZEpkicLz2hzkZKxWzvFNbZq2Q23UjhJPFPeNP4i3Pl+YGAUiuRPi6R1fKTumVHqghutdpCl0FLN4WdyKyg1fumdydDpq7ObpCL0rxe3j0zutj1AdEo2ZnPcgiHfNBPBlYw74DKZx//gk/sniPC8SmTn1FxpLx5RmjCaZcCWOD5dFana6Nuxr+7p336t6fQMz2WK3/vWHzGTVnMnNNuf2d7Vs702CGIqEzxDDeHq9Bc/xMDRjCEPeX4uAQZYWaUO0RZo1bO/+KPb4+xqBz63sWucU5yjKS6V1FtwVjCgpTQUGSPxgHZpOU72nM2hNNrXObQFvHlXQoO3UeSYJOzm9qKfC1Mg7qZM1sZ6WDOk9JVuZ1I2U6TWJ1fVMahvACgFMcwExJTWlT21Is36aD/MRsKAkdX/kDeNv4Nnfh70+K2fL+WQBFnVrqm1ECP1ukF5HrWrG+71qHm8IU8v/QKzdahmA9dss5ENe6joW/xHZfGtaRpWLRGninizzSh6r7JfIEnQUqgLsKH9Rbd5cX+z+0XF7ufEv4n4h/SlKjRME26EHfd1KkS6vLkd/zNbt7+2/6PX7vf3+ZX9vsAf//1dLgIezGmT2RCa+GINGeK3HJmBkmCeSRyJikZUFT6USiauDdU7OwL/YjOpKBlC+4d/7yfzfJy/78fX5/csfb+SLf0yWy+/n7/5VfDq//le+Klc3V/91IFZfZmX/11ffTb78VxiGuL4ZVw7HxATyZwtydgcyHcTm51ZVY4gm3lQlwt029O7XY0DI9fB0kfsTiP1Ns1b7sIC9VLiZYa34QrkVkW2pGrVrQoRV0Q36rlVZigqrOOUFatUInNpM00cKTIW6dES3BQwNhh8ux+eO0XGjdcNPdVqxMuCra1Z6nZBKW6pFO0lVe9Ablu+n4mfFJh4rckL8pgXvdXZQcgXq2g2b4fzpK4pzPUIF51+Rwl1P3d5IDdun4L/bIDxVA0Koq7aq20xKgyU0evOLsqoIhUXIHKW2gZaFIO+XP6HSmdQQAtDV3JinHw/Q8H7a5i86oqkVrOyKohDorAYIhyrercToIk3fxtQPn4IkLfQhIyFer9S1jOYn75suEVNOqoudN5yGbvWa+9LaBhSIg5ioQvI5yLJ63LrRAAwvrQprLXRxS96sse90rTGVaxncgM2YrsiuDAN2TZEAE8sOxsNIb3uXifmiXCFyQiW3eZLWPVaRiQ3rsgijccyXmlABDGoJiemKRcOMgTOZIk24DvapbyHM99rmPgF0tLmizQlDZqro1SHQdDa7/mvWcb3OO2GkK+jdY5EZ5A3oKqskcZFgiQAm7gESjrEOSztB3Qp8YYzZZL/QpYK8DgML4+exlTo+r5PyfJW2dGjRYXgQ7ncZRsmwPpgZh9GA1QPeQxa9bT3EHW3GuocsGkUD3+MTz2PsopG2wKg4j42uD1l0Gg22aPWuNcPucwdsnLzNHAhTPsrJgnAVbUQ4JysC4wfdyHb3tB4G3QA8+aOgG5wE3QDcse88NSQwBRtY0cgyq5HlVY9KzZebuVxzkTCOewp5v2xWpgTeE8FBgMFn4G5pdYniQbSQiS7kyFvNiEm14Iu4jV0AzRteuUnct8dIE1xUnmh9iZX2YldPAIWOJD87GY6rz1v9Yo2mZeXGAqCxTkOwK5YpJGkhuFiHGGAzZAqSe6CN4Bw7yHpVIKUTmAhNvlAb/3uMtNNBOBHrOK+2C2KsVYWB5VD5F6rjosu3VFVb6rZ9eFBXtbDJBnR/lxffJ75kuK9H+qmuM3Hyvr5LbRTHQpHLVJAN1rX5TTFCes3coy6bQC8AaLsrVNTUgB+9RJBGqI8RIgH04Y3MYU8WfN9MXRncczzbKoJV3Q8HTUsqI+n0JnWIpFRIAH/R3P/nNNdCmWebKJqnZtkucOgWY22mIF2iQPI2PGCdigii5oFOaOzJZmmlR3XZJIfypDpxZ8dLSZ0kj6lAQV5ch1LlThfzk/cQBonUZT1negFexfGvaPS/otH/ikb/Kxr9r2j0/ybR6GuPpnaMeq2OMHL6akJ0YuBBgHvsslxCFZAkkSVEa6GBqfIe4OqCbDrWUXkwKFoHfMiv2sSzKa9TC0jfC4UZ9VueTy2Jzn7f3MJ31qTVFuq6G41hutR8Q5rVxior2GEZ6VroyoDSRMV9WdnTQJCrxHzYSZvqOHVq+mOxUiwPUtm16hZ3kONDxyrUFPaxsqANiB3BQsK5hk1kijVHWMz0e/tYlw1BoxBCoH2sZf5iGWtkbyDbRS1wYYsPQOR70gdfnvyFET6f8FGDAW0h2AJb+b1wkOSiOgq69W1JTrT6A0QfULgQd1EIKW2epCO3n78o7i+K+4vi/BTns2N0ornKf4FQmoiQ53HdrIG5IXtHZeRdKwfiacfYaGvGFW150WVx0Iyz3kxDycy6uGhDd22quTCm5RmUsK6FB2/LdoSE6ybYYAZ+1GTm0++NouqRDTYwMQ8OPMEX59b73ejaOquCZJ/oufOZ957nxnuOF4/KdhpHFWZwIG495qnDk0M7mqCOyqlxM213alz6vvQJ2et9WZwY/JooBTdnv34vVl7QChQE+JFaKBI2GsJlTFKXT6sG0lVSoJY9EqQBqpM75BxRvhPFiayiloVQyxQsqzgIUSvc9gRMH+IpLmsTkIpN8iVsbO7H2drAM55Uh1TVCcTH0zVa8PkY47WinUHdiwGv4P4HWjFZYHX9DH3VFVdQqliBGHE3W9ENYzh6Dk7IjtVeAIzSVpgBVx1A+aqQkQ07JR3BRMeaidJ2Xl28t9mUza3jiNxN3b4QMURpJljznqrIfDScy8ZQkCEWizUAdYC3c57fYt7SN9hyeH5WT1yySVwEIB3vPXCW02lOEqypOjhNvzWhak4tfGjkhp3QflBzE/s3ldm1KGrBfx40N73RzSWsM9NpIWsoApvpsJVqtuWwNCuRcxtoR/odvH67glojsxxRSNqwVup3bus/4u63xRUNq228xm0TgJMouVumu66tTYX381QXrwUAP20AY5Zx1fJGOSHalse7RYuOoaqtmuM2bNUSN8fXkqLhgkEA+WY92LeNyyW7yV5vf9+Nb8T+325RRRxseUTMXit7MwmDOMUW3TbEBzPGlgaYR+McWAdOyVoytudI2NkYwmb7xRPviy4/4/MryEZmGLsRYlGJBGvLx6wpG1MFqKD/pXaToL3Xzu2RgsMMu6kiR5xsQJRKYxVHO/aOOWqk7wpxEwSqUMf6srwuBBx7u6P/O7HC09973DvwsWlKzmJrSV2Pr50iqVonJr+G458OzdOrGi4oX5FeWbZyP6v8L30KGoNdnmW6NmUzURCPPgEjtXnktrlbkV1x1JZ8XKnGW1HJvWjBgApRYjTc/WFUKb4a9NcFz0qR2DvhGqCyub6Y2eAfEE9pp/iUwXk8fhtVqUCmgCu3fqeqS6DFlL0mvGp7DZIMy3KI5KWLZXQjQA6eprW7OBuL1wJM1/gVtNgwETo0rcptQdmLRAoR34iErSgh2zhE7Qyxeqcz46Ab6GnVXaJVAziuqFP/GfEIB3WC7bGbKsLexw7XLaN9xPTrR0wiynpF4CcEjU15XGo1yV6TQOJzu+SxH9GtStS+G3cmUKprvjV7V7vwCkTemqBtMBOQrQ6HH7aiBED4bzQPbuM79EoSWatYWVsW/Ka9BOMrgE8NvpAvFcU3KigxYKMPfzvLSqEk+7bIlwtA8mr2p9Vsx0BnoyH79oCdjkZwu9TuD6OuYRDdBviguPFO2zageZyLsxY5tjjwUZ5vnH2N48CeZnRbQEX7xuXfscYVfT0i6dm+Q8eaATaeFZpQcHNRkbbxYCgtLE3918dT9qvLExxTQSKmMpPksAGURbdzVhp2V71E1KxnTaBVwipBuDOYiFmlGRSiXBZZI3V06B+ffNBgD4rNjZjIHRQsm6cmeLtmGEMmD081VInnmqsQbeIxMEzHZuLLSCIsUR6fup3rSQUNb42fRib/Y9BeA1CX0PfBiOlsyHNn8NRNdefQb7lBvQBZP1GqSos561+hZzSyLc2B7KZzYZanPl/8x8Ze/digShq/36zc4y6FO3m1iv+8+bXtnhg5ltF1FLZah63v4JYD6FassEqUp8x1nVvmT8Hy5Tm1E2F8eSDr8hvWWPC0mmOkehdD3H0B3NG1zrYL7DWN3SskwD9TOad01o1zm3DIPgJLVWhlmOZglLUXArqXMUa6XHWvEEuK6m/d6+qtrLspneMTzbe1liEIQoJOarXEaxSmy1RX+qnfC2lYnL3mMdEJKM3YoGSb6iiApzLDWEQNy9ADMjrUdN0hffM4CMuopHKfaaiZ3TSwVmRnb+wja7Qj04zvakxeL8zrrP/Ruze/qX3RuEWzvantNDVre+UQKN/KqqilCDWR5jE7v04mNVd4GuESrooejS+6nsw7bWw2yYFuVL691VLfYok+RWOh1zNzNYXmRhu2XkGe8KoGIPSGOYus6xKtLsE4RZ6T7dDRRQiNkl0Ts0eZMDVmerIxIW5Noh1uJqZxrHxi/Fdk0bETegA7IPGqx0WRJ8tYm3taIUYIYQOfz/CeT6ciLkXiuLJqItCTY7/rApRfBOhqTbnthJhKrDttG8PF44R/AB6dLwUE0gNVcyrLqGrburR5je+7nkj3KD8dboaQh7muA8faVRvVtLEy55bu+lnvpXAUVKuutXWjBa4svyNENR4CYunfeCLSs/xOM91GHzLD0ZrBARh92lhxddG3UVxsPIcOwSSdy4bSa3uMjhI2XkQMF4fugVPRkm2lGp/htMsmIuZGVN/eGbWdhL5N6bkGXTiaiC/6v85ljqf9eJ+/EL295HDSO4yPjnqv+OFBb3/6QvQnr5KXcX8vqFVYrKHkM6bXSEVIujr+Ayb6EQpNjs5YRQBa/2bfi5JDkH6jssl8keYrId7y5Fr0VPLrXbl9iTIs/IEXbEVeQHWZSJHZAVJKtUj5KoSeI/2i9Hzv2wX/lNkE5twArcZcr3H4r4yM/5kZGa2QCn8Kkz9VJ3SkjO0OSEpfsvY3ZGI+ia8Vv9V9NA7ryZdr3WPJ5C3UbkTc9SzGKoseUnHA87l5eVdL8QwcLWwLgYTu/6KyQLBo+OuQqr5uXZXVnQGqOSMSjfD3iQO0z92WXFA/HqqvfSYTu/DDvb0HT/eeLXMSUTkE2MHVuwte8LkoTc1bj8SBYkRDWZlymcKlY9HrqRRp8mbAXi+KfJKK+Zuoa9Ln4INrkQE/EVSBwEk2dbQOqczl9V0W3dbKNIPxTZfqrF2/QwFIrFNrPrBVpF9nb7A0sZ2G/uy1GTF5wzqvTXHlNzvG2GmrU5n10iV6DEv14Hrdcr++y3/NgPrD1/TvG9tDnrHXYJJ5E5oxW7UYdaEXoFkoHcs4wq7DqbiIbb5jHSm1CaDDSfEsmeT39TedaLycWI2gcX1cmRN3bEm6KiTbQJMo+n9iorjKtA/l3+iJaoLm4E8Mmsumi1DdySqspqKcqaYln0prP4FmJm/V7XQNSh7+yeFevyOd24v46iVCz05YJ4LShygUgMIyYK/RRvvGD9ZXf3KwbqiTRhEgxmYFlaaiJ34RshORitJq4tACbL+A4qhKJ/R6U3W6KlSvvX1Hf2rp5Yyul00x+EUUZHb2wOjPzrG9MoiWLrAOeLuF4deVRVlb+GvVSt+RnFhJFx5b2gBrC895xq91ap4OvzHZOrdcou8q8qH3i3bE2VmmltMpXFIIoeFlXvBrQcrs38fftwt0V0vTPLPI87lWD0Gb0s5YOIN0+eJmD7UDD8bo+ACHLpEZL5I7EL6UiJcYhDHPE9KONbzbVcQbvvxVviwapcwvHY8EcqD6Qjes6wJ5B1tmmFODV5tyWSjWuZkrc+9HXixmPCMfNarXdM9gDRIopcMAYaQtaZCUDWqCUzfzjuuYdOfehyxn0YUoi1VvOC3xziCVG1s0VG+uqR0YcGBsl7gcKCZXCH21pG8vSMi24c2+HTP8s5x5AKGX29z5ar26fFt721r71DXMvDWIuZ+i+lwDWZbuSGMolmn5PtyZUVaeJw7ggz9lwfK7DB8OaqTaccgRNQvn5YBtRpswtApLIsCg5dV+dGigO5BujcY+vFjGlHMyjQEha52cnbDXElRKHLOqcEL1G6lYr1+/aY3qa6f7BYNvkS9NjgClA4MfFeM3NIajtRhRVSc41Qa01d+z3FRdxz1dgfvLtRHXLgIhEFatS+vuxZAAU7DOrZXwpziZahdtOcMf7b3wjRD8P2ZzQctUhBHjxNTRjDtcSLhdBwxTAG5+jdccnWjs/6RJxdy2NNoJuliR/Ht7EMIuzUU5y5NgECxyjDZYcLirJdi93d8lu+GuJqceIdkuXCsik1244aM6UuFPtfsbSvkPux5fKclHCufdKNUr5rkWnyDAoUidBIREzPMeX8hQYrRbKOE2k2YH59ZruK6bx3oYl/waPE9rPlf0ujmRz9V2jIFACK/NplSGVXrQDaCOr95PY38cBEOt569xx52fURxc7YZtN05cM8mo1o8tPD4HV+sErVPk8qfYPJojQyu41gzKgssUYbDgMQgLIoTwhlq3A6Y/fA0nD4AD7nl5E5GzFpiFLq34Nk9Wp/9zL7WDrZrmRmLnNDMxxzjaQC0XUC33PytEsHspv60e1THIRb7GFtuPTAAlanVwgy8c5BL+ndsANb3b+pwDFvQjOt2xCFJldFbo48IrjDraAUbHnP/DczcGzvKL8x2YUZnHeaq0eAroKDL4RjF3a5SVv7t43VG3igdY2dM4dqa3VIhqJc8SXiSqF+sbi0s2RbMroqmGNM7208EIblvr/OPT5U6XnZ1evmP2DjYaDerx2BvtT/J4F1OFK6cIBa1hFGMqY5EpxANDhQsezwTbD/daWwdlUDi+DvPield/q3bfn41OP4xPe/DNQ+VCq7YTgGVw3VA3sEDa9v29fSip2YdvgfPOeebMZ+QvJd3kD45KGXyLMiRJ8luFGflvXZNUVCbmaUqC56YqynXp74+MFfk5+zlDa56uosPZSBWmkGtnox+gCsdAqPG04QIwyk3DME9Dayt74zJHuvmRn+BL66rdohSzCQhrxEEMoAZfHvckj3lkLfx4PYTuAzJDMdStev3p4nw4smPoHFHfnYi6imYjiam0iZW6C8jA1RkHPjtfBRtuwFK71ookzOoqusomqHn6APaw566U0CfS3DnU7aKGK8jxjTdKcenS0/6cXO7UCa8FrrdxHvuHml0hTrCCE4JNw33wh8/gCcDQkyWaaAn/QAH1iCWj4uAmOjiIE7dNqQ5SY0SbqmYq8DmEIO55XJrYMexb3wjh5oDc1C7BIZzRq2y8s9McXbzH+mBYkw5wEG/sYZ0oLtKrogqO0Ne8DLMa/dD1KaBk6asP6MpNxlO01WH1MeCzumo/HfFul91WpQYqYfcWdToHPyAQwJBlfdQ6CECcgNMHU9qxPdUiVDbKKOYUlaJrD7j5yc0F+4o0f3v6oXcYHob93v6OvaIDTj2d2ICAQDxVJTs+ZAXPknzOJljswEAdVyAV3XNLZuQ+m8sMVFgnmguhSYOYL6h8NX1nrQQ42SaSoo3JpOMDZ+2U6y/wca4tHTx6UwARayMe2ylkam/DQh0ca3JsuuiifYnPmlt7Gnf71C/xgUNywz09unqYVfPbNfqpqg7pmXlmkj9sWqhhysbcb/hyDZajISvEbW64A0QllpZrdUYX73dqZcy280J4dsO9kaO6aQOJhPJ9dOomaMgDY6miSiyOWwIQpkl+ZKqwVj7DhLVRqyHwd81zIpaz4Wi4Y+r9VPsHWCyz618MnyVhJ/JpKBq18FWBuIAx1m1W7VaA8hwWLo/CuXkvLW9EWIfsEko/5nn7COTUi0Oa2srTCoOm+EqDHMZo5N5XAuKgvSeFaFa62Ur6Sg3MYUIzc2UwdqIkF3wiUwkWHshzNoBzpoKpFBGUcADTdYTRGMu0hB/6LlH4qS8TxZ/120R1j3CjKFUL9ZnpdGgD+QPaJBX+nAXWOAU2zN1FCgkeD1ry/02bQH4KbvfJNDaVGI5UM4OAcoqGEEo4cUwh9ACigQYmMaVlD/ncDWZgbhn8FPz2G1zldFWkDw/w+MtSFGjSgVtWC0kZNWAzkQp+Jzrpe4Mi0LnQNrodtune2HUwMFaLbFXdZB3QmoKBTrXBO8m1JQMmR+9GNIWeLj9kvm0ZFMH+Ql8MsXr1xrauher84/gy6AagA8CS52i9Cwp+B1eC8rtgEPwc/Bzgztjwb3z+W5Dy7HqJcfUB9fugC6TWDTUEF/3DiZSsQ6Nps7GgwaV5P3kN2uB3YvXGNqc3az+wdiJqDXsDsWP/B+q6bCs=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create test certificate</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/keys/{keyId}/test-certificate"}></MethodEndpoint>



Gives a key a certificate of the built-in test CA of the organisation, in one call. For development and testing only: the test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it.

The body is a CsrRequest (the generate CSR operation), with the optional `validityDays`. The test root of the trust domain of the preset (`testCaDomain` of the list certificate presets operation) issues the certificate: `mdoc-iaca` for the mdoc presets, `access` for the WRPAC presets and `request-signer-san-dns`, and `provider` for the other presets. When the organisation has no root of that domain, the wallet first makes it, with this country:

- `mdoc-iaca`: the `subject.country` of the request, else the country of the newest leaf certificate that a CA issued for a key of the organisation, else `EU`.
- `provider` and `access`: the country of the newest leaf certificate that a CA issued for a key of the organisation, else the `subject.country` of the request, else `EU`.

The wallet makes the CSR with the key, and the root issues the leaf with the values of the request: the profile of the preset exactly. The root adds the authority key identifier, the subject key identifier and the CRL distribution point (`crlUrl` of the root). An `mdoc-iaca` leaf also has an issuer alternative name (the contact of the root, ISO/IEC 18013-5 Annex B). A `provider` or `access` leaf also has the authority information access extension with caIssuers, the `certificateUrl` of the root (ETSI EN 319 412-2 GEN-4.4.1-2). The serial number has at least 64 random bits, and the leaf is valid from 1 minute before the issue. The leaf is never valid after the root.

The wallet stores the chain (the leaf and the test root) on the key: `certificateSource` is `test-ca` and `testCertificate` is `true`. The key can then sign with the `x509` format. The `x5c` header and the mdoc `x5chain` of a signature have the leaf only, without the trust anchor. A key that has a test certificate gets a new one, also from the root of another domain, and the test CA revokes the old test leaf (CRL). A key with a certificate chain from another CA (`certificateSource` `uploaded`, `imported` or `qtsp`) is refused: delete that chain first.

ISO/IEC 18013-5 needs the same country in the Document Signer, in the root (IACA) and in the mdoc `issuing_country`. For `mdoc-document-signer` and `mdoc-reader`, a `subject.country` that is not the country of the `mdoc-iaca` root gives the warning `profile-mismatch`. To choose the country of a root before the first test certificate of its domain, use the create test CA operation.

This operation is for keys in a key store with the capabilities `csr` and `certificateChain`: `local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`. A sandbox organisation cannot issue a test certificate.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key","in":"path","name":"keyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The preset and the values of the certificate (CsrRequest), and the optional validity.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"preset"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`wrpac-legal`, `wrpac-natural`, `pid-provider`, `wallet-provider`, `wallet-status-list-signer`, `eaa-provider`, `qeaa-provider`, `pub-eaa-provider`, `mdoc-document-signer`, `mdoc-reader`, `mdoc-status-list-signer`, `status-list-signer`, `credential-issuer`, `request-signer-san-dns`, `custom`, `null`]"} schema={{"type":"string","nullable":true,"description":"The id of a preset of the list certificate presets operation. An unknown id gives `400` (`preset: unknown preset; use one of <the preset ids>`).","enum":["wrpac-legal","wrpac-natural","pid-provider","wallet-provider","wallet-status-list-signer","eaa-provider","qeaa-provider","pub-eaa-provider","mdoc-document-signer","mdoc-reader","mdoc-status-list-signer","status-list-signer","credential-issuer","request-signer-san-dns","custom",null],"example":"mdoc-document-signer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The subject of the certificate. Each attribute has one value. An attribute that the request does not give takes the prefill of the preset. `null` is no value. The wallet encodes the subject in X.500 order, from the country to the common name. The subject has no `emailAddress`: put the email address in `subjectAltName.email`.

</div><SchemaItem collapsible={false} name={"country"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Country (C), an ISO 3166-1 alpha-2 code in upper case. In an identifier, Greece is `EL`. For an mdoc Document Signer, the country of the issuing authority (the mdoc `issuing_country`) and the country of the IACA root.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"stateOrProvince"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"State or province (ST), at most 128 characters. For an mdoc Document Signer, the `issuing_jurisdiction` when the IACA root has one.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"locality"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Locality (L), at most 128 characters.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"organization"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisation (O), the registered name of the organisation, at most 256 characters.","example":"Example AB"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationalUnit"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisational unit (OU), at most 64 characters. Some Certificate Authorities put the identifier that they gave the organisation here.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"commonName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Common name (CN), at most 64 characters. Use the name of the organisation or of the service. Every preset requires it.","example":"Example AB Document Signer"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisation identifier, at most 128 characters. For a preset with `etsiSyntax` `true`, it has the syntax of ETSI EN 319 412-1 clause 5.1.4, for example `VATSE-556677889901` (the type `VAT`, `NTR`, `PSD`, `LEI`, `EOR` or `EXC`, the country code, `-` and the identifier).","example":"VATSE-556677889901"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Serial number of a natural person, at most 64 characters of an ASN.1 PrintableString. For a preset with `etsiSyntax` `true`, it has the syntax of ETSI EN 319 412-1 clause 5.1.3, for example `TINSE-1234567890` (the type `PAS`, `IDC`, `PNO`, `TIN` or `EID`, the country code, `-` and the identifier).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"givenName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Given name of a natural person, at most 128 characters.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"surname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Surname of a natural person, at most 128 characters.","example":null}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subjectAltName</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The subject alternative names of the certificate, at most 50 values of each type. A type that the request does not give takes the prefill of the preset. The wallet checks the format of each value and refuses a repeated value.

</div><SchemaItem collapsible={false} name={"dns"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"DNS names (dNSName). A host name, without an IP address. The first label can be `*`. Give an international name in the A-label form. The `x509_san_dns` client identifier prefix of OpenID4VP needs the host of the verifier here.","example":["wallet.example.com"],"items":{"type":"string","description":"One DNS name."}}}></SchemaItem><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"URIs (uniformResourceIdentifier). An absolute URI with a scheme, at most 2048 characters, for example the support website of a relying party access certificate.","example":[],"items":{"type":"string","description":"One URI."}}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Email addresses (rfc822Name), in the form `local-part@domain`.","example":[],"items":{"type":"string","description":"One email address."}}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Telephone numbers in the international form of ITU-T E.123, for example `+46 8 123 456 78`.","example":[],"items":{"type":"string","description":"One telephone number."}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key usage extension. `null` is no key usage extension.

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`digitalSignature`, `nonRepudiation`, `keyAgreement`], `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key usages, each one time.","example":["digitalSignature"],"items":{"type":"string","description":"One key usage by its X.509 name.","enum":["digitalSignature","nonRepudiation","keyAgreement"]}}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`true` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>extendedKeyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The extended key usage extension. `null` is no extended key usage extension.

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key purposes as OIDs in dotted form, at most 20, each one time. For example `1.0.18013.5.1.2` (ISO/IEC 18013-5 mdoc Document Signer), `1.0.18013.5.1.6` (ISO/IEC 18013-5 reader authentication) or `1.3.6.1.5.5.7.3.45` (Token Status List signer).","example":["1.0.18013.5.1.2"],"items":{"type":"string","description":"One OID in dotted form."}}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`false` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"certificatePolicies"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"The certificate policies as OIDs in dotted form, at most 20, each one time. For example `0.4.0.194118.1.2` (NCP-l-eudiwrp, ETSI TS 119 411-8).","example":[],"items":{"type":"string","description":"One OID in dotted form."}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcStatements</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QC statements of ETSI EN 319 412-5 and the QcPSB statement of ETSI TS 119 412-6. `null` is no QC statement.

</div><SchemaItem collapsible={false} name={"qcType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The QcType, one OID in dotted form (QcType has one value). For example `0.4.0.194126.1.1` (PID provider), `0.4.0.194126.1.2` (wallet provider) or `0.4.0.1862.1.6.2` (electronic seal).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"qcCompliance"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the QcCompliance statement (`0.4.0.1862.1.1`), an EU qualified certificate.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"qcSscd"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the QcSSCD statement (`0.4.0.1862.1.4`), the private key is in a qualified signature or seal creation device (QSCD).","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` is no QcPSB statement; with the preset `pub-eaa-provider`, `null` gives the warning `preset-override`.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"validityDays"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1` and `<= 3650`"} schema={{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"The validity of the test certificate in days, at most the `maxValidityDays` of the preset. Without a value, the validity is the `testCertificateValidityDays` of the preset (the list certificate presets operation).","example":365}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The test CA issued the certificate, and the wallet stored the chain on the key.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>key</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One signing key of the organisation, with the key store that holds it and the DIDs that come from it. The answer has public key material only. It never has the private part of the key, the reference of the key in the provider or a secret.

</div><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key. The wallet makes it, and it cannot change. The value is the same as `jwk.kid`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","nullable":true,"maxLength":100,"description":"Name of the key, given by an administrator when the key is created or with the update key operation. `null` when the key has no name.","example":"PID issuance 2026"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyStore</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key store that holds the key.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store.","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the key store.","example":"Local vault"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`created`, `imported`, `referenced`]"} schema={{"type":"string","nullable":true,"description":"How the key came to the organisation. `created`, the wallet created the key in the key store (also in a cloud KMS or a DPoD partition of the organisation). `imported`, the import key operation imported the key, with or without a certificate chain. `referenced`, the key was already in the key store of the provider, and the wallet signs with it there.","enum":["created","imported","referenced"],"example":"created"}}></SchemaItem><SchemaItem collapsible={false} name={"algorithm"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Signature algorithm of the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the key. The wallet signs with a key that has the status `active`.","example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"isDefault"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the wallet signs with this key by default.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key in JSON Web Key (JWK) format. The service sends only public members. It never sends the private key member `d`.

</div><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type. The service always sends this member. The keys are elliptic curve keys, so the value is `EC`.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve identifier. The keys are P-256 keys, so the value is `P-256`.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier. The value is the same as `keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm for the key, for example `ES256` for a P-256 key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Certificate chain of the key as it is stored, in leaf to root order (for a test certificate, the leaf and the test root). Each item is a base64 encoded DER certificate. The service adds this member only when the key has a certificate chain. The `x5c` header of a signature and the mdoc `x5chain` have the leaf and the intermediate certificates, without the trust anchor.","items":{"type":"string","description":"One base64 encoded DER certificate."}}}></SchemaItem><SchemaItem collapsible={false} name={"x5t"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-1 thumbprint of the leaf certificate. The service adds this member only when the key has a certificate chain.","example":"<base64url-sha1-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5t#S256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-256 thumbprint of the leaf certificate. Note the `#` in the member name. The upload certificate chain operation gives the same value as `x5t_s256`.","example":"<base64url-sha256-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c_expiry"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry time of the leaf certificate, in UTC. The service adds this member only when the key has a certificate chain.","example":"2027-11-21T10:00:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dids"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"DIDs that come from this key.","items":{"type":"string","description":"One decentralised identifier (DID)."},"example":["did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ..."]}}></SchemaItem><SchemaItem collapsible={false} name={"hasCertificateChain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the key has an X.509 certificate chain. Then the key can sign with the `x509` format.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSource"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`uploaded`, `imported`, `test-ca`, `qtsp`, `null`]"} schema={{"type":"string","nullable":true,"description":"Where the certificate chain of the key comes from. `uploaded`, the upload certificate chain operation. `imported`, the import key operation with a certificate. `test-ca`, the built-in test CA (the create test certificate operation), for development and testing only. `qtsp`, the certificate of the QTSP credential. `null` when the key has no certificate chain.","enum":["uploaded","imported","test-ca","qtsp",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"testCertificate"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` only when `certificateSource` is `test-ca`. The built-in test CA issued the certificate, which is for development and testing only. Wallets and verifiers outside this platform do not trust it.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificatePreset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The preset of the certificate chain of the key (the list certificate presets operation). For a test certificate, the preset of its request. For an uploaded chain, the preset of the newest CSR of the key. `null` when there is none.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>certificateAssessment</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

What the leaf certificate of the key allows: its key usage type, the credential categories that it fits, the mDL Document Signer profile, its QcPSB statement, and the texts of the save check for each category. The wallet reads the certificate chain of the key. A key without a certificate chain, or with a leaf that the wallet cannot read, gives `keyUsageType` `null`, empty lists, `mdlDocumentSigner` `false`, `qcPsb` `null` and texts such as `An EAA needs a seal certificate of a legal person. This key has no certificate. Request a certificate with the preset EAA provider (eaa-provider).` The texts do not count the trusted-list exemption of the key: an exempt key is never refused.

</div><SchemaItem collapsible={false} name={"keyUsageType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`A`, `B`, `C`, `D`, `E`, `F`, `null`]"} schema={{"type":"string","nullable":true,"description":"The key usage type of the leaf certificate (ETSI EN 319 412-2 clause 4.3.2, table 1). `A`: nonRepudiation. `B`: nonRepudiation and digitalSignature. `C`: digitalSignature. `D`: digitalSignature and keyEncipherment or keyAgreement. `E`: keyEncipherment or keyAgreement. `F`: nonRepudiation, digitalSignature and keyEncipherment or keyAgreement. `null` when the certificate has another key usage (for example with keyCertSign) or no key usage.","enum":["A","B","C","D","E","F",null],"example":"B"}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategories"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits (the list credential categories operation), without `none`. A PID certificate fits only `pid`, and a PID certificate with another key usage type fits no category.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategoriesForMdl"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits for an mDL configuration, without `none`. The rules are the same as for `fitsCredentialCategories`, but `eaa`, `qeaa` and `pub-eaa` also accept key usage Type C. A key signs an mDL configuration only when `mdlDocumentSigner` is `true` and the category of the configuration is in this list.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"mdlDocumentSigner"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the certificate has the Document Signer profile of ISO/IEC 18013-5 Table B.3 (key usage `digitalSignature` and extended key usage `1.0.18013.5.1.2`, both critical). A key signs an mDL (doctype `org.iso.18013.5.1.mDL`) only with this profile.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` when the certificate has no QcPSB statement. A key with this statement signs only the attestations under its law (`legislationIdentification`, `countryOfLegislation`) and from its authentic source (`authSourceIdentification`), ETSI TS 119 412-6 clause 8.3.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>categoryMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for a configuration that is not an mDL. `none` is always an empty list.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mdlConfigurationMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for an mDL configuration (`mso_mdoc` with doctype `org.iso.18013.5.1.mDL`) of that category. First the category rule (with key usage Type C also allowed for `eaa`, `qeaa` and `pub-eaa`), then the ISO/IEC 18013-5 Document Signer rule. `none` has only the Document Signer rule.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustedListExemption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trusted-list exemption of a key: the certificate of the key is in a trusted list, or chains to a listed CA. While the exemption applies, a rule of the signing key check that the key does not fit gives the check result `exempt` and no refusal. The exemption is bound to the leaf certificate that the key had when the exemption was set (`leafSha256`): with another leaf, `applies` is `false` and `reason` says why and what to do (`null` while it applies). `listUri` is the source of the exemption: the URL of the trusted list, or a text, for example a recorded decision. Only the platform operator sets or removes it; the API cannot change it. The other members: `listUri` (the trusted list), `service` (the service of the list), `certificateSha256` (the SHA-256 fingerprint of the certificate of the list), `match` (how the certificate of the key matched the list), `setAt` (the time, in UTC) and `setBy` (who set it). Each of them can be `null`.

</div><SchemaItem collapsible={false} name={"listUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"https://example.com/tl/eaa-providers.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"service"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"Example EAA provider"}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"leafSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"match"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"setAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"example":"2026-10-22T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"setBy"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"applies"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the key in a qualified signature creation device (QSCD). `false`, or `provider` for a key of a qualified trust service provider (key store type `csc`): the provider decides. The value comes from the key store.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trust</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The qualified status of a key of a key store of a qualified trust service provider: its leaf certificate against the EU trusted lists. The wallet checks it when the key is referenced and when the connection of the key store is tested.

</div><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","description":"`qualified`: the certificate chains to a qualified certificate authority (service type CA/QC with the status granted) on the EU trusted list, and it is a qualified certificate for electronic signatures or electronic seals whose private key is in a qualified signature or seal creation device (QSCD). `not-qualified`: the trusted lists say no. `unknown`: the installation has no EU trusted list source, a list cannot be read, or the key was not checked yet.","enum":["qualified","not-qualified","unknown"],"example":"qualified"}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the check, in UTC. `null` when the key was not checked yet.","example":"2026-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The facts that gave the result, for example the certificate authority and the trusted list, and whether the trusted list or the certificate says that the key is in a QSCD.","example":"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The number of credential definitions and presentation definitions that sign with the key. Only the list keys operation returns this member. A credential definition counts once, also when several of its configurations or its status lists use the key. The read key usage operation gives the details.

</div><SchemaItem collapsible={false} name={"credentialDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of credential definitions that sign with the key.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of presentation definitions that sign with the key.","example":1}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Creation time of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Time of the last change of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>warnings</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The warnings. The first one is always `test-certificate`. Others can follow (`preset-override`, `purpose-reuse`, `profile-mismatch`).

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`test-certificate`, `preset-override`, `profile-mismatch`, `purpose-reuse`]"} schema={{"type":"string","description":"The kind of warning. `test-certificate`, the answer issues or shows a certificate of the built-in test CA: the text is always the text of the example. `preset-override`, a value of the request is not the fixed value of the preset; the request value applies. `profile-mismatch`, the certificate does not agree with the preset of the key. `purpose-reuse`, the certificate chain of the key has a preset, and the new CSR, test certificate or chain upload has another preset: use one key for each purpose.","enum":["test-certificate","preset-override","profile-mismatch","purpose-reuse"],"example":"test-certificate"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The text of the warning, for a person.","example":"Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>affectedCredentialConfigurations</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential configurations that sign with the key, whose signing key check fitted with the old chain and gives `does-not-fit` with the test certificate. An empty list when there is none.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The credential definition of the configuration.","example":"6f1c2a7e-0d4b-4c55-9a43-2f7e1b9d8c10"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The credential configuration id, as in the OID4VCI Credential Issuer Metadata.","example":"EmployeeBadge-sdjwt"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `label` of the configuration, else its `display.name`, else the `label` of the credential definition.","example":"Employee badge"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialCategory"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}></SchemaItem><SchemaItem collapsible={false} name={"messages"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The rules that the new certificate does not fit, with the fix, as in `signingKeyCheck.messages`.","items":{"type":"string","description":"One text."}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"key\": {\n    \"keyId\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n    \"name\": \"PID issuance 2026\",\n    \"keyStore\": {\n      \"id\": \"local-openbao\",\n      \"type\": \"local\",\n      \"name\": \"Local vault\"\n    },\n    \"origin\": \"created\",\n    \"algorithm\": \"ES256\",\n    \"status\": \"active\",\n    \"isDefault\": true,\n    \"jwk\": {\n      \"kty\": \"EC\",\n      \"crv\": \"P-256\",\n      \"x\": \"<base64url-x-coordinate>\",\n      \"y\": \"<base64url-y-coordinate>\",\n      \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n      \"alg\": \"ES256\",\n      \"x5c\": [\n        \"string\"\n      ],\n      \"x5t\": \"<base64url-sha1-thumbprint>\",\n      \"x5t#S256\": \"<base64url-sha256-thumbprint>\",\n      \"x5c_expiry\": \"2027-11-21T10:00:00Z\"\n    },\n    \"dids\": [\n      \"did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...\"\n    ],\n    \"hasCertificateChain\": false,\n    \"certificateSource\": null,\n    \"testCertificate\": false,\n    \"certificatePreset\": null,\n    \"certificateAssessment\": {\n      \"keyUsageType\": \"B\",\n      \"fitsCredentialCategories\": [\n        \"eaa\"\n      ],\n      \"fitsCredentialCategoriesForMdl\": [\n        \"eaa\"\n      ],\n      \"mdlDocumentSigner\": false,\n      \"qcPsb\": {\n        \"countryOfLegislation\": \"SE\",\n        \"authSourceIdentification\": \"cn=Example Register,o=Example AB,c=SE\",\n        \"legislationIdentification\": \"https://www.example.se/law/2026-123\"\n      },\n      \"categoryMessages\": {\n        \"none\": [\n          \"string\"\n        ],\n        \"pid\": [\n          \"string\"\n        ],\n        \"eaa\": [\n          \"string\"\n        ],\n        \"qeaa\": [\n          \"string\"\n        ],\n        \"pub-eaa\": [\n          \"string\"\n        ]\n      },\n      \"mdlConfigurationMessages\": {\n        \"none\": [\n          \"string\"\n        ],\n        \"pid\": [\n          \"string\"\n        ],\n        \"eaa\": [\n          \"string\"\n        ],\n        \"qeaa\": [\n          \"string\"\n        ],\n        \"pub-eaa\": [\n          \"string\"\n        ]\n      }\n    },\n    \"trustedListExemption\": {\n      \"listUri\": \"https://example.com/tl/eaa-providers.xml\",\n      \"service\": \"Example EAA provider\",\n      \"certificateSha256\": \"string\",\n      \"leafSha256\": \"string\",\n      \"match\": \"string\",\n      \"setAt\": \"2026-10-22T10:00:00Z\",\n      \"setBy\": \"string\",\n      \"applies\": true,\n      \"reason\": \"string\"\n    },\n    \"qscd\": false,\n    \"trust\": {\n      \"status\": \"qualified\",\n      \"checkedAt\": \"2026-10-21T10:00:00Z\",\n      \"detail\": \"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT).\"\n    },\n    \"usage\": {\n      \"credentialDefinitions\": 2,\n      \"presentationDefinitions\": 1\n    },\n    \"createdAt\": \"2026-10-20T10:00:00Z\",\n    \"updatedAt\": \"2026-10-20T10:00:00Z\"\n  },\n  \"warnings\": [\n    {\n      \"code\": \"test-certificate\",\n      \"message\": \"Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production.\"\n    }\n  ],\n  \"affectedCredentialConfigurations\": []\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

A check of the request failed (`<field>: <problem>`, as for the generate CSR operation), the preset is unknown, `validityDays` is more than the preset allows (`validityDays: at most <n> days for the preset <preset id> (<document>)`), the test root of the domain expired (`The test CA of the organisation for the domain <domain> expired on <time>.`), the key store of the key cannot make a CSR (a QTSP key store), or the organisation is a sandbox organisation (`Subwallets are not allowed to issue test certificates.`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The installation switched the test CA off (`The built-in test CA is switched off in this installation.`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key with this key ID (`Key not found: <keyId>`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div>

The key has a certificate chain from another CA (`The key has a certificate chain from another CA. Delete the chain first.`). The delete certificate chain operation removes it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The key store of the key or the local key store of the test CA does not answer, for example `Failed to issue the test certificate: Key management service is not available`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"507"} value={"507"}><div>

Insufficient Storage: the HSM partition of the key store has no room for a new key. This is the partition of the installation HSM (the local key store in a hardware security module), or the DPoD partition of a key store of your organisation. The text is `The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.` A new try fails the same way: the answer has no `Retry-After`, so do not send the request again before room is free. For the installation HSM, the operator of the installation removes the unused key pairs or gives the partition more room. For a DPoD partition of your organisation, delete unused key pairs in the partition or give it more room. Some operations put the text after their own text: the test CA (`Failed to make the test CA: The HSM partition has no room ...`), the deploy of the organisation wallet (`Failed to deploy the OpenID digital wallet for organisation ID <id>: ...`) and the create of a sandbox organisation (`Failed to deploy sandbox organisation: ...`). A route that signs can also give this answer for an organisation that has no default key yet, because the wallet makes the default key the first time that it needs it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 507,\n  \"errorDescription\": \"The HSM partition has no room for a new key. Remove unused key pairs (kms signer orphans list) or give the partition more room.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete certificate chain
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-delete-certificate-chain

---
id: config-digital-wallet-open-id-delete-certificate-chain
title: "Delete certificate chain"
description: "Removes the certificate chain of a key. The key then has no `x5c`, `x5t` and `x5t#S256` values, and it cannot sign with the `x509` format until you upload a new chain with the upload certificate chain operation."
sidebar_label: "Delete certificate chain"
hide_title: true
hide_table_of_contents: true
api: eJztWd9v2zgS/lcGvBcHkO0kTXa3vqK41MkevO1ee03aPjQBREsjmRuJVEgqjhv4fz8MSUuyrbTF4R4OaJ8si+Rw+M2vj6NHlqJJtKisUJJN2Hss1T0asAuEBLUVmUi4RUgWXEhQGXC4xdUIrhZIDzRPwoIbkArih9MkjujHxsBl6p7+dnl8+ksM97yo0UTutbCQcCmVBSNyCUthF26/+OH08HkMmdIlt1BLKwpYqRrqqlA8BQ4Sl0GRZk0Y61G1Qs3pUKNreS2vFsK0r0AY2oUOYEBIfyYwVmlsJSe84nNRCLuCuCN+StJjGMSFSnhBx73ndWHpIU+q4W1p6JEvTfP4pdY4vMXV0E/0yKSVSuODEcwsSMTUAAeNdzUaC3OVriZgkKY9XrNEyUzo8ppN4JqdX7y5uLq4Zut4BGdguEzn6gGUzrkUxp8tQKudIYHvQxMAQVjyokCamdWGTK42i9zxPc4LUfj/DiGRS/OEvSa0lcYUpRW8gBQzIQUpFAGHSqNBab2C20PGclsbKISxkZNKm2AKwpgaNZRoecotB6XdaNC50upepKghL9ScF+BAyutgXrsg/zHBjUlzp3Oc6FVlVa55tRDJa1z97jSPw0FGcIkFJha4VHaBzj2cm9gFGvTyMqGNHcEn8vqNbPJ+DpZM18HaH8a9nZ6Bxnt1iwaE9SFAY+TN0/dvyBlLniI5ojs/Lx36MsfRtWQRa9x2lrKJd4f8XOTC8uKTQ+NthXKWnmOBFqc7nsoiVnHNS7SoDZt8ftyJ9w9S3NUIwtktE6gpxsPJWMQEzam4XbCISV4im7BbXM1SFjFyV6ExZROra4yYSRZYcjZ5ZHZV0URjtZA5W69v/GQ09pVKVzRjW4ep93Bvu7B96k7TieKeHRMlLUpLAnlVFXRooeT4L0NSH/cVUvO/MLGEiCa5VqCh0RBg+5pHX9PTzyGfsU5hl+AohmIfozFpjLIu2eRzCFt2EzF84GVV0Cbh3XrdPdjnRpub9doPmUpJ4zU9PjzcR28rkil80/7kTfr8jxDjWYaJxXTaxPu0G3+mI4FrzVd7SJLOnWSxFb0GlgtlfB4QMnchliwwuYVMWItpJ0O7FEXhlAuqWXGq0AylssNM2NjNU7Vtp7qqFUqWWajl7gIfgEJDHPZ+jasp7UzJVgKWlV25RAXLEP8aKXqlkkjoCoul6UPPCutMfvZ13PZgOnsSpCcxWrpSbHePNseMiluAQua4ibPeGi+s6YoOVXsPYKmWnggEkcJAqiT+3QveUleqpYN8T4aQbrc+xHdP3BZmi7nSK4gJ+Ji2DanT2UbJYuUNJCyNcQnl+RsY0AR60HWBByS+ZRMoU18q8IGM3ElD7vRzTHhtcGeGMDBXNeVy5TdHnnXhHO0nmsaY500JpJz+rbyzEy1t/WyM2AXK5Z0my/ySHSXH/FccHqYn8+FJcno6fM5Png2Ps1/xaP48/S05OmTrqKPblkv+F+ptW02kEfDGQG9n5ycfpzNoAwBmvs7/Ger8tvYXZVWoFeIrnuY4NOlfS0vK+kr0PXrFBZ9jEfcCFQEWBr37pcJUBV+NSHIcBmzP+j4r9KsMc9J5B9rguS6HFsXbzBXk3VNsssV0b52ru/uHFKkn5l0jbGJk0MTF/qjADic+mHj/np2fXbbL9+RuedomAgdSbSUSF2IRxJVIYxhUqI3zBE8xksACueU0Bzl3AuTwruYFUZAUuCXe5NWKIL7zc/rHiRjGVT0f+kmdIU8hU5ivaA4ROQ5VPS9EAgYTq7Rj2gfdOk3HobAVBDRyziJ253/CDtslnF4Qu/l6PHSw7AnWdcRKNIbn+H1lk7A1nuFuSGQXesqurgBkRDWbnJmJh00c7qba0Wb7uK+GPRFbbyVx2wc7Yus9AtOf5b6WYkJE94ZKB56bdQf8zze7G3+Tldw4XRfIU8eFH+nfiadU302Muhui1kpPVUqau+fzDkY30TdIVLu6RVtIiznqbkI5OTxc94jvsVDrl694CkJWtYWG+5Od6Lw9rrrPat2VRBhDj0p7imMbYhtt3Xx2Qt8V1HaGv1O3xbT1T8tve2+nMIjPet6G+0BQhd9zUfB5gSGsSbJLVf++unzXbjzp0MRElXR/06p0L2niKD6INvfKrSs0sYbeyzVFyK7/HP3A/vNB8toulBZfMO2B5uQHhuZq16lCsDTdCEstKfo3O+9zq+c/OHbf6jfBIJ7uZQl/FSCu7hb193uAxEzgRaJqac3L72/7UL8u3iyLN03EcD6Ij/rp4cAcRHD0VAssjHa6YJs3vW0wGvmeFtjAHMT7XnX6Qxe7mbSoJS/AoL5HDW6bHYzWETOY1FrYlePmZ5V4jSvHNuiMPDeuneO7b+DbbzBwDTi62RywiL3GFfzJJc+xJJBviMDYhaLenS9iriVnF2zCxvfHY2+2cepFDr1xx6pCKdIxdY3LRhb9NeNH14Bbjzs1cpiEVp8/WV+f7xxLFQ7OIlbrgk3YwtrKTMbjFEs15JUYiVxzaUdCsXW0K+CdVmmdeJLQL+ZbEi4tz4lRPLHc+OFdRW5ai1ySY3p/2tilJcz+RehYepO2PcuzUKWeaLO8m7mgp1pG4ZuE281V09YLBCbekhOD3wbKmrr2SCGeiYdNhyr2OoK73Vh/nbSai8JhUPGErkg4ykc7YicQFr5YqVoTHPTx4GU8cq1CCtL3bTP1YhMGnTZm01kkMDK1iXieuIjHkguC3dRVpbT9Rwt1g5b4Z/tq20Zd8+6A2CzaJCbiUIki7Yi30W/Z5L+Ap48bl0U/ohaZcJSu5e/GdQe4TBAGoXVw4HpR/QvfdVNsE5TvDkgjqxJVGLKpMEAGR0lrTKjRX0Lr0SqfcSNYqCL1ja972mEFIUI7Sd5A7SiysVymXKdm6M4ruLSQFdTsco4QkHbafno2hY9TGPzx6eoggtnF1e9weT7849MVfJz63WaXb+Hot8OjZ8NTKM9VMqaeVaew+OpnKLkXIkFpnPE3fl7xZIFwPDrcM91yuRxxNzxSOh+HtWb8Zja9+NflxZDWrNvmQ2tOAitVSd1Yj0WMkow3+/Hh8cno2eiI1lbK2JLLjj7+m8Q+nd8NwU5N+vkF8ucXyJ9fIP+/vkCGGksNn3FVUPyuQ3p5DFTmM7s/9t+XMuG6RVt0xn/ElK6rtk1p/AvDIjbZfFfc5zU3EVsoY2mXx8c5N/hBF+s1vb6rUTt2FrF7rl0V8NxHGHpO2STjhcGvZJvB+8BxD+Abn0J7QdiwD0kzXIZhE+YP1XwqXd80XSennB+behWGVyShXbtHyIlH+RVnSYKV/ercLtkMLCBi8/DRtXT0m2m+pG+pfMkm7JpdM2ec5rOde//ICi7zmuc030sm7kH8aJtyeWTCQ6eXvY3HLvtqwHGH613ygqrOa1y9bKb7kScXNIzPzybrULvvP36QPNA=
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete certificate chain</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/key-management/keys/{keyId}/certificate-chain"}></MethodEndpoint>



Removes the certificate chain of a key. The key then has no `x5c`, `x5t` and `x5t#S256` values, and it cannot sign with the `x509` format until you upload a new chain with the upload certificate chain operation.

This operation is for keys in a key store with the capability `certificateChain` (`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`). It needs a request body: send `{"confirm": "DELETE"}`. A sandbox organisation cannot remove a certificate chain.

The wallet refuses to remove the chain while the key signs with the `x509` format: a credential definition, a presentation definition, a status list, the signed issuer metadata or the wallet provider global configuration that uses the key with `cryptographicKeyFormat` `x509`. Select another key for these uses first. When the key has a test certificate, the test CA revokes it, and the new CRL is made in the same change.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key","in":"path","name":"keyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Confirmation of the delete operation.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"confirm"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`DELETE`]"} schema={{"type":"string","description":"Confirmation string. Set the value to `DELETE`.","enum":["DELETE"],"example":"DELETE"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet removed the certificate chain.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>affectedCredentialConfigurations</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential configurations whose signing key check fitted with the chain and gives `does-not-fit` without the chain. They then show `does-not-fit` in their `signingKeyCheck`. An empty list when there is none.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The credential definition of the configuration.","example":"6f1c2a7e-0d4b-4c55-9a43-2f7e1b9d8c10"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The credential configuration id, as in the OID4VCI Credential Issuer Metadata.","example":"EmployeeBadge-sdjwt"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `label` of the configuration, else its `display.name`, else the `label` of the credential definition.","example":"Employee badge"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialCategory"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}></SchemaItem><SchemaItem collapsible={false} name={"messages"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The rules that the new certificate does not fit, with the fix, as in `signingKeyCheck.messages`.","items":{"type":"string","description":"One text."}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"affectedCredentialConfigurations\": []\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The confirmation string is missing or is not `DELETE`, the key has no certificate chain, the key store of the key does not take a certificate chain (`A certificate chain delete is not available for a key of a QTSP key store: the chain comes from the QTSP.`), or the organisation is a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key with this key ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div>

The key signs with the `x509` format (`Certificate chain is in use with cryptographicKeyFormat x509: <counts>. Select another key for these uses first.`). `<counts>` is for example `1 credential definition(s), 1 presentation definition(s), 1 status list(s), 1 signed issuer metadata, 1 wallet provider global configuration(s)`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete key store
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-delete-key-store

---
id: config-digital-wallet-open-id-delete-key-store
title: "Delete key store"
description: "Deletes a key store that the organisation added. The key store must have no keys of the organisation: delete them first with the delete key operation. The wallet deletes only its record of the key store. It never deletes a key in the key store of the provider (a vault, a cloud KMS, a DPoD partition or a QTSP)."
sidebar_label: "Delete key store"
hide_title: true
hide_table_of_contents: true
api: eJztWN+P27gR/lcGfNoFZHmz2Sta4XDonr0tfJtrtmcneYgNmBbHFm8lUiEp77qG/vdiSFr+mVxf2/TJMjkzHH4znPnILRNocyNrJ7ViGRtiiQ4tcHjGDVinDYIruANXIGiz4kpaTrLAhUCRwqTAA9GqsQ4KvkZQmoYt6OWZagbCr0ITFSylsQ5epCu8YJwik7pG4xXCKi+8LNFFAQtalRuQzoLBXBuxW6jzJYWRA4VrNJ1K2JRUx4I7zdrotRRo4IrDmjelS4BDXupGwOOvY/ozfNJDqLlx0iOgDXD452T8dJ1O1VRNCmn3PoNCFLSkwS8NWgcLLTYZWFQC5tspy7VaSlNNWQZTNnx49zB5mLJ2nsI9zEud83J+4GHOldIOFjt4BIlZrsRCvx5HJUpGFA+imE4VS1jn3kiwLPiwGsqVdLz85OF9X6MaiZAFj7gZkypLWM0Nr9ChsSz7vD3JmQ9KfmkQpEDl5FKiuRCLsKeerlEtuJ4nuwHBHV9wi3NCM44VtprD0qN7FiSprONl6feQAJYWw/B+7S5bc4PcHcW5i41B1xiFImUJk7SFmruCJUzxClnGnuPGR4IljOInDQqWOdNgwmxeYMVZtmVuU5O0dUaqFUtYxV/foVq5gmV/umsThq+8qksSOdo8a2fBKlr3sxYbMnUM6CDkRvA1bjxGdH8mLriWa+VQOTLI67qUuZfs/27J6vbcc734HXNH4TVk10m0NBtT89IWv+FnkElhjAH+NS8bBKdhHrJ7Th6jaiqWfY4Jz2aHIMWxtj3c2OfOm1nbhilba2WDp7c3d+foPXYBj4cFbJPnaO2yKctNqCU7K/5UgrSAVe025GGBXPg039Jqdzc3EZH/DNhDx9EYbQZa0Pnx38MDN2fJHwRhr70Pg1QOV2jYAWp3NzftBfMXQrcH+mcuQKq6cdAda9YGdI+RJKTy8xgTXpW0lj61oX9UcnZhTk6qq6QieFbSEtI86yle9lJduxSZN99xZD4o3rhCG/kvFBegufuOoZmcJlXBbWQjMSMj15AWRsNLifWX7xy9PVIE3ddY3DlyP3zXxXKkHBrFS7BoiHT6ZU4wahNmMW+MdBvPo+5r+Yj0OSNO4PjK+uYYCBkERgZXnpMN7z4Orlniu9uvXPEVVgTyLGEVukITnQvtzrM14iCsv77tB4rXF8FkL3DoPjERKfrPuOlVnS3/18fd9rd7CtQycpq2dIn7DbHScccsYY0pWcYK52qb9fsCK93jtUzlynDlUqlZm5waeDJaNHnoLpfN/JGFseMrakVfUbdh+tSR2T4UY8rIkEi7gHQZwcNApIkhlnuieB+LsM/wM3p0/zTyZ4lKNdHT/OAyE9hRPFbzIztzCMuEy9SCLia4lK8oQuGaBx9hDldKh0sUOMNl6TGoeY7XCWC6Sk/MZhAVf9zoxhAcvWfc/DRPPeOi0/nbnpM+7PL/gA12BI3AWOrdUee5P+pYcUmw26autXF/3UPdoSX/vh86jtFheE9A7JR29zOiCLkm7xyCpF9K3iOuHA6Mv0J8RCOXki9KhIFBf0vgpYWRtQ1XOcLVe3+yRtfAlfiK4pNB2y3Rncana/LI6VyXlmIqLVDAUZGOjaUyQG+JBktrG0yg0KVI/GJrWmED8WjSdaVzr/HcyjquBDfC9vx+JVcOlqV+sSERItLe209vB/BxAFe/fJpcJzB6mPwNxsPeL58m8HEQVhuN38ObP9+8edv7AaqhzvvV8N3BmmSl4s5SVS9ljsr64O/yvOZ5gXCb3pyF7uXlJeV+OtVm1Y+6tv9uNHj4x/ihRzptwpx05VEOeLCEzpsueixhVGRC2G9vbu/St+kb0q21dRVXB/4M948ENt5QxXFB75rQ/180/rdfNGKddvjq+nXJpaKM8Sm6jX3wM1vfsiQ+dlCmHPXC8CiiJNHo434YB0JHZAnLDp4FZgkrtHVkfLul94sPpmxbGv7SoPEdPWFrbnwBCW1TWvoWLFvy0uI3Evbqt8iLruG/+2XlYmh2fVVRU/VdkGUsQH388tLO2h158gAGgUGAqTchM3sDZ0STaELQuM9zrN03ZQ9JVGxyCVvEp5nK00pm+Au9uPAXlrEpmzKfN764eypL41tWcrVq+Irkg2VqrdT+jxnFs2cU8YP2dhGUU3LRIeQ3d1HlRyqqj7j5qRMPM19V6AhNkKYQ0TvLvwGdBbJY
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete key store</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/key-management/key-stores/{keyStoreId}"}></MethodEndpoint>



Deletes a key store that the organisation added. The key store must have no keys of the organisation: delete them first with the delete key operation. The wallet deletes only its record of the key store. It never deletes a key in the key store of the provider (a vault, a cloud KMS, a DPoD partition or a QTSP).

This operation needs a request body: send `{"confirm": "DELETE"}`. A `local` key store cannot be deleted. A sandbox organisation cannot delete a key store.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else the identifier that the create key store operation returned.","in":"path","name":"keyStoreId","required":true,"schema":{"type":"string","maxLength":64},"example":"local-openbao"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Confirmation of the delete operation.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"confirm"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`DELETE`]"} schema={{"type":"string","description":"Confirmation string. Set the value to `DELETE`.","enum":["DELETE"],"example":"DELETE"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

Key store deleted successfully. The response body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The confirmation string is missing or is not `DELETE`, the key store is a `local` key store, or the organisation is a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key store with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div>

The key store has keys of the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Delete key
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-delete-key

---
id: config-digital-wallet-open-id-delete-key
title: "Delete key"
description: "Deletes a key of the organisation. The wallet deletes only its record of the key. It never deletes the key in a key store of the organisation (`vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`) or at a QTSP (`csc`)."
sidebar_label: "Delete key"
hide_title: true
hide_table_of_contents: true
api: eJztWF1v27gS/SsDPiWALLtJCiyExeJm7eyFt91ttnGbhySAGHEscSORKknZ9Rr+74shZVn+aHufb/tkmRwOh2eGM2e4ZgJtZmTtpFYsYRMs0aEFDi+4Aj0HVyBok3MlLSeZGGYFwpKXJToQrbRW5Qqks2Aw00Zs173gKoapA4ULNJ1wOwNStbtYpw2e2gvO0gVvSpdGkOZZPXipLH3ype0+/2kMDl5wNegERa1Feg7aAHfA4a/Z3S2cpZnN0vP4UT2qnvkG540li3RrXGuQK7gDacnCxmLi7RI4px1oPuqLccgMClRO8pKEpJJkOsnUBi0qF46ym/KmgXXcNRZKaR1YmSsLS+mKKEy22HMF0tqGqwzD+AKNnMssaJQK5qXMCxdcYpALv7CxPEfQNZog57AsLSwLNLjDfns4goar4PUOIGl7yxWioHgw+KlB6+BZi1UCFpWAdP3IMq3m0lSPLIFHNrl5ezO7eWSbNNhk0SxkhjugvZ1Bz7JA5QdIIRlUSWulymO4BsuVeNaf94Mh40ppt+cpb+/9VhEdrOBkq6MNMjQuoNUF13MjSzeQKgiMryM/2v4Bgwv9ghaki4Ar4efaSAkeogGFSxi/f0vw0V/LK4Ss4CrHGPYsabfcKm+tJ0VhV67sEg0dPH09ukzhLP2NyxIFRSNJeSHaaV9RAm9wBRVXPMcKleswlhZoA77gsuTPJabn3SHCJeMrGz8qFrHOt1PBkuDAfCJz6Xh574/7rkY1FSEo3uCKRazmhlfo0FiWPKwPcsYHJT81CNLfgrlE07v/LGKSZGruChYxxStkCXvB1VSwiFEsSIOCJc40GDGbFVhxlqyZW9UkaJ2RKmebzVMQRut+1WJFEvs2jEMYhkhpt28jpTtufGLHTCuHypFCXtdle7eGf1vSuj42SD//jZkjRAzpdRItzba34Njy6Gt2BpkY7tB5gxe8bJD8n4aLlJLFqJqKJQ/t3WJPEcPPvKpL2qQd22z6B3vorHnabMKUrbWywdKL0dUxehRSAS0BtskytHbelOVqm1nC+u6mYlW7FdlWIBc+Jta0z9Vo1GLxv0HaNxmN0WasBdKJ6XvSM/Ap+gb8u9U7B0jlMEfDenhdjUabE+pPOG0H8a9cgFR146C7A2wTcN3HcNbLbQcpLVz47Nj120u79XfUT9AHVYcqQJe2fZ04KpeSct+p3HnKV6++Y199ULxxhTbyHxQnoLn6jqGZHQYVVVSlfQQSQwFH9ID+TSfHYfX6u04BU+XQKF76mowG/DYnMLr8jjGafZWoRXuc5csUqk/FQpHacZwDwDcRs5g1RrqV5y7XtSROkzw8EalwPLe+ugb+A4EAwZmnQJOrj+NzFvny+EfHuAjnCl2hiT2FqukZkitYwoaLi2FgVEMRVA4ChRzqGpUUQ+pVduyN/trh2vOhDSNLKXBOkawJVrqNKxaxxpQsYYVztU2GQ4GVHvBaxjI3XLlYaraJDhXcGi2aLBSf02q+peHO8ZyK1heW2zB9aMjTDv87iukQilsvdDHFw0BLF4MDd4Txuk3X/o4ckarr26n3PyV14qBZr1MNnKqNpHRPTwphG6gaqtlIDdtcfkYREl0abIQUzpR2oXdyhsvSY1DzDM8jwDiPD9Qm0C78eaUbQ3BQg/pLGnueRvf7/Y7J3mxvUI9DdrSOwJjrbbLgmU8WWHFJsNumrrVx/9lB3aEl/7sb2vdR370HIHaLoDZ6IYV/BMg0WecQJP1WXTfb4hluCcy1gY++NaXGA8ZdQ2xhuu1fz9756zQNXcnphbf9hrm7grfnZJHTmS4t+VRaIIejojW2LVYBet/KU8uMERS6FCGd+K55Be197PXrFhrrnem4EtwIO/DnlVw5mJd6GXpyaJH21t5fjuHjGM5+v5+dRzC9mf0Gd5PB7/cz+DgOu03v3sGrn0avLgevoZrobFhN3vbfCOaaOKBPU6XMUFnv/G2c1zwrEC7i0ZHrlstlzP10rE0+bNfa4dvp+ObPu5sBrdlEzElX7sWAB0vorOm8xyJGSSa4/WJ0cRVfxq9oba2tq7jq2RN6wLaRE/vFoCtgPx6Nfjwa/Xg0+j9/NGrLtMPPbliXXCpKGD5DrVvu88AWFyxq35MoXezxn/DupCT1W/scKAxYFrEkvAs9RazQ1pHG9fqZW/xgys2Ghj81aDx1i9iCG180AlWSlr4FS+a8tPiVVHX2vmXT5/CNZ6uTB96SFUUSnlqwhIUDdM9am6fNloF648LcOJgwmJGG3doj6k+0K6y4zjKs3Vdl+0y0JQ0Re24fyCpP9JnhS3r34kuWsEf2yLwjfLH0zQWNr1nJVd7wnOSDZqIqRKf2GVpApv2gs53E45CsdeD4w51c8jMVqTe4+qUTDzNfXNARxCBN3qHXrn8BKIueZQ==
sidebar_class_name: "delete api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete key</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/key-management/keys/{keyId}"}></MethodEndpoint>



Deletes a key of the organisation. The wallet deletes only its record of the key. It never deletes the key in a key store of the organisation (`vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`) or at a QTSP (`csc`).

The wallet refuses to delete a key that is in use: the default key, a key that a credential definition, a presentation definition or a status list signs with, or a key of an issuance or a verification in flight. The read key usage operation tells where the key is in use (`canDelete`).

This operation needs a request body: send `{"confirm": "DELETE"}`. The service refuses the request when the body is missing. A sandbox organisation cannot delete a key.

When the key has a test certificate of the built-in test CA, the test CA revokes it, and the wallet signs the new CRL in the same change. When the key of the test CA cannot sign, the answer is `503` (`Failed to sign the CRL of the test CA: Key management service is not available`) and the key stays.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key","in":"path","name":"keyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Confirmation of the delete operation.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"confirm"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`DELETE`]"} schema={{"type":"string","description":"Confirmation string. Set the value to `DELETE`.","enum":["DELETE"],"example":"DELETE"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

Key deleted successfully. The response body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request body is missing, the confirmation string is not `DELETE`, the key is the default key or is in use, or the organisation is a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key with this key ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The key has a test certificate, and the key of the test CA cannot sign the new CRL. The key stays.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Exchange code and receive credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-exchange-code-and-receive-credential

---
id: config-digital-wallet-open-id-exchange-code-and-receive-credential
title: "Exchange code and receive credential"
description: "Exchanges an authorization code for an access token and receives the credential in the OID4VCI Authorization Code Flow. Call this endpoint after the authorization server redirects the holder back with a code."
sidebar_label: "Exchange code and receive credential"
hide_title: true
hide_table_of_contents: true
api: eJzlWFtv4zYW/isHfJoA8jXJJDGKYl0n03U7aIxJZuYhDWBaPLI5kUiVpOy4gf/74pCSLcmZCxb7tH1JZIo8PPfvO3phAm1sZO6kVmzEbp7jFVdLtMAV8MKttJF/c3oJsRYIiTb+TRyjteD0EyrgSoDBGOUaLbgVQmxQoHKSpyCVX7mdXp99mkxh3JA4IYnvUr3pwoSnKbiVtIBK5FoqBzxxaPzpph4WzRoNGBTSYOzClSudCjSw4PETbKRbAff6dlnEdI7Gn5wKNmKxVolcXsuldDz9zNMU3W2Oaioqy0mpsRIfgkGTvSksYgb/KtC6X7TYstFLy3PjY2eRY6zjDsGtuPuWKa4wCkXlrcq0bnmnNCjYyJkCI9LfoXJ0P8/zVMZeUu+LJSVemI1XmHF6ctsc2YjpxReMHYtYbsgRTqKlt6RfbZd1Rqoli1gm1XtUS7dio0H0fQu/bZdO/DtpbfEdK/GZZ3lKmoiLZMCH8VnnanF52jlL+ti5jIeDzlt+jn1xurhIBldsF7FDjk2FrVnCjeFbFjHpMLOvWdi0aeqFJDJoq1UjeQ3G2ohg5IZLZ336k+4h8bFMmS4p9DW5tnLDkWCqH4g1Ge6wC7/KNfqNa54WvpJK3258ltJ57lDAZoUKpIPcaCpCFG3pOknQdGGawFYXIDQo7WBJ0nmQHdXFFva4avf6kQoZd/HK75j7ZJ4HIY2wPbC3b8/74jQ+XVwuBvGQD5K+uMKz+II97iLmz70WDFWkKV+QhJDdTSfe+drxt/23FQT3R5ZKW4nUkEgV3OeNlGrZ9IIv9y7coRIwJ13noA2kyMtIJRJTAbpwISj1m2HFLSgd6r+Z4ouL+AqHyaBzxs8vO2fidNC5SoZxp49vF5d8IM7ji1O229Vr/yEU7ONuF9ZtrpUNlTzs94+bUc3qKknLNKn6Utmw28lDmv6vWsyhdR7pd2irR2leKdYIXYivBQ5WqmWKEO4EmbxSjj7XbauYXxenwPeLSk5LQqaNTzzVlkWoovA2YaOHYy981dJ6O6lhVqmTddqgbajJ0w3f2r22uEazDTnXhXGZfF5amWshraU9lIOHQmpcmOVuGzaMYP4n+5PNA5ZDqMUI5v1qRRXZAk0E84SnFqvVhdYp8oD2ZS2UZKCMRckMyJ9N4HpgUrBmx278rJC3tXxPQW2sNH5QcygsixhxkdxxFWN1QmCCxqC4KalE83KPRj5bsUQ0i4JQn0WssGhmsryVuu2YDhe52D9rTxZuzZIraStaETHdXiglfai8UFfhnTYZDwWDFpU7nJKVcofNE09YikBhyF73XCrb6ITX6LhMrXf8WoeS3bsoxSVPZ1KMnUMbrnt9dabz2otPaAjCRLhLz4K2LGJrNDbIcKawbqzilSatn3yg8TknkyfNSNrX3thDotgbFZttXuombXX5Z+lW93TLe2lddeMdmrWMcWb0WgrvME2xJC7ZdsyH0MW9zMD3Pirp6p543EUt+rDzjXYXsRVygYbaGf06C632h/tjvQTQGG3KwPnn61qbeIy+00sPpw9tVyqHS2/7HlrO+v3dK+JfAd4DGv3CCTXzwkHODc/QoWGl9ceYUk9zajTELNY8lSI6oIu0kElLfZpaQhnyCJrMqSL5bYqYFBWh2aPvv0Ob3NN4C9wg8NQGYsPXXHoOUfUzrsRCPzdUpX7UDuXgHxzKj6oqEV/cTdec/6OzfKocGsXTiln6a1o+IkaLcWGk23oGMM7l70iPjzuykS8t+aKcMSE0HXjjx0wag09YxEJSk0sydCtNk2mufZfKOQ1frLce9sKs2hNBUCewgh4hkBQ9K75sXO+AE72KvHTi4P9ggPUaNm28xkyX9hFSmZSN2Mq53I56PYGZ7vBcduXScOW6UjNqj00BM6NFEdcI+JGY70m4c3xJHeIrx2143Vbk8eD4O8q/kDaV+w9NPCxETNJVIXI0bPAM22PsEV8bz6bwhFs/ZpBjQ9oHWhb4Vdmy5g05cwjXQFZYBwuE3GAinysKNg86whzeKO3C8OAMl6n3Qc5jPIkAu8tuS+wIyoM/bXVhyB2dJ9z+PO/6+YBq8cPhm8RNle3VeP9jw/TRLP2tYW4/y/3gFEMxSHTVT3js+wlmXFK0bZHn2rh/HSK8D5L89bDUTI16VrVitz9EszERA+s/A4UBGyT9zyq6VYUxVKXHjsA4PJTUGAoQYSR2CW/Kr1gnngO/fnBWY3SHkp+dkEZOxzr1DF9aoDxDRWdsCVV/l+jmdIDDyA8Ikb9sTTdsoewEtVHEQuGR1jquBDfCdry9kisHSao3NuRf6Wmv7efTCXyawJvfPt+fRDC9uX8Hd9ed3z7fw6dJuG16dwuDy/7gtHMO2bWOe9n1+/pgnHj+aglVUxmjsj7nqvLKebxCGHb7R6HbbDZd7l93tVn2yrO29346ufnj7qZDZ3YRc9KljRzwzhI6LvbRq3HQERv2h2fd0+6AzlITzbiq6VNNF0ejLzQGC9FEkj36/T9+ES3bpMNn18tTLhV5zofqpYSfB7Yehi8BifQfzRoQVI5Bnux7GGpPaU0oeozYirBt9MBeXhbc4keT7na0/FeBxuNmxNbcyPAl6OFxT7w9dj1Rb2eTEJDOPelO29MitPoWNSGoCSfGfi785t46/M5u7+5ZxBblx90sdFDDaaCgvyNGU7M3PUxiRH1o/YWlXC0LvqT9QS41ZwpRE5OePCaVD7UvB1xta1q24SkYQ3/rY0rjyE9UH7/j9uf99vDmqwf2kBh2UwLQxPMfmkNrHA==
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Exchange code and receive credential</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/exchange-code"}></MethodEndpoint>



Exchanges an authorization code for an access token and receives the credential in the OID4VCI Authorization Code Flow. Call this endpoint after the authorization server redirects the holder back with a code.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Authorization code and state that the authorization server returned in the redirect.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty`"} schema={{"type":"string","minLength":1,"description":"Authorization code that the authorization server of the issuer returned in the redirect.","example":"d7f1a2c4-9b83-4f0e-8c21-6a5e0d3b7f19"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","description":"Identifier of one credential record that waits for the token exchange."},"description":"Identifiers of the credential records to complete. Give the values that the wallet created when it processed the credential offer. If you do not give a value, the wallet uses the credential records that match the `state` value.","example":["6650d3c3b8b1c2a1f0d9e4c7"]}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"State value that the authorization server returned in the redirect. The wallet uses this value to find the matching credential request. Send `null` or leave the field out when the redirect has no state.","example":"b7c9e2f1-4a58-4d31-9f2c-0e6b8a1d5c73"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet exchanged the code and received the credential.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>credential</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential that the wallet received. The wallet returns a single object if the token exchange gives one credential. The wallet returns an array if the exchange gives more than one credential.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the code is missing or expired, or the token endpoint of the issuer refused the request. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Generate CSR
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-generate-csr

---
id: config-digital-wallet-open-id-generate-csr
title: "Generate CSR"
description: "Generates a Certificate Signing Request (CSR) for a key. Send the CSR to a Certificate Authority (CA), then upload the signed certificate chain with the upload certificate chain operation. For development and testing, the create test certificate operation gives the key a certificate of the built-in test CA in one call."
sidebar_label: "Generate CSR"
hide_title: true
hide_table_of_contents: true
api: eJztW+tvGzmS/1cK/CQDLfmdSTSZ4BxZCbSTTRzLSRZIAjTdXZK4bpEdkm1FY+h/XxTJfkqOM3t3eziM88Wtbj6KVb96M3csRZNokVuhJBuy1yhRc4sGOIxQWzETCbcIUzGXQs7hEr8VaCz0RtPLPZgpDRxucD2AKcoU7AJhNL0EqzrTzwq7UFrYNfRGZ3sRDZRQ5JnifpIRc4kpJI0pyYILCSthF25EGLw9QuVEsFByAK+UhhRvMVP5EqUFTiShsULO3ZaQaKSJ9K61UrUGzMUtGjf2BtfA26Nm7sN1ITLbF9IvMzoDIkIiJDzLBl/kF3m1EKaxpDCOTze4NjTU8QuMVRrr0yU859ciIwbFidHxEOJMJTyLI4hveZFZepgnef9maeiRr0z1+EehsX+D674f6E4dp7lK4wFchYP47YjLphTSAM7cJzUDDu+vphfQixOTxHswR2tAWNM6/EyrpZtKQ8MxEa5VuqYDchgZHbAxgNfiFt3YONdo0MYl6/JC58pUnKTte/SQiY5A/LwGF/eGwGGJy2vUYBfcuvk6gDFVaEAq66QHlt8EEeYaZyLLPA4WCDPxHVO45VmBpiLJ7UTMcO/94sIv15nTntKAyoprpxzhuH11i1qLFOPILcMloNZKD+CTsAtVWOBhjah1DGEgTgpj1TIewAdik/Q8IvggTxYl/4gXpGYOPlwqu0BdUmUXXHpIbWtKzfVdtPu1+xoLg3El4RXPMrSQLDC5MS1yr3FGoBIWlhXHR9PLyLGbSxDylmei5J3fMT45OIg93fHzmcAsfTGE57lW1xkuX8SD6m1M3HDM5nZRUu7lH9VqI2SK3z2CHYSExSX0HLu+82WeIcSmuP4nJvYss2/5EgepNIODeM9rhj/UkI7ar0YOElVIq9eOAi5hMn0Hx4dPnvQPgWf5gvePIFEpDmAi3SlTlMRnouu1RkzQyXH8hljYdyaplHY4N1ojpmtp+fcYYqsLJG0vN1d6zqX4w2F+Ui0dw4J7dhg3kY48vppOYPwWjg+fwcnhUf8QkowXBuF0cDg46XDh49nVdNw/PX3y5Jdfnj599uzgMN7zgqp2NqgFz94WxOK4s1dj5ePOyleTt9Nx//Do+OT0yS9PnxFv6dzE3pnSS25pvgPv+dspSL7ECD5cTiLAJRcZ8DTVaEww1RnmCwK9dFTQzI78PFPfSQyoqjSDW6vFdVFb6TDPH1IqiN1+Z367mAxxY5RbNb7B9QfD5zjwFsIznabe4HosE5EvUJNfias1U255+0uPSxiPSMciuHw1gtOTpwdgMHGe4HivImfkjW/h9nO7f0umllukZczgW3JhrgkXAYzvZm9wLkzmcPEAMiNQGuLxh9hxZ1xolSOX8EESCRlfQc9B52oKhwE6T+Bi+rL/dHDcPzjdG0DMC7uYqkInWEIwCRs7xGQ1Kd3vC36LwC0slbFwdHDylEyP5olFbcqjJ0parbL6Cxnf98nF9CWYkgOO9TzLwC40BmGbCHhmlNOiphGt8UaWw9TuIWgd2Suh0UAvDo9p3Dble87ajT2kK8/gbDZY/G7NcAscQ+iAovQZPMvUClMfGpVYgN4OLJDz7ticYekvdorWDXEihp5dKSjyHHU/4QYhQ0ssjqCpm9NxZ4/lUknSomHJkxSu101WBe8TddVu6FyRmkGhRdDcCLyqCnPfYiud86Sf4dyHMSUZTT0ctljW1slfIS+8HNuWQkjo2HT3nbbYVqHBfVC+lwV5cd1Hzvu5VrciRV17wrArnRglScFR/I/B6cEBKJ2SA6iCpFJYVoWfxHpn/bznwe8WpRFKVmgjf841Ai/969C/PoMUE5GigRXhek6hjpDlurWP9+sGb+3CPeMtYxUoUEQXDkmaSD9LV06Rn56kpV98ONZuxgPCmKITu/M5F9K0tDAcU+LKRc3Ty0Y4UrG4Xt9pOk8SzK3fZZZx6zwK9EZGv8q4DeHm3rCJmtIIBBNgVQ4ZZQTRttmAMx++Oub40KKSBqkXbWZacUsvrmJesk+dOXUE7OkkJodPKkv9AejcnsIhFCHCo8ED5zZZxCoOTFI2ZImSMzE/F3NhefbJyfZdjnKSlmnayGgWsZxrvkQyAGz4+a6T0X2Q4luBjTilwXgWMUFjKMhiESN8siG7wfUkZRErNYQNKUqJmEkWuORseMfsOqeBxmoh52yz+eoHo7EvVbqmEW0armoclLF4OwonvvRqBu45H/ZjsTfSjFL2YU3nANaq0PekoJr8l0UdrLQb6eMu4xPJHWcnp4XS0tF4nmfBiuz/09D57hqsURLfzZwYApOUo41FzAqb0Yv6mCzawaeaMe3s04QMXDczcJ9SAK8yreh/NU366WztP5JPRRXF5Qn9sk5AaP5UuvXnjPK9lY2fNdYsYsFLE2Y8dWzIlqlK+qlKCnJhfVcUIf0O+KahwbGwIZuOyVw00gU2ZCGEgbOXjCBb+vvWFzgP67uaDmq2qTYIDtXpryRbwrw/GQRaKYRgXzebTfRDdDe0dCfCa512ICcmt9j7U6acIskSlLyWpEOem/gQ/kNw7yDj4pAFQU6YUh0wLVO8ALat1JTMZYkUfyb63o7B4l1RV+widMPluTSDw3YCTHn/Lm9ilXMYNZQdWikIqfIIE7W1UmUiEaTCGt6P6tjatO3b5yZQvm6+bipoGgICQbJETAAM2btiueQOhvS9CynolUSWpmUWzLkvVXjTssci5p7+eyrw0zDfbCLmYtI3FJK2T3GWJBRbdqp9HFz0CjlqoyT0Pl1enI12k90Idv9thd2d+7Mh287ef3Duj6j9vJ16XWhBIl9Ym5vh/v5qtWord8RcNE1jTJHnStv/2lJ+lhfXY84vQoTc5uT7gme0fwoGeea5eFG87I/PzqCMqRsVnE7et5O33ZD8/5jB5Wmq828i1sw8iCiXfDSoa+XvJan35SYU+Mnfyh0vQ7QSqd9qIqLkN7fEvak4G+6UscH9jK/2jw6OnlDNhpRiEzFvO9tyHLl3pe2MXDIeQgIyn3KnpMJC/yMea4fr+dOeKmJl2k4jPfk0OPURNVkGbguNhPtECysSMgwU8Tkr6A3s79USssiyiDWMxEUwsWz4+WsXBDSYmEueoc3aV6X/a/LwHrQ9yLEWc71LuY8dTW7s4sFm4+Gg0eRKGm//jw4OdsfzIdWch0wkdcGYSzyrPtCA/YnAuRtQ5FS30lZ4MhKjtxOPbnDxo4aVkHAx/nuoSbbiL9anfy/HrydvYTS+vJq8mozOrsZwOX7/YTy9cl+/yOfX3OCTk35idD+c6cUX6T6O357/YCKh1mXXD9N/b6oW2BpYWlN+iofJ0ewX3n96fZz2T5In2H82O+D9w+uj5Dg9wdPZkwPav1TQbQIIpfyaFvN5zr15W6BElz2emGbGsKJGXjPICmFVFZpRHj/rJnN77WPs9PnkrX0eYBqEc635emdUWQ7uUAq9HVlEp9lBQaMEXOZ27ZOb8lQafeoiXcRO3QWzC6pV7Fvj75OnZovSM4o00fcBTeGijllBqZdZkV9st4uu2tlKGujoaIZK8WFouUag8BWJwKkBxNTB7DfsWewzJE+NL+y48NEs1Mr8XDfUh/BUNXVV6mzF16Z+VZZWg1naleHxdnLYOP+DKeSvP0oG41yrmciwvxRmyW2yCIdtnqnKEPicys5VlNLWAdfv7kBoe62tnpsraVfhe5m6Slz5rtl2U1qHNUI5zs1vNfvqGtKuLqHTMVksydh3Bc1Km1Bx3uOqxSB61Tykiw4rpd1achOxJZrS2T4MxyYgAiSjcKPAB9xtI3G+u7EPSmZrryrbjXkvTConyjVYXRjyU6Thnv/ehfnGxG0Imw2owhqRUhZGyWDGrcu/UuXxR4uAsAM49y9IAsK5l1yrtEh8Acm70WaK5Thc8qeRZFHosDXaVfW806iMd8Mc+ih8gTx1Jb87+nXi/fRPu9vmfs7cjDyJ7vm8Iayv0QOuuZ5di11Ii3MXqVfHPDk42OxYfgdUapm/5FRjpz5AVeJkIUjpmlVXkO4ajRkXGabQ29Vr9rdQStUWBgp5I9VK+tf3FXmrwnBU6bW/W9FQ9IRLQgZ1xUN5wxeO68HP60cqIrzYnvJrddeiubKfEuxy54aGGcR12bRZzvT3MwyX6bX63v7Si6fFdaUFRE2jHWNVFdwRRbQ+aWQXdod/Ydh9kNyX//7AdAdrTv7CrLnqojAEhgTj4FeFcb8m59CLf8e1A99MFTIdOgWZpC92Ie70L23oJtKiljwDg/oWtY8Ud/Do+C/Mo7atrWM6H9X24lfeK1jleiplsjoEwuCSSz73VxCIwyLBqrF/y4VLlbZBSXUJTArqArjOz1kufse18+zEMD53KXlo44Hv40HPdfLOTz66iiLt/fdqb+LzEu1CURMwV66O7np0Q7Z/e7Tv24L7IYPvewO+r3KUIt2nm4D1Kein2b9z6rTZ94GFh86uXuE5LlVAFotYobNGGSnFperzXAzEXHNpB0Ix6gO0F7ioYqD7lnlohanlcwrr7plu/OcuIV9rCUwJ1R6MpRzq7NG/CF1PL8K67xlaOaHSshViXEz8ndCCLq/aoEw+8mzlInFrnRj8NrAs3J05XxKnBMbfBvM0Qgw9lxi6GENzkTke5DzBvQhwQMlaa9khhInPqX1J7KAroC9iH3qShl/WDdnx/99WE4lqpkpjxj1loURdVahrIFSyFK/rV20ENcHXEXE1qaxUu5xXET2Us9NfOo33Z0HaXotd3uIr72QiYKTRFXF4ZmBiTMFlgtB759R9sucSjt0TL0g+5RaVibjYI4qsSlRmCHHCAMERJc0x0BSNIbvmIsQIForaUVV2s4ZgMegedEVeYRzULJcp16npu/MKLi3MMsr6HUwDpx21n45H8HEEvb99utqLYDK+egXT8/7fPl3Bx5HfjW4vHT49ODzun8LyXCX7y/M3jT1DEc71oTKRoDQOB6UW5jxZIBwNDrZER5Vs7j7TPcn9MNfsv5mMxnQLkeZs6nJMLU5iVon1UrvJBHqxHx0cnQyOB4euUqaMXXLZoOd1IwbuGoWGi328Of94c/7x5vzjzfnHm/OPN+cfb84/3px/vDn/eHP+8eb84835x5vz/6Gb86HEQ1ZnP8+4cBcvXP54F2pnn9ntkb+RMhOuJdmqn/nL91JQIb9dQ/MvDIvYsLwaT4W0rxFbUGlu+Jnd3dHtkA8622zo9bcC9drfCbrlWvj7FVRsE4aeUzac8cx0b1s0k8neZdCxPXjg/v7OY5flLrmurxgxf4zqfr+76RlKYESc/zbyJPSvaIV67lb5mAp3fsaZg9oPxzarmRfvplcsYtfh/wksXamYab6iS6l8xYbsC/vCnDBcOcOVp+n9Hcu4nBeuvcz8ulQeIjPVrvB5voSHxkX8Nje6xb6KNaxxu7k95TmVEX7H9YtquP9y74SqwOhHk2yodfsv5nMjdg==
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Generate CSR</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/keys/{keyId}/csr"}></MethodEndpoint>



Generates a Certificate Signing Request (CSR) for a key. Send the CSR to a Certificate Authority (CA), then upload the signed certificate chain with the upload certificate chain operation. For development and testing, the create test certificate operation gives the key a certificate of the built-in test CA in one call.

This operation is for keys in a key store with the capability `csr`: `local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`. The key store signs the CSR. A key of a QTSP (`csc`) gets its certificate from the QTSP.

The body is a CsrRequest. Give the `preset` of the purpose of the key (the list certificate presets operation): a member that the request does not give takes the prefill and the fixed values of the preset. A value that is not the fixed value of the preset gives the warning `preset-override`, not an error. Without a preset, the request is `custom`. Use one key for each purpose: a CSR with another preset than the certificate chain of the key gives the warning `purpose-reuse`.

The wallet checks the request before it makes the CSR, and an invalid value gives `400` with `<field>: <problem>`. `<field>` is the path of the member, with the index of a list item (for example `subjectAltName.dns.0`). The checks:

- `subject.country` is an ISO 3166-1 alpha-2 code. In an identifier, Greece is `EL`.
- For a preset with `etsiSyntax` `true`: `subject.organizationIdentifier` has the syntax of ETSI EN 319 412-1 clause 5.1.4 (for example `VATSE-556677889901`), and `subject.serialNumber` the syntax of clause 5.1.3 (for example `TINSE-1234567890`).
- The format of each DNS name, URI, email address and telephone number of `subjectAltName`.
- One value for each attribute of the subject, and no `emailAddress` in the subject.
- `keyUsage.values` has no `keyEncipherment` and no `dataEncipherment` (an EC key, RFC 5480 section 3), and no CA key usage.
- `qcStatements.qcPsb`: `countryOfLegislation` is an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). `authSourceIdentification` and `legislationIdentification` have at most 2048 characters and no control character. A QcPSB statement has all three values, also without a preset.
- The fields that the preset requires (`required` of the preset).

Examples of the error texts: `keyUsage.values: keyEncipherment is not allowed for an EC key (RFC 5480 section 3)`, `subject.country: not an ISO 3166-1 alpha-2 country code (two upper-case letters, for example SE)`, `subject.commonName: required by the preset custom`, `subjectAltName: one of uri, email, phone is required by the preset wrpac-legal`, `subject.emailAddress: not allowed in the subject; put the email address in subjectAltName.email`, `qcStatements.qcPsb.authSourceIdentification: required by the preset pub-eaa-provider`.

The subject is encoded in X.500 order, from the country to the common name. The extensions of the CSR are a request: the CA decides what goes into the certificate. The wallet stores each CSR with its preset and its request (`csrId`). The upload certificate chain operation checks the issued certificate against the preset of the newest CSR of the key.

The operation also accepts the flat form (CsrFlatRequest): the subject fields at the top level, without a preset. A body with members of the two forms gives `400` (`The body has members of the CsrRequest form and of the old flat CSR fields: use one form.`).


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key","in":"path","name":"keyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The preset and the values of the CSR (CsrRequest), or the flat form (CsrFlatRequest). Give the subject values that your Certificate Authority registered for your organisation.

</div></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"CsrRequest"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"preset"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`wrpac-legal`, `wrpac-natural`, `pid-provider`, `wallet-provider`, `wallet-status-list-signer`, `eaa-provider`, `qeaa-provider`, `pub-eaa-provider`, `mdoc-document-signer`, `mdoc-reader`, `mdoc-status-list-signer`, `status-list-signer`, `credential-issuer`, `request-signer-san-dns`, `custom`, `null`]"} schema={{"type":"string","nullable":true,"description":"The id of a preset of the list certificate presets operation. An unknown id gives `400` (`preset: unknown preset; use one of <the preset ids>`).","enum":["wrpac-legal","wrpac-natural","pid-provider","wallet-provider","wallet-status-list-signer","eaa-provider","qeaa-provider","pub-eaa-provider","mdoc-document-signer","mdoc-reader","mdoc-status-list-signer","status-list-signer","credential-issuer","request-signer-san-dns","custom",null],"example":"mdoc-document-signer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The subject of the certificate. Each attribute has one value. An attribute that the request does not give takes the prefill of the preset. `null` is no value. The wallet encodes the subject in X.500 order, from the country to the common name. The subject has no `emailAddress`: put the email address in `subjectAltName.email`.

</div><SchemaItem collapsible={false} name={"country"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Country (C), an ISO 3166-1 alpha-2 code in upper case. In an identifier, Greece is `EL`. For an mdoc Document Signer, the country of the issuing authority (the mdoc `issuing_country`) and the country of the IACA root.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"stateOrProvince"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"State or province (ST), at most 128 characters. For an mdoc Document Signer, the `issuing_jurisdiction` when the IACA root has one.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"locality"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Locality (L), at most 128 characters.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"organization"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisation (O), the registered name of the organisation, at most 256 characters.","example":"Example AB"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationalUnit"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisational unit (OU), at most 64 characters. Some Certificate Authorities put the identifier that they gave the organisation here.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"commonName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Common name (CN), at most 64 characters. Use the name of the organisation or of the service. Every preset requires it.","example":"Example AB Document Signer"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisation identifier, at most 128 characters. For a preset with `etsiSyntax` `true`, it has the syntax of ETSI EN 319 412-1 clause 5.1.4, for example `VATSE-556677889901` (the type `VAT`, `NTR`, `PSD`, `LEI`, `EOR` or `EXC`, the country code, `-` and the identifier).","example":"VATSE-556677889901"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Serial number of a natural person, at most 64 characters of an ASN.1 PrintableString. For a preset with `etsiSyntax` `true`, it has the syntax of ETSI EN 319 412-1 clause 5.1.3, for example `TINSE-1234567890` (the type `PAS`, `IDC`, `PNO`, `TIN` or `EID`, the country code, `-` and the identifier).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"givenName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Given name of a natural person, at most 128 characters.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"surname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Surname of a natural person, at most 128 characters.","example":null}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subjectAltName</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The subject alternative names of the certificate, at most 50 values of each type. A type that the request does not give takes the prefill of the preset. The wallet checks the format of each value and refuses a repeated value.

</div><SchemaItem collapsible={false} name={"dns"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"DNS names (dNSName). A host name, without an IP address. The first label can be `*`. Give an international name in the A-label form. The `x509_san_dns` client identifier prefix of OpenID4VP needs the host of the verifier here.","items":{"type":"string","description":"One DNS name."},"example":["wallet.example.com"]}}></SchemaItem><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"URIs (uniformResourceIdentifier). An absolute URI with a scheme, at most 2048 characters, for example the support website of a relying party access certificate.","items":{"type":"string","description":"One URI."},"example":[]}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Email addresses (rfc822Name), in the form `local-part@domain`.","items":{"type":"string","description":"One email address."},"example":[]}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Telephone numbers in the international form of ITU-T E.123, for example `+46 8 123 456 78`.","items":{"type":"string","description":"One telephone number."},"example":[]}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key usage extension. The keys are EC keys, so `keyEncipherment` and `dataEncipherment` are not allowed (RFC 5480 section 3). A leaf certificate has no CA key usage (`keyCertSign`, `cRLSign`).

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`digitalSignature`, `nonRepudiation`, `keyAgreement`], `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key usages, each one time.","example":["digitalSignature"],"items":{"type":"string","description":"One key usage by its X.509 name.","enum":["digitalSignature","nonRepudiation","keyAgreement"]}}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`true` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>extendedKeyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The extended key usage extension.

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key purposes as OIDs in dotted form, at most 20, each one time. For example `1.0.18013.5.1.2` (ISO/IEC 18013-5 mdoc Document Signer), `1.0.18013.5.1.6` (ISO/IEC 18013-5 reader authentication) or `1.3.6.1.5.5.7.3.45` (Token Status List signer).","example":["1.0.18013.5.1.2"],"items":{"type":"string","description":"One OID in dotted form."}}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`false` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"certificatePolicies"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"The certificate policies as OIDs in dotted form, at most 20, each one time. For example `0.4.0.194118.1.2` (NCP-l-eudiwrp, ETSI TS 119 411-8).","items":{"type":"string","description":"One OID in dotted form."},"example":[]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcStatements</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QC statements of ETSI EN 319 412-5 and the QcPSB statement of ETSI TS 119 412-6. A member that the request does not give takes the value of the preset. `null` or `false` is no statement.

</div><SchemaItem collapsible={false} name={"qcType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The QcType, one OID in dotted form (QcType has one value). For example `0.4.0.194126.1.1` (PID provider), `0.4.0.194126.1.2` (wallet provider) or `0.4.0.1862.1.6.2` (electronic seal).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"qcCompliance"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the QcCompliance statement (`0.4.0.1862.1.1`), an EU qualified certificate.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"qcSscd"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the QcSSCD statement (`0.4.0.1862.1.4`), the private key is in a qualified signature or seal creation device (QSCD).","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` is no QcPSB statement; with the preset `pub-eaa-provider`, `null` gives the warning `preset-override`.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"CsrFlatRequest"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"commonName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common name (CN) of the certificate subject. Use the name of the organisation or of the service.","example":"Example AB"}}></SchemaItem><SchemaItem collapsible={false} name={"organization"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisation (O) of the certificate subject.","example":"Example AB"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisation identifier of the certificate subject, for example a VAT number in the ETSI EN 319 412-1 form (`VATSE-556677889901`).","example":"VATSE-556677889901"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationalUnit"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisational unit (OU) of the certificate subject, for example the identifier that a Certificate Authority gave the organisation.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"country"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Country (C) of the certificate subject, an ISO 3166-1 alpha-2 code.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"sanDns"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"DNS names of the Subject Alternative Name (SAN) extension.","items":{"type":"string","description":"One DNS name."},"example":["wallet.example.com"]}}></SchemaItem><SchemaItem collapsible={false} name={"sanEmail"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Email addresses of the Subject Alternative Name (SAN) extension.","items":{"type":"string","description":"One email address."},"example":[]}}></SchemaItem><SchemaItem collapsible={false} name={"sanUri"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"URIs of the Subject Alternative Name (SAN) extension.","items":{"type":"string","description":"One URI."},"example":[]}}></SchemaItem><SchemaItem collapsible={false} name={"keyUsage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`digitalSignature`, `nonRepudiation`, `keyAgreement`]"} schema={{"type":"array","nullable":true,"description":"The key usage to request, marked critical. Leave it out when the Certificate Authority sets the key usage.","items":{"type":"string","description":"One key usage by its X.509 name.","enum":["digitalSignature","nonRepudiation","keyAgreement"]},"example":["digitalSignature"]}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet generated and stored the CSR.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"csr"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Certificate Signing Request in PEM format.","example":"-----BEGIN CERTIFICATE REQUEST-----\n<base64-csr-content>\n-----END CERTIFICATE REQUEST-----\n"}}></SchemaItem><SchemaItem collapsible={false} name={"csrId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the stored CSR.","example":"5e1c2f7a-8b3d-4c6e-9f0a-1b2c3d4e5f60"}}></SchemaItem><SchemaItem collapsible={false} name={"preset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The preset of the request. `null` when the request has no preset (also for the flat form).","example":"mdoc-document-signer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>warnings</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The warnings of the request (`preset-override`, `purpose-reuse`). An empty list when there is none.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`test-certificate`, `preset-override`, `profile-mismatch`, `purpose-reuse`]"} schema={{"type":"string","description":"The kind of warning. `test-certificate`, the answer issues or shows a certificate of the built-in test CA: the text is always the text of the example. `preset-override`, a value of the request is not the fixed value of the preset; the request value applies. `profile-mismatch`, the certificate does not agree with the preset of the key. `purpose-reuse`, the certificate chain of the key has a preset, and the new CSR, test certificate or chain upload has another preset: use one key for each purpose.","enum":["test-certificate","preset-override","profile-mismatch","purpose-reuse"],"example":"test-certificate"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The text of the warning, for a person.","example":"Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----\\n<base64-csr-content>\\n-----END CERTIFICATE REQUEST-----\\n\",\n  \"csrId\": \"5e1c2f7a-8b3d-4c6e-9f0a-1b2c3d4e5f60\",\n  \"preset\": \"mdoc-document-signer\",\n  \"warnings\": []\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

A check of the request failed (`<field>: <problem>`), the preset is unknown, the body has members of the two forms, the key store of the key cannot make a CSR (`The key store <key store name> cannot make a CSR; the QTSP of the key store issues its certificates.`), or the organisation is a sandbox organisation (`Subwallets are not allowed to generate CSRs.`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key with this key ID (`Key not found: <keyId>`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The key store does not answer (`Failed to sign the CSR: Key management service is not available`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create credential offer
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-holder-create-credential-offer

---
id: config-digital-wallet-open-id-holder-create-credential-offer
title: "Create credential offer"
description: "Creates an OID4VCI Credential Offer that can be presented to a holder via QR code or deep link. OpenID4VCI 1.0 offers are not yet supported on this operation - the service refuses `version_01` with a 400 - so use `draft_13` until the backend adds 1.0 support. The wallet builds a Credential Offer by value with the Authorization Code Flow. The mandatory fields depend on the version of the OID4VCI specification. Version `draft_13` needs `credentialConfigurationIds`. Version `draft_17` needs `scope`, and does not accept `credentialConfigurationIds`. The offer always uses the Authorization Code Flow with an empty `issuer_state`. This operation does not create a Pre-Authorized Code Flow offer and does not add a `tx_code`."
sidebar_label: "Create credential offer"
hide_title: true
hide_table_of_contents: true
api: eJztWPtv47gR/lcGBAxsAPkRbdK0xvXarLPp+XbbpJvH/pALYkYc29xIpI6k7PgC/+/FkLIedh5XoP2hvQOCXVniDOf5zUc+MYE2MTJ3Uis2ZCOD3KEFruBsfHJwPRrDyKBA5SRP4Ww6RQNuzh0kXME9Qm7QonIowGngMNepQAMLyeGfXyDRAkEbEIg5pFI99OAsR1Xq3e8NQJNCC9wgKO1ghQ5skefakEatwM2lBZ2j4WQfdMHNESyahUwQDE4LixYmCzRWanU32J/AUro5cDgYDKALVkNhESbC8Km7238/gUI5mXot9zx5QCWAC2G9LeXGPbicIyx5mqKD+0KmwgLfDcL9ChY8LTBsSAqPCzfXRv4STB2R76epXgZ9GVeCO21WMJVIKgXmtLv3EaH0APTU/9yE3uaYyKlMvMoeXJerGv4oRGFhklTmjbSaylkRAjYWdrIrdlSJ2UTnOImAKwFCo/VJ4EmCuXtDJ/nkkwc8XfKVBZ+JV8JQJkYBZrlbwURaW6C5s4479Ppaia6MSXw9Aodzg92NahQNvaUVLQ+EAA4T93hHFTjpsYhVqseCDVniHTqRM+l4+tWn2hem+MHXb2iCOuU+4yxiBn8u0LoPWqzY8Gm3czYVEnzzNlFE6kDa0DuuCl5WWAeJVo5L1St3kAYFGzpTYESGOlSOduN5npaV0P9macsnZpM5Zpye3CpHNmT6/hsmjkUsN+Sxk2jpa23B2JvWkLDOSDVj0cveBBEY+99TuQGA2olcS+UsOB3KosSAsiCkhasvnwkdDPIQj13df0fHBXecQoCPPMtTMm3uXG6H/b7ATHd5LntyZrhyPan7i7ivzYwraUNA/hBj/CdxkOyLo0N+eHh/gIkY4OGgX2IFW0es7LG3fb9+vhl997RbcjsSU52memlDHAROeZE6kLbRsP8TCOgj4o1nQ7aRpNSoImPDm+arDaSw22bmqgXriL0MI41McGP4ikVMOszs2xn6hCvKjlYIqJxZgQww2sCsu6S5m72rgjqB0CSb9L5WjevtjesmsBv5ektob7ldHGWb2x5cWQx59bMgJGyxg+3PAvc2StdqWr1zw87n2umxqL1jt+uIecB/O74XtCzYbzHFxNk3XJ1qU3v66xw8mrQm7VQqYQEXaFbNfQROpZKu0Y7Nvg8mznkJNN67NobkFAYp2HrdBNebXUS8Xa/DGptrZQNsxoPBLs43bA7DaRvkyyCw/wJ6h0H074B3ICtXX8Z1NZb4rHNUtpUCg64wyjZKtiI5z/SXXzGBnwvKWM4Nz9AFt+vo0x5SdGuprpca9vt/2db0587Rh04cN16HKdqJ4877404c+2ngH0878enuTOjEp4u4E58266MTn740GTrxaYmitEM8au/dKu87KWxpxiHZuNNa9PHwJCjx5myWe5d4kxB5RtL82uRBla/0d3QS/tg6VOYcuUBDBUG/DkJp/uoKa9Y+GqMNESjKFT2fNKrnNnqjGmvpug6lcjjzFKnK/cFgsH5G/TO1W5fLBy5AqrxwdT1tvN/twRYOyACKC55KEbUYdfmlgv+IDiS8BKaqJzarAy+WFjJprVSzHvxQdcsG62hU89TqAMMLLlN+n6KHQA6WK3GvH1vWUU9sZ2//N5y9K8UrIr8TmsPfdGGPlUOjeOoZHhrw22zFiMY4JoWRbsWGN0/sOJefkB5v1+Qjn1mKRXm4gXC6gXcV7dxjEQtFTSHJ0M01HYlybX1IuJuzISOCHTCwL4KibhgS/QDpfSu+LV1/G9gZmUaGW29Z27cTzHTpF4tYYdJXKT5bR9sKzo0WReL7/QU1b2m4cHwm1ewlcRs+bxtyWwf8guoulMsm7DWHDS8iJmmrkDEWMcUz+to6Fu9M7OPzMTzgCqgxKKCbEz8BXZjAJfuZtPRMIGwTzpHhOmYqH7GkXJNgI0zgndIOvQJnuEx9DHKe4F4E2Jv1ttQOoRT8bqULQ+HoPuDq+0nP0yjqwS/1SfjjpsqfO2b+R89wjSNc8wjy2gHjWR5c0eCaHVLSpnoDPDzxwIMZl1Qe5ez4a10SVVbl3+pX7VpqluFWsishyI1eSEHXbZBoiqJDkPR/hsrxJusN7euHzDUaOZV+5owaNwsUcq4ShHflgXXPX0A8L3geru3CFhU2nO+RRU4nOrXllQwVJiqSseVM+2VzutHhniPyhDLcIS1ohxWUkNG6+CisLzpH92BG2K73V3LlYEpH5lCwZaS9tV/fj+B6BO9+/Hq5F8H44+UpXJx0f/x6CdejsNv44gz2/zjYf989hOxEJ/3s5HOTh0+1ybizNH5TmaCyvkg3/ZjzZI4Q9wY7qVsulz3uP/e0mfVLWdv/PB59/MfFxy7JrCPmpEtbNeCDJXRSVNlrlWw8iA9673v7JEtom3HVsCfcOe0cI7aRojEZf7+r/f2u9v/yrracpw4fXT9PuVTUMb5Fn0p+csMWcThfT6U//rY4SrjuVZLIpecprSFRMpXbiM2J8gxv2NPTPbd4ZdL1ml77Ey3RqYgtuPF46cnVhoV5avNAo5+NQi92L8liWp4WgQlsMVZiIkHi2Cfs1bVNVnZ+dnHJInZf3jhnnp0yw5d0V8yXbMh+Yj8x77BHZc+I6f0TS7maFXxG64Nemt3EL9qU5cFTlvKBPNt8UquGldvsJThD/5Jrz4p8R2j4CVffV8vDlxcFKsYUVlPa6VLmX5ENTGQ=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create credential offer</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-offer"}></MethodEndpoint>



Creates an OID4VCI Credential Offer that can be presented to a holder via QR code or deep link. OpenID4VCI 1.0 offers are not yet supported on this operation - the service refuses `version_01` with a 400 - so use `draft_13` until the backend adds 1.0 support. The wallet builds a Credential Offer by value with the Authorization Code Flow. The mandatory fields depend on the version of the OID4VCI specification. Version `draft_13` needs `credentialConfigurationIds`. Version `draft_17` needs `scope`, and does not accept `credentialConfigurationIds`. The offer always uses the Authorization Code Flow with an empty `issuer_state`. This operation does not create a Pre-Authorized Code Flow offer and does not add a `tx_code`.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Credential issuer and the credentials that the offer must contain.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier that the offer points to. The holder uses this URL to read the Credential Issuer Metadata.","example":"https://demo-api.igrant.io/v2/organisation/62e29d4c1d75a55b4ecd0e50/service"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft_13`, `draft_17`]"} schema={{"type":"string","description":"Version of the OID4VCI draft specification that the offer follows. The default is `draft_13`. OpenID4VCI 1.0 offers are not yet supported on this operation - the service refuses `version_01` with a 400 - so use `draft_13` until the backend adds 1.0 support.","default":"draft_13","enum":["draft_13","draft_17"],"example":"draft_13"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialConfigurationIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","description":"Key of one entry in the `credential_configurations_supported` object of the Credential Issuer Metadata."},"description":"Identifiers of the credential configurations that the offer contains. Use this field with version `draft_13`. Version `draft_17` does not accept this field.","example":["PhotoIdCredential"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Scope that selects the credential configurations for the offer. Use this field with version `draft_17`. The wallet finds every credential definition of the organisation that has this scope.","example":"photoid"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet created the credential offer.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"credentialOffer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Offer URI that the holder opens. The wallet returns the offer by value in the `credential_offer` query parameter.","example":"openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fdemo-api.igrant.io%2Fv2%2Forganisation%2F62e29d4c1d75a55b4ecd0e50%2Fservice%22%2C%22credential_configuration_ids%22%3A%5B%22PhotoIdCredential%22%5D%2C%22grants%22%3A%7B%22authorization_code%22%3A%7B%22issuer_state%22%3A%22%22%7D%7D%7D"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialOffer\": \"openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fdemo-api.igrant.io%2Fv2%2Forganisation%2F62e29d4c1d75a55b4ecd0e50%2Fservice%22%2C%22credential_configuration_ids%22%3A%5B%22PhotoIdCredential%22%5D%2C%22grants%22%3A%7B%22authorization_code%22%3A%7B%22issuer_state%22%3A%22%22%7D%7D%7D\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the version is not supported, or a field that the version needs is missing. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Import key
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-import-key

---
id: config-digital-wallet-open-id-import-key
title: "Import key"
description: "Imports a private key that you already have into a key store that can import keys (capability `import`: `local` with the OpenBao backend, and `vault`). A cloud KMS, a DPoD partition and the hardware security module of the installation never import a key: create the key there, or reference a key that you made there. The X.509 certificate chain of the key is optional. With a chain, the key gets the chain as its `x5c` value, so it can sign with the `x509` format at once. This operation replaces the removed `POST /v2/config/digital-wallet/openid/key-management/x509-certificate`."
sidebar_label: "Import key"
hide_title: true
hide_table_of_contents: true
api: eJztPWtz2za2fwXD/SLNULQlO2mi3e1cRVa6al5O5DTbzWZKiIQk1CShEKBtteP/fuccACT4sCynux/urWd2ug4JAgcH5/2AfvdiJqOcbxUXmTf25ulW5EoSSrY5v6KKkUu2I2pDFdmJgtAkZzTekQ29YoRnShCKA6QSOdPDIpoRjrPAG0l6Ed3SJU+42pFQvwjHJExERJOQXHO1IWrDyLsty15QQZY0umRZ7BOaxSS8okWiwn5AJiRKRBGTV28WPqHk7FyckS3NFQe4cSxMsqF5fE1zRiSLihxWTEVcJIyIFb7nmVQ0SSh+lLErlltQcRtjEuUM9gxj9b5ZznwicpKzFctZFjGz4RIjKY2ZHheQiw0j/wyeHD8nEcsVX/EIJos2lGcWAviWSyIQ3zQJyCdAANWD/HLImimJ/9AfU0m4kiS8eRKF5IomBfOJFIRrbEu+zipEhjdPjp+HZCXylCpCFRFZhLDhsizXm8/ZNqER04vkLBVXLCbh+bvFBTm6Gh1FIlvx9VHM11zRZHBNk4SpI7FlGY+PLtlukNKMrlnKMnUE6w2cDYfBv7N/Z4ALl4TSQiqyhGdCsUixWENMyZZKeS3yGHeEaHXwpM9IskwRnpEoYTQnit2ogCyYOfMVT+BgSQh/hEgKgCs7Lb6y/wj1GelPJBGZpQzJxgD0gEzI+avp4i/DkR7UC4PtcBQCBYTBdnUT9jWIXDY3AqDYZQIyV2QjklgSdkMjlexwKQcdAZlWCJMESLYiCQAxYXRVoyJu6MF5tBK5Xraa1y9ZQQBNusP1KoAapCm9jGT5FY8Y2RY1egN6zWOWj/FZC5YVz6VCYs00W0lZsBxQyWi0cYcG5JMdZJeKaJYJRVbcAFp9TN0vfaDuS8a2Gi4ExzIRHE0Ap3U+e4PkoI/AxTXLony3hdPB83xWo8Ve+GL2w/wtmb2dfvj5/GJ2Rs4/zH+aXMzIq9nPzhFXk3Qcce0A7YzT2YeL+cv5dHIxC/vInCuRJOLa0vShCM0Uy1MWc5QfzkLOmFwIVUP1Pq6j5HwwevJUk5578DlbFZJ1yntgP6EcOgeqcDiGqGthxIwcG7EIeBKFcti6RI2LYp/YE5jWUQ+yPWFrGu3cE5y9Mcd2notocLHbsjE59cvTC/tI9bTOum1QHGLEERsqG8ittpeWqOvgsm4UlvNewyo1YiaxYBqbhdTaRR9HVORXzO/6AKjvZstzFoPsgS93TIHo5zHqI/sJsisoAKqKnNkzi0Ses0jV4dSyNGeqyDPZIGYtFVkSk3BVJAlO+4sWqFxa/TCu8XFFOTn7WjBpmJArJMRJgxxqClFLgH1qq8gUT0ACwBnRtjoNyIUgNI4rzblmGeg2IPXp4kM1b/kcnpb6D8Y3wYKD5kpL0GKbCBo7ErGcz7zpUPB2br3/0ggyVpIxZRxrqSSa65xutzxb4zskPwpHXSQK7B5Js3gpbojI1zTjUqtvg0LXeAn+nXm+V0Ixj72xp9X4mdbin1CJg501j7WZ94rtPN8zx/dCxDtv/HvDHizVZSUBHTlRKhuju9po8WvKWCO3HF3hAh5nNGWBgQcI3xurvGA+bEKxTAFsaZEoDmbfEdDJIKaKwmMZbViKf6ndlnljTyx/ZZHyfG+bA0IUZxLewkacUVLlPFt7vqeJzht7S57RHHBSR0KXSeCXBoHIUUJVWKLZH1I/jo2ibQiQSlpeNHDvl6hMdhrRHYwyBzlhAfRB0zcNCUnoSrHc6igfBD2oKL+uh+CMUOmgLg68W9+z57oXqeUg30t59ppla7XxxsMWkq3CMEreRTqKPJhnu8mpLM35fVhGGwxlODDKkhGWbtUuIG8FoZm8diQhV7iXS7ZbAC3OO3eT0hsL+dPTJuivSjq2ykKbYg6Bl+zT4Q0F5F3N9ovZCpjfmnzoKTW9LEUvQaOwa3SygG3YDU23QN8efjAAY31JBWwNOOueTQ2Pj5u7ektT5rgtPm7OrEKu0ULQQlxWG/DB4UiFVGR4fAwUmNNIsbwB4Pn8DM0+Cv7U6Hj01Lu9dfn+s+ZUh76+3N7qIXIrMqm5eXQ87JZXVkNp9LK4dCiQgvHUwZpRAQlFztc8QyUX2uFhQMINlY59NwVO0oNWNJEs1Oq3ZkhkomaMeTW5RbfbBJ5zkR39KgHQfUJLcYVoWvB1xrO1ltL1bb7LGKK+pjVYTUf4Fc01aEdLFa5K8X02P5PGeRcpI6tcpIgeQKZhFtjitlgmPNJ2JVUs5zQhIks0q2nrAoa5SgJkdY2GtLtpfWnXKc7Mh+KKo6mfEwpufM5U0BLkl2zXzaZ1LH3M+NeCER6zDA6mciBKG047tiRFbrLKX7vVaEdtaLY2jj263ZYnJfAGlST89foyuORxWCfwk9WIPh9Gp98tn8Wn7OmKHkdP4u/Y8Nny+eh0dXK8jymzIknoEqbR6u+BTLrmVywjSyB2QuOUZ1yqnCprMjq+tY51oH3pWDex1S+VPUNCgCmsT2Bo3irtvcxdCdcucm8zcCe92nNrEQP/g5Sgl7pHhOrp71sGXJPumbMiBbmG83q+h9ad53vraDu4TKXne/Ra2r9+K3I2gCCLHRVvBWjPSEbelxaU+2hpL6107fs16hq9blMmc4ABVzALfrn1PS1AD6HjOiz/qHxiEgFcSrQkWEBCQ6OhFhyGWy3hNkRHRTU9mkB0DB0kGzXUAqURN+wQm/3A0QR62Sqa6QTQmsrFiFvDTB1Oj7bGwlL42dnRTwIvx4RWW7sxQFrJWIV4DDpQBVvny4QiHZIz2PJ8z4KMNraFok5RdvCt79FkLXKuNunDD3dR+qPlJK7krVHcbDF6giJCKqoKeT8VL3DcXZLcQYYTqLVqSa9BQhopfsUaQls/BFC4PNMmmAPNUoiE0awNzkZcSxICGhwJ2YZGQfwVAFrurIFXWx4muPW9X68v75eR55Ui5hn5cfHuLfnElgTM0N6Pn171jRddd/8ly9CXSHZWkacsXYJtVqlvPabp5elxJNRarqGJ1e7+IwPAYEQdIJpc050s1+TSLKRHYe4AIpYsSWCiSAdL8LkJFTs6OZxNG6c5m8JJRvnV/eDN6itUSqIBSRlC6wIAXzZgwGcAxs39QPyTRELkMc8A69a/qQO2FTxT6J0tqWRPT4s8sSddW/Zv5evBzaCa9XuA5IDT+vm/AsmuCcnlIXobKKd5Ht2GGJqE32CG0WR9gMzpEGg1V891jUIUaRjKqsVdu8XezZPIWZ/mOW1b+9N92STMDQE6UFvEpfcOGrVy10lPg6MgUFcLs5cBaatWcAh82Q/IDOL5XLEUFqDmtMHvFjGLydnsQz3YX2PvuM7WWvS0bMju4J4OCEYh2TAa2+xAFea0oKaxiHCgdtAwK9naz55gulXVuO0cggU0izYih7OCXR+gjsATuwctaEndPFEH0Nk/JoMhUZsiXW5znpWuUzNh8B/D9F3cKjd0OKjg+F5TqvoLUu1B2wCqP2Qjb4XJt4Z/Ca3tY7aBvgXu9P6gK/o9jkjQQoJizlT9Ituyub7Z0ZOn7e1Gv2AI/gCROcNxRPHKwG7uFPny48X0v3N0o+PRd4PhcDAaXgyPx8fwv3+1DHjQ1WCzxzyW98qcrpiAtWEeyB4xi1imcppwCXGXygfrnc3P+hh8K3fyGaAbQ6bst1Gc/nb2bBitz2+e/XTJv/txWRRv0pc/55/O1z+LndpdfvzXCdt93ajhr89fLb/+KwgC3F9H8OabDbnyBLK7Mvt4oNXgexLytWPDYBJYKdWcC1Hk0UFxgTr0n8Dsb2WIW8oCzlLiYQYk1FxVOiIHZDYOc42M9V1j8xC0yiCi5rtlwRM1AHYHZTOdkB6CbqovGjqqmrqvNW3MrlgitlB9oKU8kwoiYToYFX5VcmvWqc2i0fD+YnEOKyEZQsh1T3Sjm+uMY2XRV/eszD493wMwPB8md10s+PetHuYQ6UPpsxITYYt4dKDS4lvLmxa+MeseN3EEqUgOGl8egGedT5L45orlyNKSiEJJjiUxUCORUAV0T2KBYXitY/m9XHCeM8k69eV+LtDpb/jWnvZebkCiS3iD2vQETrFMPyAv9xhP1YKQgTHZNPNJRiyVuBU+dRAzdo2HAvlJx6ltkKVN7mb1iI0hJweoiZRMytRGnpPk3cobf747yjzt/LQtX0xhTqt2wTVFodRBjhEP8O9C0jVDz89wY8l1BD4FS5oZJcOhIkTp+gaSnr0mZyIqkPDA9mY5hD90Jggmfx+dL16gN48lSL5ju96oMjYgwRyMNiy61PY51qbodetBAwi8tMtrmuQCydg9SW19vDaYSo0NbtFmQ1c6rgwL+sZkAc/lIyAKgoehOXZfp6uQOKVPwjROLEI0PkKbivBJ+DU6l0v7pWFUQIMsog2aQJOMzCYTkjEWS4yqNzK1aF1D2UVCtiyXIjPlYt2SMCAfTMK/jgEnQ4zkDUuW4fweo3Rg/9UPQkS/BtPIhkgUmWOJs3iAnMluABNOsA6raCDFii/qhWK6JiHuTBiUOP42sVKn57usPNKbXSzmZPaWnAyfk9PhaDAiUUKh6uM0OAlGPlGwDBlCmHESjoGhP7BtAc6JVrAvWg/xRE0lXumIBiSchuOux2cdj3GKS7abZRHfbsAbApM8h0eTdc6QiQISzsLxAaNetiD0v3XBhuZ1EamNLl3FVuG+V8tBAsFdsh1IMFi5r0tlquGutp54vvfC872p53tnnu/NPN972VbP3gswR0EUTUthNS1l1b1W88V+KdfcJKzjaqHOL13rx8qeEBRBCBIJ0i2tKdE8CLcczDRTGtUYZgoVmvhF2sYpgOetrNxn7pdqpIkuyNB1oYfHptavtdndA1Cha5HY/GyyqD5vzYvlL0WVxgKkkV7DsMuLhPV9jS7S0wKw9FJ00pZApQmMYZTiBNnga0ETMHliQhXYBfaEwq96TPd7LCTdFsuBHuS8shbZcgdjdLDGxGkliyB/txTxru+SNGwHJB0mZhhFm1P/n1mhHtuHB3VXC4fsIfeXIn8TJ/8Vol9p6wg0fe2U2iQOs8MR6RisG/ODOcK7YA99soRZANHlqWBNeYl+zBLRKGJGjWgWwBze1Cp7HcHvgtS1wTvUMy9tdWubuGSK/67NxqWOfnCJDPDIc//Pea5FMt8comhqTazo6Lae4bTmi3dH89mUDJ8dD08GT8gFGiQvghPSq5ggbCp0TcbsRrEMnBln5DA4DnCu4EkwDKAwbinUhkQ5VzyiSb+Tk3qxiFDXhCJfB1wKZ4r07DVU1SF3lZkzs4FOxxHt3wOdHZm/x9FdXNLwKjRpVwUpK8ISFqlcZDxyCQz9DapUzpcFFNMdRFSkd168GMwmk/6YoMl4sSBDYzI+tSbjs+AE0T7JMnZDJr4D27v5GQmPg1NA/vPT4ehpMAxO0CCoxqAJlSREbXJmIqJSy1NjoVuuKA3z0PgIvKPmBu3zfPdu9ZqtudQ9NAdURKCgwy9Lm5leg1UChEhOhk+fDoaEJtsNBVNZxLrWL5x91AmUWQFA0Ix8zIBhE3ptTOwavs4XLwbPgpPB8RMkt3MI4gJZLxAoXPhaOOVoNtDcqNiq+HYxw9xQoTY6pjKviabDtl1kNF3ydSEK2RRtBhMwPzyPiMRVSK/cyGm/nlSiWkSLFckZ4P6KkZhjNKbgcsN09awMyMSU342OT585G/bRnhOZykVSPa7vOcr+PjOrfYAjViz3Rflo8sKP/q7RklQE8C146cYFnGyRAaPpEBQ6km22wWp0LALkILZsEm4PJkf9gHyUgMGPH+ak9+HllJw8f/a0rwUo9orcgJftfHLS/0OI3Ci1leOjo+vr68A8DSQ7Suj1EdRDDYajk1ZsvpO79lDgvlP4cvvlEI+2Ke56bXnS1zLQiCqnBEW7Dy3Zcp9Dl4nmqm5QRUv6CiCtMVAR4Bm7IleTCliSKBLCO7EBxl8Xck3TiKl1lB0UFN6FfGhT2SezMaNhDaQ3TIKelAfqp5ZFV37fPMKXZUirbdT5e4NhaJXTpjW7su2bxrDDFsRa6coYuQX7rcp4Ghhy9a69stVlBfWUZVBoxW8CMsmcuFY94g52fOBEhZrGPrTxybIgdgobCVKDG9P1l5GQ5bnI35SPkXpNUAgx0FZraNC1PZw7bG9g222tcOGAD8Dke9AHXx/8hTU+H/BRQwAdYNiCWPlP0aC2i+ok6HadaTux9B+g+kCXC1GXhJDT0jiZuvM8ctwjxz1yXDfHdcUxemEqxS9QSmPa8e/3zRqUG5CX0MBaj3IgnfZsjLYWXDGRF8gWsViHce4O0/Sdntem79p0c2HNUmaAwVEaD50j2xUSbppgTxj43pBZl39vHdUO22CPEOuggQfk4nxbuHFfamteFck+MHPXFd77tjTet2TxZlcs35WJKuzgQNq6L1OHmsMkml5zqWY2zXSY1rjo+rLLyL47l0WrfvA7jlCHBKmdA0U4ese4A0mwrxQesphMJ9DdzBMtwquFsPMISt2oZkiLVKd3yFFRXRrFqazSI3MmoTst1Itobs2EFvq2ha0CgEuyFAUcrOim2drCGxpXSqqaBOrjIWABdj5dLbBeK+yP61kM3bIYmh3X2rVQoOSMSpGFRIIZcb3R7WDYx6YEJCF7pfeC10MoiztI1QGWP+Y8LMtOtY9gq2MtoPo4P354bd+0jo4icTd9+5xFUKUZQ6kUlxg4fWclV1lDoQOxAqq0gTty05YNVP9XHDk5n9cbl8omLo0gU+89drbTawIJ0VRTnGbe2lI166ebQW7ZiT4PPdzW/q14tmZ5rfivg8ztbClV0SYkvY1pC7mDI3CYKVupoFUTZXfC07LQTvt38PrFLiS9641AEuJlWatt9IeKrSUzvmvbXDG4OiRr3A4BWPc/EumRSo7cWJsMblJs3jEIftgCNizjuuVeo5QMj+X+aTGiY7nqoOF4DAeNxMPZ2x0M/WYDOLe929Vxk+PBaOTWN+L8LzrrM1uQGGbujLI3mzC0pDhg2ob5YNc4MABzb50D6TV7urtUQn9vCVs5L2q8rzKK202zOq/AG51hzu0rptOEkirDUhVjY9UeJmwYCore+8X0DICyBSqYfykjzNrzM02r7oy6OKy8kaasHHG6AdEqjWQUmlxUOQjkZmyj27r2typ1rG+rM4WAax+m+l+xHWr/TnXv4KdsU3I2W2vqun/vupKqpTHpGtS/VpqzjzVakLW6JtTX2B7Q7P2s+r+MFrQBO5FlLGqSoQYZVB+Dldoy8tDerbDccdi2fFyrpsJMbeOF2gi81qtnUYUkMZ0cvZ9Wjq9B/TqnmWIxpJK6UFX2+mJnQ/eCqKWrpE9J86h+3ReMJmBTCFnvnLLs2sU2qMjBnr6LfTKhBk181c4aLBmSCajkzS4zcZ2ZQbVbzowYaGzeGDC+zSsYs2HJTGla1duCtpc2KVh0yWK4h8ZNiJYQgnR0IfZ8z4BVT4lWA0Bd6Um7dcQ9EtQptsdpqgr7LnF41zbaKmZYVzExU5Qn3wAfhGBopIybtLa9Kdp8rluATVaoCL10iVqUe71haNU139qzc+dDk7d5txpSJhBbHQ/vD+IEIPi/GhncpneYVVtk76MF/F1Lqjag+2t7CzZXAJ9aesnNBT39gMzxyrAxmb79+zxTTHLyQy6KLRB5Bf2sgnYBfDadkB9OyGw6JT2UF74VEH4DfSsyv+i3YwNGxrk0WxLHAQof7fmG7muog1KboSRzZKVN+ffK4IqucdehkU6lU4YB9uoKwyh4uOhIl/VgaC1gFOCwlv2s0O0rKzdUELMVz7hO2ADJYto5U1bcVS+RNOtdExiVKJ0gPBlsxHSvMLQ3WTmto5Pu9XUOWuJdiCZEgNJBwrbhGgtdvF0LjKGQh6cGq1rm2gu8ysZjEJhOzKSrI0lTiezIqZewnlXYcBAOrWtrDB01Ovnvw/YdCHUZfQRBTOdAvhWChx6qC8OwlQbtRMjdgH7BHl/sWf8Dfkaj29IqZLedy96LBPqlW20c19WGvknjPweVq+4SKksX/9vga8c9sXIMr3Vwbuso73dwrwPwK1FYNcrrznXTW9bdgtXV59RuhOnqA7mrv+GOCJ5xc6xV71KIey5fMCKvG0yB5OFfp8fHutblwKt7XCRiJmQqYtgD/n3mHOAXvyVE66Kg+rqL+crzPD0+vu2YvoPGnJJmCqkauPhrS3OaMgWhAn2h0h2XvdkrD8s7VCVJuZQ8W9sbfHQDgA0Z2wtku68Q9LvshPrVkq27YJvLO7caWujsLa6YLqzf/ahTHa3rwc5nb/zq0zLIiW3Dd1zUeifsTme332wV41kNwO57Wh9wP+QDroa870rI6s4RbXjULxLUdxsYcGsXDqKT1HUVIUibJg8N/8Q89DEzxvtv6AI1UXP6J0bNRZOojJnfuiWPSzI/6yKs54/Yq7BX3cUuKxMATdbyUUpveFqkjnWOtwWadkbnxsp2V2N5XbNItzQ3hmy73Qna62spWueSuF5ZTeDKT7MgXF3YkGq2bEAJ0W/B2Mrj4QXRNeiqpdu08+RPrdjBS87hxlU4VZYTXKYDRyd/Yhxd1G4f7Ah+ota/ohyN9CaFYS5C/+YARo8nWw73No4/Y2hA0bUELJmbeE3rNOnhZbxnpz9N+56Pd928Ka/VB6SlTG0E3OO7FWjHbincAug99IJ+4PkjreE9nW5CqD830wBnLBWGQsBQzhMnkRWzVAzolgccoyYBh1vxmhOc5yIudPT4jmnum2Gh6Bry0nd8LvXrJiBfKuQvgDo1UdkjqAp09APfg/sgzOlZp2fsTYzatvW1dcAgt4rxFFsmavpbqnyDIZmwNk95gU318wdsxW+sxRtqGAn2t5h7UFROeYI42NIImmRYsA4a046J+fBvO1HkgA64L/D7UEeteLYSlpFphIzMUoxherLYAhn8T4W8cv/8h+pRHevugTXQUn5kWQfvKhHAewpvh0iQBGuV3pro0Sr+Ca8NwAaUqphGYnwPr4/svUPumOtcbveH5278oeSo8z56FyISiTTdzHCELINvpFGkv5k4jxK6acPHqyb96kaDnW1sdeIsEALC41E0i2keywHul9NMkRXU3OijNZhGaD+dTMlPU7ib7aLvk/ns4iVZnA1+/HRBfprq1aAXwhY1pWciOsIyrSq2Y67ZB6mT8IhlEiWlpdwtjTaMjILj1tFBCTrF14HI10fmW3n0ej6dvV3MBvDNbZXbqo4TkBWb2h3LESA29LGPjkfQzjzEO6CFVCnNHHjmpTPRZCNHuTz+0szjL808/tLM4y/NPP7SzOMvzTz+0szjL808/tLM/7FfmjFOFQjFo20CCZ5bY33+bhzVz97VSP8OwopjLVBNx+sfq8mw+6Gu5/UDWd6rBq7wBjzg8Wfv99/h3saPeXJ7C4+/FixHLxuuVM+5Tp99/lLmddDLBUN07E215Tkwtf1o23jjzp+UAb9UfzTB2yGc4a2IyK3rp4NV4/ne0vyUTooRDcz24bx+9acGErzJuoOqjWbzh1OGRrOdA0XTV9XAwn8B9M5P/gYW/Su2+74crt/c+UHpH+vRcL6QMftf5MHWYw==
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Import key</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/keys/import"}></MethodEndpoint>



Imports a private key that you already have into a key store that can import keys (capability `import`: `local` with the OpenBao backend, and `vault`). A cloud KMS, a DPoD partition and the hardware security module of the installation never import a key: create the key there, or reference a key that you made there. The X.509 certificate chain of the key is optional. With a chain, the key gets the chain as its `x5c` value, so it can sign with the `x509` format at once. This operation replaces the removed `POST /v2/config/digital-wallet/openid/key-management/x509-certificate`.

The private key must be protected with a password, so that the key is never sent in clear text. Send the file in `file` and its password in `password`. The file is one of these:

- A PKCS#12 file (`.p12` or `.pfx`) that is protected with the password. It holds exactly one private key. Certificates are optional. The leaf certificate is the certificate for the private key, and the other certificates are its chain. The service puts the chain in order: the leaf certificate first, then the issuer of each certificate. When the service cannot find the issuer of a certificate, it keeps the order of the file.
- PEM text with exactly one encrypted PKCS#8 private key (`BEGIN ENCRYPTED PRIVATE KEY`) that is encrypted with the password. Certificates (`BEGIN CERTIFICATE`) can follow the key: the leaf certificate first, then the intermediate certificates, then the root certificate.

The private key must be a P-256 key. The service refuses a private key that is not protected in one of these two formats: a key without a password (`BEGIN PRIVATE KEY`, `BEGIN EC PRIVATE KEY`), a legacy encrypted PEM key (`Proc-Type: 4,ENCRYPTED`) and a PKCS#12 file without a password. When the file has certificates, one of them must be for the private key. The service refuses the file when a certificate does not use the P-256 curve, when a certificate is expired or not yet valid, or when a chain signature is not correct. The service never returns the password. The field `fullchain_file` is removed: the service refuses a request with it.

A key without a certificate cannot sign with the `x509` format until it has a certificate chain. To add a chain, generate a CSR with the generate CSR operation, get a certificate for it, and upload the chain with the upload certificate chain operation.

An import into a `vault` key store uses the wrapping key of that vault. A sandbox organisation cannot import a key.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The file with the private key and the optional certificate chain, its password, and optional key store and name.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"file"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","format":"binary","description":"PKCS#12 file (`.p12`, `.pfx`) or PEM file with an encrypted PKCS#8 private key (`BEGIN ENCRYPTED PRIVATE KEY`). The file holds one P-256 private key and, optionally, its certificate chain. In a PEM file, put the certificates after the key, in leaf, intermediate and root order."}}></SchemaItem><SchemaItem collapsible={false} name={"password"} required={true} schemaName={"password"} qualifierMessage={"**Possible values:** `non-empty`"} schema={{"type":"string","format":"password","minLength":1,"description":"Password of the PKCS#12 file, or passphrase of the encrypted PKCS#8 private key. It must not be empty. No answer returns it."}}></SchemaItem><SchemaItem collapsible={false} name={"keyStoreId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 64 characters`"} schema={{"type":"string","maxLength":64,"description":"Key store for the key, a key store with the capability `import`. Optional. The default is the local key store that takes new keys.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Name of the key, for example what it signs. Optional, at most 100 characters.","example":"PID issuance 2026"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The service imported the key and returned it. `origin` is `imported`. `hasCertificateChain` is `false` when the file has no certificate.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key. The wallet makes it, and it cannot change. The value is the same as `jwk.kid`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","nullable":true,"maxLength":100,"description":"Name of the key, given by an administrator when the key is created or with the update key operation. `null` when the key has no name.","example":"PID issuance 2026"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyStore</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key store that holds the key.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store.","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the key store.","example":"Local vault"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`created`, `imported`, `referenced`]"} schema={{"type":"string","nullable":true,"description":"How the key came to the organisation. `created`, the wallet created the key in the key store (also in a cloud KMS or a DPoD partition of the organisation). `imported`, the import key operation imported the key, with or without a certificate chain. `referenced`, the key was already in the key store of the provider, and the wallet signs with it there.","enum":["created","imported","referenced"],"example":"created"}}></SchemaItem><SchemaItem collapsible={false} name={"algorithm"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Signature algorithm of the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the key. The wallet signs with a key that has the status `active`.","example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"isDefault"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the wallet signs with this key by default.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key in JSON Web Key (JWK) format. The service sends only public members. It never sends the private key member `d`.

</div><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type. The service always sends this member. The keys are elliptic curve keys, so the value is `EC`.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve identifier. The keys are P-256 keys, so the value is `P-256`.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier. The value is the same as `keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm for the key, for example `ES256` for a P-256 key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Certificate chain of the key as it is stored, in leaf to root order (for a test certificate, the leaf and the test root). Each item is a base64 encoded DER certificate. The service adds this member only when the key has a certificate chain. The `x5c` header of a signature and the mdoc `x5chain` have the leaf and the intermediate certificates, without the trust anchor.","items":{"type":"string","description":"One base64 encoded DER certificate."}}}></SchemaItem><SchemaItem collapsible={false} name={"x5t"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-1 thumbprint of the leaf certificate. The service adds this member only when the key has a certificate chain.","example":"<base64url-sha1-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5t#S256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-256 thumbprint of the leaf certificate. Note the `#` in the member name. The upload certificate chain operation gives the same value as `x5t_s256`.","example":"<base64url-sha256-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c_expiry"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry time of the leaf certificate, in UTC. The service adds this member only when the key has a certificate chain.","example":"2027-11-21T10:00:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dids"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"DIDs that come from this key.","items":{"type":"string","description":"One decentralised identifier (DID)."},"example":["did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ..."]}}></SchemaItem><SchemaItem collapsible={false} name={"hasCertificateChain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the key has an X.509 certificate chain. Then the key can sign with the `x509` format.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSource"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`uploaded`, `imported`, `test-ca`, `qtsp`, `null`]"} schema={{"type":"string","nullable":true,"description":"Where the certificate chain of the key comes from. `uploaded`, the upload certificate chain operation. `imported`, the import key operation with a certificate. `test-ca`, the built-in test CA (the create test certificate operation), for development and testing only. `qtsp`, the certificate of the QTSP credential. `null` when the key has no certificate chain.","enum":["uploaded","imported","test-ca","qtsp",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"testCertificate"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` only when `certificateSource` is `test-ca`. The built-in test CA issued the certificate, which is for development and testing only. Wallets and verifiers outside this platform do not trust it.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificatePreset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The preset of the certificate chain of the key (the list certificate presets operation). For a test certificate, the preset of its request. For an uploaded chain, the preset of the newest CSR of the key. `null` when there is none.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>certificateAssessment</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

What the leaf certificate of the key allows: its key usage type, the credential categories that it fits, the mDL Document Signer profile, its QcPSB statement, and the texts of the save check for each category. The wallet reads the certificate chain of the key. A key without a certificate chain, or with a leaf that the wallet cannot read, gives `keyUsageType` `null`, empty lists, `mdlDocumentSigner` `false`, `qcPsb` `null` and texts such as `An EAA needs a seal certificate of a legal person. This key has no certificate. Request a certificate with the preset EAA provider (eaa-provider).` The texts do not count the trusted-list exemption of the key: an exempt key is never refused.

</div><SchemaItem collapsible={false} name={"keyUsageType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`A`, `B`, `C`, `D`, `E`, `F`, `null`]"} schema={{"type":"string","nullable":true,"description":"The key usage type of the leaf certificate (ETSI EN 319 412-2 clause 4.3.2, table 1). `A`: nonRepudiation. `B`: nonRepudiation and digitalSignature. `C`: digitalSignature. `D`: digitalSignature and keyEncipherment or keyAgreement. `E`: keyEncipherment or keyAgreement. `F`: nonRepudiation, digitalSignature and keyEncipherment or keyAgreement. `null` when the certificate has another key usage (for example with keyCertSign) or no key usage.","enum":["A","B","C","D","E","F",null],"example":"B"}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategories"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits (the list credential categories operation), without `none`. A PID certificate fits only `pid`, and a PID certificate with another key usage type fits no category.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategoriesForMdl"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits for an mDL configuration, without `none`. The rules are the same as for `fitsCredentialCategories`, but `eaa`, `qeaa` and `pub-eaa` also accept key usage Type C. A key signs an mDL configuration only when `mdlDocumentSigner` is `true` and the category of the configuration is in this list.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"mdlDocumentSigner"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the certificate has the Document Signer profile of ISO/IEC 18013-5 Table B.3 (key usage `digitalSignature` and extended key usage `1.0.18013.5.1.2`, both critical). A key signs an mDL (doctype `org.iso.18013.5.1.mDL`) only with this profile.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` when the certificate has no QcPSB statement. A key with this statement signs only the attestations under its law (`legislationIdentification`, `countryOfLegislation`) and from its authentic source (`authSourceIdentification`), ETSI TS 119 412-6 clause 8.3.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>categoryMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for a configuration that is not an mDL. `none` is always an empty list.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mdlConfigurationMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for an mDL configuration (`mso_mdoc` with doctype `org.iso.18013.5.1.mDL`) of that category. First the category rule (with key usage Type C also allowed for `eaa`, `qeaa` and `pub-eaa`), then the ISO/IEC 18013-5 Document Signer rule. `none` has only the Document Signer rule.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustedListExemption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trusted-list exemption of a key: the certificate of the key is in a trusted list, or chains to a listed CA. While the exemption applies, a rule of the signing key check that the key does not fit gives the check result `exempt` and no refusal. The exemption is bound to the leaf certificate that the key had when the exemption was set (`leafSha256`): with another leaf, `applies` is `false` and `reason` says why and what to do (`null` while it applies). `listUri` is the source of the exemption: the URL of the trusted list, or a text, for example a recorded decision. Only the platform operator sets or removes it; the API cannot change it. The other members: `listUri` (the trusted list), `service` (the service of the list), `certificateSha256` (the SHA-256 fingerprint of the certificate of the list), `match` (how the certificate of the key matched the list), `setAt` (the time, in UTC) and `setBy` (who set it). Each of them can be `null`.

</div><SchemaItem collapsible={false} name={"listUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"https://example.com/tl/eaa-providers.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"service"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"Example EAA provider"}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"leafSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"match"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"setAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"example":"2026-10-22T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"setBy"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"applies"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the key in a qualified signature creation device (QSCD). `false`, or `provider` for a key of a qualified trust service provider (key store type `csc`): the provider decides. The value comes from the key store.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trust</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The qualified status of a key of a key store of a qualified trust service provider: its leaf certificate against the EU trusted lists. The wallet checks it when the key is referenced and when the connection of the key store is tested.

</div><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","description":"`qualified`: the certificate chains to a qualified certificate authority (service type CA/QC with the status granted) on the EU trusted list, and it is a qualified certificate for electronic signatures or electronic seals whose private key is in a qualified signature or seal creation device (QSCD). `not-qualified`: the trusted lists say no. `unknown`: the installation has no EU trusted list source, a list cannot be read, or the key was not checked yet.","enum":["qualified","not-qualified","unknown"],"example":"qualified"}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the check, in UTC. `null` when the key was not checked yet.","example":"2026-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The facts that gave the result, for example the certificate authority and the trusted list, and whether the trusted list or the certificate says that the key is in a QSCD.","example":"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The number of credential definitions and presentation definitions that sign with the key. Only the list keys operation returns this member. A credential definition counts once, also when several of its configurations or its status lists use the key. The read key usage operation gives the details.

</div><SchemaItem collapsible={false} name={"credentialDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of credential definitions that sign with the key.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of presentation definitions that sign with the key.","example":1}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Creation time of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Time of the last change of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keyId\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n  \"name\": \"PID issuance 2026\",\n  \"keyStore\": {\n    \"id\": \"local-openbao\",\n    \"type\": \"local\",\n    \"name\": \"Local vault\"\n  },\n  \"origin\": \"created\",\n  \"algorithm\": \"ES256\",\n  \"status\": \"active\",\n  \"isDefault\": true,\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"x\": \"<base64url-x-coordinate>\",\n    \"y\": \"<base64url-y-coordinate>\",\n    \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n    \"alg\": \"ES256\",\n    \"x5c\": [\n      \"string\"\n    ],\n    \"x5t\": \"<base64url-sha1-thumbprint>\",\n    \"x5t#S256\": \"<base64url-sha256-thumbprint>\",\n    \"x5c_expiry\": \"2027-11-21T10:00:00Z\"\n  },\n  \"dids\": [\n    \"did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...\"\n  ],\n  \"hasCertificateChain\": false,\n  \"certificateSource\": null,\n  \"testCertificate\": false,\n  \"certificatePreset\": null,\n  \"certificateAssessment\": {\n    \"keyUsageType\": \"B\",\n    \"fitsCredentialCategories\": [\n      \"eaa\"\n    ],\n    \"fitsCredentialCategoriesForMdl\": [\n      \"eaa\"\n    ],\n    \"mdlDocumentSigner\": false,\n    \"qcPsb\": {\n      \"countryOfLegislation\": \"SE\",\n      \"authSourceIdentification\": \"cn=Example Register,o=Example AB,c=SE\",\n      \"legislationIdentification\": \"https://www.example.se/law/2026-123\"\n    },\n    \"categoryMessages\": {\n      \"none\": [\n        \"string\"\n      ],\n      \"pid\": [\n        \"string\"\n      ],\n      \"eaa\": [\n        \"string\"\n      ],\n      \"qeaa\": [\n        \"string\"\n      ],\n      \"pub-eaa\": [\n        \"string\"\n      ]\n    },\n    \"mdlConfigurationMessages\": {\n      \"none\": [\n        \"string\"\n      ],\n      \"pid\": [\n        \"string\"\n      ],\n      \"eaa\": [\n        \"string\"\n      ],\n      \"qeaa\": [\n        \"string\"\n      ],\n      \"pub-eaa\": [\n        \"string\"\n      ]\n    }\n  },\n  \"trustedListExemption\": {\n    \"listUri\": \"https://example.com/tl/eaa-providers.xml\",\n    \"service\": \"Example EAA provider\",\n    \"certificateSha256\": \"string\",\n    \"leafSha256\": \"string\",\n    \"match\": \"string\",\n    \"setAt\": \"2026-10-22T10:00:00Z\",\n    \"setBy\": \"string\",\n    \"applies\": true,\n    \"reason\": \"string\"\n  },\n  \"qscd\": false,\n  \"trust\": {\n    \"status\": \"qualified\",\n    \"checkedAt\": \"2026-10-21T10:00:00Z\",\n    \"detail\": \"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT).\"\n  },\n  \"usage\": {\n    \"credentialDefinitions\": 2,\n    \"presentationDefinitions\": 1\n  },\n  \"createdAt\": \"2026-10-20T10:00:00Z\",\n  \"updatedAt\": \"2026-10-20T10:00:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The file or the password is missing, the request has the removed field `fullchain_file`, the private key is not protected with a password, the password is not correct or the file is not a PKCS#12 file or an encrypted PKCS#8 PEM, the file does not have exactly one private key, the private key is not a P-256 key, no certificate in the file is for the private key, a certificate does not use the P-256 curve, a certificate is expired or not yet valid, a chain signature is not correct, the key store cannot import keys, or the organisation is a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key store with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div>

The organisation already has the key, or it has the maximum number of keys. For a file with a certificate, the service compares the leaf certificate (`x5t`), then the public key (the same private key with a new certificate is refused too). For a file without a certificate, it compares the public key.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The provider of the key store is not available.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Issue credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential

---
id: config-digital-wallet-open-id-issue-credential
title: "Issue credential"
description: "Issues a Verifiable Credential to a holder using the OpenID for Verifiable Credentials Issuance (OID4VCI) protocol. Supports two issuance modes: **InTime** (credential issued immediately via the Credential Endpoint) and **Deferred** (credential issued later via the Deferred Credential Endpoint by calling the [Issue deferred credential](/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history) API). Supports W3C VC (JWT), IETF SD-JWT VC, and ISO 18013-5 mDoc/mDL credential formats."
sidebar_label: "Issue credential"
hide_title: true
hide_table_of_contents: true
api: eJztGmtvGzfyrxD8ZOdWT7+SRVDUsdw7pU1txI6NgytE1O6sxHiX3JJcKTpD/6b/pH/sMOS+Lblp0LTXaxugXpGc4XDeM+QDDUEHiqeGS0F9OtY6A00YuQHFI85mMZAzBSEIw1lMjCSMLGQcgiKZ5mJOzALIRQpiPCKRVNvBNEG0TARA9i7Go8Obs/E+SZU0MpBxl1xlaSqV0cSsJOHFykSGoH3y7NlYXPMEnj0je0FFCC6DkPAkgZAzA/GaLDmz1NTIPRdhKrkw+4SJkDx7NoIIlIJwO7KYGVAlmmLtNnxktiYBi+OCAXeWbSQsQCrck71eKAPdkykIHh4ugw5LeS+QIuLzTpaGzEAn5HNuWNxZsTgG08GlHR52KiSdBddGqvU+Ob0c79cYdntwRm7OyN7r2+t9j4zPr78hV6PO69trcnPm2TOPry7I4Hl/cNA5IslIBr1k9F2NPJRZwozu/iCoR2UKiqEijEPqU0fkyBF3a2mzgg7tYSuuUI8q+DEDbV7JcE39B/uTKwipb1QG3hYVsxLmQhuVBTjcJdNC8G9kCFPCtWWsFPGaJEyEDM9PIg5x2CVXEENg7ILaUQwkKYqQrLhZkGk1M4KIC+7ONXVs0SBCBx8znmjCRR1gSqSq/9bTLvm3zEgoiZCGaHB7zxUThph1CiTkCgITr307YfUJDQTcKS4VdE4zs5CK/wcVSoZAvonliqwWIMhaZo6eaaZBXXKR04iQBZSVyjZAR1KXeiguA8Ig/1maxjywML0PGpn+QHWwgITZWbG+iKh/90CRdOpTOfsAgaEeNdzEODCCiGWxIXssjh3P9T5ti/GtkzmZyXBtTd96AmfdjgN14ZSq1SUXKNPH4i6l7PQb1+wQIXoh/aQK5EJ2aH6NmHNddsp7R+tE0snG282ypu09hcaj24/VmNC/sNsWq/7Se9Z9zZfea7QWLOFBXbS5i3laDc2CGaINQ9/IREMbrcdZLXiwIBFX2pD8ABjrUgUahHFGFimZWJ1xYa5LriuLRjN1mG3EO7y5LOgis4zHxgFP6/iamjuDSCog3DiMuqXAzs0ETKCbyTRULsE5NbPgmiyZ4kyYJ3X1CSHsIo5ONpONR+EjS9IYNHoKF3lJp+7AdOHAHEGKCc2sCycBbuw/0CWLM/vRoMjPsVGPZiq+Qm9kRW/jYj3WySgC5fd6u8/g05fbZ75q6Rj6OG7XczdnvYD1gWGoQNvPQGbCqDX16dU59WgsAxZzY38bGdwvZJxYTs+dvpWDmsQ//4RRUxsFYN6XKOnVEtjy55/mIMjhEd14dMaVWWCopz4dvHjR7/QPO4Mh9SgkjMfUp6D4ffeDXDChtRRf5zLoauRWxBIer98LZvn1ulhEPTrnSxDFxLni99SjXL+XS1DvB8+L4FuMDAftkeOjYiRdSAHvRZbMQFGf/uPw+KQ/GB4cHh2f0M1m4tFcDalPhweHB3Sz8SrlKBSjFaP+VoX/R1VAyZeZ8W/kGAp8X1oftihx7Sifoca/D+FI5y3ytBYNw3LFn8XMuF0TcatVqFD9fufk+YsXaGcwZ/H3Tndfredzcvqq7XWOjk+eO4Htzgz+cEbsjKw+fblr7vdioGXe+avbi/GIdFqV4h/Puc/gwNX50dHxyfHB4GR48Fks2JZC/0kYIdW8y7XsWvq7R93B53HnKfY0sv3/bbaUc1eZqyN+E1XB/zDW61QK7dLhYb+Pf5r1R606CBQwA2G7KIWPwYKJORAFgVRhWdvXq2Nkj6s0ih1t+YHFCXbZYiCuRnKFv2nvqYkU0N7IFcFMEKYUW1eQW8NIiSjB+sQsmLAoHaZGDcSEXoHSZDrs96eebYhMh/3B9Ff1IFKFDQHDHWMriv7lGl2P2Xy2k58eVvHuiDJ6gu/aKwXkuhVcl4Uh0i4F7GiLfColrvw0igX3TiDt+rPJx3jF1pooMJkSmsASigYX4oXUkGktiRoxw6ZdcpqvsDstmCZCEmua2EFxqCB0GRg3mkCSmrVb4JPpD/QHOrWHZ0QbxcXcI9N+MeJSPo9MIxZrKEZnUsaAOoT9KZHFcT4hCoV0Pyz/H1WkmBhV7DrPudVqBTSGpZozkedgbsB2HC/awyEz7HSuABIQphoxRvFZZuAGT6xtDnwaBKC1zdG4vpb3IBojjZqZ60sFVTrbIPMCTfTxSNERbjoiw0ymbT2QfziZ4zjuw+qpZt7AKOZ4aIl8crSNApPVrbjP3LnS+qnyMRagjuHhLWZrvCGcLbDPK+bQ/v0GzEKGVsCu1/lOcRuTeCkAK+7Ch1p2oLGdIrWu0e2+Y55wA+GI6yCWOlPNZoVFVMy8YWnKxbyx4Ds2g/jTmkzVhCN2Z37WnGoopGsCNdB+Y1vmKF3Xhn8LS+kcnWVP8aNUAsejU63R4dlFrZFr9DePRt1NitVCdzHwTnBzagxoU2y2dfxSXu6a2oryhsU8xCq3fsZSJ0REPfrBOPZJGRV/c5rtdw1tCKg14e0OgnM1rr5Gbn01UMNVGOcIBIfwLTBX6sLHFB3MWZNWvW1GN870No+s5yJQ67SgyBrmtcq0uQK15AFcKrnkTuZO+DsmuQj5kocZi62iJCxNQbU0sNhyLAyopdVuzeeCmUyhwSZpfeBMShVygWZcb45a10pd5d2MTDZDWQALQWEYxV+HLkX55Dhcd9eglFS5d7Dfo1rcm7Q391oxvIL2S9K5MDC3zMrbGNQ/7Pc3W9BXMC4w1UHoKxYSLtLMkJQploABRfP87HEuVvRjMbqLJep2I+oW4daGf+eeXWa05UKCa3vDKRX+snmOy3bdvUFR/E+9HEHZqkXMC6nwMtEmUoe4PpZiXgwMhiRYMMUCA0pvAw9kMuNlJN/dTy5gd12UbD0FI5Yt5N278ahA0M407BlAGEuAzMxTPW2pSCjB4U6YCVzq4XTMJmeNnNX24SPGY41y4bq6GcK+N2GxlrmQLIhiK2K1xTX4ZdRENGPBPV6d4VUisLCYn5baOHWZS1vhpgTEEmKZ2tSvbUODv7ANvROsvKl8xJqjv7R7sV5csJhoUEtQTi8/zbtwU9zqKNAyXoJT4zKE2KR6Wg8pzskUUaWw9BZUXgGkmV6g+fEoFwUxGBMr45tJs8gvcglTgDfYbb3feFRDkCnb7757oKcp/xbwc4KlsWFzrLxp/hqAuABP9op7sDO8ErTvAhTKMnHZok9TabPVlJkF9WlvOcyfPvSabx7y5xE9HX5YmV7lzXqWrxgkLcdd8d8UyggSmQvEdSGoTxfGpNrv9UJIJL636HJ7Vd/lkmJgbSK4VDJ0jxB2ofklDFeGzdHF7gDXbrpNyKRiuGucWD0v2F6FfzeA+QbitBKjHs1b/Y33AY9K1dPLMbmHNUGLRoYG+Q08aqyrGgt/2cAzJW4bkmR4sQl4Pxrxj2U4cjSSKdkT0jhNNopx+xpGpyyAfY9Ad95tofVJDvhyLTOF7Ojcw/qradd2ntB5vK2ekZwX5vklO04HEXt+FB0fdo5OBiedw6PjYWd2EAWdYfDi+CA6PmYRO27cG2Db9YkasOZeahVNKcu7YnqyvWu1qQ+/AcOwpnXjy6CBPZRB25+V3cGN59pj+czmcffsj6Rm8mSbvIRv5SM5onrGXVtcpt61sVaanV9ubcu1/bu+Z/9N7BaRLCIcc63E4mIur/a+rky4tEL+z2qoaft1t9EyzhIIX8JhUYHNvkCi1hsgHP8m5aOE3E4/66EdJkDbAS/r7x5KX35Zvc0rcjR0JCAQRhPXonEmrfEpjvXRnu1XupbjEndYk9zF11pyOn8zqA2+9VGh7tjz4msGEsVypZ2DyTltqf3tXrjZ1kMAQlunUvjPlAULIMNu/5HoVqtVl9nprlTzXg6re9+Nz86/vzrvIMymerJSiROZFcogK6VHPYrBy4l92B8edg+6A4TF6JgwUaNn3Ho31Xbptdzr76eaf+WnmrnDNfDR9NKYcYH6ZBX4Ic+27uhy6FryEbdeukF63lq1PTubdbW7cC7zmmATBO9W7+jDw4xpeKfizQaHf8xA2fTQo/ZB0gyt4G5SdiRspLnHVIaeOZXt5D2j/CrpcemAmZWDOLXNySfX1rPMy4ura+rRWf78NHGJgmIrbMixFfUptr7tka3XsqUJs1f7MRPzjM1xvcOLuQjmS80U7N6mYPlH7Y6AiXWNynY25g6D/6/3cxogL9FbfAvrr8rlbmYnQJkButUo+Mlms/kvLO/+tg==
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Issue credential</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/issue"}></MethodEndpoint>



Issues a Verifiable Credential to a holder using the OpenID for Verifiable Credentials Issuance (OID4VCI) protocol. Supports two issuance modes: **InTime** (credential issued immediately via the Credential Endpoint) and **Deferred** (credential issued later via the Deferred Credential Endpoint by calling the [Issue deferred credential](/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history) API). Supports W3C VC (JWT), IETF SD-JWT VC, and ISO 18013-5 mDoc/mDL credential formats.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Issuance instruction. `issuanceMode` is the only mandatory field. Select the credential template with `credentialDefinitionId`, and send the claims in `credential` or `credentials`. You do not set the grant type directly: the issuer uses the Pre-Authorized Code Flow when you send `userPin`, and the Authorization Code Flow when you do not.

</div></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"Default (all fields)"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode. `InTime` issues the credential immediately through the OID4VCI Credential Endpoint. `Deferred` issues the credential later through the Deferred Credential Endpoint.","enum":["InTime","Deferred"],"example":"InTime"}}></SchemaItem><SchemaItem collapsible={false} name={"urlScheme"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","default":"openid-credential-offer://","description":"URL scheme for the credential offer deep link. The issuer accepts any string and does not check the value. `openid-credential-offer://` is the standard OID4VCI scheme and the default. `haip://` is used for HAIP-compliant wallets.","example":"openid-credential-offer://"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"Identifier of a pre-configured credential definition. The issuer uses the format, type, claims structure and revocation settings of this credential definition. The value must be a valid UUID."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 12 characters`, Value must match regular expression `^(.{4,12})?$`"} schema={{"type":"string","maxLength":12,"pattern":"^(.{4,12})?$","description":"Pre-Authorized Code Flow transaction code (tx_code). When set, the wallet must include this value in the Token Request to obtain an access token. Give 4 to 12 characters. When you send this field the issuer uses the Pre-Authorized Code Flow, even if you send an empty string - an empty string selects that flow but the issuer then drops the transaction code. Leave the field out completely for the Authorisation Code Flow. You cannot combine this field with `presentationDefinitionId`.","example":"1234"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential offer endpoint URL of the wallet for issuer-initiated issuance. When you provide this URL, the issuer sends the OID4VCI Credential Offer directly to this endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential object containing the claims to be issued via the OpenID for Verifiable Credentials Issuance (OID4VCI) protocol. Structure varies by format: use `type` and `credentialSubject` for W3C VC (JWT), `vct` and `claims` for IETF SD-JWT VC, or `doctype` and `claims` for ISO 18013-5 mDoc/mDL. The issuer does not restrict the members of this object: any member that this schema does not list passes through, is stored in the credential, and is returned in the credential payload.

</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of W3C Verifiable Credential type strings (e.g. `['LegalPersonIdentificationData']`). Required for W3C VC (JWT) format (`jwt_vc_json`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key-value pairs representing the credential claims for W3C VC (JWT) format (`jwt_vc_json`).

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Key-value pairs representing the credential claims for W3C VC (JWT) format (`jwt_vc_json`)."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialMetadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Free-form metadata that you want to keep with the credential. The issuer does not read or process this object: it stores the object inside the credential and returns it unchanged in the credential payload.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Free-form metadata that you want to keep with the credential. The issuer does not read or process this object: it stores the object inside the credential and returns it unchanged in the credential payload."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type identifier for IETF SD-JWT VC format (`dc+sd-jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type identifier for ISO 18013-5 mDoc/mDL format (`mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key-value pairs representing the credential claims for IETF SD-JWT VC (`dc+sd-jwt`) or ISO 18013-5 mDoc/mDL (`mso_mdoc`) formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Key-value pairs representing the credential claims for IETF SD-JWT VC (`dc+sd-jwt`) or ISO 18013-5 mDoc/mDL (`mso_mdoc`) formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","title":"Credential","additionalProperties":true,"properties":{"type":{"type":"array","items":{"type":"string"},"description":"Array of W3C Verifiable Credential type strings (e.g. `['LegalPersonIdentificationData']`). Required for W3C VC (JWT) format (`jwt_vc_json`)."},"credentialSubject":{"type":"object","additionalProperties":true,"description":"Key-value pairs representing the credential claims for W3C VC (JWT) format (`jwt_vc_json`)."},"credentialMetadata":{"type":"object","additionalProperties":true,"description":"Free-form metadata that you want to keep with the credential. The issuer does not read or process this object: it stores the object inside the credential and returns it unchanged in the credential payload."},"vct":{"type":"string","description":"Verifiable Credential Type identifier for IETF SD-JWT VC format (`dc+sd-jwt`)."},"doctype":{"type":"string","description":"Document type identifier for ISO 18013-5 mDoc/mDL format (`mso_mdoc`)."},"claims":{"type":"object","additionalProperties":true,"description":"Key-value pairs representing the credential claims for IETF SD-JWT VC (`dc+sd-jwt`) or ISO 18013-5 mDoc/mDL (`mso_mdoc`) formats."},"id":{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}},"description":"Credential object containing the claims to be issued via the OpenID for Verifiable Credentials Issuance (OID4VCI) protocol. Structure varies by format: use `type` and `credentialSubject` for W3C VC (JWT), `vct` and `claims` for IETF SD-JWT VC, or `doctype` and `claims` for ISO 18013-5 mDoc/mDL. The issuer does not restrict the members of this object: any member that this schema does not list passes through, is stored in the credential, and is returned in the credential payload."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentials"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of credentials to issue in one exchange. Use this field when the credential definition contains more than one credential definition entry. Each entry must carry the `id` of the credential definition entry that it fills, because the issuer matches the entries by that value.","items":{"allOf":[{"type":"object","title":"Credential","additionalProperties":true,"properties":{"type":{"type":"array","items":{"type":"string"},"description":"Array of W3C Verifiable Credential type strings (e.g. `['LegalPersonIdentificationData']`). Required for W3C VC (JWT) format (`jwt_vc_json`)."},"credentialSubject":{"type":"object","additionalProperties":true,"description":"Key-value pairs representing the credential claims for W3C VC (JWT) format (`jwt_vc_json`)."},"credentialMetadata":{"type":"object","additionalProperties":true,"description":"Free-form metadata that you want to keep with the credential. The issuer does not read or process this object: it stores the object inside the credential and returns it unchanged in the credential payload."},"vct":{"type":"string","description":"Verifiable Credential Type identifier for IETF SD-JWT VC format (`dc+sd-jwt`)."},"doctype":{"type":"string","description":"Document type identifier for ISO 18013-5 mDoc/mDL format (`mso_mdoc`)."},"claims":{"type":"object","additionalProperties":true,"description":"Key-value pairs representing the credential claims for IETF SD-JWT VC (`dc+sd-jwt`) or ISO 18013-5 mDoc/mDL (`mso_mdoc`) formats."},"id":{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}},"description":"Credential object containing the claims to be issued via the OpenID for Verifiable Credentials Issuance (OID4VCI) protocol. Structure varies by format: use `type` and `credentialSubject` for W3C VC (JWT), `vct` and `claims` for IETF SD-JWT VC, or `doctype` and `claims` for ISO 18013-5 mDoc/mDL. The issuer does not restrict the members of this object: any member that this schema does not list passes through, is stored in the credential, and is returned in the credential payload."}],"required":["id"]}}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a presentation definition for dynamic credential requests. When set, the issuer requires the holder to present matching credentials through OpenID4VP before issuance continues."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data to bind to the issuance, as defined in the OpenID4VP transaction data extension. The issuer applies this field only together with `credentialDefinitionId`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data to bind to the issuance, as defined in the OpenID4VP transaction data extension. The issuer applies this field only together with `credentialDefinitionId`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional. Non-OID4VCI extension. Identifier of a specific individual recipient. When you provide this value, the issuer sends the credential offer as a push notification to the registered device of the individual. You cannot combine this field with `mapperId`."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional. Non-OID4VCI extension. External reference that identifies the individual recipient. The issuer resolves the individual from this value and sends the credential offer as a push notification. You cannot combine this field with `individualId`."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer adds a visible signature stamp to the issued document."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Position of the signature stamp on the document page. Give exactly four pixel coordinates. The issuer refuses any other number of values.","items":{"type":"integer"},"minItems":4,"maxItems":4,"example":[0,0,0,0]}}></SchemaItem></TabItem><TabItem label={"IETF SD-JWT VC"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode. `InTime` issues the credential immediately through the OID4VCI Credential Endpoint. `Deferred` issues the credential later through the Deferred Credential Endpoint.","enum":["InTime","Deferred"],"example":"InTime"}}></SchemaItem><SchemaItem collapsible={false} name={"urlScheme"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","default":"openid-credential-offer://","description":"URL scheme for the credential offer deep link. The issuer accepts any string and does not check the value. `openid-credential-offer://` is the standard OID4VCI scheme and the default. `haip://` is used for HAIP-compliant wallets.","example":"openid-credential-offer://"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition configured for IETF SD-JWT VC (`dc+sd-jwt`) format."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credentials to issue. Each entry contains the `id` from the `credentialDefinitions` array and the claims as flat key-value pairs for IETF SD-JWT VC format. The issuer matches the entries to the credential definition entries by `id`, so `id` is mandatory.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Flat key-value pairs representing the credential claims for IETF SD-JWT VC format. Keys are claim names (e.g. `given_name`, `birthdate`), values are the claim data. Nested objects (e.g. `address`) are supported.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Flat key-value pairs representing the credential claims for IETF SD-JWT VC format. Keys are claim names (e.g. `given_name`, `birthdate`), values are the claim data. Nested objects (e.g. `address`) are supported."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 12 characters`, Value must match regular expression `^(.{4,12})?$`"} schema={{"type":"string","maxLength":12,"pattern":"^(.{4,12})?$","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow. Give 4 to 12 characters. When you send this field the issuer uses the Pre-Authorized Code Flow, even if you send an empty string - an empty string selects that flow but the issuer then drops the transaction code. Leave the field out completely for the Authorisation Code Flow.","example":"1234"}}></SchemaItem></TabItem><TabItem label={"ISO 18013-5 mDoc/mDL"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode. `InTime` issues the credential immediately through the OID4VCI Credential Endpoint. `Deferred` issues the credential later through the Deferred Credential Endpoint.","enum":["InTime","Deferred"],"example":"InTime"}}></SchemaItem><SchemaItem collapsible={false} name={"urlScheme"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","default":"openid-credential-offer://","description":"URL scheme for the credential offer deep link. The issuer accepts any string and does not check the value. `openid-credential-offer://` is the standard OID4VCI scheme and the default. `haip://` is used for HAIP-compliant wallets.","example":"openid-credential-offer://"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition configured for ISO 18013-5 mDoc/mDL (`mso_mdoc`) format."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credentials to issue. Each entry contains the `id` from the `credentialDefinitions` array and the claims namespaced under the mDoc doctype. The issuer matches the entries to the credential definition entries by `id`, so `id` is mandatory.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims namespaced under the ISO 18013-5 mDoc/mDL doctype (e.g. `eu.europa.ec.eudi.pid.1`). The top-level key is the doctype namespace containing the data elements as key-value pairs.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Claims namespaced under the ISO 18013-5 mDoc/mDL doctype (e.g. `eu.europa.ec.eudi.pid.1`). The top-level key is the doctype namespace containing the data elements as key-value pairs."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 12 characters`, Value must match regular expression `^(.{4,12})?$`"} schema={{"type":"string","maxLength":12,"pattern":"^(.{4,12})?$","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow. Give 4 to 12 characters. When you send this field the issuer uses the Pre-Authorized Code Flow, even if you send an empty string - an empty string selects that flow but the issuer then drops the transaction code. Leave the field out completely for the Authorisation Code Flow.","example":"1234"}}></SchemaItem></TabItem><TabItem label={"W3C VC (JWT)"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode. `InTime` issues the credential immediately through the OID4VCI Credential Endpoint. `Deferred` issues the credential later through the Deferred Credential Endpoint.","enum":["InTime","Deferred"],"example":"InTime"}}></SchemaItem><SchemaItem collapsible={false} name={"urlScheme"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","default":"openid-credential-offer://","description":"URL scheme for the credential offer deep link. The issuer accepts any string and does not check the value. `openid-credential-offer://` is the standard OID4VCI scheme and the default. `haip://` is used for HAIP-compliant wallets.","example":"openid-credential-offer://"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition configured for W3C VC (JWT) (`jwt_vc_json`) format."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credentials to issue. Each entry contains the `id` from the `credentialDefinitions` array and the claims under `credentialSubject` for W3C VC (JWT) format. The issuer matches the entries to the credential definition entries by `id`, so `id` is mandatory.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

W3C Verifiable Credential subject containing the claims as key-value pairs following the W3C Verifiable Credentials Data Model.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"W3C Verifiable Credential subject containing the claims as key-value pairs following the W3C Verifiable Credentials Data Model."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 12 characters`, Value must match regular expression `^(.{4,12})?$`"} schema={{"type":"string","maxLength":12,"pattern":"^(.{4,12})?$","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow. Give 4 to 12 characters. When you send this field the issuer uses the Pre-Authorized Code Flow, even if you send an empty string - an empty string selects that flow but the issuer then drops the transaction code. Leave the field out completely for the Authorisation Code Flow.","example":"1234"}}></SchemaItem></TabItem><TabItem label={"Dynamic credential request"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode. `InTime` issues the credential immediately through the OID4VCI Credential Endpoint. `Deferred` issues the credential later through the Deferred Credential Endpoint.","enum":["InTime","Deferred"],"example":"InTime"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition to use for issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a presentation definition for dynamic credential requests. The issuer requires the holder to present matching credentials via OpenID for Verifiable Presentation (OpenID4VP) before issuance proceeds."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Wallet's credential offer endpoint URL for issuer-initiated issuance. When provided, the issuer sends the OID4VCI Credential Offer directly to this endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"urlScheme"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","default":"openid-credential-offer://","description":"URL scheme for the credential offer deep link. The issuer accepts any string and does not check the value. `openid-credential-offer://` is the standard OID4VCI scheme and the default. `haip://` is used for HAIP-compliant wallets.","example":"openid-credential-offer://"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data to bind to the issuance, as defined in the OpenID4VP transaction data extension. The issuer includes this data in the presentation request that it sends to the holder.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data to bind to the issuance, as defined in the OpenID4VP transaction data extension. The issuer includes this data in the presentation request that it sends to the holder."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentials"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of credentials to issue after the holder completes the presentation. Each entry must carry the `id` of the credential definition entry that it fills, because the issuer matches the entries by that value.","items":{"allOf":[{"type":"object","title":"Credential","additionalProperties":true,"properties":{"type":{"type":"array","items":{"type":"string"},"description":"Array of W3C Verifiable Credential type strings (e.g. `['LegalPersonIdentificationData']`). Required for W3C VC (JWT) format (`jwt_vc_json`)."},"credentialSubject":{"type":"object","additionalProperties":true,"description":"Key-value pairs representing the credential claims for W3C VC (JWT) format (`jwt_vc_json`)."},"credentialMetadata":{"type":"object","additionalProperties":true,"description":"Free-form metadata that you want to keep with the credential. The issuer does not read or process this object: it stores the object inside the credential and returns it unchanged in the credential payload."},"vct":{"type":"string","description":"Verifiable Credential Type identifier for IETF SD-JWT VC format (`dc+sd-jwt`)."},"doctype":{"type":"string","description":"Document type identifier for ISO 18013-5 mDoc/mDL format (`mso_mdoc`)."},"claims":{"type":"object","additionalProperties":true,"description":"Key-value pairs representing the credential claims for IETF SD-JWT VC (`dc+sd-jwt`) or ISO 18013-5 mDoc/mDL (`mso_mdoc`) formats."},"id":{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}},"description":"Credential object containing the claims to be issued via the OpenID for Verifiable Credentials Issuance (OID4VCI) protocol. Structure varies by format: use `type` and `credentialSubject` for W3C VC (JWT), `vct` and `claims` for IETF SD-JWT VC, or `doctype` and `claims` for ISO 18013-5 mDoc/mDL. The issuer does not restrict the members of this object: any member that this schema does not list passes through, is stored in the credential, and is returned in the credential payload."}],"required":["id"]}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The issuer created the credential exchange record and the credential offer. The response holds a single object when the issuer creates one exchange record, and an array when the credential definition creates more than one record. The issuer answers `200`, not `201`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>credentialHistory</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential exchange record, or array of credential exchange records, created for this issuance.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange record. This field holds the same value as `CredentialExchangeId`.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"CredentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential exchange record, tracking the full lifecycle of a single OID4VCI credential issuance.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Camel-case alias of `CredentialExchangeId`. The server sets both fields to the same value. Use this field in new integrations.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that issues the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that processes this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement that governs this issuance. The field is empty when the issuance uses a credential definition instead of a data agreement."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributeValues</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attribute values supplied for a data agreement based issuance. The field is `null` when the issuance uses a credential definition.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the data attribute, as defined in the data agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the data attribute for this holder."}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes this attribute selectively disclosable."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder opened the credential offer."}}></SchemaItem><SchemaItem collapsible={false} name={"isTokenAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder called the OID4VCI Token Endpoint for this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode used for this exchange. `InTime` means the credential was issued immediately via the OID4VCI Credential Endpoint. `Deferred` means the credential is pending via the Deferred Credential Endpoint.","enum":["","InTime","Deferred"]}}></SchemaItem><SchemaItem collapsible={false} name={"isPreAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuance used the OID4VCI Pre-Authorized Code Flow. When `false`, the Authorization Code Flow was used."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOffer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The OID4VCI Credential Offer URI sent to the holder to start the issuance flow.","example":"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/..."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential offer endpoint of the holder wallet. The issuer sends the Credential Offer to this URL for issuer-initiated issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `pending`, `ready`]"} schema={{"type":"string","enum":["","pending","ready"],"description":"Processing status of the credential. `pending` means the credential is being prepared. `ready` means it is available for the holder to retrieve."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Lifecycle status of the credential exchange in the OID4VCI protocol flow: `offer_sent` (Credential Offer sent to holder), `offer_received` (holder scanned or received the offer), `token_issued` (issuer released an access token), `credential_issued` (credential issued via Credential Endpoint), `credential_acked` (holder acknowledged receipt), `credential_accepted` (holder accepted credential), `credential_deleted` (holder deleted credential), `issuance_denied` (issuer denied issuance)."}}></SchemaItem><SchemaItem collapsible={false} name={"issuerState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the OID4VCI `issuer_state` parameter. The issuer uses it to bind the Authorization Request to this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the OAuth 2.0 Authorization Request that the wallet sent."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the ID Token Request that the issuer sent to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID Token Request that the issuer sent to the holder as a signed request object."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCodeState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value that the issuer returns together with the authorisation code."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorisation code issued for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorised code issued for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token that the holder uses to poll the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallenge"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge that the wallet sent in the Authorization Request, as defined in RFC 7636."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallengeMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge method, for example `S256`."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the wallet registered for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the holder's wallet, typically a DID or URL. Provided during the OID4VCI Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"did"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Decentralized Identifier of the issuer that signs the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was last modified. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDate"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the credential issuance happened for this exchange record. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes the data agreement attributes selectively disclosable in the issued credential."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>disclosureMapping</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialLabel"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label of the credential definition or data agreement that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of an external credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a presentation definition required for dynamic credential requests."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation exchange session linked to a dynamic credential request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata about the credential holder obtained during the OID4VCI exchange. The issuer returns only the `name` field. The default value before the holder starts the flow is `Unknown`.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder, typically a DID or display name resolved from wallet client metadata.","example":"Unknown"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format used for this issuance. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL. Records created by earlier releases can also hold the legacy values `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc`.","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"example":"dc+sd-jwt"}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether revocation is enabled for the issued credential."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status: `Operational` (valid), `Revoked` (permanently invalidated), `Suspended` (temporarily invalidated). The field is empty when the credential definition does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client assertion JWT provided by the holder's wallet for client authentication."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token, for example `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's client assertion JWT was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Wallet Unit Attestation (WUA) credential presented by the holder, certifying the wallet instance is genuine."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationPoP"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession for the Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the Wallet Unit Attestation was verified."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitValidity</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of wallet unit validity records containing attestation and proof of possession verification status.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wallet unit attestation verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isRevoked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has been revoked."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>proofOfPossession</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Proof of possession verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"validatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the wallet unit validity was validated."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed credential token (JWT, SD-JWT, or mDoc) issued to the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>cnf</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Confirmation claim (`cnf`) containing the holder's public key JWK for key binding.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Confirmation claim (`cnf`) containing the holder's public key JWK for key binding."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT Token Identifier (`jti`), unique identifier for the issued credential token."}}></SchemaItem><SchemaItem collapsible={false} name={"proof"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof JWT provided by the holder in the OID4VCI Credential Request, demonstrating key possession."}}></SchemaItem><SchemaItem collapsible={false} name={"proofType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the proof provided in the Credential Request (e.g. `jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"proofVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer verified the holder's proof of key possession."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedWalletUnitAttestation</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's Wallet Unit Attestation credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's Wallet Unit Attestation credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token shared by the holder during the issuance flow."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's OpenID Connect ID Token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's OpenID Connect ID Token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idTokenVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's OpenID Connect ID Token was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDeniedReason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable reason why the issuer denied the credential issuance request."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialResponseEncryption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."}}></SchemaItem><SchemaItem collapsible={false} name={"enc"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public JSON Web Key that the issuer uses to encrypt the Credential Response.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.","properties":{"alg":{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."},"enc":{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."},"jwk":{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the issuer, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the issuer, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holderTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the holder, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the holder, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual recipient the credential offer was sent to."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Mapper identifier linking the credential offer to an external individual record."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum polling interval (in seconds) for the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer adds a visible signature stamp to the issued document."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={true} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Position of the signature stamp on the document page, given as four pixel coordinates.","items":{"type":"integer"},"minItems":4,"maxItems":4}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `did:key` or `x509`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the credential definition at the time of the issuance.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the credential definition at the time of the issuance."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange record. This field holds the same value as `CredentialExchangeId`.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"CredentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential exchange record, tracking the full lifecycle of a single OID4VCI credential issuance.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Camel-case alias of `CredentialExchangeId`. The server sets both fields to the same value. Use this field in new integrations.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that issues the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that processes this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement that governs this issuance. The field is empty when the issuance uses a credential definition instead of a data agreement."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributeValues</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attribute values supplied for a data agreement based issuance. The field is `null` when the issuance uses a credential definition.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the data attribute, as defined in the data agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the data attribute for this holder."}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes this attribute selectively disclosable."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder opened the credential offer."}}></SchemaItem><SchemaItem collapsible={false} name={"isTokenAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder called the OID4VCI Token Endpoint for this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode used for this exchange. `InTime` means the credential was issued immediately via the OID4VCI Credential Endpoint. `Deferred` means the credential is pending via the Deferred Credential Endpoint.","enum":["","InTime","Deferred"]}}></SchemaItem><SchemaItem collapsible={false} name={"isPreAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuance used the OID4VCI Pre-Authorized Code Flow. When `false`, the Authorization Code Flow was used."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOffer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The OID4VCI Credential Offer URI sent to the holder to start the issuance flow.","example":"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/..."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential offer endpoint of the holder wallet. The issuer sends the Credential Offer to this URL for issuer-initiated issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `pending`, `ready`]"} schema={{"type":"string","enum":["","pending","ready"],"description":"Processing status of the credential. `pending` means the credential is being prepared. `ready` means it is available for the holder to retrieve."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Lifecycle status of the credential exchange in the OID4VCI protocol flow: `offer_sent` (Credential Offer sent to holder), `offer_received` (holder scanned or received the offer), `token_issued` (issuer released an access token), `credential_issued` (credential issued via Credential Endpoint), `credential_acked` (holder acknowledged receipt), `credential_accepted` (holder accepted credential), `credential_deleted` (holder deleted credential), `issuance_denied` (issuer denied issuance)."}}></SchemaItem><SchemaItem collapsible={false} name={"issuerState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the OID4VCI `issuer_state` parameter. The issuer uses it to bind the Authorization Request to this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the OAuth 2.0 Authorization Request that the wallet sent."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the ID Token Request that the issuer sent to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID Token Request that the issuer sent to the holder as a signed request object."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCodeState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value that the issuer returns together with the authorisation code."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorisation code issued for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorised code issued for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token that the holder uses to poll the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallenge"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge that the wallet sent in the Authorization Request, as defined in RFC 7636."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallengeMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge method, for example `S256`."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the wallet registered for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the holder's wallet, typically a DID or URL. Provided during the OID4VCI Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"did"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Decentralized Identifier of the issuer that signs the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was last modified. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDate"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the credential issuance happened for this exchange record. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes the data agreement attributes selectively disclosable in the issued credential."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>disclosureMapping</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialLabel"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label of the credential definition or data agreement that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of an external credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a presentation definition required for dynamic credential requests."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation exchange session linked to a dynamic credential request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata about the credential holder obtained during the OID4VCI exchange. The issuer returns only the `name` field. The default value before the holder starts the flow is `Unknown`.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder, typically a DID or display name resolved from wallet client metadata.","example":"Unknown"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format used for this issuance. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL. Records created by earlier releases can also hold the legacy values `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc`.","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"example":"dc+sd-jwt"}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether revocation is enabled for the issued credential."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status: `Operational` (valid), `Revoked` (permanently invalidated), `Suspended` (temporarily invalidated). The field is empty when the credential definition does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client assertion JWT provided by the holder's wallet for client authentication."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token, for example `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's client assertion JWT was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Wallet Unit Attestation (WUA) credential presented by the holder, certifying the wallet instance is genuine."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationPoP"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession for the Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the Wallet Unit Attestation was verified."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitValidity</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of wallet unit validity records containing attestation and proof of possession verification status.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wallet unit attestation verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isRevoked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has been revoked."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>proofOfPossession</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Proof of possession verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"validatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the wallet unit validity was validated."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed credential token (JWT, SD-JWT, or mDoc) issued to the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>cnf</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Confirmation claim (`cnf`) containing the holder's public key JWK for key binding.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Confirmation claim (`cnf`) containing the holder's public key JWK for key binding."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT Token Identifier (`jti`), unique identifier for the issued credential token."}}></SchemaItem><SchemaItem collapsible={false} name={"proof"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof JWT provided by the holder in the OID4VCI Credential Request, demonstrating key possession."}}></SchemaItem><SchemaItem collapsible={false} name={"proofType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the proof provided in the Credential Request (e.g. `jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"proofVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer verified the holder's proof of key possession."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedWalletUnitAttestation</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's Wallet Unit Attestation credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's Wallet Unit Attestation credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token shared by the holder during the issuance flow."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's OpenID Connect ID Token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's OpenID Connect ID Token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idTokenVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's OpenID Connect ID Token was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDeniedReason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable reason why the issuer denied the credential issuance request."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialResponseEncryption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."}}></SchemaItem><SchemaItem collapsible={false} name={"enc"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public JSON Web Key that the issuer uses to encrypt the Credential Response.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.","properties":{"alg":{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."},"enc":{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."},"jwk":{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the issuer, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the issuer, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holderTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the holder, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the holder, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual recipient the credential offer was sent to."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Mapper identifier linking the credential offer to an external individual record."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum polling interval (in seconds) for the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer adds a visible signature stamp to the issued document."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={true} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Position of the signature stamp on the document page, given as four pixel coordinates.","items":{"type":"integer"},"minItems":4,"maxItems":4}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `did:key` or `x509`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the credential definition at the time of the issuance.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the credential definition at the time of the issuance."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialHistory\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is invalid. The issuer returns this status when `issuanceMode` is missing or is not `InTime` or `Deferred`, when `userPin` is shorter than 4 or longer than 12 characters, when `userPin` is combined with `presentationDefinitionId`, when `credentialDefinitionId` is missing or is not a valid UUID, when `transactionData` is sent without `presentationDefinitionId` or does not match its schema, or when the issuance fails. This operation can also return the raw error body of the issuance backend instead of the `errorCode` and `errorDescription` envelope.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error. The issuer returns this status when it cannot resolve the individual for `individualId` or `mapperId`, when the individual has no push notification token, or when both fields are set.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Look up a key in the trust lists
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-key-trust-lookup

---
id: config-digital-wallet-open-id-key-trust-lookup
title: "Look up a key in the trust lists"
description: "Checks whether the trust sources of the organisation know a signing key: the trust list lookup service of the platform, the trust lists of the organisation, and the X.509 CAs of its trust authorities. Use it before you select a key for a credential definition or a presentation definition. The dashboard shows the same result in **Trust List Lookup**."
sidebar_label: "Look up a key in the trust lists"
hide_title: true
hide_table_of_contents: true
api: eJztWltvGzcW/isEn+xgPJadpG20bbGK7G3VpLFRO0kBx8jQM0cSqxlySnLsaA3998U55NwkOXa6we5DDQTOaIaXc/vOjbzlGdjUyNJJrfiQj+eQLiy7mYObg2FuDsyZyjpmdWVSsExP6aU2M6GkFTiNLZS+YYJZOVNSzdgClsPOzFziH60XVcksmGuZQr1KmQs31aaI1oZv3SZiQmX09vf4+eAFG49omHQ2zBSVm2sjnQQbs7cWmHTsCqbaAFvqilnIIXVMIH1sqg0TLDWQgXJS5CyDqVSS2KFPpQELynkG248xO58Dy4SdX2lhMmbn+sYSUVYUwAzYKndMKvbkyTkR9Rq5f03cP3kSf1Af1E/yGmgG0jE5wsHJQmZJw16grxC0UOIfk5i9l27Okk/PBy8SL7AbkefgZWtZVdK7FIyTU5kKByydC6lqUS5gGZYQ7GhyFHaI2KwmB1+2Y2nrTGaJ51goewOGzYVnNvCppwxEOg/GQVOCnQQKr8A6BsoZv55XAWSJ12VyDUZOJWQJGpxibi6a0ZbNjFAOMhqJSu5wZpkwwK5FLjMS6ShNwdohE6pvmCIrpGJOL0BFpFbFRqcTYu8GJUF6S3UJLCET2hMqnWtjhwZElrAdXC/PwNSzhixJtZrKWbIbf1A84roEQ1tNMj7k/tuRnEkn8veknJMS1CR7BUuyBm8HPOIG/qzAupc6W/LhLf2UBjI+dKaCaA2T50EjW+zDadI+q8qYR7i/A+VwRVGWOYpKarX/h8VlbrlN51AIfHLLEviQ66s/IHU84qVBRhA4+HUhs84g64xUM34XUd5oPKi2gBbJgk+iKHNc6+n0ULw4SJ99e/Vd9gy+mYpB+jz7Fg6+u3px+Gz6dMBXEfecPZyATUkEjLCdWlgKILMI93Vs7EY9MDBbpXMmLBn+cAHLhO0QPAgIu2RCBNU+V7gbUp49VG59pMXst6D+4JW66PTGzwp0JVfBbwoXPsd8tYo6xnNBqmtEeBlxkWXktkR+2lHxVOQWVh0Wgs7v10+rnsD1ylNgS62st57DwQD/2+S69v0GXGUUZNscSTfW/FcW7aQj3Wwgr0/X+zkY+JIoF3T2xfGtwx2N37YB6prG1fHNI6sf3Jbx18CrFz35oP8ZQsO2XlLbEfRnBWa5TZ3rWkPAbwZAQn6aEIzwc/ADYf+d+8LjbuSBvgWGPkA369a/CIN3oQxd+SridYzrsHWldQ5CbfB1RskEhiJoIiKwOmiGyFiHYOuEqyxLQpj06QOFxF6k7Ak6kFSvSLDK85MpH17cDSGPH2ndMe6/QfSJgkBZx1pDQkC+qhAunYPdBp0aLnWIL42+lhmYiNVM+nXQCdOLYtP6vRweZo1BZkHlPRoi0m6QVCvVmJ1QInwt8gps1EYIzB8yI25UErECREheOjRnGixT2oVtmlikb/q2H3ZC8ydJnRMX93Hzc+uLgoC9PyVNrPEylWoGpjRSuWQTBdJZyKdo+2V1lcv0I8a9iCV2IRMKeAQTTIYCYJxmgpwYZGw82o2R8s6C79AE/7Kx95K8Tjba5HsbAgw27Worvd99nPddd9iFJHcvmmsL/ZJdaiuv5/Z2bEy9Q5E3d3m/bwkr/xViHkrDmi2F6W9EAWQk/ifa7IQqqakE411R/e2MMJfcy0tH80fghMy7mBbGiE3XQ5CuiGNfbkhrKzBNokwGI92ySS+6dt8xrga63o8FPCHF0kFht4n3M6xgRvSZz5cRV1Wei6vaeLdx1amb0KvmeZOZ7IimMPLfqZDZ9PtsKo11uzFLcLeAMKVr74TJTOOSCcJhgwcJPVSD27K2CAs9N5eWaZOB+f83Ao47BSrGzkQF211IhTVe4inCN8fnZ5OP5687jx9/OTt5493g788HLz6OR1gGJJXJcaaX7NQXljUt+D1YUCiC6Rc2RhLUmKTimBACxmiTxGzUi5epUBg2goxrHFpmQFitqI72E//RTeOYdRLNpEpTrHY+a7z9AIry2BZw2hD1Rpvs9yPhhC1FCqxtbKDdoBi3TldVgSVJXmfeQaTtEwmXRzxIFuuVds8wbRXxyuTb1u+DqI6ed+RZ69EiKGKLsd8ptMd06DEdekyHHtOhx3Toq6ZD6Iwxmj3Axa/1uihuhfjjo0QbA1oPXy9/ufpsr6zuPXTq9U6d3GZHl1+lbdbpdHx6niIxv04m4ziOaf22Y+DTw265Xrv3xk/23CTv+Da+zQ35BXvOwYd/DkLs1Yi08aciDzId8rlzpR3u77s8DpzHqS72Nyes+4Oz0zd+7eMAl5Nut2v0kvch28HSXXOORyMyaqFS4M3ks3WZ3AGfi1se4IEHXW9+2E6Wc2DDsc9pHX9P7hj7Mhr/cHaMwCCk9ZcdjzrzxqPOaKUd6eMlHU7xIT8cHH6zNzjYGxycDwZD+tcZNpo6WvtwcPjt+qjVZTd1v2jUeXfKVmdsbWK2pmYc2tN0M7DJsKiB3MmiLi4bFCNmV9FnzSrs3+aDX2hnHUK8Pbd0fBWArNa48a5jDgIp4MNb/PXMd7kf3J/uOh5ae6wzqJ3TUceNX0b3pOvt7NZjSuVgBqabBzwbDFZblv9snv9SZEyqsnKsFEYUgGa38i3+zUhT1x3Sp3UUXIZYYV7pDEMoK6S1VPVQtxRTp3CSidUPqxSWoIoVUFxRhtu+whi0k7yCJft+IbMfafmprhQdwYjeoc9aI7hJMm1Vltpg47ZpAYeZmKjqym07DWI7Sd2yxkJR6c0hMXtb5lpkW6fX7eEFLOmoqD5wVppy5pbuOJwl9c6easJ8C1obX9iL+ve0WaftO6+b5MHf2CTfqlD1/5sw3xfN8781WifKgVEip2QXDPO+rS8jCsVphQdM5EZHpXwF+HiJ3tCJGXpXHo62mT/bZjt0un307N14l0d41MZ+FUrMoEAhX0a8ADfX6OpLTYGnFG7Oh3z/+nDfH5XvZ37BPY/ffV2Cktn+ApZ7RbOSj0h7TRTyXHhv32f0CAodmNyIKhkUek+UMpYUGGKpOYap/gKnRmdVSrH9jmXuW+HMiRk6vTumW/95nZDLVvpnaITedmodtGm/fxFxiVt59WGe4EPtKNg/GfVGcVDfe0CUYGXibd9f7qBqvq4Akt46CfPbNCfQpYGp/ASZd0+Jp5ElbEdpV5+kCpmTDDD12I0YxLN4bdkhCxO/X+rKoDj2FrD8MfEn2gjI39obEsdfId+ms/kaRSuU4FTXLkGk5BKgEBJ1FWLHP1v9NCKWP7Wv+ort2sSa5JtJdcVLVxE0soT9Bvy/aG4aBSV4YFFEeUfVAJZBbNxcV7JsEtJgtnNCCJzsUp23feJp9zJTg9rTXaTI6VTnFg1BWrrnAgrn2NBy9fqy2OagJDdic51nvoFJhcqSBRB3blNZVlHot06oTJjM7hG/UijHpjk2Osh6gqSJ2vdPx+zdmO388v58N2KT4/N/sbOjvV/en7N3Y7/b5OyEHXw3OHi695wVRzrdL45ed29weZVT5zOXKSgLnfJmVIp0DuwwHmyo7ubmJhb0OdZmth/m2v3Xk/Hxm7PjPZyzavt/rTpRWJlOq0Z7vnq0Xu2Hg8Nn8dP4gMoibV0hVIee1/6uSkhKpFrve6/jtxO8Hu/oPd7Re7yj9/A7eiF4Ovjk9stcSNU5VPAZyQW/PvSXjaaSesu9rMRf81PULepnJjy0Uurc5DLic8x0hhf89vZKWHhr8tUKX4d2D9bJ18JI39S6uGzKSkpmFhjs+djjfI8KVhyeVz72ryWsmHv4GSjZ0n12bDcZOz05O+cRvwp3DwtKTrkRN3gvUdzwIf/AP3Dimlw/JcT4/pbnQs0qMcPxfl1q7lUow26SsqAkJTx0rpYItexQuZ6veGbwL7K2dcr3qONXsPyxGe6/3DmhyZH8aNQ9VvP/AXI2qO8=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Look up a key in the trust lists</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/trust-lookup"}></MethodEndpoint>



Checks whether the trust sources of the organisation know a signing key: the trust list lookup service of the platform, the trust lists of the organisation, and the X.509 CAs of its trust authorities. Use it before you select a key for a credential definition or a presentation definition. The dashboard shows the same result in **Trust List Lookup**.

Give the key ID in `kid` and the key format in `format`. With `x509`, the wallet looks up the certificate chain of the key. With a DID format, give the DID of the key in `did`. The answer has the result of each source in `sources`, the best entry in `selected`, and `verified` when that entry is granted and its certificates are valid.

Access: an organisation admin token, or an API key with the scope `trust-anchors:read` (an older API key: `config`).


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The key and the key format to look up.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"kid"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The key ID of a key of the organisation.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The key format to look up. `x509` (the key needs a certificate chain), a DID format such as `did:key` (give `did`), or `kid`.","example":"x509"}}></SchemaItem><SchemaItem collapsible={false} name={"did"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The DID of the key. Required for a DID format, and it must be of that format."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the result of each trust source.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"kid"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The key ID of the request.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The key format of the lookup.","example":"x509"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>query</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

What the wallet looks up. `x5c` for the `x509` format (the certificate chain of the key), `did` for a DID format, `kid` for the `kid` format.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"What the wallet looks up. `x5c` for the `x509` format (the certificate chain of the key), `did` for a DID format, `kid` for the `kid` format.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the selected entry has the status `granted` and valid certificates.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>selected</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One entry of a trust source that matches the key: the trust service and its provider, as the source gives them.

</div><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The status of the trust service, for example `granted`. Other values, such as `withdrawn`, mean that the source does not trust the key now.","example":"granted"}}></SchemaItem><SchemaItem collapsible={false} name={"matchType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"How the key matched the entry, for example `fingerprint` (the certificate itself), `public_key`, `ski` or `chain` (a chain to a listed CA)."}}></SchemaItem><SchemaItem collapsible={false} name={"certificateValid"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the certificates of the key are valid now.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustList</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust list of the entry.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The trust list of the entry.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>provider</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust service provider of the entry, as the trust list gives it.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The trust service provider of the entry, as the trust list gives it.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>service</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust service of the entry, as the trust list gives it, for example `serviceName`, `serviceTypeIdentifier` and `serviceStatus`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The trust service of the entry, as the trust list gives it, for example `serviceName`, `serviceTypeIdentifier` and `serviceStatus`.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"certificateDetails"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The subject, the issuer and the validity of each certificate of the key that the entry matched.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","title":"TrustListEntry","description":"One entry of a trust source that matches the key: the trust service and its provider, as the source gives them.","additionalProperties":true,"properties":{"status":{"type":"string","description":"The status of the trust service, for example `granted`. Other values, such as `withdrawn`, mean that the source does not trust the key now.","example":"granted"},"matchType":{"type":"string","description":"How the key matched the entry, for example `fingerprint` (the certificate itself), `public_key`, `ski` or `chain` (a chain to a listed CA)."},"certificateValid":{"type":"boolean","description":"Shows `true` when the certificates of the key are valid now.","example":true},"trustList":{"type":"object","description":"The trust list of the entry.","additionalProperties":true},"provider":{"type":"object","description":"The trust service provider of the entry, as the trust list gives it.","additionalProperties":true},"service":{"type":"object","description":"The trust service of the entry, as the trust list gives it, for example `serviceName`, `serviceTypeIdentifier` and `serviceStatus`.","additionalProperties":true},"certificateDetails":{"type":"array","description":"The subject, the issuer and the validity of each certificate of the key that the entry matched.","items":{"type":"object","additionalProperties":true}}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sources</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The answer of each trust source, in this order: the trust list lookup service of the platform, the trust lists of the organisation, and the X.509 CAs of its trust authorities. Each source has `name`, `kind` (`lookup`, `ETSI_TL`, `ETSI_TL_JSON` or `X509_CA`), `url` (`null` for an X.509 CA), `matched`, the matching `entries`, and `error`. A source that cannot answer gives its reason in `error`; the request still succeeds.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"NordXDataspace Trust List"}}></SchemaItem><SchemaItem collapsible={false} name={"kind"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`lookup`, `ETSI_TL`, `ETSI_TL_JSON`, `X509_CA`]"} schema={{"type":"string","enum":["lookup","ETSI_TL","ETSI_TL_JSON","X509_CA"],"example":"lookup"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"matched"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>entries</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The status of the trust service, for example `granted`. Other values, such as `withdrawn`, mean that the source does not trust the key now.","example":"granted"}}></SchemaItem><SchemaItem collapsible={false} name={"matchType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"How the key matched the entry, for example `fingerprint` (the certificate itself), `public_key`, `ski` or `chain` (a chain to a listed CA)."}}></SchemaItem><SchemaItem collapsible={false} name={"certificateValid"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the certificates of the key are valid now.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustList</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust list of the entry.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The trust list of the entry.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>provider</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust service provider of the entry, as the trust list gives it.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The trust service provider of the entry, as the trust list gives it.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>service</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust service of the entry, as the trust list gives it, for example `serviceName`, `serviceTypeIdentifier` and `serviceStatus`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The trust service of the entry, as the trust list gives it, for example `serviceName`, `serviceTypeIdentifier` and `serviceStatus`.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"certificateDetails"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The subject, the issuer and the validity of each certificate of the key that the entry matched.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"error"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n  \"format\": \"x509\",\n  \"query\": {},\n  \"verified\": true,\n  \"selected\": {\n    \"status\": \"granted\",\n    \"matchType\": \"string\",\n    \"certificateValid\": true,\n    \"trustList\": {},\n    \"provider\": {},\n    \"service\": {},\n    \"certificateDetails\": [\n      {}\n    ]\n  },\n  \"sources\": [\n    {\n      \"name\": \"NordXDataspace Trust List\",\n      \"kind\": \"lookup\",\n      \"url\": \"string\",\n      \"matched\": true,\n      \"entries\": [\n        {\n          \"status\": \"granted\",\n          \"matchType\": \"string\",\n          \"certificateValid\": true,\n          \"trustList\": {},\n          \"provider\": {},\n          \"service\": {},\n          \"certificateDetails\": [\n            {}\n          ]\n        }\n      ],\n      \"error\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n  \"format\": \"x509\",\n  \"query\": {\n    \"x5c\": [\n      \"MIIC...\"\n    ]\n  },\n  \"verified\": true,\n  \"selected\": {\n    \"status\": \"granted\",\n    \"matchType\": \"fingerprint\",\n    \"certificateValid\": true,\n    \"trustList\": {\n      \"name\": \"eaa-providers.xml\",\n      \"url\": \"https://tl.example.com/eaa-providers.xml\"\n    },\n    \"provider\": {\n      \"tSPName\": \"Example Organisation AB\"\n    },\n    \"service\": {\n      \"serviceName\": \"Example Organisation EAA issuance\",\n      \"serviceStatus\": \"granted\"\n    },\n    \"certificateDetails\": [\n      {\n        \"subject\": \"CN=Example Organisation Attestation Provider,O=Example Organisation AB,C=SE\",\n        \"issuer\": \"CN=Example CA,O=Example CA AB,C=SE\",\n        \"notValidBefore\": \"2026-01-01T00:00:00\",\n        \"notValidAfter\": \"2027-01-01T00:00:00\"\n      }\n    ]\n  },\n  \"sources\": [\n    {\n      \"name\": \"NordXDataspace Trust List\",\n      \"kind\": \"lookup\",\n      \"url\": \"https://trust.example.com/lookup\",\n      \"matched\": false,\n      \"entries\": [],\n      \"error\": null\n    },\n    {\n      \"name\": \"eaa-providers.xml\",\n      \"kind\": \"ETSI_TL\",\n      \"url\": \"https://tl.example.com/eaa-providers.xml\",\n      \"matched\": true,\n      \"entries\": [\n        {\n          \"status\": \"granted\",\n          \"matchType\": \"fingerprint\",\n          \"certificateValid\": true\n        }\n      ],\n      \"error\": null\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is not valid: no body, a missing `kid` or `format`, an unknown member, an unknown key (`Key <kid> not found`), a key format that the wallet does not support, `x509` for a key without a certificate chain (`The key has no certificate chain. Upload a certificate chain for the key, or select another key format.`), or a DID format without `did` or with a `did` of another format.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List certificate presets
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-list-certificate-presets

---
id: config-digital-wallet-open-id-list-certificate-presets
title: "List certificate presets"
description: "Lists the certificate presets. A preset is a certificate profile of the ecosystem: the values that the profile fixes (key usage, extended key usage and their criticality, certificate policies, QC statements), the fields that a request must have, the longest validity, and the prefill from the data of the organisation. Give the `preset` in the generate CSR and the create test certificate operations."
sidebar_label: "List certificate presets"
hide_title: true
hide_table_of_contents: true
api: eJztXOtz2ziS/1e6+Em6o2RLfsTxPGo1smZKm6ztsexkq2ZSS5iEJIwpUAFAO5qs//erboBPUbLsZLbu6vIlsUgCaDS6G79+AJ+9iOtQiaURifROvbdCGw1mziHkyoipCJnhsFRcc6O7MHB/gtDAap8kUxFzSKbUmoeJXmnDF6f0857FKcd+maHf2ddT8YlraN3xFaSazbgP/JPhMuIR5M+AyQgbCQWhEkaELBZm5VdHT2IRCq59+HUI2jDDF1wa3fZptKngceRGZ6D4x5RrA4tUG5ize24/ihM5w8f3LBYRDeDGxSlPRRzDVCULehAxw7KJJmrGpNAM+deFX8Q9p8eB5VMAQtLvGZdcIaXDyVXecag4PjI4bHk2yRK/FYnU3d/l7/J6nq+Ab/sTGhIVcXUKwYNasrAT8xmLAz/7KZlJlX2wFFFnqZJ7EXFFH7A45qbpEbIt1Z1YaNPRYibtS85Y5eOP9QfL9LZTf7aIkrATJWGKq1DqjJ4rzsqfNQ/b/DRUPOLSCBZ3hNapfejW033W0Ux2IqkD4nIQptokiwBaMiFhi5wo+sDiB7bSEDNt2l0IdJKqkOsA15WzcJ4JumQLbhVCGyYjpiJdrF/MUs01NhFG1/vH4XFph+wsWTAhg1JftOQqSYwVSpqMpk7qwmBFwHU0kuw25lEAep48aBBWBG9TEZsOCga2HQ4y0RRSGxbHJEmosCig7+dcgiD9DaYs1jzwdxPFfNL5ILmQApP6gSsIDvcPAh90AlECMjGQTKdcAVvrFe2IZjK6TT5V9Adm3BkfJ+4ZZ5F9VU37XXq+l5MwjrxTL0zkVMzOxEwYFr8nmb5YcjmO0KYNi9Evbd+e7ymul4nUXHunn73+/j7+VzWHqHqaq3sRclDcpEryqExg1/NxXMOlwcZsuYxxDJHIvT809vDZ0+GcLxj+ZVZL7p16ye0fPDSe7y0VTsAIO77rsfQhU4qtPL+BpNwaPAgzL4QcZRkpEoYvdNOIRpgYH6xxY22Uwdcy7jta4BfY2mt6q+e3CVMRdTC4HEMYC7T8kGpriDVbcEAzAgYtQBwDIxucNArm2qqIqMRHbZSQsy0rAiLyC5Yg2eV9gMFQqys7dxyJy3Thnf7mlUy453sVC470lAw4vq7a7+LJusXEIUqG2fO9j7Xfddvt+V6T6c4eW8ud/WocsPHhmtkm3Wuy2vgxCbP3wff4J7ZYkrw2EvXoe2hQd1sf/DITI7skPkxJBpZc6UTSelTGgzM3HkxoPGiNJxd749EQeif7vYPOURspqIz0FCHvMw0p65aw+8nDPCm2gW205WRZNlSt9RRqRMI17hjwU/fAt91HcLsCJmE8GA6sDg2RBNovtE6FnP0rTFJp1CpjFzEj089h9hTbf0d/Ta79bCfChzBnuNVwv97tH6kSOhKh1d6Mzv5Bv7/fOQTFw2Sx4DKyjUZvbqDX3e/S6+5ht9ftkwpFkaD2yPtlqpaJ3kEA3luzg4iSDCYBqDLfkJV6G9NRBHTBjX9MLqBlRXmQmnmbyKHtv8nqrkvjExbTYcZpohbI7ordgEFhXApL6lAE7brW3uZQBGbi3qGOB6akkLPMKHWSe66UiHiwbvfu+OoGwTftanF8MfVOf9uyn2j1JmvQNN8CyxO817n9vuMrDUxxGA3pb0IPwR1fjWQolnOuUNIdlMOdoPZYcZoxi+PkgUfQuvp5CEeHJ/ugOYkZHLSRYTFn08p6o4jKBFFMQVkLh8WNEdeawObVW/qzvc4du34NW/VCyLHdfHtb+aB9CzITycGIBW/atTcI84Us8/N2RQDpn92j/ddk5MobS2SxEM4CtxNcG5nIK75MI0GbqOfjQg9mipO/5H14LAl9Q3t8n/lgJUpvkyTmDHuTaRyjwfFOjUp5nfQAHwYWNOSCgGKb9dmF98LMkxS1lXicgdPc7avacCDAhR6k7RoeEN6W3lv/UiaStysKjV8/PtpdSChU29+yRf3w+OGpeVRFGoUT16BEZRcC7GEbPWQyMmf3zXO1bVRv2ERigytdqN9XlWlniTUwDRfjM40WLEqM4REZMR+YgUWiDfT364IPPycK3LpAgCafdq7uEZr8YG3Thaatue3XWx43tLToBVhq5ghGLExvIxAMet2D7nG31z3qHnVfdQ+6h0cBtK6TOy5hQoAG0IdwO277mcp6MT6r8cOtfa5ntVn/b1Yz6zP+B/VsQzzohQpX2gQuXchoJ4erKdbUhYEEvlialfUvtgxtcdYAQkYQhqhPHqTtavW15QnF52M4yaNgu2GSSuAs56eFRPmLMmShSUYJt6hjKj6t25SP4TWNuz6tpxf+V2rrk6VomPIuC15GcAgiUcuO+2geun2PmDRMFstYMBnyL9SzDMFJzh2C/bXUeYmBraBCSS9ob5xKmbcgzLpi0TLrMPoLaJ9MhmebqT78Uqov9e1fQPTl5Kcmml8f9vpo3TE4NbqejOF6Ar3eazjs9TvHLogHJ92DdhGGyHC1xc6org6yt4KyZnVpJkFmLQuY3q4oEMUuzJyrctgoZwp+V7eRTnFqIpqvd8bCD/V2dwUeWMMWzdavZio+VDrcwTI2R3YKN8tJRTnUo2HJzFxDa1re+nVKtqmLbmAiz9mCo5ChiSVn1Ea6/h24BWcGUb02ZB5clJB6tV5cvddBbLDHbqrEv2uP+IKJuP5wOU+kdYueYZiJFURFfYMv5kaeNcZJ1mZLrHfhr51xoBO3bU4m+Yl1Zxe9wGytWsPJVdtCAmB5wMoHBgu+uOWqsPlZi1zFZ5TuYHc8j9raCJvTonJAvIYoWpRyEbVocx72zQK77cLf3ebiVvveweH1rd8ogSuVqHW9t9062FOGS1nsqPwxxtJdCNbu9DnoymdNWR/FCw2xRqwUhwUMJCQKsVdrOGhDxEMRcQ0POO0ZMlxIk9SjR+tbriXwZVuuiKy0OD462p9eJVLTVN5JxDQicgsQHO7vB9ByvD/NP7C/v6MIrdPe7005hKp/tD73t/jolvioj8u5U5DUmZqt+QCtJulmaOh6yASikskZoTfHjFHiNnWRFVxUUiCSi+Lds+1IRa3zHZVsQDbANWk5LjBwGSZRlqtzFAtJoZF9my71i7RCFuPMVIrMsA2gQHnKLlIU0C4xiCLFtQ5OYZnamdBjhPT4HEerbzj0QUN8LdsJnq2nQ0d4a0hwBeOocNA7Pu70gMXLOev0AdmAtKTLJcaHmeZdGGMCDwSJ2VQgK35RnIcUfg5GbwPrhzPZ6F/7FZZl2UUb1iV/2tmtPD4a1ELJQbvImVZ7oYgxJkJr8dYRSS7ikgt1idpXheg7MouADXr4S9cFtCbX7SIc0eufQDhnioWGK70DD4KmYHYJA+fTyRRhHen5XpxYp/X583nrWkLr7eZZNIxoE2d/sk1piu2jXpRTtK2Ldrb7zYQ2XPGoklwp5+hKcZ+j400keiOH1QY/eTVSWXwjxQv2sjLBLIZUCgOti5sSy44PK+s+SRbNmzEGPTJdL5Qnt2QrmDFX8FHJY8+5alz5Etp7geLnJgpaw/PNk7lxmc9Nq4L64B671HYXRvdcrbId2OF/XffeSitV1476yo1zXn2huJUt1latzYi3fgI3WkxW0rBPAViv0ceqB1RKmje9Qi6QPzg6hwPnD/YyfxAjcYc1Z+Ld4Hoy6hwdHR+/enVy8vr1fi+wRg8nSK8xb3B+fYX/XU7O8L+3ozH+N7q4CijUOPrnMKjaUzTXPgSdILeRxaSr0TRvnQAyk1wJFp+nCNZfYCOpNUhqbvGfA1cuE7ZB0OhTCYPJebcHl0pIg2NMaNC/cE0OamtyPT6fjDq9/sHh0fGrk9f7lRW5HEyQ+eOzIa3I+QX+dz0+d0sxPnvxUjiFRuDyQn3GUjGZK+lmpj9t3XWqNiXCn1h62/DLxn8sIKYDPbshzezjbYCTxYYryQzCQ1s8tQ5BC0qP9ku+JmUZkAr0IEkavhR+lqBmOOfhnc6TtMzkIzrHUUag+JSKw9DlW2JxlXNW17Eg4vr1UMv2pTs7nziOtKLzCTKSXOU58gGf29Ig8lkljC8ziGpnMRVKG4jZLY8pJH3LIfivwFUvIkyUju20fZKIuJT0oGNb2RAs9hV8Otp//S/N5L+o6M6W35T3SuIm6TVVY50dvrssBe2IYMfoe65sk2z7fEbsJeNHPfJiF6zrnmC4heIsqRLPZvnN1VhDK5UCJ3/FbcHguGQfyNu51UmMzs7N1djaPQZUAcbLSbDDskpVDZr1XpbLRBl44LdamDzVH68Qby+ZMitgYYgeRy0U8AyG3VyNG9IG5K48mzOjsheEIqmm4Um/T1JZrWYICPt2cA5/i2xV5DPprnhcDTOgyN2zZ3DNY04t3T6oM6qrqpBVZIyvbzrXMOr2+vXt6L8Pj+EEev0DODw6hlcnz52eqRGyNkM0t9+KM74VZ3wrztipOKMk0pXwUWNJxLeKjG8VGd8qMl5QkbFJy7bL+871GE/T1FSf8cWiX6SPeydO9s+Hl524w9NIPKhlPZvc65x8dUlsquXYyR79Wm70ZL1Hk9t9lDvB9cx69nE5j45b+XPzhQ3Ju1yA0Ag40baylA//nywzgZZ9X81rtDcKCtUZYFTocnwGWdYIjWHtE5Ql50vmX9GU62UqAbR4zEOjEilC0JzFjXGIr1jJsnPdCqUfRjfwMWUxekBR3RtZJ/IrFKvsUJriO3kS92gO0PQIbc9fFKTqDDYh15Gt9gQUmuWI03Gf1q+T4dkGZrvylR0VEb9uFr01tWK5OFBEoVh5ZvCsijtvhR9mWTVdKutPVFbCnt7GJC6hSRTcJtEKWpfpT53RYNA+3VoDY8/RSMk/wcAv0YaqsV5PQwe58m9QR1gcg5krnpUfWE/C7UnrZwVdJEA0KLWLyV1M32KiId6Yu2jYDKopppg9bMuU+TYWeGNLdUYpEsEk3EiUhZg9QGudX5eTnzon3YPO/hG5MLXoJw38kJRjpc6b3KQgLt+FQGhSCSuEz5h2KtniVszSJNV5/CV0EX/LiRxogQ1eQCufyGG76sgym/ZPphh3sAG4SGgj5CwVeu5yPlgCuSmmIRPAg3EqiYvH1TmH8ocsoXDlckl+8kORY/DDHyxb4kIAXsKXZl7gyqYSFe1hLjBUiGK6rjZCgzslKPAcTVbNtYWT/bZNwTAKAZHXe/D65LhtERruIfwTHbIumpAj/HJGzo1Z6tO9vYeHhzzQpflezB72+vv9YwyOe3XI16hdWyRw2yrsiBt3qM9rWxvoTFVuC905x3XbUgGbtf6/y4rQtpgfP+thpzMyj487TvRrI6vqNIdlKPRYRotF9c+mMpVSLUhegYDGp54iLidlq2nLJ5KA65kAim5vCMQSQzdWruWlk5WU8pbDUX6x5OXSMzTRLi6N0e5wziQ6Inm4vgtDHy5oTZpzmFgewovakVo5jOQPCHLX4liuJHI4yHZouzcjHmnKyraCUmOrgwEE6TJOWMQjFFWxwKgwHv/GHeuj0cvgO5D8Ho9eIzrohCxoF56kTrEyp5oqucgO5W1J2csIhtuYgYE9J5FUwdl82t+GBasH/rOThrKpEsR+K1jIgtLx+EYSH9whdgfK2xZklGp4npplUe+XxI3HQnNov1nagy5cyHi1+f4BzCFh+mdTMsvi2cngPE9eZGSXkyLOS6Ck5npyBU8YVxIwzjVpNHVNlcvIwqBpMwjgBxhaTg/tGdXNAIqWetPW4SRh4/YRlATqtKH42sy5dYoX7NM7dzfHGVuVHWwM0s/Ivj1tnOvXfKzXx+biQAXmZHAittJNBe+2BJ2KIWUCsVjUKiYOj149+h7d3VAM8OQkGg2iJdbRYoleu6xhreo6JzVjaVbOdl+iwWXMn7wBot2FsclEVHNjMqhbv2qiFfEpS2MDB8dHRG6pViWorWJQ4dfB8VHGL3dpxm4Qz6iUwgz2nghLUvMVG7twbWd2lEyWX5R/oU7ucgFKyUI23HbShcDm+AKSwGXMwlw0Bzb5NxxYY7X9Dhg7zAYj1UWck/lim48quJRFPl3rrGUlsZbOhhP79CkClLzyo9H5rxUl0NUm9ZRBNfGeHxYol764mWavmnevoHpuem3t2YyhLD9ZkdLK7n6hmhQamSqGqgEDCmAhKrKXy+x0oCKTmsZrZtagzbbbPmpVBq7f3TQqu+wGnEzoJQ9zk111P2pRfQrrEsU7euv0re8uQUBNNaDR3lYGya8xoMuiKMMC9QxYHi738+sDSjH80tvMGB0evSL75DvAM7kGV4yEiuwuTFDwQ6HbTrjaa/5Uzt188jZVW/5G4MEduV7zUtxkkF0iUGpXnAlZ3wG3by01Q1pRw0Ik6QhR5XahF+voc+4huq4/R2SuH4QJ5ygAyXT6ZNYiuzCnTr5l/JyMLEo+/jrc71mfZ8eresrj0BGRYRLRoSr8+6zEiw/+E2pXtG7a6guksL//2NB9gwYVOvETi0BILE9dMsUW3KAL9kizr1WuSFek/ScJVJU1R/beo/+nrBnb+o6YSmG5sueBajyiEsswVVSy/dtnb7AUb/iKkjM4RzYjB9ddPAXvHWDPqp2Gbc/33vAV/INJNnOpfN9bcDNP8NqqGd2+hKfGvFNv776/Z++x2nPWrWN3vr1kyaWI9u74qrPIO9orIZNOoQ92LpqIrZWN8UXipuphFVRcCh9FfJF02FJ0xUwxaboi8R79egeXKolSW76xoZunepgYNkPkuKG5tq/rhHwo1mBC5VQkQdlKFNuqfeB7iBzdImZG99RzVd1/ZiGt2pVXl2NyzqvpaGuqKpmqoNJPAHYYe8Tx1pUP4hZty14tjUBX0Blb32UUEzHxYMlCLJHi3Vm31u0puIbfr5JUITs6d3z1Y2BDPkJOk0xrmY3nuNItzxWP/a1gXj5/8UvxqMr18oLV2JI3ysJxdPMjpog43l6E/6MoVoKrVvYJUL6joj7avYf5MScNY61TyjC1LkhJxvaESHNDuqMsGyJXrMs2UmSSMIkpzSA0XQDGaRvQleiFxnM+tJv7ME/iyKINqjdcZTACwhJ5qablyW7864QuJWZgGuPWR0ublekhte8PhvBuCK2/v8fzJePR9c8wOev8/f01vBva0dB7zksmzpJwb3H2tjSmKyQl2BOLkEuLnzLJXbJwzqHf3V9bOoz6MnqNkHfPtdV7b8fDEZZGY5vHIiNVLCcyK4MtmUag2bDL3t/vH3YPulRgvky0WTBZoufthjOBdaUq7Svfrhb9drXot6tFv10t+n/jalGHJwz/ZPaWMfpPj87wfnZY7Tfvvm9v/5wK8mwreM3eTirJ5atituo9DDlq++B7GPbFfj9/vmWa36j48REff0y5IrTpe/dMCRvepMIgh28Q5t0hDPIwMLTEEUhSCA/VoPxjGXr+Mrp2Ob8qhLojCOX+KJU3MLkq9V1HU5YE/BdBX2OT73HPecNXP+af2zcbG+QIzn6Ny4Du3f8ATQpoCw==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List certificate presets</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/certificate-presets"}></MethodEndpoint>



Lists the certificate presets. A preset is a certificate profile of the ecosystem: the values that the profile fixes (key usage, extended key usage and their criticality, certificate policies, QC statements), the fields that a request must have, the longest validity, and the prefill from the data of the organisation. Give the `preset` in the generate CSR and the create test certificate operations.

The presets, in this order: `wrpac-legal`, `wrpac-natural`, `pid-provider`, `wallet-provider`, `wallet-status-list-signer`, `eaa-provider`, `qeaa-provider`, `pub-eaa-provider`, `mdoc-document-signer`, `mdoc-reader`, `mdoc-status-list-signer`, `status-list-signer`, `credential-issuer`, `request-signer-san-dns` and `custom` (no fixed values, always last). `sources` of each preset names the standards and the clauses of its fixed values, and `testCaDomain` names the test root that issues its test certificates.

`testCaEnabled` shows if the built-in test CA of the installation is on. When it is `false`, the create test certificate operation and the test CA operations answer `403`, so do not offer a test certificate. A sandbox organisation gets the presets of its main organisation.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the presets.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presets</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The presets, with `custom` last.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`wrpac-legal`, `wrpac-natural`, `pid-provider`, `wallet-provider`, `wallet-status-list-signer`, `eaa-provider`, `qeaa-provider`, `pub-eaa-provider`, `mdoc-document-signer`, `mdoc-reader`, `mdoc-status-list-signer`, `status-list-signer`, `credential-issuer`, `request-signer-san-dns`, `custom`]"} schema={{"type":"string","description":"The preset id, the value of `preset` in a CsrRequest.","enum":["wrpac-legal","wrpac-natural","pid-provider","wallet-provider","wallet-status-list-signer","eaa-provider","qeaa-provider","pub-eaa-provider","mdoc-document-signer","mdoc-reader","mdoc-status-list-signer","status-list-signer","credential-issuer","request-signer-san-dns","custom"],"example":"mdoc-document-signer"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the preset, for a person.","example":"mdoc Document Signer (ISO/IEC 18013-5)"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"What the certificate is and who issues it, for a person.","example":"Document signer certificate of ISO/IEC 18013-5 Table B.3, issued by an IACA. The C is the issuing_country of the mdoc and the C of the IACA; the ST, if the IACA has one, is the issuing_jurisdiction. ISO/IEC 23220-4 recommends the EKU 1.0.23220.4.1.2 in addition."}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"What a key with this certificate signs, for a person.","example":"Signs the mdoc MSO (issuerAuth)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>fixed</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The values that the profile fixes, in the form of a CsrRequest. A value of a request that is not the fixed value gives the warning `preset-override`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key usage extension. The keys are EC keys, so `keyEncipherment` and `dataEncipherment` are not allowed (RFC 5480 section 3). A leaf certificate has no CA key usage (`keyCertSign`, `cRLSign`).

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`digitalSignature`, `nonRepudiation`, `keyAgreement`], `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key usages, each one time.","example":["digitalSignature"],"items":{"type":"string","description":"One key usage by its X.509 name.","enum":["digitalSignature","nonRepudiation","keyAgreement"]}}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`true` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>extendedKeyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The extended key usage extension.

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key purposes as OIDs in dotted form, at most 20, each one time. For example `1.0.18013.5.1.2` (ISO/IEC 18013-5 mdoc Document Signer), `1.0.18013.5.1.6` (ISO/IEC 18013-5 reader authentication) or `1.3.6.1.5.5.7.3.45` (Token Status List signer).","example":["1.0.18013.5.1.2"],"items":{"type":"string","description":"One OID in dotted form."}}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`false` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"certificatePolicies"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The certificate policies. An empty list when the preset fixes none. The CA can add its own policy.","items":{"type":"string","description":"One OID in dotted form."},"example":[]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcStatements</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QC statements. `null` for a statement that the preset does not fix.

</div><SchemaItem collapsible={false} name={"qcType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The QcType, one OID in dotted form. `null` when the preset fixes none.","example":"0.4.0.1862.1.6.2"}}></SchemaItem><SchemaItem collapsible={false} name={"qcCompliance"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the profile needs the QcCompliance statement (`0.4.0.1862.1.1`). `null` when the preset does not fix it.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"qcSscd"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the profile needs the QcSSCD statement (`0.4.0.1862.1.4`). `null` when the preset does not fix it.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"qcPsb"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the profile needs the QcPSB statement (`0.4.0.194126.1.3`, ETSI TS 119 412-6 clause 8.3), and the request gives its values (`qcStatements.qcPsb` of the CsrRequest). `null` for the other presets.","example":null}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"required"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The fields that a request with this preset must have, as paths (for example `subject.commonName`). An entry with `|` needs at least one of its paths, for example `subjectAltName.uri|subjectAltName.email|subjectAltName.phone`.","items":{"type":"string","description":"One field path."},"example":["subject.country","subject.commonName"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>prefill</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The values of a certificate signing request (CSR). With a `preset`, a member that the request does not give takes the prefill and the fixed values of the preset (the list certificate presets operation). A value that is not the fixed value of the preset gives the warning `preset-override`, not an error, and the request value applies. Without a preset, the request is `custom`. The extensions of the CSR are a request: the Certificate Authority (CA) decides what goes into the certificate.

</div><SchemaItem collapsible={false} name={"preset"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`wrpac-legal`, `wrpac-natural`, `pid-provider`, `wallet-provider`, `wallet-status-list-signer`, `eaa-provider`, `qeaa-provider`, `pub-eaa-provider`, `mdoc-document-signer`, `mdoc-reader`, `mdoc-status-list-signer`, `status-list-signer`, `credential-issuer`, `request-signer-san-dns`, `custom`, `null`]"} schema={{"type":"string","nullable":true,"description":"The id of a preset of the list certificate presets operation. An unknown id gives `400` (`preset: unknown preset; use one of <the preset ids>`).","enum":["wrpac-legal","wrpac-natural","pid-provider","wallet-provider","wallet-status-list-signer","eaa-provider","qeaa-provider","pub-eaa-provider","mdoc-document-signer","mdoc-reader","mdoc-status-list-signer","status-list-signer","credential-issuer","request-signer-san-dns","custom",null],"example":"mdoc-document-signer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The subject of the certificate. Each attribute has one value. An attribute that the request does not give takes the prefill of the preset. `null` is no value. The wallet encodes the subject in X.500 order, from the country to the common name. The subject has no `emailAddress`: put the email address in `subjectAltName.email`.

</div><SchemaItem collapsible={false} name={"country"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Country (C), an ISO 3166-1 alpha-2 code in upper case. In an identifier, Greece is `EL`. For an mdoc Document Signer, the country of the issuing authority (the mdoc `issuing_country`) and the country of the IACA root.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"stateOrProvince"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"State or province (ST), at most 128 characters. For an mdoc Document Signer, the `issuing_jurisdiction` when the IACA root has one.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"locality"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Locality (L), at most 128 characters.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"organization"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisation (O), the registered name of the organisation, at most 256 characters.","example":"Example AB"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationalUnit"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisational unit (OU), at most 64 characters. Some Certificate Authorities put the identifier that they gave the organisation here.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"commonName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Common name (CN), at most 64 characters. Use the name of the organisation or of the service. Every preset requires it.","example":"Example AB Document Signer"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Organisation identifier, at most 128 characters. For a preset with `etsiSyntax` `true`, it has the syntax of ETSI EN 319 412-1 clause 5.1.4, for example `VATSE-556677889901` (the type `VAT`, `NTR`, `PSD`, `LEI`, `EOR` or `EXC`, the country code, `-` and the identifier).","example":"VATSE-556677889901"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Serial number of a natural person, at most 64 characters of an ASN.1 PrintableString. For a preset with `etsiSyntax` `true`, it has the syntax of ETSI EN 319 412-1 clause 5.1.3, for example `TINSE-1234567890` (the type `PAS`, `IDC`, `PNO`, `TIN` or `EID`, the country code, `-` and the identifier).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"givenName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Given name of a natural person, at most 128 characters.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"surname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Surname of a natural person, at most 128 characters.","example":null}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subjectAltName</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The subject alternative names of the certificate, at most 50 values of each type. A type that the request does not give takes the prefill of the preset. The wallet checks the format of each value and refuses a repeated value.

</div><SchemaItem collapsible={false} name={"dns"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"DNS names (dNSName). A host name, without an IP address. The first label can be `*`. Give an international name in the A-label form. The `x509_san_dns` client identifier prefix of OpenID4VP needs the host of the verifier here.","example":["wallet.example.com"],"items":{"type":"string","description":"One DNS name."}}}></SchemaItem><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"URIs (uniformResourceIdentifier). An absolute URI with a scheme, at most 2048 characters, for example the support website of a relying party access certificate.","example":[],"items":{"type":"string","description":"One URI."}}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Email addresses (rfc822Name), in the form `local-part@domain`.","example":[],"items":{"type":"string","description":"One email address."}}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Telephone numbers in the international form of ITU-T E.123, for example `+46 8 123 456 78`.","example":[],"items":{"type":"string","description":"One telephone number."}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key usage extension. `null` is no key usage extension.

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`digitalSignature`, `nonRepudiation`, `keyAgreement`], `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key usages, each one time.","example":["digitalSignature"],"items":{"type":"string","description":"One key usage by its X.509 name.","enum":["digitalSignature","nonRepudiation","keyAgreement"]}}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`true` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>extendedKeyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The extended key usage extension. `null` is no extended key usage extension.

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key purposes as OIDs in dotted form, at most 20, each one time. For example `1.0.18013.5.1.2` (ISO/IEC 18013-5 mdoc Document Signer), `1.0.18013.5.1.6` (ISO/IEC 18013-5 reader authentication) or `1.3.6.1.5.5.7.3.45` (Token Status List signer).","example":["1.0.18013.5.1.2"],"items":{"type":"string","description":"One OID in dotted form."}}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`false` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"certificatePolicies"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"The certificate policies as OIDs in dotted form, at most 20, each one time. For example `0.4.0.194118.1.2` (NCP-l-eudiwrp, ETSI TS 119 411-8).","example":[],"items":{"type":"string","description":"One OID in dotted form."}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcStatements</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QC statements of ETSI EN 319 412-5 and the QcPSB statement of ETSI TS 119 412-6. `null` is no QC statement.

</div><SchemaItem collapsible={false} name={"qcType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The QcType, one OID in dotted form (QcType has one value). For example `0.4.0.194126.1.1` (PID provider), `0.4.0.194126.1.2` (wallet provider) or `0.4.0.1862.1.6.2` (electronic seal).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"qcCompliance"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the QcCompliance statement (`0.4.0.1862.1.1`), an EU qualified certificate.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"qcSscd"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the QcSSCD statement (`0.4.0.1862.1.4`), the private key is in a qualified signature or seal creation device (QSCD).","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` is no QcPSB statement; with the preset `pub-eaa-provider`, `null` gives the warning `preset-override`.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"maxValidityDays"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","nullable":true,"description":"The longest validity of a certificate of the profile, in days. `null` when the profile sets no limit.","example":457}}></SchemaItem><SchemaItem collapsible={false} name={"testCertificateValidityDays"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The validity in days of a test certificate with this preset when the request has no `validityDays` (the create test certificate operation). It is the setting of the installation (default 365 days), at most `maxValidityDays`.","example":365}}></SchemaItem><SchemaItem collapsible={false} name={"testCaDomain"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`mdoc-iaca`, `provider`, `access`]"} schema={{"type":"string","description":"The trust domain of the test root that issues a test certificate with this preset (the create test certificate operation). `mdoc-iaca`, the IACA of `mdoc-document-signer`, `mdoc-reader` and `mdoc-status-list-signer`. `access`, in place of the Access CA, for `wrpac-legal`, `wrpac-natural` and `request-signer-san-dns`. `provider` for the other presets.","enum":["mdoc-iaca","provider","access"],"example":"mdoc-iaca"}}></SchemaItem><SchemaItem collapsible={false} name={"etsiSyntax"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the wallet checks `subject.serialNumber` and `subject.organizationIdentifier` of a request with this preset against the syntax of ETSI EN 319 412-1 (clauses 5.1.3 and 5.1.4).","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sources</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The documents and the clauses of the fixed values.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"document"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The standard or the specification.","example":"ISO/IEC 18013-5"}}></SchemaItem><SchemaItem collapsible={false} name={"clause"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The clause, and what it says.","example":"Table B.3 (keyUsage digitalSignature critical, EKU 1.0.18013.5.1.2 critical, at most 457 days, C and ST as the IACA, issuer = the IACA subject)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"testCaEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the built-in test CA of the installation is on. The installation can switch it off.","example":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presets\": [\n    {\n      \"id\": \"mdoc-document-signer\",\n      \"name\": \"mdoc Document Signer (ISO/IEC 18013-5)\",\n      \"description\": \"Document signer certificate of ISO/IEC 18013-5 Table B.3, issued by an IACA. The C is the issuing_country of the mdoc and the C of the IACA; the ST, if the IACA has one, is the issuing_jurisdiction. ISO/IEC 23220-4 recommends the EKU 1.0.23220.4.1.2 in addition.\",\n      \"purpose\": \"Signs the mdoc MSO (issuerAuth).\",\n      \"fixed\": {\n        \"keyUsage\": {\n          \"values\": [\n            \"digitalSignature\"\n          ],\n          \"critical\": true\n        },\n        \"extendedKeyUsage\": {\n          \"values\": [\n            \"1.0.18013.5.1.2\"\n          ],\n          \"critical\": true\n        },\n        \"certificatePolicies\": [],\n        \"qcStatements\": {\n          \"qcType\": \"0.4.0.1862.1.6.2\",\n          \"qcCompliance\": true,\n          \"qcSscd\": true,\n          \"qcPsb\": null\n        }\n      },\n      \"required\": [\n        \"subject.country\",\n        \"subject.commonName\"\n      ],\n      \"prefill\": {\n        \"preset\": \"mdoc-document-signer\",\n        \"subject\": {\n          \"country\": \"SE\",\n          \"organization\": \"Example AB\",\n          \"commonName\": \"Example AB Document Signer\"\n        },\n        \"subjectAltName\": {\n          \"dns\": [\n            \"wallet.example.com\"\n          ]\n        }\n      },\n      \"maxValidityDays\": 457,\n      \"testCertificateValidityDays\": 365,\n      \"testCaDomain\": \"mdoc-iaca\",\n      \"etsiSyntax\": false,\n      \"sources\": [\n        {\n          \"document\": \"ISO/IEC 18013-5\",\n          \"clause\": \"Table B.3 (keyUsage digitalSignature critical, EKU 1.0.18013.5.1.2 critical, at most 457 days, C and ST as the IACA, issuer = the IACA subject)\"\n        }\n      ]\n    }\n  ],\n  \"testCaEnabled\": true\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List credential categories
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-list-credential-categories

---
id: config-digital-wallet-open-id-list-credential-categories
title: "List credential categories"
description: "Lists the credential categories. A credential category is the eIDAS category of the credentials that a credential configuration issues: PID, EAA, QEAA or PuB-EAA. Each category has the rules for the certificate of the key that signs the configuration, the certificate preset to request, the entitlement of the provider (ETSI TS 119 475 Annex A.2) and the sources of the rules. `none` has no rule."
sidebar_label: "List credential categories"
hide_title: true
hide_table_of_contents: true
api: eJztW3tv20a2/yoH/EsCKFqSZSfRXSyuIqmFtmnjRE5ygdSIRuRImjVFMjNDu9rA331xzgzflOVms/eme4sitT3kvM7jd5784gRc+VIkWsSRM3ZeCaUV6B0HX/KAR1qwEHym+TaWgisPJi0PDiDMHL6YTZbFaLyprYRvMQ2sskYcbcQ2lQxPAEKplKsxXC1mLswnExfezCcTiCVcpS9788nEgznzd8UeO2a2lmnIFWxiabbkUouNwLeyU9zyg9ldiW1kr1je2m1MTCRXXIOOQfLPKVfavILn1iHf80hnaycyvhMBl9CZXy8XcL2EweAFjJ5dwCSK+G8w8YZdYFFAL6s4lT5X2Vw6uAerKI74iq4TxTTo/Rr9Gl3jmXLyuyAi0DuhIJYBl2M7y4VVIgL8wRnDH5/xJ224StJ1D//y4Edxx2nHlQhWuNCq4MKMb0QkkAzq441XjE8tmVclXiJpcOk0CfDXEiuDfBWIE27IqjzAOyh2x0HyTaq4Qv5XmH6/ixUnvohoS4wKYo500LARGoRWOb9duBd6B6tRv28vyKWM5fUh4StY2SU+3fLDJ1ziUxTrTxuhVx5MItjPXkEniH19SDisYrn1hIq9wfP+4Ny78AbefvZq1QUWqhgizgM8J56FNsS7L5avzxbzKdCM3gXMYj8lKViKbcQlSsFGhNyF+x3T/I7LysnHsNoH4ds05CvYijuuDCOJ00SiUCidKZJie07CjMscIJZbFglF1PJ+jRzXyem7CJyxY8g5E1uhWfiBhSHXrxMeLQJU52mdm4Irx3UkV0kcKa6c8Rdn2O/jjyoWEN+4vBM+sk6nMuLBI9DguHgOzSONS7EkCVGNRByd/V3hel8c5e/4nuFvyAJn7MTrv3NfO66TSLyQFuY0Dfmz43YWk5IdHLfltK0Hs0rDjc5kglyajCcXmu9V28lI152x06Bi8wSt0Dh+IjDGm0dg0c3B4ytgbl9DpcGwdwl+yEgVR7TyJYLc8+43wAjWjgdGwgOmduuYyYA2nVwtwA8Fj7SCVPFC7lERvIZQiKDEHqWliLaPsmcRtIqICJqkztjS0ZkatgpSAWrdY1w9zsIc4TtRXOEbcrRrERw6CZcKzSCtsbEKBAHTrGvhHReIep9TFoqN4AEwrbnS5lg59Hfan6MdzS0CdEqPjOENYI1gQ/LFIEnXofBBcV/HEtZxcOgiW3iU7p3xRwevg1wSSGjOmOM6n80Pu4Nz4zr8N7ZPiEM48OA6EdvzNkY2OYVv5pqSw789GpGJTpNvgH7CI7TBzSubnDrDB9Si8uYg1GP7TyLgIfe1jCPhl7cmwdBainWquXWBhDFv+VHNwnYxYLDn+zWXaicS8FFhaFct/Fuu0ZZVTQL4zDIQhAaGhqtKBy1TpTMs92ChMwNXObLiKLSFaHpIstLfb/nnVEhyfJ4GxyfBqmTyXYgjDpr/pg0l0MkzthHpuk/0wWgmPjSa1AbbR1j5OjKHoRvlHPvo3PLDO8W2HMglmLjwEgn9gwXM+S9wbgFzCJqtQw6DMVL2LU/SQFhkJvcgMKYXHQGmU8mJX+hI0NNbfphHvkh2XBqvUeLQZCs5EbOL9pzY+Q9r0o3yowNhLJdKjTm6eUBURK900YqGURqGeE5nrGXKWy3kY/6tFW40IcQgoVqxsbFEGRkR59IwXNUYlYFGIoJe5i0b2Cj/+bn2twWS0hCuXYeV4jFyt/DOv45Cj7n3IoKjDv6Ji18tZp+uipv9Ekef3nyaTyblwTe1v6/evay90rh+yzoPRNbcS/kqIiCWlu1a9dbD3sCgGBKHcEcCCwKFokSKWzKCxihW3X3jUFeky/gjMPKG3rA7JhouZ72/fbiG91ODHiETe1hlM1YGMPdB7Bt3jmmGWEZsK97KFAhtiUqYb/1+rpXw+oMXo2fD/sDrD/A/u+KH8yluiWC0jyWHOxamhFcrpOKqhcuZ7TbRCIZaJbanMhrjbmOO/xgb83Sc47Ljtj5P0nWT0/j3g+vY4PFJ8Ks0iwImCeeDjIjk9VVDz28EsNl2tBtFPma3Oug2ndH3A2/oDez7cAkdFL9M6RAd63B8jlNG3gBezX/sjbxzb9A7h84xNDeoRtYtxqjMRilPWHjoDXpD6LSDcz6/hAb2JggH59BpKmfXuXl4wNiLLGmA5CD3ibyiKlGPm96SDajiXVXxC2GhPW3w+ViM87N9pU2YMHhGeRk/lr0xsXnx+IdY7plewWqv4k+oq0ZLULmsCK5sPK5WecxdzgPksfeRWBuXqYfl12SpX3rn9UC8zeMnI23EvevBDygpJlGQ75y/W02ulD1pN4+8UpI/pFPdczXuAPN9nmgFmK+AqYu+WlMdrhaz3gilsNcfmEyIkeCrxQw6DG6j+D6CgN8ZDwQ2Mt5DU5BLqnHyZhbHMjeg7q3lM6zHsMrkb/Vf5mhRrHeoWLmXnsVzdkKDFlGABoMGCWAJklYb8RsPVs3QL5ORJ6Fe9nIZ5B5Bsio2tSaFyO36urgFN6/HDF8dh5BYNWOQ78FJ/4aueN2VdsGXQgufhRRtaR4FPPgpe3vg9UvMGkJnH4SzZbc06ZTPnFlqhKdeYGGmpwhmqhFs6xsPrkNi24arTWIXGJGZ5OxGpUcV2bEOzCaWe+NLTZV8a/T0lFa35YSrsGV1cI+OG86dLt8WPm+b5jZ1M+Pbo7kzJTOGnaAKUUPlCaNbflDAJIf5lH53AdG6Fk5Zzws9wNqw5BRkszCM73kAnbc/TOFi9LxPKQ2ETkTGCYScbSqCb5Pw00npZB3cdsqlRsFEevpvX9Gv3SZNDKS1aN9eRAujJoNH6aBco1ukbWL/e/WrOPX6QKbvf7yL/gsCprJvWtc09EMqwa3jOuU4lVSppLKN+fg817vipOs4DjmLTgYeKxxcjQu1UCYxleuyBx+E3sUpVpCIxrZmYx8LfahJLyWhuYKOWRrudzwqP0fNRVZHvFvJ5eDbdT/NMtXQoIpCJ2R/Xn+9Nexs4kChDN9UwpJUJjGVYRS8XswUQkwQa80DQhkXmIZ9rDQM+3UxJMDJklSrGvauoFN3xSg8q7lumKSszrxsmSk5w4CbpXqHPptfyl8OvHPv0ht4F96F98w790YXK+hcx7c8gqVmOlWAVQ8w+Nz9narzejGr0aNuqGq3/p6FfsNC9a2kvjZ+W8hyQxtu/h1x6rcLRutXyb3LfyUMMz5ALeQq79Ja0yqisgq0HquAfTRVkCzzblxSTAE1IeWXuOpt14oO/o77tx68U5QxJuePY+Hf5v4rhalUKxHYYkdeR1VahGGRRT5VGq1klR/xVz/elJ011JxaRs8OlfNbZigXuI83D66lU1LE1mNMwDWodHW02mIU0jzQB5NeIveLTB0LrfcNnXLaPss0EcUD60KvhdS7btb48DPl9QmouGuy+lhYATyFVrDmOxZuXNsGkbll83ezBZiybjl5TwFhnpt8MomdNz6FnyLoYeap99nXvUQE0Ol7I8S2F6PBEPF10DX2v5ZTcWF6KknedSpsbCR9ywytJ0YfZe3J3NFoXI2eW3JC2flNQ4Z5+4LebadLW5poCO+HCP+AAfbQwJa5Ou1o7Tehyoks0QV0ygTA/FAmvaaWZqX3VHGrUYv+zytGPSrT30klJ8uHEEbSNDrP9OkVnori1MohVcVpLSH8a+rzR0q9Hk37GU4dvWoZH8YldrlQ1VyYQqcpDFF46KK+mGxeFlh+VVKuAQxYVrGHnE8mvQushRgYQ4DBoctiiNoIMgtPxZGvzUdnePO5AjjUdnekjaCl86V48Smw48HrKDwAgyOoUGqoe3O9vOpWMMW1Pl3e+meaRviWhcA3G+5b1AnZ/SYNw0PW2pCwBCOK4kwVW1qcpIE8lIpIQqYpCWMKXWiVkdY5Cx4t9Jw0yNN4n4SCRT55rtqUsTKD/PxymJnjN/5yOZ0dfWdk3mmYMU53qr576Q3bDfz3BZxVQKwXiKuIWK+fVsDwZCnud+DkM+i8OQWUF+gjXJKPgDM7ZSZ3XVPpxFFkqPFFRkZLDf/+rdj7H42dyBkyIENv2OsPTQexRdNhrz+wA5f5ABGfxp4VY9TvUC6Dn4DXoRGJVmTN+qGKWMT0MkOn2mL17Ty6tuYtsB2fAnlteZfnV2xXsg08KDLJXEMLn7UIpeoh3vGd8ENsE90KpWWJjyYmwr9ZaB9zScj7vwTfpepVhSQlDKXWFnafpx/qVOl+vQlI0vVJ8L9avmxB9CwMO++WcvtxGumifzRk927rgfObhOyeLML/kX1BMaq8JwKmErXmjLXc8w9njZrtSfXYttHA8wSbRO0fv8caPR/D1fJl77l3jsCl4+KvC9Noa1qU0LJcLV8imaeLt9CZv+vCsD8cnQ1fPHthX1ossu8seiPvEpcYtcbFJUb+afu+I9tXMA8N2TmZv2zsIhsbFGOX+ZjJhtCwNYPnX2MGR9CpCz1awptK/0lRzz9acc9N5c/xGvs8AinusAgdCp8jinX2s1etNjLrNGnvOTN9LHb/0/0h7vGmFAsOjyQ6m0WNXNS6bqnfGtOnk+nkqQmOb14fr0Baa427VOIul3uzIlRbJbBcE6G6QnvVrFiiUVZprPBQAcXjatzJjm9LQGM4SrucCi6cpFz26qP6V+RRiqR4j8TR6FAEazTO5ss2ln/bxjKFpP4wvOmO6l9Y7MC/Rv0BVQWe+nlNufBA30dN44BKNfj7rKQyN+6JT3GK2UXZRUSab40xyyoWo37/oWX5tnaLvJ3iJQtAREmqIWGS7bnGbgpz+6pWv4vQv4ml+AfFaVXSXJgvl/6fkmYRaS7Rs8bECZdA29RohHrD/VQKfaAS0iQRP/EDFUrwjmxL+mQ/HrNlBujQ92Oz0fsp2Uzq8UWS7LnexQgUW04UYXrnjJ2zu+GZwdszq2K9e1rnLE54JIKzAlt7frn8ZY5tSlvVm834Pra3ojbZ0Bk7O60TNT47C/g+7rFEeGIrWaQ9ETsYa9VqOzIOUtPmcWSZUyssNdsi5h+Zrszj+kFuCnIvUeqMsGREL8qhZsB1BG5l+FUEiBMr8FkbRs3MXS3IEFWr4yZIyfuVqbuyss4KzDawx1TbmurBBOy2b9OcEegLI22qWVoyERINsHm66wL3tl5t2THYiX85xKlEcvRu+eGvKyy14vU2caagzCcF5XsmkJAqTZJY6v8uiJffX/xYDFWpXmZYjSz5pCwvY740RZ3SHAT+RLOQB814QSPm5M6951JsBJmRaan+ibJPgVPnNenDwjis7ROv0JJmW+Q6dNXFE+nYj0P6HFYo+viNRzhHQTnHTTU/8g1c2MVhYJKdd7jDITNflfJsqog9WQm951tHW8MmjO+VYa2ldLnBvfO3D9ddFxbz6x+KTnuz22L5uujgmMX+GTo6Je9oQ1299MEnuWOKEDCT3IT5Ow5Dr99g3f39vcfosRfL7Zmdq85eLabzX5bzHs55KDpnCnYisTKjnmkEwoZhO8Yw6Brj3CRWes+i0nleHf2cr65WJSPy52fwf34G/+dn8H+Az+CtMcWO5LMkZCJCECDU+WJ9k4/O3dB8mb4R1CpU8U/Ml/QR9Ym0+yg3rrOLlcaFvnxZM8XfyfDhAYc/p1weTMvKHZPCtHhh90lmzdGpuUWj70yo7R9RC60zWf+aj/pQ9q1+nF87roPWveow3JLDYH/B1bNH0aG0dt13MEfA/6OL0zrlL4iwP/HDX/PXzZOjE3J/xbyNdMfA5Z/Qgsv4
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List credential categories</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/credential-categories"}></MethodEndpoint>



Lists the credential categories. A credential category is the eIDAS category of the credentials that a credential configuration issues: PID, EAA, QEAA or PuB-EAA. Each category has the rules for the certificate of the key that signs the configuration, the certificate preset to request, the entitlement of the provider (ETSI TS 119 475 Annex A.2) and the sources of the rules. `none` has no rule.

The categories, in this order: `none`, `pid`, `eaa`, `qeaa` and `pub-eaa`. Give the `id` in `credentialDefinitions[].credentialCategory` of the create and update credential definition operations. The save refuses a configuration whose signing key does not fit its category, with `400` and `errorType` `signing_key_does_not_fit`. An mDL (doctype `org.iso.18013.5.1.mDL`) also needs a key with the ISO/IEC 18013-5 Document Signer profile, whatever its category: `mdlRule` gives this rule. The list is the same for every organisation.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the credential categories.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialCategories</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential categories, in the order of the description.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"CredentialCategoryId"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the category, for a person.","example":"EAA (non-qualified attestation)"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"What the category is, for a person.","example":"An electronic attestation of attributes that is not qualified, for example a membership card or a ticket. Any organisation can issue it as a non-qualified trust service. It needs an electronic seal certificate."}}></SchemaItem><SchemaItem collapsible={false} name={"certificateRequirements"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The rules for the certificate of the signing key, one text for each rule. An empty list for `none`.","items":{"type":"string","description":"One rule."},"example":["keyUsage type A, B or F (ETSI EN 319 412-2 table 1: nonRepudiation, with digitalSignature or also with keyEncipherment or keyAgreement)","organizationIdentifier in the subject"]}}></SchemaItem><SchemaItem collapsible={false} name={"presetId"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`pid-provider`, `eaa-provider`, `qeaa-provider`, `pub-eaa-provider`, `null`]"} schema={{"type":"string","nullable":true,"description":"The certificate preset to request for a key of this category (the list certificate presets operation). `null` for `none`.","enum":["pid-provider","eaa-provider","qeaa-provider","pub-eaa-provider",null],"example":"eaa-provider"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlement"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`PID_Provider`, `Non_Q_EAA_Provider`, `QEAA_Provider`, `PUB_EAA_Provider`, `null`]"} schema={{"type":"string","nullable":true,"description":"The entitlement of the provider in ETSI TS 119 475 Annex A.2. `null` for `none`.","enum":["PID_Provider","Non_Q_EAA_Provider","QEAA_Provider","PUB_EAA_Provider",null],"example":"Non_Q_EAA_Provider"}}></SchemaItem><SchemaItem collapsible={false} name={"eaaCategory"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`urn:etsi:esi:eaa:eu:qualified`, `urn:etsi:esi:eaa:eu:pub`, `null`]"} schema={{"type":"string","nullable":true,"description":"The EAA category of ETSI TS 119 472-1 that the issuer adds to each credential of a configuration with this category (clause 4.2.2): for SD-JWT VC the claim `category`, for mdoc the data element `category` in the namespace `org.etsi.01947201.010101`, for W3C VC one more value of `type`. `null` for `none`, `pid` and `eaa`.","enum":["urn:etsi:esi:eaa:eu:qualified","urn:etsi:esi:eaa:eu:pub",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"sources"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The standards and the clauses of the rules. An empty list for `none`.","items":{"type":"string","description":"One standard and its clauses."},"example":["ETSI TS 119 412-6 V1.2.1 clause 6 (EAA provider)","ETSI EN 319 412-3 V1.4.1 LEG-4.3.1-3 (keyUsage type A, B or F for a seal over content)","ETSI EN 319 412-3 V1.4.1 LEG-4.2.1-2 (organizationIdentifier)","ETSI TS 119 475 V1.2.1 A.2.3 (Non_Q_EAA_Provider)"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mdlRule</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The mDL rule: a credential configuration with `credentialFormat` `mso_mdoc` and one of the `doctypes` needs a signing key with the Document Signer profile of ISO/IEC 18013-5 Table B.3, whatever its credential category (also `none`). For an mDL with the category `eaa`, `qeaa` or `pub-eaa`, the key usage rule of the category also accepts Type C, as ETSI TS 119 412-6 PID-4.4.1-01 does for a PID (a known deviation from ETSI EN 319 412-3 LEG-4.3.1-3). For an mDL with the category `none`, request the certificate with the preset `presetId`; for another category, use the preset of the category and add the values of `fixed`.

</div><SchemaItem collapsible={false} name={"doctypes"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The doctypes of the rule.","items":{"type":"string"},"example":["org.iso.18013.5.1.mDL"]}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the rule, for a person."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"What the rule is, for a person."}}></SchemaItem><SchemaItem collapsible={false} name={"certificateRequirements"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The rules for the certificate of the signing key, one text for each rule.","items":{"type":"string","description":"One rule."},"example":["keyUsage digitalSignature, critical","extendedKeyUsage 1.0.18013.5.1.2 (mdlDS), critical"]}}></SchemaItem><SchemaItem collapsible={false} name={"presetId"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`mdoc-document-signer`]"} schema={{"type":"string","enum":["mdoc-document-signer"],"example":"mdoc-document-signer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>fixed</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key usage and the extended key usage of the rule, in the form of a CsrRequest. For an mDL with the category `pid`, `eaa`, `qeaa` or `pub-eaa`, add them to the CSR of the preset of the category.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key usage extension. The keys are EC keys, so `keyEncipherment` and `dataEncipherment` are not allowed (RFC 5480 section 3). A leaf certificate has no CA key usage (`keyCertSign`, `cRLSign`).

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`digitalSignature`, `nonRepudiation`, `keyAgreement`], `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key usages, each one time.","items":{"type":"string","description":"One key usage by its X.509 name.","enum":["digitalSignature","nonRepudiation","keyAgreement"]},"example":["digitalSignature"]}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`true` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>extendedKeyUsage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The extended key usage extension.

</div><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","minItems":1,"description":"The key purposes as OIDs in dotted form, at most 20, each one time. For example `1.0.18013.5.1.2` (ISO/IEC 18013-5 mdoc Document Signer), `1.0.18013.5.1.6` (ISO/IEC 18013-5 reader authentication) or `1.3.6.1.5.5.7.3.45` (Token Status List signer).","items":{"type":"string","description":"One OID in dotted form."},"example":["1.0.18013.5.1.2"]}}></SchemaItem><SchemaItem collapsible={false} name={"critical"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true`: the extension is critical. Without a value, the criticality of the preset applies (`false` when the preset fixes none).","example":true}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"sources"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The standards and the clauses of the rule.","items":{"type":"string","description":"One standard and its clauses."}}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialCategories\": [\n    {\n      \"id\": \"eaa\",\n      \"name\": \"EAA (non-qualified attestation)\",\n      \"description\": \"An electronic attestation of attributes that is not qualified, for example a membership card or a ticket. Any organisation can issue it as a non-qualified trust service. It needs an electronic seal certificate.\",\n      \"certificateRequirements\": [\n        \"keyUsage type A, B or F (ETSI EN 319 412-2 table 1: nonRepudiation, with digitalSignature or also with keyEncipherment or keyAgreement)\",\n        \"organizationIdentifier in the subject\"\n      ],\n      \"presetId\": \"eaa-provider\",\n      \"entitlement\": \"Non_Q_EAA_Provider\",\n      \"eaaCategory\": null,\n      \"sources\": [\n        \"ETSI TS 119 412-6 V1.2.1 clause 6 (EAA provider)\",\n        \"ETSI EN 319 412-3 V1.4.1 LEG-4.3.1-3 (keyUsage type A, B or F for a seal over content)\",\n        \"ETSI EN 319 412-3 V1.4.1 LEG-4.2.1-2 (organizationIdentifier)\",\n        \"ETSI TS 119 475 V1.2.1 A.2.3 (Non_Q_EAA_Provider)\"\n      ]\n    }\n  ],\n  \"mdlRule\": {\n    \"doctypes\": [\n      \"org.iso.18013.5.1.mDL\"\n    ],\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"certificateRequirements\": [\n      \"keyUsage digitalSignature, critical\",\n      \"extendedKeyUsage 1.0.18013.5.1.2 (mdlDS), critical\"\n    ],\n    \"presetId\": \"mdoc-document-signer\",\n    \"fixed\": {\n      \"keyUsage\": {\n        \"values\": [\n          \"digitalSignature\"\n        ],\n        \"critical\": true\n      },\n      \"extendedKeyUsage\": {\n        \"values\": [\n          \"1.0.18013.5.1.2\"\n        ],\n        \"critical\": true\n      }\n    },\n    \"sources\": [\n      \"string\"\n    ]\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"credentialCategories\": [\n    {\n      \"id\": \"none\",\n      \"name\": \"None\",\n      \"description\": \"No category and no certificate check. Use it for tests or for credentials outside eIDAS. An mDL still needs an ISO/IEC 18013-5 Document Signer certificate.\",\n      \"certificateRequirements\": [],\n      \"presetId\": null,\n      \"entitlement\": null,\n      \"eaaCategory\": null,\n      \"sources\": []\n    },\n    {\n      \"id\": \"pid\",\n      \"name\": \"PID\",\n      \"description\": \"Person identification data: the identity data of a natural person (for example the name and date of birth) that a Member State, or a body on its behalf, issues to the EUDI Wallet. It needs a PID provider certificate.\",\n      \"certificateRequirements\": [\n        \"QcType id-etsi-qct-pid (0.4.0.194126.1.1)\",\n        \"keyUsage type A, B, C or F (ETSI EN 319 412-2 table 1)\"\n      ],\n      \"presetId\": \"pid-provider\",\n      \"entitlement\": \"PID_Provider\",\n      \"eaaCategory\": null,\n      \"sources\": [\n        \"ETSI TS 119 412-6 V1.2.1 clause 4: PID-4.4.1-01 (keyUsage type A, B, C or F) and PID-4.5-01 (QcType id-etsi-qct-pid)\",\n        \"ETSI EN 319 412-2 V2.5.1 4.3.2 and table 1 (key usage types)\",\n        \"ETSI TS 119 475 V1.2.1 A.2.5 (PID_Provider)\"\n      ]\n    },\n    {\n      \"id\": \"eaa\",\n      \"name\": \"EAA (non-qualified attestation)\",\n      \"description\": \"An electronic attestation of attributes that is not qualified, for example a membership card or a ticket. Any organisation can issue it as a non-qualified trust service. It needs an electronic seal certificate.\",\n      \"certificateRequirements\": [\n        \"keyUsage type A, B or F (ETSI EN 319 412-2 table 1: nonRepudiation, with digitalSignature or also with keyEncipherment or keyAgreement); for an mDL also type C\",\n        \"organizationIdentifier in the subject\"\n      ],\n      \"presetId\": \"eaa-provider\",\n      \"entitlement\": \"Non_Q_EAA_Provider\",\n      \"eaaCategory\": null,\n      \"sources\": [\n        \"ETSI TS 119 412-6 V1.2.1 clause 6 (EAA provider)\",\n        \"ETSI EN 319 412-3 V1.4.1 LEG-4.3.1-3 (keyUsage type A, B or F for a seal over content)\",\n        \"ETSI EN 319 412-3 V1.4.1 LEG-4.2.1-2 (organizationIdentifier)\",\n        \"ISO/IEC 18013-5 Table B.3 with ETSI TS 119 412-6 V1.2.1 PID-4.4.1-01: for an mDL, key usage type C (digitalSignature only) is also allowed (a known deviation from ETSI EN 319 412-3 LEG-4.3.1-3)\",\n        \"ETSI TS 119 472-1 V1.2.1 EAA-5.2.2.1-01 and EAA-6.2.2.1-01 (no category claim)\",\n        \"ETSI TS 119 475 V1.2.1 A.2.3 (Non_Q_EAA_Provider)\"\n      ]\n    },\n    {\n      \"id\": \"qeaa\",\n      \"name\": \"QEAA (qualified attestation)\",\n      \"description\": \"A qualified electronic attestation of attributes. Only a qualified trust service provider (QTSP) can issue it, and it has the same legal effect as a lawfully issued paper attestation. It needs a qualified seal certificate. The platform adds the ETSI category urn:etsi:esi:eaa:eu:qualified.\",\n      \"certificateRequirements\": [\n        \"QcCompliance statement (0.4.0.1862.1.1)\",\n        \"QcSSCD statement (0.4.0.1862.1.4)\",\n        \"QcType id-etsi-qct-eseal (0.4.0.1862.1.6.2)\",\n        \"keyUsage type A, B or F (ETSI EN 319 412-2 table 1: nonRepudiation, with digitalSignature or also with keyEncipherment or keyAgreement); for an mDL also type C\"\n      ],\n      \"presetId\": \"qeaa-provider\",\n      \"entitlement\": \"QEAA_Provider\",\n      \"eaaCategory\": \"urn:etsi:esi:eaa:eu:qualified\",\n      \"sources\": [\n        \"ETSI TS 119 412-6 V1.2.1 clause 7 (QEAA provider)\",\n        \"ETSI EN 319 412-5 V2.6.1 4.2.1 (QcCompliance), 4.2.2 (QcSSCD) and 4.2.3 (QcType)\",\n        \"ETSI EN 319 412-3 V1.4.1 LEG-4.3.1-3 (keyUsage type A, B or F for a seal over content)\",\n        \"ISO/IEC 18013-5 Table B.3 with ETSI TS 119 412-6 V1.2.1 PID-4.4.1-01: for an mDL, key usage type C (digitalSignature only) is also allowed (a known deviation from ETSI EN 319 412-3 LEG-4.3.1-3)\",\n        \"ETSI TS 119 472-1 V1.2.1 QEAA-4.2.2.2-02, QEAA-5.2.2.2-01, QEAA-6.2.2.2-01 and QEAA-7.2.2.2-01 (the EAA category)\",\n        \"ETSI TS 119 475 V1.2.1 A.2.2 (QEAA_Provider)\"\n      ]\n    },\n    {\n      \"id\": \"pub-eaa\",\n      \"name\": \"PuB-EAA (public sector attestation)\",\n      \"description\": \"An electronic attestation of attributes that a public sector body responsible for an authentic source issues, or that is issued on its behalf, for example a vehicle registration from the national register. It has the same legal effect as a lawfully issued paper attestation. It needs a qualified seal certificate with the public sector statement (the law and the authentic source). The platform adds the ETSI category urn:etsi:esi:eaa:eu:pub.\",\n      \"certificateRequirements\": [\n        \"QcPSB statement (0.4.0.194126.1.3) with the country of the law, the authentic source and the law\",\n        \"QcCompliance statement (0.4.0.1862.1.1)\",\n        \"QcSSCD statement (0.4.0.1862.1.4)\",\n        \"QcType id-etsi-qct-eseal (0.4.0.1862.1.6.2) or id-etsi-qct-eidaspsbeaa (0.4.0.194126.1.3)\",\n        \"keyUsage type A, B or F (ETSI EN 319 412-2 table 1: nonRepudiation, with digitalSignature or also with keyEncipherment or keyAgreement); for an mDL also type C\"\n      ],\n      \"presetId\": \"pub-eaa-provider\",\n      \"entitlement\": \"PUB_EAA_Provider\",\n      \"eaaCategory\": \"urn:etsi:esi:eaa:eu:pub\",\n      \"sources\": [\n        \"ETSI TS 119 412-6 V1.2.1 clause 8: PSB-8.3-01 to PSB-8.3-05 and Annex A (QcPSB)\",\n        \"CIR (EU) 2024/2979 Annex II PuB-EAA-4.6.3-04 (QcType id-etsi-qct-eidaspsbeaa)\",\n        \"ETSI EN 319 412-5 V2.6.1 4.2.1 (QcCompliance), 4.2.2 (QcSSCD) and 4.2.3 (QcType)\",\n        \"ETSI EN 319 412-3 V1.4.1 LEG-4.3.1-3 (keyUsage type A, B or F for a seal over content)\",\n        \"ISO/IEC 18013-5 Table B.3 with ETSI TS 119 412-6 V1.2.1 PID-4.4.1-01: for an mDL, key usage type C (digitalSignature only) is also allowed (a known deviation from ETSI EN 319 412-3 LEG-4.3.1-3)\",\n        \"ETSI TS 119 472-1 V1.2.1 PuB-EAA-4.2.2.3-02, PuB-EAA-5.2.2.3-01, PuB-EAA-6.2.2.3-01 and PuB-EA-7.2.2.3-01 (the EAA category)\",\n        \"ETSI TS 119 475 V1.2.1 A.2.4 (PUB_EAA_Provider)\"\n      ]\n    }\n  ],\n  \"mdlRule\": {\n    \"doctypes\": [\n      \"org.iso.18013.5.1.mDL\"\n    ],\n    \"name\": \"Mobile driving licence (mDL)\",\n    \"description\": \"An mso_mdoc configuration with the mDL doctype, whatever its credential category, needs a signing key with an mDL Document Signer certificate (ISO/IEC 18013-5 Table B.3), issued by an IACA.\",\n    \"certificateRequirements\": [\n      \"keyUsage digitalSignature, critical\",\n      \"extendedKeyUsage 1.0.18013.5.1.2 (mdlDS), critical\"\n    ],\n    \"presetId\": \"mdoc-document-signer\",\n    \"fixed\": {\n      \"keyUsage\": {\n        \"values\": [\n          \"digitalSignature\"\n        ],\n        \"critical\": true\n      },\n      \"extendedKeyUsage\": {\n        \"values\": [\n          \"1.0.18013.5.1.2\"\n        ],\n        \"critical\": true\n      }\n    },\n    \"sources\": [\n      \"ISO/IEC 18013-5 Table B.3 (document signer: keyUsage digitalSignature critical, extendedKeyUsage 1.0.18013.5.1.2 critical)\",\n      \"ETSI TS 119 472-1 V1.2.1 clause 6 (an ISO/IEC-mdoc EAA can be an EAA, a QEAA or a PuB-EAA)\"\n    ]\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List key store types
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-list-key-store-types

---
id: config-digital-wallet-open-id-list-key-store-types
title: "List key store types"
description: "Lists the key store types and the key store providers. A key store holds signing keys of the organisation. Its type tells what it can do, and its provider is the product or the partner. The first type is `local`, the key store of the installation, with `canAdd` `false` (its `protection` is `hsm` when the installation keeps the new keys in its hardware security module). Then come the types that the installation lets an organisation add (from `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod` and `csc`)."
sidebar_label: "List key store types"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/iuEPtmArLxsb3HwLRaXdbrdbNtrtk6bD90AYqSxxYtEqiQV11f4vx9mSL1aTpP2cF+2X1pHoobDmeHMMw/5OUjBJFqUVigZzINXwljDbAbsDrbMWKWB2W0JhnGZDp6XWt2LFLSJ2Fnncaby1DAj1lLINT43TK3oU6XXXArDca6IXeBE2xKYhTw3bJNxy4RlCZcsVSHNJ6xpZmHC6VVqlVaJZUq7P7m2EnTErjJgK6GNdUKFYXGuEp7H4UBtr4yQxvI8J2VCthE2Y3HC5Vmaxixe8dxAzCaoQFxqZSHBcTGJzUwRs00Gck8OuwMonZoSNm7tQtIyMq7TDdfADCSVFnbLCpVWOUxJc8kSVQB96Kxt0Rp74nOw6IieIRlPUzZZaVWw+J5XuY1DFq+TcnZXGPzJN6b5+Z9Kw+wOtrNmYFqqNCZbx4lJ4mn0p/xTxo1n49rqCbc8V+tq1Hy4xlSYMudbpnQKes7elCB/4Spkv3GTiYXSJXuPc4bshVLrHNgiV1XKXr5ehuzseok/SIszVJG9hK0bziYJt7BWesti+GRBS5575achu8p4Doa9qiT38n5bvmaT80t1Pu1+iQ6bhuxCWjCCvdCqKruvP1pTxlOanrPFcjFLVFFyK27zNsa74zUUysLMRzhKLvOqCU5nuAMO5GlKu6Ub1MLFUS6MZUrm2wOhddD3ot5HuIBUgWFSWZaJFHoqRexs8HHGDeOWFYomHmwR4EnWfDtnvFVZrdgmE0m2t6WdwI4YYRjPN3zbW+OhvUYxKJU9u+ci57c5vAVucMvFV8N5eK6Bp9u9+Sg0RZsyopiyAhnHR7pw1vH6pLCiKHO2X6F5+2nBJSHGc6OYBEidlzHK0PvOGGTknNuV0sWcFqcqzGRhz/wsthStM6cHqr6fbuKrjAKi43YcKFV3ypXSDEOcUp/AQSaKpxhVLpuOBl4TFzzP1aZjhvgOtku03hXmnTj6UwZhoErQ9N1FGsyDRMmVWJ+LtbA8v+Z5Dha390WKxeJl9/MgDDSYUkkDJph/Dk6Pj/G/folBlxjQ9yIBpsFWWsKwslAOjIIQp7YgLQrhZZmLhLQ6+rdBSZ8Dk2RQcPyFXwTzQN3+GxIbhEGpcQ1WOD16a+wM51rzbRCOKDjQJayLiSsxqJqwUJixqa2wOT7oWmZvjrPBDH5XUBHcC2kfwq4yUkxuMrAZ6P0tiGMwKSgJ0Z4ZnKaNxsZqIdePWD5KAlkVwfxDQGYIwoCScBAGvtIEYeALDf7q1xmcoVQputMkwU0YwCdelGQj934XBpIXj1Dt3BcZHN01TUibwotl8SvUkTU17rkvHO4Jm/jahAhiUJ2mOHxYoPCZL1H0s1+h8NFDdSjGaeK3VDIaUFSH/2SxXLCzy4tpTCZuzPIEjdF4Lo90zHerVA5c7tlvmamNYbHVFXQQzGgADYKwn/8py1JMTgwA6+AFzEMu5ddJDT3jN0/EfsU/KAOGbeLH5Dpe8/aSX89MuIwdxbiHZ2MBJKucqokbPjTIdQYa6uRj3ELHNx/XuEdrLelRColIwTBhoxZrxkatLAI9t3Ic3PEeFR1u+S03wG55cgcyDT2ixOH8IE6sR0et/VJIMSFCOqPvJ9yptcmU6SIRFMbz/KBk41IPIoDWlNOIxWi6dhXKJRzMhv/oowNyE6IQtZE9tNzNG7VZgjDITEGR2dG+lxVw3l0YfDRJul89XAiLEUfVIdli8Bp/c/ax4rlYCUgpjrjFLZxo8LUR3Gb8Y7k4x3W7uAxp49Zr9HGMGJnCwEfNH1fLyzoOerFJMmhrlvxW5KKfgg8UnuvR7F+vy6X/iC1xx3XlxnWgNh+O1Se/I3YdJT8EZAP0iShKpS3V7xVokAk+RFtR1tb4L9aRFblskXGBLxA2XXoDvYQtpn4LBqVAKijtQw4WgptdiCX4jRZrIb9sht+Ub52oJxLSqoNGiVjslpDGbEJ9Cv1FoxsQMw1Z7NbXDHN/DoY5CNoY4CGRHsOW7eLfwgqTX5sHGr1Iamd+wvjta5KE8/gN7tuVqO3mcPPaTAOu9nGNnZuzzhN9TTrri+qA7j08HDvtbvYim8Chn60Q8vhemD08nFc2A2k9xHsNNlPpWKw8nNARvNzzvAJK5nFfaFSQ1LiG/wasFXJtuom+sTuLKwO65MZZuCy1yoHMCZqqvlV3INGGtSNYzJMEjHkJW3o8dEqc5AKkXUKigSS4vxftxoofyrqPckytM6Iwp7Lfurg3UWF8UWuJrzoqNX92NBp68svyyZeleA/aYGvyVR70sIjdeyG9Skwx+82Guj9BEHvaXx9Vnh2G5sdKaEhxoHXwnQBqA7V6qMOXqkGy76W8Q+HdN9XNzsEZV7if2Kc034V7dIzPY57AoL5UsphexdMn9TJ1tn+wn+kjxS9wR55aqCk9XhN6OLZPSrjdeUbMWmcQlww+CYMbuWH+8MMCv2mnBmlx6XV7zlmScbluVDq7vPgWgmS/1xLpl9uZd1J8rICJFANjJTp0QkMPyb4FI/ZC3ANSEkJ2wQkB062q6mLF+1ig7SwEcWCuaXDh8LiGcE2k2UA9x3Dcqk/1i5Sb7FZxjSh1QNcdpgQbZjmh1gkVL7jkayhA2rpV6hBqPRfpCrODZhqkNWxykFwMh8wiFlgstPMHcPEIbc0mo81eSIwMyiQycc7uJILhFnZaXZlmMV3mfMgmzhmXW5/N6uENRHDzLRsIu1DSKG1FVVArOcUw/gdGh4R70CzJuShMH/5abivTBeZ9PzXwHNdBRbqrXb95pyG78KtphWE4+eCmyowNPtVxCnQc/eUgrzP7/4SZwAffxEt0U0MrtstBo3xKwp0JcH+uR/IrWq9Uhui+sSyB7Ve9o91ZCHGajl5+WjFolD053oVBrtbq6X117WxqqFFEu32bHEHpdRKrEuQtV4iHMkwMidJlez7h8hVy7JAb8EXfLbDtcOM1bfsZJZBHw+MBH3tfSw+bhNSqaqjr5ExCZTXPmUiUPJRYcbnvdP50o51JlllbGvbu7avax2S7Pv9y8GQB0oGVrptih2LCp67J9+EP8yuH+JRSi3vfNhEFEXWYkXkDwP2TbgO7n/sfDhKfyGfUPqVONve1BE+VyFz7nMAXs76T0J7/PDXIUK8+Q+NVO8jwNHz+eOHpBSxKb8r/nPmIaLXlPWpi2j+hRSaBAp5LV2h6R5w247J/8kqJF580DZOT26ddh7W3d/TbTsByuIecxcs3v15dn719/gBL5H26Rxa1ILmfs5unyB7VJe+ptKij4R5Xv/dOEekAbxqxN9jj9ygZsoSpkqy7lddgR6ozm8TNoyU92Wd4QlLX2O6b6Rg7qmH9VcwoZthEVYia9+rN5GL5hv1w8uOPsxPG8zLjs9NBgu7XvCt0iD9rG20zBu6oo8wqthJ5jtvGecUfqvfp2RY+XGWwJboTz7YM9bQR+6USOcLlkDVZxOX/YSJha0QfsdVcGmFf49rpKH247Wlc71rAK4zomMW/LV+Plhv/wR1srwjIxM8XMz/W17d6SGKSdzr3Cratoa9JMe3WGfa/9QedMdS/QNdhvQJBxD5S7W6ZyFO5/T5pSKUpUZ4uYvB5nd0osHiaUnLi+eXIodIYvfg5cMsJ5gHVtfnRUY3mI+QJnxVCplGiil4bjKdCJ8HuG1mEXz0t0DIGrvzBJ57Yg/zChg43n8otHDh0JPj6OFzskC4RVq0/hyxVNMZe9A7TTgh+8FsYBR/7044ao793T6Lj6Fl0HAxZEbe4erY+SdQs3anpFWpFhZ0Bp50Bp9FpdIwDbv4/Z1r95FEfR/WvYDz+3kG3LVZ6WK6/8mxr/z7E15xxbUdNQrcBHrZK+G2XLzCbfPWNhnoTkiuaqxKidvU+Uh1EqHCMnCc5wgGP5/ou3960mH3I6zUgoimknULWz1AdbnDEaze7oX53g4sTLe/nxmbAPQuIfz07PqGE+tj7EN2ZQGulFyrFddPv80583IRfSGPt12NdauOCZ8fYLe6JH2Ngm+TyC0+ZkGVl0fG8AIvQbUerHxJlSJ8qLf5Druib5m/ukslf1DRIKNBVASytoBlNM7DRLgzqXoPS81kpkP2ff7jZ4Rr52qAt/AUf5m74uEsHF+fP3i+mQYgEMHvddGZoGneWEsyDNZ0clNxmwTw4uj89cveFjlInb+aK6hGCL5EeISxqWzz6k/LHzPp94NZhSNEBywKF8ssMwqDqAYsUCjXjpYjEWnNpI6GozvQFXDqeGZPQATFfkrC0fF1f4Bj53LjXQ0VuWvsvMQxd9NReaJGNexAGAqdyDqwz1jw48zuA2zoN9biDywvKxYMDL9ZDF5ja456cmLlpWIHtzS1mfliJT5D6A06nI4vZROL9FUJUmoucbFDyBBD3R+toIHbO/Ic/bVWl0RwIh3+OI8IRQq5UvWN5QjsWCi7QkKYq8Xzwn63xmvWLF+2jvtW7DhuYpfmoLktYs/B6J55L4ylwTmHIu123i3sqSu9Bi5XANM4WGoim57lhF8ZUXCIx8YY2yIU7Oh7/8FKDaaZoNtXllFpilajcoJeEIQwGEr8xvuI6Y1IfJIypIKS71a4XuMcZtsxvMqREG/UqQ+6xXKZcp4aus+aCS8tWOWIlcq23NGl7/cOCvV+wye/XV3hN9vnVr2x5Pvv9+oq9X7jZsOE7+fvxyQ+zv7HiXCVHxfmrzpwopeCWIGouEpCGUmIduSVPMmCn0fGe6zabTcTpdaT0+sh/a45eXSye/2v5fHZKeLE5hmrdicZKVVI13kM83DQQp8enz6IfIsLDpTK24LKjD15bHF7wG26oTj35fif++53473fiv9+J/34n/i99J96DNAuf7FGZ4wW4na9mnz34/eDoDAd/saD0ALC7Vi+pLe2DYP+gC4NvwiBTxqLMz5/xsug7ne92+PhjBZqgO17B1sK1/R9umoaRcPMd4srgLEmgtHRX27Ete33RrovjXzy/8vdU+pj0jjCp/4HS61dy25E9hKdOBfwXUfToJz9hEX8J25+b4e7NwQ8aSOxGowuwV/4vmdNASg==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List key store types</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/key-store-types"}></MethodEndpoint>



Lists the key store types and the key store providers. A key store holds signing keys of the organisation. Its type tells what it can do, and its provider is the product or the partner. The first type is `local`, the key store of the installation, with `canAdd` `false` (its `protection` is `hsm` when the installation keeps the new keys in its hardware security module). Then come the types that the installation lets an organisation add (from `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod` and `csc`).

`providers` is the catalogue of the installation in display order: OpenBao, HashiCorp Vault, Google Cloud KMS, AWS KMS and Azure Key Vault (category `external-vault`), Thales Luna Cloud HSM (DPoD) (category `hsm`), Intesi Group (category `qtsp`) and a CSC-compatible provider (category `remote-signing`), plus the providers that the installation adds. A provider is in the list only when the installation lets an organisation add its type and does not hide the provider. An organisation has at most one key store of each provider: a provider of which the organisation has a key store is always in the list, with `canAdd` `false` and `notAvailableReason` `The organisation already has a key store of this provider.` The type `dpod` is not in the default list of an installation, and it also needs the HSM signer of the platform: without it, the provider `thales-dpod` has `canAdd` `false` (`This installation has no HSM signer for DPoD partitions.`). A type that the installation does not allow is not in `keyStoreTypes`.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the key store types.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyStoreTypes</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key store types, `local` first.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"The key store type.","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"vault"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the type, for example `Local vault`, `External vault (OpenBao or HashiCorp Vault)`, `Google Cloud KMS`, `AWS KMS`, `Azure Key Vault`, `Thales Luna Cloud HSM (DPoD)` or `Remote signing service (CSC API)`.","example":"External vault (OpenBao or HashiCorp Vault)"}}></SchemaItem><SchemaItem collapsible={false} name={"canAdd"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the organisation can add a key store of a provider of this type (see `providers`). Always `false` for `local`. For `dpod`, `false` also when the installation has no HSM signer.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`, `dedicated-hsm`]"} schema={{"type":"string","nullable":true,"description":"Where the keys of a key store of the type are, when the type decides it. `local`, `software` for the OpenBao or the database backend, `hsm` for a hardware security module backend. `dpod`, `dedicated-hsm` (a type whose providers are all hardware security modules with one protection). `null` for the other types; each provider has its own `protection`.","enum":["software","hsm","dedicated-hsm"],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if a key store of this type keeps the keys in a qualified signature creation device (QSCD). `false`, or `provider` for `csc`, where the QTSP decides.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"capabilities"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"What a key store of this type can do. See `capabilities` of the key store.","items":{"type":"string"},"example":["create","import","reference","sign","csr","certificateChain","listProviderKeys","test","edit","delete"]}}></SchemaItem><SchemaItem collapsible={false} name={"keyOrigins"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`created`, `imported`, `referenced`]"} schema={{"type":"array","description":"How keys come into a key store of this type. `created` (the create key operation), `imported` (the import key operation) and `referenced` (the create key operation with `providerKeyRef`). `local`, `created` and `imported` (only `created` with the backend `hsm`). `vault`, all three. `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`, `created` and `referenced`. `csc`, `referenced`.","items":{"type":"string","enum":["created","imported","referenced"]},"example":["created","imported","referenced"]}}></SchemaItem><SchemaItem collapsible={false} name={"authenticationMethods"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`userpass`, `approle`, `cert`, `token`, `accessKey`, `clientSecret`, `clientCertificate`]"} schema={{"type":"array","nullable":true,"description":"The values of `authentication.method` in the settings of the type. `vault` `userpass`, `approle`, `cert`, `token`. `aws-kms` `accessKey`. `azure-key-vault` `clientSecret`, `clientCertificate`. `null` for the other types.","items":{"type":"string","enum":["userpass","approle","cert","token","accessKey","clientSecret","clientCertificate"]},"example":["userpass","approle","cert","token"]}}></SchemaItem><SchemaItem collapsible={false} name={"apiVersions"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"array","nullable":true,"description":"The CSC API versions of the type `csc`. `null` for the other types.","items":{"type":"string","enum":["v1","v2"]},"example":null}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>providers</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key store providers, in display order (the category, then `order`).

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the provider in the catalogue. Give it in `provider` when you create a key store.","example":"intesi"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`external-vault`, `hsm`, `qtsp`, `remote-signing`]"} schema={{"type":"string","description":"The group of the provider, the box of the dashboard. `external-vault`: OpenBao, HashiCorp Vault and the cloud key management services that the organisation runs or rents (Google Cloud KMS, AWS KMS, Azure Key Vault). `hsm`: hardware security modules of the organisation (Thales Luna Cloud HSM, DPoD). `qtsp`: known qualified trust service providers. `remote-signing`: any other service with the Cloud Signature Consortium (CSC) API; it never claims a qualified status.","enum":["external-vault","hsm","qtsp","remote-signing"],"example":"qtsp"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"The key store type of the provider. Give the same value in `type` when you create a key store.","enum":["vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"csc"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the provider.","example":"Intesi Group"}}></SchemaItem><SchemaItem collapsible={false} name={"order"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The position of the provider in its category. The list is in display order (the category, then `order`).","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The key of a logo that the dashboard has (`openbao`, `hashicorp-vault`, `intesi`), else `null`. The providers `google-cloud-kms`, `aws-kms`, `azure-key-vault` and `thales-dpod` have `null`, and the dashboard shows a neutral icon.","example":"intesi"}}></SchemaItem><SchemaItem collapsible={false} name={"logoUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"An https URL of the logo of a provider that the installation added, else `null`. Without a logo, the dashboard shows a neutral icon.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm-backed`, `dedicated-hsm`, `provider`]"} schema={{"type":"string","description":"Where the private keys are. `software`: in the software of the key management service (`openbao`, `hashicorp-vault`). `hsm-backed`: in a cloud KMS that keeps the keys in hardware security modules of the cloud provider (`google-cloud-kms`, `aws-kms`, `azure-key-vault`). `dedicated-hsm`: in a hardware security module partition of the organisation (`thales-dpod`). `provider`: at the provider (a QTSP decides). A key store can have another `protection` than its provider when its settings decide, for example Google Cloud KMS keys of the protection level `SOFTWARE`.","enum":["software","hsm-backed","dedicated-hsm","provider"],"example":"provider"}}></SchemaItem><SchemaItem collapsible={false} name={"qualified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` for a known qualified trust service provider (category `qtsp` only). Only the key stores of such a provider get a qualified status (`qualifiedStatus` of the key store, `trust` of the key).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"region"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The country of the provider (ISO 3166-1 alpha-2), else `null`.","example":"IT"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>defaults</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Settings to fill in for a new key store of the provider. They are not secret. Built in, `openbao` and `hashicorp-vault` give `transitMount`, `google-cloud-kms` gives `protectionLevel` `HSM`, `azure-key-vault` gives `keyType` `EC-HSM`, `intesi` gives `cscUrl` and `apiVersion`, and `other-csc` gives `apiVersion`. An entry of the installation can also give `location` (`gcp-kms`) or `region` (`aws-kms`).

</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>apiVersions</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For the type `csc`, the exact CSC API versions of the wallet. `null` for the other types.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"The value of `apiVersion` in the settings.","enum":["v1","v2"],"example":"v1"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The exact CSC API version.","example":"1.0.4.0"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"canAdd"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the organisation can add a key store of the provider. `false` only when the organisation already has a key store of the provider, or (`thales-dpod`) the installation has no HSM signer.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"notAvailableReason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Why the organisation cannot add a key store of the provider, `The organisation already has a key store of this provider.` or `This installation has no HSM signer for DPoD partitions.` `null` when `canAdd` is `true`.","example":null}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keyStoreTypes\": [\n    {\n      \"type\": \"vault\",\n      \"name\": \"External vault (OpenBao or HashiCorp Vault)\",\n      \"canAdd\": true,\n      \"protection\": null,\n      \"qscd\": false,\n      \"capabilities\": [\n        \"create\",\n        \"import\",\n        \"reference\",\n        \"sign\",\n        \"csr\",\n        \"certificateChain\",\n        \"listProviderKeys\",\n        \"test\",\n        \"edit\",\n        \"delete\"\n      ],\n      \"keyOrigins\": [\n        \"created\",\n        \"imported\",\n        \"referenced\"\n      ],\n      \"authenticationMethods\": [\n        \"userpass\",\n        \"approle\",\n        \"cert\",\n        \"token\"\n      ],\n      \"apiVersions\": null\n    }\n  ],\n  \"providers\": [\n    {\n      \"id\": \"intesi\",\n      \"category\": \"qtsp\",\n      \"type\": \"csc\",\n      \"name\": \"Intesi Group\",\n      \"order\": 10,\n      \"logo\": \"intesi\",\n      \"logoUrl\": null,\n      \"protection\": \"provider\",\n      \"qualified\": true,\n      \"region\": \"IT\",\n      \"defaults\": {\n        \"cscUrl\": \"https://services.test4mind.com\",\n        \"apiVersion\": \"v1\"\n      },\n      \"apiVersions\": [\n        {\n          \"value\": \"v1\",\n          \"label\": \"1.0.4.0\"\n        },\n        {\n          \"value\": \"v2\",\n          \"label\": \"2.2.0.0\"\n        }\n      ],\n      \"canAdd\": true,\n      \"notAvailableReason\": null\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List key stores
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-list-key-stores

---
id: config-digital-wallet-open-id-list-key-stores
title: "List key stores"
description: "Lists the key stores of the organisation. The first key store is the local key store that takes new keys. The other key store of the installation comes next, but only when the organisation has keys in it. Then come the key stores that the organisation added, oldest first."
sidebar_label: "List key stores"
hide_title: true
hide_table_of_contents: true
api: eJztGttu2zj2Vwg9JYDsuGlnsfAOBptxMjOepG2mThpgOwHESMcWJxKpklQcT+F/X5xD6mo5Sbu7L7v70rgUee538kuQgIm1KKxQMpgGF8JYw2wK7B42zFilwTC1pBWlV1wKw3HrmF2lwJZCG9vsZMIdzVTMs9ayTblllt+DYRLW+MG488qmoFsbPSIhjeVZRohYrHI692hDdldapmS2YesU5A5NLOWGgDMhmbCEwp3vM+QI6h/nSQJJyFSWgLGOt/Hv8nd5wgyXyZ167G5fwaCkhDUs50IOiItLswbNJDyAJmI5izUkIK3gGZ7lDawpi5pvZqbkUqxKDUnETKrWhq1TEaet446UNc8ysAh7/LsMwkAVoImAeRJMg5ignIqVsDy7oa3vC5DzBLV+DpsFMRGEgQZTKGnABNMvwfFkgn+6doLsGNAPIgamwZZaQtITxjgIEaMFafE8L4pMxETM0R8GgXwJTJxCzvGX3RQQTAN19wfENgiDQiPpVjgS7mvamq1ca74JwgG6nrHcIAyEhdwMobXCZrhQCWMH/knfrFOVJYYZsZJCrpz17XWXZ/XfEeB4RwwiadFsrBZytUPgtRSfS2CCoC4F6F24LCIHHakC5B1XUVgtJNzyO24gYkpXa6nJI7ZUum2bQ34aMsgMMM6ur+enSDo88rwgYXawBdvQc/AcJ1ebAvYSH2GseYYkdoDW/SNX7EpzaYQN2z5SMRsis7iecp2suUa7jkst7IblKimzQdCHY3bG47QbEGIuWWmAISIunTucXM5xXSqL4SVkccrlCm2DJZCBBYpT0QMvM+tYkgweLWjJM1ZRrzT7hZtUzJQu2EfcOmxi0SouRve5ackGBYvR8GelVhmwWabKhJ2/XYxZxNem3qwkevEKmcAoJNnJzYLxOFaltOwA/3P+dnGIh/4sNYzuYTPqkHyCy4TwwZGnWc4lX0HCflm8HbMoKVTiySq4tsJWqNhVyjMw7KKU3JP3y+JtHVoOTi/VKSKOTezPa8iVhdrjqp1rYVOSiQOyECvJLVI1U9IobUWZs4PZYnaIKgnJor2FMs4+lzxDZ0mY1aWxNdBCqweRgGYHv10tLg/JrGWZB9NPzqiDMCCGgzDwsg/CwAsWf3WlhRZeqATDoomD2x0XQdeoMA65hyyzjN/hfqtLGIp8Nb19t0GDZJFIoupLtbOOVpnoZHLEbVidPthBW2BRK3KkaJmx0oW3iJBFKzK2UYyKcCaG4URIC0ZEqExkpAoqlTu3PHxuK5dx3jJmJ3I30XPLcmUs2W4nDAA6ZsVfJxIh3m0YSJ4Php+cP16AXNk0mL6aTPryfcfzoXA0t2iWpY+6u0VJNxReUGXkrGEberU3pNwplQGXO6FwQSk/QrW/KBizAwRYyfawQwMC2YaBsdyW5vkovKB9Q3GYx1Y8QNTUYg1Ja6XvzZhFoLXSEeNLC0hzrKSEmAi0WGJRAl1ykUGCMUIYtG4XJzSgD0LSdjmHECn0O/EbYuj6kt/mnMk6fF/vTjcpaPCuIh64hVZuF6bFKydhGLW0mDyiaWUE1UpT17mQmINsAsxBZf51+Lrj8T3IpPExcp46M4dVsghb4b4+3DDMMniAjEWL9z9d3Zx8OMP9O8G7PofUOYs5m5GHYtavOfmaxPgURwjUAx/RYuJwcBZXecmZxD1AUZfWVM3vI6E2TAehidc94US/LN6SCHzS2yuN6Gw2wr1IZwIJFqyQjGpx8P3C6OS1nd7iwKVABFsRGU2Z70KqldBX9QnEIgHDUrVmwlZabUnkgPLh4W5gbMwSQyTujxqbiKr2pMFXygyMoUUD1gq5Mh572/EqUw7CIDW5+9drkOJFS0xBK4V1vLKGgbHHo9ptKxYVEf14Q+Y5Zu+odOYofA0WaVQS3i+D6af9tXyVqfdj+spoSrV8Z4PxrWA+WPj5mg+/j9nJbsYjXUnVbubGwTbcz1FdTezn6JvLyIpZ5xSeWV8yY81lGsf2VbVXhmEgV0LWEiQAY2omP5dCQ0IhPEk0GKqNSpsis64jDG6f4reprZ7T4b569ylOq0jhea3B5FgJwqMwtiOEmGeZcVMIgrhcihjbN5BJoYS0LKJYdJ+bsSuEeCHMOFZ51BdGoZVnFC2CeAqx1f2A+elJgTQl5n6BPFnTPyGOKkQevohr3xs03HvIDjOVR4nC+Y2yTAP3vnGzYLGfaDjcS0Gx3DViIB+EVpISZVOuxmBMX4IOyzOy2i3Cn3Kbp1uZJwXXSyhdAdbTIqvuQdYBrjUVYUutcvZWxFphsGRn0mrO5qcUUnryd7Rdf7gYnBq0RUQ7rzUGQAuSSzunBiQT4H9+jSP69uUpL/yq9u4JaVK6DKvzp9xydtlUN0qyU8i5TIYClE21KlcuRhE2sZJNT1Rk3C6Vzt3BhlyUMubBmd4UVrH3aOGgmVYZuFBwh0FfYHgWBhI/+6QG1ZlnUmo47IuftH3B7yB7WrLYET4t2Bf2qNQe9Hrkr+qNKwW4CqPHTmxiZ0stAyoN6HkS3G5vt2EwOLMcmrR1Wf0Ju0veGWiypYAsGS4EwqoXqnuPZvDJOHvgWQl7Rm7Oe+j7WV7YDcmL/LKV46vpNmSJmdbjmajgxqyVRruMXNKb029SMv5wUrl0DcM5bKK/tar0yGvsxMVg/7kew0Q8xhB3Dpt5C8FJtUh7+yWrR7igrQ0BMxwZLqko20eVG8hE6PxXSL1T1rUWVBrXq17LA4sNzkJIhEgTmh2C0DguhaTcx5OEXI1nl52xZq/53bbKxi9btCle8DuRid7+4QHwTTXabywG53KJcjolLdflWjNNPOgZ2e6NxaGbyHuZirxQmjhEJyMpG01/GtnPUi7oEza7ETuQqj73RHfUJugF9yNI1ktJqCeNe1jRsAQNMoYX8oUzo0sffs5hY2pEIYsgEfTXjTmj1nTymTYM47Azzw6V/0HaOpqpho3TPSi/hueBm4Z6+lD1Vo5D3En4Kd56tEEYIFaaF2r8t8cmFo49aijLG4SCtJBzICmYexqnGkL6HCKCilA+mzgZ6NtoQCX6sXq3kW/nMVPnIaIHk3ACbizy22JGY98lz2jogTOQum/uhWzUFnbO1bwG02DVQncmXwRsSyX2DCNwSy04nFyB3okm78r8zpUO+252qiFJpwCrUb5GiVUML/aO3J4eRb3Hqm9g6seb3O9mFzWmqMqPB6jDldIbFn22pogwWrR2UfrE1LghyDu5VpiWunxn65a5ZRnwZvwaskgqO+rDdhQLqv/9DVFUynup1jLqDIIdEb14N8WuuB8D44yL3HQNiQQ7ZgsAYhyjbcNLe5JRn0Ght+nFOsbR1Rlb+Ilxxo2dpYADjxP7DaN50YyOEVR/EBqiEV1fzWqJ3MFSeWt2ZSbuGhpl14R9AIPNDd6zZtkzA5HqcrN9sE+yW3ZW1h/bdicmu9eU6v5rR9p1GddHhRWXHwL35tc5GMNXg3P85wa7m0FUbg4dMqogDV8Cs/BoqYNtX9i6sqxqVROwXGSsd6lS67Hmax8zXo3xv8e29plV5wrieHL8l9Gryeh4cvVqMp18N51M/hFgmdWu89V90Ii4Td/t9vY5ihrT2Wfvz9m56yNwpPgtEplVycSKgRubFwll4oQSBmWRfCsZu07vr37/BYJ6WhIYtoiq1tTV32+F9dzT3/R0rkNaM9h9PVuv7vaZv5U9dzNbP1Duxqe2YtvSvd32eWuefLhvKXC8rvQtwZvJK9TIi5+XtCHTldFMJVBdH5229HYbPvMUpTk9VD3UCnwzmWwHwA8VgrXOf+QJE7IoMVJonoMFHWy3xH3/jQc2Y0qLP0lPXdF8557r/I+KZi791JuuDzVz94NdGdENhLu8oTx5UohzwJ8U3CzHi4lPgX8mxdw7KfeWZH765uPsMAgxhbK39XUeiiYHmyp8ZLUCkgzHa+Tg6OH4yE06jxIHb+QmFUd4vSeSI2x8mntB+q+pXmE5FgzR2OXyFHLlOUQ30lkwDVJrCzM9OkogVyNeiLFYaS7tWCi6S+gCuNQqKWN/dzEI5jkIC8tX1fuLgePGfe4TctuIfoEW6AynUkDT2ruFMBCIyumuCmzT4MQbfzUy773QupxTcO3ONV33T4OfKgJHHTgRc2jqWV+hYSkeIfG1taORUbNoXcqymouMZFDwGA5DBuPVuAd2yvzB7zeq1CgO7HV/iMYUzIVcqspZeUzOCjkXKEhTFtia/b0RXs2/+LlZ6kq9rbCeWOpDVZVCr88U+he+QsK/aIG8fYPpTJ7q84+gxVJgtmOz1pvDuTEll9ixvSffmB9SmzB88BIv9SsUtT9dHtIFp4pVRq9ChaEpJEg8Y3yv5YRpmFVMGFNCSO/u3G3bA2LYMO9fnSeRpSH1WC4TrhMzIn4Fl5YtM3pEiar1kiZqb17P2McZO/j15uowZPOzq5/Y4nT0680V+zhz2OaL9+zVXyevXo++Y/mpio/y04vO1FLpnFtqPDMRgzQUDSvLLXicAjseT3ZUt16vx5w+j5VeHfmz5uhiPjt7tzgb4ZltU8M36kRhJSoua+3hoyTQxqn9eHL8Zvx6/IqeQyhjcy5b9Fx0Hv3s3Ce1ssj/Hwb/dz0M9oEWW5yjIsMZz9Zb5Befuz4FD8fuBe9S0LOgTv5yb4ul8BVhK4f5BW9Rt2GQKmMR3Jcv+ILlWmfbLS5/LkFT0sU3dFq4QvrTbV3qUdq7x7QQ4BC8sPTYLitdfuhVNNt2Bv757Mrfa3VTyj2lFP+j1SBzuWnB7mcXRwL+27q/6R75Hn3wHDY/1Nvdl70H6ozmdqP0scr9J6Wzr0Q=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List key stores</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/key-stores"}></MethodEndpoint>



Lists the key stores of the organisation. The first key store is the local key store that takes new keys. The other key store of the installation comes next, but only when the organisation has keys in it. Then come the key stores that the organisation added, oldest first.

A sandbox organisation gets the key stores of its main organisation. The answer never has a credential of a key store: `credentialsConfigured` shows which credentials the wallet has.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the key stores.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyStores</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key stores of the organisation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else a UUID.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store. `local` is a key store of the installation (OpenBao Transit, the wallet database, or the hardware security module of the installation). Each organisation can use it, and the API cannot add, change or delete it. `vault` is an external OpenBao or HashiCorp Vault of the organisation. `gcp-kms` is a key ring in Google Cloud KMS. `aws-kms` is one region of an AWS account (AWS KMS). `azure-key-vault` is an Azure key vault or managed HSM. `dpod` is a partition of a Thales Luna Cloud HSM service (DPoD). `csc` is a remote signing service with the Cloud Signature Consortium (CSC) API, for example a qualified trust service provider (QTSP).","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"provider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The provider of the key store, an `id` of the providers of the list key store types operation (for example `openbao`, `hashicorp-vault`, `google-cloud-kms` or `intesi`). `null` for a `local` key store. It cannot change. An organisation has at most one key store of each provider.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Name of the key store. It is unique in the organisation.","example":"Local vault"}}></SchemaItem><SchemaItem collapsible={false} name={"local"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` for a key store of the installation (type `local`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`active`, `disabled`, `error`]"} schema={{"type":"string","description":"Status of the key store. `active` when the key store works. `error` after a connection test that failed. `disabled` is reserved.","enum":["active","disabled","error"],"example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`, `hsm-backed`, `dedicated-hsm`, `provider`]"} schema={{"type":"string","nullable":true,"description":"Where the private keys of this key store are. `software`: in the software of a key management service (`local` with the backend `openbao` or `database`, `vault`, `gcp-kms` with the protection level `SOFTWARE`, `azure-key-vault` with the key type `EC`). `hsm`: in the hardware security module of the installation (`local` with the backend `hsm`). `hsm-backed`: in a cloud KMS that keeps the keys in hardware security modules of the cloud provider (`gcp-kms` with `HSM`, `aws-kms`, `azure-key-vault` with `EC-HSM`). `dedicated-hsm`: in a hardware security module partition of the organisation (`dpod`). `provider`: at the provider, which decides how it protects the keys (`csc`). An organisation key store has the `protection` of its provider, unless its settings decide.","enum":["software","hsm","hsm-backed","dedicated-hsm","provider"],"example":"software"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>settings</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Settings of the key store type. Never a secret.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"local"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"backend"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openbao`, `database`, `hsm`]"} schema={{"type":"string","description":"Where the installation keeps the keys. `openbao` for OpenBao Transit (`local-openbao`), `database` for the wallet database (`local-database`, legacy, no new keys), `hsm` for the hardware security module of the installation (`local-hsm`). With `hsm`, the new local keys of the organisations go to the HSM; the keys in `local-openbao` stay there and keep working.","enum":["openbao","database","hsm"],"example":"openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`]"} schema={{"type":"string","description":"How the key store protects the keys. `software` for the backends `openbao` and `database`, `hsm` for the backend `hsm`.","enum":["software","hsm"],"example":"software"}}></SchemaItem></TabItem><TabItem label={"vault"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"address"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the vault, with `https://`. The wallet refuses `http://` and private network addresses, unless the installation allows private addresses (for example on premises).","example":"https://vault.example.com:8200"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Namespace in the vault. Leave it out or send `null` when the vault has no namespaces.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"transitMount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the Transit secrets engine. The default is `transit`.","example":"transit"}}></SchemaItem><SchemaItem collapsible={false} name={"caCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM bundle of the certificate authorities that the wallet trusts for the TLS certificate of the vault. Without it, the wallet uses the system certificate authorities.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"clientCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM client certificate for mutual TLS. Required for the authentication method `cert`. With another method, send it when the listener of the vault requires mutual TLS. The private key of the certificate goes in the credential `clientPrivateKey`.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to the vault.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`userpass`, `approle`, `cert`, `token`]"} schema={{"type":"string","description":"Authentication method. `userpass` needs `username` and the credential `password`. `approle` needs `roleId` and the credential `secretId`. `cert` needs `clientCertificate` and the credential `clientPrivateKey`, and can have `role`. `token` needs the credential `token`.","enum":["userpass","approle","cert","token"],"example":"userpass"}}></SchemaItem><SchemaItem collapsible={false} name={"mount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the authentication method. The default is the name of the method (`userpass`, `approle` or `cert`).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"User name, for the method `userpass`.","example":"wallet"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Role ID, for the method `approle`.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Name of the certificate role, for the method `cert`. Optional.","example":null}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"gcp-kms"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"project"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Google Cloud project ID of the key ring. A domain-scoped project ID (`example.com:my-project`) is also accepted.","example":"my-project"}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Cloud KMS location of the key ring, for example `europe-west1`.","example":"europe-west1"}}></SchemaItem><SchemaItem collapsible={false} name={"keyRing"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 63 characters`"} schema={{"type":"string","maxLength":63,"description":"The name of the key ring. Letters, digits, `_` and `-`, at most 63 characters.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"protectionLevel"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`HSM`, `SOFTWARE`]"} schema={{"type":"string","description":"The protection level of the keys that the wallet creates. `HSM` (default) keeps the keys in hardware security modules of Google Cloud (the key store `protection` is `hsm-backed`). `SOFTWARE` keeps them in software (the key store `protection` is `software`).","enum":["HSM","SOFTWARE"],"example":"HSM"}}></SchemaItem></TabItem><TabItem label={"aws-kms"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"region"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The AWS region of the keys, for example `eu-central-1`. Free text with a format check, not a fixed list.","example":"eu-central-1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to AWS KMS.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`accessKey`]"} schema={{"type":"string","description":"Authentication method. `accessKey` (the only method) needs the credentials `accessKeyId` and `secretAccessKey`.","enum":["accessKey"],"example":"accessKey"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"azure-key-vault"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"vaultUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the key vault (`https://<name>.vault.azure.net`) or of the managed HSM (`https://<name>.managedhsm.azure.net`), without a path and without a trailing `/`.","example":"https://my-vault.vault.azure.net"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Microsoft Entra tenant ID, a GUID or a domain name (for example `contoso.onmicrosoft.com`).","example":"00000000-0000-0000-0000-000000000000"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The application (client) ID of the app registration, a GUID.","example":"11111111-1111-1111-1111-111111111111"}}></SchemaItem><SchemaItem collapsible={false} name={"keyType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EC-HSM`, `EC`]"} schema={{"type":"string","description":"The key type of the keys that the wallet creates. `EC-HSM` (default) keeps the keys in hardware security modules (the key store `protection` is `hsm-backed`). `EC` keeps them in software (the key store `protection` is `software`). A managed HSM has `EC-HSM` keys only.","enum":["EC-HSM","EC"],"example":"EC-HSM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the application logs in to Microsoft Entra ID.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`clientSecret`, `clientCertificate`]"} schema={{"type":"string","description":"Authentication method. `clientSecret` needs the credential `clientSecret`. `clientCertificate` needs the credentials `clientCertificate` and `clientPrivateKey`.","enum":["clientSecret","clientCertificate"],"example":"clientSecret"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"dpod"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"tokenLabel"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 32 characters`"} schema={{"type":"string","maxLength":32,"description":"The label of the partition, at most 32 bytes in UTF-8, without a control character, `;`, `{` or `}`. The wallet removes the spaces around it.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^[0-9]{1,16}$`"} schema={{"type":"string","nullable":true,"pattern":"^[0-9]{1,16}$","description":"The serial number of the partition, a string of 1 to 16 digits. Optional; an empty string is the same as `null`, and a number is refused. When given, the HSM signer checks that the partition has this serial number.","example":null}}></SchemaItem></TabItem><TabItem label={"csc"} value={"6-item-properties"}><SchemaItem collapsible={false} name={"cscUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC API of the QTSP, with `https://`.","example":"https://qtsp.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"apiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"Version of the CSC API. The default is `v1`.","enum":["v1","v2"],"example":"v1"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client ID that the QTSP gave the organisation.","example":"client"}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID that the QTSP registered for the organisation.","example":"user-1"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialsConfigured</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential field of the key store type, `true` when the wallet has a value. The answer never has the value. Empty for the type `local`. The fields: `vault` `password`, `secretId`, `token`, `clientPrivateKey`; `gcp-kms` `serviceAccountKey`; `aws-kms` `accessKeyId`, `secretAccessKey`; `azure-key-vault` `clientSecret`, `clientCertificate`, `clientPrivateKey`; `dpod` `authTokenConfigUri`, `authTokenClientId`, `authTokenClientSecret`, `pin`; `csc` `clientSecret`, `userPin`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"capabilities"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`create`, `import`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete`]"} schema={{"type":"array","description":"What the key store can do. The type sets them. `local` (the key store that takes new keys): `create`, `import`, `sign`, `csr`, `certificateChain`, `test` (no `import` with the backend `hsm`). `local` (the other key store of the installation): `sign`, `csr`, `certificateChain`, `test`. `vault`: `create`, `import`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete`. `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`: `create`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete` (no `import`). `csc`: `reference`, `sign`, `listProviderKeys`, `test`, `edit`, `delete`.","items":{"type":"string","enum":["create","import","reference","sign","csr","certificateChain","listProviderKeys","test","edit","delete"]},"example":["create","import","sign","csr","certificateChain","test"]}}></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the keys in a qualified signature creation device (QSCD). `false`, or `provider` for the type `csc`, where the QTSP decides.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"keyCount"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of keys of the organisation in the key store.","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"qualifiedStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","nullable":true,"description":"Only for a key store of a provider with `qualified` `true` (category `qtsp`): `qualified` when every key of the key store is qualified and there is at least one key, `not-qualified` when a key is not, else `unknown`. `null` for every other key store: no other key store claims a qualified status. See `trust` of the key.","enum":["qualified","not-qualified","unknown"],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"lastCheckedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the last connection test, in UTC. `null` before the first test.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lastCheckResult</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Result of a connection test of a key store.

</div><SchemaItem collapsible={false} name={"ok"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the connection test passed.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Why the connection test failed, as a safe text. It never has a secret or the detail of the provider. `null` when the test passed.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the connection test, in UTC.","example":"2026-10-20T10:05:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Creation time of the key store, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the last change of the key store, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keyStores\": [\n    {\n      \"id\": \"local-openbao\",\n      \"type\": \"local\",\n      \"provider\": null,\n      \"name\": \"Local vault\",\n      \"local\": true,\n      \"status\": \"active\",\n      \"protection\": \"software\",\n      \"settings\": {},\n      \"credentialsConfigured\": {},\n      \"capabilities\": [\n        \"create\",\n        \"import\",\n        \"sign\",\n        \"csr\",\n        \"certificateChain\",\n        \"test\"\n      ],\n      \"qscd\": false,\n      \"keyCount\": 3,\n      \"qualifiedStatus\": null,\n      \"lastCheckedAt\": null,\n      \"lastCheckResult\": {\n        \"ok\": true,\n        \"message\": null,\n        \"checkedAt\": \"2026-10-20T10:05:00Z\"\n      },\n      \"createdAt\": \"2026-10-20T10:00:00Z\",\n      \"updatedAt\": \"2026-10-20T10:00:00Z\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List keys
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-list-keys

---
id: config-digital-wallet-open-id-list-keys
title: "List keys"
description: "Lists one page of the signing keys of the organisation, from all key stores or from one key store. The wallet uses these keys to sign OID4VCI credentials, status lists, signed issuer metadata and OpenID4VP requests. This operation returns public key material only. It never returns the private part of a key."
sidebar_label: "List keys"
hide_title: true
hide_table_of_contents: true
api: eJztPdtyG7mxv4KavJBVQ0qkZK+tJFuHpuSN1jfZktdJHFcGnAFJrIYAPcBI4rr076e6G5g7JUonPg/ZrdqqtUhcGo2+d6P5LUiEiTO5tlKr4Ch4LY01TCvB1nwhmJ4zuxTMyIWSasEuxcb4z3S24EoaDhNDNs/0ivE0hSHMWJ0Jw3RGH8NqxcdDdrEU7JqnqbAsN8LAYkbQ0lbjVuzd6fHhL9NTFmciEcpKnpqQGcttblgKEIY4TiRMGpOLjK2E5Qm3nHGVsHdroWCBM5aJr7kw1sCm0jC9FhnCyzJh80wZts5nqYwRuhW3IpM8ZVqlmyE7tUyJK5EVQ+HM60xecQu4ySzggcPM4b/Uv9QJj5e4zJIbJq1hiq9EiP8qjk5/ui1//vSK/j4+PTYhi6Q5FnOepzZiPVtiCI5p2LW0S2bhCLDYbMMSGtvH80a54QsRHSGIKl/NRAbAlciD4VJJOLnBGetMGKEs4aL6pV1y2tNviRdDd5YJnuD+uF0FmQt5RdfIEmG5TA1i5KVMrchonehSbM4BBadJFLLICJ7Fy4iAhwFTkVk5lzG3YrrkUkUh01lSzDY6sy82bjz88Q6+jEI6CwBD41K5ktYN0/O5ETYask/SLnVuy1UA0JQby/J1wq2gM8V6JQyby8zYIZsoRtPZGsbBBKGSyjlxOmxMmKHz4L7wLeEn1rmyhrBGuCnR3MFCOBvowXCVzPRN7UvjiHLS+S1bCGv8XeHisM6KS1UbNvyXCsKguLbTJDgKYq3mcnEsF9Ly9BOSHHJPAnLgldiYIAzWPOMrYUVmgqPP3xry4pUQ6/reDW736Jc2xGFcmWuRIZtUZ9VFxzAIAwnLf81FtgnCALgpOApKMgrCAJhbZiIJjuY8NSIMTLwUKx4cfQvsZg3Djc2kWgRhsOI3r4Va2GVw9PTwNgzEDV+tUxiS6pinA70WasZ1cBvec77rpSZZxU6PQb4BXCzWynLpRIQVNzYsSIGkGjAVr/KjzraxoNsB19UZ7NJavSITkFRPjxlPjQYBFi8FfUEYN2y5WS+FMkM25UYwqYxQRlp5JULGLVtpY9lo/IzFS57xGK54G+aJxB+N9dH42W0buZ+Qa22Wiyhkl3VMI9KW/Aoohv19+GT/OYtLKQEQS7UN2C6RshPoM61TwWGsE7BuaAfsKII8IwPEVVLfQcbQ2QFgPPumvDfuqWrl1pCKzbRdskRmIkZxQGLHkaFQiWGgqjYkNENmtBMvAKKxfEN4NbBsoZFRbloaqcSN3XrzKDYfdvNC5avg6DMtEQZxJgAJExuEgUPIxAZfKliufNyB64mJhUrAANEZg6+KvxKRES7cSkwaFnETR2yus1LkE55JMcB8+hoZSq62i5tC1Tzu9NzESEkmDr50nOptoakzEessIfPnUq4RuDVfSEVym02YEgsObAsIyBXoFD5LBbviaS7YnKepYTMeX8IK0X607Tyk1HY6jFRWLPDgxR3th8FKKrmCw+3jedyyqHabW9bP+obfwMSKdVI5M1lYbC0y0qmPBXC0f3v7BeaatVZGGBg93t+H/9WhIZ2dXclYuM1F0rJ5t9m6AB7IZKEsrMzX6xSkjNRq71cDy39rA6tnv4oYULTOQP9aScDBFpVRPMt4G3UXBSyKTMDS7gBTGCherNZ2w66XQjGlUSzwRSaEKY24ORpjROhWrEwXbFZaVInnZOy/Em1Y3qmaL9DtClQtR9LnTpjrNAHbuFCOYPnSVyjrUDJJS0ermAk72Ojemmja5w4KsjwyMReZUHH1hkG20kR9JVGgZ4wzI+JMoEBs3RdYTW2Or2Ppo5Jfc8Ekavu5rKmJmvuz4pfCoGVExh+LuVLagnJT/o6JxWVFgnPDol+vL4eXMkFOL42Zg/mYPx/Fhz/MniWH4umc78dPkh/E6Nns+fhwfrAf3HpR0D6CytMUZEpwBPq4rrz395tHfIv2SQXBYBsr8Ey4YjwBOWFsxq3OiCwLdBvmlAFguqAUkv5EUt4+HbIIYIrqC8BNK40asn72s9NjdAY5XPB4f/wUDuvtxS5y7+SyNr36e2sRg/w/UoIzkIO7rFG3/H3bXGzWontlp4lw3SAMrlBQhsEiXg8uV2Dc82vj//VbnonBpdgM/KhkrcHOjkF/taC8i5bupJWuc7+GFRnte3tbFf+fAc8OD27DL7dhoDO5kGoXOq7D8jd9XcARA1xWtwU8ixyNRiQ4HLd6wm2IjpJqemiGSwW2fqrzhL16c04C5fhMH6NQIhu/Q2z2hyySq7XOym3pzzpTMD+m5DxkIsdMZD627WQWFcLPrw7LXnPDeArWRMdpHJBeMpY+TTsyQQZvneQctkDhOJBRrXso6hTlB9+GAU8XOpN2uXr45YLi4jbPBCsWqUreGsWdnI+foIigqNL9VHxO0actkryCDIwJeffFiW2aG/EYbLiG0KYPAZQiBLTFI6mBs9TXxvlOpYTcKWhU2x4WuA2DX68v75eRZ6Uilor9fP7uLfskZuyV2LDez59e9cFuXXHrYyJkXxl0T0Bfe0W+EmADmor6pjFVBY7KHsexiLRcQxPbzf1XBoDBiDpAPL0Gh8jvKY3bqPCpDOOZYCJNYaGYxXl2RZ8XjlWhk6OTaeM2T6Zwk3F2dT94J/UdSiXRgORsMH7ydBsA+GUDBvwMwLi5H4i/s1jrLAFXo2D5xtHXWiobohfKjXh6mGepv+natn8pvh7cDMpVfwRIdritf3wXSDZNSC530dtAOc376DbE0CR8hBnG08UOMqdDoHnHFWU//OH2ZRGKNPJseUk0W8TezZP4Xs9j2tQjVS2OYW5AB2qLBG8lFXyODp3W1kUfegSOFcZW9RLpIBzv1QoOgZn9IcNoOjgqsAF3t82EinUiEnZ88qG6VoO9kzpbk+hp2ZCdWhLWiW6exBFbCu7COxylqbsFB+oq0TEOxFg1Rala5wEHNVuJROIG5WYmLFQ1HjvLDbhE8VJnXe7ZFtIAT+wetKAldfPE7kBnf5sMRswu89VsnUlVuE54nu+B6W3capZ8NCjh+JEo1f4JqXanYwDV73KQt9rSnUV/irzt446BvgWeNF+nmidt+DtzHygSSEiAYLh5Yv9t2rK5ftjxk6ft48b/Fjdrme0gMk9wHMawtp0U+fLjxfT7XN14f/zDYDQajEcXo/2jffjvny0DHnQ12OyJTO6PdnTFBLwN80D2SEQslM14Kg0kCksfrHd8etwfBtU8wGeA7uhSbI5+Gyer346fjeLF2c2zXy7lDz/P8vzN6uU/sk9ni3/ojd1cfvzngdh8XdrRr89fzb7+czgc4vmW3LSCzo815Iob2B77hgstB8dcNfJ20c2T/edRl36kkHYYVNY813kW7xQXaETwwezH7TqYpFQWLvKd6dWQRcRVhSNyP5Pt6Bo567vG5hFolUHM3bxZLlM7AHYHZTOdUKqVvI+WjiqX7pOmTcSVSPV6JZSLYQljMQyNwajoqzVrt09tFULD+4vzs0oK6M7oRjfXOcfKo6/uWblzBmEAYAQhLF51seDvWxpWIdKH0mcpJqIW8URoj3p8k7xp4RvT9UkTRyG7XkrQ+GYHPFOWkvLYVyJDljZM59bIRLgIacot0D1LNIN4GulYeS8XnEFOrlNf3s0FF+i5wFx/23dyAxIdxm6rw2iBSpFCf8he3mE8lRtKTDNjpYObopinEtq9OYNyPtd4Kecfak5tgywzNHmVVvWIjSOnClATY4QxKx8VT9N3c0wXb4syTzuntuULt516rWaKpqm+NkdFsQXl32Fjx41l4hWmgiUtnJKRls0llJOg/j9+zY51nCPhge0NCYlMz2XqSjfex2fnL9CbFzAmrNiuN7aIDRgwB+OliC/JPgdb1u1bDxpA4MXcSy6Q/sFgzfb4TlgEU7mzwT3afOiK4sqwYehMFvBcPgKiIHgYuWsPXSrB1dhEqyT1CCF8RCxCvoEqjq/xmZn5mY5RAQ0mh1oIw6KJYicTyF2JxGBUHS6gfoUA74KnkPsxWrkynW5JOGQfiMYbGCgUniNv2LII5/cE5wP/V38YIfoJTCcbsEyjtMRFMkDOFDeAiUqwDmwDYCz6wgezfYnQPDci6UwYFDh+nFip0/M2K4/1Ti7OT9nJW3Ywes4OR+PBmMUpz41gh8OD4ThkFvOFIwgzTqIjYOgPYp2Dc0IK9kXrQ7zRhCpDCkd0yKJpdNT18XHHx7jEpdicqFiul+ANgUmewUcTSFDB30MWnURHO4x62YIwfOyGDc1bRSQZXRokXwX3vaqjjQR3KTYgwWDnPhaC6HJ4VVtPgjB4EYTBNAiD4yAMToIweNlWz8ELMEdBFE0LYTUtZNVOOcI7pFzzkLBPVQt1zqxaP172RKAIIpBIkG5pLYnmQbSWiSvN4q1hJKRa+EXaxiWA572svMvcL9RIE10brA1qo0cmJG/ah908ABVUYydOjyfn5fTWulhUlZdpLEAa6zUMuyxPRT8kdLEeCcDCS4ldXRC3HMYIznEBNfia8xRMnoRxC3aBv6HoK43p/h4oNFrnswENqnzlLbLZBss10d5wcVojYsjfzXSy6VdJGo4Dkg4TM4KjzUn/czvUY/vwQd3VwiF3kPtLnb1J0u9C9HOyjkDT126pTeJY8ZingmKw1ZgfVpZsgz0K2QxWAUQXt4J1JwX6MUvE41g4NUIsgDm8qVf2FMHvgrRqg3eoZ1nY6t42qZIp/l1bTRqKfkgqrP2D5/7Lea5FMo8OUTS1JlZ0dFvPcFun5+/2Tk+mbPRsf3QweMIu0CB5MTxgvZIJoqZCJzIWN1aoRFSrj6PRcH+Iaw2fDEfDMfAd1MjFmbQy5mm/k5N6iY5R10Q6Wwyl0ZUlVsevo77jriJz5g7Q6Tii/bujs2Oy9zi6i0saXgWRdlmQMmciFbHNtJJxlcCobNbaTM5yC2UkuxAV653lLwYnk0n/iKHJeHHORs5kfOpNxmfDA0T7RClxwyZhBbZ3p8cs2h8eAvKfH47GT4ej4QEaBOUYNKHSlNllJlxE1BUsOgvdc0VhmEfOR5AdNTdon2ebd/PXYiFNyglx91ZELF0Bdin3Un4NVgkQIjsYPX06GDGerpccTGWdCPShopOPlEA5yQEIrthHBQyb8mtnYtfwdXb+YvBseDDYf4LkdgZBXCDrcwQKN77WleJaH2iuRemrfHt+grmh3C4ppnJaE027HTtXfDWTi1znpinaHCZgffg8ZgZ3Yb3iIIf9elKJk4jGer2UKhATidGYXJqlSDBYboZs4oqJx/uH1WriEO05rWym0/Lj+plj9dcTt9sHuGIrslAXH01ehPFfCS1pSQCPwUs3LuBmc4VPDTAEhY5km20kRFiwrFCC2PJJuDswOe4P2UcDGPz44ZT1PrycsoPnz572SYBCsaG4wbc25ZSD/v8JkUtr1+Zob+/6+nroPh0asZfy6z2ohxqMxget2Hwnd91BgXfdwhcovrzfo22Ku15bnvRJBjpRVSlBIfehJVvuc+iUbu5aDaqQpC8BIo2BigDvuCpyiVTAkkSREG3FBhh/XciN6MmOq3U0HRQUbUN+1A/vlNmY0fAG0hthQE+aHfVTy6Ir5jev8GUR0mobdeGdwTD/DKJuzbpgVWHY4VuWWunKEXILvnwo4mlgyJVmPtxkooXBgM4c6ikrha83+EiijGvVI+5gxw8rUaGmsS8Vi0xREDuFgwxXDjdknMAIkWU6e1N8jNTrgkKIgbZaQ4Ou7eFssb2Bbde1woUdJoDJ96AJXx88wxufD5jUEEA7GLa3X/5zNEh2UZ0EKRBMxEN2YuE/QPUBlQvxKgkhp62SdFpd5w+O+4Pj/uC4bo7rimP0opXR/4ZSmoiI537frEG5Q/YS3lLVoxxIpz0fo60FV1zkBbJFIqEwzvYwTR+PRWTb9F2bbi7sWcgMMDgK46FzZLtCopomuCMMfG/IrMu/945qh21whxDroIEH5OJCX7hxX2rr1FZfgj4kc9cV3ntcGu8xWbwTfG5XvvcOHW3dl6lDzeESTfDE9sSnmXbTGhddM7uM7O25LE4CfkuVgktrYQ27WwNFOHrHeAJ8sUVuoUjYdDJkn5YyJRFeboSvoqDUjRNDtvsIVFVUl0apVFbRyEwYeOAX0SbErUqT0Id6iosaANKwmc7hYnU3zdY2XvKkVFLlIlAfDwELsPP5/BzrtaL+UT2LAV+FLHInpggs5UhJoGSCG60iZji+H97gp9e4u4YkZK/wXgCN8DyKVoJUHWD5YyajouyUfARfHesBpev8+OG1/6Z1ddy9S6779vQGTyRQKiUNBk7feclV1FBQIFZDlbbFng6ZWOkrfLf0Zxw5OTutP1wqHnERgly991HlOL0mkH3sCoDFae5bX6rm/XQ3qFp2QvdBw33t31yqhchqxX8dZO5XwyfTEest3bOQLRxBL6uT2lQj7MT3aoACPF9o51oyGIEPT3vXS40kJIuyVlp3hRVbM+F817a54nC1S9a4HQLw7n+sV3s23avG2szwZoWPdxyCH7aBD8tU3fKgUUqG13L/shjR8Vy103C8hp1G4uV0jaRquOAogPdmA7i3O49LcZP9wXhcrW/E9V901me2IHHM3Bllbz7CIEmxw7IN88HvsWMA5t46B9YDLVnlhS6V0L+zhK1YFzXeVxMn7We4lFeQjZdh9UYAtG+ZYSmLsbFqj5onoKDovT+fHgNQvkAF8y9FhJk8P/dotboiFYd5cVNWjlReA6JVGps4crmoYhDIzcRHt6n2tyx1rB+rM4WAe++m+l+JDWr/TnVfwU/xTKly2NqjrvvPTpVULY3JF6D+SWmefKzRgqnVNaG+xucBzbef5fsvpwV9wE4rRa0NWg8FUfUJ2KktI3d9uxUVJ47alk/VqikxUzt4bpfw+mLDeh5VSBLTyd77aen4OtQvMq6sSPr0XruFquKtL75s6N4QtXSZ9CloHtVv9QvBU9+TpPpyyrNrF9ugIgd7ehv7KG0HTXzV7hosGaY0VPKqS6WvlRsExMFTCnN6MdA4vDNgQp9XcGbDTLjStPJtC9peZFKI+FIkbEMPsn1CtIAQpGMVYmgxQWDVU6LlAFBXtGi3jrhHglaK7XGZssK+SxxuO0ZbxYzqKoZaKT2uaGzOY+vcpIV/m0Lmc90CbLJCSeiFS9Si3OulQKuu+a2/u+p6hm9M3dD2lAnEVsfD+504AQj+z04Gt+kdViWL7H18Dv+uJVUb0P25fQSfK4Cpnl4ol4rm2yn2Gjti07d/PVVWGMl+ynS+BiIvoT8poT0HPptO2E8H7GQ6ZT2UF6EXEGEDfXN2etFvxwacjKvSbEEcOyh8tOcbuq+hDgptRk20St73Kf9eEVyhGncKjXQqnSIMcKeucIyCl0t9a3w9GFoLGAXY7cn+9+l2VjhBeDPUfKPVOq72dHTSvb9vAqYVCj0IEaB0MHBsaGNBxdu1wBgKeWwEVul3B53ySvge2I2tnVMvYD0usbGlt0p3x5ot2N6C0CqjjyGIWbmQx0Lw0EutwjBqpUE7EbId0C+31aZGj/UzGq8tvUKuPufCV55Ov3Srjf262ij7KP1noKqqO2xG5Vz8x8HXjnti5ZhrE1V06yj6O1TbAYSlKCwfytPLdfe2rPsJVtc7p/ZDmK53INveN2yJ4Dk3x1v1W9teYRi/6O50VyeeV2IDW5yVg1tP8oH3HZ9X5a+v5avzvdWWp6eNPMH9rFZpYgdF1K2uQiGYupCVh85EpsFpoWsPdf+G7R5RZdsjUXSGKpfehz4g1NHqwaeZiTn1eSn6Ke3e89E/+5Cm/ibcTfdZihbA+/RG8K24eXSDB3KHOPZra2/gW9XVeKxy52HRqatoBObh+dLBmtT7sSC9L5hJoofRQD/w1yF119q5HVZ1B8zgTXUCvIf/Pq6c/0vYYoo6KZezu+6+QMnhPmC9tXxX07ayFJ9DinGdA4Zd50vIot3eNq9owrDZWTnMPZolqqillSnn1Ii/KuY8lbJRnW9aVzQ4LZulYjo21RDehLVVo3GjC/N2t1PtAok5ygMSat7q6Hd8qx+Vc4N+Q2eyiZrD3zFqLpo9a53DVDoUhWqAblyq1ve3TWdPftfSA1zITPEUw28iY7hNA0cYao5zcMkxODhZS2jLd/QZPT/LF9CSN3Dte93LWNbz/a+n/SDEViZvuOIL9IMBNSthlxqa/y5QBaw59HgL9q7Ge+SH7Lki7AGF8/agHZlM9qAz2KpYaM8pCAK+qzPwsVhpdzawf7K0kp9IxEoP+FoOJTrDQ9nVevcs00lOQcEty9y3wrkF9bXYNt3Q101AvpRIPwfaI5LxqC/rLugD1/aSbq1stTlxMqTbbIOUGbrJvvrPPVsow8jOlotq6xR9SVYQtp1hQfVc3ojEue4EI8NnC669hc24TBEHax7D2wcxXAwbyx4xN/EvG51ngA5oA/djRMEIqebasymPkU3FCkNTgcnX8AD9f0rkFeeXP5Uf1bFevbAGWopJPiaBLSg0cJbFR/8p0l6tgJeIHRXrL/gaHN8VlDUSBsM22BWw59rK9ytd4psTz6puZcFJZ32AyOpYp76XPFyhUDDHOJn4m3PfraZa/BA7CIblQ/WNf69Y7WvPcoPXY7lKeJaYAZ5XcmXZHEop6GodphHaTwdT9ssUWm5d9EN2enLxkp0fD37+dMF+mdJuUOLua1VWxzrew+qb0mUnPxAt9VTGQhmUg55y1zxeCjYe7reuDiqLOX491Nliz801e69Ppydvz08GMOe2dF/K6wRkJa4kw3MEiA269vH+GF6pjmDuWhu74qoCz2sfg2lyUUVz/PGzBX/8bMEfP1vw3/yzBU7pghO0t04hrnPrpNM3Z8F8Dq7G1Jp5LjEFWLNi6JcPFBY91i0Z+sCAZbTUkI39HHz7Bl2aPmbp7S18TC2t0cKRBiR+2ZZ6q0D6fr+L0ImJSzBN6j+PgHZEcBSQXfRYwH8XP3hwB0qL3z14JDr/Ez9xcAd4W37p4JHA/lf+psFdl+t/2uCR+Pr/+F2Ce8D3P0/wyBN8398guAP2IgL5SMAf+oMCd4Dig6IlJF/gj0xSVuTzlyLsiTqAJk3w/X5lVit0cVt1tX86uXDP6uoe5CV6kO4flfIfrqpk2XQmC2mPSOuc8hcwuV+JzY/FcPpm64TCgaXRgCCI+P4vkYq8kw==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List keys</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/keys"}></MethodEndpoint>



Lists one page of the signing keys of the organisation, from all key stores or from one key store. The wallet uses these keys to sign OID4VCI credentials, status lists, signed issuer metadata and OpenID4VP requests. This operation returns public key material only. It never returns the private part of a key.

Each key has its name, its key store, its public JWK, its DIDs, `isDefault` (the wallet signs with this key by default) and `usage`: the number of credential definitions and presentation definitions that sign with the key. The read key usage operation gives the details.

Filter with `keyStoreId`, `search` and `withCertificateChain`, order with `sortBy` and `sortOrder`, and page with `limit` and `offset`. Without `sortBy` the last updated key comes first. An offset past the end gives the last page. The search and the usage counts read the definitions of the organisation and its sandbox organisations only. A sandbox organisation gets the keys of its main organisation.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Keeps the keys of one key store. Without it, the answer has the keys of all key stores.","in":"query","name":"keyStoreId","required":false,"schema":{"type":"string","maxLength":64},"example":"local-openbao"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Keeps the keys whose key ID or name contains the text, and the keys that a credential or presentation definition whose name or ID contains the text signs with. An ID also matches without its hyphens. Case insensitive, at most 128 characters.","in":"query","name":"search","required":false,"schema":{"type":"string","maxLength":128}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"With `true`, keeps the keys that have an X.509 certificate chain.","in":"query","name":"withCertificateChain","required":false,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Order of the keys. Without it the last updated key comes first. With `name`, keys without a name come last in both directions. The key ID ends every order, so the order stays the same from one page to the next.","in":"query","name":"sortBy","required":false,"schema":{"type":"string","enum":["name","createdAt","updatedAt"],"default":"updatedAt"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Ascending or descending order. The default is `asc` for `sortBy` `name` and `desc` for the times.","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["asc","desc"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned one page of the keys of the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keys</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The keys on this page. The list is empty when no key agrees with the filters.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key. The wallet makes it, and it cannot change. The value is the same as `jwk.kid`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","nullable":true,"maxLength":100,"description":"Name of the key, given by an administrator when the key is created or with the update key operation. `null` when the key has no name.","example":"PID issuance 2026"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyStore</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key store that holds the key.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store.","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the key store.","example":"Local vault"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`created`, `imported`, `referenced`]"} schema={{"type":"string","nullable":true,"description":"How the key came to the organisation. `created`, the wallet created the key in the key store (also in a cloud KMS or a DPoD partition of the organisation). `imported`, the import key operation imported the key, with or without a certificate chain. `referenced`, the key was already in the key store of the provider, and the wallet signs with it there.","enum":["created","imported","referenced"],"example":"created"}}></SchemaItem><SchemaItem collapsible={false} name={"algorithm"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Signature algorithm of the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the key. The wallet signs with a key that has the status `active`.","example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"isDefault"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the wallet signs with this key by default.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key in JSON Web Key (JWK) format. The service sends only public members. It never sends the private key member `d`.

</div><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type. The service always sends this member. The keys are elliptic curve keys, so the value is `EC`.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve identifier. The keys are P-256 keys, so the value is `P-256`.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier. The value is the same as `keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm for the key, for example `ES256` for a P-256 key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Certificate chain of the key as it is stored, in leaf to root order (for a test certificate, the leaf and the test root). Each item is a base64 encoded DER certificate. The service adds this member only when the key has a certificate chain. The `x5c` header of a signature and the mdoc `x5chain` have the leaf and the intermediate certificates, without the trust anchor.","items":{"type":"string","description":"One base64 encoded DER certificate."}}}></SchemaItem><SchemaItem collapsible={false} name={"x5t"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-1 thumbprint of the leaf certificate. The service adds this member only when the key has a certificate chain.","example":"<base64url-sha1-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5t#S256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-256 thumbprint of the leaf certificate. Note the `#` in the member name. The upload certificate chain operation gives the same value as `x5t_s256`.","example":"<base64url-sha256-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c_expiry"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry time of the leaf certificate, in UTC. The service adds this member only when the key has a certificate chain.","example":"2027-11-21T10:00:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dids"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"DIDs that come from this key.","items":{"type":"string","description":"One decentralised identifier (DID)."},"example":["did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ..."]}}></SchemaItem><SchemaItem collapsible={false} name={"hasCertificateChain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the key has an X.509 certificate chain. Then the key can sign with the `x509` format.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSource"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`uploaded`, `imported`, `test-ca`, `qtsp`, `null`]"} schema={{"type":"string","nullable":true,"description":"Where the certificate chain of the key comes from. `uploaded`, the upload certificate chain operation. `imported`, the import key operation with a certificate. `test-ca`, the built-in test CA (the create test certificate operation), for development and testing only. `qtsp`, the certificate of the QTSP credential. `null` when the key has no certificate chain.","enum":["uploaded","imported","test-ca","qtsp",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"testCertificate"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` only when `certificateSource` is `test-ca`. The built-in test CA issued the certificate, which is for development and testing only. Wallets and verifiers outside this platform do not trust it.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificatePreset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The preset of the certificate chain of the key (the list certificate presets operation). For a test certificate, the preset of its request. For an uploaded chain, the preset of the newest CSR of the key. `null` when there is none.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>certificateAssessment</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

What the leaf certificate of the key allows: its key usage type, the credential categories that it fits, the mDL Document Signer profile, its QcPSB statement, and the texts of the save check for each category. The wallet reads the certificate chain of the key. A key without a certificate chain, or with a leaf that the wallet cannot read, gives `keyUsageType` `null`, empty lists, `mdlDocumentSigner` `false`, `qcPsb` `null` and texts such as `An EAA needs a seal certificate of a legal person. This key has no certificate. Request a certificate with the preset EAA provider (eaa-provider).` The texts do not count the trusted-list exemption of the key: an exempt key is never refused.

</div><SchemaItem collapsible={false} name={"keyUsageType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`A`, `B`, `C`, `D`, `E`, `F`, `null`]"} schema={{"type":"string","nullable":true,"description":"The key usage type of the leaf certificate (ETSI EN 319 412-2 clause 4.3.2, table 1). `A`: nonRepudiation. `B`: nonRepudiation and digitalSignature. `C`: digitalSignature. `D`: digitalSignature and keyEncipherment or keyAgreement. `E`: keyEncipherment or keyAgreement. `F`: nonRepudiation, digitalSignature and keyEncipherment or keyAgreement. `null` when the certificate has another key usage (for example with keyCertSign) or no key usage.","enum":["A","B","C","D","E","F",null],"example":"B"}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategories"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits (the list credential categories operation), without `none`. A PID certificate fits only `pid`, and a PID certificate with another key usage type fits no category.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategoriesForMdl"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits for an mDL configuration, without `none`. The rules are the same as for `fitsCredentialCategories`, but `eaa`, `qeaa` and `pub-eaa` also accept key usage Type C. A key signs an mDL configuration only when `mdlDocumentSigner` is `true` and the category of the configuration is in this list.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"mdlDocumentSigner"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the certificate has the Document Signer profile of ISO/IEC 18013-5 Table B.3 (key usage `digitalSignature` and extended key usage `1.0.18013.5.1.2`, both critical). A key signs an mDL (doctype `org.iso.18013.5.1.mDL`) only with this profile.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` when the certificate has no QcPSB statement. A key with this statement signs only the attestations under its law (`legislationIdentification`, `countryOfLegislation`) and from its authentic source (`authSourceIdentification`), ETSI TS 119 412-6 clause 8.3.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>categoryMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for a configuration that is not an mDL. `none` is always an empty list.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mdlConfigurationMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for an mDL configuration (`mso_mdoc` with doctype `org.iso.18013.5.1.mDL`) of that category. First the category rule (with key usage Type C also allowed for `eaa`, `qeaa` and `pub-eaa`), then the ISO/IEC 18013-5 Document Signer rule. `none` has only the Document Signer rule.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustedListExemption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trusted-list exemption of a key: the certificate of the key is in a trusted list, or chains to a listed CA. While the exemption applies, a rule of the signing key check that the key does not fit gives the check result `exempt` and no refusal. The exemption is bound to the leaf certificate that the key had when the exemption was set (`leafSha256`): with another leaf, `applies` is `false` and `reason` says why and what to do (`null` while it applies). `listUri` is the source of the exemption: the URL of the trusted list, or a text, for example a recorded decision. Only the platform operator sets or removes it; the API cannot change it. The other members: `listUri` (the trusted list), `service` (the service of the list), `certificateSha256` (the SHA-256 fingerprint of the certificate of the list), `match` (how the certificate of the key matched the list), `setAt` (the time, in UTC) and `setBy` (who set it). Each of them can be `null`.

</div><SchemaItem collapsible={false} name={"listUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"https://example.com/tl/eaa-providers.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"service"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"Example EAA provider"}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"leafSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"match"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"setAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"example":"2026-10-22T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"setBy"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"applies"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the key in a qualified signature creation device (QSCD). `false`, or `provider` for a key of a qualified trust service provider (key store type `csc`): the provider decides. The value comes from the key store.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trust</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The qualified status of a key of a key store of a qualified trust service provider: its leaf certificate against the EU trusted lists. The wallet checks it when the key is referenced and when the connection of the key store is tested.

</div><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","description":"`qualified`: the certificate chains to a qualified certificate authority (service type CA/QC with the status granted) on the EU trusted list, and it is a qualified certificate for electronic signatures or electronic seals whose private key is in a qualified signature or seal creation device (QSCD). `not-qualified`: the trusted lists say no. `unknown`: the installation has no EU trusted list source, a list cannot be read, or the key was not checked yet.","enum":["qualified","not-qualified","unknown"],"example":"qualified"}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the check, in UTC. `null` when the key was not checked yet.","example":"2026-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The facts that gave the result, for example the certificate authority and the trusted list, and whether the trusted list or the certificate says that the key is in a QSCD.","example":"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The number of credential definitions and presentation definitions that sign with the key. Only the list keys operation returns this member. A credential definition counts once, also when several of its configurations or its status lists use the key. The read key usage operation gives the details.

</div><SchemaItem collapsible={false} name={"credentialDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of credential definitions that sign with the key.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of presentation definitions that sign with the key.","example":1}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Creation time of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Time of the last change of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Page details of the key list.

</div><SchemaItem collapsible={false} name={"totalItems"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of keys that agree with the filters, on all pages.","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Maximum number of keys on the page.","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"offset"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of keys before this page. An offset past the end gives the last page, and this value is the offset of that page.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when there is a next page.","example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keys\": [\n    {\n      \"keyId\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n      \"name\": \"PID issuance 2026\",\n      \"keyStore\": {\n        \"id\": \"local-openbao\",\n        \"type\": \"local\",\n        \"name\": \"Local vault\"\n      },\n      \"origin\": \"created\",\n      \"algorithm\": \"ES256\",\n      \"status\": \"active\",\n      \"isDefault\": true,\n      \"jwk\": {\n        \"kty\": \"EC\",\n        \"crv\": \"P-256\",\n        \"x\": \"<base64url-x-coordinate>\",\n        \"y\": \"<base64url-y-coordinate>\",\n        \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n        \"alg\": \"ES256\",\n        \"x5c\": [\n          \"string\"\n        ],\n        \"x5t\": \"<base64url-sha1-thumbprint>\",\n        \"x5t#S256\": \"<base64url-sha256-thumbprint>\",\n        \"x5c_expiry\": \"2027-11-21T10:00:00Z\"\n      },\n      \"dids\": [\n        \"did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...\"\n      ],\n      \"hasCertificateChain\": false,\n      \"certificateSource\": null,\n      \"testCertificate\": false,\n      \"certificatePreset\": null,\n      \"certificateAssessment\": {\n        \"keyUsageType\": \"B\",\n        \"fitsCredentialCategories\": [\n          \"eaa\"\n        ],\n        \"fitsCredentialCategoriesForMdl\": [\n          \"eaa\"\n        ],\n        \"mdlDocumentSigner\": false,\n        \"qcPsb\": {\n          \"countryOfLegislation\": \"SE\",\n          \"authSourceIdentification\": \"cn=Example Register,o=Example AB,c=SE\",\n          \"legislationIdentification\": \"https://www.example.se/law/2026-123\"\n        },\n        \"categoryMessages\": {\n          \"none\": [\n            \"string\"\n          ],\n          \"pid\": [\n            \"string\"\n          ],\n          \"eaa\": [\n            \"string\"\n          ],\n          \"qeaa\": [\n            \"string\"\n          ],\n          \"pub-eaa\": [\n            \"string\"\n          ]\n        },\n        \"mdlConfigurationMessages\": {\n          \"none\": [\n            \"string\"\n          ],\n          \"pid\": [\n            \"string\"\n          ],\n          \"eaa\": [\n            \"string\"\n          ],\n          \"qeaa\": [\n            \"string\"\n          ],\n          \"pub-eaa\": [\n            \"string\"\n          ]\n        }\n      },\n      \"trustedListExemption\": {\n        \"listUri\": \"https://example.com/tl/eaa-providers.xml\",\n        \"service\": \"Example EAA provider\",\n        \"certificateSha256\": \"string\",\n        \"leafSha256\": \"string\",\n        \"match\": \"string\",\n        \"setAt\": \"2026-10-22T10:00:00Z\",\n        \"setBy\": \"string\",\n        \"applies\": true,\n        \"reason\": \"string\"\n      },\n      \"qscd\": false,\n      \"trust\": {\n        \"status\": \"qualified\",\n        \"checkedAt\": \"2026-10-21T10:00:00Z\",\n        \"detail\": \"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT).\"\n      },\n      \"usage\": {\n        \"credentialDefinitions\": 2,\n        \"presentationDefinitions\": 1\n      },\n      \"createdAt\": \"2026-10-20T10:00:00Z\",\n      \"updatedAt\": \"2026-10-20T10:00:00Z\"\n    }\n  ],\n  \"pagination\": {\n    \"totalItems\": 1,\n    \"limit\": 10,\n    \"offset\": 0,\n    \"hasNext\": false\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

A query parameter has a value that is not allowed, for example an unknown `sortBy` or `sortOrder`, a `search` text longer than 128 characters, or a `withCertificateChain` value that is not a boolean.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key store with the ID in `keyStoreId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List provider keys
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-list-provider-keys

---
id: config-digital-wallet-open-id-list-provider-keys
title: "List provider keys"
description: "Lists the keys that the provider of a key store has, so that you can sign with one of them. Give its `providerKeyRef` to the create key operation."
sidebar_label: "List provider keys"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/isEPyWALLtpEuz5ssFlbbfnbZvkYre9vTaoGGlssZZJLUnZ8ab+74ch9R4n2RZ3OBxaYLuRJXLm4bzPSHc0Ah0qnhouBe3T11wbTUwMZAEbvGDG/kqVXPEIFJEzwvAZ0UYqIDHTHtHSLdzIjIRMEM3ngqy5iYkUgDtMDEufvOQrINxoEhTUXsHmCmYBMdIyCRUwYzkTmYJiiMn/KD6KL2S6SYF8IZcFDIvuy31KXz6KL51Op/yHe4MVyxITkC9kGgOZKiY0N44CYkPKAYSRZp304Og48POFgi0L8PVNPnFE52HaWSx1QRYEu0kgIsFo8Gkyfnn+6fLg6PjT5O9nSJKsQGkuhS7ohWqTGllhcPImiou5E5yVeaZSqYEEZ5Pf3rwZTa/GjnSJMGUo4jbFglkBlK31A0AHn87Hk6lFGpDAon43uhq/+C0gYaaNXBaCznkomDu6lhCyOrs6L9n8kSnoLGDTaYi7YDcakMvOwdGxNQ48Zp2w3eERLvAXVyTMlAJhaicpOY6HTkBoR62DRqmMgtrSlHFVskiZMhwNqpJvwm4gIamCGb8lgVzrfilZ96imGaRV8Al1WLAZTAZotREIw1lSMss0KLJ31CPMkKXUZt8rueLpQBk+4yEzoAuGFREyHlpGH4W9n8gsIq/eTKydaqKARQVVctDrNcRYOikTEVFgMiXKtUc9n5zZo5Q+vQN45dghE0Iax29PSKL4PDboqPYONx6RiuCKmcxEtE+4tr+cCknCtfmrvZImLqyIKfCddLk2JGRJglqEZEaWmTZkLdXCI5BocBuLCEBmjCfaJyMWxtUREWnMtLWDNLtJeGhvcUGCz+tFQPZmUjlVebkzlWvysybAZnVd7PskSLhYQBRYAQYL2IyjgOhYrsk6BpEHvny7VHMmuHYQWYJi2RAFM1AgQtBNhdi4cUaCRIYsCZrxkwjZWKj9j4J6tDz/OKJ9Gkox4/Mhn3PDkvcsScBcpCDGEQbsyyoIaurRlCm2BANK0/6Hu1aAfyv47xkQbjU/4y6iN1Tv5zA7MgVxw2TgFTciZtgN0xCg7vN7sV4GBGVdzwo5SS60YUliT1HTbI133RaL0J+TKNXvDBkin3qU4xEw7FGPYnymfbqAzQR3jCPqUQW/Z1xBRPtGZeBRHcawZLR/R9F9aJ9qgzGWenTJbl+DmJuY9o8Ptx6FW7ZME1zSODzdXiNVnUqhQSOhg14P/zSlilatQa14CCXeKou23BMPEkphQBikxNI0QQPkUnQ/ayR3dx+3vPkMoUHlKpSM4Q5MWtd8tZopxTbU2wHyITzcwFLv4me4sVKp2dg9wq248kit8I1FAD6rigpu/McEcQWzXQpvQr4qHLVu/i38PnmBdu7SmYsiD9YEdmVREuQR59HsTPZQAChk3T3Jr067aHuIUHdPisvT7gI2V1zMdfckvzrtOnqodXuzduNdXml0T3JGp8F+Dq8oBLzywDZ9u2et7F2t2ZFwyV5wYpe9VYmFp7snKJnTHUxtUvZq+baVVIuMUeXnPZuKT2z0Pa3HltLA1jb+5ZYSFZyqWD8eFlya+RnNpvLzvBCxh35Gtx5lyVwqbuLlLvMRWZJgJVNElqY5TfhcMJMpICWR2kGbfEeTg6Nj5Pd5vdjlcY9zmu7MZY20yAX5dXJxTt7DDXkFG7L36/tX+yjHJTN9EizMBkN6qFb45xb/hzdsymPJPHC5rkF1zleAqdYnY1OkrGDBo6Bf14dbVSgX7UWuRZlGLVXsEMocaQm++No07ZMAJfQwTCHzSrOihQpgUWTtiyWXtcjhRNyMJQuzeTqAoGBxhatoVizBpKqxqg5a6h6grkO1eprmKEnwOsT6d1XPk20m9nwtPvYesrp9mtE/SSilirjASJvLGZrMU8mFK8kx4x8fZirJTajJ9qR83LntVFRPEcmfEONv/xUkmzYSlsyfxvINTrzdetTVjDXyN1ImwMR9+rFcaxKgyQXfVFBy3awo64hmLNGw9aj1tq8PYEXPtAuLjbuPAmm4ZFlEo6VaWE1LxaXoEZVLf30UbEWNGq0HIn+BELNJ1ZbYnsqFvjKa/GM6uawiST3w3Cs6dGbRDs+ftq0h14aLecZ1DFGjjKhjzwk2TW1w/vPI/SAXdbWc/eJdPPhk8PNkhIbPtc5A/ecQOnoPArTCG5zVgOGdEo0GxVlyni1vQP0Jf7SribDLd4Bpojhkz2d/CZHLiiU8eqHkt+Rxw5SpphIJj7jZPMn6oHdw3Ok96/SeTXu9vv3vXyWQqfx6GCMRfQuIn3aBqE8bnmwRBjVVhzHjwnP5d8aVNnkLjq0C+jbL4zEBEcoIIjIcXbXhtduKBzR9IeBJYtutjbZVh/ehXfTXKzhXXZXBuYiLzbBz/RhFnT+OgUW2lb7DX4eu+/vT7VudOCgl1UBGgHrD62FNCNfeE61etbsSJxcG5qDqdnDY6213kN+hgsp0fsGJjkgzQ8rRQSHu3VnC9XN2chpJcJMfO9RpzDHIXj7v2LfDokappmCW6bxHRhmBtlGvLexn37Gw3wqWmVgq/oc14LZoDr9j0UzbJUrek1S2mY9bucZx6j3pHX3XXjwWBpRgiZ1YgSKWzQ4ZPf+OZTRtzbGaw/F82M1WjNss3rYwW+qEmeLYSX64o2cpx7lZ/8M1jhMNm+NklubTXOLGuWTPDnSHh+8G+9Sz/eUbJtgclij+a48uwcQSZ8FzsDLDKWifdlcHXTcc7kaOXse1412cYPIIxzOdZUnI/rSH0N27anS67RaHxXEIDpGdbeyaIA9hKXPToR7NVEL7NDYm1f1uN4Kl7LCU+3yumDA+l3TrtQlcKhllofXbB8g8RWFi2BzfIT2wXbvHbSDXlVYmaLbO2grdVJWRu5EPm51aq3HzWR6TrRvcn4Rejt0kMTMxdh7OW+rte25LQYNOQBwb9yLkBvKXUhC5OBY4jCTANzHGDdGNYjyxMkhZCPseAX/ut8j2Sb7xZCMzheJA7Z4GWEzh8Way8HAWWg+HJeMoSJ2lqVTmb5XwyvPzl9WtptTrCmuJpdxU+BRWj6FEp8SeAv+icbpYnkvIeYNt2N6B4jOOjkYGtXdWY60zhnOkvQvrNuN928nt3nipQJcsSle73EdERoYS3zBNMV+gCt1LS53nGCdMjUNo2/54JJZJ5NrGFXLYkNz1Gq/UMm3VY5iImIp0x56XM2HILMFBgFVtLmmL9v3zAXk3wHHddN8j49H0BZkMO7++n5J3A8dtPLkgz37qPXveOSLLoQy7y+Hr+qtDNxbRvi18QxDahtDCclMWxkAO/N491a3Xa5/Zx75U826+V3dfjwej88mog3u21buASp0orEiGWak96tF8BOxakkP/uW+Hq6nUZslEDc/rewVj251q2efHhwk/Pkz48WHCjw8TfnyY8D//MCEvkwzcmm6aMC4wvNt8cpcXpR/o6sC9455xO+xpFKbu2wbB86lMrTjNb7jylHq033i336xQrz0aS22Q2d0dzo7eqmS7xdu/Z6BsrY0DOMXdlA2rWK6tx+ez8kdyzd5V3svsk//vzyV2qqoocwXWuLYopX3qRN/8nGJ7XY6/rADdgrMwhNTUtt5rC7f1ZuXlaIqDuQztol5iL2yJnV8g9Z2w2tV2idE2BTu3nGBN8go2p+Vy9+TBDWWF71ajkHDy929JT0re
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List provider keys</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/key-stores/{keyStoreId}/provider-keys"}></MethodEndpoint>



Lists the keys that the provider of a key store has, so that you can sign with one of them. Give its `providerKeyRef` to the create key operation.

| Type | Provider keys | `providerKeyRef` |
|---|---|---|
| `vault` | The Transit keys of type `ecdsa-p256`. | The name of the Transit key. |
| `gcp-kms` | The enabled `EC_SIGN_P256_SHA256` versions of the crypto keys of the key ring with the purpose `ASYMMETRIC_SIGN`. | The path of the crypto key version. |
| `aws-kms` | The enabled `ECC_NIST_P256` `SIGN_VERIFY` customer keys of the region. | The key ARN. |
| `azure-key-vault` | The enabled EC P-256 signing keys of the vault, in their current version. | The key ID with its version. |
| `dpod` | The key pairs of the partition with the label prefix `ows:`. | The label of the key pair. |
| `csc` | The CSC credentials of the user (50 at most), with their certificates. | The credential ID. |

The cloud KMS types read at most 200 keys of the provider and return at most 50. A key that the credentials of the key store cannot read (no right to read it, or not found) is not in the list; the other keys are. The list call itself must work, else the operation fails. Each provider key has its public key in `jwk` (for `csc`, the public key of the leaf certificate). `linked` and `keyId` show when a key of the organisation already references the provider key. A `local` key store has no provider keys.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else the identifier that the create key store operation returned.","in":"path","name":"keyStoreId","required":true,"schema":{"type":"string","maxLength":64},"example":"local-openbao"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the keys of the provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>providerKeys</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The keys of the provider.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"providerKeyRef"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference of the key at the provider. For `vault`, the name of the Transit key. For `gcp-kms`, the path of the crypto key version (`projects/<project>/locations/<location>/keyRings/<keyRing>/cryptoKeys/<key>/cryptoKeyVersions/<version>`). For `aws-kms`, the key ARN. For `azure-key-vault`, the key ID with its version (`<vaultUrl>/keys/<name>/<version>`). For `dpod`, the label of the key pair in the partition (`ows:<keyId>` for a key that the wallet created). For `csc`, the ID of the CSC credential.","example":"signing-key-1"}}></SchemaItem><SchemaItem collapsible={false} name={"algorithm"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Signature algorithm of the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The public key of the provider key in JSON Web Key (JWK) format: `kty`, `crv`, `x`, `y`, and `alg` when the provider gives it. It has no `kid`: the wallet gives the key its own `keyId` when you reference it. For `csc`, the public key of the leaf certificate. `null` when the provider gives no P-256 public key.

</div><SchemaItem collapsible={false} name={"kty"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type. The value is `EC`.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve identifier. The value is `P-256`.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm of the key.","example":"ES256"}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"The public key of the provider key in JSON Web Key (JWK) format: `kty`, `crv`, `x`, `y`, and `alg` when the provider gives it. It has no `kid`: the wallet gives the key its own `keyId` when you reference it. For `csc`, the public key of the leaf certificate. `null` when the provider gives no P-256 public key.","additionalProperties":true,"properties":{"kty":{"type":"string","description":"Key type. The value is `EC`.","example":"EC"},"crv":{"type":"string","description":"Elliptic curve identifier. The value is `P-256`.","example":"P-256"},"x":{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"},"y":{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"},"alg":{"type":"string","description":"Signature algorithm of the key.","example":"ES256"}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"linked"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when a key of the organisation already references this provider key.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The key of the organisation that references this provider key. `null` when `linked` is `false`.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>certificate</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For `csc`, the certificate of the CSC credential. `null` for the other types, and when the QTSP gives no certificate.

</div><SchemaItem collapsible={false} name={"subjectDN"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Distinguished name of the certificate subject.","example":"CN=Example Organisation AB,O=Example Organisation AB,C=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"issuerDN"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Distinguished name of the certificate issuer.","example":"CN=Example QTSP CA,O=Example QTSP,C=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Serial number of the certificate.","example":"4a3f9c"}}></SchemaItem><SchemaItem collapsible={false} name={"validFrom"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Start of the validity of the certificate.","example":"2026-01-01T00:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"validTo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"End of the validity of the certificate.","example":"2028-01-01T00:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"certificates"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Certificate chain, leaf first. Each item is a base64 encoded DER certificate.","items":{"type":"string","description":"One base64 encoded DER certificate."}}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"providerKeys\": [\n    {\n      \"providerKeyRef\": \"signing-key-1\",\n      \"algorithm\": \"ES256\",\n      \"jwk\": {\n        \"kty\": \"EC\",\n        \"crv\": \"P-256\",\n        \"x\": \"<base64url-x-coordinate>\",\n        \"y\": \"<base64url-y-coordinate>\",\n        \"alg\": \"ES256\"\n      },\n      \"linked\": false,\n      \"keyId\": null,\n      \"certificate\": {\n        \"subjectDN\": \"CN=Example Organisation AB,O=Example Organisation AB,C=SE\",\n        \"issuerDN\": \"CN=Example QTSP CA,O=Example QTSP,C=SE\",\n        \"serialNumber\": \"4a3f9c\",\n        \"validFrom\": \"2026-01-01T00:00:00Z\",\n        \"validTo\": \"2028-01-01T00:00:00Z\",\n        \"certificates\": [\n          \"string\"\n        ]\n      }\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The key store type does not list provider keys (`local`), or the provider refused the request.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key store with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The provider of the key store is not available.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Create presentation definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition

---
id: config-digital-wallet-open-id-presentation-definition
title: "Create presentation definition"
description: "Creates a presentation definition. The presentation definition gives the credential types and the claims that the verifier needs for an OpenID4VP verification."
sidebar_label: "Create presentation definition"
hide_title: true
hide_table_of_contents: true
api: eJztPWtz27ayfwXDL0l8KdlOm/PQPXPmOpZPqyaNXTtpbqfJSDAJSWgogAFAK2rG//3M7oIkSFGSm7rTR/QlsUg8FvvCYrG7/BilwiZG5k5qFQ2iUyO4E5ZxlhthhXIcXrBUTKWS8GefvZyLTS/ZTN4Iy9xcsMSIVCgnecbcKocRVUovMi4X0IY7/H0jjJxKYZgSIrVsqg3jip3nQo2GX35/4d8nOFX/jXqjvpI3oj2FEe8LacRCKGcZB/CHciYdz9hp1ciy7wphVuw5V7OCzwR7ODz97vkj9h6fSsUmafI+wzYTWmUFmrQBQMf9I1wMTxKRO8tgFBxECsu0ylYI5TYs8cxqNtdZSqhyhiuba+OYFc5JNfPYETcAWLh+XKewjkk1F0Y6O2ATI2yulRXf6lRMYjZJMimUG6VXyVws8EmanOTyknq+XOX4THzIReJEem7kTCo7wRVNhErMKncivfSDnqnke54Vwl4VOUAo0kmfPdVuzg4OhtKIxLELbd3BAXs4SfH3ONfW4az1z/5PSzd5hFMcHAxP2cnFiHokY55LAhH+8u3KFbGFToFxjGD8hsuMX2cCcXtZZCLgICvMjTCM53kmhR28UT02yfi1yCZAuAVXKXfarHD+RWEduxbsC+Y0Oz46YsmcG544YSzLtJr1w97YWGnswBk+pFm5YuKDE8oSTRAAGyPvig98kWeCPTiZCfZ9QLsHMXsw1EkBPMqu5ExJNXvAtGEPnim97P2gC9M7LazTC2HYw2c/nD56QMDUXNlcznIuVE1+JCw0mNzkY6ffCTWBwSepuJGJGJfNJn021LgmK1TKpNs4jEz9MAjFGU/mTChnVkxPA5j6tRDaiRdhrqA3sRRnk6k2C+68SJW/WKKVMzqzbDmXyZxNFsLxCXsnVrZBU5KxAZssrB4vUp1MmOPvhGWTVCegWMY3wJ8TFDxkpP+xaQ/4qGx3kzhqYwkhdSc7iYntf1q68U0y/slqVXULm5FUE/w31QQxoLqaLRhowmiRFsdiSgerY8A9WdZnJ2rFtJsLg0+lZUZMCytSojkqybEVrkYqU1r1xCJ3K/8ahNYYjqoLUcYXDZ2Ieu2uxNs8l8atoZzMsyTKNkj+paC/XxmJbMOzTC9FihhrsRYqKGStUFMQWj25CQcW2HKKzNvSITT7XbTUNlHpBKRPJC13qUr1zzJ9zTNg16mcFYbUMCqGXJiFdLW28mDRNtXrULt3xw/pRZLfWjP61bc19/pKYQHlTgF8jINaOVOovsMhYVfiRQasqqsmxMslEI0WhSqHQVhw5+IJrHnIHR9WW1y13g7Iqv1yxbh953d8dsFXqBlf8ywTjp04JyztnDHj7Luzq5PTkLnJSrg6PWG8blltvBNp9fE/jo6/GP99zJUSH8bJBEiK+nrOLVtoI5iBbWTQ1n3lDrGmOWNYb2HdiUrm2gQNPzw5+mfHzls3UEWWUfet6Crb82uwGro2aWwBhgM7OBAfeOKyFdNKHBwwjU1ibzO0tQB1LKwI9ehSujnoZ9BN/aY2jbepG+QOb3CNkeX1zPB8LpMxgCbM+FqqVKrZBOwZZBtncFAPHIzGcu7mwXrcUjORkQHntfKacqKngWYEywC2Mi9U/TcqiiOdC5LSURoNIpJbbwwSb6Ell14EtllNiCiOvOA81ekqGnyM/ELTaACLiFvm8nOwCeLNlihok3XrTk9REJRYbrSyoxhAd0I5AAJNGzIjDmGXgmcWuIzjW7U6n0aDHz9GQMJoEOnrn0Tiojhy0mXwYEgyzB7yLGNTKbLUPvJLpbX9GKF1E729jTePMjp7+R92Nex98/ol+/40auPiYoO1SxZTJemKNccJkedZstYQ/U+A8uqcoez3nrDFUCeHi+HzXwFrazRQPIvh8/sG+vUXp4CKh9+8fvnoU4FlfhCpGGCWbJC7Q/f2No688WqBq86evj4fDVmvRS54hUoC/qC+g+isMDoXXLGnhZVKWFuq8fOlEoaNhuwhDQeLa6iMZ2I1QkTCZhsNoo73/8GFRIMolengnVhFceRVeTQo/xofHUdxZBON6MUV1jodmnmbGIZvaOloEBlvwowLI4OesB3jpJWJAIQpTSdYfWD6ovRJUDjPxYxnvQthrFa9cmkkuj1Q+r3nF6NhFEfTalWlQRnFEahiRHBlswKFcEgasTkgjAd8FZGCRiBAr0InWWMVOa98nsFgL/hCAMkrTtiqx0vVtygyJ3Pg1ynPrLh9e3t7Gwd80iV4vx+3wK78F2OVcu8OOKWxb4NmMbO+tLqPhOg/6R/3s1ymUTePrDWO4o1809X2t+Olhj7ca5z7ZaPguBtwUnDgjQY/7tQ6G9RODeFVUW5ym1iqq+1vqJ6aVsdD8kPF6IoR6a/lsnK8arg/HdfhcQ8ZrnlsjQYRnfkisA8aBxIg4ty53A4OD8sDc9/bEP1EL6K3+x3zU1jylT9l3xtT1gP+ldiydEbs7bJP4DI4I9y78oMp7kEB/g6mW+USu38NeAd3JQxzcvz4H6dPT3tfXz1+8rcoxt9fnX4Lfz1+8jf4a69NP5nP712jwiT3olX/eLweqNU96/5+R+c/soX6ezHtn8I8/XxO6dvZ9o9pxf6xWPe3NWH3nLi3dPeW7l4cOsRhbxD/FQ3iz4fDwwuCvaX8J7WUP8+LiG7W3VvLv7e1vOfGvcW8t5j3IrFFJPZW81/Rav6MuPwWOb2kJMb5PT46wnNCI+QwiMlPMCOMouLvI1q1HQKZg9AYJwmavDssd2c/oHzVxjoDeGjHUY6UE0ZhjG6iTcpqOpQRuVtz3jJpHRMqzbVUEPbvCqMoWQW5BFMrusEfpRM2F0bQOITQmBnBU4wQLvKUO1ENbf3YjLNUTqfCQFi8LGGvge6zk2zJV5biujfP7DTjaWpAH22l4S3GTqtRem5mXElbBVHvxOsaHstkuVOWijzTFNmP4ap6iTiTdiscmxazG5ZXSr4vREjadpqYT1HU2wn+ygoCMxhJAkk60/GAij4LB+PaPRqAwnFJXmiTikyElMbF+u1j18q+LhZc9WBIyIMLs9HqpMu8MLm2gubfjONWphpmqa3YhTYOh66y1E6OHxDLptzOrzU3KbNzvfQERAhwBQ2d3JZTnqY4Kc8uAontCqb/pSmbrcUHm8HuZFMKmzZ6gY9JgVbpIzQ8JWjyMBGhyoIKU6ogn8SnvMVBvptPf6NfPZuLBPimTAUj9AzW0tgw7anK0Yi3p6/5JKkgIw1TJNabhAlukHrmIU94kItapXnEjSSL+I65HjGblBuOz9TAZBmRjnnh5tpIoDtMzpzOe5m4EVlXigdmmABcM6OLvJ3m67NsK0J5kc4EJyZAlkcmWzFduDrnaFMmLtBO6TA6/o0Cjt6aqbNbVqEVCmE9DEu5421GbKkRwKUliSPsUoIMz3Ojfc7z2ojXYgq5TPBuSdYmJHauq3qf0Yw7lRWZSBy1+ebq/AVDk4+vqUrMxXMaeknUYfCuncU0KbVd15L67BJ2uclXZy/Z4c3jQ0rHOUxJ0nsE8SFsOzI9tOlPS3cYDN+DFfZqcnl2RggJYj1lAiQRyFFxBS1SolRSBhORaTc7IAGAIdpoptQioYoFGGpgfVC62hhe1j/BYNMzqcZG2nfjYJCNL8ZKq7Gzx49BUyaJLpQbQ9KrtTAfZc8J4C/u+JjPjMDMojFZMOXzVNok07YwoqvJe2EJTDRRyZo7cQETq2JxLUzXVvqBObmA7LpFHsMGZ0WiVWrjkuQLXe/srstk3LHP09b4G0OTcesgzVvN7gJSdYLaJeNk4yBDUpo37p1hro5lD6uqAY+q9EMP7AlpxZ8JiMtSXCb1uW2yVnag353YKEmS60ufv7MTeMdOQRtOZSZin2VdJQthKlO4YeobQYLVtQmfXIz6Afs3jpbrAHk+23yQ3YXZZ5AQvWZTQpo0klaixZuCYoITJr6soUUibjom75qZ2pUzWkrSh5mbFtPEh8LSjozpn/0R5vdZNtfLwKSA7GCdlRYKLcqtmhoTLPlOulIyth8/wH8diIunfkC3P+Dv5FngOva4f8Swg9eUlD2GT3rXHFDbEJBKlf863UrmlNI0EZKp6Yu4O/BVyrUr99ltAlWVQwhS5TZIbD8oe9BIA/TCfqqVgpoXoyF7CY3661nCG7MHh9iw9IDQkYHqhZCN1sEBDaGrHTUliIihxuw+oq3px9mF11NsD2vCTXUXQtuMXhdJKUUW8vetyKblIcvbJX5Yb2uDWVm7lyZka3BWPmSvLkdYRCStXg1Hwxj1I043DvK+qybfl7AE6ePkuUMpGluuximYEWTZzAW7OnnBhi+umOK0cK7Y//efHP2TJXBSQXNGeLMaR5hzOw+6w89N3frsNeReUso7evuahU3iNgpKduAMbIWkcdhHEDDXGU6VWY0nx81MuEYVhY3m8F34rOX0S2VKbsU1pHv1U+K0/AkYQTbsrBFxhwP85ajewbs4h4G1aBmfOuA5xyBPynYyLCG7z85LGUPzNSw+0aRIZymKJhY7q1IQf0hXniYWguO+UU7ZSf27UezuWvXV5aihU8lLuwvblyFMhPeGcHcSIBWZBBtgK9Ib9YEGBwctxNdUq9CCJsjXL19e9NdR3NWejt2VbxnkvF/VF6IZfQmLSlzBs7/BwEEahk69ah7IoAZafPP6LKzx0ayjUU3xi4fHalXfvD5r7vCNFMAmMtDdXl2SVk54lLk1N/wuBvCFiBo7acWvXuO35McjNSgSQiho83dVTgTkocsHA++7majcu6tyI5vHqA675SG67HPfAoaWT0ik6nqjuumgFPrWJWBFAfRtrFs11G5N55XVxbxxhhOsUeZ+V0g1RGCJ0omFXWceuDu4013OjjWDJPn7gkCiGM9m4CeadzvsAnxs0zsjVxYCK82PdWXS4NT/Ddma3k8zvWRyprShWkToySNfO09vYIcHaZ/4+ykvCv6OanKPzqmSMBViwrJ0Ld+Rg9GmPMssu+bJO/T6Z+AgNkIEmCVHxgb61rx9h6s4YAa7sk4svuWKzxpkv9Y6E1ytEZ4KwQQrz7gDB+kdrgXYD7oAxyDYQN6NzhnND0WGAICt53qs1wa/zhSY/b8U2kbFt9Aw2A2t9//bAg7gm13ywESrtTUutC2330WfvdDeCWdzkWWgt2tPv+csMGS33KH8Og893IEmq43lbsAQ3sjNZeE8siEa9R0Rqd5p1DpmUu0kOn1j9aCtwyNhGmUcAzpgMaIQV/2ILkPrWiho7G68fCqvana5h+PoHQ5Eh/LWMTd0wYUOsA2Xb20Z62Dkt+1VbKA8RTnMBU+FAeGHX1/S5e+dL2/DaYQx2pyCmRnT38OAV97GOy5s6941R8Il5wx9f97TEg2+PDq67Ri+S3WVXaKnHG7j8sKxnBu+EE6YyN98r99yX+sUy+8Bh6CfGz3icaOCpLQWZc3A9ZdxdKmo2BdB8chGh7vUiuwoD5dqQXCgE5cq96yV9+ws/+YB3GIrxNuK9oFkbDjZ3L3YXgDD+o7rN+3tVfWq9W+urBe3K8iFlNtdYW0NV2vXKbVqo6l0II7oeVTvlF56OPw1RmmyBXfdHizv/UvjEgGtHr7m467YirbMHn/GMvtK+fvEn1EbNlHz5LNWZ1V8i7c8cZoWjsBoE0lhpFthnNJJLp8J+BPDixyfYdhieYj18WvVNcYpxKiVTjZAykK4uYagK39UpVCm6I5XfSHLB9d8sOnhCiiUqhUkIBbaLxD2TwOBd2WUZSoWugdWvJwZrlxf6gjiq9rV1HRakMRvGGbXCFeOz0CFbOhu6XUbkLc15skzi3xT4r8+MdGDOJIwFZEuiiMw66JB1Dj1rBmsoO+xxmwBpwFXFs0OLCp/wp80xoHgJF7dNl+jKprKDyL1WxDByCbsoSrtT2e4RPvT5jwRj2Im+rN+a9gB8x3/tYLaxjyXvXdi9e8JmV0gjJd1qcWzkt3rcMraY7Ez5K9q+gtSw30fL9lhpF/5BqINW9kz5UG4EevXBMFH84Hd+jaOqmHxNzBBHVvRnuzTgvvod0ewRVgRsoJuff23BFUzEgP7+sq/G8D0FTGxbuCOcIn2bfmGKNWtwa/VCu5Qn6YMd636fHrQ6wYv9vrQG4p3/aJo8ZolPyliFigh1VSXWyBPcAsUCy5Rnqjn/9U6qVIr8qv6UVOZhXqwpW2qTnCgupFYqp0lGsTYCSbh/0Vl0DQCA9uX5qGvdGRtwVUi2MNz3HFGVDd+921747I9N9rpRGfoZpfkgRV4XrLepPvZX9E7zaS1hYjR3ULH8BsKiCuNtfCevEDj0ToIzDCp7eF6JVcOnUaWNKbHNEIbBpPHrRolNFtnsmZwxPbFxMEQzGQi4Jpv8LHaEHKezAXciq6Rbrlc9jm+7mszO/R97eHz0enZi6uzHvS5rUuQ1uQEZKU+BrDcaGqRfXz0+Mv+F/1j9DFo6xZcBfDQ9yM2GbPtHSsw1fZfnth/eWL/5Yn9lyf2X57Yf3li/+WJ/Zcn9l+e2H954k/25Ql/1nbigzvMMy4xkwBt8jrH7+Yx5cpNJXo2Gs4xfwdEd0cp+S42ucjextEczpiDH6OPHyFo85XJbm/h8XvylPyIzgeD5yR075V+QDzawzl5EJ2S8d3zF1Olk2PNZwouMOpxgrvi1rahV/Di/OplFEfX/lsaCzojG76EgzNfRoPoTfQmwnV7V8NHeg5eILKVIT8TxwWnEXg3mr4yOvD7PwKHB1erAMq224wWA/8GH2VodvkXnIKeidW/q+b0ZmOHylVHrYH6cOP2X2WaPz8=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Create presentation definition</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/presentation-definition"}></MethodEndpoint>



Creates a presentation definition. The presentation definition gives the credential types and the claims that the verifier needs for an OpenID4VP verification.

Give the credential requirements as a Digital Credentials Query Language (DCQL) query in `dcqlQuery`. The verifier is OpenID4VP 1.0 and accepts DCQL queries only.

The presentation definition also holds the transport settings that every verification request inherits: `responseMode`, `clientIdScheme`, `dcApiRequestType`, `expectedOrigins` and `encryptedResponseEncValuesSupported`. Both **Direct Post** (`direct_post`, `direct_post.jwt`) and **DC API** (`dc_api`, `dc_api.jwt`) response modes are available.

Rules that the server applies:
- `label` is mandatory and must be 3 to 100 characters long.
- `label` must not be a label that an extension reserves, for example 'Age Verification', 'Document Signing' or 'Know-Your-Customer (KYC)'.
- `dcqlQuery` is mandatory when `responseType` is `vp_token` or `device_response`. Do not send it when `responseType` is `id_token`.
- Each entry of `dcqlQuery.credentials` needs an `id` and a `format`. The `format` controls which `meta` keys the server accepts: `mso_mdoc` takes `doctype_value` only, `dc+sd-jwt` takes `vct_values` or `type_values`, and `jwt_vc_json` takes `type_values` only. The `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc` formats take no `meta` key at all. Any other key is refused.
- `claim_sets` needs a non-empty `claims` array in the same credential query.
- Each entry of `dcqlQuery.credential_sets` needs a non-empty `options` array.
- `directPostRedirectUri` is allowed only when `responseMode` is `direct_post`. The server refuses it for `direct_post.jwt`.
- `encryptedResponseEncValuesSupported` is mandatory when `responseMode` is `direct_post.jwt`, and the verifier global configuration must permit response encryption.
- `dcApiRequestType` is allowed only when `responseMode` is `dc_api` or `dc_api.jwt`.
- `expectedOrigins` is mandatory when the request type is `signed`. `dc_api.jwt` defaults to `signed` and `dc_api` defaults to `unsigned`.
- `transactionDataDefinitionType` is mandatory when the DCQL query asks for a Payment Wallet Attestation, a QESAC credential or an SCA attestation.

The `iso18013_7_annex_c` version has more rules: `responseType` must be `device_response`, `trustAnchor` must be `x509`, `clientIdScheme` must be `null`, `transactionDataDefinitionType` must be absent, `expectedOrigins` must hold **exactly one** origin, every credential query must use `mso_mdoc` with a `meta.doctype_value`, a non-empty `claims` array and `require_cryptographic_holder_binding` set to `true`, every claim path must hold two elements, and `credential_sets` and `claim_sets` are not allowed.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Label, credential requirements and transport settings of the new presentation definition.

</div></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"Default (all fields)"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 3 characters` and `<= 100 characters`"} schema={{"type":"string","minLength":3,"maxLength":100,"description":"Human-readable label that gives the purpose of this presentation definition, for example 'Verify Portable Document A1'. The dashboard shows this label. The label must be 3 to 100 characters long. Labels that extensions reserve are refused, for example 'Age Verification', 'Document Signing' and 'Know-Your-Customer (KYC)'."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder. This is the only way to give the credential requirements.

The query holds a `credentials` array. Each entry needs an `id` and a `format`. The `format` controls which `meta` keys the server accepts. Each entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.

`dcqlQuery` is mandatory when `responseType` is `vp_token` or `device_response`. Do not send it when `responseType` is `id_token`.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

**Possible values:** `>= 1`

</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential queries. The wallet of the holder must satisfy every entry, unless `credential_sets` says otherwise.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of this credential query. `credential_sets` and the presentation response use this value. Use only letters, digits, `_` and `-`. Do not use spaces. The server does not apply this check to the `iso18013_7_annex_c` version."}}></SchemaItem><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dc+sd-jwt`, `vc+sd-jwt`, `vp+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format that the verifier accepts for this query.","enum":["dc+sd-jwt","vc+sd-jwt","vp+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>meta</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Format-specific match rules. The server refuses any key that the `format` does not allow:

- `mso_mdoc` - `doctype_value` only.
- `dc+sd-jwt` - `vct_values` or `type_values`.
- `jwt_vc_json` - `type_values` only. `vct_values` is refused.
- `vc+sd-jwt`, `vp+sd-jwt`, `jwt_vc` - no key is allowed. Leave `meta` out.


</div><SchemaItem collapsible={false} name={"vct_values"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Accepted `vct` values of the SD-JWT VC. Use this property with the `dc+sd-jwt` format only.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"type_values"} required={false} schemaName={"array[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Accepted type sets of the credential. Each entry is an array of type names, and the credential must hold every type of at least one entry. Use this property with the `dc+sd-jwt` and `jwt_vc_json` formats only.","items":{"type":"array","items":{"type":"string"}}}}></SchemaItem><SchemaItem collapsible={false} name={"doctype_value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Accepted `docType` of the mDoc, for example `org.iso.18013.5.1.mDL`. Use this property with `mso_mdoc` only."}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Format-specific match rules. The server refuses any key that the `format` does not allow:\n\n- `mso_mdoc` - `doctype_value` only.\n- `dc+sd-jwt` - `vct_values` or `type_values`.\n- `jwt_vc_json` - `type_values` only. `vct_values` is refused.\n- `vc+sd-jwt`, `vp+sd-jwt`, `jwt_vc` - no key is allowed. Leave `meta` out.\n","properties":{"vct_values":{"type":"array","description":"Accepted `vct` values of the SD-JWT VC. Use this property with the `dc+sd-jwt` format only.","items":{"type":"string"}},"type_values":{"type":"array","description":"Accepted type sets of the credential. Each entry is an array of type names, and the credential must hold every type of at least one entry. Use this property with the `dc+sd-jwt` and `jwt_vc_json` formats only.","items":{"type":"array","items":{"type":"string"}}},"doctype_value":{"type":"string","description":"Accepted `docType` of the mDoc, for example `org.iso.18013.5.1.mDL`. Use this property with `mso_mdoc` only."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims that the verifier asks for. Leave this property out to ask for the whole credential.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of this claim query. `claim_sets` uses this value. Give an `id` to every claim when you use `claim_sets`."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Pointer to the claim inside the credential. Each element is a property name, or an array index. For `mso_mdoc` the path holds two elements: the namespace and the data element, for example `['org.iso.18013.5.1', 'family_name']`. For `jwt_vc_json` the path starts with `credentialSubject`.","items":{}}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Values that the claim must hold. Leave this property out to accept every value.","items":{}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"claim_sets"} required={false} schemaName={"array[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Alternative sets of claims. Each entry is an array of claim `id` values, and the wallet satisfies the first entry that it can. Send this property only together with a non-empty `claims` array.","items":{"type":"array","items":{"type":"string"}}}}></SchemaItem><SchemaItem collapsible={false} name={"require_cryptographic_holder_binding"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the credential must prove that the holder owns it."}}></SchemaItem><SchemaItem collapsible={false} name={"multiple"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet can return more than one credential for this query."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trusted_authorities</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Issuers that the verifier trusts for this query.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the trust list, for example `etsi_tl` for an ETSI trusted list or `aki` for an authority key identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Identifiers of the trusted issuers.","items":{"type":"string"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential_sets</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Groups of credential queries. Each entry gives the combinations of credential query identifiers that satisfy the request.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"options"} required={true} schemaName={"array[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","minItems":1,"description":"Accepted combinations. Each entry is an array of credential query identifiers. This property is mandatory, and it must hold at least one combination.","items":{"type":"array","items":{"type":"string"}}}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet must satisfy one of the `options`."}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Reason why the verifier asks for this group of credentials. The server accepts a string, a number or an object here."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder. This is the only way to give the credential requirements.\n\nThe query holds a `credentials` array. Each entry needs an `id` and a `format`. The `format` controls which `meta` keys the server accepts. Each entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.\n\n`dcqlQuery` is mandatory when `responseType` is `vp_token` or `device_response`. Do not send it when `responseType` is `id_token`.\n","properties":{"credentials":{"type":"array","minItems":1,"description":"Credential queries. The wallet of the holder must satisfy every entry, unless `credential_sets` says otherwise.","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"Identifier of this credential query. `credential_sets` and the presentation response use this value. Use only letters, digits, `_` and `-`. Do not use spaces. The server does not apply this check to the `iso18013_7_annex_c` version."},"format":{"type":"string","description":"Credential format that the verifier accepts for this query.","enum":["dc+sd-jwt","vc+sd-jwt","vp+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"]},"meta":{"type":"object","additionalProperties":true,"description":"Format-specific match rules. The server refuses any key that the `format` does not allow:\n\n- `mso_mdoc` - `doctype_value` only.\n- `dc+sd-jwt` - `vct_values` or `type_values`.\n- `jwt_vc_json` - `type_values` only. `vct_values` is refused.\n- `vc+sd-jwt`, `vp+sd-jwt`, `jwt_vc` - no key is allowed. Leave `meta` out.\n","properties":{"vct_values":{"type":"array","description":"Accepted `vct` values of the SD-JWT VC. Use this property with the `dc+sd-jwt` format only.","items":{"type":"string"}},"type_values":{"type":"array","description":"Accepted type sets of the credential. Each entry is an array of type names, and the credential must hold every type of at least one entry. Use this property with the `dc+sd-jwt` and `jwt_vc_json` formats only.","items":{"type":"array","items":{"type":"string"}}},"doctype_value":{"type":"string","description":"Accepted `docType` of the mDoc, for example `org.iso.18013.5.1.mDL`. Use this property with `mso_mdoc` only."}}},"claims":{"type":"array","description":"Claims that the verifier asks for. Leave this property out to ask for the whole credential.","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"Identifier of this claim query. `claim_sets` uses this value. Give an `id` to every claim when you use `claim_sets`."},"path":{"type":"array","description":"Pointer to the claim inside the credential. Each element is a property name, or an array index. For `mso_mdoc` the path holds two elements: the namespace and the data element, for example `['org.iso.18013.5.1', 'family_name']`. For `jwt_vc_json` the path starts with `credentialSubject`.","items":{}},"values":{"type":"array","description":"Values that the claim must hold. Leave this property out to accept every value.","items":{}}}}},"claim_sets":{"type":"array","description":"Alternative sets of claims. Each entry is an array of claim `id` values, and the wallet satisfies the first entry that it can. Send this property only together with a non-empty `claims` array.","items":{"type":"array","items":{"type":"string"}}},"require_cryptographic_holder_binding":{"type":"boolean","description":"`true` when the credential must prove that the holder owns it."},"multiple":{"type":"boolean","description":"`true` when the wallet can return more than one credential for this query."},"trusted_authorities":{"type":"array","description":"Issuers that the verifier trusts for this query.","items":{"type":"object","additionalProperties":true,"properties":{"type":{"type":"string","description":"Type of the trust list, for example `etsi_tl` for an ETSI trusted list or `aki` for an authority key identifier."},"values":{"type":"array","description":"Identifiers of the trusted issuers.","items":{"type":"string"}}}}}},"required":["id","format"]}},"credential_sets":{"type":"array","description":"Groups of credential queries. Each entry gives the combinations of credential query identifiers that satisfy the request.","items":{"type":"object","additionalProperties":true,"properties":{"options":{"type":"array","minItems":1,"description":"Accepted combinations. Each entry is an array of credential query identifiers. This property is mandatory, and it must hold at least one combination.","items":{"type":"array","items":{"type":"string"}}},"required":{"type":"boolean","description":"`true` when the wallet must satisfy one of the `options`."},"purpose":{"description":"Reason why the verifier asks for this group of credentials. The server accepts a string, a number or an object here."}},"required":["options"]}}},"required":["credentials"]}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDefinitionType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`payment_data`, `payment`, `login_risk_transaction`, `login_risk_transaction_non_ts12`, `account_access`, `emandate`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`]"} schema={{"type":"string","description":"Type of transaction data that the verification request binds. The holder must approve the transaction data before the wallet sends the presentation. The value selects the JSON Schema that the server uses to validate the `transactionData` of the verification request. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.\n\nThis property is mandatory when the DCQL query asks for a Payment Wallet Attestation, a QESAC credential or an SCA attestation.\n","enum":["payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`, `iso18013_7_annex_c`]"} schema={{"type":"string","default":"version_01","description":"OpenID for Verifiable Presentations (OpenID4VP) version of the Authorization Request. `version_01` is OpenID4VP 1.0. `iso18013_7_annex_c` is the ISO 18013-7 Annex C profile, which asks for mDoc credentials over the Digital Credentials API.","enum":["version_01","iso18013_7_annex_c"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value for a scope-based presentation request."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","default":"vp_token","description":"OAuth 2.0 response type of the Authorization Request. `vp_token` asks for a Verifiable Presentation. `id_token` asks for an OpenID Connect ID Token and accepts no `dcqlQuery`. `device_response` asks for an ISO 18013-5 DeviceResponse and is only for `iso18013_7_annex_c`.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","default":"redirect_uri","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet of the holder. `redirect_uri` uses a redirect URI, `did` uses a DID, `verifier_attestation` uses a Verifier Attestation JWT, `x509_san_dns` uses the SAN DNS name of an X.509 certificate, and `x509_hash` uses the hash of an X.509 certificate. With the DC API response modes, `redirect_uri` is only a logical identifier and not a real redirect target. Send `null` for `iso18013_7_annex_c`.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI that the wallet of the holder opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`, and it has no meaning for the DC API response modes."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`]"} schema={{"type":"string","default":"direct_post","description":"Response mode that sets how the wallet of the holder delivers the Authorization Response. **Direct Post:** `direct_post` posts the response over HTTP. `direct_post.jwt` posts the response as an encrypted JWT. **DC API:** `dc_api` uses the W3C Digital Credentials API and returns the response without JWE encryption. `dc_api.jwt` uses the Digital Credentials API and returns the response as a JWE.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signed`, `unsigned`]"} schema={{"type":"string","description":"Signing type of the DC API request. Only allowed when `responseMode` is `dc_api` or `dc_api.jwt`. `signed` makes the verifier sign the Authorization Request. `unsigned` gives no verifier authentication. The server treats a missing value as `unsigned` for `dc_api` and as `signed` for `dc_api.jwt`. Use `signed` in production.","enum":["signed","unsigned"]}}></SchemaItem><SchemaItem collapsible={false} name={"expectedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Origins that the wallet accepts for a signed DC API request. The wallet compares these values with the actual origin to find a replay. Mandatory when the effective `dcApiRequestType` is `signed`, and mandatory for `iso18013_7_annex_c`. The wallet ignores this property for an unsigned request.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the Authorization Response.\n\nThis property is mandatory when `responseMode` is `direct_post.jwt`, and the verifier global configuration must permit response encryption. When the stored value is empty, the verification request falls back to all three algorithms: `A128CBC-HS256`, `A128GCM` and `A256GCM`.\n\nThe `dc_api.jwt` response mode ignores this property. That flow always advertises `A128GCM` and `A256GCM`, and encrypts with `A256GCM`.\n","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem></TabItem><TabItem label={"IETF SD-JWT VC"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 3 characters` and `<= 100 characters`"} schema={{"type":"string","minLength":3,"maxLength":100,"description":"Human-readable label that gives the purpose of this presentation definition. The dashboard shows this label. The label must be 3 to 100 characters long. Labels that extensions reserve are refused, for example 'Age Verification', 'Document Signing' and 'Know-Your-Customer (KYC)'."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","default":"version_01","description":"OpenID for Verifiable Presentations (OpenID4VP) version of the Authorization Request. `version_01` is OpenID4VP 1.0.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key Identifier (kid) of the cryptographic key of the verifier. The server uses the key of the organisation when you send no `kid`. The key must be valid when `dcApiRequestType` is `signed`."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`]"} schema={{"type":"string","default":"vp_token","description":"OAuth 2.0 response type of the Authorization Request. Use `vp_token` to ask for a Verifiable Presentation. `id_token` asks for an OpenID Connect ID Token and accepts no `dcqlQuery`.","enum":["vp_token","id_token"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","default":"redirect_uri","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet of the holder. With the DC API response modes, `redirect_uri` is only a logical identifier and not a real redirect target.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`]"} schema={{"type":"string","default":"direct_post","description":"Response mode that sets how the wallet of the holder delivers the Authorization Response. **Direct Post:** `direct_post` posts the response over HTTP. `direct_post.jwt` posts the response as an encrypted JWT. **DC API:** `dc_api` uses the W3C Digital Credentials API and returns the response without JWE encryption. `dc_api.jwt` uses the Digital Credentials API and returns the response as a JWE.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI that the wallet of the holder opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`, and it has no meaning for the DC API response modes."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDefinitionType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`payment_data`, `payment`, `login_risk_transaction`, `login_risk_transaction_non_ts12`, `account_access`, `emandate`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`]"} schema={{"type":"string","description":"Type of transaction data that the verification request binds. The holder must approve the transaction data before the wallet sends the presentation. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.","enum":["payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signed`, `unsigned`]"} schema={{"type":"string","description":"Signing type of the DC API request. Only allowed when `responseMode` is `dc_api` or `dc_api.jwt`. `signed` makes the verifier sign the Authorization Request. `unsigned` gives no verifier authentication. The server treats a missing value as `unsigned` for `dc_api` and as `signed` for `dc_api.jwt`. Use `signed` in production.","enum":["signed","unsigned"]}}></SchemaItem><SchemaItem collapsible={false} name={"expectedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Origins that the wallet accepts for a signed DC API request. The wallet compares these values with the actual origin to find a replay. Mandatory when the effective `dcApiRequestType` is `signed`. The wallet ignores this property for an unsigned request.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the Authorization Response.\n\nThis property is mandatory when `responseMode` is `direct_post.jwt`, and the verifier global configuration must permit response encryption. When the stored value is empty, the verification request falls back to all three algorithms: `A128CBC-HS256`, `A128GCM` and `A256GCM`.\n\nThe `dc_api.jwt` response mode ignores this property. That flow always advertises `A128GCM` and `A256GCM`, and encrypts with `A256GCM`.\n","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query for the IETF SD-JWT VC format. It holds a `credentials` array, and every entry needs an `id` and a `format`.

Set `format` to `dc+sd-jwt` and give the accepted credential types in `meta.vct_values`. Claim paths are flat, for example `['identifier']`.

Ask only for subject claims, for example `given_name` or `birthdate`. The envelope claims `iss`, `iat`, `exp`, `cnf`, `vct` and `status` are always in the presentation. You cannot ask for them.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query for the IETF SD-JWT VC format. It holds a `credentials` array, and every entry needs an `id` and a `format`.\n\nSet `format` to `dc+sd-jwt` and give the accepted credential types in `meta.vct_values`. Claim paths are flat, for example `['identifier']`.\n\nAsk only for subject claims, for example `given_name` or `birthdate`. The envelope claims `iss`, `iat`, `exp`, `cnf`, `vct` and `status` are always in the presentation. You cannot ask for them.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"ISO 18013-5 mDoc/mDL"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 3 characters` and `<= 100 characters`"} schema={{"type":"string","minLength":3,"maxLength":100,"description":"Human-readable label that gives the purpose of this presentation definition. The dashboard shows this label. The label must be 3 to 100 characters long. Labels that extensions reserve are refused, for example 'Age Verification', 'Document Signing' and 'Know-Your-Customer (KYC)'."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","default":"version_01","description":"OpenID for Verifiable Presentations (OpenID4VP) version of the Authorization Request. `version_01` is OpenID4VP 1.0.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`]"} schema={{"type":"string","default":"vp_token","description":"OAuth 2.0 response type of the Authorization Request. Use `vp_token` to ask for a Verifiable Presentation. `id_token` asks for an OpenID Connect ID Token and accepts no `dcqlQuery`.","enum":["vp_token","id_token"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","default":"redirect_uri","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet of the holder. With the DC API response modes, `redirect_uri` is only a logical identifier and not a real redirect target.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`]"} schema={{"type":"string","default":"direct_post","description":"Response mode that sets how the wallet of the holder delivers the Authorization Response. **Direct Post:** `direct_post` posts the response over HTTP. `direct_post.jwt` posts the response as an encrypted JWT. **DC API:** `dc_api` uses the W3C Digital Credentials API and returns the response without JWE encryption. `dc_api.jwt` uses the Digital Credentials API and returns the response as a JWE.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI that the wallet of the holder opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`, and it has no meaning for the DC API response modes."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDefinitionType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`payment_data`, `payment`, `login_risk_transaction`, `login_risk_transaction_non_ts12`, `account_access`, `emandate`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`]"} schema={{"type":"string","description":"Type of transaction data that the verification request binds. The holder must approve the transaction data before the wallet sends the presentation. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.","enum":["payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signed`, `unsigned`]"} schema={{"type":"string","description":"Signing type of the DC API request. Only allowed when `responseMode` is `dc_api` or `dc_api.jwt`. `signed` makes the verifier sign the Authorization Request. `unsigned` gives no verifier authentication. The server treats a missing value as `unsigned` for `dc_api` and as `signed` for `dc_api.jwt`. Use `signed` in production.","enum":["signed","unsigned"]}}></SchemaItem><SchemaItem collapsible={false} name={"expectedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Origins that the wallet accepts for a signed DC API request. The wallet compares these values with the actual origin to find a replay. Mandatory when the effective `dcApiRequestType` is `signed`. The wallet ignores this property for an unsigned request.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the Authorization Response.\n\nThis property is mandatory when `responseMode` is `direct_post.jwt`, and the verifier global configuration must permit response encryption. When the stored value is empty, the verification request falls back to all three algorithms: `A128CBC-HS256`, `A128GCM` and `A256GCM`.\n\nThe `dc_api.jwt` response mode ignores this property. That flow always advertises `A128GCM` and `A256GCM`, and encrypts with `A256GCM`.\n","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query for the ISO 18013-5 mDoc/mDL format. It holds a `credentials` array, and every entry needs an `id` and a `format`.

Set `format` to `mso_mdoc` and give the document type in `meta.doctype_value`. Every claim path holds two elements: the namespace and the data element, for example `['org.iso.18013.5.1', 'family_name']`.

Ask only for subject data elements, for example `given_name` or `birth_date`. The MSO fields `validityInfo`, `digestAlgorithm` and `deviceKey` are always in the presentation. You cannot ask for them.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query for the ISO 18013-5 mDoc/mDL format. It holds a `credentials` array, and every entry needs an `id` and a `format`.\n\nSet `format` to `mso_mdoc` and give the document type in `meta.doctype_value`. Every claim path holds two elements: the namespace and the data element, for example `['org.iso.18013.5.1', 'family_name']`.\n\nAsk only for subject data elements, for example `given_name` or `birth_date`. The MSO fields `validityInfo`, `digestAlgorithm` and `deviceKey` are always in the presentation. You cannot ask for them.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"W3C VC (JWT)"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 3 characters` and `<= 100 characters`"} schema={{"type":"string","minLength":3,"maxLength":100,"description":"Human-readable label that gives the purpose of this presentation definition. The dashboard shows this label. The label must be 3 to 100 characters long. Labels that extensions reserve are refused, for example 'Age Verification', 'Document Signing' and 'Know-Your-Customer (KYC)'."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","default":"version_01","description":"OpenID for Verifiable Presentations (OpenID4VP) version of the Authorization Request. `version_01` is OpenID4VP 1.0.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`]"} schema={{"type":"string","default":"vp_token","description":"OAuth 2.0 response type of the Authorization Request. Use `vp_token` to ask for a Verifiable Presentation. `id_token` asks for an OpenID Connect ID Token and accepts no `dcqlQuery`.","enum":["vp_token","id_token"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","default":"redirect_uri","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet of the holder. With the DC API response modes, `redirect_uri` is only a logical identifier and not a real redirect target.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`]"} schema={{"type":"string","default":"direct_post","description":"Response mode that sets how the wallet of the holder delivers the Authorization Response. **Direct Post:** `direct_post` posts the response over HTTP. `direct_post.jwt` posts the response as an encrypted JWT. **DC API:** `dc_api` uses the W3C Digital Credentials API and returns the response without JWE encryption. `dc_api.jwt` uses the Digital Credentials API and returns the response as a JWE.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI that the wallet of the holder opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`, and it has no meaning for the DC API response modes."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDefinitionType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`payment_data`, `payment`, `login_risk_transaction`, `login_risk_transaction_non_ts12`, `account_access`, `emandate`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`]"} schema={{"type":"string","description":"Type of transaction data that the verification request binds. The holder must approve the transaction data before the wallet sends the presentation. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.","enum":["payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signed`, `unsigned`]"} schema={{"type":"string","description":"Signing type of the DC API request. Only allowed when `responseMode` is `dc_api` or `dc_api.jwt`. `signed` makes the verifier sign the Authorization Request. `unsigned` gives no verifier authentication. The server treats a missing value as `unsigned` for `dc_api` and as `signed` for `dc_api.jwt`. Use `signed` in production.","enum":["signed","unsigned"]}}></SchemaItem><SchemaItem collapsible={false} name={"expectedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Origins that the wallet accepts for a signed DC API request. The wallet compares these values with the actual origin to find a replay. Mandatory when the effective `dcApiRequestType` is `signed`. The wallet ignores this property for an unsigned request.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the Authorization Response.\n\nThis property is mandatory when `responseMode` is `direct_post.jwt`, and the verifier global configuration must permit response encryption. When the stored value is empty, the verification request falls back to all three algorithms: `A128CBC-HS256`, `A128GCM` and `A256GCM`.\n\nThe `dc_api.jwt` response mode ignores this property. That flow always advertises `A128GCM` and `A256GCM`, and encrypts with `A256GCM`.\n","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query for the W3C VC (JWT) format. It holds a `credentials` array, and every entry needs an `id` and a `format`.

Set `format` to `jwt_vc_json` and give the accepted type sets in `meta.type_values`, which is an array of arrays. Every claim path starts with `credentialSubject`, for example `['credentialSubject', 'identifier']`.

Ask only for claims under `credentialSubject`. The envelope fields `issuer`, `issuanceDate`, `expirationDate` and `credentialStatus` are always in the presentation. You cannot ask for them.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query for the W3C VC (JWT) format. It holds a `credentials` array, and every entry needs an `id` and a `format`.\n\nSet `format` to `jwt_vc_json` and give the accepted type sets in `meta.type_values`, which is an array of arrays. Every claim path starts with `credentialSubject`, for example `['credentialSubject', 'identifier']`.\n\nAsk only for claims under `credentialSubject`. The envelope fields `issuer`, `issuanceDate`, `expirationDate` and `credentialStatus` are always in the presentation. You cannot ask for them.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server created the presentation definition.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinition</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the presentation definition. The list endpoint returns the value of `presentationDefinitionId` here. The create, read and update endpoints return a different internal identifier. Always use `presentationDefinitionId` to address the presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VC deployment that owns this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier that the server gives to the presentation definition. Use this identifier in a verification request and in the path of the read, update and delete endpoints."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label that gives the purpose of this presentation definition, for example 'Verify Portable Document A1'. The dashboard shows this label."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder.

The query holds a `credentials` array. Each entry has an `id`, a `format` and a format-specific `meta` object: `doctype_value` for `mso_mdoc`, `vct_values` or `type_values` for `dc+sd-jwt`, and `type_values` for `jwt_vc_json`. An entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.

The server leaves this property out when the presentation definition has no DCQL query.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder.\n\nThe query holds a `credentials` array. Each entry has an `id`, a `format` and a format-specific `meta` object: `doctype_value` for `mso_mdoc`, `vct_values` or `type_values` for `dc+sd-jwt`, and `type_values` for `jwt_vc_json`. An entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.\n\nThe server leaves this property out when the presentation definition has no DCQL query.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDefinitionType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `payment_data`, `payment`, `login_risk_transaction`, `login_risk_transaction_non_ts12`, `account_access`, `emandate`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`]"} schema={{"type":"string","description":"Type of transaction data that the verification request binds. The holder must approve the transaction data before the wallet sends the presentation. The value selects the JSON Schema that the server uses to validate the `transactionData` of the verification request. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.\n\nThe value is an empty string when the presentation definition binds no transaction data.\n","enum":["","payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server created this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server last changed this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`, `iso18013_7_annex_c`]"} schema={{"type":"string","description":"OpenID for Verifiable Presentations (OpenID4VP) version of the Authorization Request. `version_01` is OpenID4VP 1.0. `iso18013_7_annex_c` is the ISO 18013-7 Annex C profile, which asks for mDoc credentials over the Digital Credentials API.","enum":["version_01","iso18013_7_annex_c"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value for a scope-based presentation request. The value is an empty string when the presentation definition holds no scope."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request. `vp_token` asks for a Verifiable Presentation. `id_token` asks for an OpenID Connect ID Token. `device_response` asks for an ISO 18013-5 DeviceResponse and is only for `iso18013_7_annex_c`.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet of the holder. `redirect_uri` uses a redirect URI, `did` uses a DID, `verifier_attestation` uses a Verifier Attestation JWT, `x509_san_dns` uses the SAN DNS name of an X.509 certificate, and `x509_hash` uses the hash of an X.509 certificate. With the DC API response modes, `redirect_uri` is only a logical identifier and not a real redirect target. The server leaves this property out for `iso18013_7_annex_c`.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI that the wallet of the holder opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`, and it has no meaning for the DC API response modes. The server leaves this property out when the presentation definition holds no URI."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`]"} schema={{"type":"string","description":"Response mode that sets how the wallet of the holder delivers the Authorization Response. **Direct Post:** `direct_post` posts the response over HTTP. `direct_post.jwt` posts the response as an encrypted JWT. **DC API:** `dc_api` uses the W3C Digital Credentials API and returns the response without JWE encryption. `dc_api.jwt` uses the Digital Credentials API and returns the response as a JWE.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signed`, `unsigned`]"} schema={{"type":"string","description":"Signing type of the DC API request. Only for the `dc_api` and `dc_api.jwt` response modes. `signed` means that the verifier signs the Authorization Request. `unsigned` means that the verifier sends the request unsigned. The server leaves this property out when the presentation definition holds no value.","enum":["signed","unsigned"]}}></SchemaItem><SchemaItem collapsible={false} name={"expectedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Origins that the wallet accepts for a signed DC API request. The server leaves this property out when the presentation definition holds no origin.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the Authorization Response. It applies to the `direct_post.jwt` response mode; the `dc_api.jwt` flow ignores it and always advertises `A128GCM` and `A256GCM`.\n\nThe server leaves this property out when the presentation definition holds no algorithm. The verification request then falls back to all three algorithms.\n","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the platform owns this presentation definition. You cannot delete a system managed presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"extentionEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when an extension uses this presentation definition. You cannot update such a presentation definition, and you cannot delete most of them. Note the spelling of this property name."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Legacy credential requirements of a presentation definition that an older OpenID4VP version created. The value is `null` for every presentation definition that uses `dcqlQuery`. You cannot set this property.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Legacy credential requirements of a presentation definition that an older OpenID4VP version created. The value is `null` for every presentation definition that uses `dcqlQuery`. You cannot set this property."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presentationDefinition\": {\n    \"id\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"presentationDefinitionId\": \"string\",\n    \"label\": \"string\",\n    \"dcqlQuery\": {},\n    \"transactionDataDefinitionType\": \"\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"version\": \"version_01\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"scope\": \"string\",\n    \"responseType\": \"vp_token\",\n    \"clientIdScheme\": \"redirect_uri\",\n    \"directPostRedirectUri\": \"string\",\n    \"responseMode\": \"direct_post\",\n    \"dcApiRequestType\": \"signed\",\n    \"expectedOrigins\": [\n      \"string\"\n    ],\n    \"encryptedResponseEncValuesSupported\": [\n      \"A128CBC-HS256\"\n    ],\n    \"systemManaged\": true,\n    \"extentionEnabled\": true,\n    \"presentationDefinition\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The body is not valid JSON, `label` is missing or shorter than 3 characters, `label` is a label that an extension reserves, `dcApiRequestType` does not agree with `responseMode`, `expectedOrigins` is missing for a signed DC API request, `directPostRedirectUri` is set for `direct_post.jwt`, `encryptedResponseEncValuesSupported` is missing for `direct_post.jwt` or the verifier global configuration does not permit response encryption, the DCQL query is not valid, `transactionDataDefinitionType` is missing for a transaction data credential, the organisation is unknown, the digital wallet deployment is not resolved, or the digital wallet refused the presentation definition.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read credential issuer metadata
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-read-issuer-metadata

---
id: config-digital-wallet-open-id-read-issuer-metadata
title: "Read credential issuer metadata"
description: "Retrieves the OID4VCI Credential Issuer Metadata for a credential issuer. The wallet reads the `.well-known/openid-credential-issuer` document of the given credential issuer, checks it against the metadata model of the selected version, and returns the checked result. The wallet removes the keys that the model does not define, including `signed_metadata`, and returns the optional keys that the issuer left out with the value `null`. Each entry of `display` gets the default values `Not Discoverable` for `name` and `description` when the issuer gives no value. The wallet does not change the contents of `credential_configurations_supported`."
sidebar_label: "Read credential issuer metadata"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv3LYS/isDPtmA9mLHbs9ZFEVT2223zWmM2HEeAiOixVmJNUWqJLWbrbH//WBI3fZipwc4DwVaP9iyxLlw5puZj3xiAl1mZeWl0WzG3qG3EpfowBcIb+eXZ3cXc7iwKFB7yRXMnavRwn/Qc8E9h4WxwCHrF8iwYAy3BcKKK4UeLHIRFabjFSo1etRmpSemQi3FqJcdRdkUhMnqErUHswhiuVyi3jeSQFZg9uhAeuA5l9r5sLxsnSuNQNUqcagw8yhgidZJoxPgWoBFX1sdvQvakN65WvmdLZSmjcojrumBN8aCDWHQgTYeBC6kxgSkzlQtpM4hdTLXKD61XqX7hk0IP1c7quMuQeHCg6k9rKQvwoclVzVCqmul0jFc8awA1N6uaaupkK5SfJ1Cjj6qF7jgtfJRzEH6q/FwKV1mlmj5g8I0ZDHVvMQ0+JYOQJHCqkA99IeyQZuN+rbC1IUhK7jOMUbVaI/au+Bcn8NPmdELmdeWkxX3ydVVZaxHkY5ZwkyF8cNcsBmLSy9lLj1XH4KptxXquXiHXEREtoBkCau45SV6tI7NPj4x2hbp6CxHAZYwSYj/vUa7ZslOHewjfh7+X8hnsf1SkVhTgi+kg/fv3tD2LP5eS4uCzbytMWEuK7DkbPbE/Loib523UucsYaXUb1DnvmCzk03C8DMvK0UrCu8rN5tMBJZmxCs5lrnl2o+lmSxPJ8bmXEsXQjj56hRP/y3OshPx9Tk/P384w0xM8Xw6cWiXMkO2SbowNcXxcnTu4qK2sto24SrM5EJmwWoP4yZStaP6MSFiW2Ua49mCVDpIheUL/+nkVUqfpIMODcCzDCvCklZrUuIIYxabknDbsV1w5V4MbmOTzVhrkSUMdV2y2cfhq+bxvH/8mt1vZaNbvLknD1xltENHNk+nU/rTVAE98qpSTZAmvzkK6NO+j+bhN8w8odnS7r2M2nZR3MH+gCQXQsa+cj3QEQH3JbR30G1S3DZc7poOJ0DqNvExgdEuFEY1BYFaVEY2lT/oH9RhQmPorW73gr0O2PQGN2Yb+tl1f6cch5IdxljCCuQiNIUnUnH2P+alh9VHhtYae2EEElzo+XLgz33yhRz20n3SpPaYh6bUYepsOt0cUH8Axj0Mv+eUl6r20DXB50M27BFUdtS3l1xJkYQIdhqGXXveTGjpoJTOSZ3HxU3baNV0zTwBY4dNIOOavu/1gG2IjOEnowTavvAdcIvAlTNBP19yqWh0NfzDcS0ezOetLR1K+cnfOOXvNa99Yaz8A8VeaM7/1tUw1x4t8S8aiGghmNmJ0SZhDrPaSr8OtOJ1JX9Berynlu95TmyDNRwFIkmBo0BTqEkes4RFUFNISvSFIWaTY4gIp/nOaHDHTjgRUc8olk1DlSd7VJmRU+RypDrbu7rE0jQ7YgmrrXqRNQQSsK3g2hpRZ6E9PKPmSxpuPM+JAz8j7uLnXUfu+1DfEOIiUNqAdxnn8UXDVGKuWNISmdcN2AOC9xjM6+s5kW2gkqCIRqDHQRbZddOQ0i09KUQzUNbOwwNCZXEhP6OI3DyNPkIKR9r4SH+95VKFGFQ8w+MEcJyPd9TOoBH8Zm1qS+EYPeL625TmHW1vYdri5FkoTiy5pEA2ffa7Pnjd/uWP/avtqA8TthOWTggqa5ZSoKPDnaF68giS/tK5LI6Mlv0FiIdGfIdWLmToyz2lcIFTcJ0hHDWE4ThwgMOC1xZdZ6Krn+tj8sibzCjXkEJKIWqScU3f/6OlDybOkSSQkXjcWpKFNTR1NeAeDmoX0uO5FtwKNwr7lVx7WCizcjG1TaSDtx9eXcDdBRz9/OH2OIH51e0PcHM5+vnDLdxdRGvzm7dw8q/pyavROZSXJpuUl2+GfGdhbMl9oKtKZqhd6H4tciueFQin4+le6lar1ZiHz2Nj80kj6yZv5hdXv95cjUhmkzAvvdrCQAhWe6puK6Kl+jN2Oj09G78an5BsZZwvuR74Q4es/cN3N7p3a2swRf65TvjnOuEvcZ3QTAyPn/2kUlxqQnooradm+H5ky1OWNDcNBOmtARxvJLQk4rQ/hO8TVhjnScnT0wN3+N6qzYZex+NzGM3SUWz6U+mzNXP0ruFWxwcK5f96C3EwKo80Yw/dloT0sBmLY/5Pb+cvfVfwQgT6i5B+4/f0jw1zKhC/liGGDEex18HoQGqPR2+G/O/Hq1s6qdcEwSGxeQzEpnkg7e0nvR7o3uU40QX6TTk6KPINTYJfcP1ttzx+eVag41VxNYXofrPZ/BfcxdUD
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read credential issuer metadata</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/credential-issuer"}></MethodEndpoint>



Retrieves the OID4VCI Credential Issuer Metadata for a credential issuer. The wallet reads the `.well-known/openid-credential-issuer` document of the given credential issuer, checks it against the metadata model of the selected version, and returns the checked result. The wallet removes the keys that the model does not define, including `signed_metadata`, and returns the optional keys that the issuer left out with the value `null`. Each entry of `display` gets the default values `Not Discoverable` for `name` and `description` when the issuer gives no value. The wallet does not change the contents of `credential_configurations_supported`.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"credentialIssuer","in":"query","description":"Credential Issuer Identifier. The wallet reads the Credential Issuer Metadata from this URL.","required":true,"schema":{"type":"string","minLength":1},"example":"https://demo-api.igrant.io/v2/organisation/62e29d4c1d75a55b4ecd0e50/service"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"version","in":"query","description":"Version of the OID4VCI specification that the wallet uses to read the metadata. The default is `draft_13`. This operation accepts only these three values.","required":false,"schema":{"type":"string","default":"draft_13","enum":["draft_13","draft_15","draft_17"]},"example":"draft_13"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet read the issuer metadata.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialIssuerMetadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential Issuer Metadata of the issuer, as defined in OID4VCI. The object holds the endpoints of the issuer and the credential configurations that the issuer supports.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential Issuer Metadata of the issuer, as defined in OID4VCI. The object holds the endpoints of the issuer and the credential configurations that the issuer supports."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialIssuerMetadata\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the parameter `credentialIssuer` is missing, the version is not supported, or the wallet cannot read the metadata of the issuer. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read key store
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-read-key-store

---
id: config-digital-wallet-open-id-read-key-store
title: "Read key store"
description: "Reads one key store of the organisation. The answer never has a credential of the key store."
sidebar_label: "Read key store"
hide_title: true
hide_table_of_contents: true
api: eJzlWulvGzcW/1eI+SQDI1lx0sVCWxTrym6jOocb2TGwWQNDzzxpWM+QE5JjRTX0vy/eI+fU4TjbArvol1jh8Hjn7x3kY5CAibUorFAymAQfgCeGKQnsHtbMWKWBqQWzKTCll1wKw3HmiF2lwLg0K9BMwgNolnLDOIs1JCCt4Fm1rN5n9G8ZhIEqQNMWsySYBLGSC7E8E0theXbDswzs+wLkLEE6LmA9x4VBGBRc8xwsaBNMPj32aL6W4nMJTNDBCwF6+2gWZSrm2VAVIO+4isJqIOGW33EDEVO6GktNHrGF0oxvC0FIY3mWEQchg8yAG27Otim3NBZr4LYjx4p1psGWWkIyCsJAIAsFt2kQBpLnEEyCe8/4LAnCQMPnUmhIgonVJYSBiVPIeTB5DOy6wNnGaiGXQRjk/MsbkEubBpO/vdqEAXzheZHhlA7zweYWdzWFkgYMbnQyHuOfrlRRwQb0g4ihprcn1SBEBVqQFpfzoshETAwe/2Zwj8dtYtXdbxDbIAyssERaS8nd809bkiOZpipLDDNiKYVc4kfzh1kmWphG9VjhJCKSXQL+nzI7zq6vZ2dI+l49h56Dpzi5Whewl/iICfMUSWyAXvsjV+xKc2mEDWnKihyaVcyGyCyOp1wnK67RvuJSC7tmuUrKbOfWRyN2zuO0o2MWc8lKAwwP4tKZ5enlDMelsownScjilMsl2gZLIAOLk0cseuBlZh1LksEXC1ryjFXUK81ec5OKqdIF+4hTd5tYtIyL4X1uWrJBwTIh2c9KLTNg00yVCbt4Ox+xiK9MPRmRVcMSmVALpOH0Zs54HKtSWjbA/1y8nR/hot9LDcN7WA87JJ/iMB344MjTLOeSLyFhr+dvRyxKCpV4sgqurbDVUewq5RkY9qaU3JP3ev62dvHB2aU6w4NjE/v1GnJlofa4auZK2JRk4jaZi6XkFqmaKmmUtqLM2WA6nx6hSkKyaG+hjLPPJc/QWRJmdWlsvWmh1YNIQLPBr1fzyyMya1nmweSTM+ogDIjhIAy87IMw8ILFX11poYUXCtEzNnFwu+Ui6BrVibvcQ5ZZxu9wvsPcbWSs6e27DRoki0QSVV+qmTVaZcLYNratCzCt2DBoCyxqIUeKlhkrXXiLCFm0JGMbxqgIZ2IIJ0JaMCJCZSIjFahU7tzy8JmtXMZ5y4idyq6nEXZalitjt7MCQMes+OsgEZ67qeLZwUj1Yjzuy/cdz3fB0cyiWZYedeW2W3ag8A0y65wEte3U3pByp1QGXG5B4TxVK8MiVPtXgTEb4IaVbI86NOAmmzAwltvSPI3Cc5q3C4d5bMUDRGyVgux+ZCul782IRaC10hHjCwtIc6ykhJgItGCsC6ALLjJIECOEQet2OKEBfdDlIpXLuQORQj8Tv+EJXV/y05wzWXfe893pJgUN3lXEg0+ZvByEafHKSRhGLSwGj2hSGUE14mAO5ztIzEE2ADOozL+Grzse34NMGh8j56kjc1gFi7AF9/XihmGWwQNkLJq//+nq5vTDOc7fAu96HVLnLOZ8Sh6KUb/m5DmB8RBHuKnffEiDiTuDs7iKS84k7gEKUxFmcMo+EmrDdDs0eN0TTvR6/pZE4IPeXmlE59MhzkU6E0gwc4RkWIuD7xdGJ671UYANXAjEbSsiownzOXk1ErJVKuKUJRCLBAxL1YoJW2m1JZEBxcOjbWBszBIhEudHjU0Q+AtrWueVMgNjaNCAtUIujT+97XiVKQdhkJrc/es1SHjRElPQCmEdr6z3QOzxR22n9/OKiD7ekHmO2DtKnTkKX4NFGpWE9wsqv/bl8lWk3n/SM9GUcvnOBANOO/nOxM/nfPh9xE63Ix7pSqpWLWBGwSbcz1GdTezn6JvTyIpZ5xSeWZ8yY85lGsf2WbVXhmEgl0LWEqQNRp1S8VPAk0SDodyotCky60qz4PYQv01u9ZQO9+W7hzitkMLzWm+TYyYIX4SxHSHEPMswY87WbsfFQsRYvoFMCiWkZRFh0X1uRi4R4oUwo1jlUV8YhVaeUbQI4inEKvsDxqeDAmlSzP0COZjTHxBHBZFHX8W1rw0a7v3O7mRKjxIFaN6WaeDeN27mzPVYSp9eLgRhuSvEQD4IrSQFyiZdjcGYvgTdKU/IajsJP+Q2h0uZg4LrBZSuAJceIphV9yBrgGu1J9hCq5y9FbFWCJbsXFrN2eyMIKUnf0fb9Yc3O7sGbRHRzGuNAGhBcmmpfRNnAvzP5ziiL18OeeGzyrsD0qRwGVbrz7jl7LLJbpRkZ5BzmewCKJtqVS4dRtFpYimbmqjIuF0onbuFDbkoZYyDU70urGLv0cJBM60ycFBwh6AvEJ6FgYQthDbWFajOPJNSw1Ff/KTtN/wOssOSxYrwsGC/skal8qBXIz+rNq4U4DKMHjuxiZ0ttQyoNKBnSXC7ud2EQSuGTb2HQ7Kr09Zl9SesLrFua/XDFgKyZHciEFa1UF17eANwTbUHnpWwp+XmvIe+n+eFXZO8yC9bMd6tJQLMpG7PRAU3ZqU02mXkgt6MfpOS8YeTyqUrGC5gHf2jlaVHXmOnDoP957oNE/EYIe4C1rPWAafVIM3tp6z+wDlNbQiYYstwQUnZPqpcQyZC579C6p2yrrWg1Lge9VreMdicWQiJO1KHZosgNI5LISn28SQhV+PZZaet2St+2z3ixw3aFC/4nchEbz7Xmq+3LOmmanQ3FoN9uUQ5nZKW63St6SYOekZGu/B7jFywoqT7aMIi1zxHvkReKE0copORlI2mP43spykX9AmL3YgNpKrXHaiO2gQpm4I+nJwiWV9LQt1p3MOKhgVokDF8JV/YM7r08HMBa1MfFLIIEkF/XZszanUnnyjDEIedeXao/BNp62imajZO9hz5HJ7xHsVCvrPLUtVWjkOcSecT3vpjgzDAU6lfqPHfHpuYOPaooShvcBekhZwDScHY0zjVrkOfOoh2xV0+mzjZUbdRg0r0sXq7kG/HMVPHIaIHg3ACri3y63xKbd8Fz6jpgT2Qum7uQTZqCyvnql+DYbAqoTudL9psQyn2FBG4pRZsTi5Bb6HJuzK/c6nDvpudqknSScDqI1+ixCqG53tbbodbUe8x69vR9eNN7He9i/qkqIqPA9ThUuk1iz5bU0SIFq1ZFD4xNK5p561YK0xLXb6ydcPcsgx4034NWSSVHfb3dhQLyv/9DVFUynupVjLqNIIdET28m2BV3MfAOOMiN11DIsGO2ByAGEe0bXhpdzLqNSj0Nr2Yxzi6Om0L3zHOuLHTFLDhcWq/oTUvmtYxbtVvhIZoRNdX01oid7BQ3ppdmomzdrWya8I+gMHiBi88s+yJhkh1udle2CfZDTsr67dtux2T7WtKdf/clnadxvWPwozLN4F7/escjOHLnX38pxq7651HuT50yCiDNHwBzMIXSxVs+8LWpWVVqZqA5SJjvUuVWo81X/uY8WqM/xjb2mdWnSuIk/HJ34YvxsOT8dWL8WT83WQ8/leAaVY7z1f3QSPiNn23eE1/mKLGdPbZ+1N27uoIbCl+i0SmVTCxYseNzVcJZeyEEgZlkXwrGdtO769+/wuCeloSCFtEVavr6u+3wrrv6W96OtchrR7svpqtl3f7yN+KntuRrQ+U2/jUVmxburcb5C0FntBjGkr7X41foNS/+i1HWzJ0LTRVCVRXRGct3dyGW9DYBbBm9a4MoVbSq/F4s2P7XclerdcfecKELEpEA/94KNhsiPv+Ow4suJQWv5Mu+qJ59RcWzVU/BfP989b9o6uuhGHuLUpXet+5h0V/UenNpL8XoAtWzdwNaldGdEfjrrcokzgtxAXgT4J/y/Hq5lPgH8gx90LOvbaZnb36OD0KQkwy2Nv6whNFk4NNFT6vWwJJBh+XTYLjh5Nj1ws+Ttx+Q9fLOcYLUJEcY2nY3JzSf0nJ5vixeZG2IURDfnY9xTuDXHl2EXV0FkyC1NrCTI6PE8jVkBdiJJaaSzsSiq5euhtcapWUsb/q2bnNUzvMLV9Wz1V2LDfuc5+Q20YPczRHZ0WVNppOiBvwr/acIpt3e6ceR6obht6DtssZOU63DeyaJdQnqwJW1NknYu6YujVaaFiIL5D4UsTRyKi2ti7CW81FRjIoeAxHIYPRctTbdsL8wu/XqtQoDmwN/BCNKPYJuVCV5/KYPBdyLlCQpiywkv1nI7yaf/FzM9SVelthPbHUi6qkjh7rKXQ2fLSFf9EcefvC19k/lTMfQYuFwOSATZvoymbGlFxigfueHGV2RFXV7oWX+AaiOqJ2rssjug9WscoMakkYatqCxDXG46ITpmFWMWFMCSE9U3SXkw94wpp5Z2tfOrLSkHoslwnXiRkSv4JLyxYZZuukWi9povbm5ZR9nLLBLzdXRyGbnV/9xOZnw19urtjHqTttNn/PXvx9/OLl8DuWn6n4OD9702nyKp1zS3V6JmKQhqCxstyCxymwk9F4S3Wr1WrE6fNI6eWxX2uO38ym5+/m50Ncs2lKnkadKKxExWWtPXzDBdo4tZ+MT16NXo5e0OsRZWzOZYsefP7bRJm+K7Uiyp//YNl7PpYox0WGPZqNF9GjR9ZPwcOJewq7EPSsp4Ou7s2zFD6jayGsH3AYG4TBpPXu9zYMUmUsbv74iO9RrnW22eDw5xI0BQh8EaeFS4sRiKunOq77ckBkgw8+zB6x/++n0ztVUyG1XNObwazE/zlRd59W0y2Kh3AUoJuA1wCFbS3dylg27Qj78/mVv9nrRol7ihL+R6tF0CWrHzBqGtuPErpLvke3uoD1D/V092XvgjpIudkoJKwB/gMDm8n8
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read key store</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/key-stores/{keyStoreId}"}></MethodEndpoint>



Reads one key store of the organisation. The answer never has a credential of the key store.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else the identifier that the create key store operation returned.","in":"path","name":"keyStoreId","required":true,"schema":{"type":"string","maxLength":64},"example":"local-openbao"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the key store.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else a UUID.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store. `local` is a key store of the installation (OpenBao Transit, the wallet database, or the hardware security module of the installation). Each organisation can use it, and the API cannot add, change or delete it. `vault` is an external OpenBao or HashiCorp Vault of the organisation. `gcp-kms` is a key ring in Google Cloud KMS. `aws-kms` is one region of an AWS account (AWS KMS). `azure-key-vault` is an Azure key vault or managed HSM. `dpod` is a partition of a Thales Luna Cloud HSM service (DPoD). `csc` is a remote signing service with the Cloud Signature Consortium (CSC) API, for example a qualified trust service provider (QTSP).","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"provider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The provider of the key store, an `id` of the providers of the list key store types operation (for example `openbao`, `hashicorp-vault`, `google-cloud-kms` or `intesi`). `null` for a `local` key store. It cannot change. An organisation has at most one key store of each provider.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Name of the key store. It is unique in the organisation.","example":"Local vault"}}></SchemaItem><SchemaItem collapsible={false} name={"local"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` for a key store of the installation (type `local`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`active`, `disabled`, `error`]"} schema={{"type":"string","description":"Status of the key store. `active` when the key store works. `error` after a connection test that failed. `disabled` is reserved.","enum":["active","disabled","error"],"example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`, `hsm-backed`, `dedicated-hsm`, `provider`]"} schema={{"type":"string","nullable":true,"description":"Where the private keys of this key store are. `software`: in the software of a key management service (`local` with the backend `openbao` or `database`, `vault`, `gcp-kms` with the protection level `SOFTWARE`, `azure-key-vault` with the key type `EC`). `hsm`: in the hardware security module of the installation (`local` with the backend `hsm`). `hsm-backed`: in a cloud KMS that keeps the keys in hardware security modules of the cloud provider (`gcp-kms` with `HSM`, `aws-kms`, `azure-key-vault` with `EC-HSM`). `dedicated-hsm`: in a hardware security module partition of the organisation (`dpod`). `provider`: at the provider, which decides how it protects the keys (`csc`). An organisation key store has the `protection` of its provider, unless its settings decide.","enum":["software","hsm","hsm-backed","dedicated-hsm","provider"],"example":"software"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>settings</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Settings of the key store type. Never a secret.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"local"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"backend"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openbao`, `database`, `hsm`]"} schema={{"type":"string","description":"Where the installation keeps the keys. `openbao` for OpenBao Transit (`local-openbao`), `database` for the wallet database (`local-database`, legacy, no new keys), `hsm` for the hardware security module of the installation (`local-hsm`). With `hsm`, the new local keys of the organisations go to the HSM; the keys in `local-openbao` stay there and keep working.","enum":["openbao","database","hsm"],"example":"openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`]"} schema={{"type":"string","description":"How the key store protects the keys. `software` for the backends `openbao` and `database`, `hsm` for the backend `hsm`.","enum":["software","hsm"],"example":"software"}}></SchemaItem></TabItem><TabItem label={"vault"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"address"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the vault, with `https://`. The wallet refuses `http://` and private network addresses, unless the installation allows private addresses (for example on premises).","example":"https://vault.example.com:8200"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Namespace in the vault. Leave it out or send `null` when the vault has no namespaces.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"transitMount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the Transit secrets engine. The default is `transit`.","example":"transit"}}></SchemaItem><SchemaItem collapsible={false} name={"caCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM bundle of the certificate authorities that the wallet trusts for the TLS certificate of the vault. Without it, the wallet uses the system certificate authorities.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"clientCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM client certificate for mutual TLS. Required for the authentication method `cert`. With another method, send it when the listener of the vault requires mutual TLS. The private key of the certificate goes in the credential `clientPrivateKey`.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to the vault.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`userpass`, `approle`, `cert`, `token`]"} schema={{"type":"string","description":"Authentication method. `userpass` needs `username` and the credential `password`. `approle` needs `roleId` and the credential `secretId`. `cert` needs `clientCertificate` and the credential `clientPrivateKey`, and can have `role`. `token` needs the credential `token`.","enum":["userpass","approle","cert","token"],"example":"userpass"}}></SchemaItem><SchemaItem collapsible={false} name={"mount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the authentication method. The default is the name of the method (`userpass`, `approle` or `cert`).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"User name, for the method `userpass`.","example":"wallet"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Role ID, for the method `approle`.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Name of the certificate role, for the method `cert`. Optional.","example":null}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"gcp-kms"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"project"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Google Cloud project ID of the key ring. A domain-scoped project ID (`example.com:my-project`) is also accepted.","example":"my-project"}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Cloud KMS location of the key ring, for example `europe-west1`.","example":"europe-west1"}}></SchemaItem><SchemaItem collapsible={false} name={"keyRing"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 63 characters`"} schema={{"type":"string","maxLength":63,"description":"The name of the key ring. Letters, digits, `_` and `-`, at most 63 characters.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"protectionLevel"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`HSM`, `SOFTWARE`]"} schema={{"type":"string","description":"The protection level of the keys that the wallet creates. `HSM` (default) keeps the keys in hardware security modules of Google Cloud (the key store `protection` is `hsm-backed`). `SOFTWARE` keeps them in software (the key store `protection` is `software`).","enum":["HSM","SOFTWARE"],"example":"HSM"}}></SchemaItem></TabItem><TabItem label={"aws-kms"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"region"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The AWS region of the keys, for example `eu-central-1`. Free text with a format check, not a fixed list.","example":"eu-central-1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to AWS KMS.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`accessKey`]"} schema={{"type":"string","description":"Authentication method. `accessKey` (the only method) needs the credentials `accessKeyId` and `secretAccessKey`.","enum":["accessKey"],"example":"accessKey"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"azure-key-vault"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"vaultUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the key vault (`https://<name>.vault.azure.net`) or of the managed HSM (`https://<name>.managedhsm.azure.net`), without a path and without a trailing `/`.","example":"https://my-vault.vault.azure.net"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Microsoft Entra tenant ID, a GUID or a domain name (for example `contoso.onmicrosoft.com`).","example":"00000000-0000-0000-0000-000000000000"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The application (client) ID of the app registration, a GUID.","example":"11111111-1111-1111-1111-111111111111"}}></SchemaItem><SchemaItem collapsible={false} name={"keyType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EC-HSM`, `EC`]"} schema={{"type":"string","description":"The key type of the keys that the wallet creates. `EC-HSM` (default) keeps the keys in hardware security modules (the key store `protection` is `hsm-backed`). `EC` keeps them in software (the key store `protection` is `software`). A managed HSM has `EC-HSM` keys only.","enum":["EC-HSM","EC"],"example":"EC-HSM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the application logs in to Microsoft Entra ID.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`clientSecret`, `clientCertificate`]"} schema={{"type":"string","description":"Authentication method. `clientSecret` needs the credential `clientSecret`. `clientCertificate` needs the credentials `clientCertificate` and `clientPrivateKey`.","enum":["clientSecret","clientCertificate"],"example":"clientSecret"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"dpod"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"tokenLabel"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 32 characters`"} schema={{"type":"string","maxLength":32,"description":"The label of the partition, at most 32 bytes in UTF-8, without a control character, `;`, `{` or `}`. The wallet removes the spaces around it.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^[0-9]{1,16}$`"} schema={{"type":"string","nullable":true,"pattern":"^[0-9]{1,16}$","description":"The serial number of the partition, a string of 1 to 16 digits. Optional; an empty string is the same as `null`, and a number is refused. When given, the HSM signer checks that the partition has this serial number.","example":null}}></SchemaItem></TabItem><TabItem label={"csc"} value={"6-item-properties"}><SchemaItem collapsible={false} name={"cscUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC API of the QTSP, with `https://`.","example":"https://qtsp.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"apiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"Version of the CSC API. The default is `v1`.","enum":["v1","v2"],"example":"v1"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client ID that the QTSP gave the organisation.","example":"client"}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID that the QTSP registered for the organisation.","example":"user-1"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialsConfigured</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential field of the key store type, `true` when the wallet has a value. The answer never has the value. Empty for the type `local`. The fields: `vault` `password`, `secretId`, `token`, `clientPrivateKey`; `gcp-kms` `serviceAccountKey`; `aws-kms` `accessKeyId`, `secretAccessKey`; `azure-key-vault` `clientSecret`, `clientCertificate`, `clientPrivateKey`; `dpod` `authTokenConfigUri`, `authTokenClientId`, `authTokenClientSecret`, `pin`; `csc` `clientSecret`, `userPin`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"capabilities"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`create`, `import`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete`]"} schema={{"type":"array","description":"What the key store can do. The type sets them. `local` (the key store that takes new keys): `create`, `import`, `sign`, `csr`, `certificateChain`, `test` (no `import` with the backend `hsm`). `local` (the other key store of the installation): `sign`, `csr`, `certificateChain`, `test`. `vault`: `create`, `import`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete`. `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`: `create`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete` (no `import`). `csc`: `reference`, `sign`, `listProviderKeys`, `test`, `edit`, `delete`.","items":{"type":"string","enum":["create","import","reference","sign","csr","certificateChain","listProviderKeys","test","edit","delete"]},"example":["create","import","sign","csr","certificateChain","test"]}}></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the keys in a qualified signature creation device (QSCD). `false`, or `provider` for the type `csc`, where the QTSP decides.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"keyCount"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of keys of the organisation in the key store.","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"qualifiedStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","nullable":true,"description":"Only for a key store of a provider with `qualified` `true` (category `qtsp`): `qualified` when every key of the key store is qualified and there is at least one key, `not-qualified` when a key is not, else `unknown`. `null` for every other key store: no other key store claims a qualified status. See `trust` of the key.","enum":["qualified","not-qualified","unknown"],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"lastCheckedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the last connection test, in UTC. `null` before the first test.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lastCheckResult</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Result of a connection test of a key store.

</div><SchemaItem collapsible={false} name={"ok"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the connection test passed.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Why the connection test failed, as a safe text. It never has a secret or the detail of the provider. `null` when the test passed.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the connection test, in UTC.","example":"2026-10-20T10:05:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Creation time of the key store, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the last change of the key store, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"local-openbao\",\n  \"type\": \"local\",\n  \"provider\": null,\n  \"name\": \"Local vault\",\n  \"local\": true,\n  \"status\": \"active\",\n  \"protection\": \"software\",\n  \"settings\": {},\n  \"credentialsConfigured\": {},\n  \"capabilities\": [\n    \"create\",\n    \"import\",\n    \"sign\",\n    \"csr\",\n    \"certificateChain\",\n    \"test\"\n  ],\n  \"qscd\": false,\n  \"keyCount\": 3,\n  \"qualifiedStatus\": null,\n  \"lastCheckedAt\": null,\n  \"lastCheckResult\": {\n    \"ok\": true,\n    \"message\": null,\n    \"checkedAt\": \"2026-10-20T10:05:00Z\"\n  },\n  \"createdAt\": \"2026-10-20T10:00:00Z\",\n  \"updatedAt\": \"2026-10-20T10:00:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key store with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read key usage
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-read-key-usage

---
id: config-digital-wallet-open-id-read-key-usage
title: "Read key usage"
description: "Reports where a key is in use: the credential definitions and presentation definitions that sign with it, the status lists of those credential definitions, the issuances and verifications in flight, and whether the key can be deleted. The items come last changed first."
sidebar_label: "Read key usage"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zgS/isDfmoAxW9x2sRYLC4Xdxfe9tqiSdoPbYCMpZHFrUSqJBXXG/i/H4aUX+TITXK3uA/X5ksSSRzOy8OZZ4Z3IiEbG1k6qZUYifdUauMszDMyBAhfaAHSglRQWRqBywhiQwkpJzGHhFKpJC+1gCqB0pAl5ZCfNF66DB1YOVMwly4D6SIvyjp0lYVcWmdBp+AybfdtEFZIaytUMYX9bsnIVMYYNpEK0lzOMhf5l/OMXEbGL2MzYlQwJUgoJ0dJBy5ZnKPCQqwLghytgzhDNaMEUmms63xWnxV/ZbxTwBAm1ovTZoZK2mAn7yWdBYsqmepvjZcWtMoXI8AtS9hQbP3ae8gGF9Vae7ew9AKlanwcjFQatLeyIYdNrSythARbg+HeFbokUytflrmkYJXFgsBUOXU+KxGJ9UeTRIxErFUqZ2M5kw7zj5jn5N6WpCbJe8LkFS2uLM5IRKJEgwU5MlaMPt3toOtKya8VgfThTSWrna6UFJGQ/E2JLhORUFiQGIkvtJgkIhKGvlbSUCJGzlQUCRtnVKAY3Qm3KPlD64xUM7FcRrubviIq7S5yv4vWuYchawDawGQMsVYOpQpSHH2rEdYOYbamdHtQ3IEzxRIxtxoKdHFGIeC6cj7O2aLMiL87R0sglSVlpZO3FAE6KLR10B+cMFANxuzmGsgr7EOsK+XC8biJUY191G8A8zkuGOq3ZIBuySw8Qjb+76wC8LUis9hEwBKaOGuEIMXcficGkSjw22tSM5eJUX9wslxe82pbamXJ8veDXo9/NePEZlgytzLmE+cqoyi4uGJorQ5hU2EODCnHwjySQyro/mlZ4t19DfX0T4odw9QwvJ0M+gSUtRjyePiyNvQNizJnAUfpAE/78fDF9CQZ0vMUe/Fx8oL6J9PTwTA96ollJKQdU4pV7rY2nmqdE6p7O19kem7hhrF/w4lN+W3n/hg2s4a0/oRPF4w6lt5QzEduGYkM7Tmb75Nn8MGTNUCINyIYkFJxqcil+sKB062e4fXLSGwOx3hzNtri1FTivL307FSXrX2bYfZHY2sXqRzNyNzb5k1VTENwfX1oGNDnyPHTLTloDPr8tfN8D9rkfwO11rTSBN+LeEBDPJ32k6N0SM/xZNqL+8mAjtIhHk+fxwy+HKeUP6zGG58DH73zOzJWK5jUWofTCGN0KJb+h12xSbpPiv27R3KL/+vo7ylZzSicJv30aHqMHgfp3xb/R+19NiPwJaZ/sg55KJGvuUI+HOaLlnq6h3H+SIHfohlNhw+mw+R5eoK9uL832Bv/nXsWV2143UMKTR6XgEIsdhSFKeVazSw4/fQExUSfzJV5BEgn/lO4ev+6XQ1poaymubQZJVCphExTncy50o663YQKfYil7MiZQeU6Une3WXX3OD3F/nQQHyVDOk6f9170TwanRzjs1qxlDfhVk/KeYm0SO1G/eWr2pPq2aXS8TWgoqA5zXPz9eF9vtuaRDRf1vFnb3daTTfvQaNX+Bzbt6Q1b7Fqz5P+IBintMqlmzKbtSv8IbKA/7T1XHFPpLMg2brbcJtqf1v3PhizeJ2/76NT+YtvMyfsB+/2Yb3vu2nsyI0x853fH/w0Dy380R9+2m4zR5lwn3FL6v8dbYbiOHki1m9VtiFl7fNjrLVvEtyScTbL4JyYgVVk5WHe6oj72be0M906+Y/TUWKuZH0ig2m3ixH3n9X9g510prFymjfyLkhbXDH9g11zuzp8ytDwG4hzT7AEn4/uwOv6hz+REOTIKcz9n4DkIb7PjIyasFFdGuoWfYJ2V8hXxn9c8xnA448GWqAdhECZh8MzPwsbDD+cHIhKvaAH/QoUzKtjJ15EoyGWax2gz8p7hGddIdG8H3TBX6yZB3mFo6bu6JCWT7hdaHBZrQfyv7d75krDsVvXALZjSNm0bU6FrS0UkKqZS3+E64v7k7J3RSRWHyWS7mIckXDiccXHcs9yG17uKXG9CcMFIDABaBWLDv8ODemwVYriZW53VCcQj+14dP3s38WeE0wxXznAAwiztFvNq3fXcNOTcQNgGisrzW26KUvmNknD0boKOcAPPlHZh/uoMytz7oMSYDiKgzqyzI3YE9cJfFroy7I7DL7T49aYjPJ1UqV4dWoz9oaUCJTvSViVPxf6xcd7afvn75lHT69sB23HLehGURt/KhOfsPB4vPY2R/LtY94C1hwL0IdUGAsnDaU6wobIWJjW9gGdv/RmZHPjxZPvCRp+/PlfvDlgjp2Od+4mntMAhJMVrbJ0Q/1qxS+0ZLUWQ6TyJNlcFC6jP2VYXY6GyPjwOVYImsYfeXonKQZoz2/OhrT3ttf14dA4fzuHZHx8vDyKYvLz8DS7Gh398vIQP52G3ycVb6J/0+keHx1CMddwtxq+3O6dUmwKdL/u5jElZnxVXyC0xzggGnd690M3n8w761x1tZt16re2+npy/fHPx8pDXLCPhpMsbGPDOSnRcraMXuJ0NYR/0BsPOUafPa0ttXYFqSx+e8PvDsko5STMxr4vJz9ujn7dHq9ujOkcz9e2WOUrF2KpCOx/K3ydxOwgj/FT6pr5RAsMFlJJM/5plMDzgtmW06o4CMK8jkWnrWPLd3RQtXZl8ueTH4UrDV0hpOWNsLjH2YvnntdGjr41aY81Xelu3R76oipHw1f0WjU/2TwzJs/c1Gz2AB24SWzVa0Qa12NZnpWnA0vJ63cZ65cK7M9+xb626R5qX2yTv95eXIhJMLZpsJehW/8HSWzXaJS5r9Ty/al3yC6f3V7T4df15eLN3wZosha/ZP9zB/xvMTjxE
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read key usage</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/keys/{keyId}/usage"}></MethodEndpoint>



Reports where a key is in use: the credential definitions and presentation definitions that sign with it, the status lists of those credential definitions, the issuances and verifications in flight, and whether the key can be deleted. The items come last changed first.

The report reads the organisation and its sandbox organisations only: a definition of a sandbox organisation signs with the keys of its main organisation, and no other organisation can use the key. The delete key operation applies the same rule.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key","in":"path","name":"keyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Keeps the credential and presentation definitions whose name or ID contains the text, and the status lists of the kept credential definitions. An ID also matches without its hyphens. Case insensitive, at most 128 characters. The in flight counts and `canDelete` always cover every use of the key.","in":"query","name":"search","required":false,"schema":{"type":"string","maxLength":128}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the usage report of the key.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"isDefault"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the wallet signs with this key by default.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasCertificates"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when a certificate chain is linked to the key.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential definitions that sign with the key.

</div><SchemaItem collapsible={false} name={"count"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items.","example":1}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>items</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential definition.","example":"7c2e4a9b1d3f4e6a8b0c1d2e3f4a5b6c"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the credential definition.","example":"Person Identification Data"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinitions</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation definitions that sign with the key.

</div><SchemaItem collapsible={false} name={"count"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items.","example":1}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>items</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the presentation definition.","example":"9d1f3b5a7c2e4f6a8b0c1d2e3f4a5b6c"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the presentation definition.","example":"Age over 18"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>statusLists</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Status lists of the credential definitions that sign with the key.

</div><SchemaItem collapsible={false} name={"count"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items.","example":1}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>items</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the status list.","example":"2b4d6f8a0c1e4f6a8b0c1d2e3f4a5b6c"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialConfigurationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition that the status list belongs to.","example":"7c2e4a9b1d3f4e6a8b0c1d2e3f4a5b6c"}}></SchemaItem><SchemaItem collapsible={false} name={"issuerUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Issuer URL that the status list is published under.","example":"https://demo-api.igrant.io/organisation/5f9a1b2c3d4e5f60718293a4/service"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuanceRecordsInFlight</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential issuances that are under way with the key.

</div><SchemaItem collapsible={false} name={"count"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of issuances in flight.","example":0}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>verificationRecordsInFlight</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Verifications that are under way with the key.

</div><SchemaItem collapsible={false} name={"count"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of verifications in flight.","example":0}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"canDelete"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when nothing uses the key, so the delete key operation accepts it.","example":false}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keyId\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n  \"isDefault\": false,\n  \"hasCertificates\": true,\n  \"credentialDefinitions\": {\n    \"count\": 1,\n    \"items\": [\n      {\n        \"id\": \"7c2e4a9b1d3f4e6a8b0c1d2e3f4a5b6c\",\n        \"label\": \"Person Identification Data\"\n      }\n    ]\n  },\n  \"presentationDefinitions\": {\n    \"count\": 1,\n    \"items\": [\n      {\n        \"id\": \"9d1f3b5a7c2e4f6a8b0c1d2e3f4a5b6c\",\n        \"label\": \"Age over 18\"\n      }\n    ]\n  },\n  \"statusLists\": {\n    \"count\": 1,\n    \"items\": [\n      {\n        \"id\": \"2b4d6f8a0c1e4f6a8b0c1d2e3f4a5b6c\",\n        \"credentialConfigurationId\": \"7c2e4a9b1d3f4e6a8b0c1d2e3f4a5b6c\",\n        \"issuerUrl\": \"https://demo-api.igrant.io/organisation/5f9a1b2c3d4e5f60718293a4/service\"\n      }\n    ]\n  },\n  \"issuanceRecordsInFlight\": {\n    \"count\": 0\n  },\n  \"verificationRecordsInFlight\": {\n    \"count\": 0\n  },\n  \"canDelete\": false\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The search text is longer than 128 characters.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key with this key ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read key
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-read-key

---
id: config-digital-wallet-open-id-read-key
title: "Read key"
description: "Reads one signing key of the organisation by its key ID, with the key store that holds it. The key has the shape of a key in the list keys operation, without `usage`. This operation returns public key material only. A sandbox organisation reads the keys of its main organisation."
sidebar_label: "Read key"
hide_title: true
hide_table_of_contents: true
api: eJztXO1z2zbS/1cwvC/SDEVbsp0maq/zKJLSc5M0Tuw0d5cnc4RISEJNEgoAWlYz/t+f2QVIgi+ylNz1y3OdyUwsEgQWi335YXeBL17MVCT5RnOReWPvHaOxIiJjRPFVxrMVuWU7IpZErxkRckUzrii0JYsd4Vrh68uZT7Zcr7ERPFBaSEb0mmqyFkmsCNcBubEv11RhQ7WmGwZdU3zMM3yacKXhtyJiwyQOZToXuSZhruiKhdAXdxoQyXQuM0U2+SLhEXaXUs0kpwkRWbILyIQomsULcV+fhMTpWrIVEANzSinPau2C/8083yvHu4y9sReJbMlXM77imiYfaJIw/WbDsssYWPiS7Tzf21BJU6aZVN7445cGp99n/HPOCI9ZpvmSM1lw+Ra/5dBmQ/Xa872Mpswbe7dsdxl7vifZ55xLFntjLXPmeypas5R64y+e3m2godKSZyvv4eETNFYbkSmm4P3o9BT+qxMC66KYvOMRs4xkcUFI4PkwUc0yDR/SzSbhEfLg5DcFX39pjy4Wv7FIe76nuU7gwbWRJMOT+thvDgvaYdEiNDMEzy5nyryKRMrIUoq0lDyaqS2TKHz7peRSk4zd2WbQ40byO6oZ2VCpnfXx8Q/JlkyyLGLOm0KMN1Lc8RgWVRJKFIsk08DMjQQp0tysh1nR1sI1ufSYqJjZbVH+SEpvGXDER5ZwTSKaZUKTaE2zFTNN72gCfVkdpCkjVJHwt+1tcMvjEGhk9zTd4MqdLUf02TA6/27xND5nT5b0NLqIv2PDp4tno/Pl2an3UAhnewpZniR0Ad0YKU3p/SuWrfTaGw9PT5tT/AUIcRm84ncMjQzNCI1TnnGlJdVCku2aZRW7FYkko5rFwOlSUvJNDMuGIlVobUBCoCmsdwArnQkCs6jP/epyRrhSOYUFHp2OnsBkb9nuGgSwS9zbWtUpr45m1YWB/5uSYIaqTyIREU0GYsOyBRUwAdP9oWFudhvW3XOWp974o+nX8707micw91W0GdymyvM9ulXFX7/nkg1u2W5QtIo3AuxXpCLvU4vKx2TpUVnpmvcr6JGYcR8eXJP5Efhs+WAH/PTge0LyFc+OkeM6LX8T25KOCOjSomXBAhJaGQ2N4bDaWghuw3RUUtOjiRLwmJIoEXlMXr6+NgZldiVmaJQ4urEOs9kPSMjTjZDVsOZnXSlI0abSPFQiq0zgdCmJQEiXYPgZmBIOMyqNX9E7dLulitAEnGrHbCyRhWX0S7Nt2QF+QJnRuYYXdZGz3ALXaElGV1hQUZeoovGD79FkJSTX6/TrFxccF9W5ZKTsxLW8NYmbX48u0EQoTXWuDkvxNbbbZ8kdZhh4ZCxIAZ3MtyGNNL9jDaNtHgIpXM3YEnWgomYhRMJo1iZnLbaKhMAGx0K2qdGAvICgxY7Epvfa8NDBg+/9tr09bCOvKkfMM/Lz9ZtfyAe2IC/ZjvR+/vCyT5ZCptQ68AKiKJYhQk12hSNPWbpgUjnu27RxHTg6e2xHQuPlGp5Y7w4vGRAGLeoE0WRLd6ockys7UIl4FaGSEZYk0FFEolzemec+UcZalD45nE8bqzmfwkpG8u4wefP6CJWTaFByNRhdPNlHAL5s0IDPgIz7w0T8nURCyJhnwHUr3I2pbwTPtA9LvqCKPTnPZVKsdG3YH8rXg/tB1euPQMkRq/WPP4SSXZOS22P8NkhOcz26gRhCwm+AYTRZHWFzOgzaUsjK9sMPOy4J0aSF+IxWQrPH7N1fRM74VEraRvvTph9xvThFKM+V8RYxrkrC6BI8qhRCEyEBT/cMOZop7fol44OwfeFWsAl82Q/InEbgVVgKA1C72oRlkYhZTGbzd25fDfWO62ptTE8LQ3Z6SegnvL+IQrJmNDZojaI1tatgSU1jEWFD+Cwka3rH2vPhmWYyZTHHAarBVLU/xmnLXMGWKFoLCWsFsz7CHcFO7ABbEEndX+gj5Oxvk8GQ6HWeLjaSZ+XWCefzR3B6n7aqNR0OKjp+NJKq/4JSe9Q0QOqPmcgvQps1C/8SFtjHTgP3FjjTfJMIGrfpd/AY7Hsck2CMBBiG+wv9L9W2zfXJji6etKcb/Yvdb7g8wmTOsR3RvALYzZmiXr6/mf4xSzc6HX03GA4Ho+HN8HR8Cv/+2QLw4KsBs8c8VgdtTldMoMAwX6keMYtYpiVNuGKxuwfrzS5n/QCYXc7kI1A3vmW78e+jOP199nQYra7un/56y7/7eZHnr9MX/5Afrlb/EDu9u33/zzO2+7zWw9+evVx8/mcQBDi/NVWOxZwCt74ZyJUrkJG/Bxenz/ZYq6pxRDM0VNWeOry/OH0WdvnHJU0UgD6nz2uRy+iouECd+g8A+3G4DiWpnAWspcLFDEhotKrciBxWsiO3RhZ919Q8BK8yiKj9bpHzRA9A3cHZTCekh6Tj7qPlo6qu+8bTxuyOJWKTsszGsJjSEAkzwajws1YbO06tF8OGtzfXVzASiiFNHo1udGud3VgV7KvvrOw8Pd8DMjwfOne3WPD7wTRzhPRr5bMyE2FLeELEowW/jb1p8RsiNHbzWjNS2zUHj6+O4LOJ3Sp8c8ckqrQiIteKx8zYik1CNcg9iQWBeJrxsfygFlxJplinv3xcC25w5wLfFqv9qDb0ysC528x04ITJ+wF58Qh4qgaEGDgYXKa0/SQjhZSY0ZtfwK+MbXFRrt/VNrUNsZQIeTOR1SM2VpwcoiZKMaXSIvKcJG+WGEXfF2Wedn7ati9Ud/q1GhRNErFV4zK/gVkH3PlZbSy1jsCngKSZdTJckyXXyrRLZ6/ITEQ5Ch5gbyYh/LHkCbhRrcjb6Or6Oe7mGbTxHex6r8vYgAI4GK1ZdGvwOWBZO249aFBlMx4TF0iGYLBmf3zHL4Op1GLwgm1F6MrElWFA30IW2Lm8B0ZB8DC0y+4Tlm70DoVT+SRM46RgiOFHSELUm9An4efoSi2KL62iAhtUHq0RAk0yMp9MSMZYrDCqDgtQX0Kgd0UTsmFSicwmirotYUDeGRlvcKB0eFa8YcgynN9jlA6KX/0gRPYbMq1tiESeOUicxQPUTHYPnHCCdYANQLHMiyKYbeIXki1zxeLOhEHJ428zK3V53ofySG9+c31J5r+Qs+Ezcj4cDUYkSmiuGDkPzoKRTzQMQ4YQZpyEY1Dod2yTw+bEONjnrYe4orHJl5Ub0YCE03Dc9XjW8Ri7uGW7eRbxzRp2QwDJJTyarCRDJQpIOA/HR7R60aLQ/9YBG57XZaQBXQIsn8P7nrvRRoG7ZTuwYDByH0bIRNXc9dYTz/eee7439Xxv5vne3PO9F2337D0HOAqmaFoaq2lpqw6i5pvHrVxzkjCO64U6v3TRT5nQBUcQgkWCdEurS4QH4YYDTIOVoK1mxki1+IuyjV2Azhe28jG4X7qRJrtMzrXNHh4be9Oe7O4rWDE2YanL2eS6+rzVL6aa8yqNBUwjvQawk3nC+r5hF+kZA1juUkzSlsRUU2jDKMUOssHnnCYAeWJCNeCCYoXCz6ZN93uQ0HCTLwamkfOqQGSLHbQxwRobp1UsgvzdQsS7vivSMB2wdJiYYRQxp/nPjlCP7cOD+lYLmzwi7i+EfB0nf4jQLw06Ak9fW6W2iEPvsEQmBuvG/KCPcB/toU8W0AswulwV0IWK/ZglolHErBsxKoA5vGnh7E0Ev4tSF4N3uGdeYvUCm7hiir9rvXFloh9coQL8qXP/z3WuJTLfHKJoek2s6OhGz7Bal9dvTi7nUzJ8ejo8G1yQGwQkz4Mz0quUIGw6dCPG7F6zDDYzTsthcBpgX8FFMAxGoHdCr0kkueYRTfqdmtSLRYS+JhRyFXAlnC7S2auwb7WrzJzZCXRuHBH/HrnZUfIttu7Sksauwoh2VZCyJCxhkZYi45ErYLjfoFpLvsg1lJEcI1Skd5U/H8wnk/6YIGS8uSZDCxmfFJDxaXCGbJ9kGbsnE9+h7c3ljISnwTkw/9n5cPQkGAZnCAiqNgihkoTotWQ2IqqMPbUIvdCKEpiHdo/AO2puEJ/L3ZvlK7biKqGGcQcrItDQ4ZclZqZbQCUgiORs+OTJYEhosllTgMoiZriHCufvTQJlngMRNCPvM1DYhG4txK7x6+r6+eBpcDY4vUBxu4IgLoj1NRKFA28FbNEkjaCsrAg016L0rt5ezzE3lOu1ialc1kzTcdPOM5ou+CoXuWqaNssJ6B+eR0ThKKRXTuS8X08qUWOixZJIBry/YyTmGI3JuVqzGIPlKiATTVKhNBmdnj91JuwjnhOZliKpHtfnHGV/ndvR3sESayZ9UT6aPPejvxq2JJUAfAtfunkBK5tnoGgmBIUbybbacIiwYGUeB7NVJOEe4eSoH5D3Cjj4/t0l6b17MSVnz54+6RsDChWb7B522c4nZ/1/i5FrrTdqfHKy3W4D+zRQ7CSh2xOohxoMR2et2Hyndj0igY+twieoXzy8o22au17bnvSNDbSmyilBMduHlm05tKHLRHNUN6hiLH1FkPEY6AhwjV2Ta0QFkCSahHAvNwD8dTE37KNptbWOqkOCwn3MD/v+ozYbMxoFQHrNFPhJdaR/aiG68vvmEr4oQ1ptUOc/GgxDVE6baNYGq0pgt4IYaK10ZYzaAr1W8TQAchXMh5WMBVMY0FlCPWUZFFry+4BMMieuVY+4A44PnKhQE+zzjISqLIidwkSC1PLGgBNowaQU8nX5GKXXBoWQA223hoCuvcPZg71BbTe1woUjPgDI91UffP7qLwrw+RUfNQzQEcAWzMp/SgYNLqqLoAkEG+ExOLHcP0D1gSkXoq4IoaalcTJ1+/lT4/7UuD81rlvjuuIYvTBV4l9QShMa4Tm8N2tIbkBecKl0PcqBctorYrS14IqNvEC2iMUmjLM/TNPHaRmxbe5dm9tcGLO0GQA4SvDQ2bJdIeGmCR4JAx8MmXXt74uNagc2eMSIdcjAV+Ti/KJw41Bq67Iqkv3KzF1XeO/b0njfksWb3zG5KxNVeIIDZetQpg49h000veJKz4s003Fe46bryy6QvT+XRY2B31OlYNNaWMNu+0ATjrtjnIGCAj+zLWQxmU4C8mHNE2PCq4Hw5BGUulGjkAVTnbNDjovq8ihOZZVpKZnKE4is4iBGWzNhjD7UU9zUCOCKLEQOCyu6ZbY28JrGlZOqOoH6eAhYAM6ny2us1wr743oWA175JLQzNhFYkyM1BkUyqkQWEgUwYrve4dMtji4gCdkrdy/ARjgeZXqCVB1w+b3kYVl2avYIRXVsQahZzvfvXhVvWktHUbibe3vJIqjSjKFUiisMnL4pLFdZQ2ECsQKqtEE7INuZijs8t/Q9tpxcXdYPLpWHuAyDbL332JlOr0kkRFNtcZp9W5SqFft028gtOzHrYZoXtX9Lnq2YrBX/dYh50VtKdbQOSW9tj4Xs0QhsZstWKmr1RBcz4WlZaGf2d/D6+S4kve1aoAjxsqzV9JtixdaC2b1rG65YXh2TNW6HAIrtfyTSE52cuLE2FdyneHjHMvjrBijCMu623GuUkuGyHO4WIzqFVh3VHJfhqJa4OF0tTTWcN/bgvNkA1u3R6Zq4yelgNHLrG7H/5531mS1KrDJ3RtmbhzCMpTii2wZ8KMY4MgBzsM6B9MBLurrQ5RL6j5awlf2ix/usorh9ktXkFXjjZBi5ZWxTQQIct8qwVMXYWLWHCRuGhqL39no6A6KKAhXMv5QRZrPzs4dW3R5NcVhhbqrKEec0IKLSSEWhzUWVjcBuxkV029T+VqWO9Wl1phBw7ONc/0u2Q+/f6e4d/pTHlJzJ1g51HZ67qaRqeUy6AvdvnOb8fU0WVK2uCf01Hg9onv2szn9ZL1gE7ESWsagphoZkcH0MRmrbyGPPboXljMM28nFRTcWZ2sRzvYbTFzvSK1iFIjGdnLydVhtfy/qVpJlmMaSSulhVnvXFkw3dA6KXrpI+pcyj+3VfMJoAphCqfnKqUNcutUFHDnh6n/pkQg+a/KqtNSAZkgmo5M1uM7HNbCMQDpqYMGdhBhqTtwDGL/IKFjYsmC1Nq862IPYykIJFtywmO3Mgu0iIlhSCdXQp9nzPklVPiVYNwF2ZTrt9xAEL6hTbYzdVhX2XOdw3jbaLGdZdTMw05ck30AchGBppu01aFWdTDHyuI8CmKlSCXm6JWpK7XTNEdc23xdq5/SHkrQHtQjJB2Op8eHuUJoDAf29tcFveoVeDyN5G1/B3LanaoO779hSKXAF8WsiLyaUifLuEDKsck+kvf73MNFOc/CRFvgEhr6ifV9Reg55NJ+SnMzKfTkkP7YVfGAi/wb4lubzpt2MD1sa5MlsKxxEOH/F8w/c13EHpzdCSObaySPn3yuCKqXE3oZFOp1OGAR71FVZRcHFxI13WgyFawCjAcUf2s9wcX1m6oYKYLXnGTcIGRBbTzpkuzF31EkWzfmoCoxLlJqjjdpPy8pLa0dFJ9/gmBw3xIDR6ECJA66Bg2nCNhSnergXG0MjDU8tVY3Mhx1PSh7VJjLr1EF0nkoyUqI6ceknrrOKGw3A4urbC0FHjJP8hbu9hqKvoIwhiOgvyrRR87aK6NAxbadBOhuwn9BOe8cUz6//GPqNx2rJwyO5xLjzlaf1Lt9s4rbsNc5PGf44q190lVJVb/G+jrx33xMoxvNbBua2jvN/BvQ7Ar0xhdVDenFy3Z8u6j2B1nXNqH4TpOgey73zDngie3eYUqN6VEHddPmFE3hwwBZGHX+enQ1PrcuTVPS4TMRMyFTHMAf+eOQv4yW8Z0bopqL7uUr5yPc9PTx86uu+QMaekmUKqZpNrUl6sBNmIh4f2LSkWePyO8K3JmvP/YtbcNK/xshClXrtgLvUKWry7MPdH/ZfyDjCazGiC+1smCQ7T4BHGcqIcMC/uvicbDvdejT8itNJ0BVeBefbWMHv0jPTw4rDZ+a/TvufjXQGvaUZXCDSBNSnTawF3jq3QiOCtYGPv5G50Yhz9ia1yHJj98gnc98PjE7h6Jy07gp/q5AuayAfPhOu6byabsVTYOYKhkYkTCIxZKgZ0wwOOqDPgcKtQs4MrKeLc7L73dHOoh2tNVxDX3/O5Mq+bhHyqmH8NMmhEp1iCKsFpHtg71szqVbesTazpKOqT6oRBbBrxaFFmY+uDq3iNdWRhrZ/yAoAU4iMLrFxc8nsWW4xsaCRYH2zPkWtJeYI82NAIioxZsAoa3Y6J/fCHncglsAPuW/oxNKifZ0tRqCuNUF1ZintAT+UbOOn5PxXzyvnzn6pHda67C9ZgS/lRAf7xrLcADdN4ujZBGaxVyhmhR9D+Kx67xALeKhmpcH+E12/13qB2XJpYePeHVy5+KzXqqg8UaRGJRNnTYLCELINvlDWFv1ucrIUpevXxqi6/OhG6Kw4GOTgVIDQuj6ZZTGWsBjhfTjNNlpCzNEtrOY3Ufjibkl+ncLfNTd8nl/ObF+R6Nvj5ww35dWpGg1rSIimczkR0gmnuChsbwIUIPOERyxTaw0JyNzRaMzIKTltLByV8FF8HQq5O7Lfq5NXldP7L9XwA3zxUscFqOYFZsc19FhoBZsMs++h0BMfBhvDtRiid0syh553dUTSVyHEgf943+ch9k9ZcQaLtZJMA9Hyw6/rF+oCP3t3I3NC45BilrPkBc2VlhnUZdV9gHgDAHRvI/Mn31gIixx+9L1/gRon3Mnl4gMefcybRf8Flb5IbYA8ugyv4O7ax50eWuPfOooA+OXDnZeeEC6Od7fC+uSSHX2YC5Z2YD59KBIzEmXcTPBLjfNUCKw+uc/1pfmMrVeu+wtBm/3Ai6nWKmm6jJA+9W+cnP4ByvWS7H8vm5s3eD0pXZVoDfwD8/x9c0901
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read key</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/keys/{keyId}"}></MethodEndpoint>



Reads one signing key of the organisation by its key ID, with the key store that holds it. The key has the shape of a key in the list keys operation, without `usage`. This operation returns public key material only. A sandbox organisation reads the keys of its main organisation.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key","in":"path","name":"keyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the key.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key. The wallet makes it, and it cannot change. The value is the same as `jwk.kid`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","nullable":true,"maxLength":100,"description":"Name of the key, given by an administrator when the key is created or with the update key operation. `null` when the key has no name.","example":"PID issuance 2026"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyStore</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key store that holds the key.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store.","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the key store.","example":"Local vault"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`created`, `imported`, `referenced`]"} schema={{"type":"string","nullable":true,"description":"How the key came to the organisation. `created`, the wallet created the key in the key store (also in a cloud KMS or a DPoD partition of the organisation). `imported`, the import key operation imported the key, with or without a certificate chain. `referenced`, the key was already in the key store of the provider, and the wallet signs with it there.","enum":["created","imported","referenced"],"example":"created"}}></SchemaItem><SchemaItem collapsible={false} name={"algorithm"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Signature algorithm of the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the key. The wallet signs with a key that has the status `active`.","example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"isDefault"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the wallet signs with this key by default.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key in JSON Web Key (JWK) format. The service sends only public members. It never sends the private key member `d`.

</div><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type. The service always sends this member. The keys are elliptic curve keys, so the value is `EC`.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve identifier. The keys are P-256 keys, so the value is `P-256`.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier. The value is the same as `keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm for the key, for example `ES256` for a P-256 key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Certificate chain of the key as it is stored, in leaf to root order (for a test certificate, the leaf and the test root). Each item is a base64 encoded DER certificate. The service adds this member only when the key has a certificate chain. The `x5c` header of a signature and the mdoc `x5chain` have the leaf and the intermediate certificates, without the trust anchor.","items":{"type":"string","description":"One base64 encoded DER certificate."}}}></SchemaItem><SchemaItem collapsible={false} name={"x5t"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-1 thumbprint of the leaf certificate. The service adds this member only when the key has a certificate chain.","example":"<base64url-sha1-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5t#S256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-256 thumbprint of the leaf certificate. Note the `#` in the member name. The upload certificate chain operation gives the same value as `x5t_s256`.","example":"<base64url-sha256-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c_expiry"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry time of the leaf certificate, in UTC. The service adds this member only when the key has a certificate chain.","example":"2027-11-21T10:00:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dids"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"DIDs that come from this key.","items":{"type":"string","description":"One decentralised identifier (DID)."},"example":["did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ..."]}}></SchemaItem><SchemaItem collapsible={false} name={"hasCertificateChain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the key has an X.509 certificate chain. Then the key can sign with the `x509` format.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSource"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`uploaded`, `imported`, `test-ca`, `qtsp`, `null`]"} schema={{"type":"string","nullable":true,"description":"Where the certificate chain of the key comes from. `uploaded`, the upload certificate chain operation. `imported`, the import key operation with a certificate. `test-ca`, the built-in test CA (the create test certificate operation), for development and testing only. `qtsp`, the certificate of the QTSP credential. `null` when the key has no certificate chain.","enum":["uploaded","imported","test-ca","qtsp",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"testCertificate"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` only when `certificateSource` is `test-ca`. The built-in test CA issued the certificate, which is for development and testing only. Wallets and verifiers outside this platform do not trust it.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificatePreset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The preset of the certificate chain of the key (the list certificate presets operation). For a test certificate, the preset of its request. For an uploaded chain, the preset of the newest CSR of the key. `null` when there is none.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>certificateAssessment</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

What the leaf certificate of the key allows: its key usage type, the credential categories that it fits, the mDL Document Signer profile, its QcPSB statement, and the texts of the save check for each category. The wallet reads the certificate chain of the key. A key without a certificate chain, or with a leaf that the wallet cannot read, gives `keyUsageType` `null`, empty lists, `mdlDocumentSigner` `false`, `qcPsb` `null` and texts such as `An EAA needs a seal certificate of a legal person. This key has no certificate. Request a certificate with the preset EAA provider (eaa-provider).` The texts do not count the trusted-list exemption of the key: an exempt key is never refused.

</div><SchemaItem collapsible={false} name={"keyUsageType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`A`, `B`, `C`, `D`, `E`, `F`, `null`]"} schema={{"type":"string","nullable":true,"description":"The key usage type of the leaf certificate (ETSI EN 319 412-2 clause 4.3.2, table 1). `A`: nonRepudiation. `B`: nonRepudiation and digitalSignature. `C`: digitalSignature. `D`: digitalSignature and keyEncipherment or keyAgreement. `E`: keyEncipherment or keyAgreement. `F`: nonRepudiation, digitalSignature and keyEncipherment or keyAgreement. `null` when the certificate has another key usage (for example with keyCertSign) or no key usage.","enum":["A","B","C","D","E","F",null],"example":"B"}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategories"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits (the list credential categories operation), without `none`. A PID certificate fits only `pid`, and a PID certificate with another key usage type fits no category.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategoriesForMdl"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits for an mDL configuration, without `none`. The rules are the same as for `fitsCredentialCategories`, but `eaa`, `qeaa` and `pub-eaa` also accept key usage Type C. A key signs an mDL configuration only when `mdlDocumentSigner` is `true` and the category of the configuration is in this list.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"mdlDocumentSigner"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the certificate has the Document Signer profile of ISO/IEC 18013-5 Table B.3 (key usage `digitalSignature` and extended key usage `1.0.18013.5.1.2`, both critical). A key signs an mDL (doctype `org.iso.18013.5.1.mDL`) only with this profile.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` when the certificate has no QcPSB statement. A key with this statement signs only the attestations under its law (`legislationIdentification`, `countryOfLegislation`) and from its authentic source (`authSourceIdentification`), ETSI TS 119 412-6 clause 8.3.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>categoryMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for a configuration that is not an mDL. `none` is always an empty list.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mdlConfigurationMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for an mDL configuration (`mso_mdoc` with doctype `org.iso.18013.5.1.mDL`) of that category. First the category rule (with key usage Type C also allowed for `eaa`, `qeaa` and `pub-eaa`), then the ISO/IEC 18013-5 Document Signer rule. `none` has only the Document Signer rule.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustedListExemption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trusted-list exemption of a key: the certificate of the key is in a trusted list, or chains to a listed CA. While the exemption applies, a rule of the signing key check that the key does not fit gives the check result `exempt` and no refusal. The exemption is bound to the leaf certificate that the key had when the exemption was set (`leafSha256`): with another leaf, `applies` is `false` and `reason` says why and what to do (`null` while it applies). `listUri` is the source of the exemption: the URL of the trusted list, or a text, for example a recorded decision. Only the platform operator sets or removes it; the API cannot change it. The other members: `listUri` (the trusted list), `service` (the service of the list), `certificateSha256` (the SHA-256 fingerprint of the certificate of the list), `match` (how the certificate of the key matched the list), `setAt` (the time, in UTC) and `setBy` (who set it). Each of them can be `null`.

</div><SchemaItem collapsible={false} name={"listUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"https://example.com/tl/eaa-providers.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"service"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"Example EAA provider"}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"leafSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"match"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"setAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"example":"2026-10-22T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"setBy"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"applies"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the key in a qualified signature creation device (QSCD). `false`, or `provider` for a key of a qualified trust service provider (key store type `csc`): the provider decides. The value comes from the key store.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trust</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The qualified status of a key of a key store of a qualified trust service provider: its leaf certificate against the EU trusted lists. The wallet checks it when the key is referenced and when the connection of the key store is tested.

</div><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","description":"`qualified`: the certificate chains to a qualified certificate authority (service type CA/QC with the status granted) on the EU trusted list, and it is a qualified certificate for electronic signatures or electronic seals whose private key is in a qualified signature or seal creation device (QSCD). `not-qualified`: the trusted lists say no. `unknown`: the installation has no EU trusted list source, a list cannot be read, or the key was not checked yet.","enum":["qualified","not-qualified","unknown"],"example":"qualified"}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the check, in UTC. `null` when the key was not checked yet.","example":"2026-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The facts that gave the result, for example the certificate authority and the trusted list, and whether the trusted list or the certificate says that the key is in a QSCD.","example":"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The number of credential definitions and presentation definitions that sign with the key. Only the list keys operation returns this member. A credential definition counts once, also when several of its configurations or its status lists use the key. The read key usage operation gives the details.

</div><SchemaItem collapsible={false} name={"credentialDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of credential definitions that sign with the key.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of presentation definitions that sign with the key.","example":1}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Creation time of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Time of the last change of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keyId\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n  \"name\": \"PID issuance 2026\",\n  \"keyStore\": {\n    \"id\": \"local-openbao\",\n    \"type\": \"local\",\n    \"name\": \"Local vault\"\n  },\n  \"origin\": \"created\",\n  \"algorithm\": \"ES256\",\n  \"status\": \"active\",\n  \"isDefault\": true,\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"x\": \"<base64url-x-coordinate>\",\n    \"y\": \"<base64url-y-coordinate>\",\n    \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n    \"alg\": \"ES256\",\n    \"x5c\": [\n      \"string\"\n    ],\n    \"x5t\": \"<base64url-sha1-thumbprint>\",\n    \"x5t#S256\": \"<base64url-sha256-thumbprint>\",\n    \"x5c_expiry\": \"2027-11-21T10:00:00Z\"\n  },\n  \"dids\": [\n    \"did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...\"\n  ],\n  \"hasCertificateChain\": false,\n  \"certificateSource\": null,\n  \"testCertificate\": false,\n  \"certificatePreset\": null,\n  \"certificateAssessment\": {\n    \"keyUsageType\": \"B\",\n    \"fitsCredentialCategories\": [\n      \"eaa\"\n    ],\n    \"fitsCredentialCategoriesForMdl\": [\n      \"eaa\"\n    ],\n    \"mdlDocumentSigner\": false,\n    \"qcPsb\": {\n      \"countryOfLegislation\": \"SE\",\n      \"authSourceIdentification\": \"cn=Example Register,o=Example AB,c=SE\",\n      \"legislationIdentification\": \"https://www.example.se/law/2026-123\"\n    },\n    \"categoryMessages\": {\n      \"none\": [\n        \"string\"\n      ],\n      \"pid\": [\n        \"string\"\n      ],\n      \"eaa\": [\n        \"string\"\n      ],\n      \"qeaa\": [\n        \"string\"\n      ],\n      \"pub-eaa\": [\n        \"string\"\n      ]\n    },\n    \"mdlConfigurationMessages\": {\n      \"none\": [\n        \"string\"\n      ],\n      \"pid\": [\n        \"string\"\n      ],\n      \"eaa\": [\n        \"string\"\n      ],\n      \"qeaa\": [\n        \"string\"\n      ],\n      \"pub-eaa\": [\n        \"string\"\n      ]\n    }\n  },\n  \"trustedListExemption\": {\n    \"listUri\": \"https://example.com/tl/eaa-providers.xml\",\n    \"service\": \"Example EAA provider\",\n    \"certificateSha256\": \"string\",\n    \"leafSha256\": \"string\",\n    \"match\": \"string\",\n    \"setAt\": \"2026-10-22T10:00:00Z\",\n    \"setBy\": \"string\",\n    \"applies\": true,\n    \"reason\": \"string\"\n  },\n  \"qscd\": false,\n  \"trust\": {\n    \"status\": \"qualified\",\n    \"checkedAt\": \"2026-10-21T10:00:00Z\",\n    \"detail\": \"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT).\"\n  },\n  \"usage\": {\n    \"credentialDefinitions\": 2,\n    \"presentationDefinitions\": 1\n  },\n  \"createdAt\": \"2026-10-20T10:00:00Z\",\n  \"updatedAt\": \"2026-10-20T10:00:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key with this key ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read test CA
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-read-test-ca

---
id: config-digital-wallet-open-id-read-test-ca
title: "Read test CA"
description: "Lists the test root CAs of the organisation: for each root, its trust domain, the root certificate (PEM), its subject and validity, the URL of its CRL and the URL of the root certificate. For development and testing only."
sidebar_label: "Read test CA"
hide_title: true
hide_table_of_contents: true
api: eJztWm1vGzcS/iuD/SQBu5Lfkra6NDhFUgq1ru2z5Qa4xIDo3ZHEepfckFzZOkP//TAk902Wz27RL4cmCBJpSQ7nfZ6Z1WOQoI4Vzw2XIhgEp1wbDWaFYFAbUFIaGA01yIV9KNWSCa4Z7R7AQipAFq/sthA4nVSFNpDIjHER2iOWRIzK8AWPmUHoXEx+7brdurj9HWMDTCSwZilPuNm4U9eXp3QnbRpdntoNjcf76Pbgo1SQ4BpTmWcoHFWSgoslSJFuel/EFzHbkQJWTIMUTXkrsZrCDGCeJTKOOIvZHDrEwXQ4Gpbc0BrkCjUa3Q1hniu55gkqv7X8Wm4JYa4NM4WOUq5NpPlSoJqHMI8VJigMZ2nEtS6IAIkxjwttZDbvum8sjlFrT/vT5cVwVBJ26wq/FljRjTQTUSL0vNsDEp+u9GKnm0qXZHVmAB+4JlsKb29iuiF5U7SwYoTocg0KWQIZu0MNQlqiA0slVkiGtxomleWorO5DkMpuWHCljVtveopcAKt8ydGtLG/1zkrrWNMOYY2KLzgqt8o15CkzC6kyZ0oNbM8lpIT7FYonDl7atqLKkkRbl7QcMEvOuggrzEoq67xSOWLlklW25bRFqtCorQ1KgXowbLgg1yBwTYIIYAIm144aJpZeCFoCb+z6WrCU6CZeD5qJ5FY+tKUh6zRC20c1iUMabO3tfRFBGFR2mibBIIilWPDlmC+5YeknlqZoznMU0+QSWTJDbUYsCAOFOpdCow4Gj8HRwQH9184w5IEa1ZrHCApNoQQmLa56QUiXGRSGTrM8T8lSXIr+75pIPAY6XmHG6JPZ5BgMAmnzSBAGuSKuDXcMGMuWbmxkSrFNEO7h6cV898eDYigAs9xsnBPs9zHyASEFktTcYKb3SWW4SelBpeY2+8MW8/t5X7yUHOHPZkbozN0Hyi+TNaqN20zH73ADhWZLhPkdbkaozBVfijKnXZ66b51YccNjlnZDuGWaxxBLoY1iXFD+H8I9NyvImVlBimJpVnDQOsOqQkL3cZtAKcpopSwrpJUfYINMuRzJ4CI6evOWTjjRm+m94t/n7gVPXTYSML06708nIzj8/uDwOHrjikBnxm5ThA+9w+4ARiGchzA6g/m7pjrfw8znv87Z+Qw+nl/CxeX5+Ho0m56fdZ1KmACX9YGlBpVghq8RBMvQpXoKCxYbn8cbRaZVFVw2X7E1el6eOF2tIueVLpfcCXkvQkvrOe4vyjr2rBhS7T85tMw9e85JROazSb9Mgj7iUhmz1K5qIxWWHs6FNixNXcqCqYGYCSEN3CLgQy6VwSQs8yQlbKB6SA7v73mil069ubyZIvcON7quWt2wgiOtw/7yQiPdSaEizYpKfqFyqdHmtXZ64kkj2LVRXCyfxPa14F8LbFrMM+7TJVHFB5blNkEc3L5dfI9HLDqOD5PoBN8soh/Yd7fRYXyUHOPJ4g17extsw8AF7Mu328TYjPUG+KrVUGKP+5XU+KTCamcCXaCGztyl5LFLGCU5R6DbayfVvRhrLOPCJrAri210aOsa+qh2oMpZzYEf3WslZ6JTU7yYjkO4t7UshMlwaGn8iz6UR7Q7soduSeNqHP38aQa/jezhT8cj+ljDOE+gfuAjXLdwXa+KXltl8pTFlZfXkeMfuJ1tFXcsCnTwsLSRA4GVHshRRJEFg89BpWXnklbSIAwc4eCm6VH11m0YNK58ne/sgnQr3cXkVwqPjJkezKT3r8qlW2KVOM7lA0JVz0K8kOAZudo+XNaOkoj+fJj8ND2D0eRyNv04HQ1nE/v0i3h3yzS+PYkafEQejrz/Iuymydl4z0FSkK9Dr1NOWbRaMeXzjsEHm0MyWr38OIKTN4cnbSlGZz9O3BcYfvifxSU8b+wMRz9eTYhXIc0HXEi115TOPsEgSEh+wzMMwkAUaUqFLhgYVeCuSFeGqUqYZtltCXc9G7XFODo4ehsdHkRHh7PDg8EB/f23Z2+4MKj+Iu4mdWD8Ed6O3+zjLVbptUpfZ+VGy9psOxSupUO1Lqt0Rpen3Za/24rGyZnz4jblMShZmCorlFmLoJEsnKtTgol9NaSrmdD3qIiGTXuXpyTkeHLpow868ya4zu/4QxSrdN4NXc5I4LZuD3swscBvT49W9WQOMXFtZWa66t4TTvq5Lay0ueTCOP6cQNqwjQa2Ztyar8bJzfIO+p6beIWtBgbkYtE22MqYXA/6faednl/oxTLrN2t1v4VQpsn7vu9I+kQ5iln/natTtBSrdCf3/RnbPx1X/LXWbdrkZSujMuU04Jmk+yp4WRnbZS2u6owLXLj7yXi+YuGDQaEt0IrZ1JXB7v+VKzTq33ZL3e7XgitMqKbyJKhwVbtS1mWhmXQbGa5KKE+87IZuuWeKUOvr2ti5Y7smMwd/fm8/6vGYnpMf2cVXNaKjmv4nR31PUyqk80Vqz6wDLIrUe23oALkAVEoq7wIer3ANiW+I23A5lskrYccdd9m+kvypVhwsq2LIolOpQK/kPQXlnhR3W/DUROTpzuUGdaGmOE7vyXerR/5Q6XYUTYRxI7lGpXhCDNjmtMBdvOYbEDcXe8CkvcuR+UfrhNtgoxw93qWONcq4zpiJV17YpkyJRN8ULRWia7Br8uVltjme+wYmUlho3EMrXjU6A2qtVhaCOVJ1lyDwHkZXl+GeGqI8jSJPJUvceeG7J0tlYNsqGkYQ/WoM4TlrQttdQ1svamne+VVLQfSoKWQbAj8huQ2DDDWNNV7ZQTUcwrukG8gwyFFpKdqZa/zimGbXFUufsdPCzc6skEi4JOh6jhJBa5CF0TzBnVFpIp3/WQTNTQ/G7oFvbKk9UTIpYluJnqRBG6S1fm62uxvKmVwjr7lNK9fHBYNH+nZycOhi/pWDwOYVNqmMHCP287hhkpvwhaFhfbo2LhcGlzZTV2Y6OTjY7iG/xyFqy35gCXCRFwZypliGlPy3Wyv9btfvC+l/kMrKrmqO/8aqmT0DB5JdOACd+XOxUh2hbRa72FlTY5o07/ae6P2NG2f/TfU+FXYimdrhPSpXuXd0RB0wxgXhv2Dw+TEY5vwXpI83W5KREYb5HPh3COBeIkDHvkYYn/w26gZh8Atu4Fcm2BIp/5FqMjQrSW8glmg1w8wqGAT99VHfvZLoJ45e5JJcX+YoeNK/w02UVYRKNEdgzPKvLYNtEceYSS9eEAYFofwKRiaYyYjlvMeXignT4zLYhrsELqrE+ByZlyhcGbakXP/Mce2Wdxm5qfV+Re7nvKbUfo0a3YMwoNGfNxzhUJbR6tBnHOvOT+HcxdTW3n2dSAugzFt05uCugYyqya0FGA7VWMgxdzzCHDoWLdoQVoynVgc5i7EbAvYIwbXIDsAffLeRhSJ1RHe4eT939YhajzJSmZvGYMY4KVIXOQ2G/1krr5Kf/1Q/amu9abAdtVSHyomhBY+SgovAL/1P7td6n+j83QKA32wttr3OqB4ZAvVGTMQInXMbGFM32Nt/8ILgTXlFFUwXXeLIyFim2r+eJROioDPaT66dMjUY6SBwCCuZJmENEzbgg6s50YRCW/MYJhKmEh1ZeTkTBhYpwWdrWq9py62finZ+/jTrhjCdzD7WY1N32/TqvHqlko1l3M/Gp82hqesl7RAz5TEKbVNh6bk5i1cIR72DJ6a7v7/vMbvck2rZ92d1/3Q6mpxdTSI6s637mtqcpKzEz5rLiKC04cx+dHB00jvuHdLZXGqTMdHgh96IluVmN5Aa9ePbjy2+/dji248tvv3Ywv7YwpdoahX7eUpDpK3PZY8e8nwO1kfupxELbvvMFuxxv9cQdgrVhj5E3IOfmzBYSW2I1uMjvee4Vul2S4+/FqgsUAuDNVPczdE/31RtmUVLd4QmAnoflRNVW/YtrNhBwdsmavtpMqNXSwWJ0EQidxaJ+A9EvVwSmwbtXVDiWKB/CTvtPfKOUvcvuHlfbXcrzx6ogJDbTaqnjvS/1IugeA==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read test CA</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/test-ca"}></MethodEndpoint>



Lists the test root CAs of the organisation: for each root, its trust domain, the root certificate (PEM), its subject and validity, the URL of its CRL and the URL of the root certificate. For development and testing only.

The organisation has one test root for each trust domain: `mdoc-iaca` (the IACA of the mdoc presets), `provider` (the provider presets, `status-list-signer`, `credential-issuer` and `custom`) and `access` (the WRPAC presets and `request-signer-san-dns`). The list has only the roots that exist, in the order `mdoc-iaca`, `provider`, `access`. This read makes no root: the create test CA operation, or the first test certificate of a domain, makes the root of that domain.

A verifier of this platform trusts a test certificate only when the organisation of the verifier adds its root as a trust authority, or when a trust list that the verifier uses has the root. A test root is never on an EU trusted list, so it is never qualified.

A sandbox organisation reads the test CAs of its main organisation.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the test CAs.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>testCas</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The test root CAs of the organisation, in the order `mdoc-iaca`, `provider`, `access`. An empty list when the organisation has none.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the test CA.","example":"0b6f8e2a-3c1d-4e5f-9a7b-1c2d3e4f5a6b"}}></SchemaItem><SchemaItem collapsible={false} name={"domain"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`mdoc-iaca`, `provider`, `access`]"} schema={{"type":"string","description":"The trust domain of the root, and the presets whose test certificates it issues (`testCaDomain` of the preset). `mdoc-iaca`, the IACA of the mdoc Document Signers, readers and status list signers. `provider`, the CA of the PID, wallet, EAA and QEAA providers, the status list signers of the SD-JWT VC and W3C VC credentials, the credential issuers and `custom`. `access`, in place of the Access CA of the access certificates (WRPAC) and of the request signers.","enum":["mdoc-iaca","provider","access"],"example":"mdoc-iaca"}}></SchemaItem><SchemaItem collapsible={false} name={"certificate"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The root certificate, in PEM format. To trust the test certificates of this root in a verifier of this platform, add it as a trust authority.","example":"-----BEGIN CERTIFICATE-----\n<base64-certificate-content>\n-----END CERTIFICATE-----\n"}}></SchemaItem><SchemaItem collapsible={false} name={"subject"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The subject of the root, in the text form of RFC 4514.","example":"CN=Example AB Test CA (NOT FOR PRODUCTION),O=Example AB,C=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"notBefore"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Start of the validity of the root, in UTC.","example":"2026-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"notAfter"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"End of the validity of the root, in UTC.","example":"2035-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"crlUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the certificate revocation list (CRL) of this root. It is a public route of the wallet, without authentication. The answer is the CRL in DER format (`application/pkix-crl`), signed by the root. Each test certificate of the root has this URL as its CRL distribution point. The route stays available when the installation switches the test CA off.","example":"https://wallet.example.com/organisation/<organisationId>/service/test-ca/<testCaId>/crl"}}></SchemaItem><SchemaItem collapsible={false} name={"certificateUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the root certificate. It is a public route of the wallet, without authentication. The answer is the certificate in DER format (`application/pkix-cert`). The test certificates of the `provider` and `access` roots have this URL in their authority information access extension (caIssuers). The route stays available when the installation switches the test CA off.","example":"https://wallet.example.com/organisation/<organisationId>/service/test-ca/<testCaId>/certificate"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>warnings</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The `test-certificate` warning. An empty list when `testCas` is empty.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`test-certificate`, `preset-override`, `profile-mismatch`, `purpose-reuse`]"} schema={{"type":"string","description":"The kind of warning. `test-certificate`, the answer issues or shows a certificate of the built-in test CA: the text is always the text of the example. `preset-override`, a value of the request is not the fixed value of the preset; the request value applies. `profile-mismatch`, the certificate does not agree with the preset of the key. `purpose-reuse`, the certificate chain of the key has a preset, and the new CSR, test certificate or chain upload has another preset: use one key for each purpose.","enum":["test-certificate","preset-override","profile-mismatch","purpose-reuse"],"example":"test-certificate"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The text of the warning, for a person.","example":"Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"testCas\": [\n    {\n      \"id\": \"0b6f8e2a-3c1d-4e5f-9a7b-1c2d3e4f5a6b\",\n      \"domain\": \"mdoc-iaca\",\n      \"certificate\": \"-----BEGIN CERTIFICATE-----\\n<base64-certificate-content>\\n-----END CERTIFICATE-----\\n\",\n      \"subject\": \"CN=Example AB Test CA (NOT FOR PRODUCTION),O=Example AB,C=SE\",\n      \"notBefore\": \"2026-10-21T10:00:00Z\",\n      \"notAfter\": \"2035-10-21T10:00:00Z\",\n      \"crlUrl\": \"https://wallet.example.com/organisation/<organisationId>/service/test-ca/<testCaId>/crl\",\n      \"certificateUrl\": \"https://wallet.example.com/organisation/<organisationId>/service/test-ca/<testCaId>/certificate\"\n    }\n  ],\n  \"warnings\": [\n    {\n      \"code\": \"test-certificate\",\n      \"message\": \"Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The installation switched the test CA off (`The built-in test CA is switched off in this installation.`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Test key store
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-test-key-store

---
id: config-digital-wallet-open-id-test-key-store
title: "Test key store"
description: "Does a connection test of a key store, then saves the result in `lastCheckedAt` and `lastCheckResult`, and sets `status` to `active` or `error`. The request has no body."
sidebar_label: "Test key store"
hide_title: true
hide_table_of_contents: true
api: eJztWFlv20gS/iuFfrIB6rDiDAbCYLBeOzOrSSY2RkoMbGKAZbJE9pjsprubUjS2/vuiuknqsJzdxeZlET8Ypvqo46u7H0RKNjGyclIrMRYXmiwgJFopSngNHFkHeg4Id7QC67ShCFxOCiwuyPInGLJ14UAqiAu07jyn5I7SMxcDqnRr7Q9/Lo78siVnIbYOXW1jcBpiTJxcUAzaQEzGaBP3YebJ39csRY4WlIZbna76n9Vn9QizVUXwCDPeffysHnu9nv/jvbjQCRYxb+cEOWHhckhYDFaHxe4Uaheksg6LAlnxPgQqC2SR4RHe6Yw1XEqX+8NYMwpOJv44lORynUZgCFO/33BsSHsyXu9CWteyt+32zKCy0kGpa+X6cM347orIygcbNFe0yVBJ67lHgIXVYGWmAIPJSrIWM/IsF2TkfOVv8RF0taGNIp5+ClV9W8iEObSqZ0nVuyutV/6Q0CyMkSr7H+XdCIgW5mz8gHkrBi7tV8UwlHl7fRshOq5/1YZ6d7TqdR7wKzlGV9+RaulhVRWtBzxrXE/gW8uXVjploXxggcsx8K3QOOnFkRZCQIEObP8x/d0TI9ME4B763iEQLFnL91kqTzblnKC0A+twxSGww+fb6dXR2dGBGQc9Iogbp47BUVFYkM6yUI4i7zf0BcuqIEBYGq0yuJq8b9FKbNJZUMHlWe1yGPWHjTF3LJcYSjmusbAh/fhw2oAgMzVmmLpAUkRpyINXk/eeFiqfHbRpNPZSfFZMDJVdkmHF4tFwCJdv44DGslXec5ujLOw4pNlY38X+/BwLS01K3QNima8i8JhbnDONL85nyF+02U7cIY9XRi9kSiYYPL6vsZBzSWkMsTM1xXCUoKNMmxXE985W8XEUbFiRaTydJfap1AJhkj9n6dZZNgJghpxk/eqbD+BMbR0F8G3YjPbw2C9FHpq2LoSyY33l8bTi7dzESPFOp+G0KTb7+b//WYlIdPpNUjEWiVZzmV3ITDosrrEoyF1WpCYpF5u3tJryRRGJCg2W5MhYMf70sFdOPyh5XxNI71BzSeYp66ZO9XRF6hZ1HLULKTq8RdvUw7CW2zL2ro5fL14RUGEpLG94d0kiMYRup/51pjXkaqMo7YtISFahQpeLSCgsSYzFXaP4JBWR4LosDaVizH4TCZvkVKIYPwi3qvi0dVweRCRK/PKOVOZyMf7hdB2JJlLFWOwoL9Y3TNVWWlmyTGg0HPK/XVTZ9pbMQiYEqUwPugnbvtVlq0dhtRKtHCnHdLfS9+BPy8Qfnmqhb/+kxIlIOOm8zK31t3oaEe3JGJZDwH29m2KRKsMWcDIore+2uN9qXRCqJwymuV7aNmKfjZYKrQ3G7CDnG+tINBnkkLVUXRR4257dZ3ydr54NTEqfpCGYOFC0INMUBUuJIcc+zURSciiL1oXbzNSHmGWI97LiAWX42DoSSdtx/vfqzGTZhdCeShFnjw+z8x2OYjQc/dA7GfZGw9nJcDx8PR4O/ynW6+1w+MQm3EC8Ld/Nmo/mhKnPGA/863R4wnL/x365zcj3yec6ZS7++2JLu5voiQ/vetrm9gY3qRxlZLZ1Ph0O1wfIH8B6A9PfkZNvVbPZmgwp1muv/X6ObGrlX8RJZR+a0+8Ymtl+PW0moE3ibpp4aWFy0X+C3uuQPb9T9CbKkVFY+FpBBjybPYzWkbCU1Ea6lS/fZ5V8S/x5w6XIYcZVXTRdAIQ2AI58I3Bx+vH8WERcDeB3VJhRySDfcNzzKMi1U1sPDZfQsRgsRoPQVQzSQLC39AQHXP5kOuBho+wo+Z/eynbwsKm76wGnJsFys1aHuo4LKnWjtIhEbQoxFrlzlR0PBimVuoeV7MvMoHJ9qcU62idwZXRahzz4DJl/R2HqMJMqe+66Ddv7gtxsrDFlpwy+1NqkcwoMC02DEsy5aVHOmmzinfxJ2Ty7moTecGd6D/3kAou6qwXxDp0YAhsoa+vglksVzeUXSpsmOsgIMRwp7ULj5QzKwmNQYULHEVA/6++RHUNz8aeVrg3DwRPnz3HfFxSp5rqNX0x8/FKJkoG0dVVp4/62Aa/TX/66WdpFfdtge7B0l9oaHF6BOOQcgeT/7JMhCzUIhSjw7ehHHuEkF1k434xPMLG2RpUQHF36cJkc+77s8MUrQ7Zj0YXY1TFL5HSiQ9cvLbAJSfEd22THAKblRyRpbU0R5LpIo+3htom47ekOauvN41ClaFLb8/pKVA7mBTdX3rQN0l7a61fn8PEcjn67nh1HMHkz+wWmF73frmfw8Txwm0wv4eTH4cmr3msoL3QyKC/ebfFkKiU6y6m6kAkp6xNk67kVJjnxXPrEdMvlso9+u69NNmju2sG7yfmb99M3Pb6z3nSoG3MyWKlO6s56IhKcNoLZR8PRaf9V/4TvcrIqUW3J45/VulqzH0pbdeXl2fDl2fDl2fDl2fDl2fDl2fC7ezZsmlIGb1AVKBUXU1+9H5rO/5NYjMK701zyLLPb/YeXRyV5+N2dAJqFMAOISIx3Xt/8GHATiZyHjPEn8fDAr4UfTLFe8/J9TcYPMpFYoJHhAYRHBWn5OxVj7xhfKepHfzTj4DH8f79jHrRQO0soHiR85y/GIiC++865vukebDyA4cBZklDltq4+mazX25Pg1eV0JiLB4b07yNz5Qab5YPIH5dqfaToh/eh18MpP3Pm9pdXP3fGw8+yFbo4Kpxklfqz6Fx9gl5s=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Test key store</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/key-stores/{keyStoreId}/test"}></MethodEndpoint>



Does a connection test of a key store, then saves the result in `lastCheckedAt` and `lastCheckResult`, and sets `status` to `active` or `error`. The request has no body.

| Type | Test |
|---|---|
| `local` | The health check of the key store of the installation. |
| `vault` | Log in with the authentication method, read the health of the vault and list the keys of the Transit mount. When the key store has a key of the organisation, also sign a test message and verify the signature with the stored public key. |
| `gcp-kms` | List the keys of the key ring. When the key store has a key of the organisation, also sign and verify as for `vault`. |
| `aws-kms` | List the keys of the region. When the key store has a key of the organisation, also sign and verify. |
| `azure-key-vault` | Get a token of the application and list the keys of the vault. When the key store has a key of the organisation, also sign and verify. |
| `dpod` | Check that the partition is active on the HSM signer, and sign and verify with a session key that does not stay in the partition. When the key store has a key of the organisation, also sign and verify. When the partition is not active, `message` tells its state, for example a wrong PIN. |
| `csc` | Get an OAuth 2.0 token and list the credentials. The test does not sign: a signature needs the PIN and an authorisation. |

The answer is `200 OK` also when the test fails: then `ok` is `false` and `message` tells why, as a safe text.

For a key store of a provider with `qualified` `true` (category `qtsp`), the operation also checks each key of the organisation in the key store against the EU trusted lists again, also when the connection test fails. The result is in `trust` of the key and in `qualifiedStatus` of the key store.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else the identifier that the create key store operation returned.","in":"path","name":"keyStoreId","required":true,"schema":{"type":"string","maxLength":64},"example":"local-openbao"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service did the connection test and returned the result.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ok"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the connection test passed.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Why the connection test failed, as a safe text. It never has a secret or the detail of the provider. `null` when the test passed.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the connection test, in UTC.","example":"2026-10-20T10:05:00Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"ok\": true,\n  \"message\": null,\n  \"checkedAt\": \"2026-10-20T10:05:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key store with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update key store
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-update-key-store

---
id: config-digital-wallet-open-id-update-key-store
title: "Update key store"
description: "Changes the name, the settings or the credentials of a key store that the organisation added. The operation changes only the members that the body gives. `settings`, when given, replaces all the settings. A credential field that the body does not give keeps the stored value."
sidebar_label: "Update key store"
hide_title: true
hide_table_of_contents: true
api: eJztXO1v2zjS/1cIfUoARXG73cOd91A8Wae76+tbrk5a4NoAYqSxzYtEqiQV1xfkf38wQ+pdsZPuHXCHzZc2lilyOJzX3wx9G6RgEi0KK5QMpsFszeUKDLNrYJLnENJfBqwVcmWY0vQ50ZCCtIJnhqkl4+watsxYpYHZNbc0RukVl8JwnJjxNIU0Yuf4vADtHiZ+LSWzLb2SQ34F2jRzXKl0y1biBkzE4oqIOGSbNUh6LkOmoch4AobxLOsQG7GTFqFsKSBLe1OnCgyTytJc7BqgcDunraTshmclRF/kF3ne2/RSZZna0Fhe2jU+TtymcrBrlUbsE5JY0xx1R0VuVFyz4CC+4WVm45DFfGOOrnNDf/6r1HB0Ddsj9+2hO40NzzKwLIUMLHQI7p0LHUOWepqYkG4sz8EvHDKjGGfG8gz5lmiwTMINaHy0NRH7FfkycuIkHrDxM4eslBkY06aOZxp4umVrTo/ziP2iNINvPC8yCBmX7AR315eciiFLrXIWJ5kAaRdEWMysqp7MQFuxRGZCzCRAaka/4TKtnp9pccMtvIZtHNLz3YzsrlyLgH8hWUNybbqagXOSOBG3lJSQkDxYMJbxFRcyYnPLDL+pxtBOnfCTPONDGl1wY1DikWFxWqgUSSZ2n83foQrin+0Dyfm1O6XfFm+ZESsJmmVqhQdOK4dMSWBW5ODlsl6KlNet0TqJJReZqbnUPN8ofQ0pu4Kl0t4yWPhmK4GIX0wmMQOZGrYRds3i887bTr2ENQy4zgQKWZt5rQ1F8U8MMgO1mJEiGhLKEbK8iOHXtjQsBq2Vjp21KbS6ESnovplKuES9d4eAliLOVMKzNheEYSjCdEI4wnCZXqlvXcPWmae9QvRFBmFQG7t5GkyDRMmlWJ2KlbA8+0Sy9L4AOU8vitQJ5wJfDcKg4JrnYEGbYPr5tmejL6T4WgITxK6lcJvrsCTy2zlSBcgrrtCYuAcpt/yKG4hRjvyztcljtlS6wyA/pZBoHDLaQ9gcSmvt2qImGrhtn0tj6TXYUktIoyAMBG6h4HYdhAF6mGAaXPuNz9MgDDR8LYWGNJhaXUIYmGQNOQ+mt4HdFjjaWC3kKgiDnH97A3Jl18H0Ty/uwsAbl2AadDYf3F26WcHYn1W6xam6DD1v+x5VCcUILYmSFqTFGXhRZN6aH//T4DS3Q1LV1T8hsXieGplhBRj81m1754aeTSZhj8p3sCGXPDjtkHHLcmUsezaZIPWaJyg6ZHDy0lh2Baz0QiMHzhlluzk0nm341pBOcR8BGMViWWZZjCqB0s6TBArrjrNh+qw0VuWgGTmr4I52Tcq39/D6W+1rbk+457ard96NUUDgbEW97ZZNRxt4wKWya6IRR1Fo4ezWYXczteyEQWWlhnJz0os4KlJxr2R+tlV00qajjgnQPkh4vyQV70uMFZYIcczsM2jRWpFLBt8saMkzhubkZ65QuX/jZi1mShfsI05RxwNt63WAqzIfexw6i+l9HLoRb8fxtXPNpRHWBwmGgVwJWYsiTdBVmM8BT1MNxgRh0A1+gsu78P79rpICw5/dOyZhQEFCef5VqVUGbJapMmWv3y527dTPXu21nobEBb4JYztMSHiWteJTtVyKBGNJkGmhhLQYJ6gyvc5NtCIqeCFMlKg87jOj0MpvFG0T7SlEu/cBtWEnQ3w8uJMhKNoaVrhRJxAnnxaopaqUOw++ijUPH7RrnBT5W+/ez+xWJrWsA2rynPglvuT8XumdwVJkUGcSIG+EVjKHZrpCqwSM6XPQrbKHV92AeZ/aNBHojVMRzXIu+QpSiqR2Ma4fmXcYuEINIUOgrkHWZqHlMlx8+1YkWhm1tOyVtJqz+amLhLr8d7RdfHgztIQ9FtHIC50hR0ByacmhulCW/nyMImJQuEcLC66tsJXUsfM1x5N9U0rutZHiUdA3IoFd3PQxrn//lFvOzrSyPoJWkp1CzmU6ZqDsWqtyte5Hv5UoZdwulc59LFiTi1zGQHSmt4VV7D1KOGimVdZ4DiEFBqPCQMqWQhvLDk7P1KkTz7TUcNhnP532G34F2W7OJibZw9ivJc8wukqZ1UhOxcPaJx78/XxxdkhBm4ZcWaCNoyWrLbY7gYVYSW5RzGdKGqWtKHN2MFvMDtnJ2bw6gMQk8WA7iUmcLLUEqDSg52lweXd5FwatiH3oGz9pYeGIhLidqjThFTvxKbk/K0pLR5NpF2JuVcky4DfAVGnvy9V/h0u9h+Be3oDEtnzmaIZc6/s4MvBOMS7NBuWNwmIMtJqXo+B7vOMjia/c4O8j5j7P9EhiGsCDmJag8adxzkjPT94yFLvfSesez/BYmnv2fzdS8h8QhFHr/MhNkNl1ptEZOLvWAFWyzXWdLaDHZvFsrbfGqmsRoT+Pa731tslZCVbw5JqvanNPJtMPiRgGzEtVapq8sjUO/UD19hlkL9rfw6aO4xUeXcm9+1R7HANCiSJZN+bEvyjwlHKlt276DmPUcsgLchoY96zRQHGMeKxWWZOMhSz+CbPwW5d43w1RKLTjFTZkCodoalW6QXlnm43xQ0CII6iCqRnlPxE7kawkPMGPa3NrxJTulrMxX/VIMUPn8gBhv7y7a3J4lybD5owbs1E6pey6zHOutz4TLvw3btlKqemIcHDPNxX1PMFft6rU75qpXwa0MGn0W9JMh4F3l3Sh4mvYumwqdAEcr6TeY6dWNY+SBolsE9bOJut4bRqsrS3M9Pg49xYlcv8SVZEE2w7p/B7O/eeXbRftv5v5zy9dlnHuTvfV7Oi3xdthHDi9DZxNwgPvw6jB3dDVDwd11m19cQZ5Q18DwnbHN89pOJ0HGqczIYcH34vZCBJFEXDBWRXi7ZIFQqAqMXDT+dnOhKTl74gEDaZQ0jhhfD6ZjANHlf1DPBVS0moEedMWyOt0vQLBhjH8d8NKlZa2kMMeQtHH19cqS00dLF7D1owF5s7aeH11BQEHCA2DnM5GujCXSMeAn/8qLJOzi4v5aRf66YGHod/Bvp2gjt1LPEFne0hiBxV648GWbrXHbzasMuc11+kG/aiBpNTCblmu0jIbnfowYq94sh5A1xhYMVyo8kWYE3hojadpWBcptC+SMGGjKvalLX039hQ1UWjDm/sgnaiJEnHwTrjjwMMUh9EwTPMk7877o6ogQmQ9KselDBEXRp/n3u+lZ9XIR6VpIUm0l9CHp4ck1rLMMZkjKSSj6Bxlk0g0UfxIjOyiTAwCLgcqsg/hRciYX+F4B54/AuKl+mAs0jrIrEbW1ioTxrZt27bAyKwuOBy0GRa3LMcaJTNRujiqC64OuTsiJM+JGJoTIS0YgcCOx76dURmUiYZoNEVgHU0j2+khepTdjhkAVMxqfx1LhOvehd9bLRirFBCxwuwqBnRM4RvcbIPnu2NvSLlSKgMuh2DGWm0Mi/HYH2SMKxjC8baLxOMkCMJTbW+/FV64GuCIHeaJFTcQN7XWbl0TOwxc4ZDxpQXtgvhOFZccKNZGsZUhToVB6XZ2QgPqoK+IeJVzCyKFfiR+hyt0dckPc8rkMa/Hq9OnNWjwqkLBVMu3C9Ou7xAzEHRE5xFP664A/6QJ451JzF146+1bJf61+briyTVgmb3SMVKe2jOHrGlsqM19/XKzYZbBDWQsXrz/5fzTyYdXY90PzXtInZOYVzPSUPT69U4e4xh37Qgn9ZMf0cPUrYERflVqIJFo0jHiuZD3klALppuhsdc95sS/Ld7u6QXxA11IT3SmkFLInR7V7OD3M6Pj14bArHOBOG1FZDxlvtBbPamS5xQSkYJha7XBTNSfaosjBx5gHBjGYQ0/bmSCjD+itM16vs0EH9Y1N7d6W/EqUQ7CYG1y968/QbIXLTYFLRfW0cp6jp0FwEWv8Nd1SBF7R6Ez9+nhw9DJylPvK3892JpSLN8ZYHx9Ih8N/HzM51CHscYIPCupOg0bOzGEpxLmUwnzqYT5VMJ8KmE+lTD/e0uYM6/hkI4hbd2tUisr5m2D/uLRQCCscqE69/AC4EA1V7och9yc9tD3r/LCbolfVY9R5ZurGg5kqZnW8Excgd4YPjqnN6e/6ZDxj0Fr7E+tKD32J3bibLD/uoZhYleoew3beWuBk+ohje2HrN2u2nCsZ/ceqhwgE6PynyP17rAutKDQuH7qT3nkYbNmISTOSAjNgCAUjjMhyffxNCVV49lZB9bsJb/txsNbwsp5wa9EJnrjudZ8O6ylVN2TndZUlipfeMJTrsO1Bk086AkZzcKv0XPBhoLuwymLXT0N9yXyQmnaISoZcdlo+q/h/WzNBX2FyW7MDqSq39uRHbUJcq11O4NTJOuhJNRI4z1b0bAEDTKBB+4LMaMzb35ew9bUC4UshlTQ/w7mjFvo5J40jHrMSTw7VP4HaeucTAU2Tu9Z8jF7xuZcC/koylLlVm6HOJLWJ3vrlw3CAFclvFDjv71tYuDYo4a8vMFZkBZSDiQFfU+jVGOL7luIZsVZvpokHcnbCKASfVs9TOTbfszUfojoQSecgoNF/r6YEey75BmBHoiB1Hlzz2TjadENFo/XoBusUugO8kWT3VGIPUML3DoWBCdXoAfW5F2JTcyod/dVdiqQpBOA1Uv+gByrNry4F3LbDUW9x6hvBPXjje932EW9Ulz5xwM8w5XSWxZ/taaI0Vq0RpH7RNe4rfpDuucnTOu4fGbrHnOLBe8Gfg1ZLJU96s/tKHZdzr5CFJfyWqqNjDtAsCOiZ++mmBX3bWCScZGbriARYyO2AKCNo7Vt9tJGMup3kOltejGOcXR1YAuPGGfc2BneUYH0xH4HNC8a6Bin6gOhIQrRxfms5oi7EOJbRaiRBIwdg7Jrwj6AweQGC55ZtgcQqYqb7Rf7JLvHTsr6sG0XMRmWKdX1YyHtOozrL0U3d9Ix/DoHY/hqFMffB+xuR5dyOHTIKII0fOmu4lAG2y7Y+sYEb4FSsFxkrFdUqc9x5BpSOnaMyb9Htu4Tq04J4vnk+Z+Onk2Onk/On02mkx+nk8k/Aledb+J8dR00LG7Td4l3P3ZT1IjOffK+T85dHoGQ4vdwZFY5EytG73Y8gCkTx5QwcH0//yal96Xf30FQ75QEmi2iqoW6+vpWWOOevtLTKYe0MNj7crZe3O09f8t7Dj1b31AO7VP7YNvcdb1Ka+Ap3dCisP+FaxB5cC9HmzNUFpqpFKoS0WnrbC7DgWnsGrDm7bEIoT6kF5PJ3cj0Y8Fefa4/c7w2WpRoDfyNtMB3xwzLuR1HPFIqdf0MdPHW26PmAqAGwtxueCbQqA1a1jqj8cYnrpELY4RchSNRjrOKwwt7dfvEuD11ly65/+TNUtznWcwsIL61WW8HBjgYysWzP7BcXEhMxJUW/yId7bPmxR+YNed9ofV1lVZd2mXdwjDXo9Tn3l+euNf6iYHWhXM+ykR0NEM2/viHtttz6ctu1L+gmWtQ6PKISqCuekyB+kkhqIXzM0VXlmNl9HPgrzUzd6/ZNbPNT198nB0GIcbw7G3dT4CsqRtOi5I4gxeCp8HxzfNjV2o5Tt18Rw4qPcb+ApEeI/LSNCbQRzpmc3zb3CK+o4AB9zN2ffoUcuW3i069036bQq6OeCEisdJc2kgoqmx2JzjTKi0TX0kdnWbfDAvLV1U32Mjrxn3dJ+SyOYcFiqOTouo0GqDRPfA3rd1BNnetT7w5rgp4vX7RszmpTu/nKgiLdFdmq7v+nXli5papKw+FhqX4hr39lOk7GhlBV77B32ouMuIB9rofhgyiVdSbdsr8i9Ssi+xA5O1lHFFoiar5obnW/aoGYaut9i4kt7vV6vu93ep+Ve9tjsKVhb1iYVl0+mfsBHbsJNJdVhQG1pWX3zqopvpIcWmnUdqNHumgdl/saM1GcBqTMsx13CruFXzut+yUBVE5leF1ej8CP/nsbdjM3e+NbxrjSd6obFB9t/Cf8TsqI9TN6PjhOzq9UUqXqjLAPCEDDDkXqA+mLBDv+79GB2oxFr82j7rK09a7nnTXL1WpL7U0KzxabG3F/9Gq8HZbjDNjBPp8BC2WAlMoNmvde5gbU3KJMOB7snfzQ8Kexl88w06xaonaRp4dUteMSlRmUNmEodIWSHzHeD/ndIKu0AljSgipmdu1cNzgClvmbWbnWkZpSMsslynXqTmi/QouLVtmiGmQhnpOE7WffpixjzN28LdP54chm786/4UtTo/+9umcfZy51eaL9+zZnyfPfjj6keWnKjnOT990SmFK59wSmpmJBKRpa+VJwZM1sOfRZHB0m80m4vR1pPTq2L9rjt/MZ6/eLV4d4Tt3DTDUHCcyK1VJWZ8edrqCNu7Yn0+ev4h+iJ5Rj50yNueyRc9FdVfGBwx9m9gKDZ5+HWl44/Lp15Gefh3p6deRnn4d6Xt+HckHrMil4yLDyt2ddwm3PiH4HNw8dxekloKavTtJgfuBJSk8ztdKDPwDlxoEYTBt/cTQZRislbE4+e0tdilf6OzuDh9/LUFTXoP3JLRwYCnmD1UDt6vJ7XAQBx98dnjI/rd/pWn0aKoEQ26b63WBY3X3V5yot8ZnHshAN2Dm2HR07iDgaoJBuo35knvjhH5oaOfYdip5dnEehMGV/42nnDLrQPMNxsN8E0yDL8GXgISGIinK5vH5bZBxuSqpPhO4aelKaIki2M6rrimv8n+0alZdjvRTrJo97S7Z7it/xQjmNWxf1sPdN/e+UKd1bjSeD4LS/w9BBtIm
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update key store</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/key-management/key-stores/{keyStoreId}"}></MethodEndpoint>



Changes the name, the settings or the credentials of a key store that the organisation added. The operation changes only the members that the body gives. `settings`, when given, replaces all the settings. A credential field that the body does not give keeps the stored value.

The credentials follow the authentication method. When `settings.authentication.method` changes (`vault`, `aws-kms`, `azure-key-vault`), the wallet deletes the stored credentials of the old method in the same change, so a stale secret never stays. Give the credentials of the new method, unless the wallet already has them. For example, an Azure key store that changes from `clientSecret` to `clientCertificate` needs `clientCertificate` and `clientPrivateKey`, and the wallet deletes the stored `clientSecret`.

The wallet checks the settings and does the connection test again. It saves the change only when the test passes. For `dpod`, a new PIN or new credentials make the HSM signer log in again, one time. When the test of a `dpod` key store fails and the key store worked before, the text of the `400` ends with `The key store keeps its earlier settings and credentials.`; else the new values stay and the key store has the status `error`. The provider of a key store cannot change. A `local` key store is read only. A sandbox organisation cannot change a key store.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else the identifier that the create key store operation returned.","in":"path","name":"keyStoreId","required":true,"schema":{"type":"string","maxLength":64},"example":"local-openbao"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The members to change.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"New name of the key store, at most 100 characters. It must be unique in the organisation. A key store always has a name, so `null` is not accepted.","example":"Customer vault"}}></SchemaItem><SchemaItem collapsible={false} name={"provider"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 64 characters`"} schema={{"type":"string","maxLength":64,"description":"The provider of the key store. It cannot change, so a given value must be the stored one (another value gives `400`).","example":"openbao"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>settings</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

All the settings of the type. They replace the stored settings.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"vault"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"address"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the vault, with `https://`. The wallet refuses `http://` and private network addresses, unless the installation allows private addresses (for example on premises).","example":"https://vault.example.com:8200"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Namespace in the vault. Leave it out or send `null` when the vault has no namespaces.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"transitMount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the Transit secrets engine. The default is `transit`.","example":"transit"}}></SchemaItem><SchemaItem collapsible={false} name={"caCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM bundle of the certificate authorities that the wallet trusts for the TLS certificate of the vault. Without it, the wallet uses the system certificate authorities.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"clientCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM client certificate for mutual TLS. Required for the authentication method `cert`. With another method, send it when the listener of the vault requires mutual TLS. The private key of the certificate goes in the credential `clientPrivateKey`.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to the vault.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`userpass`, `approle`, `cert`, `token`]"} schema={{"type":"string","description":"Authentication method. `userpass` needs `username` and the credential `password`. `approle` needs `roleId` and the credential `secretId`. `cert` needs `clientCertificate` and the credential `clientPrivateKey`, and can have `role`. `token` needs the credential `token`.","enum":["userpass","approle","cert","token"],"example":"userpass"}}></SchemaItem><SchemaItem collapsible={false} name={"mount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the authentication method. The default is the name of the method (`userpass`, `approle` or `cert`).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"User name, for the method `userpass`.","example":"wallet"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Role ID, for the method `approle`.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Name of the certificate role, for the method `cert`. Optional.","example":null}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"gcp-kms"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"project"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Google Cloud project ID of the key ring. A domain-scoped project ID (`example.com:my-project`) is also accepted.","example":"my-project"}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Cloud KMS location of the key ring, for example `europe-west1`.","example":"europe-west1"}}></SchemaItem><SchemaItem collapsible={false} name={"keyRing"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 63 characters`"} schema={{"type":"string","maxLength":63,"description":"The name of the key ring. Letters, digits, `_` and `-`, at most 63 characters.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"protectionLevel"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`HSM`, `SOFTWARE`]"} schema={{"type":"string","description":"The protection level of the keys that the wallet creates. `HSM` (default) keeps the keys in hardware security modules of Google Cloud (the key store `protection` is `hsm-backed`). `SOFTWARE` keeps them in software (the key store `protection` is `software`).","enum":["HSM","SOFTWARE"],"example":"HSM"}}></SchemaItem></TabItem><TabItem label={"aws-kms"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"region"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The AWS region of the keys, for example `eu-central-1`. Free text with a format check, not a fixed list.","example":"eu-central-1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to AWS KMS.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`accessKey`]"} schema={{"type":"string","description":"Authentication method. `accessKey` (the only method) needs the credentials `accessKeyId` and `secretAccessKey`.","enum":["accessKey"],"example":"accessKey"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"azure-key-vault"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"vaultUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the key vault (`https://<name>.vault.azure.net`) or of the managed HSM (`https://<name>.managedhsm.azure.net`), without a path and without a trailing `/`.","example":"https://my-vault.vault.azure.net"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Microsoft Entra tenant ID, a GUID or a domain name (for example `contoso.onmicrosoft.com`).","example":"00000000-0000-0000-0000-000000000000"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The application (client) ID of the app registration, a GUID.","example":"11111111-1111-1111-1111-111111111111"}}></SchemaItem><SchemaItem collapsible={false} name={"keyType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EC-HSM`, `EC`]"} schema={{"type":"string","description":"The key type of the keys that the wallet creates. `EC-HSM` (default) keeps the keys in hardware security modules (the key store `protection` is `hsm-backed`). `EC` keeps them in software (the key store `protection` is `software`). A managed HSM has `EC-HSM` keys only.","enum":["EC-HSM","EC"],"example":"EC-HSM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the application logs in to Microsoft Entra ID.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`clientSecret`, `clientCertificate`]"} schema={{"type":"string","description":"Authentication method. `clientSecret` needs the credential `clientSecret`. `clientCertificate` needs the credentials `clientCertificate` and `clientPrivateKey`.","enum":["clientSecret","clientCertificate"],"example":"clientSecret"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"dpod"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"tokenLabel"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 32 characters`"} schema={{"type":"string","maxLength":32,"description":"The label of the partition, at most 32 bytes in UTF-8, without a control character, `;`, `{` or `}`. The wallet removes the spaces around it.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^[0-9]{1,16}$`"} schema={{"type":"string","nullable":true,"pattern":"^[0-9]{1,16}$","description":"The serial number of the partition, a string of 1 to 16 digits. Optional; an empty string is the same as `null`, and a number is refused. When given, the HSM signer checks that the partition has this serial number.","example":null}}></SchemaItem></TabItem><TabItem label={"csc"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"cscUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC API of the QTSP, with `https://`.","example":"https://qtsp.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"apiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"Version of the CSC API. The default is `v1`.","enum":["v1","v2"],"example":"v1"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client ID that the QTSP gave the organisation.","example":"client"}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID that the QTSP registered for the organisation.","example":"user-1"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>credentials</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Write-only credentials to change. A field of the same authentication method that you leave out keeps the stored value.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"vault"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"password"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Password, for the method `userpass`.","example":"<yourPassword>"}}></SchemaItem><SchemaItem collapsible={false} name={"secretId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret ID, for the method `approle`.","example":"<yourSecretId>"}}></SchemaItem><SchemaItem collapsible={false} name={"token"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Vault token, for the method `token`.","example":"<yourToken>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientPrivateKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PEM private key of `clientCertificate`, without a password. Required for the method `cert`, and when you give `clientCertificate` with another method.","example":"<yourClientPrivateKeyPem>"}}></SchemaItem></TabItem><TabItem label={"gcp-kms"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"serviceAccountKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The JSON key file of a Google Cloud service account, as one string (the text of the file, not an object). Required. The wallet checks that the text is JSON, that `type` is `service_account`, that it has `client_email` and a PEM `private_key`, and that the service account is of `googleapis.com`. The wallet never sends a request to an address of the key file.","example":"<the text of the service account key file>"}}></SchemaItem></TabItem><TabItem label={"aws-kms"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"accessKeyId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The access key ID. Required.","example":"<yourAccessKeyId>"}}></SchemaItem><SchemaItem collapsible={false} name={"secretAccessKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret access key. Required.","example":"<yourSecretAccessKey>"}}></SchemaItem></TabItem><TabItem label={"azure-key-vault"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The client secret of the application, for the method `clientSecret`.","example":"<yourClientSecret>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The PEM certificate of the application, for the method `clientCertificate`.","example":"<yourClientCertificatePem>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientPrivateKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The PEM private key of `clientCertificate`, without a password, for the method `clientCertificate`. It must be the private key of the certificate.","example":"<yourClientPrivateKeyPem>"}}></SchemaItem></TabItem><TabItem label={"dpod"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"authTokenConfigUri"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 2048 characters`"} schema={{"type":"string","maxLength":2048,"description":"The value `AuthTokenConfigURI` of `Chrystoki.conf`, an https URL.","example":"<AuthTokenConfigURI>"}}></SchemaItem><SchemaItem collapsible={false} name={"authTokenClientId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 512 characters`"} schema={{"type":"string","maxLength":512,"description":"The value `AuthTokenClientId` of `Chrystoki.conf`.","example":"<AuthTokenClientId>"}}></SchemaItem><SchemaItem collapsible={false} name={"authTokenClientSecret"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 2048 characters`"} schema={{"type":"string","maxLength":2048,"description":"The value `AuthTokenClientSecret` of `Chrystoki.conf`.","example":"<AuthTokenClientSecret>"}}></SchemaItem><SchemaItem collapsible={false} name={"pin"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 256 characters`"} schema={{"type":"string","maxLength":256,"description":"The PIN of the Crypto Officer of the partition. The HSM signer logs in one time with each new PIN. After a wrong PIN it does not log in again until you give a new PIN, because the partition locks after too many wrong PINs.","example":"<yourCryptoOfficerPin>"}}></SchemaItem></TabItem><TabItem label={"csc"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client secret that the QTSP gave the organisation. Required.","example":"<yourClientSecret>"}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PIN of the user at the QTSP. Optional. The wallet uses it for a referenced key that has no PIN of its own (`providerSecret`), and for document signing.","example":"<yourUserPin>"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service tested and saved the change, and returned the key store.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store. `local-openbao`, `local-database` or `local-hsm` for a key store of the installation, else a UUID.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store. `local` is a key store of the installation (OpenBao Transit, the wallet database, or the hardware security module of the installation). Each organisation can use it, and the API cannot add, change or delete it. `vault` is an external OpenBao or HashiCorp Vault of the organisation. `gcp-kms` is a key ring in Google Cloud KMS. `aws-kms` is one region of an AWS account (AWS KMS). `azure-key-vault` is an Azure key vault or managed HSM. `dpod` is a partition of a Thales Luna Cloud HSM service (DPoD). `csc` is a remote signing service with the Cloud Signature Consortium (CSC) API, for example a qualified trust service provider (QTSP).","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"provider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The provider of the key store, an `id` of the providers of the list key store types operation (for example `openbao`, `hashicorp-vault`, `google-cloud-kms` or `intesi`). `null` for a `local` key store. It cannot change. An organisation has at most one key store of each provider.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","maxLength":100,"description":"Name of the key store. It is unique in the organisation.","example":"Local vault"}}></SchemaItem><SchemaItem collapsible={false} name={"local"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` for a key store of the installation (type `local`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`active`, `disabled`, `error`]"} schema={{"type":"string","description":"Status of the key store. `active` when the key store works. `error` after a connection test that failed. `disabled` is reserved.","enum":["active","disabled","error"],"example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`, `hsm-backed`, `dedicated-hsm`, `provider`]"} schema={{"type":"string","nullable":true,"description":"Where the private keys of this key store are. `software`: in the software of a key management service (`local` with the backend `openbao` or `database`, `vault`, `gcp-kms` with the protection level `SOFTWARE`, `azure-key-vault` with the key type `EC`). `hsm`: in the hardware security module of the installation (`local` with the backend `hsm`). `hsm-backed`: in a cloud KMS that keeps the keys in hardware security modules of the cloud provider (`gcp-kms` with `HSM`, `aws-kms`, `azure-key-vault` with `EC-HSM`). `dedicated-hsm`: in a hardware security module partition of the organisation (`dpod`). `provider`: at the provider, which decides how it protects the keys (`csc`). An organisation key store has the `protection` of its provider, unless its settings decide.","enum":["software","hsm","hsm-backed","dedicated-hsm","provider"],"example":"software"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>settings</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Settings of the key store type. Never a secret.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"local"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"backend"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openbao`, `database`, `hsm`]"} schema={{"type":"string","description":"Where the installation keeps the keys. `openbao` for OpenBao Transit (`local-openbao`), `database` for the wallet database (`local-database`, legacy, no new keys), `hsm` for the hardware security module of the installation (`local-hsm`). With `hsm`, the new local keys of the organisations go to the HSM; the keys in `local-openbao` stay there and keep working.","enum":["openbao","database","hsm"],"example":"openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"protection"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`software`, `hsm`]"} schema={{"type":"string","description":"How the key store protects the keys. `software` for the backends `openbao` and `database`, `hsm` for the backend `hsm`.","enum":["software","hsm"],"example":"software"}}></SchemaItem></TabItem><TabItem label={"vault"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"address"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the vault, with `https://`. The wallet refuses `http://` and private network addresses, unless the installation allows private addresses (for example on premises).","example":"https://vault.example.com:8200"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Namespace in the vault. Leave it out or send `null` when the vault has no namespaces.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"transitMount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the Transit secrets engine. The default is `transit`.","example":"transit"}}></SchemaItem><SchemaItem collapsible={false} name={"caCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM bundle of the certificate authorities that the wallet trusts for the TLS certificate of the vault. Without it, the wallet uses the system certificate authorities.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"clientCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"PEM client certificate for mutual TLS. Required for the authentication method `cert`. With another method, send it when the listener of the vault requires mutual TLS. The private key of the certificate goes in the credential `clientPrivateKey`.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to the vault.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`userpass`, `approle`, `cert`, `token`]"} schema={{"type":"string","description":"Authentication method. `userpass` needs `username` and the credential `password`. `approle` needs `roleId` and the credential `secretId`. `cert` needs `clientCertificate` and the credential `clientPrivateKey`, and can have `role`. `token` needs the credential `token`.","enum":["userpass","approle","cert","token"],"example":"userpass"}}></SchemaItem><SchemaItem collapsible={false} name={"mount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mount path of the authentication method. The default is the name of the method (`userpass`, `approle` or `cert`).","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"User name, for the method `userpass`.","example":"wallet"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Role ID, for the method `approle`.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Name of the certificate role, for the method `cert`. Optional.","example":null}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"gcp-kms"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"project"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Google Cloud project ID of the key ring. A domain-scoped project ID (`example.com:my-project`) is also accepted.","example":"my-project"}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Cloud KMS location of the key ring, for example `europe-west1`.","example":"europe-west1"}}></SchemaItem><SchemaItem collapsible={false} name={"keyRing"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 63 characters`"} schema={{"type":"string","maxLength":63,"description":"The name of the key ring. Letters, digits, `_` and `-`, at most 63 characters.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"protectionLevel"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`HSM`, `SOFTWARE`]"} schema={{"type":"string","description":"The protection level of the keys that the wallet creates. `HSM` (default) keeps the keys in hardware security modules of Google Cloud (the key store `protection` is `hsm-backed`). `SOFTWARE` keeps them in software (the key store `protection` is `software`).","enum":["HSM","SOFTWARE"],"example":"HSM"}}></SchemaItem></TabItem><TabItem label={"aws-kms"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"region"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The AWS region of the keys, for example `eu-central-1`. Free text with a format check, not a fixed list.","example":"eu-central-1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the wallet logs in to AWS KMS.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`accessKey`]"} schema={{"type":"string","description":"Authentication method. `accessKey` (the only method) needs the credentials `accessKeyId` and `secretAccessKey`.","enum":["accessKey"],"example":"accessKey"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"azure-key-vault"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"vaultUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the key vault (`https://<name>.vault.azure.net`) or of the managed HSM (`https://<name>.managedhsm.azure.net`), without a path and without a trailing `/`.","example":"https://my-vault.vault.azure.net"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Microsoft Entra tenant ID, a GUID or a domain name (for example `contoso.onmicrosoft.com`).","example":"00000000-0000-0000-0000-000000000000"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The application (client) ID of the app registration, a GUID.","example":"11111111-1111-1111-1111-111111111111"}}></SchemaItem><SchemaItem collapsible={false} name={"keyType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EC-HSM`, `EC`]"} schema={{"type":"string","description":"The key type of the keys that the wallet creates. `EC-HSM` (default) keeps the keys in hardware security modules (the key store `protection` is `hsm-backed`). `EC` keeps them in software (the key store `protection` is `software`). A managed HSM has `EC-HSM` keys only.","enum":["EC-HSM","EC"],"example":"EC-HSM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

How the application logs in to Microsoft Entra ID.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`clientSecret`, `clientCertificate`]"} schema={{"type":"string","description":"Authentication method. `clientSecret` needs the credential `clientSecret`. `clientCertificate` needs the credentials `clientCertificate` and `clientPrivateKey`.","enum":["clientSecret","clientCertificate"],"example":"clientSecret"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"dpod"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"tokenLabel"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 32 characters`"} schema={{"type":"string","maxLength":32,"description":"The label of the partition, at most 32 bytes in UTF-8, without a control character, `;`, `{` or `}`. The wallet removes the spaces around it.","example":"ows-signing"}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^[0-9]{1,16}$`"} schema={{"type":"string","nullable":true,"pattern":"^[0-9]{1,16}$","description":"The serial number of the partition, a string of 1 to 16 digits. Optional; an empty string is the same as `null`, and a number is refused. When given, the HSM signer checks that the partition has this serial number.","example":null}}></SchemaItem></TabItem><TabItem label={"csc"} value={"6-item-properties"}><SchemaItem collapsible={false} name={"cscUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC API of the QTSP, with `https://`.","example":"https://qtsp.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"apiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"Version of the CSC API. The default is `v1`.","enum":["v1","v2"],"example":"v1"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client ID that the QTSP gave the organisation.","example":"client"}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID that the QTSP registered for the organisation.","example":"user-1"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialsConfigured</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential field of the key store type, `true` when the wallet has a value. The answer never has the value. Empty for the type `local`. The fields: `vault` `password`, `secretId`, `token`, `clientPrivateKey`; `gcp-kms` `serviceAccountKey`; `aws-kms` `accessKeyId`, `secretAccessKey`; `azure-key-vault` `clientSecret`, `clientCertificate`, `clientPrivateKey`; `dpod` `authTokenConfigUri`, `authTokenClientId`, `authTokenClientSecret`, `pin`; `csc` `clientSecret`, `userPin`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"capabilities"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`create`, `import`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete`]"} schema={{"type":"array","description":"What the key store can do. The type sets them. `local` (the key store that takes new keys): `create`, `import`, `sign`, `csr`, `certificateChain`, `test` (no `import` with the backend `hsm`). `local` (the other key store of the installation): `sign`, `csr`, `certificateChain`, `test`. `vault`: `create`, `import`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete`. `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`: `create`, `reference`, `sign`, `csr`, `certificateChain`, `listProviderKeys`, `test`, `edit`, `delete` (no `import`). `csc`: `reference`, `sign`, `listProviderKeys`, `test`, `edit`, `delete`.","items":{"type":"string","enum":["create","import","reference","sign","csr","certificateChain","listProviderKeys","test","edit","delete"]},"example":["create","import","sign","csr","certificateChain","test"]}}></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the keys in a qualified signature creation device (QSCD). `false`, or `provider` for the type `csc`, where the QTSP decides.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"keyCount"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of keys of the organisation in the key store.","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"qualifiedStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","nullable":true,"description":"Only for a key store of a provider with `qualified` `true` (category `qtsp`): `qualified` when every key of the key store is qualified and there is at least one key, `not-qualified` when a key is not, else `unknown`. `null` for every other key store: no other key store claims a qualified status. See `trust` of the key.","enum":["qualified","not-qualified","unknown"],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"lastCheckedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the last connection test, in UTC. `null` before the first test.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lastCheckResult</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Result of a connection test of a key store.

</div><SchemaItem collapsible={false} name={"ok"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the connection test passed.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Why the connection test failed, as a safe text. It never has a secret or the detail of the provider. `null` when the test passed.","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the connection test, in UTC.","example":"2026-10-20T10:05:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Creation time of the key store, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the last change of the key store, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"local-openbao\",\n  \"type\": \"local\",\n  \"provider\": null,\n  \"name\": \"Local vault\",\n  \"local\": true,\n  \"status\": \"active\",\n  \"protection\": \"software\",\n  \"settings\": {},\n  \"credentialsConfigured\": {},\n  \"capabilities\": [\n    \"create\",\n    \"import\",\n    \"sign\",\n    \"csr\",\n    \"certificateChain\",\n    \"test\"\n  ],\n  \"qscd\": false,\n  \"keyCount\": 3,\n  \"qualifiedStatus\": null,\n  \"lastCheckedAt\": null,\n  \"lastCheckResult\": {\n    \"ok\": true,\n    \"message\": null,\n    \"checkedAt\": \"2026-10-20T10:05:00Z\"\n  },\n  \"createdAt\": \"2026-10-20T10:00:00Z\",\n  \"updatedAt\": \"2026-10-20T10:00:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The key store is a `local` key store, the body or the settings are not valid, a credential that the settings need is missing, the organisation is a sandbox organisation, or the connection test failed. For a failed test, `errorDescription` tells why, as a safe text.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key store with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div>

The organisation already has a key store with this name.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update key
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-update-key

---
id: config-digital-wallet-open-id-update-key
title: "Update key"
description: "Names a key or removes its name, and changes the PIN of a QTSP key. The operation changes only the members that the body gives. The name is free text that an administrator gives a key, for example what it signs. The key ID is made by the wallet and cannot change. This operation does not change which key is the default key (`isDefault`)."
sidebar_label: "Update key"
hide_title: true
hide_table_of_contents: true
api: eJztPGtz2za2fwXD/SLNULQk22mi3e1cRVa6btLEiexmd9NMCZGQhJoCFAK0rGb83++cA5AEH7KUtP1wbzvTmcYUHgfn/QI+ezFTUco3mkvhjbzXdM0UoeSW7YhMScrW8o4pwrUigq6ZT6iISbSiYskU0StGri5fE7kglLy9nl3BtIBcrxiRG5ZSWLMYLEWywxlrtp6zFGZTjR/mMt6RJb9jysyFjQhXZJEyRjS712YoFYTGay640inVMjVTDKw+WciUsHu63iSMbGE410TxpbBrwnkuL2DVNY0ZmRtQtjRJmDZnokJIbaGFOVw5h4glU6T8nWxXPFrhotygIWYLmiUaP3VCri7M32E3+En8JAACKtSWpfl4GEfNP1NGY4PvYruU6SwVgPaAjImiIp7LeyLTJRVcWbS68BokBD8Jz/eKVS5jb+RFUiz48oIvuabJezzumw0Tl/HNJqaavWQ7z/c2NKVrplmqvNGHzzWOuBH8U8YIj5nQfMFZCuS2R/B8j8OYDdUrz/eAcN7Iu2W7y9jzvZR9ynjKYm+k04z5nopWbE290WdP7zYwUOmUi6X38PDRDGZKP5fxDkZUYbh22UbmRGrZIpJCM6FhBbrZJDxCTJz8omCZz00I5PwXFmnP92gccxhKk6sUMKg5U95oQRPFfG/jfPpsT1k/hO+JLEnoPGE5LGt6/4qJpV55o0G/79cFjW0No5fY9AnVZC2VJoN+Hw6Z0giIEpAZEzEJYYMQzm+kEqfBEoAIy/reyLtCNlcZFREjw/7wifeAJ7jjMUtnLEqZboPegXZ4/qQO7fuUa9ZDEVa4hJH5lC1YykTEYiP5L2RqdQcXhJIwUlGIfyotU+YbiNk2Vxrw52Q2IVHKkLtoEpA3sAcIczFZBeS1zMXHkYzKqf+xk1l6xcW33sPDg/NDTq42tODIlKmNFMqQdtjvtzOfYukdj5jlvLgUYRFbkFhsYfpqFtRc41FmfCm4WBrRrILyRjBUalwsjcYwOHQVg0+2XK8KABHxRn+uZBID4hBo+P3i8sJq4UiuGVmkco0ax9FWK6rIJpsnPMLV1lSzlNMElXlALjUR7M4OgxU3Kb+jmpENTXWFsY2es8zi/AJ8YiYa/iTIQIbFAJlVyTOKpYV5j9dY5nRW76/pLdo2Y9W4bhoBRu5okrFcaysQWKpI+Mv2NrjlcVhlwtPFkD4bRGffzJ/GZ+zJgvaj8/gbNng6fzY8W5z2QRJ/J+1R1xxgCwWYtYaV3K6YKNGtQNioZjFguuCUDI1B1QgFucKpLACUFvJYtXPLdjNgwDZ2bwpZK7/mdGswA/+NnGC2qh4ikRFNenLDxJxKOIBZ/tA217sNa19ZZGtv9MGs6/neHfgEnu8to03vdq3A7mxV/q9fs5T1btmul4+KNxLMaKQi72MDysd46VFeaTv3K1iRmH2NUszN6gfAs8WD3fDjg+/JlC+5OIaPq7D8S24LOCKAS8uGBgtIaHk09F0vLWfcmuoouaZDEyWN5YkSmcXk5Q8zo1AuruQFKiW08W1qsxuQkK83Mi23NX/WPLN8TCl5KERWmGSmYXNg0gUofjQYHE5UWkq7Oiy7pYrQBPy/ltNYIHPN6Bdq26IDnVuzO0c/uspyFlvgoVmQ0V3KoahyVD74wfdospQp16v1lxMXDBfVWcpIsYireSscN50Nz1FFKE11pg5z8QzH7dPkDjKM/2E0iDVLZg8S0kjzO1ZT2uYjgFJ47Q40cykTRkUTnJXcKhICGhwN2YRGQxwBAM13eYxQ2R4WePC9X7a3h3XkVWmIuSDfz968Ju/ZnLyEkOP79y+74DatqTXguceimIht8GUNuXWkHfNtxrgGHI09jiOhsXI1S6x3h0kGgMGIKkA02dKdKvaEiAw3KuI0RWjKCEsSWCgiUZbeme8+UUZbFDY5nE5q1JxOgJJRencYvGl1h9JI1CC56g3Pn+wDAH+swYDfAIz7w0D8m0RSpjEXgHXL3LWjbyQX2geSz6liT86yNMkpXXWBi597971y1W8BkiOo9Z8/BJJdHZLbY+w2cE6dHu2OGLqEX+GG0WR5hM5pUWgQmhS63006hKjSQvxGS6bZo/buzyNnf5qmtOntT+p2xLXiFF15roy1iJEqCaMLjA+l1ESm4E93DDiaKe3aJWODcHxuVnAIzOwGZEojsCpsDRtQS23CRCRjFpOL6Tt3rZp4x1WxNqqn4UO2WklYJ7w/j0KyYjQ23hpFbWqpYEFdxzLCgTAtJCtqg+HKebjQLF2zmOMG5WbKL0w1HjvNFIRE0UqmQCs49RHmCCKxA2hBT+r+vDXarvHZv8a9AdGrbD3fpFwUoROe54/A9D5pVSs66JVwfGs4Vf8NufaoYwDXH3OQ11IbmoV/C3Pfxx4DYws8abZJJI2b8Dv+mMkBFirBKAlQDPfn+mfV1M3Vww7PnzSPG/3M7jc8PUJlTnEc0bx0sOsnRbm8uZ78MaQb9off9AaD3nBwPeiP+vDffxsOPNhq8NljHquDOqctJ5D7MF8oHjGLmNApTbiC5EgZg3UuLi+6geemaT4AdKNbthv9OozXv148HUTLq/unP97yb76fZ9kP6xf/Sd9fLf8jd3p3e/PfU7b7tNKDX569nH/6bxAEeL4VVY7GnAC2vtqRKyggyL+D8/6zPdqqHBxRgYqqjKnD+/P+s7DNPmJWEbyUcs2ZzNLoqLxALS8Hbj9u1yIkpbEAWiokZkBCI1VFIHJYyI4Mjaz3XRHzEKxKL6J23jzjie6BuIOxmYxJB0HH6KNho8qlu8bSxuyOJXKzZsLmsJjSkAkzyajwk1Ybu09lFYMGLE+4icZHshvtUmcDqxx91cjKntPzPQDD82FxN8SCvx/MMIdJv5Q/SzURNpgnRH80x7fRNw18Q4bGBq8VJWXqGVBzOYhnU0RQ+MsdS1GkFZGZVjxmRldsEqqB70kssWhibCw/KAVXKVPt2enHpeAaIxeYm1P7UWlApkt4jdvMAk7Rp5vns9udp3JDKI7Z8oWdIkjOJWb3+gybB0eizN5VgtoaW6bo8gopqhkby04OUGOlmFLrPPOcJG8WWMzZl2WetE5t6hdbo6vbtYormiRyq0aIB/g7U3TJMPKz0lhIHYGp4Ekza2S4JguulRm3vnhFLmSUIeOB781SSH8seAJmVCvyNrqaPcdonsEY3/Fd73WRG1DgDkYrFt0a/xx8WbtvNWkAiRd1kF2gAofJmv35Hb9IplLrg+doy1NXJq8MG/rWZYHI5QYQBcnD0JLdJ2y90TtkTuWTcB0nOUIMPkISotyEPgk/RVdqns+0ggpoUFm0QhdoLMh0PCaCsVhhVh0IUCUhwLukCdmwVElhy57tmjAg7wyP1zBQGDzL3rBlkc7vMEp7+V/dIET0GzCtbohkJhxPnMU9lEx2D5hwknXgG4BgmR/yZLbJX6RskSkWtxYMChx/nVqp8vM+L490ptezSzJ9TU4Hz8jZYNgbkiihmWLkLDgNhj7RsA0ZQJpxHI5AoN+xTQbBiTGwzxsfkaKxKdwWgWhAwkk4avt80fIZl7hlu6mI+GYF0RC45Cl8Gi9ThkIUkHAajo4Y9aIBof+1G9Ysr4tI43RJ0HwO7juV6j4w3C3bgQaDnbuwg5DlcNdajz3fe+753sTzvQvP96ae771ommfvObijoIomhbKaFLrqoNd8/biWqx8S9nGtUOtM1/vJdU8IhiAEjQTllsaS6B6EGw5uGlCCNoYZJdXAL/I2LgEyn+vKx9z9wozU0WVK/0308Njom+Zhd1+AipFJS11ejGfl9Ma62POQlWUsQBrp1By7NEtY1zfoIh2jAIsoJbJtH1RTGMMoxQVE71NGE3B5YkI1+AU5hcJPZkz778Ch4Sab98wg56fcI5tju41J1tg8rWIR1O+gO6brsjQcBzQdFmYYRZ/T/M/uUM3tw4dqqIVDHmH3FzL9IU7+EKZfGO8ILH2FSk0Wh9WBRCYH6+b8sDlgH+yhT+awCiC6oArIQol+rBLRKGLWjBgRwBreJDf2JoPfBqnrg7eYZ1746rlv4rIp/l1ZjSuT/eAKBeAvmft/LnMNlvnqFEXdamJHR7v3DNS6nL05uZxOyOBpf3DaOyfX6JA8D05JpxSCsG7QDRuze81EbJp88pGDoB/gWsF5MAiGIHdSr0iUcs0jmnRbJakTywhtTSjTZcCVdJZYX7wKu1a6isqZPUBr4Ij+75HBjkrf4ug2KalFFYa1y4aUBWEJi3QqBY9cBsN4g2qd8nmmoY3kGKYinavseW86HndHBF3G6xkZWJfxSe4yPg1OEe1jIdg9GfsObG8uL0jYD84A+c/OBsMnwSA4RYegHIMuVJIQvYL+ScyI2iZI66HnUlE45qGNEXhLzw365+nuzeIVW3KVUIO4gx0RqOhwZuEz0y14JcCI5HTw5ElvQGiyWVFwlWXMMIYKpzemgDLNAAgqyI0AgU3o1rrYFXxdzZ73nganvf45stsVJHGBrWcIFG68lU4jXZ5ormTpXbmdTbE2lOmVyalcVlTTccfOBF3P+TKTmaqrNosJWB++R0ThLqRTHOSsWy0qUaOi5YKkDHB/x0jMMRuTcbViMSbLVUDGtnFw2D976hzYR39OCp3KpPxcPXMk/jm1u70DEmuW+rL4NH7uR/80aElKBvgavLTjAiibCRA0k4LCQLIpNhwyLNiox0Ft5UW4RzA57AbkRgEGb95dks67FxNy+uzpk65RoFIwwu4hynamnHZ/EyJXWm/U6ORku90G9mug2ElCtyfQD9UbDE8buflW6XqEAx+jwkdooz0c0dbVXaepT7pGB1pV5bSgmPChoVsOBXRC1nd1kypG05cAGYtRtItXVK5hFfAkUSWEe7EBzl8bcsMuqlbb66haOCjch/yw6z+qs7GikTtIPzAFdlIdaZ8aHl0xv07CF0VKq+nU+Y8mw0wTfd2btcmqwrFbQg600royQmnBPvwinwaOXOnmAyWLDvkF9FMWSaEFvw/IWDh5rWrGHfz4wMkK1Z19LkioiobYCRwkWFvcGOcERrA0lekPxee8NxmSQoiBpllDh64Z4ezxvUFsN5XGhSMmgMv3RRM+ffGM3Pn8gkk1BXSEYwtq5ffiQeMXVVnQJIIN8xg/sYgfoPvAtAtRl4VQ0tZxMnHX+Uvi/pK4vySuXeLa8hidcK3kz9BKExrmORyb1Tg3IC94qnQ1y4F82slztJXkis28QLWIxSaNsz9N08VjGbatx671MBf2LHQGOByF89A6stkh4ZYJHkkDH0yZtcX3eaDa4hs8osRaeOALanF+3rhxqLR1WTbJfmHlri2993VlvK+p4k3vWLorClV4gwN561ClDi2HLTS94kpP8zLTcVbjum1mm5O9v5ZFjYLf06Vgy1rYw27XQBWO0TGeAC/AmbCQxWQyDsj7FU+MCi83wptH0OpGjUDmSHXuDjkmqs2iOJ1VZmTKFFxwDM0mRlqFNEof+imuKwBwReYyA8LKdp6tbLyicWmkykWgPx4SFuDn08UM+7XC7qhaxYCffBLaE5sMrKmRGoWSMqqkCIkCN2K7Mne28IaollCE7BTRC6ARrkeZlaBUB1i+SXlYtJ2aGCHvjs0BNeS8efcq/6VBOorMXY/tUxZBl2YMrVJcYeL0Ta65ih4Kk4iV0KUN0uHeyf07jhxfXdZug+aXuAyCbL/3yDlOpw4kZFNtc5r9NW9Vy+N0O8htOzH0MMPz3r8FF0uWVpr/Wtg8X21NdbQKSWdlr4XskQgcZttWSmj1WOcn4eui0c7Ed/Dz811IOtuVRBbiRVurWXeNHVtzZmPXprticXVM1biZAsjD/0iuT3Ry4ubaVHC/xss7FsFftkGelnHDcq/WSoZkObwsZnRyqTpqOJLhqJFInLaRphvOG3lw36wHdHv0uCZv0u8Nh25/I67/vLU/swGJFebWLHv9EobRFEcsW3Mf8j2OTMAc7HMgHbCSriy0mYTuoy1sxbpo8T6pKG5ebDV1BV67GUZuGduULgHuW1ZYymZs7NrDgg1DRdF5O5tcAFB5gwrWX4oM86K4GoxGsFzRNIfl6qbsHHFuA6JXCteBbS2qGAR6M86z26b3t2x1rB6rtYSAex9n+l+yHVr/VnPv4Ke4puQctnKp6/DZTSdVw2LSJZh/YzSnNxVeUJW+JrTXeD2gfvfTua9trGCesJNCsKjOhgZkMH0MdmrqyGPvboXFicOm5+N6NSVmKgfP9ApuX+xIJ0cVssRkfPJ2Uga+FvXLlArNYigltaGquOuLNxvaN0QrXRZ9Cp5H8+v+wGgCPoVU1ZtTubi2iQ0acvCn94mPkLpXx1eF1uDJECGhk1fcCrkVdhAwB01MmjNXA7XDWwfGz+sK1m2YM9uaVt5tQd/LuBQsumUx2ZkL2XlBtIAQtKMLsed7FqxqSbQcAObKLNpuIw5oUKfZHpcpO+zb1OG+YzRNzKBqYmKmKU++Aj5IwdBI2zBpmd9NMe5z1QOsi0LJ6EVI1ODc7YqhV1f/Naedux66vBVHO+dMYLYqHt4eJQnA8H+3OrjJ77Cq8cjeRjP4d6WoWoPu780j5LUCmJrzi6mlovt2CRXWdEQmr/95KTRTnHyXymwDTF5CPy2hnYGcTcbku1MynUxIB/WFnysIv4a+Bbm87jZzA1bHuTxbMMcRBr94zmK/OSisGWoyR1fmJf9OkVwxPe4mNdJqdIo0wKO2wgoKEhcD6aIfDL0FzAIcd2VfZOb6ysJNFcRswQU3BRtgWSw7C52ru/JHZM3qrQnMShRBEFIGL2I238apXB0dt+9vatCQD0KlBykC1A4Kjg3PWJjm7UpiDJU8fLVYNToXajwFfNfuqz0mZ9J2I8lwiWqpqRewXpTYcBAOV9eWmDqq3eQ/hO09CHUFfYivwZQE+VoIvpSoLgyDRhm0FSH7Af2Id3zxzvpviDNqty1zg+xe58Jbnta+tJuNftVsmJc0fj+oXHOXUFWE+F8HXzPviZ1j+KyD81pH8b6D+xyAX6rC8qK8ublu75a1X8Fqu+fUvAjTdg9k3/2GPRk8G+bkXr3LIS5dPmJG3lwwBZaHv87Muz9HP93jIhErIRMZwxnw3xcOAT/6DSVaVQXl7DbhK+h51u8/tCzfwmNOSzOFUs0m06R43wvfPHpoU+TYZWFvvFn/zSpX+2qTfZMtkZDfASEXtVeq/DLaM69MYdbMvEtTGkC32Nf+RpT1YyqPnaGv3vYMGjB9nZSDPzEpb4T1IX9FT7yOmrM/MWqu60xlvc1qG4p5J7DJVud/ag0B7nYqaIKpCpYS3KaGI0zLRRmEL5hIGW84PGE2+oBesqZLeFzQsy8R2luEpIOPEV6c/Tjpej4++/ADFXSJMQOgZs30SsI7hpsMMQPvDI68k7vhifHZTmzDas+kPk7g6SYen8ArSutiIfhTnXxGa/fgmcxr+1uHF2wt7RnBZqSJk9ON2Vr26IYHHAOIgMMDUfUFrlIZZyaRsmeZQyvMNF1CiWbPdGV+rgPysUT+DHjQsE5OgrJWbT7YVxsN9cp3G8dWdeStZlXAoMyAoUXeMWVbvcvUm/VJwso6xVsOa0h1zbEJdcHvWWzDHQMjwVZv+ySATilPEAcbGkG/OAuWQW3ZEbET8eE/QAc8nfVtaAI4kMd35YOS0yNeA2y+kei+KQgYW8hcA9AINQBbY4bAU9kG7gH/T0mPAqX8u/JTlZAuD9QwXUzKQ0N8CUDCETTevU6QrSt9lEaO0ND+iJdysb27LFUrjJ7xuJ03KHCXplLSPvHK9e4LIb3qAkRaRjJR9q4gcAUTMEdZ7fqrjaK0NC3RPj7k5pf3hXf5tTEnioEACymuqYhpGqsenpdTockCKtqGWyymEdr3pxPy4wRePrru+uRyev2CzC5637+/Jj9OzG7QaZy3DKwvZHSCTRBl5GTccYzPEh4xoVwOGW9otGJkGPQbpIMGT4o/BzJdnti56uTV5WT6ejbtwZyHMnNckhOQFdvKeC5koIkM2Yf9IVwWHOB7nVLpNRUOPDfFE311yXSs0l/P9/6ff77XamrA28kmgQDqwfLfZ2v+Pnh3Q/PO6IJjrr1iAs0LwAK7i6pm0HyAMG1kAr+PvreSUP/44H3+DO+i3KTJwwN8/pSxFE03PFmYchOegrXkCv4dFy/j7mXEzjvrAHXJgQeEWw+c2yuxw1cTkwz+MgcoHhh++FjEcQic+W1iQOjZXp58bsNbA8trZozxKtijY11P5Orm2vO9uX2neI2OmZfSLTyvR7feyPvJ+8lDKhRJFfz+2UuoWGaYWvPMsg/2skHVQhu02H84JakqMurGusAMnqx1yj9A/7xku2+L4eaXvRMKB8GMBtJA9Py/nVEWIA==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update key</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/key-management/keys/{keyId}"}></MethodEndpoint>



Names a key or removes its name, and changes the PIN of a QTSP key. The operation changes only the members that the body gives. The name is free text that an administrator gives a key, for example what it signs. The key ID is made by the wallet and cannot change. This operation does not change which key is the default key (`isDefault`).

The answer is the key as the read key operation returns it. A sandbox organisation cannot change a key.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key","in":"path","name":"keyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The members to change.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","nullable":true,"maxLength":100,"description":"New name of the key, at most 100 characters. Send `null` to remove the name.","example":"PID issuance 2026"}}></SchemaItem><SchemaItem collapsible={false} name={"providerSecret"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 256 characters`"} schema={{"type":"string","maxLength":256,"description":"Write-only secret of a referenced key. For a key in a `csc` key store, the new PIN of the CSC credential. Only for `csc` keys. No answer returns it.","example":"<yourPin>"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service changed the key and returned it.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key. The wallet makes it, and it cannot change. The value is the same as `jwk.kid`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 100 characters`"} schema={{"type":"string","nullable":true,"maxLength":100,"description":"Name of the key, given by an administrator when the key is created or with the update key operation. `null` when the key has no name.","example":"PID issuance 2026"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyStore</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The key store that holds the key.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key store.","example":"local-openbao"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault`, `dpod`, `csc`]"} schema={{"type":"string","description":"Type of the key store.","enum":["local","vault","gcp-kms","aws-kms","azure-key-vault","dpod","csc"],"example":"local"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the key store.","example":"Local vault"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`created`, `imported`, `referenced`]"} schema={{"type":"string","nullable":true,"description":"How the key came to the organisation. `created`, the wallet created the key in the key store (also in a cloud KMS or a DPoD partition of the organisation). `imported`, the import key operation imported the key, with or without a certificate chain. `referenced`, the key was already in the key store of the provider, and the wallet signs with it there.","enum":["created","imported","referenced"],"example":"created"}}></SchemaItem><SchemaItem collapsible={false} name={"algorithm"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Signature algorithm of the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the key. The wallet signs with a key that has the status `active`.","example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"isDefault"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the wallet signs with this key by default.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key in JSON Web Key (JWK) format. The service sends only public members. It never sends the private key member `d`.

</div><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type. The service always sends this member. The keys are elliptic curve keys, so the value is `EC`.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve identifier. The keys are P-256 keys, so the value is `P-256`.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate of the elliptic curve point, in base64url format.","example":"<base64url-x-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate of the elliptic curve point, in base64url format.","example":"<base64url-y-coordinate>"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier. The value is the same as `keyId`.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm for the key, for example `ES256` for a P-256 key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Certificate chain of the key as it is stored, in leaf to root order (for a test certificate, the leaf and the test root). Each item is a base64 encoded DER certificate. The service adds this member only when the key has a certificate chain. The `x5c` header of a signature and the mdoc `x5chain` have the leaf and the intermediate certificates, without the trust anchor.","items":{"type":"string","description":"One base64 encoded DER certificate."}}}></SchemaItem><SchemaItem collapsible={false} name={"x5t"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-1 thumbprint of the leaf certificate. The service adds this member only when the key has a certificate chain.","example":"<base64url-sha1-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5t#S256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-256 thumbprint of the leaf certificate. Note the `#` in the member name. The upload certificate chain operation gives the same value as `x5t_s256`.","example":"<base64url-sha256-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5c_expiry"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry time of the leaf certificate, in UTC. The service adds this member only when the key has a certificate chain.","example":"2027-11-21T10:00:00Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dids"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"DIDs that come from this key.","items":{"type":"string","description":"One decentralised identifier (DID)."},"example":["did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ..."]}}></SchemaItem><SchemaItem collapsible={false} name={"hasCertificateChain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the key has an X.509 certificate chain. Then the key can sign with the `x509` format.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSource"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`uploaded`, `imported`, `test-ca`, `qtsp`, `null`]"} schema={{"type":"string","nullable":true,"description":"Where the certificate chain of the key comes from. `uploaded`, the upload certificate chain operation. `imported`, the import key operation with a certificate. `test-ca`, the built-in test CA (the create test certificate operation), for development and testing only. `qtsp`, the certificate of the QTSP credential. `null` when the key has no certificate chain.","enum":["uploaded","imported","test-ca","qtsp",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"testCertificate"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` only when `certificateSource` is `test-ca`. The built-in test CA issued the certificate, which is for development and testing only. Wallets and verifiers outside this platform do not trust it.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"certificatePreset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The preset of the certificate chain of the key (the list certificate presets operation). For a test certificate, the preset of its request. For an uploaded chain, the preset of the newest CSR of the key. `null` when there is none.","example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>certificateAssessment</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

What the leaf certificate of the key allows: its key usage type, the credential categories that it fits, the mDL Document Signer profile, its QcPSB statement, and the texts of the save check for each category. The wallet reads the certificate chain of the key. A key without a certificate chain, or with a leaf that the wallet cannot read, gives `keyUsageType` `null`, empty lists, `mdlDocumentSigner` `false`, `qcPsb` `null` and texts such as `An EAA needs a seal certificate of a legal person. This key has no certificate. Request a certificate with the preset EAA provider (eaa-provider).` The texts do not count the trusted-list exemption of the key: an exempt key is never refused.

</div><SchemaItem collapsible={false} name={"keyUsageType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`A`, `B`, `C`, `D`, `E`, `F`, `null`]"} schema={{"type":"string","nullable":true,"description":"The key usage type of the leaf certificate (ETSI EN 319 412-2 clause 4.3.2, table 1). `A`: nonRepudiation. `B`: nonRepudiation and digitalSignature. `C`: digitalSignature. `D`: digitalSignature and keyEncipherment or keyAgreement. `E`: keyEncipherment or keyAgreement. `F`: nonRepudiation, digitalSignature and keyEncipherment or keyAgreement. `null` when the certificate has another key usage (for example with keyCertSign) or no key usage.","enum":["A","B","C","D","E","F",null],"example":"B"}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategories"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits (the list credential categories operation), without `none`. A PID certificate fits only `pid`, and a PID certificate with another key usage type fits no category.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"fitsCredentialCategoriesForMdl"} required={true} schemaName={"CredentialCategoryId[]"} qualifierMessage={"**Possible values:** [`none`, `pid`, `eaa`, `qeaa`, `pub-eaa`]"} schema={{"type":"array","description":"The credential categories that the certificate fits for an mDL configuration, without `none`. The rules are the same as for `fitsCredentialCategories`, but `eaa`, `qeaa` and `pub-eaa` also accept key usage Type C. A key signs an mDL configuration only when `mdlDocumentSigner` is `true` and the category of the configuration is in this list.","example":["eaa"],"items":{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}}></SchemaItem><SchemaItem collapsible={false} name={"mdlDocumentSigner"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the certificate has the Document Signer profile of ISO/IEC 18013-5 Table B.3 (key usage `digitalSignature` and extended key usage `1.0.18013.5.1.2`, both critical). A key signs an mDL (doctype `org.iso.18013.5.1.mDL`) only with this profile.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>qcPsb</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The QcPSB statement (`0.4.0.194126.1.3`) of a PuB-EAA provider, with all three values. `null` when the certificate has no QcPSB statement. A key with this statement signs only the attestations under its law (`legislationIdentification`, `countryOfLegislation`) and from its authentic source (`authSourceIdentification`), ETSI TS 119 412-6 clause 8.3.

</div><SchemaItem collapsible={false} name={"countryOfLegislation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The country of the law, an ISO 3166-1 alpha-2 code, or `EU` for European Union law (ETSI TS 119 412-6 PSB-8.3-05). A PrintableString of two characters in the certificate.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"authSourceIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unambiguous identification of the authentic source (PSB-8.3-04), for example a list of relative distinguished names. At most 2048 characters, no control character.","example":"cn=Example Register,o=Example AB,c=SE"}}></SchemaItem><SchemaItem collapsible={false} name={"legislationIdentification"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identification of the law under which the public sector body is responsible for the authentic source (PSB-8.3-02). Use a URI (RFC 3986) when one exists (PSB-8.3-03). At most 2048 characters, no control character.","example":"https://www.example.se/law/2026-123"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>categoryMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for a configuration that is not an mDL. `none` is always an empty list.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mdlConfigurationMessages</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

For each credential category, the texts of the save check for an mDL configuration (`mso_mdoc` with doctype `org.iso.18013.5.1.mDL`) of that category. First the category rule (with key usage Type C also allowed for `eaa`, `qeaa` and `pub-eaa`), then the ISO/IEC 18013-5 Document Signer rule. `none` has only the Document Signer rule.

</div><SchemaItem collapsible={false} name={"none"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pid"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"qeaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"pub-eaa"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustedListExemption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trusted-list exemption of a key: the certificate of the key is in a trusted list, or chains to a listed CA. While the exemption applies, a rule of the signing key check that the key does not fit gives the check result `exempt` and no refusal. The exemption is bound to the leaf certificate that the key had when the exemption was set (`leafSha256`): with another leaf, `applies` is `false` and `reason` says why and what to do (`null` while it applies). `listUri` is the source of the exemption: the URL of the trusted list, or a text, for example a recorded decision. Only the platform operator sets or removes it; the API cannot change it. The other members: `listUri` (the trusted list), `service` (the service of the list), `certificateSha256` (the SHA-256 fingerprint of the certificate of the list), `match` (how the certificate of the key matched the list), `setAt` (the time, in UTC) and `setBy` (who set it). Each of them can be `null`.

</div><SchemaItem collapsible={false} name={"listUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"https://example.com/tl/eaa-providers.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"service"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":"Example EAA provider"}}></SchemaItem><SchemaItem collapsible={false} name={"certificateSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"leafSha256"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"match"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"setAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"example":"2026-10-22T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"setBy"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"applies"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"qscd"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Shows if the key store keeps the key in a qualified signature creation device (QSCD). `false`, or `provider` for a key of a qualified trust service provider (key store type `csc`): the provider decides. The value comes from the key store.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trust</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The qualified status of a key of a key store of a qualified trust service provider: its leaf certificate against the EU trusted lists. The wallet checks it when the key is referenced and when the connection of the key store is tested.

</div><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`qualified`, `not-qualified`, `unknown`]"} schema={{"type":"string","description":"`qualified`: the certificate chains to a qualified certificate authority (service type CA/QC with the status granted) on the EU trusted list, and it is a qualified certificate for electronic signatures or electronic seals whose private key is in a qualified signature or seal creation device (QSCD). `not-qualified`: the trusted lists say no. `unknown`: the installation has no EU trusted list source, a list cannot be read, or the key was not checked yet.","enum":["qualified","not-qualified","unknown"],"example":"qualified"}}></SchemaItem><SchemaItem collapsible={false} name={"checkedAt"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Time of the check, in UTC. `null` when the key was not checked yet.","example":"2026-10-21T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The facts that gave the result, for example the certificate authority and the trusted list, and whether the trusted list or the certificate says that the key is in a QSCD.","example":"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The number of credential definitions and presentation definitions that sign with the key. Only the list keys operation returns this member. A credential definition counts once, also when several of its configurations or its status lists use the key. The read key usage operation gives the details.

</div><SchemaItem collapsible={false} name={"credentialDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of credential definitions that sign with the key.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitions"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of presentation definitions that sign with the key.","example":1}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Creation time of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"Time of the last change of the key, in UTC.","example":"2026-10-20T10:00:00Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"keyId\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n  \"name\": \"PID issuance 2026\",\n  \"keyStore\": {\n    \"id\": \"local-openbao\",\n    \"type\": \"local\",\n    \"name\": \"Local vault\"\n  },\n  \"origin\": \"created\",\n  \"algorithm\": \"ES256\",\n  \"status\": \"active\",\n  \"isDefault\": true,\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"x\": \"<base64url-x-coordinate>\",\n    \"y\": \"<base64url-y-coordinate>\",\n    \"kid\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n    \"alg\": \"ES256\",\n    \"x5c\": [\n      \"string\"\n    ],\n    \"x5t\": \"<base64url-sha1-thumbprint>\",\n    \"x5t#S256\": \"<base64url-sha256-thumbprint>\",\n    \"x5c_expiry\": \"2027-11-21T10:00:00Z\"\n  },\n  \"dids\": [\n    \"did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...\"\n  ],\n  \"hasCertificateChain\": false,\n  \"certificateSource\": null,\n  \"testCertificate\": false,\n  \"certificatePreset\": null,\n  \"certificateAssessment\": {\n    \"keyUsageType\": \"B\",\n    \"fitsCredentialCategories\": [\n      \"eaa\"\n    ],\n    \"fitsCredentialCategoriesForMdl\": [\n      \"eaa\"\n    ],\n    \"mdlDocumentSigner\": false,\n    \"qcPsb\": {\n      \"countryOfLegislation\": \"SE\",\n      \"authSourceIdentification\": \"cn=Example Register,o=Example AB,c=SE\",\n      \"legislationIdentification\": \"https://www.example.se/law/2026-123\"\n    },\n    \"categoryMessages\": {\n      \"none\": [\n        \"string\"\n      ],\n      \"pid\": [\n        \"string\"\n      ],\n      \"eaa\": [\n        \"string\"\n      ],\n      \"qeaa\": [\n        \"string\"\n      ],\n      \"pub-eaa\": [\n        \"string\"\n      ]\n    },\n    \"mdlConfigurationMessages\": {\n      \"none\": [\n        \"string\"\n      ],\n      \"pid\": [\n        \"string\"\n      ],\n      \"eaa\": [\n        \"string\"\n      ],\n      \"qeaa\": [\n        \"string\"\n      ],\n      \"pub-eaa\": [\n        \"string\"\n      ]\n    }\n  },\n  \"trustedListExemption\": {\n    \"listUri\": \"https://example.com/tl/eaa-providers.xml\",\n    \"service\": \"Example EAA provider\",\n    \"certificateSha256\": \"string\",\n    \"leafSha256\": \"string\",\n    \"match\": \"string\",\n    \"setAt\": \"2026-10-22T10:00:00Z\",\n    \"setBy\": \"string\",\n    \"applies\": true,\n    \"reason\": \"string\"\n  },\n  \"qscd\": false,\n  \"trust\": {\n    \"status\": \"qualified\",\n    \"checkedAt\": \"2026-10-21T10:00:00Z\",\n    \"detail\": \"Qualified certificate for electronic seals; the private key is in a QSCD (the QcSSCD statement of the certificate; the trusted list has no QSCD qualifier for it). Issuer: CN=Intesi Group EU Qualified Electronic Seal CA G3 ECC (CA/QC, granted, trusted list of IT).\"\n  },\n  \"usage\": {\n    \"credentialDefinitions\": 2,\n    \"presentationDefinitions\": 1\n  },\n  \"createdAt\": \"2026-10-20T10:00:00Z\",\n  \"updatedAt\": \"2026-10-20T10:00:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The body has an unknown member, the name is longer than 100 characters, `providerSecret` is given for a key that is not in a `csc` key store, or the organisation is a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key with this key ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Upload certificate chain
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-upload-certificate-chain

---
id: config-digital-wallet-open-id-upload-certificate-chain
title: "Upload certificate chain"
description: "Uploads a certificate chain and links it to a key. The wallet then adds the chain as the `x5c` value of the key, and the key can sign with the `x509` format. A chain that the key already has is replaced."
sidebar_label: "Upload certificate chain"
hide_title: true
hide_table_of_contents: true
api: eJztGtty2zb2VzB8kmdIyddc1ExmXTndVdM23thJHlJPCJGHEmoKYADQsurRv++cA/Am0Ym2M7sv9ZMoEjg49yseghRMokVhhZLBOPhQ5IqnhnGWgLYiEwm3wJIFF5JxmbJcyFvDhGVWMc5uYT1k1wtgK57nYJldgGQ8TQ0+Vbvcn/j+LInZHc9LYCqjV7ewDgmo/8MSLpkRc8lWwi6qXYcvY5YpveR2yM49TLvgtt7Fcw08XbMFN0wYpqHIeQLp8Hf5u7xeCMNUAZojffg5Uxp3GYao0X5jlYbmyIQXfCZyYdcsbvFgggfHYxbnKuF5HLL4jpe5xYd5UkS3S4OPfGXqxz9LDdEtrCO3kCiN00KlMRKCJ6uMcfbv66tLNogTk8QHbA4WuWs63M+0WhJquHTIrhWy2COPQGk98UVIpiQwY6EIWWmAdollobR1B9acGHg6HFYeQyXz9YHnG7BM5MCWpbFsBuzD9U/RC2bh3uIhl29+rWVyWTpR5MCzLtpCGxs6nSA8pAW9hFSQRjULTWuNVsq2vzntMqDvRAJMQ1YacPpE2K1wn7BsoXLS2UKLO4ROmrWqgO5gliowTCpbs+gyOj57xpJS34Hf19V/YRjcF0JDypSmnWuwqMwiDfFNtYWEgBrMbalpG65NlNaQ2Jqx3liSBSS3ph9DPudCGsfYQoMBWxmNhBUYyyZX71tmxAb4MAeJ4gX3sRL1wZhWwb0FmUJKy0vD5xDWu1t/TTn7AxLLeG5BS27FHTDJl15IjmQ0DS7TkGyJSza9ejeavpmwoxeHRyfRmUfYbRDGlKBR4VORZaBBJsDm4s5LccW1FHLO4kIrlGi0FGbJbbKIQ2Idlwy0VnrsVxPjKjVAda25Ti5BWPQhtWQVyWLIzjMLmiCU5N7CjmVfqVInELfZKQyL3VJIvYm0NlwSfTGu2pYPd5IZxLLM87hRQQSK/kkq+k7OhvudB0P2qbsOjduilFuHOnbS28k503CnboEc8WDy/peDIXtznwA58TEyzSFfkZSUWoO0OzA7JFsDeeYUidSx9rGzUuQ2Qhb7w0mmKUnfon8la0OmO6zSA3YLUJheJscIJEp4XDv+Ps62A0Sb7Npw3UkOR8S2iSPkdWq9QkG6E5tDYjLEc7QkrzsYd2Ya+C1qk4YUpBU8Z4mSmZiX3mPSWahPpokVt7Ae77hrqViu5Bw0y/ATCaAFlFuYK72uZdM+JHTupdq/8LFz28AuVFIuUaBXYi5BM288FE8kW1784tymVwJjRZ4zUyYJQGocp2KeZZBYSCc1ZpM2IiZmuTAOe7OFpCHoa+e0zUKtWIxyiaSyUSbQLkiXhWYxskvI+VtYT9DZxe5w1B+OfqAWp7GqGP4ugzCo3dY0DcaBO/dCzIXl+Sey/ncFyGnq0pTJVngOwqDgmi/BgjbB+PPDdnIjxdcSmCCKMwG6pWhBGAhcU3C7CMIAfV4wDm5hPU2DMNDwtUT3H4ytLiEMTLKAJQ/GD4FdF7jQWC3kPNhsbtxiMPZHla5xRRcHCp0oLNInF7hID7bTrWHPsYmSFqRFqMsyt6Lg2o4wEEcpt4TODmKK/DlyRiNvrQCDX1vHfUF0dkkJAxfhg3EwE5Jr5NBfJAU1wllpJwdAXaCAr3SKMaKbdKBeIMxuWB8Gm02bL593KbnZbNwaUyhpHLnHh4e7opjs4Fn5fGctxmRlnq9REC3G86LIcY9QcvSHQUD7c/0W1l9E2sfr/RW1ccy7fJ4Beg7DrEKk4Z4vCxRtcJId85dHyenz2Yv0FJ5l/DA5S5/D0YvZy+PT7OQw2IRtPpoviSodtR5PlNsc9A6iv5XLmcOuvd17gIadtULXKJ1swuD+zH6fFVf/Oo+OmF2Uy1mhhazzoO2UCXWLzbiBZ6elzqvstMOFV/XnyCz4UdQAfR04dL6Y47Nn++GECeP/AKvjs2fbeCVGT3t1BnMMPkMgzjvsqUO9GaSLs613lJ0O2TcSGaqbUtzTJegMjpLj7DmPXsxO0ug0eQbRy+yQR0ez4+QkPYWz7BkpnMt+/nvCrndyYsI13DdZ3iGqytQldAlZpiqJUh9rI0OxFhH3yYVpoc615rsO8rrJcE2FgA/Kg76MNy5KXSgDkYbSQHwwZOeSwbKwa4rGfQg3qWNtbKSDPjfdI/ML906bMERaWJo+P2eFJZ61fOonB2yHK+fo2sHV342fZVyaFehu2u9igo+niFXqhbQVzFTaG8B2pXErJGXFntBhD5mOHw4bl+oazMow0dlui3gmbifIY5+z3hPKPF/xtWle+U1ezYZY+qDKRuoOtBYpIsC7fZIW/cgcJ657SLurHJgfOjvcAopYYIa9VdZ2IKlzMj7X0GqLdA3LmVFXXXdhuaDUCl3oOXhdH1YpOybik6v3YY+W6k5gdvulQhPwUMZU6WHTA+FjSQI8WTCPGdmzLJeYJ2wLOqg8UM15p1cdBuGrNpHBTdtB7IDchMESDFbT+6ljWyG8SvqqmhWgjerGzOAC7iBXBaX+xDwwFs0VC2FnKj21GglTYfduzawujUUXIYznvyupDT3fgaZAYZgqrREpuPKuyLnFwMVS5fQPgTBhh+xC1V0UQX2hQqu0TJDAnjxNEYcr/txsWpR9xn/fK0n2crePlW+GrRbKAPMViWs3YtjAIg1ZUis6ppxNv9O1KrYKnHptXULu4an38Z7n32ZBjyt9tFx9jNwVdxqxRdIMMuyC+ratnNdupdeesa5tga7Kum2gUq2cWnqQ3oH/sFv44lLvYneLSTxtp5SkZnCX4qaD60vsGBlPfRqfkJJsqG1UdQ7RQVPJ7Dof+KDLHDD0thoEIH1pA/coZDytHUBnkPCqldisEIbNVIlmqnpzw544VgvzAjIhRVUH7+NKWoqQ1pt7mwxdn/IsO0qO+XOIDtPTWXSanJ1FL/npSXScPYej2cv0RXLkyoN+lfwL6HWlhh1UXgvo3fTi9ONkyhoDYFPqILJfwXIscrvYv1kWuVoD/MjTOUQm/WNlEVlXve+DV5zzGeTxI90YyMm1oVIKU+R8PUTIsf9ge/b3SaEfZTZDnLdY6zWX6sw8f5dRE2ObijrX2tlHvYpdIkXqRg19bahBbRe7XwWY3T7y9OL8qtPFerxnNqwscCBVx5GQiWG+K9KYDVyoqysVV1szFDauAc4JgIy+ljzHAJUybjG+ObRCFn91a/q/YxIRF+Uscotan6pG5myNa3zYLWe5SJiBxCrNZipdH7STCCQHzVYgo4HzIAy+uh9/QjdBwBfYEfq2PXyrIzhs5RT7RUDkrWmaBOTE+vK7TNiw8ZmZuK/scNvVDqvjeyuAR2zrnXTZDeYB24lAv5f7lovxFt1rKi32bOcUWwf77ktvq8N1I1pNgKruruvUVt23R65yQ2QvgKfUinzAf6euCbV3L6mNO5VDE5dC0fNFi9034Xf6Ts3uvpZOzbLTw8NND/geYTcq/iNPmZBFaVndekWRI7095Res2fQCI+NSGEPZbj3L85kqTZhwwNj61DPeY4NvjTdDFl++u7pmo7vjkTOnUeqayJFLeEeqACnSEY5nl1zyOWBSjX/NyAHEckZVwN2slYxlu9tPCcJB2D/G8zS5SQlUzsWPfuvZXdxuRLbW1KZKpYgbz7meyy2sY3Js355kPjbEDL87q2xmg2463kLXD9gsv4XeWwKD+Lqz9VXziEb8ugLgXvVA+KGedbePdcubyaFLu+MDGplQ3q7nXApTD/o5M1ymM3Xf/TKIr8pZXfUgUljr5rlaAWVqvtLcwcoMY4oE2yZ99Dc26Q+Sl3ahtPgT0h7WnP6NWXO9rZG+aVr7kWpyyqYXu2p19reOFFNJdw9yuvcB2rUCt3i0CQMDSamFXVOOfF6It7CmqI80cuzOfg785JC50SEb0PAQK4yDIAzewpr9Wvt+ZM0S7ELh3LFQhliDs8Bx8JeiyAONDjejliOJEj+kdHT1TSgvYKk82UEYlDoPxsHC2sKMR6MUlirihRiKuebSDoUKNuHOeLHuwDwG5nsQriyfY13/yHbjPm8jctPI4wrV0mlTJZUmbXUv/KzVCbSZtp57b/JIs+Ny6q48lTh5tt4aXIOh0wmNO3Bi5o6przIVGlz7lOwwdjgyqjGsC6JWc5ETDwqeYKECQ2wVd8COmd/4aq1KjezAu16vY9f4EjJTlQXzhCwYllwgI01ZYE7xj4Z5Nf3in82rLtfbAttiS70Ju293IgXqUis0OkvZUU5aydv9AGcHlJd8pKYfTltaRbehqptm9ANfkh9Qj6d/I13bqI6ojezyADGyKlE5XRkQhqEIQeIe473jn747h7kWVmMhJXth049cM29zrZLJsNKQeCyXKdepiYhewaVlWY5NJBKt5zRh++lkwj5O2ODnT9cHIZu+uf6JXV1EP3+6Zh8n7rTp1bv6gsXyQiUj7AW1yjQ3uzPorHORgDTkIivNLXiyAHY8PNwR3Wq1GnL6PFR6PvJ7zeiX6eTNb1dvItyzaYr6RpzIrGr6VFkEug0n9uPD49PhyfCIJmnK2CWXLXw+PJLFbBtVK8Y8Xf18uvr5dPXz6ern09XPp6ufT1c/n65+/t+vfvoSAQPNqMgxWdn4XOrBV2Kfg7tjdxkvE9Ry7lRj7vaopA5vtyJzL7BvO64udO6WZTdhsMCyb/w5eHjAO1kfdL7Z4OuvJWgqLcPgjmvhbiZh6SYMPqfBOOO52b6n1E6tBu99gX7AvnMHtZcJVfEkcQXlUcE4cETVd1Q3N3W/mZBz3yYOhegaITR7+y6PYiXoNp0n6E9ay3eaD5t2sYyd1iAMZv6665KaB3R5lOCGzaOf85coy3ZJ6Ej3D62JV5fg7eqwpp5Q793yCnPot7B+XS93Xx7dUFekbjWyHzv5/wG5gq92
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Upload certificate chain</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/keys/{keyId}/certificate-chain"}></MethodEndpoint>



Uploads a certificate chain and links it to a key. The wallet then adds the chain as the `x5c` value of the key, and the key can sign with the `x509` format. A chain that the key already has is replaced.

This operation is for keys in a key store with the capability `certificateChain`: `local`, `vault`, `gcp-kms`, `aws-kms`, `azure-key-vault` and `dpod`. A key of a QTSP (`csc`) gets its certificate from the QTSP. To add a key and its chain in one step, use the import key operation (`local` and `vault` only).

The file must be UTF-8 text in PEM format. Put the leaf certificate first, then the intermediate certificates, then the root certificate. The service refuses the file when it holds a private key, when the leaf certificate does not use the P-256 curve, when a certificate is expired or not yet valid, or when a chain signature is not correct.

The wallet checks the leaf certificate against the preset of the newest CSR of the key (the generate CSR operation): the extended key usage, the key usage, the subject alternative names, the validity and, for an ISO/IEC 18013-5 preset, the issuer. A difference gives the warning `profile-mismatch`, not an error: the wallet refuses only a chain that it cannot use to sign. After the upload, `certificateSource` of the key is `uploaded` and `certificatePreset` is the preset of that CSR (`null` when the key has no CSR with a preset). When the key had a test certificate, the test CA revokes it (CRL). Exception: an upload of the current test certificate of the key itself (the leaf that the built-in test CA issued for this key, not revoked) keeps `certificateSource` `test-ca` and the `certificatePreset` of the key, the test CA does not revoke that leaf, and the first warning is `test-certificate`.

A new chain can break a credential configuration that signs with the key: its certificate no longer fits the credential category of the configuration, or no longer has the ISO/IEC 18013-5 Document Signer profile of an mDL. The upload still succeeds, and `affectedCredentialConfigurations` lists these configurations. They then show `does-not-fit` in their `signingKeyCheck`, and issuance does not stop.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the key","in":"path","name":"keyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

PEM file that holds the certificate chain.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"certificate_file"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","format":"binary","description":"PEM file that holds the certificate chain in leaf, intermediate and root order. The file must not hold a private key."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Certificate chain uploaded successfully.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"key_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the key that the certificate chain belongs to.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"certificates_count"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of certificates in the uploaded chain.","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"x5t"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-1 thumbprint of the leaf certificate, in base64url format.","example":"<base64url-sha1-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"x5t_s256"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SHA-256 thumbprint of the leaf certificate, in base64url format.","example":"<base64url-sha256-thumbprint>"}}></SchemaItem><SchemaItem collapsible={false} name={"csrId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Unique identifier of the newest CSR of the key, the CSR of the check. `null` when the key has no stored CSR.","example":"5e1c2f7a-8b3d-4c6e-9f0a-1b2c3d4e5f60"}}></SchemaItem><SchemaItem collapsible={false} name={"preset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The preset of the check, the preset of the newest CSR of the key. `null` when there is none.","example":"mdoc-document-signer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>warnings</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The warnings of the upload (`profile-mismatch`, `purpose-reuse`). An empty list when there is none. When the uploaded leaf is the current test certificate of the key, the first warning is `test-certificate`.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`test-certificate`, `preset-override`, `profile-mismatch`, `purpose-reuse`]"} schema={{"type":"string","description":"The kind of warning. `test-certificate`, the answer issues or shows a certificate of the built-in test CA: the text is always the text of the example. `preset-override`, a value of the request is not the fixed value of the preset; the request value applies. `profile-mismatch`, the certificate does not agree with the preset of the key. `purpose-reuse`, the certificate chain of the key has a preset, and the new CSR, test certificate or chain upload has another preset: use one key for each purpose.","enum":["test-certificate","preset-override","profile-mismatch","purpose-reuse"],"example":"test-certificate"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The text of the warning, for a person.","example":"Development and testing only. The built-in test CA is not on any trusted list, and wallets and verifiers outside this platform do not trust it. Do not use it in production."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>affectedCredentialConfigurations</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential configurations whose signing key check fitted with the old chain and gives `does-not-fit` with the new chain. An empty list when there is none.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The credential definition of the configuration.","example":"6f1c2a7e-0d4b-4c55-9a43-2f7e1b9d8c10"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The credential configuration id, as in the OID4VCI Credential Issuer Metadata.","example":"EmployeeBadge-sdjwt"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `label` of the configuration, else its `display.name`, else the `label` of the credential definition.","example":"Employee badge"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialCategory"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}></SchemaItem><SchemaItem collapsible={false} name={"messages"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The rules that the new certificate does not fit, with the fix, as in `signingKeyCheck.messages`.","items":{"type":"string","description":"One text."}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"key_id\": \"3f2a91c47b8d4e6fa0c5d7e18b924f30\",\n  \"certificates_count\": 3,\n  \"x5t\": \"<base64url-sha1-thumbprint>\",\n  \"x5t_s256\": \"<base64url-sha256-thumbprint>\",\n  \"csrId\": \"5e1c2f7a-8b3d-4c6e-9f0a-1b2c3d4e5f60\",\n  \"preset\": \"mdoc-document-signer\",\n  \"warnings\": [],\n  \"affectedCredentialConfigurations\": []\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The key ID is missing, the file is not valid PEM, the file holds a private key (use the import key operation, `POST /v2/config/digital-wallet/openid/key-management/keys/import`, to import a key with its certificate chain), the leaf certificate is not for the public key of the key (`Certificate public key does not match the stored key`) or does not use the P-256 curve, a certificate is expired, a chain signature is not correct, the key store of the key cannot take a certificate chain (`The key store <key store name> cannot store a certificate chain; the QTSP of the key store gives the chain.`), or the organisation is a sandbox organisation (`Subwallets are not allowed to upload certificate chains.`).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no key with this key ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Validate transaction data
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-validate-transaction-data

---
id: config-digital-wallet-open-id-validate-transaction-data
title: "Validate transaction data"
description: "Validates the transaction data that a holder approved during an OID4VCI credential issuance."
sidebar_label: "Validate transaction data"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zgS/isEP7WAbKdpujgYi8WlSW/P3cUmaNL0QxLAY3FssaVIlaTi+AL/98OQkizLspPbwx4O2P3SxqI4nJdnZh6OnrhAl1pZeGk0H/MbUFKAR8d8hsxb0A5SWmMCPDCfgWfAMqMEWgZFYc0DCiZKK/WCgWYXk/OTm7MJSy0K1F6CYtK5EnSKwzt9p68zZA7tA1pmEUQ85huu2ExqQTI+frlmZs6mBaxy1P4LKIX+1Ht0HkiPacJSUGmpGiUzcBlt6VM4YaAFS01egEXHpGdL6bNmGz3SfSoM2cTTc82cN7Y6yKIrlR+yTwiCTVtHnYOHG7RyLlFMa1VAuyVa5g1ziO395IZPpQpCIZxSewSKQkl04zs9YFeoRVgrYKUMCFK0e+aUGdv3/D04/OFkmrBZ6Zk2nt6ZGZ8NSXD35X8GP5yqxZTlpfMhtgwfIfVqxYxG9gCqxOjIoHD4Hd+dIZu6DAbH736YBuEUXmMXoKUL0apEwgMyIB8P7zRPuCnQhuWJ4GOeGj2Xi3O5kB5UjPdFgXoiaixebyvME27xe4nOvzdixcdP4ae0KPjY2xKTDqSvuyCGyrOXEWLstKRIe5mCN5YVFh3qCLZocAB5hbUK+AuLKCi2HdANeUL2eNSeFAsBTYOo0VdH2jxxl2aYA/3lVwXyMTezr5h6nvDCkmO8REer+xKgtdN5SjveNbjfrghQmClkl1smmm+oN1CsLKT1YQhnXN9AA3bStUmpnXIRc2zI1wnfh7qWOWAtrHjCc6knHnPHx28SnsPj5se2nSSDgVoYK32Wb0zo6lc6dGxu7EEd2c/yAffjHpnRasVcWRTGehRVFkjXSgCecBlV3Y0Q6jLn41tevczv17s+6cMECCFpHdRlCx0vgnmrcBQKpGYfry5+G9aFRTpW4W1FVeTZEhLqR08g44vPg3KveuAYsFmQUlrFUKdGoGBRTFLX57mxrQiH+nB+cnMZMG6s/FfE8qdYF1gK1koK6suM3TVznbSKyu3+XDyA6/v1OopxhdEu5vTx0RH91/FMhqFHoiVQhYon+qFKUAz9SLT7yX9ScrZLTFd3ScJX/RrW53Z1spgaK55tiq02WBlJEjYWHK6FUjwPsIn2aDWoSiMmA/+YS7T7yEGj+8RTIlP4QzOGvEp+wmbXpImYDtmpWsLKUWHpWydjQQiLruYN4Zie5Jm8wK7PWn6nSrMxp0sbFjK0p51mtG3kZ4cxE1qSquQqwDcMilgZQy0KI7UPOm+o3IfHNAO9wJeoPdlxfw8lZFmEXB2zyjLpds2YoTJ6QWbGttTUX9AM88KvqorBlhnqlttbG5k2vbyUjDSBcVy0qMvvM7KuTGdMYKFMbMQ1bTqQ2/tLq+vpkNtavN8pnjvei/q3GGddcKoEZbAAqV1v/+z4e6pLpaYbN3claVOddqAfUmH8P+A3PT7/X/TgJJARfIS8UFhzfMSGaUBuSu0JUUFA3lCxvTGo+DBbENFuXxp6CljV2fuMr8t1ywkzYxSC3onBlMw/gIIDVOsg1kirh+KaYnaOAcz/XUQqIY1DqjT9vWT4uSxITalE6CQiHBz9QELrUkoV4NS3jNJlPkPbV/YfmZc5pUVeBB7kMDVauKQ2Ijeb6tJqB9UhsY62ek9ZiD/+cAVEv0KX6GrQ4VRS7LKnCT3r7Td7KvSBMrIf3e04tN0SOXkHam2V9/Cl+0D0MgSBlood/TqJTO/FxKx9DFpr7JkRSPcG+vu8FZz757jSZvcmzFJ7XIQ4V1WHj0+OjtY94vuuLvUW/j5UsqL0rAALOXq0fB1p7i5hrGtSxaxC+4tJ1Mx/fGm1iyihqJUu5tP+2U8feW/NL6RjuXQu3BuazJwZsQqJ7AK57xmiUN3dUyXpQE2XwYj6vJJ7QAdhMBq8M0dpLor1zbJRcWtikgHtp8KY0OnNSy3aPAepHLXXLube/Ikx91lDdRcMKb7tmnd/6nRsrkZV5oVjOj5aJ9xhWlrpV3x8+8RPC/kL0p/3a7IRFo58UU3pWExN9qqhu695wiehB5JLcvSZodleYVxwCfiMj/no4XgUp30jEQUNlkHQiIq7FCMnvi79qJVcAxEHflFxFzTrNvjcVHZRMbeKj3nmfeHGo5HA3AygkEO5sKD9UBq+TroCLq0RZSQpe8Q8J+HKw4L4y57tLi53FbnfOPyKcBfhUrt9Q/njg4RLOipGjCdcQ06rW+OPnTZ+ejkJBAs2RJlmlC0mUzXz6ZacKYvHNDPewuJcPqKIk75p1JFN2SttPNZUT6rggwJSfJ0wHC6GHbFjVm38cWVKS+4YfMPVT9NIDSgHP23Guh9qlB8ahG6SYv90sTVy6yP7+wdazV2FXD83dfmANJQPzEFSkKuB4N83gW1iI3/ePNpGRBtMnZA1m8LUWQqiy+H7hUKPTNL/ecNWt+6c4VLR4rVnDY1ybFLft19V32deh6bXv3GLEDcZfvmaNPImNcoRgqRjBC/UtMdVLSwGOty1AyFOQheMM9RwNVixKvFbF3GaowToeNACrHCDYK8E7dlcmaWLsKs8HbT98vaM3ZyxVx+/XL9O2OTD9T/Y1fmAZr03Z/G0ydUFe/O3ozdvB+9Yfm7SUX7+a/vyT/NE8KGJKpmidgFqdVYVkGbIjodHO6FbLpdDCMtDYxejaq8b/To5+/Db1YcB7SFMSa+2MBCcJUxaNtHjCaeSFsN+fHR8Mnw7fEN7qWbmoFv61B9Cdm5U3Yxvdbi/vuT99SXvj/+SVzUpj49+FAYc4aJJGfNUNf1b/nAcJ9RzGUY5W42/uteFu2Bo/tu1PLb/+4RnxCPGt/zpib4UfLZqvabH30u0gaMk/AFsKF+BsdTUJvCFb9RP+VlMjME1aUyvqzK21w4NpPYed5ymKRb+4LttqnN5cXXNEz6rvknmgfJxC0u6RMKSj/kdv+PB4FAkA82k509cgV6UsKD3o1xqiNS0t3nAt8ADqj/IsnpJr1padilBNIb+JdN6t/xIxekXXP3UvB5X9m5oaEh8m8JOl+B/A6iRfSg=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Validate transaction data</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/transaction-data"}></MethodEndpoint>



Validates the transaction data that a holder approved during an OID4VCI credential issuance.

The server reads the key binding JWT of `paymentWalletAttestation`, calculates the hash of the transaction data, and compares it with the hashes in the key binding JWT. It then stores the result. Read `transactionDataVerified` of the answer to see the result.

Rules that the server applies:
- Send the payload in `transactionData` or in `transactionDataBase64`, but not in both.
- `transactionDataHashesAlg` must hold exactly one value, and that value must be `sha-256`.
- The organisation must have a key.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Transaction data and the Payment Authenticator presentation that proves the holder agreed to the transaction.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"paymentWalletAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authenticator Verifiable Presentation token that the holder sent. The token must hold a key binding JWT with the transaction data hashes."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataHashesAlg"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`sha-256`], `>= 1`, `<= 1`"} schema={{"type":"array","minItems":1,"maxItems":1,"description":"Hash algorithm that the key binding JWT uses for the transaction data hashes. Give exactly one value, and the only supported value is `sha-256`.","items":{"type":"string","enum":["sha-256"]}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data payload in plain JSON. Send this property or `transactionDataBase64`, but not both.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data payload in plain JSON. Send this property or `transactionDataBase64`, but not both."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction data payload as a base64url encoded string, in the form that the OpenID4VP Authorization Request carries. Send this property or `transactionData`, but not both."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The issuer validated the transaction data and stored the result.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionDataHistory</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The stored transaction data record. Read `transactionDataVerified` to see the validation result.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the transaction data record. It is not the same value as `transactionDataId`. Always use `transactionDataId` to address the record."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier that the server gives to the transaction data record. Use this identifier in the path of the read endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential issuance history record that this transaction data belongs to. The value is an empty string when the record belongs to no credential issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VC deployment that validated the transaction data."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64s"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Base64url encoded transaction data strings that the issuer verified against the key binding JWT. The value is `null` when the issuer verified no string.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"paymentWalletAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authenticator Verifiable Presentation token that the holder sent."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data payload in plain JSON, for example the payee and the amount of a payment. The value is `null` when the request gave the payload as `transactionDataBase64`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data payload in plain JSON, for example the payee and the amount of a payment. The value is `null` when the request gave the payload as `transactionDataBase64`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the issuer verified the transaction data hashes against the key binding JWT."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>vpTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Presentation token that the holder sent. The value is `null` when the issuer could not decode the token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Presentation token that the holder sent. The value is `null` when the issuer could not decode the token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server created this record."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server last changed this record."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"transactionDataHistory\": {\n    \"id\": \"string\",\n    \"transactionDataId\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"transactionDataBase64s\": [\n      \"string\"\n    ],\n    \"paymentWalletAttestation\": \"string\",\n    \"transactionData\": {},\n    \"transactionDataVerified\": true,\n    \"vpTokenDecoded\": {},\n    \"createdAt\": 0,\n    \"updatedAt\": 0\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is not valid. The server returns this status when `paymentWalletAttestation` or `transactionDataHashesAlg` is missing, when the body holds both `transactionData` and `transactionDataBase64` or none of them, when `transactionDataHashesAlg` does not hold exactly one `sha-256` value, when the organisation has no key, or when the validation fails.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Filter verification
Source: https://docs.igrant.io/docs/openid4vc-api/config-filter-digital-wallet-open-id-verification

---
id: config-filter-digital-wallet-open-id-verification
title: "Filter verification"
description: "Filters the credentials in the wallet of the holder against the request of the verifier and returns the matches. Call this operation after the receive operation, and use the result to build the request body of the send operation."
sidebar_label: "Filter verification"
hide_title: true
hide_table_of_contents: true
api: eJztWm1z00gS/itT8+UIJct5YwHf1tZxMeya5ZYcCfCBTZ0nUtseIs2ImZGDN+X/ftU9I1mSFRLYu6urXX8Bx56X7qdfnm6pb3gKNjGycFIrPuIvZObAWOYWwBIDKSgnRWaZVPTVtcgycEzP6K+FzlIwTMyFVNbRVwY+lWDrFUswciZxjUqZAVca5c/OhUsWYGN2IrKMuYW0TBdgBIrBxMyBCcclIJew+S2ik0oL4WdbZo45zS5LmaUtCS51uqrEsKDSzRnxr+pXde63F1pZr4hl04bCU3a9ANXWwYJyTLDxyT9fsU8lmFXsP0uvklbZyn/PZtrkzC2EY0Ix+aMRysVSt05KbcSs9pqHA0pbiowJZa/BxKxPQKmK0o2DwbSxU7RLkYkEUFPpvAwzbZiocZgZnaMYunRWpg11SD7rZJYhnhY1m7xgpwZQT2+I55+ThVBzYCnMpJIEHgkW/EDBEkxt10vtFuwKVrYGWBgjVkF4rYCBch4dhhtXDQ/zwEX4vQoKeChJSqWbS9u+6PGyMXsDImVT71jpSdOUWjEQycJfP0IwIC/cKoiXC3NlA2DSQI5WplsbLp4IpbRjOYBreI8HeCEsCoj+1gInlTYRJsWjyRfljK10GXxRQXWOAbS/0uzdEdrGIu7kts2QiNlbC2hgp+fgFmDYtXQLkvDdURUlETMIAQZI2+HRIDzi9d+TlI94otVMzn28j+VcOpG9J8FfF6Am6Ttyk4TW84gXwogcMDXw0YebTtJ4q+SnEpgkxMm3QtwVTWcykGiTfimTIHybcJg2d0/SKSsMauDqqPYHRgwtIx2GR2NRzCMuUbhCuAWPuBI54F+tM3nEg9VTPnKmhIjbZAG54KMb7lYF7rDOSDXn64jDZ5EXGX53NDsUj5ODJ4Onl8cwOE73xeBJ8t1scACPLg/F0/Q4eXzE1xd4ug9giwce7u/jf23sGg6T6LwQBtKt5Fvbuordv9ja+25LrDxCCztQDu8URZEFYw4/Wrz4ZltTffkREofG9hhKL3ZDksZiih0edbT5h7/dhziGXDfCK/NvkmiXKiKvbl+6CEm3AVkGYgnWB8vGPcqQCG9P4fdKdD8i85AnomPpWSOJVGq0KcPnk37OQXd0kNs+vNsYntyTdilHkbkJrC2kO7hSvvk9fBWzF5SXG6ZryFb5YNtuDx+S5R4+7En1ZGaCFn34lsSdrWL2TFWg2yqjeJ6o7Rtk8ETTJguUgjSjW//qE0XfXd54HptAEIFTXM1kGag5hqJmM6n8D3isJBfsZYzA5hVndMCaYlYK+helKbSF6f+Ew581rehZvDA6LRPSBHJPGO08INPtrNj13ckWBdA9W75ZoWXbiY7sUgeetGwpshKYsK0wrNOcVPNvDcfgy/1IVbA3i7MJll5sU3s12A5je8MNp2CsVoMKCZ90B2PhxOB0MkYe8VR0F5Q/lblQA2R0cZkBw02VLg04G0VLXGnT9KC7FBRV1Ai6IWa/BGfwJ806ER+j/MFT71bhDQirMUxXnWbAXtkQmNI2tPm9GgTB7qXEdgq4k9y+KjGLuQGomFvaJnfVmcZXobdmsdrHmwg1sojIrsXKsrn0FAg1A/omSToqLAmKqSqzbPpFErqN9CffFPY9sn+58uuJ+WlTiGnEMOhU+1s7japj79H3teI0PXwqvksOYHB8+WQ2OBYH6eBpcgSDxzOs4fbTJ3BwgI7iNd9yjS6OmzLxNqdhuNJuAfT+6IT5Ypvi/KTf1rcWOujcmjqCNunlwlly9GXi7jZgrwDsfFXAlryT5+cv2Nl48PL9OXt38h8SMtVJB+dbBB3rpPQdWq9sZ6/ZwZP9g6PBI5aPdXJb5Hy7oHRVX/iINCVuFdlpI5B8T9HxiEzI3NY9XuOi7cQBzbyBrTUTBliCJzBsbFihpcKuzIe8W8CKVlC6xTiyWKwgc1Hk4D4Mmq+IGaxciCvVl9DFFrtmexQs8sXyFazYFUBhqe5ChrGFSCDyRb2PRTbVZh5Lq2M6PH4UH8Qzkcts9S8qj2L2GtngG6qhfurw+ZLARJTR7Ch6LRyp/L5Kyr5eqRlLaWalmmfBCFEzo2XSOls92SATkUDSYTFIjwMybWEUVkw3F0JGBD71TKW64PpLqv1pONuCq9a3Q7J2BXa90FmrKDoryV3DRT71nLCX78+x3luvm93whzYFVJ5/se4uk/WPbTa9wIXdB1Zf30B2667ov1saf6H77Epyv4xyn8eIu95w1xvuesNdb7jrDXe94a433PWGu95w1xvuesNdb/hH7g3XtHgBIqV3yjf417F/QXrv95bNq8AYbU50CpjI8fO4EVgX0R2Uttm9CV8MnjmYJjEc7++ve47vyUwbLvm7wHfeGGb1O3QetN9+E9x6YT4ZI0mX6krpa0UUR62ZmQslbXinXiqqN6xQ6aX+zHKdQsx+8rXG5v0/xT21HEshM0rlTtebmifSi+OuVQ7+xFZ5q0TpFtrI3yDdgubRn9phJ8guSmTMgsFCkq7pYLSOuIWkNNKtaHDkWSF/Bvx4geMRTsxxnoSH+RPmB1DYAxpBGR+/O9njEffejJDk4BYaZ1cKbQkSHO0Y8eHycOinWYapP2jgs+5QF6BkOrTpx2s3XDYmWoY37UGQ9XBGgzAcxUVl+sZcxpDroCuPeGkyPuIL5wo7Gg5TyPVAFDKW8/CEhK+j7gGn1EZT4N5yzF0nnDkxx2Lmlu3W/9wV5GJjhDP0Re9ClSk25av/IszNeCtuJmeehTCoJoLagj07nRChY7Bglk/EZljMF+2hhJi2zpkyfw3LSyw1KAHO5GdIwxMgLyObsgdKO1+6OCNkRhggP+5FDOJ53Dl2xMLG71e6NAjH4ApWP0xj7h9KznQVtsJXwJALiUDasii0cX/bgFfrXz/62kK9abAOLJvnZYXRS5nSYxic88nAAZP4f17n+4CQd36i4d7S27KJtaVQCbAHrylKJntE6/0bW4VOHVmneyiR04nObBi7QhOCwj02UMJvgT2cZtLaEiLqyHwNQdG0YiHgWk9qSkvmcUKlOP82IH2lwG4709dhnCkgTdKGWuPBy/fne1FvxdItL4f5+FVvGR7xTCag/BOIynMLkSyAHcb7W6a7vr6OBf0cazMfhr12+Gpy8vyXs+cD3IN9nnRZywcIrDT0G1VEhOk9PuKH+4fH8VFMPSLmqlyohjx+5o4t2xN2aTs/15yyG8ndjeTuRnL/oCO5gXkdfHbDIhNSYcagFHUTqpsPfHnoZzlnkh55tCocP9WrqM+iKsenoWZeGW2NvIZS5yLiC6yjRh/4zc2lsPDWZOs1fk1mxhot4kthiEZ8OSQtfk75aCYy23140cxZD96ESneP/b8OB/dCX1VCCssgqlv4iPOIX2Gh1B0eXl/UHSzB4xc9SxIoXGP7Vkuwbpayp6/PzvERUekW7VLsikqx8AGP75WtW5V5GfBfLB57t3yP3PUzrH6ol/tfbt1QV4J+NSKFDfy/Ae6G1Z4=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Filter verification</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/verification/{presentationId}/filter"}></MethodEndpoint>



Filters the credentials in the wallet of the holder against the request of the verifier and returns the matches. Call this operation after the receive operation, and use the result to build the request body of the send operation.

The response holds `credentials` when the verifier sent a DCQL query. DCQL is the only query form that an iGrant.io verifier sends, so this is the usual answer. The response holds `inputDescriptors` in place of it only for a request from an outside verifier that still uses a DIF Presentation Exchange definition. The wallet never returns both keys.

The array holds one entry for every credential query, even for a query that no credential in the wallet answers. Read `matchedCredentials` on each entry: an empty array marks a requirement that the holder cannot meet.

The request has no body. The wallet discards a body if you send one.

There is no V3 version of this operation. Use it together with the V3 receive, read and send operations.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the presentation record in the wallet of the holder. This is the `presentationId` property of the record, not its `id` property.","in":"path","name":"presentationId","required":true,"schema":{"type":"string"},"example":"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet compared the credentials with the verifier's request and returns the matches.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentials</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Matches for each credential query in the DCQL query of the verifier, with one entry for every query. The wallet leaves this property out only when the verifier sent a DIF Presentation Exchange definition. Give the `id` of each entry in the `credentials` array of the send operation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the DCQL credential query that these credentials match. Give this value as the `id` of the matching entry in the `credentials` array of the send operation. For a Presentation Exchange request this is the Input Descriptor identifier.","example":"Person-Identification-Data-PID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the credential requirement. Present only for a Presentation Exchange request that holds a name. Never present for a DCQL query."}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason why the verifier asks for this credential. Present only for a Presentation Exchange request that holds a purpose. Never present for a DCQL query."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>matchedCredentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credentials in the wallet of the holder that agree with this query. The array is empty when the wallet holds no matching credential. The wallet always gives the property, and it is never `null`.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the matching credential in the wallet of the holder. Give this value as `credentialId`, or in `credentialIds`, in the request body of the send operation.","example":"d29a6c1e-4b8f-4a1d-9c3e-7f5b2a0d8e11"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential types of the matching W3C Verifiable Credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type of the matching IETF SD-JWT VC. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type of the matching ISO 18013-5 mDoc credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>match</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of this credential that agree with the query. The keys are claim path pointers, and they are the values to put in `claimIds` in the request body of the send operation.

For an ISO 18013-5 mDoc credential on the DCQL path, each key keeps its namespace, for example `org.iso.18013.5.1.family_name`. Only a request from an outside verifier that still uses Presentation Exchange gives keys without the namespace.

When the query asks for no single claim, the wallet lists every claim that it can disclose: every `namespace.element` for an mDoc credential, the disclosed claim set for an IETF SD-JWT VC, and the whole `credentialSubject` for a W3C VC JWT.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Claims of this credential that agree with the query. The keys are claim path pointers, and they are the values to put in `claimIds` in the request body of the send operation.\n\nFor an ISO 18013-5 mDoc credential on the DCQL path, each key keeps its namespace, for example `org.iso.18013.5.1.family_name`. Only a request from an outside verifier that still uses Presentation Exchange gives keys without the namespace.\n\nWhen the query asks for no single claim, the wallet lists every claim that it can disclose: every `namespace.element` for an mDoc credential, the disclosed claim set for an IETF SD-JWT VC, and the whole `credentialSubject` for a W3C VC JWT.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>inputDescriptors</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Matches for each Input Descriptor, for a request from an outside verifier that still uses a DIF Presentation Exchange definition, with one entry for every Input Descriptor. The wallet leaves this property out when the verifier sent a DCQL query.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the DCQL credential query that these credentials match. Give this value as the `id` of the matching entry in the `credentials` array of the send operation. For a Presentation Exchange request this is the Input Descriptor identifier.","example":"Person-Identification-Data-PID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the credential requirement. Present only for a Presentation Exchange request that holds a name. Never present for a DCQL query."}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason why the verifier asks for this credential. Present only for a Presentation Exchange request that holds a purpose. Never present for a DCQL query."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>matchedCredentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credentials in the wallet of the holder that agree with this query. The array is empty when the wallet holds no matching credential. The wallet always gives the property, and it is never `null`.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the matching credential in the wallet of the holder. Give this value as `credentialId`, or in `credentialIds`, in the request body of the send operation.","example":"d29a6c1e-4b8f-4a1d-9c3e-7f5b2a0d8e11"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential types of the matching W3C Verifiable Credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type of the matching IETF SD-JWT VC. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type of the matching ISO 18013-5 mDoc credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>match</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of this credential that agree with the query. The keys are claim path pointers, and they are the values to put in `claimIds` in the request body of the send operation.

For an ISO 18013-5 mDoc credential on the DCQL path, each key keeps its namespace, for example `org.iso.18013.5.1.family_name`. Only a request from an outside verifier that still uses Presentation Exchange gives keys without the namespace.

When the query asks for no single claim, the wallet lists every claim that it can disclose: every `namespace.element` for an mDoc credential, the disclosed claim set for an IETF SD-JWT VC, and the whole `credentialSubject` for a W3C VC JWT.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Claims of this credential that agree with the query. The keys are claim path pointers, and they are the values to put in `claimIds` in the request body of the send operation.\n\nFor an ISO 18013-5 mDoc credential on the DCQL path, each key keeps its namespace, for example `org.iso.18013.5.1.family_name`. Only a request from an outside verifier that still uses Presentation Exchange gives keys without the namespace.\n\nWhen the query asks for no single claim, the wallet lists every claim that it can disclose: every `namespace.element` for an mDoc credential, the disclosed claim set for an IETF SD-JWT VC, and the whole `credentialSubject` for a W3C VC JWT.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentials\": [\n    {\n      \"id\": \"Person-Identification-Data-PID\",\n      \"name\": \"string\",\n      \"purpose\": \"string\",\n      \"matchedCredentials\": [\n        {\n          \"credentialId\": \"d29a6c1e-4b8f-4a1d-9c3e-7f5b2a0d8e11\",\n          \"type\": [\n            \"string\"\n          ],\n          \"vct\": \"string\",\n          \"doctype\": \"string\",\n          \"match\": {}\n        }\n      ]\n    }\n  ],\n  \"inputDescriptors\": [\n    {\n      \"id\": \"Person-Identification-Data-PID\",\n      \"name\": \"string\",\n      \"purpose\": \"string\",\n      \"matchedCredentials\": [\n        {\n          \"credentialId\": \"d29a6c1e-4b8f-4a1d-9c3e-7f5b2a0d8e11\",\n          \"type\": [\n            \"string\"\n          ],\n          \"vct\": \"string\",\n          \"doctype\": \"string\",\n          \"match\": {}\n        }\n      ]\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The presentation ID is unknown, or the organisation runs in sandbox mode. Holder operations are not available to sandbox organisations.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all webhook deliveries
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-all-recent-webhook-deliveries

---
id: config-list-all-recent-webhook-deliveries
title: "List all webhook deliveries"
description: "This endpoint is used to read recent webhook deliveries with pagination from the consent building block that were sent to an external IT system."
sidebar_label: "List all webhook deliveries"
hide_title: true
hide_table_of_contents: true
api: eJzlWG1v2zYQ/isHflkCKLbzUmwwimKZnRVuuyRo3ORDYSC0dLLZUKRKnpx4hv77cJRsy3a8NgUGDNuXRJF4x+eeOz53zEIkmDuMJWEiuqnUHiORoI+dyklZI7piOFUe0CS5VYZAeSg8JkAWHMoEHMZoCB5xPLX2ARLUaoZOoYdHRVPI5UQZyZ4gdTYDmiLE1ni2GRdKJ8pMYKxt/AA0lezHIYSvZEEawCdCZ6SGwRD83BNmLREJm6MLTgeJ6IrYmlRNPihP51p/DHjuKjj9FRoRiVw6mSGh86L7eSEUx5ZLmopIGJmh6Io6iEEiIuHwa6Eck0KuwEj4eIqZFN2FoHnOiz05ZSaijISnuQ5vVJZrFGW02GLwssjG6MCmzJZ1iefg/IPKIbWuQVELzsHgRJKaIVgHhWGK5VgjzKQuEFKptYexZLYs3HfumYwQyNcC3XwdiU1Tj7QRRp3bnTiUIZygE5z2VBaaRLcTiUwZlRWZ6HZKjqd2q1WmaHvLzVj/kE9sCOa5mB1S4QzkGKLG1o8CPO6U5Yhtfc615Hn1SafDv2JrCA3xo8xzreLAbPuLZ3SLhvfccRWRqqzXSWjsbMdfMOZ4SVHI8PV6VbTlIC6cQ0PXcoJ7sDdZ6lWrAws1VSIS+CRDBXWPy0iQJakHhJn/Dn9DXtzgXLEdyJlUmsun6fvk1dI5Y/0R5wyaq5BlwBpYFsVqh9Myqivl274vtyAvS2ODjU4Zian01w5nyhZNyGNrNUqz43ZgEs48elApa47DnzxIyGsPO1uE2qt2ucQn+vEdDD7RjndWkLIso6XANGSpu60Vm8rF50sta8AavEqDdu2rz13jTedXBiGXc21lslTqOUgizPJKcJc63oLhlHXYzVSMIPWjnHuW5cSD1Bp+hlShTvzmAf4sFCvnpopWJ/SGJBW+ZxPceXlDLkSQoSeZ5YL1lN+vHvqNEEbliKu3Cl86J+eCeW1i2OU4ap7uUbTFXkjMFk3vRSSmKJPQKxa84Kxz/CJ1aSJC56yrYw/PGxFt49kWlrX1c6dpVWNnHT4lO+53+lXDRPwmE1AmL7hi697IdOwS8snIgqbWqT8xeYaas/8xNR/R28LFCMYSpLYwuwS9emFn+m8RNDD1BMdqgg7CNlsc8RCFceEUzYO+nefqPfLjiNs8yQmPbEt147AzpKnl2W8SppwwxnVFe3bSrobBdq0Cvr1YyVHZTpqaUMGpZsFNxH3MbI1WRKJwWnTFlCj33XY7wcweyVy11MRJQy1ln5n3rp1NijgMvXvcfMvDDbFiTfaZ++rzNpDRmsYbrqaqCJZkrrIpqxf1GFflYT06ntcnfTnmbAI7vx7AA86B9QAN1UVctYtqRrWhHcL9hp97qLaBrPAEY+ROnKonTKpbwn2FEe7hwFjC4ICcVDpwkMsYDyPA1qS15bYLteHruS0c03H0gPM3963QFZRJ7fLgyTgcPMykYiJ9kefW0a9r8lbxq7frV5usNxO2RcvKCHJnZypBngViy2eFEMK9IEND1UWoZugqRzPohyvALTqVqjDo9xwmTKzUHgbeF9LECAdXg/7ZbW9wCNIkewyvHfrVFgfVmrPb60NGRDa22nOWlAdOIRq28WDdRJqazDChK+8LjGBqdRKFzfi8pHNI1ETxFBg34BU+pIekSaRL/FGIV0lDkGr7WF8Aa6YD2rvTHtz24ODd3fAwgsHF8He46R+9uxvCba/abXBzBce/dI5Pj15B1rdxO+t/aOzJXjJJYe7QKkbjg7ItKzeX8RThpNXZSd3j42NLhs8t6ybt2ta3Pwx6F5c3F0dsU67nqHU6mazExsUqeyISLBtV2k86J2et09Yx2+bWUyZNAw/fSMO4tHs53j5Xje7wb7xv18JB+ETtXEtlOODA8KLW3s9idiKi+iq+HgI50G5zIGxQMIrE1Hpi28WCbxOfnC5Lfl3dLIMwK8+FuudfE03W/tk79rMEPLCqrq/awVx0RSXn3w38pRfmv4GyvImtkYz4DxcE4oV8Hnysp5BD2Lfpsp2YeXPPJZh11sPMXrcZBlF9P49jzJtod4aistno314MRSS47Wx2sofQyeqHxt1oE9V2U6sg8E9O1rMmr/nov8f5m9Xy6steg1UjrVYzR6OyLP8CgZu8Aw==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all webhook deliveries</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhooks/{webhookId}/deliveries"}></MethodEndpoint>



This endpoint is used to read recent webhook deliveries with pagination from the consent building block that were sent to an external IT system.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhookDeliveries</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

WebhookDelivery

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"WebhookDelivery"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the delivery. This is the `deliveryID` field of the delivered payload.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"webhookId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook that made the delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"responseStatusCode"} required={true} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"HTTP status code that the payload URL sent. The value is `0` when the service could not reach the payload URL.","example":200}}></SchemaItem><SchemaItem collapsible={false} name={"responseStatusStr"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"HTTP status text that the payload URL sent. The value is an empty string when the service could not reach the payload URL.","example":"200 OK"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the delivery started."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`completed`, `failed`]"} schema={{"type":"string","description":"Result of the delivery. `completed` means the payload URL answered, also when it answered with an error code. Read `responseStatusCode` to see the answer. `failed` means the service could not reach the payload URL.","enum":["completed","failed"],"example":"completed"}}></SchemaItem><SchemaItem collapsible={false} name={"statusDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason for a failure. The value is an empty string when the delivery succeeded."}}></SchemaItem></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"webhookDeliveries\": [\n    {}\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List credential definition templates
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-credential-definition-templates

---
id: config-list-digital-wallet-open-id-credential-definition-templates
title: "List credential definition templates"
description: "Lists the pre-defined credential schema templates that you can use to create a credential definition. The platform returns only the latest version of each schema. A claim path pointer schema has one entry for each credential format, so the same `name` and `version` can appear more than once. When the platform cannot read the schema repository, it returns an empty `templates` array and no `pagination` object."
sidebar_label: "List credential definition templates"
hide_title: true
hide_table_of_contents: true
api: eJztWW1vG7kR/isDforR9Up2ckCrHg51rVygnBMbtS4u4BpZejmSGO+SG5IrWWfovxdDrvZNcqxcUbQo+sWWVst5eeZ9+MQE2tTIwkmt2IhdSOssuAVCYfBY4EwqFJAaFKic5BnYdIE5B4d5kXGH9C53sNYlpFxBaRGcpve5Q+Dtg56WJDYxTIl+xt1MmxwMutIoC1pla8/Z03WwRGOlVqBngDxdVJxjOIM04zKHgrsFFFoqh2Yr1oITHQRUzqxhpk042hKDWHIXgdWel+U5QqJ4jglwJSCpuCZeHV4UyA3k2iDpqUCrFGO4WaAKGG11SLlS2oFBLgLZII7BQlvptFlHIF2tKVeAeeHWkNQwJsCN4Wsvg9KQFHwuFXdeEn3/BVMX/0OxiOkCjX88EWzEUq1mck42G8u5dDy74VmG7rJANRHntdLjGvrplh+LWMENz9GhsWx0+9Tzg49lfo+GsDeYaiMsmdU+yMKD2khH5lA4504uEbSBUhEG/D5DWPKsRJjxLLNwz9MHopAMk5hFTBKLryWaNYsYgc9GTM9mFh2LmMGvpTQo2GjGM4sRC2Cy0RNz64JeJZPP0bCICZzxMnNsNIxYLpXMy5yNhptN9LQlm8lcuj7Lrq4f+CMdBLVP52AzKNBrjfHvFfBkuNnc0VlbaGXR0tunwyH9S7VyqBx95EWRydQjO/hiSbqnFvXCkPmdDKdr36EvXY3OvxGvZD9y0bQ0BpWrtZIOc0+KZ9nlzLtEpU3wvx3Yrr6dIPppgVtoxPBScFC4OjBFcBGyUksPo/MQhOV9JtM9IjTR959PGiBDxsikrSK5a8zgrTXk1hmp5juQXweBpZdrJtEQTtJWoSYDRDOdCTRAFMmXW+mokuGbSLGI4SPPi4zEuMA5z67QWMo3gWdwzjF3nG2iStyXxB5LnmHqetIInZY5Khd5DL3kEjMRPMchpQ3yn4VeURySC0kXQ+LteMXd4ipYMSG9+T7zNgxWC5kutviIRhqfKMdvPp1P4CQexpBQzAWQK7Lvry8/wnVX4CAhcpNJNNsyZYN20sLZ1YSkFX8GoYGqQhD9RZf3XoGKMtgtawRhEeurzO42Eav4HuA0mHPlZNouqI0Z/rVi3PEWgnBIXrGTD+sMwoXwyvLsquX+zpTYl3q66ygx/Owh3OMC27QQQaqLdbBDYApSUd1J9xRDe3sXe1I2gdW2pO9EPflBItI/WHH8ZeUSKnJJbvXnXOg0Cb77Aos9z19k+GXlPi/Tz+QGCXnGJmI5Oi4o7vbg2k0mUvyOVNIx5c385vHrb8581Prdn07/9vfl4/X0ZklSNOJOD4r9io/Pb9+VWqR9v3It+vdaZ8jVDoOJhZvX5/Dp/NX7m+nRFkNbFoU2DkWbKfmZp/zB6g9Cp4dRn1xfwskfhyevj38AMvogH18cxuZaHKzC5O30Z7geH7+/mcKn80PIO+myA/Cf0msUtnabTXo2gGAE6FoByAzw6uJqMj4K1jjvJ6GX9fJ9ckLyJhEktp1Xv5GuexmJZyu+tmDRzyXShioR70FE6PTAelQn8nWBrRDY1pkXYrOO/m7602YeS6tj7yvxD/FJnI8vCDvyfVvw9ADJ8rFOoX6/n6kp/XVLlh8rtnVfGusAM/SqbRN1A/QL0rKmplzXbtcI7MeTdpvYVWTT1+RTpywiXFZC2wLTxstCrSerVrm+8njbEfZ2K9jn4Qm722w2m3YTfsuq5OIlagpjXYdaqfNuc1d3LZVKG5qEtuPMvtza1evSjylwzy2K1hxUt9V1h+s7vdCe1UMbCI227gl888rnuEuswky7BRpPqCHhkemm+2py2j9+7B/qeuO7dzI0S+qJH2RRYDe+hpuomqNe5rE7TDW86iEKxmEs8hPWybDD7IS4Oe14Num52nMsp/TyXoZ8yWVGw2iXw+kmYgturwwupS7tIRlaCXJZtJQbvFU4LUj88WBDfKTNSYePnw4Dq4/4eFAh2MNG4aN7loXPfD4eul7rHz07EzZNZwsrcjMUYMs0RWtnZZZRuC+QC78heCKKb4Yn3zWwtoMUjdHmXAvfBtDncUu8u74CfR9vTu/zhxqPN0Pynh3ye/Jukwn/yqmDK0pCudqIEH67CP6qeOkW2sjffEHuQvPDd87y/1vQTKiCKxooQxbxbHoY0WCAaWmkW/vtwlkhf0H6eEeLEcfntIdi1SILwiYLXtX17ohFbGJtSeOPz+gLTSuwud8ZUX1jIzZYng7CTmwgAp3jlacz0AUqKQZWfFm5QVPWj5tQGLjWbiyosW8xNsZcV1qyiJUmYyO2cK6wo8FAYK6PeSFjOTdcuVhqRpuo/tpEizL1wfcMmZcoXDuqFPPnjtvwc1+QuwZ+35MH59kaoanz4UG1MAv2a5Z0Z1UAhGLZ9wKafB9wDRQmhG/Km11OWFFUhS3p0EkgsIG8tA7u/ep5Jh9RwEq6BSRBRkjgldIulE1nuMw8BtQnHUWA8TzukR1BdfDHtS4NwXH8gOufkpiRK0o109uA5akPWMy5JCCrHuQvDXi1/vJd86iLettgPVjqQ1AYvZQCfQOsKcYcgqT/1LJ1Sn9we99VfEIjZ9KvVJscboFigdNm6VXVWh35WXT/wSuDtmZRx9TVEUnkdKozW7UqZEJUdMaCNnOuKjB9pZYUfhEsdCbC4LskDmuoYq3VLlsorTeP40pwI+yx11dy5WCW6ZUNpq2Q9tKGIQ78FBf15qHArTOIjatBbKdF9wUykykqi81mjZ0VPF0gnMbDHdOtVquY+59jbeaD6qwdXEzO3368fnt8GrYa1cDVMieBtZ1athFRr2XY6fD0Tfw6NNaFti7nqiUPLe33L4KgnYhEN1XX5eX/FzX/5Rc1VTp1+OgGRcalX+F4v3uqqtUtW57Scs/XKzJ1p2KFux4lqdPwVYu1dy+tukW8aoe5i9hCW0fEn55orPjVZJsNPQ5XH76eSUvx3VxfPOtj/95LoL0IPVAxau6C/HE2YqEKHiz4997ofEOU7f1RI8kdfTE+r/rmZdvleHDDobM0xaJ9aqcX3LR7mHdvp7QbLckr2oX4wRfi6kPrQoardYt2vyYHEegvgbb3yI+UuX7B9U/16+GXZw/UfUB4mwCiOfyfKQCdew==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List credential definition templates</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/templates"}></MethodEndpoint>



Lists the pre-defined credential schema templates that you can use to create a credential definition. The platform returns only the latest version of each schema. A claim path pointer schema has one entry for each credential format, so the same `name` and `version` can appear more than once. When the platform cannot read the schema repository, it returns an empty `templates` array and no `pagination` object.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential definition templates listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"templates"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"description":"Credential schema templates for the current page.","items":{"allOf":[{"type":"object","description":"Pre-defined credential schema that you can use as a template for a new credential definition. The platform reads the templates from the public credential schema repository. A claim path pointer schema has one entry for each credential format, so the same `name` and `version` can appear more than once in the list.\n","properties":{"name":{"type":"string","description":"Schema identifier. This value is the folder name of the schema in the credential schema repository.","example":"LegalPersonIdentificationData"},"type":{"type":"string","description":"Dialect of the schema document, and the field that tells you how to use it. `claimPathPointer` is a claim path pointer document, which is the dialect of OpenID4VCI 1.0. `jsonSchema` is a JSON Schema document that earlier versions of this API used; do not use it for a new credential definition.\n","enum":["jsonSchema","claimPathPointer"]},"version":{"type":"string","description":"Semantic version of the schema. The platform returns only the latest version of each schema.","example":"1.0.0"},"schema":{"type":"object","additionalProperties":true,"description":"The schema document. For a `claimPathPointer` template, copy this object into `credentialDefinitions[].claims` when the credential format is `dc+sd-jwt` or `mso_mdoc`, and into `credentialDefinitions[].credentialDefinition` when the credential format is `jwt_vc_json`.\n"},"metadata":{"type":"object","properties":{"id":{"type":"string","description":"Schema identifier","example":"WgWxqztrNooG92RXvxSTWv"},"credentialType":{"type":"string","description":"Schema name","example":"LegalPersonIdentificationData"},"isJwt":{"type":"boolean","description":"Is W3C VC(JWT) format supported","example":true},"isMsoMdoc":{"type":"boolean","description":"Is ISO 18013-5 mdoc/mDL format supported","example":true},"isSdJwt":{"type":"boolean","description":"Is IETF SD-JWT VC format supported","example":true},"title":{"type":"string","description":"Title of schema","example":"Legal Person Identification Data (LPID)"},"isClaimPathPointer":{"type":"boolean","description":"When `true`, `schema` is a claim path pointer document. The platform always sets this field.","example":true},"doctype":{"type":"string","description":"Document type identifier to use when the credential format is `mso_mdoc`.","example":"org.iso.18013.5.1.mDL"},"namespace":{"type":"string","description":"mDoc namespace of the schema. For OpenID4VCI 1.0, it is the first element of each claim path.","example":"org.iso.18013.5.1"},"versionSupported":{"type":"array","items":{"type":"string"},"description":"Versions of the OID4VCI specification that this schema supports.","example":["version_01"]}}}},"required":["name","type","version","schema","metadata"]}]},"type":"array"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Offset based pagination for the template list. This operation does not use the page based pagination of the other list operations.

</div><SchemaItem collapsible={false} name={"offset"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of templates that the server skipped.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Maximum number of templates per page. Defaults to 10.","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of templates available.","example":12}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether a previous page exists.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether a next page exists.","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"templates\": [\n    {\n      \"name\": \"LegalPersonIdentificationData\",\n      \"type\": \"jsonSchema\",\n      \"version\": \"1.0.0\",\n      \"schema\": {},\n      \"metadata\": {\n        \"id\": \"WgWxqztrNooG92RXvxSTWv\",\n        \"credentialType\": \"LegalPersonIdentificationData\",\n        \"isJwt\": true,\n        \"isMsoMdoc\": true,\n        \"isSdJwt\": true,\n        \"title\": \"Legal Person Identification Data (LPID)\",\n        \"isClaimPathPointer\": true,\n        \"doctype\": \"org.iso.18013.5.1.mDL\",\n        \"namespace\": \"org.iso.18013.5.1\",\n        \"versionSupported\": [\n          \"version_01\"\n        ]\n      }\n    }\n  ],\n  \"pagination\": {\n    \"offset\": 0,\n    \"limit\": 10,\n    \"totalItems\": 12,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List credential definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-credential-definition

---
id: config-list-digital-wallet-open-id-credential-definition
title: "List credential definition"
description: "Lists all credential definitions configured for OID4VCI credential issuance, with the newest change first. Each entry also holds the issuance counts of the credential definition, and the response holds the aggregate issuance counts of the organisation. `search` matches the label and the credential definition ID. `sortOrder` sorts on the last modification time. `vct`, `doctype` and `type` match the value at the top level of a record and in its credential configurations."
sidebar_label: "List credential definition"
hide_title: true
hide_table_of_contents: true
api: eJztPWtv3Layf4XQPUBtXHn9SNKeLIriunbSbpM2Rpw0uMg1LK7E3WWsJRWS8nob+L9fzJCSSEn7sJMmwWnOh9N4RQ6Hw+G8SX6IMqZTxQvDpYiG0XOujSY0z0mqWMaE4TQnGZtwwaGFJqkUEz4tFcvIRCryYnT68M+Tkd+aa11SkbKYLLiZETNjRLAF04akMyqmjEy40mZAntB0RpgwakloriWZyTzT2LyCQFJZCqOJnODPvRjFhIoMPyumCyk08wDR6VSxKTUrQUo1pYJrCpAGJNGMqnSWkDk16YxZGDkds7wepBcHMjqFzlKZFypjKiHwT02kcAC0IXOZ8QlPcSBi+JwNSHKdmiQmSSZTsyxYgmMk9p+IAPa+pnnJCDX4h5EFydk1ywF/ShRLpcqwHxeEG+2jVy0UDqkH/yeiOJIFs3+PsmgY2Raw4qd8yg3N39A8Z+ZFwcQoO6khndbzjOKooIrOmWFKR8O3H1rM80c5HzMFuFnMNDGS6CteIKsUdMqFo/QxEbAu/BqWgJRCMZrRcV5Nd0LzXJMxTa8AQnKQDKI44jDE+5KpZRRHgs5ZNIzkZKKZieJIsfclVyyLhhOaaxZHOp2xOY2GHyKgaDSMuDBsylQURxmb0DI30fAgjuZc8Hk5j4YHt7fxhwpszufctIcM5/o7vYGORPTNWTFTKkEKhrNmg/sieGixCkd+ynPDFBkvyejJq6fk/HTvtzevyJ8n5JopPuFIRo8PADrh+NeEM7WKktcpTLiDlDaKi2m0Ho3zF+Tw3weHD/YekfmpTPfnp89JJtNyzoTZdny3C+6Lw5sHJ+TPZv4nrfnvAIkmUs2p2V2Fwd2HP0dxQQxTc1j1icVGMV3mRpPxcsVAVspsxRNrxpbKEAniBjeXFYDAdSyrOXGH6pSJjIsp7DLob/9aSYJahN0FuThiAnbQW8QwiiOq0+jC42L7e88c3syYIIlRJUtinIFm6popkkmmiZCGpDRPyxzkd49aGJDXGj5wTSRCREJQMqHaLQOqgwF51UA2MKKlkyZ/MSVBcCZGGpqfANAXk4ZzfuXaSLVMKvnKQF8lFRI/K0avMrkQCZlwlmcrSXrFCwStt6LpWMqcUeELAWx6e3sB3e2UNHQ4OjiA/6RSGCYM/JMWRe5UzP47DRT+4A1QKJD+htveaZ94H7YX6KTfBqgYLi2Vgi0OMi5Gpccy2IzrtN6rWqdxTRJR5nkCzEkFYfPCLAlVii7JAtYJwABop9CFdIyNpDZsjhOhef5igrrIUVCO3zGUZVtMpdagmsBaN9jDKjNlsW2ULi60RnQcuxrDxbS2JhYzmTMH09olSR+ddeJmJAVzBhBQFPlrlQInZuZsAIsaKcpxzjUYKdxSqrLEvImObNPfmaEZNdTaACEf8KxvQ4ekG9XCe60lBtTi2hLJs8E0nddWjO4nyChDBc9u6LzIAZHHk8P0iD54uPdo/H2295D9MNn7N318sHc4PkofZA/Zo8n3B9Ft3MvFoy1m9Frw96WvlQjVmk9Bdhq5xs4rCyngk7NiavkzOrVaf8IUAwG1GgIXBO2rU1zyXo2lcd1Q0O24Rd0lteWm70cpiUbdC8/c3YZO3ZV3yC/QUiQZK3K5tGoe+LNada5XsIhbNGpYdmy88a0V1bdONyg3tKHzguxwQTRLpcj0LuEiQ8kippW0WDUqWVBN3KgB9Q5/eHRg/3cbR2WRfQG0PDHZj9z3iBw6IZvX69dyTsVebUxb18U2GQNGKD9AX2QsI6VmdlVXIrjDBtMB+Q7FCDmTyiDU08qyOz78bjfkxtUtV+1W7U0KRf86wR26NOuRt7K7IyyZ53RqQolm4NEYtlrwbi9ee3WbtUmcnvE2iZDhOIFSW6/KXoi16GqeMUJXesvrVN1nJde9dFFXcvdwQUhYf2ZTJkCOOtce18qKcW4qzD0Npd9eDHjmDLxKAiIkfzQw6pg2cWUntoB4vN4GR0GjZC1yBtYJQh6Em+fEn939pPjK1aO6XvzsrpzvdEKpmVMBdiugYsR5rF8nkpWqllGVApzkcoHT/4wCsLUtb0HAFdyRW5zSpd6sIZpISEaXmpTC8LzhnswfDoEzjQPpsiikMi/ZtbRG8wrPYK0T5VjdwdJE1dAAH4+7yUTJuZt+Z85Nr9+Zmckt2My2A6ra0GCwRSpgECcz1JT6MufaJBW3MBvLeCWvmCDn2IBAYIrogqW1CxF2vjw6ODr0IEAIwO8Kn7v9F1zrSwPjXPqwrn1I59CIFEpOeI4s0sFr4Hm9HhgIH7QQhJ9Wjhld3FY9AOqJWhZGThUtZjx9xpZPMWCxmfK2XbW5wZAFXr9iyyFJMp4Nr9gSnazk5tHB48TH3X2N4gg+bUCnkSObUXrGlr6Q3kmueJbs9qA4IP8rS5JSgf6+DRB7cc8JuPJLaIH22xrvAzeqmEiVskZSWXUhmNZ33Ultb6wUGcYP2psFVH1plRKE+0C5Q5Cr2cwNMi9ZJdfuioyFqoFMtTBVNTSgqpUiGayyYFTt4d9Lf7e3tMjPHENBdtNuY4V5vADrRsYWAJlbCJ/EQSVJKjW7RH61CoRnRIp8WYcckrmWl/NMpokL5/XZTd3AVM3m7xZXURxVo0QXt7dxREszk4r/hev50pL3FULaqG7kwjr+VvW5pdEkgOgrtooGoYIjSdDhMmOG8lw7ifTy6Ql5/ODx9+QlT2fkOADtsNUg2VJZsMsx1SxzHV9AW3I0OCD4zW4p7W//3mExBlrDsjIB/t5Mjt4B72agaWac9WCtJPShklUrhFwSzBy5POO6yOlysyV9ahuSxg5tYlsetlShMeRW+fVId21XG+3bRKBqPGjdN1JrELB7ZErzLSD/fHL28AeSUzEtIWJm6LSGn3UmGVCc5gswUZDwCRN7v/ycOFN2KqRimlCxJBYNu8dBGmsmQm81wp5IfB+vO9pr3sceU7UoVSE1Q7pAbmiqZCmyE5nLLRTSr+yGpNCUpDLrJT4ucwPXeb/Jfz3F/yW7OK5hN+YjRmQ3pkoLtkeuhrMBCTdcLqdyMxs/l1NJ+BwWvsfApzZiGvJrqfgWztbL5xXAvB4C8aK5ecVutjBNjiElImymD2dfET4AeBus6Ah+3Tzrn5ul+nvnPm4NhAjfBtr0pYvMj4Rh6prmmz2E323ikRQyz0E7cNczjCZV1HJSAaVhqdva5BQCj6D9PdX6RGSF5KLtPG5rUnqQJp512XEVSPJuYS6v00tIOKA4xkzcCWbcdgckydL/1tneu4XBj2HGcuCrc/jak0j01ZU3FCBcQY7iqAKD2grNBkTvjJrZ5rn+dv7iD2gJRpRiWtfhds1ylhrtEhHK9MkkuswlzTrWj8MBxOeUcqHtxzSnfK7bgaJ/Da6tORMS02UQ/uU+eYTE32vKWbkU2iuVEbfCMmqL6aidL7Xt9Baquc1aViX780AgujI/CC0KRlUdKLH1Dt0ISxYyEqAMKeqNi9mfBH7VSkLfd17eIjh5XSoxZOWAlUoWdMDSASszPix4Njx0MrzKbG+2DlalzO+LbbO5HLJSTQdcywFussGjweEgL8AvG6wKz76+o6hkNyjuc8fpxKYfO7sDYwRGknHJXSrNte8XMha7r8A3biPx9XvEXtiQGjaVatmbNK1xNtygOXfS6TfKOlNCtrSRzFDr2h5kBxU9xGK6X8HWrpNau0PLPaPT4/OmewduS/MIKVhCdiCSDsodozyMqDJnuzFJgLHJTsGUBifdEd7FwcDZhDaMUgQg9t6XNMccDKHGQF4H0YpJ8t626f+OjFOU4z3byPtUCbHxEtrYJAB6xCkodyMVGctsuevzG0wHbBUOhGaURnH03v7HjQBFFZ7BTWl0e9G3JH1L0bux7rBANbnrzHwIaUZtSsONN4SVCxpgrHHMJlJ1WNYbEMDYgWwIxe6KZ2x5MmPp1fp8f8W6561OvSSCLz17bz3PxWROs6YYj89rm5MKvQBBPTIkldcQqjELiayoLWv7HOr6wHAT7syLlWvG2ihUlYgVtoJAudWO0zJ9Mn5++jzZRdJioPX8xf7oyUltaNVaB+gGcRsb9nRlM/SadWjiJ8SrkClm+ZGqUAhS1WOWuQFF5P2FmoBauFN+jXU+CzuWa5FA9c+ekGZvwk3S1AJpqMOo4iZdo9723iyGvZEq+gLWQ5LAWth6TG98EBI3UJlilQT8jO0h1OC6rFxgn6/qhUaeGLRG6YKopz3hQC/oFdsqESsAyJiltNSs0zGdUS58FrMaJHOKw7hFHZBzNG4JFdLMmIKmMUyxCi/SAGpdyZuAhczMKEtq8tXSfmLreOanz20iwjYlCZgge1U94B7WWagEJIqj7PrZx2Rcmno2wMVQK4Q9UYRBjFQblkHE+kn1c+JRoAueY0ySEtcTJeBuzbfImzUGik1KzA8OwtUfhpPnldxqKoXbUWKAVpFHSyxnKnNGsGorDMsBswDjeiyCsRaYHFSWNWiEKgH73cbRnGlNp2xzVBfLm9iNV2JtdzAUJtUlSYhlbcHBIoTLU/PGhN9YjVJTBbtiuXdsS+/gK4grVNIDclxVfaEOQjcHt9SAPIV/O/6ILQiS2OUdYmubn/wR/vkTpC1/hAo/nrKfEm8ot9metrdu3NSbAYDYVaBxYX1ddAAhWFEru5r1yNnoNOCl/uWuKWSzxdhtbaS6m+EHBFz20a3vW4xWNzWEbyuh5634xQqTwNd3G0RV5bAmXdsRudvKoYqTffd2S9USr9OgLfGvZ3KhQ+4TkuRSTKHwlRsdSkUr5CgcOOhKxUFTWBVoFZetmU4ZsFXX8u1bLyjuACczGkKKpk1ya3y2XbOGirW0sIISTwKQKsNRnwfgFb/tOC+zdizj9X4nKK32p0HBs8FhstsYEB31hFiDYjChbMMNXtcqDKrKFhCheU6s+kipDmUYmrHQ0JdQ8HeTGTtuzOUzJeXkI5LdNE1ZYVA1JJ4VngDLyQnZQb72DHc/Qffbwnyy4THyUY0qJ6SQWruI0o4tncOA3eHgADSplJNLGFFfOlRY5YtfsaVHHf2y3vMba4PwZ5f2XtZb2nNMnPyAfantCQVE1oZ9KjSq4qBOrq5reHmwN6P3bB0yVbDzO6/Fdx563bGv2PISqpnCeHG/rjvGNWIZEsR1Al+sVBzUABT4ahsniX1B9vARGVPN092tEo1cy0vsdImdoEv9CxMzkD3ZXvfTXGZYlhT8OOPTWajf29BBHZSaqUvIj8EydYpGNpACOpOwc5skX+W0YeIQ+P1E/PZuYT4vn32VRP3H8hKmcjD+uJmhTrw4pe+1Y2ElAiEFpBIw98LU/SPoXqQZrFcv2t9mzg7q/QuFVaMdBL2TB/htZRXH2vrUEKEizLqsKCjpotLJuViUeCdf6pIu1RHSHPezNZcsO1UWqkXQ+rZo3+MJu+qrPWrCRcZuYuvd1xW77JqpZQ3ZhlmwuXMm6uWInecD/omHiPVzZIqZfl1QG7Go6dersy2W98Ep9BIimmWQxsI6lxJqdzF2PacioyY0Z+9s59haAS7SvMyYt0g2WQ2nJk+5TnOpS3XnIicAZgudsM4ps4CYxwmWN/g1y2HOkIbOMoxD0fzM40CA107QhqecvpI9HmbJkJkRsDYUCjfR7va6npeI7z9QBIxZLhcuUWqp3dlxK+j0mbZcZ3AYukkOfY79t3E74I6A2PRWlTl/2oatcz8rDy31nVkKam/7coCNCdauh3NoXh4c4k4JXSc4Pu4fqGiSYVntqzKqckizXfvT4Jocn41QuuAZvir26c4BdHexd/y+OvVlgxbgQwvgDhde1RAgDOqhmhl8y15+bD3vm9fHH7FpnM2vfQVjpI1OCwh02zLTN67wTnBDPN+b7Lx5fby7uYbTCyhgERBFReWqNe2Ju6ok5yPm0hTVOnPGjVNVnNqBCHMjuf219jieXmrD5r9TQadBgGFr1IqcGoibkjnCWHv+r4c58GR6ziCUSiwuDlC2jjFuDBMaaQqC6M54YwrBgcCoB4TgO8xIDd2Ggh9TbtpvZNzrDI5lYE1cVqipuDGSZIoutiuO+zSFrBC2FWE5qz16ZlXCnSYWiNXnbEpzcmaz+pUAcxrmlBr6rWb2K6uZ9efrfv7cdbQBCvbne9XWWqbuH7bfevCvF7IVr+gOADdk0uYfQPYsCSWvX476WKy6qwKhIYauLLBUHE0jm8VqqjJ60/T1kVPA4esuBm6JMfClq5YQZdeaj3nOjXMA/WQYzKJB5uLvLCnevNhYBeKAfOE175Yv/x0F0d216GQrUbXU4jmE35VOvoxwm7W7ohef7XSmJ0QeHHzRo5or7ZCv48hmfOdDmvF9jmV+yhOYf+OxQcdR3ulB/zKQb0cHv+jRwd4LG2qx6kIMjRwNsP4E5w4/xamM4Aoby1vWuHYkG5DzOqdru+hh68zGjiu0hzr7OCxxD49rwFevpLzvtMbut+MaX/C4RosF/J3TOgf/CU5k+IaLnPOeqLe3iVCGV+G2tM3Fn/h0h9Vn2yXXBmRkg6nN1R1YjGPjzuH0W4eXAr9iTTnOJzkDsnlODYPVfnE3pOHm2Htjo5MoG4+KBB5sf5kRTLnOfG2e9B9VU3/CsIt68fQVU7g1rV3ssnutcpsV1+H4ZbRhwq5K44WZBtCXTaoEchdf3dmZ6pK8b1ntrzml9S2r/S2r/S2r/S2r/S2r/ZFZ7TDGhIfnVlwLuuIWTP9GSv8ayOrSsSbB0xNr6vHiVlsDHV+nycfHER5GORbpDONdV/YUYJP/7Is49YR81gcz1kcWtk9g+tZdO4PYk5y7gKuf12+ttVcwe7zlX5LeH9ILgncux1hdiF1VCWyMpnnb4OHRLZQUtm593ixvR60XBzYkEv1bqtsXVNsN60lem04yJGlul07wpvw6vZnZNxWwNTd1yjW4T9tdo92/FlvQ/BW08y7AX0f5TWnUNsGpKyu909LXN/BXst4p3gqYO/oAJxAVc6e7ruVV6+JVDO9yOJIwVWEE8I4YwCDa8BzdrsKBC4b6wUVtr+450cUMTIkg3Ng/JYwgCH7PYWDxFjPuXqRwUtvCC6p3gjGPUDpf1MEOpy5v4Q2J6iGIvl1UHeM9a1p1DAN77/hZmNNZNZ8T75ZyUmcEmnt2AUPg5FHLCNiW7VEZE3pNuT0R5NPgUQX8rHUeb1vgBVZU4N1WkHmsHqYIVtb+eJeFtShXz1ME1ADmn1F9ptg1l+U28e+RvfEYorVoWyr2HfgshYPQGcLeZ4+j/BGmDe84goDEYBu6swsake10CCQdtvCEj1e+GFNfxYOXvIcPx1jbDbKbuj5e1XB5lfdrqqH0ZxW+4bXSRwdfVrz+++FnE69Hh59Jvj7+AvL1e2v8huyMP62MFftvOLgztLrEpPqkzHOwb2eMZvi2zwcA9PCOT0z4hjhTSqoTmeHmhH+felhdtPFu74Kmdx89G1MBL0fvgO/LyNQhy58phHqLEkSHe8uous+re242yOljuu5KYBFIcC2XO9xtb8O3rNEm5OE/mJCvRXV/I7oHIWke/aN5DD0tiPk6yx+HadEI8sHuHBXee3Jc8GdsicfBYY50Ck9xRe4Jr6qMtTltuhvF9l5+BSSZu8qAaIrPZtmIRrR/fbRvD7DvZxbOnmXtffCYebavs3cLs98Iwj1PlIAHiNj3PQl2yubSTQ6ca5VHw2hmTKGH+/sZm8s9WvABnyoqzIDLqPtG0JmSWZkae5qsF8wmCOcGNPF0VXdtP7cRuWiofg7MZ3mmon0TA7I/uLd/7LI1j/8El7V2bY2zkT2dGxya83MaLliXBHASYoch81IbMsZ7Nib8pip+TyyOBC82cp6eUZTjLYPosu/GxOZ4ArBD4jr+uJSlAnLsXbHlT4kNwsDVCNU+pTZTx+aUAyFd0OB/GuLV8+e/ND+FVPcXrEWWuhMo9WsOESG4TAi2Fphl8F8IXNVlMtscT+h9UwXMlf6OZ7Y23BWAV1vpbBcwMjKVNvPkjhMwjHJopyv+co9TGGkVua3AsC45PtC2JG6LBfU99lJHbSCcpjK9h/PlFEq4c7gBAZfWURqx9XOxcSs1aUfbkDyrygFAW+U8ZUKzpv43Oi5oOmNwl29n6RaLxYDi54FU033XV+8/H508+eP8yR70uW38uGY5gVjVNTDVjqjPo0RHB0cPBw9s7rCQ2syp8PB53rqkqpE/7W3l6ZJvr1n+R79m6UQwlAnuFznlAlgHebUK1b+Nro8wYQSdMZDrKzcXEMZIKyq4IHQbqLiLOJpJbQDihw/gjb9W+e0t/Gyfe0PFx7U7i+Aed1vJln/vO5m9ZIGiI++5TOweDSOrLrdG/K6PXq5BpYpk3BOTj38Ecw1u9i3Mj8fsru9irkGpeR7zo9G641OZa5D6OIy2eD1zzdj1I5r3Hf1j389ch5v3jOY90ftPexpzHbX8FzIbcl3AH4rbS5beQhzZWdcga21Pe/eE16vjOt76Ls8vT15F9rWH0IC3FZruH97NklQsPdhtW96iAP/vZbfCLj+CxfOMLX+qm9svKzvU/oNtDVS6uL29/X/P1aQ8
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List credential definition</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definitions"}></MethodEndpoint>



Lists all credential definitions configured for OID4VCI credential issuance, with the newest change first. Each entry also holds the issuance counts of the credential definition, and the response holds the aggregate issuance counts of the organisation. `search` matches the label and the credential definition ID. `sortOrder` sorts on the last modification time. `vct`, `doctype` and `type` match the value at the top level of a record and in its credential configurations.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by IETF SD-JWT VC verifiable credential type identifier.","in":"query","name":"vct","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by ISO 18013-5 mDoc/mDL document type identifier.","in":"query","name":"doctype","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by W3C Verifiable Credential type (JWT format).","in":"query","name":"type","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Search term to filter results by","in":"query","name":"search","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Sort order for the returned records (ascending or descending).","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"When `true`, the server does not calculate the issuance counts. Use this option for a faster response. The server then returns zero in `totalCountOfCredentialHistory` and in each `issuanceBreakdown` field.","in":"query","name":"skipCounts","required":false,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential definitions listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"credentialDefinition"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"description":"Credential definitions for the current page, sorted by the last modification time. The value is `null` or an empty array when the page holds no record.","items":{"allOf":[{"type":"object","description":"Credential definition record as stored by the issuer. The top level fields hold the settings of the whole record, and `credentialDefinitions` holds one entry for each credential configuration that the issuer publishes in the OID4VCI Credential Issuer Metadata.\n","properties":{"id":{"type":"string","description":"Identifier of the credential definition. This field holds the same value as `credentialDefinitionId`.","example":"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60"},"credentialDefinitionId":{"type":"string","description":"Unique identifier assigned to the credential definition upon creation. Use this ID to reference the credential definition in OpenID for Verifiable Credentials Issuance (OID4VCI) operations.","example":"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60"},"openIdOrganisationId":{"type":"string","description":"Identifier of the OpenID wallet deployment that holds this credential definition."},"createdAt":{"type":"number","description":"Unix timestamp (in seconds) indicating when this credential definition was created.","example":1750000000},"updatedAt":{"type":"number","description":"Unix timestamp (in seconds) indicating when this credential definition was last modified.","example":1750000600},"label":{"type":"string","description":"Human-readable label describing the intended use of this credential definition (e.g. 'Issue Portable Document A1').","example":"Issue Portable Document A1"},"credentialDefinitions":{"type":"array","description":"Credential configurations of this credential definition. The issuer publishes each entry as a separate credential configuration in the OID4VCI Credential Issuer Metadata. The value is `null` for a record that holds no configuration.","items":{"type":"object","description":"One credential configuration inside a credential definition, as stored by the issuer. The issuer publishes each entry as a separate credential configuration in the OID4VCI Credential Issuer Metadata.","properties":{"id":{"type":"string","description":"Unique identifier of this credential configuration. The issuer generates the value. Use it in the `credentials[].id` field of the issue credential request, and in the `credentialDefinitions[].id` field of an update credential definition request."},"credentialConfigurationId":{"type":"string","description":"Identifier of the credential configuration as published in the OID4VCI Credential Issuer Metadata. The wallet uses this value to request this credential configuration during the issuance flow."},"label":{"type":"string","description":"Human-readable label describing the intended use of this credential configuration."},"expirationInDays":{"type":"number","description":"Number of days until the issued credential expires."},"supportRevocation":{"type":"boolean","description":"When `true`, the issuer supports revocation of credentials from this configuration."},"revocationMethod":{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List specification. `status_list_2021` uses the W3C Status List 2021 specification. `swiss_token_status_list_v1` uses the Swiss profile of Token Status List.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]},"statusListCryptographicKeyFormat":{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]},"statusListCryptographicKeyIdentifier":{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."},"enforceCredentialUniqueness":{"type":"boolean","description":"When `true`, each credential under this configuration is unique per holder."},"supportCredentialReissuance":{"type":"boolean","description":"When `true`, holders can request reissuance of expired or near-expiry credentials."},"credentialBindingMethods":{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. `cose_key` is valid only for the `mso_mdoc` format.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}},"authorizationRequestType":{"type":"string","description":"How the wallet requests authorization during the OID4VCI issuance flow. `authorization_details` uses RFC 9396 Rich Authorization Requests. `scope_based` uses OAuth 2.0 scope values.","enum":["authorization_details","scope_based"]},"scope":{"type":"string","description":"OAuth 2.0 scope value of this credential configuration. The issuer sets this field when `authorizationRequestType` is `scope_based`."},"display":{"type":"object","description":"Display properties for the credential card in wallet UIs.","properties":{"name":{"type":"string","description":"Display name for the credential in wallet UIs."},"locale":{"type":"string","description":"BCP47 language tag for the display properties. The issuer always sets `en-GB`, and ignores any locale that you send.","example":"en-GB"},"description":{"type":"string","description":"Human-readable description of the credential purpose."},"backgroundColor":{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`)."},"textColor":{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`)."},"logo":{"type":"object","description":"Logo image of the credential card.","properties":{"uri":{"type":"string","description":"URL of the logo image."},"altText":{"type":"string","description":"Alternative text for the logo image."}}},"backgroundImage":{"type":"object","description":"Background image of the credential card.","properties":{"uri":{"type":"string","description":"URL of the background image."}}}}},"credentialResponseInterval":{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint."},"credentialFormat":{"type":"string","description":"Credential format of this configuration. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL.","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]},"validationPath":{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. The value is `$.vc` for `jwt_vc_json`, and `$` for `dc+sd-jwt` and `mso_mdoc`."},"type":{"type":"array","items":{"type":"string"},"description":"Credential type strings. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. These values appear in the `type` field of the issued W3C VC (JWT)."},"vct":{"type":"string","description":"Verifiable Credential Type identifier. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` (e.g. `urn:eu.europa.ec.eudi:pid:1`)."},"doctype":{"type":"string","description":"Document type identifier. The issuer sets this field when `credentialFormat` is `mso_mdoc` (e.g. `org.iso.18013.5.1.lpid`)."},"credentialDefinitionUri":{"type":"string","description":"URL of the external claims schema that the issuer used to build the claims of this configuration."},"cryptographicKeyFormat":{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]},"cryptographicKeyIdentifier":{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."},"credentialCategory":{"allOf":[{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}],"description":"The credential category of this configuration (the list credential categories operation). `none` when the configuration has no category: a configuration from before the credential categories has `none`."},"signingKeyCheck":{"allOf":[{"type":"object","title":"SigningKeyCheck","description":"The check of the signing key of a credential configuration, made at the time of the answer. It covers two rules: the certificate of the key fits the credential category of the configuration, and the key of an mDL (doctype `org.iso.18013.5.1.mDL`) has the ISO/IEC 18013-5 Document Signer profile. The save of a credential definition uses the same check, so the result is the result that a save gives now. The result `does-not-fit` does not stop issuance.","properties":{"result":{"type":"string","description":"The result of the check: `fits`, `does-not-fit`, `exempt` or `not-checked`. `fits`: the certificate of the signing key fits the rules. `does-not-fit`: the certificate does not fit a rule, for example because the certificate chain of the key changed after the save. Select another key, or request a certificate with the `presetId` of the category (for an mDL, the preset `mdoc-document-signer`). `exempt`: the certificate does not fit, but the key has an exemption (`trustedListExemption` of the key: the certificate is in a trusted list), so the save does not refuse it. `not-checked`: the category is `none` and the configuration is not an mDL, so no rule applies.","enum":["fits","does-not-fit","exempt","not-checked"],"example":"fits"},"messages":{"type":"array","description":"The texts of the check, one for each rule that the key does not fit, with the fix (the category rule first, then the mDL rule). An empty list for `fits`. For `exempt`, first `Exempt: listed in <list> as <service>`, then the rules. For `not-checked`, an empty list, or an information text when the key has a PID certificate and the configuration does not issue a PID.","items":{"type":"string","description":"One text."},"example":[]}},"required":["result","messages"]}],"description":"The check of the certificate of the signing key against `credentialCategory` and, for an mDL, against the ISO/IEC 18013-5 Document Signer profile, at the time of the answer. `does-not-fit` shows that the key no longer fits, for example after a new certificate chain. Issuance does not stop."},"suggestedCredentialCategory":{"type":"string","nullable":true,"description":"`pid` when `credentialCategory` is `none`, the `vct` or the `doctype` is a PID (`urn:eudi:pid:1`, `urn:eu.europa.ec.eudi:pid:1`, `eu.europa.ec.eudi.pid.1`), and the signing key fits `pid`. Set the category with an update. `null` in all other cases.","enum":["pid",null],"example":null},"supportAttestationProof":{"type":"boolean","description":"When `true`, the issuer accepts an `attestation` proof (key attestation)."},"supportJwtProof":{"type":"boolean","description":"When `true`, the issuer accepts a `jwt` proof of possession (OpenID4VCI 1.0 `proof_types_supported`)."},"keyAttestationsRequired":{"type":"object","description":"Object specifying key attestation requirements per proof type supported by the Credential Issuer.","properties":{"attestation":{"type":"object","description":"Key attestation requirements for the 'attestation' proof type.","properties":{"key_storage":{"type":"array","description":"Accepted key storage security levels (e.g., ISO/IEC 18045 basic).","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}},"user_authentication":{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}},"jwt":{"type":"object","description":"Key attestation requirements for the 'jwt' proof type.","properties":{"key_storage":{"type":"array","description":"Accepted key storage security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}},"user_authentication":{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}}}},"claims":{"type":"object","description":"Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.","properties":{"claims":{"type":"array","description":"One claim path pointer for each claim that the issuer publishes.","items":{"type":"object","properties":{"path":{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. For `mso_mdoc`, the first element is the mDoc namespace.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]},"mandatory":{"type":"boolean","description":"When `true`, the issuer always includes the claim."},"limitDisclosure":{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}},"additionalProperties":true}}}},"credentialDefinition":{"type":"object","description":"Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. Each path starts with `credentialSubject`.","properties":{"claims":{"type":"array","description":"One claim path pointer for each claim that the issuer publishes.","items":{"type":"object","properties":{"path":{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. The first element is `credentialSubject`.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]},"mandatory":{"type":"boolean","description":"When `true`, the issuer always includes the claim."}},"additionalProperties":true}}}}}}},"version":{"type":"string","description":"Version of the OpenID for Verifiable Credential Issuance (OID4VCI) specification that the issuer uses for the issuance flow. `version_01` is OpenID4VCI 1.0. A record that you created with an earlier version of this API can hold another value. The issuer sets the value at creation time and never changes it.","example":"version_01"},"cryptographicKeyFormat":{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]},"cryptographicKeyIdentifier":{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."},"enforceWUA":{"type":"boolean","description":"When `true`, the issuer requires the holder to present a valid Wallet Unit Attestation (WUA) during the OID4VCI issuance flow."},"supportInteractiveAuthorisationEndpoint":{"type":"boolean","description":"When `true`, the issuer publishes an interactive authorisation endpoint for this credential definition."},"systemManaged":{"type":"boolean","description":"When `true`, the platform manages this credential definition. You cannot change or delete a system managed credential definition."},"extensionEnabled":{"type":"boolean","description":"When `true`, an extension supplies the credential data for this credential definition."},"display":{"type":"object","description":"Display properties of the credential, as published in the OID4VCI Credential Issuer Metadata. Wallets use these values to draw the credential card.","properties":{"name":{"type":"string","description":"Display name for the credential shown in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata.","example":"Legal Person Identification Data"},"locale":{"type":"string","description":"BCP47 language tag for the display properties. The issuer always sets `en-GB`, and ignores any locale that you send.","example":"en-GB"},"description":{"type":"string","description":"Human-readable description of the credential purpose."},"backgroundColor":{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`).","example":"#FFFFFF"},"textColor":{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`).","example":"#000000"},"logo":{"type":"object","description":"Logo image shown on the credential card. The issuer sets the organisation logo when you do not supply a URI. The issuer always returns the object, and `uri` is empty when the credential definition holds no logo.","properties":{"uri":{"type":"string","description":"URL of the logo image."},"altText":{"type":"string","description":"Alternative text for the logo image. Wallets use this text for accessibility."}},"required":["uri","altText"]},"backgroundImage":{"type":"object","description":"Background image of the credential card. The issuer sets the organisation cover image when you do not supply a URI. The issuer always returns the object, and `uri` is empty when the credential definition holds no background image.","properties":{"uri":{"type":"string","description":"URL of the background image."}},"required":["uri"]}},"required":["name","locale","description","backgroundColor","textColor","logo","backgroundImage"]},"expirationInDays":{"type":"number","description":"Number of days until the issued credential expires.","example":30},"supportRevocation":{"type":"boolean","description":"When `true`, the issuer supports revocation of credentials from this credential definition."},"revocationMethod":{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List, `status_list_2021` uses the W3C Status List 2021, `swiss_token_status_list_v1` uses the Swiss profile.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]},"enforceCredentialUniqueness":{"type":"boolean","description":"When `true`, each credential issued under this definition is unique per holder."},"supportCredentialReissuance":{"type":"boolean","description":"When `true`, holders can request reissuance of expired or near-expiry credentials."},"credentialBindingMethods":{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. `cose_key` is valid only for the `mso_mdoc` format. The value is `null` when the record holds no binding method.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}},"credentialFormat":{"type":"string","description":"Credential format identifier as defined in OID4VCI. Supported formats: `jwt_vc_json` (W3C VC JWT), `dc+sd-jwt` (IETF SD-JWT VC), `mso_mdoc` (ISO 18013-5 mDoc/mDL).","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]},"validationPath":{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. The value is `$.vc` for `jwt_vc_json`, and `$` for `dc+sd-jwt` and `mso_mdoc`."},"type":{"type":"array","items":{"type":"string"},"description":"Credential type strings as defined in the OID4VCI specification. These values appear in the `type` field of the issued W3C VC (JWT). The issuer omits this field when the record uses another credential format."},"vct":{"type":"string","description":"Verifiable Credential Type identifier used when `credentialFormat` is `dc+sd-jwt`. Included in the `vct` claim of the issued IETF SD-JWT VC.","example":"urn:eu.europa.ec.eudi:pid:1"},"doctype":{"type":"string","description":"Document type identifier used when `credentialFormat` is `mso_mdoc`. Identifies the credential in the ISO 18013-5 mDoc/mDL format (e.g. `org.iso.18013.5.1.lpid`).","example":"eu.europa.ec.eudi.pid.1"},"namespace":{"type":"string","description":"Namespace identifier for ISO 18013-5 mDoc/mDL credentials. The value is empty for an OpenID4VCI 1.0 credential definition, because the mDoc namespace is the first element of each claim path."},"credentialDefinitionUri":{"type":"string","description":"URL of the external claims schema that the issuer used to build the claims of this record."},"claims":{"type":"object","description":"Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.","properties":{"claims":{"type":"array","description":"One claim path pointer for each claim that the issuer publishes.","items":{"type":"object","properties":{"path":{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. For `mso_mdoc`, the first element is the mDoc namespace.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]},"mandatory":{"type":"boolean","description":"When `true`, the issuer always includes the claim."},"limitDisclosure":{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}},"additionalProperties":true}}}},"credentialDefinition":{"type":"object","description":"Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. Each path starts with `credentialSubject`.","properties":{"claims":{"type":"array","description":"One claim path pointer for each claim that the issuer publishes.","items":{"type":"object","properties":{"path":{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. The first element is `credentialSubject`.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]},"mandatory":{"type":"boolean","description":"When `true`, the issuer always includes the claim."}},"additionalProperties":true}}}}},"required":["id","credentialDefinitionId","openIdOrganisationId","createdAt","updatedAt","label","display","expirationInDays","credentialFormat","credentialDefinitionUri","validationPath","version","trustAnchor","kid","enforceWUA","supportRevocation","revocationMethod","enforceCredentialUniqueness","supportCredentialReissuance","supportInteractiveAuthorisationEndpoint","namespace","systemManaged","extensionEnabled"]},{"type":"object","properties":{"totalCountOfCredentialHistory":{"type":"integer","description":"Number of credential exchange records created from this credential definition.","example":42},"issuanceBreakdown":{"type":"object","description":"Issuance counts for this credential definition. The server returns zero in every field when you set `skipCounts` to `true`, and also when it cannot calculate the counts.","properties":{"total":{"type":"integer","description":"Total number of credential exchange records for this credential definition.","example":42},"accepted":{"type":"integer","description":"Number of records that the holder accepted and that are not revoked.","example":30},"inProgress":{"type":"integer","description":"Number of records that are still in progress.","example":7},"revoked":{"type":"integer","description":"Number of records whose credential is revoked.","example":3},"denied":{"type":"integer","description":"Number of records for which the issuer denied the issuance.","example":2}}}}}]},"type":"array"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuanceHistoryStats</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Aggregate issuance counts for the whole organisation. The filters and the pagination do not change these counts.

</div><SchemaItem collapsible={false} name={"total"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of credential exchange records.","example":120}}></SchemaItem><SchemaItem collapsible={false} name={"accepted"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records that the holder accepted and that are not revoked.","example":84}}></SchemaItem><SchemaItem collapsible={false} name={"inProgress"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records that are still in progress.","example":21}}></SchemaItem><SchemaItem collapsible={false} name={"revoked"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records whose credential is revoked.","example":9}}></SchemaItem><SchemaItem collapsible={false} name={"denied"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records for which the issuer denied the issuance.","example":6}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialDefinition\": [\n    {\n      \"id\": \"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60\",\n      \"credentialDefinitionId\": \"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60\",\n      \"openIdOrganisationId\": \"string\",\n      \"createdAt\": 1750000000,\n      \"updatedAt\": 1750000600,\n      \"label\": \"Issue Portable Document A1\",\n      \"credentialDefinitions\": [\n        {\n          \"id\": \"string\",\n          \"credentialConfigurationId\": \"string\",\n          \"label\": \"string\",\n          \"expirationInDays\": 0,\n          \"supportRevocation\": true,\n          \"revocationMethod\": \"status_list\",\n          \"statusListCryptographicKeyFormat\": \"did:key\",\n          \"statusListCryptographicKeyIdentifier\": \"string\",\n          \"enforceCredentialUniqueness\": true,\n          \"supportCredentialReissuance\": true,\n          \"credentialBindingMethods\": [\n            \"did:key\"\n          ],\n          \"authorizationRequestType\": \"authorization_details\",\n          \"scope\": \"string\",\n          \"display\": {\n            \"name\": \"string\",\n            \"locale\": \"en-GB\",\n            \"description\": \"string\",\n            \"backgroundColor\": \"string\",\n            \"textColor\": \"string\",\n            \"logo\": {\n              \"uri\": \"string\",\n              \"altText\": \"string\"\n            },\n            \"backgroundImage\": {\n              \"uri\": \"string\"\n            }\n          },\n          \"credentialResponseInterval\": 0,\n          \"credentialFormat\": \"jwt_vc_json\",\n          \"validationPath\": \"string\",\n          \"type\": [\n            \"string\"\n          ],\n          \"vct\": \"string\",\n          \"doctype\": \"string\",\n          \"credentialDefinitionUri\": \"string\",\n          \"cryptographicKeyFormat\": \"did:key\",\n          \"cryptographicKeyIdentifier\": \"string\",\n          \"credentialCategory\": \"eaa\",\n          \"signingKeyCheck\": {\n            \"result\": \"fits\",\n            \"messages\": []\n          },\n          \"suggestedCredentialCategory\": null,\n          \"supportAttestationProof\": true,\n          \"supportJwtProof\": true,\n          \"keyAttestationsRequired\": {\n            \"attestation\": {\n              \"key_storage\": [\n                \"iso_18045_basic\"\n              ],\n              \"user_authentication\": [\n                \"iso_18045_basic\"\n              ]\n            },\n            \"jwt\": {\n              \"key_storage\": [\n                \"iso_18045_basic\"\n              ],\n              \"user_authentication\": [\n                \"iso_18045_basic\"\n              ]\n            }\n          },\n          \"claims\": {\n            \"claims\": [\n              {\n                \"path\": [\n                  \"address\",\n                  \"country\"\n                ],\n                \"mandatory\": true,\n                \"limitDisclosure\": true\n              }\n            ]\n          },\n          \"credentialDefinition\": {\n            \"claims\": [\n              {\n                \"path\": [\n                  \"credentialSubject\",\n                  \"identifier\"\n                ],\n                \"mandatory\": true\n              }\n            ]\n          }\n        }\n      ],\n      \"version\": \"version_01\",\n      \"cryptographicKeyFormat\": \"did:key\",\n      \"cryptographicKeyIdentifier\": \"string\",\n      \"enforceWUA\": true,\n      \"supportInteractiveAuthorisationEndpoint\": true,\n      \"systemManaged\": true,\n      \"extensionEnabled\": true,\n      \"display\": {\n        \"name\": \"Legal Person Identification Data\",\n        \"locale\": \"en-GB\",\n        \"description\": \"string\",\n        \"backgroundColor\": \"#FFFFFF\",\n        \"textColor\": \"#000000\",\n        \"logo\": {\n          \"uri\": \"string\",\n          \"altText\": \"string\"\n        },\n        \"backgroundImage\": {\n          \"uri\": \"string\"\n        }\n      },\n      \"expirationInDays\": 30,\n      \"supportRevocation\": true,\n      \"revocationMethod\": \"status_list\",\n      \"enforceCredentialUniqueness\": true,\n      \"supportCredentialReissuance\": true,\n      \"credentialBindingMethods\": [\n        \"did:key\"\n      ],\n      \"credentialFormat\": \"jwt_vc_json\",\n      \"validationPath\": \"string\",\n      \"type\": [\n        \"string\"\n      ],\n      \"vct\": \"urn:eu.europa.ec.eudi:pid:1\",\n      \"doctype\": \"eu.europa.ec.eudi.pid.1\",\n      \"namespace\": \"string\",\n      \"credentialDefinitionUri\": \"string\",\n      \"claims\": {\n        \"claims\": [\n          {\n            \"path\": [\n              \"address\",\n              \"country\"\n            ],\n            \"mandatory\": true,\n            \"limitDisclosure\": true\n          }\n        ]\n      },\n      \"credentialDefinition\": {\n        \"claims\": [\n          {\n            \"path\": [\n              \"credentialSubject\",\n              \"identifier\"\n            ],\n            \"mandatory\": true\n          }\n        ]\n      },\n      \"totalCountOfCredentialHistory\": 42,\n      \"issuanceBreakdown\": {\n        \"total\": 42,\n        \"accepted\": 30,\n        \"inProgress\": 7,\n        \"revoked\": 3,\n        \"denied\": 2\n      }\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"issuanceHistoryStats\": {\n    \"total\": 120,\n    \"accepted\": 84,\n    \"inProgress\": 21,\n    \"revoked\": 9,\n    \"denied\": 6\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown or the wallet is not deployed.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List issuance history
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-credential-history

---
id: config-list-digital-wallet-open-id-credential-history
title: "List issuance history"
description: "Lists credential exchange records with pagination and optional status filtering. Each record represents a single OID4VCI credential issuance lifecycle. The issuer sorts the records by `updatedAt` and leaves out the records that you deleted. The response also holds aggregate issuance counts for the whole organisation. The parameters `status`, `accepted`, `inProgress` and `denied` all filter on the same status field. Use only one of them in a request: if you send more than one, the issuer keeps only the last one in the order `status`, `accepted`, `inProgress`, `denied`."
sidebar_label: "List issuance history"
hide_title: true
hide_table_of_contents: true
api: eJztXV9zGzeS/yqoeYlUR1G243gT1d7e+SRnV4kdqyzZfvC6PNBMk4Q1A8wCICWeS9/9qhvADOYfRYl2sle7eUgoEkA3GkCj+9eNzpckB5NpUVmhZHKUvBTGGpZpyEFawQsGN9mCyzkwDZnSuWHXwi5YxedCcuzDuMyZou68YMZyuzRsJgoLWsj5lL3g2cL3ZRoqDQakNYwzI+S8APb69OTpu+PTmKQwZsllBqwQM8jWWQFTdrEA+h40M0pbw+yiYelyzdJllXML+XObEkcF8BUYppa21dIuuGVrtWQ5FGAhdwNrMJWSBhgvjGILVeSG8flcw5xbaNjJ1BJZnylNY14vVAFM6TmXwpAs3GgV17wEC9qw1MkjnbCUZxlUFnL8LOSZVnMNxjhm0xykgDxlvCi87JiSRMTwEhqpQpFP2VsDTMlizZQEpmbYrGRCMs40/GMJxh4xMaNJGpA5K5UGnLfE9hMa1AvyCqAybij8tuDG0pjCkVY6B73FFCY1/9NkkqgKNAnjNE+OkkzJmZjjpjoRc2F58Z4XBdjXFcjT/Lhe8r8JY5VeJ5OkEV5y9OFLZ3P+tiwvUTSzZj0VM1eiojVp9uSUPWcSF0+scBpsKTXwnF8WwFa8WAKb8aIw7JJnVzhC+og4F0jiH0sgPiQvITlK1GxmwCaTBEUrNOTJ0YwXBiaJyRZQ8uToS2LXFTYV0sIcdDJJcpjxZWGTo0eTpBRSlMsyOXp0ezv5EoYtRClsl2R7rq/4DXZkcmjOGuxSS1YBzRqmD2XwseOqTflntwE36YBL2jFC16e3f2T9pp2y57RrDO0sJ32lGWeZKkt+YAAX3ELOCoG7b+aamLH1cIMmk8TYdYFfzJQuk0kCN1WhchifPNea4zjCQmmi741FNYUjSFylD7jioD+hksLNTH9oyECsIE8miVVXID/R+cE/GxkNfsezq/5X7gy1v/XaCPnzgvzkjlTy8XZ8hS7X8SLlMBNSkEoW9N1MgPabRQtYQX+xwnLOaEVMBZmYiSweFKU0thZNs5Oa9CnOoSd8L+SNM0GNg5oX9HeGnUAG0mpeiP+FnJ0209k7OT3ZH2PIdT8RD+ZByFysRL7EO2hYhEFi3BiVCdq4dB9G0msGGeOzaUHiuvvkbsN7yStUB3fwXQh5BTn+NMgxjYLX9gjnjsjOXJ8D19mCWdAlsuJvPA1mWVhULmOHn7rtSltp66+2cJE7bQp5LaU9bjKQuZBz1FXY3/01uvPQJHmNY96HuUbnIIVkknCTJR8j7ey+37jqObec8bkGKEHasdUPd37r0JMpFO2CzlBztQItjTNpDOgVrRAKyjAuGWitNLtegGRSdfuW3GYLcDYa6fMxuWG/56HbztvqPXKTWr2EdFLzWps3rXk32oYFjUyWmBOKBiaVZRpW6irYiO7qSomrlC24wXnDbAaZHZtdpOvvntalUgVwueO8kHVjRVGgEVd5C621hnCTFcscTD3vSbCF8QPeOSQIP/cw+oNl0NiJv48UrhfKQNuZ2Hkdff/fZwIzOlYC1WNjqfuFic/xg2fjDYv7TeYjNndOEllPTx49wv9kSlq0lI6+JLyqCpGR+X342eCEv0QDVhr9Aitc76xn+B91hXW8wfoMejtbao3qBk3gCbmFkAdTgpyZUuWo2pyfakXphUa2IG4MKCu7rpWYd1K98poOGIvq8jNktmeqj/PqlY3m2ZUzgLsmWMux5cU1X5t6a8AK9No5fTguVBZ3D5eGZ0j4hFueoqfjWhAlvwHcrhCmudnISBE2TJkaHLH078nfkzSYf6RXJ+gN+W+c6zGpt5f71m8K57jKZVH4HyRz4mHuDxIyCrG99CIfugjb8ozsPefebvBFUIDCu8bec6/dZicGbljarNAL3/3Ueatww8uKHInv+ePZo+zZk4MfZz/xg6f88Z8OfuJP+cGT2aPZ4+yn/Bl//Di5nSRDQ909pbdS/AOXpJlZvYlHpzZxGwetEGw4WxZF5F6p2VYYysMmmT1okse8hOIg4wSkCG6QxxHRxzeSATT6lF24VSQHt72GDvOwzUILySRcM/JoHdpgHjbRGL3ZZor9rRmP4A4hnWbTWdwpUSPY4/XONAk+OWHXhKWwHKpCrcnwIvqVVhkYQyygkvNiJw66BtcDiHdsPSLpjUVHsK3b/IK1lG3LHl0ip3zMk5XGAs/dbm9TbuZjrRaXSwvvCDoYcPrbU6rbe6yBmSXeXZB7BdeZ4CU3kI9NyivA+81q49XSVpfuzr5rkX7Dk9JanjDFCao/ogx5wPUGxEiCuJvOOwffDBHy+kwYb1bTsARzQX4iTFYos9QwYFt0abSspMgEKvlV2NENUQMFZIjyFWuWOyqI8k3R/Irsmw9OjmGeH/FXYRCYMgbyLZg6lTmaEYD2JdgF6NiBwFPtjbNouQk6IikIc4Go0dcil+Gpd+SC3qfx2QuZV0pI2yxF6+iHrfmKcLI7z33YyKXKaTfnA8Oy9FReiBJSVgKXXZXHrrlTBrj1yhJyxEuKNVsJ3uI+Mp/CFKYsPYEZaI2g+ODYwrDKu+hhvNBjcMDI204miWM7mSShT/KRJHSm4fnSLpQW2y3U4GYN57+9RmcaDvzYiGkdo1h/LtT1lLlBnI3lRgnt3KVSNyWB4sDT9h39Grfa3Ut6MSxz6s3evjnFcIENl6/fbIivW65te3Iz5Lt13+IZEPlBw9MB7f+jw8P/imBOB6cutfjPhbWVOTo85JWYirnm0k6FOpxOh2YW1nALA6Rz/BiEI+F1lp+VuzjbQSWQ3nTsiYYkIgx7++YlnQHX44CUOSGAja3VYv7cYdUbcB9U924TkzvG87XDf+I5nbnbHDe6DwP1bOIpS/0w44flEnCESiPejq5wSuRCe4FWC+MrLgqKkgTjtNkFAUuiOZptZvbPBqR3BfuyE6nY5Gv4mzOcnkorqzJV0EE4Ymkz1ZTt9fZPOFZOmPuT0D5II2V7Xs4m4xKvEoVQm/vR2ZjYHjvGUkvZnt+7GgogIwXdLrplGDXEHj3Bpmyv4yZATip0QGt2BqBVaLjl2ZVU1wXkc4cTgaj6PXzEMOrk0bamVaePX8Kmi/+i06Ozvo00PFYSft+vLz/QeCLva+aENU/dEJ9ws0DaBHlbWoSsPkGrfSlkPqDM37gQba1UWlc093cPNfUtt+SZmoX4muccKbMn00djLAQg1PsRJliDIieDYmcGTk+8ZdKj2CjdzoUzQH8LW+X+dNAsRvd57mB/183Z4P2VwAv4AVLochFwHavmzqgjUAYbtKixTOUD2+F4K7OtWfP+mOGwB+U+YmUQ6So2hLYjjQYOr/sMUrzTFqJZk4bAo0uLejfh53UHp/Z6CD+dSqtYpYqixcdmixEvc5XD8QKPh5xvI4Jfj1+4iWeh0+ApC/fJ4Lnsumxvfj5mf3r2/bM+Q6/ALtQWPvwQWyX1ndDSeDOOpedPfniWEh0NudCQ2bda3D3+G9+YjMjufDXMhbGgt9x4WSG2RCaOqWUMqbWMvO+M52CCQWyBXtOacXZyeoLX69s3L6fsTKuVyCFn+VIHlK3tUvklcVDDNtDlaODa8+ZVAQkJtc8gTLQ0oM/EFjv/okGD3fru2ZtP+GG/lvXGo5ZpcDlTI1kiHQTzhjB0Y3lZsT0hmYFMydzsB/gjus4C/o0ei6fSchge/+mHR+4fnG9I3fqmbEQRgRALcjknIWHJJ5YpGSGNQ0w/I6aDfXHSvhd24BsGc+AWGHKXQ+53hIDvNpVvAdP0cMIatDFjqE3Qiv7S6ByK5s8h1IznuXApiGcRfobsDXnBkZwrvi4Uz71/5EhP2bGSlgtpWIqEfJJe5Nktia4LfLz//pi9O2Z7v7y/oGNXcjtBFZOuMpseprnK4jEKLkrjOp6+uPiZnZ8c/PL+Agc4ZKfnr9njHx89/v7gB1aeqOywPHnpRzReBYUVeuXyNHYTxXlYB9YMHDJAhjhsBGB8XifqOko9IawT58YqjkaNomBTNKwBaymxpLWUL/klFHfrOWo24J9FQDHmaQwA0y1AmgyBDget1KXdIlMRN/elvdU1i/gD4uCSwY0Fjem296fuE3BJS+wyd87ikWLqAXalHZSvJS/bKWXe2u6zc59QU38hWuzUKtIgdKJkK+9pnCdiyZkP/Yj0K7DcbbHLkFUcjRCw4EvUG8MmRQObXvSdgjoPIEWoOg25vtjS5wN5r+ISZi6htzZvCaBzOhfxCApLvJXom0uKcX6NCENf3o74oHGVC1MVfM1waMzqUgUCGTOtymAUOisPjVASaRtL9LwPY/gfWyfoZ1KO9wIGnT7tINpNdCf9fG0/rbJPmMKQoihj9T5laZ79h8kPPl9b+rGtIKcsLY36VOYqc78O6PMpe+OzGLxZhAkLwHUhGiDHsAyRnJCL7vIZYM6zdYhYpauajQlLV1XNE10ybgppB/Ouu+DnqvmcR99Hk6//SiZJmBWCaM06NR0RElxWldL2DayUy7d4UJhD190pYijRLGj8hmHDoOkzDrh2doPPG4moOQjwiKWvgwnFi5TtrXghckSb3rgUoJTtVaBLLkHaAvNFqQEuIzY6XxrEYamZhbJSmmvRabY5KDqsz3MFhhLSvJAjxjtrHHGfTJI3dd5SzZk7P3T6nhuDWkBt4Wc0qII/uDz0Zbjzq+BHddN4/WnH9Qsdl3aBEwzc97m5IE7u9HzWVQ0z9XgiFKDj2i61PBJgZ0cE3JkjhZwcua4HddcDpHr0+doeXALXoNMhDt+BJh9ix0Ded2ZYmuirrDwJIu+k+FYK+9xa9B+2WzT30oJhPxZ1ZHvv3z7fb5nA7ubsrt+EZcjVbB3uMb+aGJInm0IYNge5FBLG2TxTZ9sgR0rNcDXPlAkXdjjzI7MYp7jz6ozJbcO6vMPjLez67tQDyjxTsyDLJRJZ+d51flvmvA+UO48YQN1eBVFVjagcUy1FtjHDYJOD0LYN+OB+G8mCex9NKWZ7hL1OWph5cVO5i/6ByxaTxDQ4cON59D+owq81+iWArPNKHYmdNx4f32y3ZCorNXs9a87I3Utytv1u+drLMbRR+8uys8yGyAzIrr5/vxbGBMMnmEgHWkS7Za5uCWhTbpwLTcRPcQiRRDt04k1OghnQsNwPplE/lpLJ2W4gwTG+4EOTmUBGcvH30kzO0v1YT7WutWp5WYiMXcGa/fL+V1Ll+BkjYgEC+Gy3cHjxNnQ4bPwCKP1sRbo/QcmPpFT27EQnO+9wKjXb9koaN266EeHIwahh/BxKJY1Fg0zOSQLNJm14ub+94/Z8zZfnpM8B24Pp3Hk06X5DcOcz5z3XcMQ6ax8O5MB8c0BsOn9/hz3zgE164kau0bxuJGDsTu+4Ej7wuIVB7BIwj5WUGPeoA5BmgdkVna0SQQGdDJqGpJ/At5XCCNcxH1/Pth0TUc+MqoF0itu/AW62sW7/tiy5PKif9Wrqxq4X65FnE0PQeoz6+HvpuK2rh5JJR16Q3o7aepWGlVBLg57gsGYyIXt/Ba0LssfUNvxssXHGefVHNHAxgJQ73K7zDmFHSD4KYxHCdqmWMq9TJMJ6DeWyul329N0Zs91BECSVxr/Kp2FcLg0CbdGTiWi7RDUD6JoX7QcVHfT2jX8P80Jmel3trsOaceIKAv1wqkNPezH1lv53nN2Rq+xH5OYqvACuCi5kXQ2hbxbyYr7Nrf2ClH/JJZ/72E8xV1rYRdlxyl8cn/zt4MW587JBZtsN7h8dMWgENkbg+eMnP/71+JUj8Pn6arcVOnN2zS/nr39j7+GS/Qrr3h4KuQaeuf7VHGR7e1unJV3opbHnoFciAx+T1rueqKWx9L5CZBBMBR2ioa1Y9KSD0OIvlrpjSDFCxP8gLgMYcSeXrVfVDwC0o1fQGjJRCRdE6id10xXmU4qIcv0q+k6qr3qPtDEwEayDHiEMV0TRnjaHGPod1kin0oJetQKlY67OK1eeglJjKADqu7adnq6uuTNvBr0Xbpca06bKaodwMs/xsT1bCSPwmq/HZc418/6Ov1ZzlS3rJw1102OldI6FQWDg8uwccGV8NNFtiS45X5Ml0PEPD+diBRLvpplaalaJGyhYVhMdxGLCctxSgZBT9+tT3Ek34Q9a2XVl1VzzaiGyX2Hd7NmhnYbaHW2h4bOGuqqfKnMVNJgwPmNd0aQ7asvvszY347GXzZy4frGIvXvU0d25yI+uYJ1SLP3mh0c/paPh03PJK7NQdldPt1pvDut6VY/QQKxEfe53J1xFZSgGXwuOvK/rvUYbeTDWf8U1/A6q9cal/wyl8yKk//yh/8RgPDV/IO990hRribNvN2W5Dqee9hJCR9Mzh1Imh3IZ+0mG3VS/4Uy7dl5clKzmssOazK04tSrObxrKtWmltgzlePQTJkYTGMazCzZE/kej8HUsfCDkOhTxG4jF9YNNwwGf8SDLWPxjQ8DhrsjAIHTfx+kceOawqgAcxaBNF0+5A+Bo4IWe1993v0fc4nE/ddBZvMNd2Wh/bjT7Jt0aNlFhmA32SM8wGL6mMUbZuqcRuqqLew0peSsshaTPmlZd38UXCzjj823S9Y6j0gL+HXwrfQ45VJYXpyMXe8/UxcZRLS8yCJoHN/HYT34IgyOvDxkcmTb+3SrlvrhiYzWF70PO3xZj/9ZhOZQca0kDkwgXHK8PAjruBR4Jukc1fGdcThGN0CNBr+Mcld/gxj6cgoQb2xudMJHbCIvyZSlQiW1R/+H5g0sFuspHxpm8JqqKxP3jkajOYq4oB8AnNtkFmEDGj4XW5+Uyu8Ln9Btq9emQytCqPEinGfCFkcXMh0uw1+BwgrJdXe6D25v1HeqUVbvKS0g7aJ5etc+iG+H+G3tDSbp2duuTR7cRf/fZ5Q+vEhQz8OPT25ZQHszBcD2flrp4fNuI/CF0NlXMiQn9dFsv6EPIbF3XJqb5zEXQ2sePvhrN71q4o0u4AOTMLMnexeIZeMcvgOdUW/ILDvL0nlVs4lNABbC8NUmfTyKOPt6Vddf0HpJlPf+nlJ/dG37o4WWdlvU/HNHRamkbGJECkT2hXXSrV6AT6HLvJq2ED5d85MpMYJkopTfU/Eo7zgmloXXF/vhfWOxvJa/fY/RE88O/9I4kQ5HKCPtaZUimIyOEdiBbakq3+fAleV6JXwE/fsQiVZbPsXBs4qvNhsDfXogTHO/j639SPiiS0r+gSuZU5BVz15Oj5HD15NAVrj3M3TgH7igcumfuhyb/fG0PG5V5uKjr1zrOh4rXnkCp/MTQJ9QFVqz0z+AxVHzQeguf9OuHnWmVL12AY2SYu0Y4t2hOzMe6G/dzl5GPjcTPceO5/RLk3kBq7gtfdMwtWVN1rPXmq29BnZ0SFtVJD4xKnHm4JW2NkzJHhpWIBF9SEvhM3IR6V6njkaVsTyoLHjTmgpBOU/EM9ifMxchbwx4x3/HPa7XUKI6DK1j/JXUYj5AzFc4oz+iMQskFCtK7xP/dCK+pg/fX5qu21OMF64il7hTAceMK51b4IJoJ/G9Z57y3awPhdeu8SYqPRl4hq0t77Hk8d5+MmuGOZ3FafX2MzvbrN/DGh9dwCV3CrvG3ihMmRUPoup+QLTUhYhQBxtc/7phGL0vYMtQ6kDnXuTmg+QqOdU0Kde3rj4dM2O4DnEknJdtRG3xYE1k89Rsb9IsykAaazPjkecWzBWD2a2/prq+vp5x+nio9P/R9zeHL0+MXv52/OMA+t4132iwnCiugyOFEoNpwy/7k0ZOn0++nVKCqUsaWXEb8YDHt6HlYrXnytjqur5B/l3T/d0n33Uq6ewVv4cYeUoiYHqlq8uDclfkhWT0hzBQvTQIx42vTA9muLnPuXhq0MM+wiT8i6IQv/j8kX74gfvFWF7e3+LWrYUmXqqDHgk3VytF9/22rxQ8K5QpvxKZovC+rlbireGvG71v6fQMrAft5ICf/LKXgN8ywDjLsNsXfsZb6hsmMwvo7T87er7z6Bh7jKus7s/UNKq5vYL0DWu/M/Vevub6B9whhfyDfW1Rd33TOQvH1h1Lfte76Jt6i8us7L+r/o5LqG0TSDxE/UDB/ZFH1DfOLwOdvP7E/tKr6Rn0Wwe7fVAy7llXfMIkmXPBNZ/BV66pvOnihvHozm4/4hxYuJeYDRjc9OoL2rOvlLKOoVw/2u43hqr++uPDJDm0A5ooAGP8BRw8/yXU0dheLcSzgv1Hwg13+jB7rr7D+S93c/TLaocZ/wk5NbvF/ZfN/e9B5kQ==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List issuance history</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/history"}></MethodEndpoint>



Lists credential exchange records with pagination and optional status filtering. Each record represents a single OID4VCI credential issuance lifecycle. The issuer sorts the records by `updatedAt` and leaves out the records that you deleted. The response also holds aggregate issuance counts for the whole organisation. The parameters `status`, `accepted`, `inProgress` and `denied` all filter on the same status field. Use only one of them in a request: if you send more than one, the issuer keeps only the last one in the order `status`, `accepted`, `inProgress`, `denied`.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter credential exchange records by their OID4VCI issuance lifecycle status. Accepts one value or a comma-separated list of values.","in":"query","name":"status","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["offer_sent","offer_received","token_issued","credential_issued","credential_acked","credential_accepted","credential_deleted","issuance_denied"]}}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by credential definition identifier to retrieve OID4VCI issuance records for a specific credential type.","in":"query","name":"credentialDefinitionId","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by the holder's Decentralized Identifier (DID).","in":"query","name":"holderDid","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by individual identifier to retrieve records associated with a specific individual.","in":"query","name":"individualId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by mapper identifier to retrieve records linked to a specific individual mapping.","in":"query","name":"mapperId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Search term to filter results by","in":"query","name":"search","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Sort order for the returned records (ascending or descending).","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by data agreement identifier to retrieve the issuance records that a specific data agreement governs. The server returns an error when no data agreement matches the value.","in":"query","name":"dataAgreementId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"When `true`, returns only the records that the holder accepted and that are not revoked. The value `false` has no effect.","in":"query","name":"accepted","required":false,"schema":{"type":"boolean"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"When `true`, returns only the records that are still in progress. The server excludes accepted, deleted, denied and revoked records. The value `false` has no effect.","in":"query","name":"inProgress","required":false,"schema":{"type":"boolean"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"When `true`, returns only the records whose credential is revoked. The value `false` has no effect.","in":"query","name":"revoked","required":false,"schema":{"type":"boolean"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"When `true`, returns only the records for which the issuer denied the issuance. The value `false` has no effect.","in":"query","name":"denied","required":false,"schema":{"type":"boolean"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential history listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialHistory</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential exchange records for the current page, sorted by the last modification time. The array is empty when no record matches.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange record. This field holds the same value as `CredentialExchangeId`.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"CredentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential exchange record, tracking the full lifecycle of a single OID4VCI credential issuance.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Camel-case alias of `CredentialExchangeId`. The server sets both fields to the same value. Use this field in new integrations.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that issues the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that processes this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement that governs this issuance. The field is empty when the issuance uses a credential definition instead of a data agreement."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributeValues</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attribute values supplied for a data agreement based issuance. The field is `null` when the issuance uses a credential definition.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the data attribute, as defined in the data agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the data attribute for this holder."}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes this attribute selectively disclosable."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder opened the credential offer."}}></SchemaItem><SchemaItem collapsible={false} name={"isTokenAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder called the OID4VCI Token Endpoint for this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode used for this exchange. `InTime` means the credential was issued immediately via the OID4VCI Credential Endpoint. `Deferred` means the credential is pending via the Deferred Credential Endpoint.","enum":["","InTime","Deferred"]}}></SchemaItem><SchemaItem collapsible={false} name={"isPreAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuance used the OID4VCI Pre-Authorized Code Flow. When `false`, the Authorization Code Flow was used."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOffer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The OID4VCI Credential Offer URI sent to the holder to start the issuance flow.","example":"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/..."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential offer endpoint of the holder wallet. The issuer sends the Credential Offer to this URL for issuer-initiated issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `pending`, `ready`]"} schema={{"type":"string","enum":["","pending","ready"],"description":"Processing status of the credential. `pending` means the credential is being prepared. `ready` means it is available for the holder to retrieve."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Lifecycle status of the credential exchange in the OID4VCI protocol flow: `offer_sent` (Credential Offer sent to holder), `offer_received` (holder scanned or received the offer), `token_issued` (issuer released an access token), `credential_issued` (credential issued via Credential Endpoint), `credential_acked` (holder acknowledged receipt), `credential_accepted` (holder accepted credential), `credential_deleted` (holder deleted credential), `issuance_denied` (issuer denied issuance)."}}></SchemaItem><SchemaItem collapsible={false} name={"issuerState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the OID4VCI `issuer_state` parameter. The issuer uses it to bind the Authorization Request to this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the OAuth 2.0 Authorization Request that the wallet sent."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the ID Token Request that the issuer sent to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID Token Request that the issuer sent to the holder as a signed request object."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCodeState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value that the issuer returns together with the authorisation code."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorisation code issued for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorised code issued for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token that the holder uses to poll the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallenge"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge that the wallet sent in the Authorization Request, as defined in RFC 7636."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallengeMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge method, for example `S256`."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the wallet registered for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the holder's wallet, typically a DID or URL. Provided during the OID4VCI Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"did"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Decentralized Identifier of the issuer that signs the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was last modified. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDate"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the credential issuance happened for this exchange record. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes the data agreement attributes selectively disclosable in the issued credential."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>disclosureMapping</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialLabel"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label of the credential definition or data agreement that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of an external credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a presentation definition required for dynamic credential requests."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation exchange session linked to a dynamic credential request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata about the credential holder obtained during the OID4VCI exchange. The issuer returns only the `name` field. The default value before the holder starts the flow is `Unknown`.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder, typically a DID or display name resolved from wallet client metadata.","example":"Unknown"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format used for this issuance. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL. Records created by earlier releases can also hold the legacy values `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc`.","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"example":"dc+sd-jwt"}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether revocation is enabled for the issued credential."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status: `Operational` (valid), `Revoked` (permanently invalidated), `Suspended` (temporarily invalidated). The field is empty when the credential definition does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client assertion JWT provided by the holder's wallet for client authentication."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token, for example `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's client assertion JWT was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Wallet Unit Attestation (WUA) credential presented by the holder, certifying the wallet instance is genuine."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationPoP"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession for the Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the Wallet Unit Attestation was verified."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitValidity</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of wallet unit validity records containing attestation and proof of possession verification status.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wallet unit attestation verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isRevoked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has been revoked."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>proofOfPossession</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Proof of possession verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"validatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the wallet unit validity was validated."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed credential token (JWT, SD-JWT, or mDoc) issued to the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>cnf</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Confirmation claim (`cnf`) containing the holder's public key JWK for key binding.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Confirmation claim (`cnf`) containing the holder's public key JWK for key binding."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT Token Identifier (`jti`), unique identifier for the issued credential token."}}></SchemaItem><SchemaItem collapsible={false} name={"proof"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof JWT provided by the holder in the OID4VCI Credential Request, demonstrating key possession."}}></SchemaItem><SchemaItem collapsible={false} name={"proofType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the proof provided in the Credential Request (e.g. `jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"proofVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer verified the holder's proof of key possession."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedWalletUnitAttestation</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's Wallet Unit Attestation credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's Wallet Unit Attestation credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token shared by the holder during the issuance flow."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's OpenID Connect ID Token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's OpenID Connect ID Token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idTokenVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's OpenID Connect ID Token was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDeniedReason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable reason why the issuer denied the credential issuance request."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialResponseEncryption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."}}></SchemaItem><SchemaItem collapsible={false} name={"enc"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public JSON Web Key that the issuer uses to encrypt the Credential Response.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.","properties":{"alg":{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."},"enc":{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."},"jwk":{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the issuer, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the issuer, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holderTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the holder, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the holder, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual recipient the credential offer was sent to."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Mapper identifier linking the credential offer to an external individual record."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum polling interval (in seconds) for the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer adds a visible signature stamp to the issued document."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={true} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Position of the signature stamp on the document page, given as four pixel coordinates.","items":{"type":"integer"},"minItems":4,"maxItems":4}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `did:key` or `x509`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the credential definition at the time of the issuance.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the credential definition at the time of the issuance."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuanceHistoryStats</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Aggregate issuance counts for the whole organisation. The filters, the search term and the pagination do not change these counts. The four buckets `accepted`, `inProgress`, `revoked` and `denied` divide `total` between them.

</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of credential exchange records.","example":120}}></SchemaItem><SchemaItem collapsible={false} name={"accepted"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records that the holder accepted and that are not revoked.","example":84}}></SchemaItem><SchemaItem collapsible={false} name={"inProgress"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records that are still in progress.","example":21}}></SchemaItem><SchemaItem collapsible={false} name={"revoked"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records whose credential is revoked.","example":9}}></SchemaItem><SchemaItem collapsible={false} name={"denied"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records for which the issuer denied the issuance.","example":6}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialHistory\": [\n    {\n      \"id\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n      \"CredentialExchangeId\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n      \"credentialExchangeId\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n      \"organisationId\": \"string\",\n      \"openIdOrganisationId\": \"string\",\n      \"dataAgreementId\": \"string\",\n      \"dataAttributeValues\": [\n        {\n          \"name\": \"string\",\n          \"value\": \"string\",\n          \"limitedDisclosure\": true\n        }\n      ],\n      \"isAccessed\": true,\n      \"isTokenAccessed\": true,\n      \"issuanceMode\": \"\",\n      \"isPreAuthorised\": true,\n      \"credentialOffer\": \"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/...\",\n      \"credentialOfferEndpoint\": \"string\",\n      \"credentialStatus\": \"\",\n      \"status\": \"\",\n      \"issuerState\": \"string\",\n      \"authorisationRequestState\": \"string\",\n      \"idTokenRequestState\": \"string\",\n      \"idTokenRequest\": \"string\",\n      \"authorisationCodeState\": \"string\",\n      \"authorisationCode\": \"string\",\n      \"preAuthorisedCode\": \"string\",\n      \"acceptanceToken\": \"string\",\n      \"codeChallenge\": \"string\",\n      \"codeChallengeMethod\": \"string\",\n      \"redirectUri\": \"string\",\n      \"clientId\": \"string\",\n      \"did\": \"string\",\n      \"userPin\": \"string\",\n      \"createdAt\": 1750000000,\n      \"updatedAt\": 1750000600,\n      \"issuanceDate\": 1750000600,\n      \"limitedDisclosure\": true,\n      \"credential\": {},\n      \"disclosureMapping\": {},\n      \"credentialLabel\": \"string\",\n      \"credentialDefinitionId\": \"string\",\n      \"credentialDefinitionUri\": \"string\",\n      \"presentationDefinitionId\": \"string\",\n      \"presentationExchangeId\": \"string\",\n      \"holder\": {\n        \"name\": \"Unknown\"\n      },\n      \"credentialFormat\": \"dc+sd-jwt\",\n      \"supportRevocation\": true,\n      \"revocationStatus\": \"\",\n      \"clientAssertion\": \"string\",\n      \"clientAssertionType\": \"string\",\n      \"clientAssertionVerified\": true,\n      \"walletUnitAttestation\": \"string\",\n      \"walletUnitAttestationPoP\": \"string\",\n      \"walletUnitAttestationVerified\": true,\n      \"walletUnitValidity\": [\n        {\n          \"attestation\": {\n            \"isExpired\": true,\n            \"isRevoked\": true,\n            \"isVerified\": true\n          },\n          \"proofOfPossession\": {\n            \"isExpired\": true,\n            \"isVerified\": true\n          },\n          \"validatedAt\": 0\n        }\n      ],\n      \"credentialToken\": \"string\",\n      \"cnf\": {},\n      \"jti\": \"string\",\n      \"proof\": \"string\",\n      \"proofType\": \"string\",\n      \"proofVerified\": true,\n      \"decodedWalletUnitAttestation\": {},\n      \"idToken\": \"string\",\n      \"idTokenDecoded\": {},\n      \"idTokenVerified\": true,\n      \"issuanceDeniedReason\": \"string\",\n      \"expiredCredentialTokens\": [\n        \"string\"\n      ],\n      \"expiredCredentials\": [\n        {}\n      ],\n      \"transactionData\": {},\n      \"credentialResponseEncryption\": {\n        \"alg\": \"string\",\n        \"enc\": \"string\",\n        \"jwk\": {}\n      },\n      \"issuerTrustServiceProvider\": {},\n      \"holderTrustServiceProvider\": {},\n      \"individualId\": \"string\",\n      \"mapperId\": \"string\",\n      \"credentialResponseInterval\": 0,\n      \"signatureStamp\": true,\n      \"signatureCoordinate\": [\n        0\n      ],\n      \"cryptographicKeyIdentifier\": \"string\",\n      \"cryptographicKeyFormat\": \"string\",\n      \"credentialDefinitionSnapshot\": {}\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"issuanceHistoryStats\": {\n    \"total\": 120,\n    \"accepted\": 84,\n    \"inProgress\": 21,\n    \"revoked\": 9,\n    \"denied\": 6\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the wallet is not deployed, or no data agreement matches `dataAgreementId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-credential

---
id: config-list-digital-wallet-open-id-credential
title: "List credential"
description: "Lists all credentials stored in the holder's wallet with pagination support. The wallet sorts the records by the last update time and leaves out the credentials that you deleted. Use the query parameters to filter the list by status, credential type, expiry, or a search term. The wallet replaces a value that it cannot read with the default value and does not refuse the request."
sidebar_label: "List credential"
hide_title: true
hide_table_of_contents: true
api: eJztXG1z2ziS/isoflm7jpbfk41va2s9tjNRkolVsRPvViZlQmRLQkwCHACUrE35v181AJLgi2TZydZe3d58mNg00Wg0Gv3ydIPfgwRULFmumeDBSfCeKa0ITVMSS0iAa0ZTRZQWEhLCONEzIDORJiD/pMiCpilosmB6RnI6ZZwiFaKKPBdSD8j1DMp3lJBamdESYiETRcZL82tKlSZFnlANRLMMCOUJSYHOQRFRaPOOz4qeUU2WoiAJpKAhGZBPCsxbfxQglySnkmagQSqiBZmwVIO0EzGlcVKlqS5U6BEleplDSOA+Z3IZEiEJJQqojGdEg8wa65CQpzQGRSiZ07QAyw/TJKacC/w7TaxAcM4EJrRItXsVV5YIUMS+OCkc4xL+KEDpQRAGIgdphDhMgpMgFnzCprgl52zKNE1vDBOXOfBhclbxH4RBverg5Mv31p5+KLIxSCImley1IOqO5WQipLdxA3JKOEypZnNAKRQcV0PHKbgFTGiaKjKm8R1SiPYiZJnhFEb2QRhwmkFwEojJRIEOwgCXxiQkwcmEpgrCQMUzyGhw8j1AoQcnAeMapiCDMHDCCk72wiBjnGVFFpzsPTyE30uyKcuYbk/ZXOtv9B4HEt63Zgm6kJzkYFYNg+cyuN/gyugNJOv5em0V0dfk8dKpnFPJAbmZASdaFhA6VhVxxP2B/00W+J7lt3qRxmbbvPc2W95YiBQoD8yKmjxf1WfAO0sSVJFqZH/F5tujs9HkSkvGp71zC6mJkAlIo6T2mOBKIal2dIuqGHjC+BS1Fcfb37ZXqSUaoUuk+RTmwgA4auIXw2EQBlTFwVdPG+xzXyPqTbgyO7uRavg2Cn+2SoEa3DSBpRW2BqlhnDKq4xlYM2tPLNzTWKdLPNnOhnuEuJAZTdOlMeiKCA7lbHomwZFQJKqH3OZWwlHYeErjO0gi3ITm0xhyDUm0mSJ2xC0mE5C3CjgeefuLhBjY3Jw1Le6A3zKlCvOrN2/fM8d386Fhu/3I8tx86lwNbqNSBeUx3CbAGSTB14cwgHua5Wlz3x1tTyfm8SOWa4UafAbJJswY4drik+tlDmQrmsc62sZNo5wML65fk6vznbc31+TzmbfPTxJ/Yz2F5CdQDKCQIqcDiAdQJOwkZ8nJvr+0RMSGyHOWl4i4yIBr44PJVuRo1au6uiT7f97bP9w5Jtm5iH/KuoScDpgSA0N4cDzYH2Tn7/0VPWs5eH5aQUV5Vr3HCUwYZyZOwhWSm8Ozn7Vdtaqcag1oP5DXh69IT+WCK1BI4WBvD/+JBdd4tk6+BzTPUxab13e/KVzf9+6MYvwNjA7nEqMUzSy1mnH8jWnIVN+gpvQ8TbbG3IZRdXBZhY1otFTDyNF0QZeqdpBzjPomDNIErZz5wVKbUYy0nCFkqvYfJjxjWhHIcr20L5yQ6Pfg9yAy3oYSK94QYxz3xAYUIYnMjpRPnfc0oV3EizR1f+DErpzYX6iUdDnoyI4lffavKapPnP2B/Bt5TZiNaVo6ZWWIUmLKScCadONHaFZ6A9ow5kO0zA++oRs+i5/SP3sMrc0XWpNe3MczyqewyeTDdVIAR8jufi5FUsSAusBU43g1Zr9GN/L4xKh/ki7I25vr0BlZkygYk2RcUcmQ9T4rzDZFLbQujEykyOoRKB4T158befYOV2To3A/ZuhyeH30+G2771C94kgvG2wLuO440SYwNounI00gTerZWfg6xSCAhOV2mgiblMvvXZyQxIGeCa8q41b+cSoVxR0pZpupVO7u39fbmejtsOS8j2rbl383O3/v7aGyCVXamysO3mLEUvPCILCge9K6KtmTk4rQ10UgVg/wvD0g6praQEv3rY+Fk+5A+KWKso8VBb7hIMqBOHXxqAIkimZAY7EKuQrNPzp8RSrSkXGFeIzhBJbSZeYzghBaGmDsF5BwmIJHXvtPQF6rW/FR5vTuWaMndwlsa0x/ceqSc6yr/1BmPCiv0DGQZWccig6YdMIc7ZROIl3FqEYMY/UeeA5Wedle2jincwFyKqQSljFbb+ZHShsbttBrgTNmWJ/lbZux4ZW8qLzoxOZeTe8l7w1MXyuQizOTeucBtm8H6vUL+S6Llww180sf3pWJvphEjCXiMV6yh5RSNeX6cCW8iO4R43ooqG/iBL8wBhvEsNgeq4QjGVAHBRRVoOQ1woUQ6t1vfnec30DShmhrGcwmnhZ4JyRQkZyKBxzkfSdihdsw/8bzjUau00juvxuQ1heeLHMmc1mRwbvI6FQvDVqFAjtgmnrZ96Lf0/S3+sE3KqPhpM8cSqIbkVK/AdFrBzb1BIZWmWU62GCcKYsETtW1Bl1YwUUavC2qe4jwY5VUh+f7L4z37H4rAgJz/ekYMopqJBDWvl50Xhh3rlZ7GDdlqc1FqbRn3tL3sqtmFwTAv5ZRypirE89nBsAudhEePbCUWNC3NUQJ5KpaYbG67BMHFyN34UPwsvhoMPTKpOyIfq9yvg9G1pzV4YYRRWxT6HigrlAmA5yzp9aP1kdICnVCO0cRGJ4oYl0I+loh1w1K+xuig11x7QdQ8/i+V7HxbYAw1z+ufE+/5t4W+nce3JhUtfwvCIFPiNktE3A1y7Myl0Ctf7p2PFQY48qaKbBZnn0SEymaQilYno1qFJKrWgDhYtYgotASqlVgaLVymomLeLZcUoSNH3nujXjumFfHa5LXgmqV+IHPHxcKScqOcU0CTvbE+e54rZfwOEda2wdGCUOLTrWKSkLCJF08pzAC0BTuSJacZi+tQZ4I6xfhcpHOcpD8DGvmzbNl3jj6Pts3SWNs9r4AczpnKU7okjFu5IC067laYnD0LS5/rJWqrPW8j+ZPr4AqzMQjUm31UoQUj7F7azVDWtPolpdr5Z5Wr90GiLxa3CoNUWBQHswUxN5Y8FVPREsbXNg5hUa/HlKKUIL7dWjBuRDX3o4Teuzd7iFiunxLwVUGTGUpYZgo7D27hz6KEIz1CjQGPCqn+rbO8h4a1PDPFvcKW+3oxs82TdE8zY5/s03XXOikDCIKyaVbTUxndvoMlJtUpnl7fbZTq6WxPM6EzaHVIKoi3WUOocVFnhxOrbhaj0vetUHbFKe9Gj5HzddF2ozRM0Y1V0in596R0aYPdarVYrFWc3gGJMTofQ0xd/XZJMiZlKyRdMAkNu13lmdYORN9/D1LgUz37PTgheyH5PWA8L/RtJhLAR4hG4lNvfeXjh6iOvkxMXkKdbUffRRztlBuEfHXNOJ5RSWMrtRKk7UQUM+pA2gptReR0cy6rIPEITXoliA08Fb6LejcTdV7QniFc6f55kYFk6O1NDqyIiRkR2cCiWaThXtd/o2k+o26EJ5Zmn4MBrL0KXCUzd74U8EQ1WwHiGcR3hOmWBK1TeIYMA8fjk43XkCstC0u1lKULKc0y4D5PDa43w3MvyBT61QFtXdM/Ob1r7G3LKSFy4SJOY7vOQVOW+obRoOhd9MIfRBI7qiP2CrZwcFd5Tst41tZH+kHFUhSr08xw08LHJY4nB4M9QnvYtvk+Tley14pLMGZqK/PH12fk1eGrFz/HVnUshl3PoxBS32pwSNsqYN7Hktt6XVXBZM2S/Q4Zr4rXJtXMRm4bnvB2k1rL2vJC07E6Ndo4JGxwPpoJLRodPE3O6zyyT/3bqlaXAlcGBR7BHzoZpZEzNqzuF1BVr0BXLHWq2DIJrsa6bsNWCuWrJTZ3geRq9L4fC69HVq030WXZeYUqaTHdOU1ZEpLoI8yFhxrnIDPKgesUswnzEuI6IYmuCoWIt4cKQ5YLSSVrvtqbyVWG3gmZY2XT+gaHq5Sda0LWL/uV5dKfuP47b5mDZg7urTUIA7e8IAwq/o01TmFK0xFL/GLy47E9DiIjkErwCgB1st56PxqebxNa02uii55WhhX0Occ8sIWPGs6cUutlqXQXn86HxHbIEYiFWioNmU0FuisZiXwTYFSICTI2EkqBUmYRIzHarlxCxRIuzV9ZaPEXkzhXRw1L7lKkNjygSomYoTqQXLI59j/ewbLBr82BN4KChjxBMYPJHk2NYS17Jo4YA2CzZhyDUpMCUei5m9DWEQotXOr9HCyqzH8LLTDdtjC3Aww6AJhVaGo7mGok4OjziDRdizMntp5vIQbD7Byk2khBP9sX2/WCytXkUmgRC88X92ZAZWcn+rRE0om+3T+M/GPmGLrd2zeHKZbLXIuppPmMxe9gWbuax1l+B0sfWtyK7lhiG2SMVWBTjhIrlac902pUbh2G5lE9wVwsObmDpW3xuj/eexW1LIp7IQgD/KtrizKdi7UrMA7lRxzaKb6PDOYS5kwUCq2qhZ0bwBROU7aAzKFsoRwEfUxtws8GCflqXhNXP+82cpYldVu1c65RXXCzgU1d3vjQVT7dEiNgqUHSl+KWvl31qrkF10oTdMP07FoWSmM38g9wZtSrdfSpqgwPoVNMMDTWeV00gG4AJzZ9VhYMwF+vQM5ZDCOLcvcCgE9pcrBZQ9n+aOZTdoYSSJcEuJZLq1i20zLxV5YU0pj7ile3KOeBV7QrNH3+RBQ8wfzO0LelCLR/mGU8foLr5MLAqpUB64moBySaSME1IrYc0sjWasdSLJRRn4RJiA3Wjd3ezbdQLiB3tNixP2EFISt4/0JtbLNJBuVZE5+1IAw8FrpponMIT5FOM/VyuYWpt5Z8Nn1Os57IlI0xPnGm+0OjDc9E8xQwvFLgohckTTzaZOvm0+m2AQ0wvqNEwrRIqWx4pY/QTpeUqT+YEbbBD8F0LRBpwIVwUcdmmxQFIn/ALUuidgtTWBdmnfc+G5IP3qBmnd8nt3mtv5deD5LsU7/aLISxW0PopOzsrNMdmzH5NMsWFG9KaiIp4+auN8qaTRevY90Odg0YvYKtcNQxUAnSOuPzkRhZiDTJRf52cfc4BvH26vIDuYExwbhi6+3NO6ysu8CsDFirbqC8GKcsxjDA8IDTkTEzXT1drICm0w2ggnQqJNOzjCD2iNmGoYwARXVvxsQyfsZ8cXVw/MJGN/NNWjG8EIjEhZy3ALLRjiN3twksgHIanlcZibHN2COaQ4zq0OXWSm/HyWlnf3J4uH8Ik1eUvjoy/8Le0d4efRnvT17s0XhnfHwMMX11HL86Ojg6Hk/G++Oj8cEhvDwYH79MDg4Np3q5GacGdWkK7wwJ3D8+/O8kFkImeB0IqrN8ceYrwdYvVMGLIzSWwE1ks92cbEI/vTk/Pp2/mAxHo6vizdVSXCziT/unf98vfrmVbPzbi1fyzevx1Z9PkasNFvWPn8DV9Ojdwa/zvQWbvslG327Yy4OjsTx9/cf09j6Fd1rf3L8+Pk5Pf72+OuoAFSh5q3goRGT5a/uVFlYxbP7qdbh2W08bnZo9LYndfq6eDqmefqW+TqC6Dcdvi/E7U1Y0ZnQ6IrrdCj2NAJ26c1WtXVMHq2o9K+DgHtynH6pYmfb35NfNZLfOJl2secrjmUCu78xGr8psetOL3sh+dWS9Irr148AVAdDqyARjprUQeqcd3+uYdZCZuS9nQjtDog7t2MR3lba7hYtGQlYHzGX9OzV1E9OZUN0+tA4kvZyYG4xtF6aZtpa7fr9zE8GyOqJT3/WuKnCdeQtzzf2NZiWUmdA0HbaSwVX0rvFl79qhSSIJnVOWYtzl0z44Lokjr88hjkzbNsGECE7Ke5HVDIcIIpmHT6n0WZbL25ENaWDL1oyqkUu8nwRIWQ2R8CdlO0YMhc4U5lqFneUD3G8Srq2YgcO97lA3OfrDQ6dxqFYnUtatqzs9pmL/0MnsO8XcTtebuXk5A5pY/B5JHD3xzo3vXAALNs4kmp+9HgPs5Vh/P6ce3acKdd3VdOV1yPf1clVO9ReKRQOsv1aV9dUia3TCMQtUG0DcdnW3Lm8bfJKShRR8amsLA/LGViKrK9I2vaGpEjbHKY9aeYWH8mQs7hsT923M/n/wxnzidd9vRzTH/9E6O+QaJMe7TBbkMNO0ZPQQBgriQjKMzb98D05z9g7wx69oaTSd4m38wN3dL5P7qoHtbDsIA6vUKBLbw4Cxqrk5n1Ps0wh25we7Fgnbde2sO9b47Nry565Kvi30btyIOCzLfZ8COIdMuBVhDCdTzFa0ztXJ7m4CmdihORuwqaRcD5gIuveyR+ZalS2d9ZN5jMKVRps7XTVc2T+3Gflai/oKNc4qSinwGsK1D9zVTbtX9f3vBqzTTUxHQ5NM4JFAWfp4li1gu1Q9atCJiJ3Gdt2OES+ECbsv7xlGlkcSkS0uXJetlpSlRgY5jWE7JDCYDlpkT4gb+JelKCSKY+cOln+NbCEVuxjLw0ljczghowwF6ap/f6uFV62f/Vo/akrd37CWWKpBJRCqDDjrmoYZ/ptV3ZnNduyn3WRDeOtpDaBVsUa5u4+4hcBxjHJ2/5/OVSDshblHaEJU233rSotlm7j/bYZCme3RlCdUJmrHrJdRvPWQYn+t2dqyzorcrr/OhrM9cp+tbAxGF5WyGLiCujUzOM1pPANELztbt1gsBtT8eSDkdNeNVbvvh2cXH64udnDMQx1A19uJwiqvX5cnoiqjBQd7B0eDw8G+CdKF0hnlHj+Yq5BG4tpqNKq8xv9/Uebf+0UZZxixk23XdG+ZqwbS3Aq1PuZLMD8wDcPoZUwtz/czDhIwia/xNY3kXaHnmgnE378E379jRvJJpg8P+NhenDc+iCk8k/V19pXK8q/9VE2vLLBs6X2xxgwPTgLruTZm/KnfnVnDSpnNPZOTf9OXZtYsqP5AzjOXtMGHaNZMX32P5rmz/+inaNbx5n2R5sf2u/1hjf9bn49ZI8IexPTnSvLnfIFlzQrsp2F+LtM/+F2VNdzWX3v5eRz/xE+nrOG8w/ZX/EWarTVJW5ndGadlx9i70d6oTg784Oduv15cO3y2mZTY3hj3g4dvUr70aLfzE8sC/h8l3DvkLxjFvYPlX6vX7V9WDqhyIvs2yufrw8PD/wBNeS8n
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List credential</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credentials"}></MethodEndpoint>



Lists all credentials stored in the holder's wallet with pagination support. The wallet sorts the records by the last update time and leaves out the credentials that you deleted. Use the query parameters to filter the list by status, credential type, expiry, or a search term. The wallet replaces a value that it cannot read with the default value and does not refuse the request.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"expired","in":"query","description":"Filter credentials by expiry status. When true, returns expired credentials; when false, returns active credentials.","required":false,"schema":{"type":"boolean"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Search term to filter results by","in":"query","name":"search","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Sort order for the returned records (ascending or descending).","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"credentialStatus","in":"query","description":"Filter the list by the status of the credential in the wallet. The wallet matches the value exactly. A stored credential normally holds one of the three values `credential_pending`, `credential_acked` or `credential_accepted`.","required":false,"schema":{"type":"string","enum":["offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"]},"example":"credential_acked"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"vct","in":"query","description":"Filter the list by the Verifiable Credential Type (`vct`) of an IETF SD-JWT VC credential.","required":false,"schema":{"type":"string"},"example":"urn:eu.europa.ec.eudi:pid:1"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"doctype","in":"query","description":"Filter the list by the document type (`doctype`) of an ISO 18013-5 mDoc credential.","required":false,"schema":{"type":"string"},"example":"org.iso.18013.5.1.mDL"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"type","in":"query","description":"Filter the list by one credential type in the credential definition of a W3C VC credential.","required":false,"schema":{"type":"string"},"example":"VerifiableAttestation"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet returned the credentials.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential records for the current page. The array is empty if the wallet holds no credential that matches the filters.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": [\n    {\n      \"id\": \"string\",\n      \"credentialId\": \"string\",\n      \"credentialExchangeId\": \"string\",\n      \"credentialToken\": \"string\",\n      \"credential\": {},\n      \"credentialStatus\": \"\",\n      \"acceptanceToken\": \"string\",\n      \"deferredEndpoint\": \"string\",\n      \"credentialIssuer\": \"string\",\n      \"preAuthorisedCode\": \"string\",\n      \"userPin\": \"string\",\n      \"createdAt\": 1750000000,\n      \"updatedAt\": 1750000600,\n      \"issuedAt\": 1750000600,\n      \"openIdOrganisationId\": \"string\",\n      \"organisationId\": \"string\",\n      \"userPinRequired\": true,\n      \"credentialFormat\": \"\",\n      \"presentationId\": \"string\",\n      \"issuer\": {\n        \"name\": \"string\",\n        \"location\": \"string\",\n        \"cover\": \"string\",\n        \"logo\": \"string\",\n        \"description\": \"string\"\n      },\n      \"credentialConfigurations\": {},\n      \"txCode\": {\n        \"length\": 4,\n        \"input_mode\": \"numeric\",\n        \"description\": \"string\"\n      },\n      \"authorizationDetails\": [\n        {\n          \"type\": \"openid_credential\",\n          \"credential_configuration_id\": \"PhotoIdCredential\",\n          \"credential_identifiers\": [\n            \"string\"\n          ]\n        }\n      ],\n      \"revocationStatus\": \"\",\n      \"legalPidAttestation\": \"string\",\n      \"legalPidAttestationPop\": \"string\",\n      \"legalPidVerified\": true,\n      \"autoPresent\": true,\n      \"version\": \"version_01\",\n      \"cryptographicKeyIdentifier\": \"string\",\n      \"cryptographicKeyFormat\": \"\",\n      \"expiredCredentialTokens\": [\n        \"string\"\n      ],\n      \"expiredCredentials\": [\n        {}\n      ],\n      \"requiresEncryption\": true,\n      \"isVerifiedWithTrustList\": true,\n      \"trustServiceProvider\": {},\n      \"oAuthFlow\": \"\",\n      \"authorizationRequest\": \"string\",\n      \"isWalletUnitAttestation\": true,\n      \"notificationId\": \"string\",\n      \"notificationEndpoint\": \"string\",\n      \"notificationSent\": true,\n      \"accessTokenType\": \"string\",\n      \"dpopJwk\": {\n        \"alg\": \"ES256\",\n        \"crv\": \"P-256\",\n        \"kid\": \"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23\",\n        \"kty\": \"EC\",\n        \"x\": \"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A\",\n        \"y\": \"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4\"\n      }\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid or a query parameter has a wrong value. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Stream notifications (SSE)
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-notification-sse

---
id: config-list-digital-wallet-open-id-notification-sse
title: "Stream notifications (SSE)"
description: "Streams wallet notifications for OID4VCI credential lifecycle events over Server-Sent Events. The server keeps the connection open and writes one frame for each new notification."
sidebar_label: "Stream notifications (SSE)"
hide_title: true
hide_table_of_contents: true
api: eJztGtlyGzfyV7qQFyk1Q5ESZVlMKrWO5CTKZiNXpNgPpmoHnGmSWA2BCYARzVXx37cawFw8ZCWbfcnqxRYxQKPvC/3IMjSpFoUVSrIRu7Ea+cLAkuc5WpDKiqlIOX01MFUarq8uh+8vriDVmKG0gueQiymmqzRHwAeU1oB6QA03qB9QxzcoLbx16z24nSMYtw73iIUBO0dIlZSY0g2gCpTAZQZLLSwaUBJhqvkC3dXI0zlIXHaw6o3lWH7xxRfwprRzQsgv0+oNyszdkNA3pcW/3acE5sgz1HCQvCnE33EFX9/j6psElIbkW+QaNXxt1T3Kb5JDj/NEq6VBDYkj5EaVOsUE3ry7gpRLqSwYtKDxtxKNDdDNCGZogRMNsRULBCvSe7SwFHYOybvrm1s4ejg+SpWcitmRMbSLNiRwMFHZCpLHMSu4nY/ZCMastTUTM2F5HnsRHRHPRHbUkRSBG7N1cuiYWZQWhAUhPTOqa34rUa+g4MRfi7oH3zt8icEB1ZrpjYhqdv+CplDSYEUurScXSlqUNr5dFTgCi5/skVOJ2Di1SiJILng6x5g2apWPQKo4pZWkBvwd4UOawa3DN+iL1wjaNOhBotHq1QhO+v1+P4F4eyPYuTCV7ghtbA+uLFjM86B0uSDFtAqWXFg46YPBVMnMjCUATHCqNBLTNAbaTW8sj3uQOHpGFUcwS7xACWbGLYfkcf1ZhPjUovZbykltfe5mYSAXD9gby5PmsrZsCfhzzMLprd80V3lmgEtIRJbAVGCeubtINzgkhHZYbmhpwwI1+Rem1oN0MIQJBP5WokwRZLmYoAY1pWUHu3PekVHpn1fbkdfIVCM3aBwqwoKxfBVAE+LLOcoWJx1gjcZybU0EE6/WKZeOQpjxwvTgV+PkZhXtLMns6LxTPzgwiPALFjlfHfbGctiDZOQcUcyJ6cRaLuHm5i2karEgnHMhnVfTKxicViriVCnlWgs0IJUnL3I0eLXySiRm0itRbyxPG2Gi1kp/VkVq0pWecSmMZ+Scuws9C6PANXcZ+T5Ic2XQtCj2InN66ZXAaQ5JOoLEIxKcsuW2NJ5cYYDnGnm2AoPSg3e2yC0UShCpRnXUWWvxgMYrzw+3t+/guN+PSAX8Eofhp0/hCmfm3tDf8VWueEZaw7v64sDSNqdwbf30VOxRUH/bl1+SSOQD5qrAL7+MoJS5uPd6QFQ5rpVFxi1SvNHeY0awnIt0DkvNC893D1JISDrm5/kVvvJ8SQpbY2UQUMzm1mNrRs5aIkjaQrxyK22Y5C13rf2CObeYbR8IbpaWPVfpLzIli9kbmzgKE08i/e7Bz8riDiw8yRVjooordDwXxrbYA5ly8tRoSy07OuPFt+F+vBI55iSlJOiJV9cn0ASuEX6V4hNQuDSWLwpD/K+srok8ZMBOPZSLsbbydK2oEfz7QhiDWQQz8eA1wLkv76cg58YGFd48N1PkoULA/IkbG7vIH19dNtmD+7aVEBiUmXHOzRrMp96QO4HkMKJMowJOSDggV9lWSIYD8u+8DlaEJIV7Ezjeuf2wk145f+Bx2bQWU8cfbquQoA25EwsLZSyckvVynzt5LMk7Bhb7W7STgfO9GgvklDjs5iS5rOBORpBpVQCvjkxW25ZM+PTgDTzwvAzAhHGqx6FQRljCREiLM9TgI0Hbw5MHUKX1d+R8VSvNtzjnD0KVunIrXc9bYa9kvqpF5lXVbHgnwi6ofjrncoYhjmaYoyOh0CorKSgqD7QHHwhgLUbiRQdpqxSYXC3zVdQOCrXwwjantdzWYLideylKz1cvn6/azG+UronslQUIa9oWQETMMHDTm01lVEFOgaMuwnqlaLsIH3F5tkPdapUIRUXIR7xS9LxAhGmD4vc+sk5FTppaG0S3hPAB1rSdYC4WovIsajo1lOcSQIJPyfRT2IfLOrj3WMTqTVcZGzGfhP8kjL30efgHR9R1gfIq+7l19sYgi1iDOht9fNwotq43SoNta6/LiycrmcjngZ/4osg9dXsLFp/l05bnliORywJa+rO7mAr+Av602sWLOmApDHkEkTlCm2Td3UpLlNdU9ZdVbXm/kVDKe6mWMoKSlNpxqhAaswr4zGUvw/6ATLuC8jl6JWLmdNQDIUURJFPnwlnEJF8gGzH/lUWM4NKlbDTlucGImXSOC85Gj8yuCtpqrBZyxtbraFNPbncFrm5asj+ORTvUam8Q8UnsptLtDIAdU/xcpBGmFWm6efgexrXi4rO4F2ICi1iwAzYang0GfzY3QxH0B8J+h19NDAjq5BlTGdHTWYEPUiHSNTBqTvqfDSs74vvvmHlHp33hb2j/cb9P/20zONBJioaepu1+UKdIqcCGGtB1gkppRd4WQKvAaXeNdDtstvfMuZSYE2NSnzI7GjfbErS4zxqjzf7YfiqubKs8SZoGQbSpXC46hTKQRJSFvlmddLVq0k4lGnSoUxG59HvjAl9vhzALP95c/9ypkFy+7AoUOp1sBC1HVQITzNWyxbl/YCb4recNL4o8HDj6l1Gy2XWzyUZ/L4uYFZbUiO26bYvLrdLQPptgQrbQFK2t8Nopsl0CnSq94JaNWFmKbOvqX6X4rUQQrrk5FXVXo5sDti2Dvcr6fDA9wfh4cpbGw/Q1j8+ng0F8wien6avsDF9Pz9k6Yt366/ejdrWFU6c54D37Um774R5ck8to5ZI+5Pkanrj61TOrQMozhe2S35+eTwbpcRaf4JDHp5NXaXyWvcb4fNrng8lxepINkcjfLG8/b2y0qyK16jtvN5YcNrJcsNFH1nSl/1mgzDzQ1iJP7zHrLml8UFuLIUNgd21Ct+DsIKqu2f8M8Wo0LsQ0gWirxp6o0m6nf63mfKPIXalNzrLBdMiP49fpCcZDfj6Iz6enx3E/O0lf4RkfTIanmwReNE70SXvdbkSGzN+rHZfUMuIr2u79Q6gRXBvPe8+agNDaCL8uXBpZBn0MrlQYU6JOIEPLRR6cpC8gKe+QZZ4nTUOtU4RIBYXH3WX6Eq+nLk8PknNoUli1uDC7vBrPMkGo8Pxdy/NYXaJLPH7H9rt1xHwd83m7+IXqrKb9ss3yN9sNmapVxaua0p1umjOupVf7h7Dby6va1DY0WmAR81+6ZhLW1s6gfG+nRZJvFe9yu62+Dxw0fZ/DRnQdgpbchAo962j24Gx41h8MXvX764jV3aX/FQYueVyojCxsLx7rds71kTnb3wgGO9zjU85lt13WGtRmfZsJpGSNoNqPKFSFbz5tjCXF3RE8rumryEZASWC9r41BvXXMRDZmo/GzguKYReMNRrizz4ko7uwmg9zpTTe9c2fNSnfkOc5wC0zg+pgcRvvWMRs9jtlDah3ot4siVyvEb3k2o7o2GjPvr/w2yv/8vuC+r1vsGDPKuMdBqm6bNy6HSy3icVvZonEj784HJ8T2c0dLqMfPFCoJ5QSH0/iUv5rEw/Qsi1/j+TRuxHI6/Z8LNQTsZ4j1dPqKn01ep/F51sd4OB3w+HhyksbD7BRfTc/468l5+oRYKXD8Du6fHu/hPn1YtwzMpf4t5vrfBP87LnIql9zjlcofmtcyqcC1mC4hQ1IoVxNMVVn1Pxy//11pzViyNXmd8DZLzq/z7vpkzRZ8v69ok+aBlu3vWbS9SnWAMFhHbNgf0P5W/bVVPXTKr7ajdIy5UBn5Qvf3ZQvnu2grvHaz/+b004WtCxRb4J+k8VuegZD0rl5X5Y7c9VYGu7+BJIxrswo5owKWGi6uwxVV5WzT+drXvyKJNBKmy0/7J/83zG5t6Vx/2j/ZdQO7VQoWXK58a8GXyD7bMWyP5IJBuJxp/+ke3OoV8BkXEsj76E25UGaHaamFXbnk0k+dsNHHO+qnWD6j3jAL7WTw/WQ48OY+fH9xyCL2g8qppXMXsQXauaJG9My1FanJyUZ/oMVK1uzI29WYvsSFCtRT/qBz6ipZW5jR0VGGCxXzQvTETHNpe0Kx7R7bO/cG4rKkPWA+B+HG8hnZxp7jxn/eROSuYbVrRXjlrBje5PV+YU+/rGOvW3kidfvucQW8M2/ULjqqrsVuu1+UxsIEodA4FZ8wzFxUo0gJHEh6rHUeQHOROx4UPMXDCLA3622AHUE1w7RSpSZ2xG6YqUd9ZCbkVFUOgafOIeCCC2KkKYtCafu3hnk1/eL7ZqnL9bbANthSH6L3rweRuXezVJGBWgRB/1PMCu/1oab3EY0C2HvUYir4JEe4qEO9gStjSk4TJgeh/vcTTbsPvtNo6itq+3l3SBhZlSpfGgrjGrYo6YzpRE4yc3DZWeTqQ9+Qe6AbVhDsqlVbGyid+zaWy4zrzMSOXsEpNOdqGR7dAqcdth9OLuD9BRz8+OH2MIKrt7ffwc1l/OOHW3h/4W+7urmGwev+4CQ+hcWlSo8Wlz+163nfQ3APU7lIURrn/yrNLSjywnGvvyW65XLZ4+5zT+nZUThrjn66unj7883bmM6smzZdI05iVqbSspYeixi5DS/24/7xsHfSG9DZQhm74LKFj58m3HgTOLi5eXu4aVatoPUyg/gyg/gyg/gyg/gyg/gyg/gyg/gyg/gyg/gyg/gyg/gyg/j/PIMY+hYumy1yLiTVW67AewwtoI/s4djPYUyFezHsZOh+jFGKzZcjeiqiZtBdxObKWALz+DjhBn/V+XpNy34sy7WIhKGSuRkb2lvAvcw1/qXmGncq3z011JrxRucr2Yj5Tt6zNeWvPtn4BOu6A44N/+7oh3YdLdcirnrJv9MG/8pTjk9wdXPWsaOXfsubNMWirbPbA4HrdqP9+7e3NLpRkpdtd5DvXQc5/NEeGpGrFvDNZrLHgf5tDYh0j3xNrP47rr6pt/svew/UDWy/m/hxt16v/wO6qhTg
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Stream notifications (SSE)</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/notifications/sse"}></MethodEndpoint>



Streams wallet notifications for OID4VCI credential lifecycle events over Server-Sent Events. The server keeps the connection open and writes one frame for each new notification.

### Authentication

Send the `Authorization` header (`ApiKey <key>` or `Bearer <token>`). The browser `EventSource` API cannot set request headers: get a one-time ticket with `POST /v2/config/sse-ticket` (body `{"path": "/v2/config/digital-wallet/openid/notifications/sse"}`) and put it in the `ticket` query parameter. Get a new ticket for each connection.

### Response headers

`Content-Type: text/event-stream`, `Cache-Control: no-cache`.

### Frames that the server writes

1. `retry: 30000` - the server writes this frame first. It tells the client to wait 30 seconds
   before it reconnects.
2. `event: connected` with the data `{}` - the server writes this frame after the subscription
   is live.
3. `event: notification` - one frame for each new notification. The frame holds an `id` field
   and a `data` field with the notification object. The `id` is the sequence number of the
   notification event in the wallet: it increases and it stays the same when the server
   restarts, but it can hold gaps. Use it to resume the stream (see Replay).
4. `: keep-alive` - an SSE comment line every 15 seconds. It carries no event, and clients
   ignore it.
5. `event: error` - the server writes this frame when the organisation has no wallet, and it
   then closes the stream. The data holds one field, `error`. The status line is already sent
   at that point, so this frame arrives with HTTP 200, not with a 4xx status.


### Payload of a notification frame

The `data` field holds the notification object with **no envelope**, unlike the read and update operations, which wrap the object in `notification`. The object always holds these eight fields: `id`, `organisationId`, `notificationType`, `notificationTypeRelatedId`, `notificationContent`, `status`, `createdAt` and `updatedAt`. Note `organisationId`, which the read, update and list operations do not return. The status of a new notification is always `unread`, and `createdAt` and `updatedAt` are Unix timestamps in seconds.

### Replay

To get the frames that the client missed, give the `id` of the last frame that the client got: in the `Last-Event-ID` header (the `EventSource` API sends it itself when it reconnects), or in the `lastEventId` query parameter (for a client that opens a new `EventSource`). The server then sends the notifications after that `id` first, at most 500, and then the live frames. The replay can repeat a frame that the client has already: drop a repeat by the notification `id`. A value that is not a positive integer starts the stream without a replay.

### Behaviour

The server writes a frame only when it creates a notification. A status change and a deletion produce no frame. When a client reads the stream too slowly, the server ends the stream of that client rather than drop frames; the client reconnects with the `id` of its last frame and gets the missed frames by the replay. Use the list operation to read the notifications that the wallet holds already.

This operation takes no filter parameters. The server ignores `status`, `limit` and `offset` on this path. Use the list operation to filter notifications.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"One-time ticket for a client that cannot send the `Authorization` header, for example the browser `EventSource` API. Get the ticket with `POST /v2/config/sse-ticket`, sent with the `Authorization` header and the body `{\"path\": \"/v2/config/digital-wallet/openid/notifications/sse\"}`. The ticket is valid for 30 seconds and for one request to this path. An unknown, used or expired ticket gives 401. A request with the `Authorization` header needs no ticket.","in":"query","name":"ticket","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"The `id` of the last `notification` frame that the client got, for a client that opens a new `EventSource` and cannot send the `Last-Event-ID` header. The server sends the notifications after this `id` first (see Replay).","in":"query","name":"lastEventId","required":false,"schema":{"type":"integer","example":4711}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The `id` of the last `notification` frame that the client got. The `EventSource` API sends it itself when it reconnects. The server reads the header first and the `lastEventId` query parameter only without the header.","in":"header","name":"Last-Event-ID","required":false,"schema":{"type":"integer","example":4711}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server opened the Server-Sent Events stream. The response stays open until the client closes the connection or the server closes the channel.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Cache-Control</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The server always sends `no-cache`.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"text/event-stream"} value={"text/event-stream"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

The `Authorization` header is missing or not valid, or the ticket is unknown, used or expired.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The server has too many open event streams. Try again later.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 503,\n  \"errorDescription\": \"Too many open event streams\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List notification
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-notification

---
id: config-list-digital-wallet-open-id-notification
title: "List notification"
description: "Lists the wallet notifications for OID4VCI credential lifecycle events. You can filter the notifications by read status, by notification type and by a search term."
sidebar_label: "List notification"
hide_title: true
hide_table_of_contents: true
api: eJztWW1zG7cR/is7+FJp5kiRkmzZnEymquSkTFxZE8n2dBxNDzzskYjugDOAo8Ro+N87Cxx5LyQlWW2+NP1iizhg8WBfnwUemECbGFk4qRUbsffSOgtuhnDHswwdKO1kKhNO3y2k2sCH8fnxp7MxJAYFKid5BplMMVkkGQLOUTnbh3/qEhKuIJWZQ+MFtiVNFmCQC7COu9JG9Ls5AdyiQOBK0AcOFrlJZuDQ5P1f1a/qeoYQh8HYj0LOXTLDAL2BzIvZi+eJi/cj/zHj1sHno7PurPA1P9cJxEIn14sC4zAmpC0yvgDFc7Sg0+4eiVapnJbGA488aJohrS3R+FVrzBbNXCYIPLvjCwtWm0rbG8qJy0Jwh+LUxREovEPrIJXGuj6Ew2vjPhiBJoaCG54jqXnGLSgNmKaYOCAtzqQFXWDA1mcRW/8YCzZiAToZ/VxOpePZZ2/1DwWqsbhoYGIRW29j2ejLQ8dvLsp8goaUYzDRRlhwGuytLLzLFHwqVYAAp6Bwyp2cI2gDpSIv4JMMYc6zEiHlWWZhwpNbkhAPYgItaYuvJZoFixgplI2YTlOLjkXM4NdSGhRslPLMYsRsMsOcs9EDI7uyEZPK4RQNi5jAlJeZY6NBxHKpZF7mbDRYLqOHldhM5tJ1t2yf9R/8nhaC2nZmg640Cgr0p8b+SwEOA6r2zj+EaNoeSWttVjG1S3HhK9sCwzoj1ZRFDBXp5QsjaSxiQSy7+QZETycJH3S7MDblUSQ+C229178KVCJ8bAzy5BZFe8jgXG8M4n3hzbXtvFd1IiJrV+nNoC0zRwffpXO/7Fm+UB1r297aONAU8z6oKG0Eb0Ox9sA9bpNwdvIHWh9+7e/0hlUe+RZwtc5pBxYxbhN20/DeML5c3pBQW2hl0ZKYw8GA/muf67quNuE8W1IiwU+0cqgcCeBFkVWfDn6zJOVhE6ye/IYJxXJhKOs5GTA05TZmc2P4ZqxftBzbZ1TS+tcSrUMRQtwnZL8cpAXMC7eAuxmqZhmd6Uz43LxxKukwt9tQt4GcbivI3g+4eka09TfUIMU2u7Y3/ajk1xJBeqGpDMmuaxsSjfc8LzKS9FoM+DA9wt7h5CTpHSdveO9tOhz2jvjkVfJanOCb9C1bRpsR/iQYmrXaf3XgljLCQSHezAMx7AlM0RgUvixzlSBIBYXRU4PW7ketVT5RxLBHO5Hh0ABPbpW+y1BMUXTqf2dxlVKq5RUJqAYfX1nlnWplw5bVBx/Df1iyaxpxQ84Wg/2CGfGT8TPcaLzhPwatLk2C4GbcbXgUhRGf6NJF3sErXF3aVXtl2wMnJ2KYHvPD3pvkCHvH/O2w9zZ9ddgbiKPkNZ7w4eT4VfdAZ3VqaUO/5ItMU3Hd4vfQSFxTOUdLoRjygE4hxLENJyQv8gIa9o5b1j9rkkgbexYZB++JQaDjMrNhx8CTpIVYlVkW7041RcDuWZ/CD6mnba1sRzWmm3a4EJIw8OyykS+cKXF5s4xW7OFJm/9SE5HtyiMeeNc2O9FXmlgtiwPviMOxAx+uySxYdK3pRBf9/EDBeVt2wpXSDqa65pYr8bsJT9OtqrGlj57AzBtaCFxwWwK9BydztI7nBexJgp1oJex+bbcWzjtuodqg5dbDk+OTwXD4ejBYRmzdG/xRCHyTlGtB4bUTx7LJGL5QQdmS1h9LHNtjMKoZaq3p5pmJl7G6pfB8IMva/r12ZyedN99lPb9bCZPSGFTukk9xBydvKvQszPalH9ZKr/WzjJjTjmfjTl3fJe+aJjd6Cc8HgM+5zKgtaso+fLUSTlhfIpxAU3dlURCZWTU76x2OllHVAT0t+6IDedXytLRB3jrj9tLgXOpW3phonSFXm8VCCXIItCB92jD4FwscikrCxhaeqoZdLvDevXwHhfduQ7rPe57HduvCFFdpeZONd0heN1JUt7Feu+bNkubOkAvfZj/Qr+PAmZ/Nfps7oTHanGnhz0R/nzdOcRM9wZTr1du8Ya2jY5+TNsRv6xrW2fRvXIBURenq2wu2XPrTbzYH2ky5knbNDUpFZExFUOm9KnxVis+k3aQUnmp39Tr8E+v1o+Klm2kjf/eMsK2aV39qlxsrh0bxzN/WoQG/TUdHxIQwKY10C192Tgv5M9KfN5QrHJ/SJRmrLtUg3KrBnr9Xo85ln0Xs776zIJXk6GaaruOm/kKr4G7GRuxgfngQ7ucORJDTC45+oAtUUhy0/JvKpoe77XbuHHNdnYYqqcnYiM2cK+zo4EBgrnu8kH05NVy5vtRs8+rh0mhRJhXt2irmKQlXjrLcdNdyGz53gdzUar4ibwtOslJ2zWbDQHXDEexUX3GcVo6+yredxvpyDLe4AAoHouJNch+odkVf45acGMI2kJfWwQSpQKXyHgXcSTeDOGCEGPaUdqF3cYbLzOug4AnuR4D9ab8jdgTVwu8WujSkjt4tLr6PQxGRKtWrwOSJD0zMuSRF2rIotHF/rZW3Pr/8sR5qa71psI5a1ouoSZ5LQd0NJJpiySFI+j9H5UJOXnXl3r19OfyERqbS3+uerXscC+NV871XdfD7nqtvX3hp0K63WMfO5T4hcjrRoSGSFsiEqGiNrWrF79WFjdOhA498VxQagzntsIAqphodpYXSevM4rgQ3wvb8eSVXDtJM39lg2krTHi29I3w6g72fPl/vRzB+d/0DXJ33fvp8DZ/Owm7jqw8wfDMYHvVe+ceFg/z8fbOLTbXJufPlKZMJKusz38pzC57MEA77gw3T3d3d9bn/3NdmelCttQfvx2fvLq7e9WjNsqa/tTlJWUIn5dp6LGKUNoLZDweHx/2j/pDWFtq6nKsGHnoogA57Ee38u64Z/39K+l9/SqqSr8N7d1BkXCpyGu+lD1UN+8Lmh+HiNpX+iqBVx8JrlNroGy3VxJm2jgQ8PFC38tFkyyUNh9trX+GkpYivL6t3OuIf+za1VQu3VJ7qJyq/nI1YqIvPBv6tD02PQFl1ei9E8s0PT49AWXf3/2Us3/Dk9Ai6LRcYL8T5jKeix7S0ejF66e7/6WPRY9gab0Y1vBv6YXzp9jx4RZh9tIaFp0mCRdMNN9qKZZMO//jumi4kS0olTa5367le9UfzUlMtGrK7tC9AoH8b157tJd9RcfwZF9+vp4cvOxesqWaYTUqiFv7fFFavvA==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List notification</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/notifications"}></MethodEndpoint>



Lists the wallet notifications for OID4VCI credential lifecycle events. You can filter the notifications by read status, by notification type and by a search term.

The `search` term matches the credential type (`vct`), the last W3C credential type, the mDoc `docType`, the display names of the credential configuration, and the issuer name.

The service always sorts the notifications by `updatedAt`, newest first. The `sortOrder` parameter has no effect on this operation.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter notifications by read or unread status.","in":"query","name":"status","schema":{"type":"string","enum":["read","unread"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter notifications by OID4VCI credential lifecycle event type.","in":"query","name":"notificationType","schema":{"type":"string","enum":["credential_pending","credential_acked","credential_revoked","credential_expired"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Search term to filter results by","in":"query","name":"search","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Sort order for the returned records (ascending or descending).","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet returns the notifications.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>notification</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Notifications on the requested page. The array is empty when the wallet holds no notifications.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the notification.","example":"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9"}}></SchemaItem><SchemaItem collapsible={false} name={"notificationType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`credential_pending`, `credential_acked`, `credential_revoked`, `credential_expired`]"} schema={{"type":"string","description":"Type of the OID4VCI notification event. `credential_pending` (deferred issuance in progress), `credential_acked` (the holder acknowledged the credential), `credential_revoked` (the issuer revoked the credential), `credential_expired` (the credential expired).","enum":["credential_pending","credential_acked","credential_revoked","credential_expired"],"example":"credential_acked"}}></SchemaItem><SchemaItem collapsible={false} name={"notificationTypeRelatedId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the resource that the notification is about, for example the credential identifier.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>notificationContent</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Payload of the notification. The wallet gives an array of objects that hold the `credential`, `credentialConfigurations` and `issuer` details. The value is `null` when the wallet holds no payload.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`read`, `unread`]"} schema={{"type":"string","description":"Read status of the notification. A new notification has the status `unread`. The update operation sets the status to `read`, and a notification cannot go back to `unread`.","enum":["read","unread"],"example":"unread"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when the notification was created.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when the notification was last modified.","example":1747011600}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"notification\": [\n    {\n      \"id\": \"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9\",\n      \"notificationType\": \"credential_acked\",\n      \"notificationTypeRelatedId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n      \"notificationContent\": [\n        null\n      ],\n      \"status\": \"unread\",\n      \"createdAt\": 1747011600,\n      \"updatedAt\": 1747011600\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, or the wallet cannot list the notifications.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List organisation wallet units
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-organisation-wallet-unit

---
id: config-list-digital-wallet-open-id-organisation-wallet-unit
title: "List organisation wallet units"
description: "Lists the organisation wallet units that the wallet provider manages. For each organisation, the response gives the status of the Legal Person Identification Data (LPID) credential, the status of the Wallet Unit Attestation (WUA), and usage counts. The organisation must have the wallet provider capability enabled."
sidebar_label: "List organisation wallet units"
hide_title: true
hide_table_of_contents: true
api: eJztWW1PIzkS/islfzmQmiQwzOkUrVbHAbPKLssgwQwf5pBSdFcSL912r+1OyKL891PZ3emXJMAyc7qV5r5Autsu13s9VX4SCdnYyNxJrcRQXEjrLLgZgTZTVNIif4AFpik5KJT0X9H5JeXb3Oi5TMhAhgqnZHvwQRsgjGctIpHfY8jmWlmCqZxTOMk6dIUFPfFPFzTFFK7IWK1glJByciLjwMYZOoS9i6vR2T7EhvxHTKMtVG4Da5+UdHDiHPFXprB3++lkPwJUCRQWpwSxLpSzPbjpipwV1sEM57RV1BhzvJepdEsghfcpJb1/K6ZhycxlzHLmKcZkARWM9WRiyY2D5qSFlKxXo4KBZwVhnMpMNlYMQJuwbCHdzLOQ0ASL1MEc04J6MJrUdJkkmimZQJRXqyK7J8PqMGSL1NlSS2v2XGFU0H+K1kGOU+qJSOicjFfAKBFDEWs1kVN2ijM5lQ7ToNePOalR8rGhrvCe1S0ikaPBjBwZK4Zfnjoe9kGmjgzcL99g6dLIwVqVKLHOcjSlL3nlAD1i7NJlBFaz/gv1oPRClR8zdPGMLCjdMjgLL5nB3wsySxEJhRmJoUhzmVz7Y0UkDP1eSEOJGE4wtRQJG88oQzF8Em6Z83LrjFRTEQlSRSaGX4RUGDs5JxGJ9Q96zD0VJjjXD5SIu9Uq2q2pZ70ZUjmheBmn9L9Qz6LAr9FOobBwM22k9epoP7xVXa04Zj53Md9ceMmv/oQMWzi4bMRcrE1iwWmwDzKHiTYcYVIFXcIJKJoii8dxXihDmHAWKW0wwTS1cI/xA1MYD8Y7BfAJ4FVsS+VoSkZEokwkYjiIRCaVzNgUAy9P5fOcjLpHtmX9FR95YyvPrGUO2QVyMuu88iYGDwer1R3vDTXD8uqjwYD/tbm52ZKiAxOUPF/NmLdYK0fKMVnM87TMQf3fLNN+2uRU3/9GsU90htOlk4EzvT0f1vvQGNzU5EblaRVbHdJ5XBhDqkzTPr5TaX2loCx3S5CTbsA2yQBODVGjlkx8rHjhpaPMbhPOSZfyi51pvi3GbeM4W2QZmqV3+8M2V4VKfJnasFc7a2G6wKUFSyqxQHNiYpLSJNR3aSGw2XvWCD6ktySfTtRiRhVsaGe8VdTM/i8Suv5KHBM0EDKA9MAh2DYcB4sZBV9ItX4ocpigTL0Fq1zqA/ZVxYZfYpZ785brSlnPefFyR1Q2hf2k5CM4mXEtynLYkwosxVoldr/mlCVslu/Aiu0IOh6M6y0tZ5mhr0MdMt4wdd150S4Xnfr4KozYg3GzNo0hIyzxUjOwJDPooF7Yg/GrdtWL4L5wlaS7WFqS+wbe8dZiu91dFgV+W2/ZJfwbvWYHOe890tqCktO1S9mtMky0ydCFV38/3kzc2mHaKIC1hzZ6pBZn4VjPwZzMOh98k9NbBHecn5NhqiULjPtP2JzSLV+OohtZp0nfMbAwqGKPYJqHA5Y0tybVV3px3acwqKCEDVrR7TH2agCKL9twXAu2NzJb1EKstQ9v84mulToqYxAqalT3XA29qld1C1ZZ2a9wSq8IpNMGDiiNLxrhebiKhGPHGHWq+i56XS/yaABwjjJlPNqkffS+Is68voU4M82wlpOeVlChzPUJ79gp/cuXaV92WK6wZksbg1UkZmivDM2lbpWKe61TQrVBdqQSNjdZRlRuRob+ZgEhLylsHOHBbDjlkh7d209Q9Og2qDtTEDtZmwKrHxJynOE9xCrnKjwcsOSeD49Oo752y7sV75oRJr5tf+Kn4wC1Xw2Pm2eSMdqc6sTLw7/PGjLcRS9A6Xr3Nk9Y6+d4wBbeIL+t31wXsH9hAlLlBWu7HFOI1Wq1qeYNXF7V+g3kKjYVd/gdK+5TBTP+8DCirZr337VPjZQjo3iQRWZOBvwxHR2tImEpLoyvyl+exEkufyH+ece9sMMpT9VEOY+rUM6eH8mdHX8+3RdR1YtdlQ7KusnIzTSP9KYUIt/NxFD050f9MOPrJ4HgQXDuvs5JyaQfng4qV+83A6JceuAbVcFcs0zbZn5nlOlSZIahJhVDMXMut8N+P6FMH2Aue3JqULme1GJzsnJldFLEPgp3kHmJwrXjXDfdtd2Gz11G7mpbXLNLBk+qLFI39uFFOTAJxqyHNCdlNFT1v83YydUIHmjpGwIGHvEGTiph1LhFZwzhmDCnvicuURP5SElo8seBRxjDntIuzLCdQZl6HeQY034E1Jv2OmSHUG78YakLw+o4eKDlj+NQVKSa6Cp6MfbRSxlKVqQt8lwb989aeWv55U/1q7bWmwbrqGW9qUqzXCR5lpmSI5D8PyNVdgilhkIM+JL42QM3P1JrIDoYVZh176MPltG+n79v33hlyK6PWAfY1T5z5HSsU9+SSAtswnALYMuK8UcFw3XA/BHMdJqEewePKZdQxlurayisN49DlaBJ7IGXV6JyMEn1opzflJr23N6+O4XPp7D38+3NfgSj85sPcH128PPtDXw+DaeNrj/C4T8Gh+8O3kN2puN+dnbRbMlDl+E7xVTGpKxPj5Xn5hjPCI56gw3TLRaLHvrPPW2m/XKv7V+MTs8vr88PeM+qBsC1OVlZiY6LtfUCzLbB7EeDo+Peu94h7821dRmqBj98EbF7VtYNrUaV+f+91vd+r1VmakePrp+nKBV7mHfpp7IYfhHzozAMnkjf/rYKYrgaU5IRTaco8qedZfEuEjNtHZN/euLW55NJVyt+HebqvlhK61W9no3vdOO/8uXZVg0/cJ1sN+OekBiKUKTfIPpf5DbsGXmbI4avFnfrbdYzh28ZhryRh//ufdZzIlTXWm9k/M9eTj3nuuWQoubkjh+MhwgelFfo3Ydy2HQSx5Q3d230OKsmJP/p/KYcx7Yx5YPHlOUPpl59UssG7S68DCzwX1ba1i0/cBH+hZY/rpeHLzs3rCFtWM0K4oHBfwAjcgz1
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List organisation wallet units</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/wallet-provider/organisation-wallet-units"}></MethodEndpoint>



Lists the organisation wallet units that the wallet provider manages. For each organisation, the response gives the status of the Legal Person Identification Data (LPID) credential, the status of the Wallet Unit Attestation (WUA), and usage counts. The organisation must have the wallet provider capability enabled.
The service replaces an `offset` that is less than 0 and a `limit` that is 0 or less with the default value. If `offset` is larger than the number of results, the service returns the last page.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Filter by Legal Person Identification Data (LPID) credential status. The service compares the value exactly, so an unknown value matches no organisation.","in":"query","name":"lpidStatus","required":false,"schema":{"type":"string","enum":["inactive","active","expired","revoked"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by Wallet Unit Attestation (WUA) lifecycle status. The service compares the value exactly, so an unknown value matches no organisation.","in":"query","name":"wuaStatus","required":false,"schema":{"type":"string","enum":["unauthorised","authorised","active","expired","revoked"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by organisation name.","in":"query","name":"organisationName","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet provider returned the organisation wallet units.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisationWalletUnit</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The organisation wallet units on the current page. The list is empty if no organisation wallet unit agrees with the filters.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"organisationName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the organisation."}}></SchemaItem><SchemaItem collapsible={false} name={"lpidStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `inactive`, `active`, `expired`, `revoked`]"} schema={{"type":"string","description":"Status of the Legal Person Identification Data (LPID) credential. The value is an empty string when the lookup fails.","enum":["","inactive","active","expired","revoked"],"example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"lpidExpiry"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the LPID credential expires. The value is `0` when the organisation has no LPID credential."}}></SchemaItem><SchemaItem collapsible={false} name={"wuaStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `unauthorised`, `authorised`, `active`, `expired`, `revoked`]"} schema={{"type":"string","description":"Lifecycle status of the Wallet Unit Attestation (WUA). `unauthorised` means the wallet unit is not authorised. `authorised` means the wallet unit is authorised but has no Wallet Unit Attestation yet. The value is an empty string when the lookup fails.","enum":["","unauthorised","authorised","active","expired","revoked"],"example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"wuaExpiry"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the Wallet Unit Attestation expires. The value is `0` when the organisation has no Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"issuedCredentials"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Total number of credentials that the organisation issued."}}></SchemaItem><SchemaItem collapsible={false} name={"verifications"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Total number of verifications that the organisation performed."}}></SchemaItem><SchemaItem collapsible={false} name={"lastActivity"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Time of the last issuance or verification activity of the organisation. The value is an empty string when the service recorded no activity."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Page details for the result set.

</div><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"organisationWalletUnit\": [\n    {\n      \"organisationName\": \"string\",\n      \"lpidStatus\": \"active\",\n      \"lpidExpiry\": 0,\n      \"wuaStatus\": \"active\",\n      \"wuaExpiry\": 0,\n      \"issuedCredentials\": 0,\n      \"verifications\": 0,\n      \"lastActivity\": \"string\"\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not a wallet provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Performance statistics of a wallet provider
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-performance-statistics

---
id: config-list-digital-wallet-open-id-performance-statistics
title: "Performance statistics of a wallet provider"
description: "Reads the performance statistics of a wallet provider. The statistics give the OID4VCI issuance totals, the OpenID4VP verification totals, the monthly issuance history, and the counts of individual and organisation wallet units. The service caches the statistics and refreshes them in the background. The organisation must have the wallet provider capability enabled."
sidebar_label: "Performance statistics of a wallet provider"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/isDfmoA+SVO2jsYRbE5J7fn3d422KTth24AM9TYZiORWpKy6w383w9DSrYky06D3gIF6i+JLInz+swMZ6hHFqMVRmZOasWG7HfksQU3R8jQTLVJuRII1nEnrZPCgp4ChyVPEnSQGb2QMZou3M5rL83kAj2Rd+PL8w+jMUhrc0/JaccTG4WHGSp6fg0LNHIqBSchaq+kWrl5stqun0vrtFlFwFXs3xA6V86LJVUsFzLOeeIfajPjStpAsxA4V9LZQlo0CykQBBdzDBpXFCACBqcGbfEwBan8S/dcPMyMzlUc6NTYpLl1MOeF8g0rgeAZv5eJdCtAxe8TjLt/qD9UXRoFBl1uVFWaqdEpSGeDsLCcywRBuicljMBqf2vBkxytp36PwGGKS0ilyh1a0EncZRHTGRqvxDhmQya0msrZW2ndpZxJx5OPXhfvsfh6i4ybjZAsYgZtppVFy4aPbNDv0z+hlUPl6JJnWVL4uPfZEtoemRVzTDlduVWGbMj0/WcUjkUsMySRk4Fa1spy+NhA7+1B3Lb4hDQ/zFnL+HwhvPxJ8m7Khp92Za0LMS6xSiBqQXZ3h4e/PzIYo3KSJ7errLgf+EjlcIaGRQy/8DRLkA1PXza5/pan92hITbEhBETAdtk6CixIMoy3jJ5i8mo/E+lJVXhV2Hyo6PwEi3/s51C1HBFfE8D+zKXBmA0/tdtsr56tkt2t75rs9+Qr78qD6arEV0vWsZArCv9W+JU22wpbwuc/IdM9B3n/LbJlBQFyLxiLTNqFKy7mMJWYxDDXSUzKAjeGr2Ap3Ry0QjAotIkptEJGjkDhEq2DqTTW7QJa5Magcl6eCgA81R2pL7njMNXBQMXKwCZk2CBLEG0rDDGVDlPbljyeF5CeOVEOTHe0SRtqWGekmlVhzD5zlXOz6gz6g1ftbikBEnPHozJV+0TlYPLas+gonuKbzusVcvNm0oaN/3NmKMUo9P4b0kQlP5Qpo53n35AzmpwaCSR4dY+Jn5tI1hFLuHVn3tX26yGPFHsFMogAnAVx7RHeR3h/d/B+9c3wfnWE9xHe3yu8TwffjO/TwRHgR4B/jwAXeZon3MkFHnvZH6OXvS0a0wUa4ElSJqba9CvWaEFpB4IngvBBkytpIcABnI75yk+RcIFmFYZtIC1M+pNdNWpdX31DXN8/NNJtDZwtihxqa4su9hva7+3YMMy43ivpnhMio80AsjpkpN+Usx+kivcEyROAHfT346k2ziQluCgj+wDF0/Ovoxj6fk5TQxlDsAqQWeDCOfQzNa08W4ML/UDOP8T3QOQV6w+MZ1P+4Meb0oYhZpiFTrwBJ36GaWEStG9BZLDzxjxbgVtQtvUjIaUyTK6Z5jCWqvA7oumIpgNp6Svw1GBfTKKfHBjuSWl70XnXZNQ+bL9b03u78/bStuHYAuMDh0cE3TnyGA3hlsidP/OUoComGqPNSMfkCX99WZHt7qm5/nb1Qbid9/vrFvIHd9v/4rSNzHIHGTc8RYeGrdd7zFeDhgzFePeArcVwpz+w4d4rnru5NvIvjHdM8/KHxtRYOTSKJz4u0YBn07DROmIWRW6kW/mSdJHJX5EufSJzfGbJFsXJX5myX5TnH6MTFrHi5nUBULJNim6u6fBwht40nLpS1lsMeuE0sRcHgp0A7p7OUMm4F351Sqj3bPVIMShhvZSNHhxTXejIIpabhA3Z3LnMDnu9GFPd4ZnsypnhynWlZuuoSeDa6DgXPuz2kHmKwo3jM6lm+5bb8LgpyN3W+DeEwQCd0gXbyUO4QcmcaHrvsYhRD86G7KKAv8f0zibi4noMD7gCChKqEQH6oRSGulfUpUmNzgQCm3CMfY+QGZzKL1RRqYRPgowwgRdKu3DE7QyXibdBxgWeRIDdWbdBdgjFwtcrnRsyR+cBV2+KAivVVJfhyoUPV0y5JEPaPMu0cT9tjbfRX/68vVW3etVhDbNsFpV51QIHoSnCHIKk/ymqsCEpLRRA70cwoeGic3uotGOwaZFfFIeHJ5XTwubCa4N2w2ITUdcnJJHTQid+wyItkAvDRwK2KBF/FWMDp0PDGvkjsWjbma+gCLDaWCO33j2Oq5ib2Ha8vpIrB9NEL4vdWWFpL+3HsxF8GMGLXz7enkQwvrr9N9xcdn75eAsfRoHb+OYdnP6zf3rWeQnppRa99PJttTkLYyNf7RMpUFmfD0vkZv4bhkG3v+O65XLZ5f5xV5tZr1hre2/Ho6vfbq46tIb6cumSGga8sWIt8o33WMQobQS3D/qD8+5Z95TWZtq6lKuKPNdf/5lLM84qNeb43cyP+t1Mka4dfnG9LOFSEcw8rh+LEviJLQY04/BFkDBUK4Ph0xslaR/TKIVU/yr774jNtXVE7/Hxnlt8b5L1mm7/maPx1TtiC258ovG1vCz6vno+UHVhF0JgRjy9Zr7MNLZG62ol//nqlvqdvH6Kn8kHX5mKi0pTy9WqQrtZpIII9JdqaeuS1xTKv+Lqzeb18GTvgk1hDG+T+alR+R++m8Al
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Performance statistics of a wallet provider</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/wallet-provider/statistics"}></MethodEndpoint>



Reads the performance statistics of a wallet provider. The statistics give the OID4VCI issuance totals, the OpenID4VP verification totals, the monthly issuance history, and the counts of individual and organisation wallet units. The service caches the statistics and refreshes them in the background. The organisation must have the wallet provider capability enabled.

The service can return statistics from its cache while it refreshes them in the background, so the values can be a few minutes old.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the performance statistics.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>performanceStatistics</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The performance statistics of the wallet provider.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>oid4vc</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Issuance and verification totals.

</div><SchemaItem collapsible={false} name={"totalCredentialTypes"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":15,"description":"Number of credential types."}}></SchemaItem><SchemaItem collapsible={false} name={"totalIssuedCredentials"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":16,"description":"Number of issued credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"totalVerifications"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":7,"description":"Number of verifications."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>totalCredentialIssuanceHistory</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Monthly credential issuance and verification history. Each field holds an array with one record per month, newest first.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>currentMonth</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data for the current month. The array holds one record.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"month"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"january-2026","description":"Month of the data, in the format `<month-name>-<year>`."}}></SchemaItem><SchemaItem collapsible={false} name={"totalCredentialTypes"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":15,"description":"Number of credential types in the month."}}></SchemaItem><SchemaItem collapsible={false} name={"totalIssuedCredentials"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":16,"description":"Number of credentials issued in the month."}}></SchemaItem><SchemaItem collapsible={false} name={"totalVerifications"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":7,"description":"Number of verifications in the month."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>last3Months</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data for each of the last 3 months.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"month"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"january-2026","description":"Month of the data, in the format `<month-name>-<year>`."}}></SchemaItem><SchemaItem collapsible={false} name={"totalCredentialTypes"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":15,"description":"Number of credential types in the month."}}></SchemaItem><SchemaItem collapsible={false} name={"totalIssuedCredentials"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":16,"description":"Number of credentials issued in the month."}}></SchemaItem><SchemaItem collapsible={false} name={"totalVerifications"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":7,"description":"Number of verifications in the month."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>last6Months</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data for each of the last 6 months.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"month"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"january-2026","description":"Month of the data, in the format `<month-name>-<year>`."}}></SchemaItem><SchemaItem collapsible={false} name={"totalCredentialTypes"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":15,"description":"Number of credential types in the month."}}></SchemaItem><SchemaItem collapsible={false} name={"totalIssuedCredentials"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":16,"description":"Number of credentials issued in the month."}}></SchemaItem><SchemaItem collapsible={false} name={"totalVerifications"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":7,"description":"Number of verifications in the month."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>last12Months</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data for each of the last 12 months.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"month"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"january-2026","description":"Month of the data, in the format `<month-name>-<year>`."}}></SchemaItem><SchemaItem collapsible={false} name={"totalCredentialTypes"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":15,"description":"Number of credential types in the month."}}></SchemaItem><SchemaItem collapsible={false} name={"totalIssuedCredentials"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":16,"description":"Number of credentials issued in the month."}}></SchemaItem><SchemaItem collapsible={false} name={"totalVerifications"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":7,"description":"Number of verifications in the month."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>cumulative</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Totals over all months. The service does not calculate this object today, so every count is `0`.

</div><SchemaItem collapsible={false} name={"totalCredentialTypes"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":15,"description":"Number of credential types."}}></SchemaItem><SchemaItem collapsible={false} name={"totalIssuedCredentials"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":16,"description":"Number of issued credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"totalVerifications"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":7,"description":"Number of verifications."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individualWalletUnit</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Counts of wallet units of one kind.

</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":120,"description":"Number of wallet units."}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":114,"description":"Number of wallet units with a valid Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"revoked"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":6,"description":"Number of revoked wallet units. The service makes this value from `total` minus `active`."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisationWalletUnit</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Counts of wallet units of one kind.

</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":120,"description":"Number of wallet units."}}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":114,"description":"Number of wallet units with a valid Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"revoked"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":6,"description":"Number of revoked wallet units. The service makes this value from `total` minus `active`."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"performanceStatistics\": {\n    \"oid4vc\": {\n      \"totalCredentialTypes\": 15,\n      \"totalIssuedCredentials\": 16,\n      \"totalVerifications\": 7\n    },\n    \"totalCredentialIssuanceHistory\": {\n      \"currentMonth\": [\n        {\n          \"month\": \"january-2026\",\n          \"totalCredentialTypes\": 15,\n          \"totalIssuedCredentials\": 16,\n          \"totalVerifications\": 7\n        }\n      ],\n      \"last3Months\": [\n        {\n          \"month\": \"january-2026\",\n          \"totalCredentialTypes\": 15,\n          \"totalIssuedCredentials\": 16,\n          \"totalVerifications\": 7\n        }\n      ],\n      \"last6Months\": [\n        {\n          \"month\": \"january-2026\",\n          \"totalCredentialTypes\": 15,\n          \"totalIssuedCredentials\": 16,\n          \"totalVerifications\": 7\n        }\n      ],\n      \"last12Months\": [\n        {\n          \"month\": \"january-2026\",\n          \"totalCredentialTypes\": 15,\n          \"totalIssuedCredentials\": 16,\n          \"totalVerifications\": 7\n        }\n      ],\n      \"cumulative\": {\n        \"totalCredentialTypes\": 15,\n        \"totalIssuedCredentials\": 16,\n        \"totalVerifications\": 7\n      }\n    },\n    \"individualWalletUnit\": {\n      \"total\": 120,\n      \"active\": 114,\n      \"revoked\": 6\n    },\n    \"organisationWalletUnit\": {\n      \"total\": 120,\n      \"active\": 114,\n      \"revoked\": 6\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not a wallet provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List presentation definition templates
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-presentation-definition-templates

---
id: config-list-digital-wallet-open-id-presentation-definition-templates
title: "List presentation definition templates"
description: "Lists the presentation definition templates of the platform schema repository. Use a template as the starting point for a new presentation definition."
sidebar_label: "List presentation definition templates"
hide_title: true
hide_table_of_contents: true
api: eJztWutv20YS/1cG+ynG0ZLspEBPKIpzrVzq1pe4tRMfkBrhmBxJG5O7zO5Ssmrofz/MLl96OH4APQR3yoeYIrnz/M1juXMnUrKJkYWTWomhOJXWWXBTgsKQJeWQH0BKY6mkv3SUFxk6sqDH4cUM3VibHGwypRzBUKGtdNosevDeEmCzBDCQtg6Nk2oChZbKwVgbQFA0v49n7w/1h7rghWRmZMCQK42yoBUBKWcWngRhMm1YRTCXbuq5KZqTdTAjY5msVtmiB0wtk9bBVGdpkGp0/NspfCnJLDo6okoBM6tBZymZzgM3ReeXzcjIsSQDSkOm1YQMYJJQ4WwPfidMIc7JYYoOe9KOki/Zb8wiBqfBUZYxjRywQOMqNaUFUmkwDWZzXLAUdk7GBp1+vrg4g8PBoAeXU1LBoMEuCSqlHRjm6m+vOyQC6RrroQLKC7eAuNEqBjQGF15rpSEucCKV90YM+vozJa5xxZZnARBd8aUFFqjyuUrRpNCuq0nCSe2GWI/HllwcQZzJXPoLpx1mJ45yy7+maM8MzaQuWViV+jtv6dbFXrKvGVyPARkoOboKNU6DJYL5VHaQY2GhSzYllJZ68E5liy6EvQviFcKWHJOKnSkphomcMW66cGJ0sg3idE2a+/EuIqELMv7JSSqGItFqLCccniM5kQ6zS8wycu8KUifpWYfOqCFzUWskIlGgwZwcGSuGH+/Wgv5tmV+TYZEMJdpwPGiwN7LwkrcO68ERKJqgkzMCbaBUDDW8zghmmJUEY8wyC9eY3HiDDOKeiIRkFt4QIhIKcxJDEfwsImHoSykNpWI4xsxSJAJmxfBOuEXBr0rlaEJGRCKlMZaZE8NBJHKpZF7mYjhYLqO7mqwHzTrLVV3/hbe8ENQ2nUNoQEFea+o9V8CDwXJ5xWttoZUly28fDgb8J9HKkXJ8iUWRycRbtv/ZsnR3m9RDjLAHDQPCyUCtQSv/WNXw7MHEXeMxKY0h5YKuPiWG8OcQ9plh/tQE4/3NsbpNg6eJCWOj8wcLzJaqsC3nj1erg88Vr/lOYigl5SRmdWoImQghDtxClsE2qTSZEH7SbgpoCGJVZlncsda6nDBFzoQwlhlV1kdXMWyLG+ZMCnOKffq5JpCBni9Ubq7ByZxsBNeUYGnpPl5eAa6NzhCx7vdWtu5LawXuGcVrA6QhKhsgWGekmmwA4cQ7wJfQqqNoICDvsSfDjG4xLzKme0oTzM7IWE6VgVaIqhE6FMtIVDB4WJRzylE5mXSB0xXosXhrmoN1t6wKftAb9AYsYJr8zab7n+fu4bC5aMKjCuKT1xf/hPPR/i+XF/DheBPQvQ233J9jME19EGJ21lnBdW1djOOWTbfGSbtFAN8FSld3fxtV8CudX4ipe0AobVVzg1tCCeKbzwhHaRtzLSNR89tMrqP614ygfmsDtl+xhYgeSOwy/S9EzOXk8vbLn8681frN3w9///fs9vzicsaatxJfeBEeEqWDA36xRr603ab/xht3AwezxH3yTuPOzt9hEvUtaJomnbT341rjZA2AT0wJj0tNP5c5qv2myeFFW/gzjS3sIfCHVQGAJYAXp2cnoz0WpChNoe3TZanWbc9QKdrpteZu20713NYOuXU1PhrncGnxkO9EVkeWa60zQrUhTNXrNiHWFMt6C7DSZ8vVfjgAQW9trAPdKRl6etfcdQHT8VqdJ9hi9BmabcAYEM6d0WoCx6V1OicDR6WbMoPKwy/Oj4/2AJ0j66q+uVM2+FWYGxk2kQSYpobs5m5aKohXozFe0dC3o0v+F4nPc/dplnyqm8gnVpDLl8dcObiAfIvVY5fbd7l9l9t3uf3/NLfnVn/KU508Z2tw/g4Ovh8cvNz/DvKRTnbpfZfed+l9l9536f3bS++fZgfPyPD1B6cDmKGRqFwtyyNS//ZvWdJCldUWwc/MatsHxL+mdGycmuyKxq5o7IrGrmjsikZTNJbdU8mPAdrtIcfVskk5/jTPg645wn3EuRxOOK0Eh7J6TXbz2OmqlhHOaKNolC5YU7rHnReu5sPqZHj78er2Q+stQxmVgHyGXVBaBUk4nfUVYxCvKJJkmBcM2lBTPBlWGM3EexDVyhzCil8Gy6g6d35Y5s3D5840jfLHce1ZbFfeg8Eq0wPm2kr0THM9qngcvlpGojN28cSYqkc6Nuw52AZvz4nHOZ7IJdeGOoqNdZbpeQXM6iB/NVWsxVAzj1BPEHRsu6p9K+HVOpH2TP7KB+la79aJG2kdpY+bsmLRp4Spn9y4Y7KvBgdPGiToikjGaHOsU04Y/nrUkfHqoV6lXb0Nb42BXw0YnRvkt1S8toL+hClIVZQ8jFBNqogq162a8b3C0k21kX9SumGa7544Y/G/ZZoT5cgozGqYeTZrNlpGwlJSGukWfhDoqJC/El9e8cCKwwnPB4lqxAjCjBG88FNGo1cfjvdEJD5UA29slJzcVPN40sRHT4FuKoaiPzvsh3mlfhoo7c89pb4uSMm0b9PPc9fvYn+/xX6/jSMWllXZNrQ0olxXmopIlCYTQzF1rrDDfj+lXO9jIXtyYlC5ntSCp4TWB1B0WiY+2u4h8xCFc8d1dXLfchserwty1brgnJEYAFQ7okEChhvVMFPwYTtAdVQFQSjq60g4OjuBG1oArjQq3W1T1X3EK3S4EWM2kJfW8fxJYWgsbymtmrUgI8TwQmkXxk+cQZl5GxSY0F4E1Jv01sgOoVr4w0KXhs2xf0OLH+OeYDhyq1EHLSY+aClHyYa0ZVFo4/7RGq/RX75pb61aveuwNbM0i7hbmcnUz+klmuOMt1L8N2+ScWWhAH3fBAXg+268bTEtnFhbokoIXrzzMXKy52drti9cmXpq4upsjyVyOtGZZS9JC+xCUrzGgjYTVJUx/ZyatLakyI+URJ6ZH0JdQBVtnc2KhdJ691Tjl3bf6+s/FYwz3it411aW9tJWx4Evfrm82IvWxksCt/WPC/18dLq59/WlK5MJqbDdqZFbYDIlOOwNNlw3n8976B/3tJn0q7W2f3py/Prt+ev9wzAt46TLVjDgjZXqpGy81+mHh+JwcPiq97J34DthbV2OqiMPj1Q+XIbXQ6xTZHYz07uZ6d3M9LcxM13VTv700S8ylIpj3ieZu6o5+ShmhyKqxqk5qlcalDB2rSS3lr5J8Y3e1jaFubUNfySm2jomf3d3jZbem2y55NthCtm3L9JyOm8nie9NKH/tPPZWG91w79Fug/xyMRSh6Xm04E8drv6KKPVGrJXkin8YX0Z9v1o3tt64YdGRTyKdVRvt/7LbtL55fcEfp0vGRbfvuvF9V3XB1OtHatGhvd6CBRH4fzba1iU/cKH6lRY/Nq+HJ/cuaNq+8DYbiPeW/wGw02jY
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List presentation definition templates</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/presentation-definition/templates"}></MethodEndpoint>



Lists the presentation definition templates of the platform schema repository. Use a template as the starting point for a new presentation definition.

The server returns one entry for each template, with the newest version only. The list holds the DCQL query templates and also older templates that the verifier no longer accepts. Read `metadata.isDcqlQuery` to tell them apart.

This endpoint always answers with HTTP 200. When the server cannot read the schema repository, it returns an empty `templates` array and no `pagination` object.

The `pagination` object of this endpoint is not the standard pagination object. It holds `offset`, `limit`, `totalItems`, `hasPrevious` and `hasNext`.

Read `metadata.isDcqlQuery` of a format entry to see which templates you can use. Only a template with `isDcqlQuery` set to `true` gives a DCQL query for the `dcqlQuery` of a presentation definition.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server listed the presentation definition templates.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>templates</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation definition templates for the current page. The array is empty when the server cannot read the schema repository.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the template in the schema repository.","example":"LegalPersonIdentificationData"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Semantic version of the template. The server returns the newest version that the repository holds.","example":"1.0.0"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dc+sd-jwt</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Template for the IETF SD-JWT VC credential format.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>schema</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential query for this credential format. Use it as the `dcqlQuery` of a new presentation definition when `metadata.isDcqlQuery` is `true`. The value is `null` when the schema repository has no file for this format.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential query for this credential format. Use it as the `dcqlQuery` of a new presentation definition when `metadata.isDcqlQuery` is `true`. The value is `null` when the schema repository has no file for this format."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>metadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Descriptive metadata of the template for this credential format.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the template in the schema repository.","example":"WgWxqztrNooG92RXvxSTWv"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential type that this template asks for. Use it as the `vct_values`, the `type_values` or the `doctype_value` of the credential query.","example":"LegalPersonIdentificationData"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the credential type.","example":"Legal Person Identification Data (LPID)"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable purpose of the template. The dashboard shows this text in the template list."}}></SchemaItem><SchemaItem collapsible={false} name={"isDcqlQuery"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `schema` of this format entry is a DCQL query. Use only a template with `true` here for the `dcqlQuery` of a presentation definition.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"isScaCredential"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the template asks for a Strong Customer Authentication (SCA) attestation. The server then writes the address of the platform in `credentialType`.","example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwt_vc_json</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Template for the W3C VC JWT credential format.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>schema</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential query for this credential format. The value is `null` when the schema repository has no file for this format.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential query for this credential format. The value is `null` when the schema repository has no file for this format."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>metadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Descriptive metadata of the template for this credential format.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the template in the schema repository.","example":"WgWxqztrNooG92RXvxSTWv"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential type that this template asks for. Use it as the `vct_values`, the `type_values` or the `doctype_value` of the credential query.","example":"LegalPersonIdentificationData"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the credential type.","example":"Legal Person Identification Data (LPID)"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable purpose of the template. The dashboard shows this text in the template list."}}></SchemaItem><SchemaItem collapsible={false} name={"isDcqlQuery"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `schema` of this format entry is a DCQL query. Use only a template with `true` here for the `dcqlQuery` of a presentation definition.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"isScaCredential"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the template asks for a Strong Customer Authentication (SCA) attestation. The server then writes the address of the platform in `credentialType`.","example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mso_mdoc</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Template for the ISO 18013-5 mDoc credential format.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>schema</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential query for this credential format. The value is `null` when the schema repository has no file for this format.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential query for this credential format. The value is `null` when the schema repository has no file for this format."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>metadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Descriptive metadata of the template for this credential format.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the template in the schema repository.","example":"WgWxqztrNooG92RXvxSTWv"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential type that this template asks for. Use it as the `vct_values`, the `type_values` or the `doctype_value` of the credential query.","example":"LegalPersonIdentificationData"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the credential type.","example":"Legal Person Identification Data (LPID)"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable purpose of the template. The dashboard shows this text in the template list."}}></SchemaItem><SchemaItem collapsible={false} name={"isDcqlQuery"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `schema` of this format entry is a DCQL query. Use only a template with `true` here for the `dcqlQuery` of a presentation definition.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"isScaCredential"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the template asks for a Strong Customer Authentication (SCA) attestation. The server then writes the address of the platform in `credentialType`.","example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>mso_mdoc_v1</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Template for the version 1 variant of the ISO 18013-5 mDoc credential format. The server returns this property only for DCQL query templates.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>schema</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

DCQL query for this credential format. The value is `null` when the schema repository has no file for this format.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"DCQL query for this credential format. The value is `null` when the schema repository has no file for this format."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>metadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Descriptive metadata of the template for this credential format.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the template in the schema repository.","example":"WgWxqztrNooG92RXvxSTWv"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential type that this template asks for. Use it as the `vct_values`, the `type_values` or the `doctype_value` of the credential query.","example":"LegalPersonIdentificationData"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the credential type.","example":"Legal Person Identification Data (LPID)"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable purpose of the template. The dashboard shows this text in the template list."}}></SchemaItem><SchemaItem collapsible={false} name={"isDcqlQuery"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `schema` of this format entry is a DCQL query. Use only a template with `true` here for the `dcqlQuery` of a presentation definition.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"isScaCredential"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the template asks for a Strong Customer Authentication (SCA) attestation. The server then writes the address of the platform in `credentialType`.","example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Page information for this list. The server leaves this property out when it cannot read the schema repository.

</div><SchemaItem collapsible={false} name={"offset"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of templates that the server skipped. The default is `0`. The server clamps a value that is larger than `totalItems`.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Maximum number of templates on one page. The default is `10`.","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of templates in the schema repository.","example":24}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when `offset` is larger than `0`.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when more templates follow this page.","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"templates\": [\n    {\n      \"name\": \"LegalPersonIdentificationData\",\n      \"version\": \"1.0.0\",\n      \"dc+sd-jwt\": {\n        \"schema\": {},\n        \"metadata\": {\n          \"id\": \"WgWxqztrNooG92RXvxSTWv\",\n          \"credentialType\": \"LegalPersonIdentificationData\",\n          \"name\": \"Legal Person Identification Data (LPID)\",\n          \"purpose\": \"string\",\n          \"isDcqlQuery\": true,\n          \"isScaCredential\": false\n        }\n      },\n      \"jwt_vc_json\": {\n        \"schema\": {},\n        \"metadata\": {\n          \"id\": \"WgWxqztrNooG92RXvxSTWv\",\n          \"credentialType\": \"LegalPersonIdentificationData\",\n          \"name\": \"Legal Person Identification Data (LPID)\",\n          \"purpose\": \"string\",\n          \"isDcqlQuery\": true,\n          \"isScaCredential\": false\n        }\n      },\n      \"mso_mdoc\": {\n        \"schema\": {},\n        \"metadata\": {\n          \"id\": \"WgWxqztrNooG92RXvxSTWv\",\n          \"credentialType\": \"LegalPersonIdentificationData\",\n          \"name\": \"Legal Person Identification Data (LPID)\",\n          \"purpose\": \"string\",\n          \"isDcqlQuery\": true,\n          \"isScaCredential\": false\n        }\n      },\n      \"mso_mdoc_v1\": {\n        \"schema\": {},\n        \"metadata\": {\n          \"id\": \"WgWxqztrNooG92RXvxSTWv\",\n          \"credentialType\": \"LegalPersonIdentificationData\",\n          \"name\": \"Legal Person Identification Data (LPID)\",\n          \"purpose\": \"string\",\n          \"isDcqlQuery\": true,\n          \"isScaCredential\": false\n        }\n      }\n    }\n  ],\n  \"pagination\": {\n    \"offset\": 0,\n    \"limit\": 10,\n    \"totalItems\": 24,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List presentation definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-presentation-definition

---
id: config-list-digital-wallet-open-id-presentation-definition
title: "List presentation definition"
description: "Lists the presentation definitions of the organisation. The server sorts them by `updatedAt` and uses `sortOrder` for the direction."
sidebar_label: "List presentation definition"
hide_title: true
hide_table_of_contents: true
api: eJztO2tz2za2fwXDL016afnRpNvq7uxc105bpWnsjZ3k3sl6RJg8khCTAAOAslWP//udcwCSoEQ94qY7u9P9ksgkcd4vHBzcRxmYVIvSCiWjYfRKGGuYnQErNRiQluMLlsFESIE/DVMTeq/0lEth6P2AXc6AGdBz0Mwo7UAU7HrBkqrMuIXs2CaMy4xVBgxL8JsznYFO2ERpgpcJDSkB+4f8h3zB0xkTFgo2U3m2kSICi+/noMVEpO59qippQRsPn9t1ywdsJJmdCcNyYSwBSkSWIJvQEAGfKp4bJqxhSQjntAEzyhIiHAWhwZRKGmA8N8ozkITU/SyMVXpxYbk1CQnPQEtxqlCMMAe96PIEd+mMyykiSJXO+jQRM6ksUzJf0Ku00hqkZSWfApF3AZYl5kaUJ4jNJMwqllhdAf3CF07UoB3jNVEdDdsZSKbBVloa9htoRUJ2BPsFJD56gGDiRkdcmluEbdiEGwuaiEoMcJ3OEjYRMjOMr9X09cKpIOfXkCdM6ebJeqV4whEBokXxpNzAngFphBVzlEsUR6oEzd2aaBilSk7EFJ3hVEyF5fl7nudgz0qQo+y8F1cURyXXvAAUVzT8cL/kWa+r4trJxWnPNAJH4ZV8KqT3pWMmYcqRNOSwkhp4xq9zYHOeV8AmPM8Nu+bpDSnvIBlEcSQQxacK9CKKI8kLiIaRmkwM2CiONHyqhIYsGk54biCOTDqDgkfD+8guSvxUSAtT0FEcZTDhVW6j4UEcFUKKoiqi4cHDQ3xfg81FIewyyi6vv/I7XMhkH8/OcMjEyCwfS+Cho6qL+cIp2oIuENdE5GiMGkyVW8OuF2tE5exjJ0qM1UJOoz7cSlumMKo1Qc3xClnD/xNuUpCZkFPULa53fz1dp8QmUn4OcXEEEvX2gSiM4oibNLoKZOeeh1q1mkvDKQCfcssvEd4SRSvou+z/6GR97SJPAI9l3HKGFNYRa20oDoJMqoqSazAuNjvTvxV2huGqQ2rrgkg0ecN2uZR8UYC0YySNPJf+jOIoV1Mhx1qYm3GAZ+2LsVRybM3hEQo5peA35mkKxiCygktMfmi13PIxn2oAQuvMoX6eCZPmylQa+j75BMaReRXqq43hn6kmzABbgn5vIh2wF+sDPEZWygqYDQbsrQGnNkVYyR24j/g+BfSq6VqpHLgMvZx4eHi4Qr5cVjW44OjgAP9LlbSot+F9xMsy9zTvfzTI6v0qAnX9EVJUc6kx4FvhoPVnD3zTld35upqo9vdOviVr5lrzBYoHitIu2C0KaTlpsxnHxLTWLaK4pp+gocItFEQ5z/OzCWWbzRyKrM8butyNUK+S53V5ITKQVkyEU/ZWv6XyCWRWKiFtUx5QYUbOqyYb0jSbgfYSSzVwCzHDtOdKRqogG9CmziCcZWIyARK4qGlviR6w4/yWLwyWnJswW8V4lmkwG6vMQfRARYIcZWeB6ka7yHVFjlRHnD57d8IyKHNFsccVqepW+oi3iY51zGyn5a0UnyoIVUtobRt3p2IOlKc3Krzx8ACSQJV0YgeGIjCWtCic3ZfczmoxoIbjWr34TQY5hJomZqnY287Zz1XB5V5TK9Eqx5znCJFXulTGp6H1Mo5dPXvHizIH9tU7ZGnBzpW2BPpUpRVp7PjwK2eyGTeza8V1xsxM3XoFEgXEQZZ+yv9O0bknEvEsI6Q8Pw88FqPzMoe+FGUnGkjouCMhsOwVl9OKT4E9OT35+6unjFLBMvNpsKwux9Oci8K0NuC0h0Ha3Bg20aqgx7iF8bU6suvAu30NZ0kAOHHxbsBo/wbS4ncc8dGmKsbPJ0oX3O8GOXN/7ZkSUrQblhRgecKceIYsyVSKEhtTDHG7xaQwalxkKk1ilsxT694Z2g8k7cfGf52l/2WyvY+3NnHbkJ5PPt7a8TwdY9pIBuxYespTLtstHEucsBAp/RobsPSXT7jjVC9Kq6aalzORjp3MxteC6jv8rqhyK8ocEk+GroyFbMwrO1NaoN4RObOq3MthDnkoWYfMZxOka6pVVS7plRQjwDSK8i6dA59DE1bIyBZMVbbNRus2XD4xoVU5reNm6SFerha7Jdh2X72sa8GVIrFriEthBGXpd6JOuqyoMLqUpVZz6C87r2GitHt3S3s4ZkD2NBQcWJepDOSQ+jbIy4uz1+yC6oiVUEm9DKtwlaAYRs2DJdkkdbTrY2nA3mCWS356ccn250f7bt+5nzlP33MU72PaEdm+yT7e2v0A/B5yuBfUIW03xVU+TRMD1dFYhWNSkFe6qsSpabs5kALQIJbF7PbQdXHdFtT/ZvV1HLniIzu2gRG7XWxfKr1jVhRgLC/KGBOcgVTJzMS1ygvVZvbAbjyS7Xm+6Z39kdTk3FjmGks7kDQHbXxtvNnHXY1DBkkJVFDuDCtow57UhdD5U+YB18Qeu6j4myPiTe0uif9sfHCYoAk3ANjh4GDAEmHU4XcHh9+M/zLmUsLdOE383oSNLs4Yvdv7CzvGd+wEo+FE5BCz25lIZz7rKc2KU5V2EqbyfS/Wl4SPz0eDwPxbErFSXyHI21mQK36BRVsjbpfsL7Doqc1vwGd8QRVvRls7MXUO3VJLSlzG/iMl4e2Y3Xc1RoSOYeMGFt2KKclENryBhcvId88Pvk8GIwy81rCZug1KCuzMqLyuUBxTmJsmnWpkjV4lADZWHfyw5+GwR3GEr0jcJlW75KUztDp2NDhgtKBuuNHulZ7sXXMUbcdBmlD++2KrK6ekcohITfWOd7ek2hLf9J/DnstahyrHVt2ATFrr5+s8FhWRrX4uvRuyEyUlpJaNTtklfjRgSQZzkcK4Jqm7rHXJ5+yUPnzTtM5xy2BcJ5tqtB4L6DidZwNdLmt+LmF3rpcLkHaUUVLfQa4n9D3yREl1m0CXDb0pqRuXpXMEyCf1JsvXJR6sr7WxrHRHIuNKi8TVGpzVD9nbN6OYHK15dTo6jetjBtBjbi3mAiSu+eRdTctx+5K9fH8ZOy8aGy7HGZYRrrKZAbs4fs1OX18w7DohhVyy/x08P/iepbhToXIGfFlNEGbczILl+Oe6ZQP2Htt5FFRPMIa2dluoDEy8LILaHDjDWiHtbPaJBOzto4ioheHlZLmegu10FteWw7vYWUgSmorAEqJP6D781DKt/0SJkBk6MOfK2Dce5FstdtjAvxm1GbzPchhWi4bxiaV2HitVfaK3bLBO2AN2VvsYla+ePVyWdDXSEaKGiddyKEW34WohDNptl7D1bqIATnmjRtmr/d00tntUfftm1Impv6psB99/E9Lk5N5x7l4FZJALrAE2Cv3rr0+dgaIFDL/+eknwrdYasVAJ8vPl5flgVcR937ttN0hK9pChnxNakrbDmI55KQJ3ff/NyboCh3QYNvUaPNiUR128fP+ixuZShQPv6GtQfDZ4ZANhdzN8w34UR0vCwCeEuflBT8nn0uNS+Ei9W1K98DVOmEkbe/URf8l/vFApJoYiWLbvBOsnyBLyh74eDL7vN6I6d1dyK4xms1tvous1X9rBqPIJleTQRHFUYyQVwF0JqYXsTIupkCbQQN3bXqpq3HcrMQ83gaWt6xWHYEUzX5ZDRaQMwvb7yplg1Phb7eovZPqOek0XVVkqbSHbyjN6kj/ZCDyK8XyKfaJZf8MukMemuDOifkku2h7vajDpWOp/h2bt3k9ydcvEVCpNtYzr5LleO8/mmOFpyOP48Oi7n05+9a5wfPT8W/zrCzanasU0gvE1eF/viE6nukfnPMcGsQYIJOsaGWv029o2snbyw8nezxdHz7+N4sizir8cm3RYF5mFsVD8yiWfdtQennOFiveHci3nObfYIN3hWID9n6qwMYg1kG+jc+bws8IRsHFfD3dobkLJFxLL/s+lFjMNQqAtfFgYbKfW9/9NhRvw9S15NKLFCo+FMnX6LQbstfJNOFNCntMh+2TJsrCQ3XCG8vs69K9gytNF2JH1vWFsvNDk1PrZFnJpLpmrIdq+Rt0X8U2jpW1mIqs8T4L5m43g3fBVcxyRdPRg8GA4lNWAAlp7nPwhomJ37eFTfVSzrT0cRzcEyG3Kl7a5YQsubICtOXxb9rEeQ77CU/PNp6NWWZ7TafrZ5N3qnNaaOZT+6Z5NE1umUcMW9+jq+MA7WWdwC1+QA1LOdZ2XaPjs6KHejjgSftDAbzJ122vZXR7ebZif20Rsdy5gB4LZcX3EjCcZ14DNysJ16dEBZDMLFzPjclRDTabcLi/DY2E3x4C6IyH06PSfrrkVXYQfvoEUxLwTW7dTZWk4sKaCJmBwh1ktDb2NeXoDWdcYvjnw/gvGnrs5oy+F2kMdI37X5qufaM9kl5Tvl8zyRy7yP1QQrujw5VGWuAlOMhiaKFkSlCtMXZh7PEkzPFvurdWZh97BerQcXp3JrrGZFU32CrTl46oX+oYgty5uXD0QqHZCsS+SWGGRpei8/WrZIf1szDmfwg5CPgkmaVhz5tHI7hAPIZGh0VKptg7eJX4cDCRSicf4nIsc00RHL89r4EjrY4Aj0VhnYq9YSVZPTHbszT38HGtzJNdzkx1poKPPuDnXMBeqMjsUbyOZURfOMEF2rOErP3lLEFZQuDkswvIa7uzjMUi4syvQMS88PCzFiHBKenv2OgkT1uOGp13edTOj7YxEa/h19vGAnPe7QYJ/y5zWiUaHR999iXT1qET1/be/L1F9kRR19Oz356g/JDs9f2R2emxe+u6fm5fWbMQ6GWdDYLiiuLEUj4P2gjDuqH39jRZkfgY8o7n9e4T27DOnS0N2QGulT7C7HLvfpwFpV/GWnUi7uk/TbWl5gBF/BXxfx6JeEv3AcQivrDD6+nsK0cPDGul1xlPxRFneSHUrY9bc1nFtXN+NC8YY/R0Lf7Cb9Qn38E8s3LfSz3v9Rl7RFc3zP73dNcP/VZ55O+JNGqYO/K5ejO03SCst7ILmo49L8QvgzyscJrd8ipd0mplKd7+nHUg5eRrFUX1ciuIrwM4UXg2a0pUaHGONhtGOM1shzeG8FrYviOG+C0OnUCgvD+yE6DwaRjNrSzPc38+gUHvYjxVTzaUdCBWt3kc51yqr3IzWGjDbIFxYDMHTdcuNe71MyFUreXfGThZWy7/tfbsH/vaCU11776WTrlaSHHb5ceAFfQm7PenKDJ8v75IOHBwz583c4DWlhIm4g8zfLHE0soQ9kXUn0WouqJNoSp7C05jBYDpYAjtkfuFfF6rSKI69G1j8LXENNCEnqvZqnpJXQ8EFCtK4I4H/aYXX8C9+ah91pR4qbEkszSLs4c1FRof+eJGGeqUC/y8a3+nMoi/PaYXHcyNjKi5TYE/OyDVGT6l82T7g1ZnvKrWyKlU5newKd+gH1KIzPtv85qfCrGLCmApi6vC7zu/czWDXaScczaoMqcfiLKDOzB7xK7i0dE5R12JO0kQtnnK+O2FPXr6/fBqz0YvLH9nF6d7L95fs3YnDFs6l4CjYfnH6KuzquqFlCjm5SAEnS4bNzZzjkqczwEGcFdXd3t4OOL0eKD3d92vN/qvRyYvXFy/2cM1Du5lu1YnCyvzYeVARuUm86Ojg6Nngm8EhtbWVsQWXAT14i3Fd1Fx2rCD3/Ocq8H+uAv85rwL7/GThzu6XORc08U6OfO/z/odojgPJLvPTBEKY+/1ZhTvjyNxEwtoK4CqOZjjGMPwQ3d9jx+itzh8e8LG7z0d1gTD+TK7vRl/os3/sJeNeweCkZXDXmJZHw8hVEzsT/rk3hjeQUnfbHknJDjeINyBvLhI/FvvvvUO8ibbgKvEjyfsXuuO7gdH+u8yPtod/mfuym3QbXgduOb3CPzRVZrTzqbdIFFbcymMaHAlWrWw5H8Ltz08vLvFIvMIwGJbybuDa/wjuo3K5CGAvV/WOBPw3OKTtLvkr1j6/wOJvzefuzdoFzU7CfY1Swh7R/wOzIKbE
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List presentation definition</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/presentation-definitions"}></MethodEndpoint>



Lists the presentation definitions of the organisation. The server sorts them by `updatedAt` and uses `sortOrder` for the direction.

Each item holds the presentation definition and the verification counters for that presentation definition. In this list the `id` of each item equals its `presentationDefinitionId`.

The response also holds `verificationHistoryStats`. These counters cover every verification exchange record of the organisation, not only the current page.

Set `skipCounts` to `true` to skip the per item counters. The server then returns zero for every counter of every item, and the answer is faster.

`search` finds a presentation definition by its `label` or by its `presentationDefinitionId`. The search is not case-sensitive.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Search term to filter results by","in":"query","name":"search","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Sort order for the returned records (ascending or descending).","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"transactionDataType","in":"query","required":false,"description":"Filter by the transaction data type of the presentation definition. The server compares this value with `transactionDataDefinitionType`.","schema":{"type":"string","enum":["payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"skipCounts","in":"query","required":false,"description":"Set to `true` to skip the per item verification counters. Every counter of every item is then zero. Use this option for a faster answer.","schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server listed the presentation definitions.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"presentationDefinition"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"description":"Presentation definitions for the current page. The array is empty when the organisation has no presentation definition.","type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Internal record identifier of the presentation definition. The list endpoint returns the value of `presentationDefinitionId` here. The create, read and update endpoints return a different internal identifier. Always use `presentationDefinitionId` to address the presentation definition."},"openIdOrganisationId":{"type":"string","description":"Identifier of the OpenID4VC deployment that owns this presentation definition."},"presentationDefinitionId":{"type":"string","description":"Unique identifier that the server gives to the presentation definition. Use this identifier in a verification request and in the path of the read, update and delete endpoints."},"label":{"type":"string","description":"Human-readable label that gives the purpose of this presentation definition, for example 'Verify Portable Document A1'. The dashboard shows this label."},"dcqlQuery":{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder.\n\nThe query holds a `credentials` array. Each entry has an `id`, a `format` and a format-specific `meta` object: `doctype_value` for `mso_mdoc`, `vct_values` or `type_values` for `dc+sd-jwt`, and `type_values` for `jwt_vc_json`. An entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.\n\nThe server leaves this property out when the presentation definition has no DCQL query.\n"},"transactionDataDefinitionType":{"type":"string","description":"Type of transaction data that the verification request binds. The holder must approve the transaction data before the wallet sends the presentation. The value selects the JSON Schema that the server uses to validate the `transactionData` of the verification request. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.\n\nThe value is an empty string when the presentation definition binds no transaction data.\n","enum":["","payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]},"createdAt":{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server created this presentation definition."},"updatedAt":{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server last changed this presentation definition."},"version":{"type":"string","description":"OpenID for Verifiable Presentations (OpenID4VP) version of the Authorization Request. `version_01` is OpenID4VP 1.0. `iso18013_7_annex_c` is the ISO 18013-7 Annex C profile, which asks for mDoc credentials over the Digital Credentials API.","enum":["version_01","iso18013_7_annex_c"]},"cryptographicKeyIdentifier":{"type":"string","description":"Key identifier of the key that is used to sign the Credential."},"cryptographicKeyFormat":{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]},"scope":{"type":"string","description":"OAuth 2.0 scope value for a scope-based presentation request. The value is an empty string when the presentation definition holds no scope."},"responseType":{"type":"string","description":"OAuth 2.0 response type of the Authorization Request. `vp_token` asks for a Verifiable Presentation. `id_token` asks for an OpenID Connect ID Token. `device_response` asks for an ISO 18013-5 DeviceResponse and is only for `iso18013_7_annex_c`.","enum":["vp_token","id_token","device_response"]},"clientIdScheme":{"type":"string","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet of the holder. `redirect_uri` uses a redirect URI, `did` uses a DID, `verifier_attestation` uses a Verifier Attestation JWT, `x509_san_dns` uses the SAN DNS name of an X.509 certificate, and `x509_hash` uses the hash of an X.509 certificate. With the DC API response modes, `redirect_uri` is only a logical identifier and not a real redirect target. The server leaves this property out for `iso18013_7_annex_c`.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]},"directPostRedirectUri":{"type":"string","description":"URI that the wallet of the holder opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`, and it has no meaning for the DC API response modes. The server leaves this property out when the presentation definition holds no URI."},"responseMode":{"type":"string","description":"Response mode that sets how the wallet of the holder delivers the Authorization Response. **Direct Post:** `direct_post` posts the response over HTTP. `direct_post.jwt` posts the response as an encrypted JWT. **DC API:** `dc_api` uses the W3C Digital Credentials API and returns the response without JWE encryption. `dc_api.jwt` uses the Digital Credentials API and returns the response as a JWE.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]},"dcApiRequestType":{"type":"string","description":"Signing type of the DC API request. Only for the `dc_api` and `dc_api.jwt` response modes. `signed` means that the verifier signs the Authorization Request. `unsigned` means that the verifier sends the request unsigned. The server leaves this property out when the presentation definition holds no value.","enum":["signed","unsigned"]},"expectedOrigins":{"type":"array","description":"Origins that the wallet accepts for a signed DC API request. The server leaves this property out when the presentation definition holds no origin.","items":{"type":"string"}},"encryptedResponseEncValuesSupported":{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the Authorization Response. It applies to the `direct_post.jwt` response mode; the `dc_api.jwt` flow ignores it and always advertises `A128GCM` and `A256GCM`.\n\nThe server leaves this property out when the presentation definition holds no algorithm. The verification request then falls back to all three algorithms.\n","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}},"systemManaged":{"type":"boolean","description":"`true` when the platform owns this presentation definition. You cannot delete a system managed presentation definition."},"extentionEnabled":{"type":"boolean","description":"`true` when an extension uses this presentation definition. You cannot update such a presentation definition, and you cannot delete most of them. Note the spelling of this property name."},"presentationDefinition":{"type":"object","additionalProperties":true,"description":"Legacy credential requirements of a presentation definition that an older OpenID4VP version created. The value is `null` for every presentation definition that uses `dcqlQuery`. You cannot set this property."}},"required":["id","presentationDefinitionId","label","transactionDataDefinitionType","kid","scope","responseType","createdAt","updatedAt","openIdOrganisationId","systemManaged","extentionEnabled"]},{"type":"object","properties":{"totalCountOfVerificationHistory":{"type":"integer","description":"Number of verification exchange records that use this presentation definition. The value is `0` when `skipCounts` is `true`.","example":42},"verificationBreakdown":{"type":"object","description":"Verification counters for this presentation definition. Every counter is `0` when `skipCounts` is `true`. A record can be in more than one counter, so the counters do not add up to `total`.","properties":{"total":{"type":"integer","description":"Number of verification exchange records that use this presentation definition.","example":42},"presentationReceived":{"type":"integer","description":"Number of these records with status `presentation_acked`.","example":30},"requestPending":{"type":"integer","description":"Number of these records with status `request_sent` or `request_received`.","example":9},"verificationFailed":{"type":"integer","description":"Number of these records with status `presentation_acked` and `verified` equal to `false`.","example":3},"expired":{"type":"integer","description":"Number of these records whose Authorization Request expired.","example":2}},"required":["total","presentationReceived","requestPending","verificationFailed","expired"]}},"required":["totalCountOfVerificationHistory","verificationBreakdown"]}]}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>verificationHistoryStats</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Counters for every verification exchange record of the organisation. The filters and the pagination do not change these values. A record can be in more than one counter, so the counters do not add up to `total`.

</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of verification exchange records.","example":128}}></SchemaItem><SchemaItem collapsible={false} name={"presentationReceived"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records with status `presentation_acked`.","example":96}}></SchemaItem><SchemaItem collapsible={false} name={"requestPending"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records with status `request_sent` or `request_received`.","example":24}}></SchemaItem><SchemaItem collapsible={false} name={"verificationFailed"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records with status `presentation_acked` and `verified` equal to `false`.","example":5}}></SchemaItem><SchemaItem collapsible={false} name={"expired"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records whose Authorization Request expired.","example":8}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presentationDefinition\": [\n    {\n      \"id\": \"string\",\n      \"openIdOrganisationId\": \"string\",\n      \"presentationDefinitionId\": \"string\",\n      \"label\": \"string\",\n      \"dcqlQuery\": {},\n      \"transactionDataDefinitionType\": \"\",\n      \"createdAt\": 0,\n      \"updatedAt\": 0,\n      \"version\": \"version_01\",\n      \"cryptographicKeyIdentifier\": \"string\",\n      \"cryptographicKeyFormat\": \"did:key\",\n      \"scope\": \"string\",\n      \"responseType\": \"vp_token\",\n      \"clientIdScheme\": \"redirect_uri\",\n      \"directPostRedirectUri\": \"string\",\n      \"responseMode\": \"direct_post\",\n      \"dcApiRequestType\": \"signed\",\n      \"expectedOrigins\": [\n        \"string\"\n      ],\n      \"encryptedResponseEncValuesSupported\": [\n        \"A128CBC-HS256\"\n      ],\n      \"systemManaged\": true,\n      \"extentionEnabled\": true,\n      \"presentationDefinition\": {},\n      \"totalCountOfVerificationHistory\": 42,\n      \"verificationBreakdown\": {\n        \"total\": 42,\n        \"presentationReceived\": 30,\n        \"requestPending\": 9,\n        \"verificationFailed\": 3,\n        \"expired\": 2\n      }\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"verificationHistoryStats\": {\n    \"total\": 128,\n    \"presentationReceived\": 96,\n    \"requestPending\": 24,\n    \"verificationFailed\": 5,\n    \"expired\": 8\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, or the digital wallet deployment is not resolved.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The server could not read the page of presentation definitions.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List scope
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-scopes

---
id: config-list-digital-wallet-open-id-scopes
title: "List scope"
description: "Lists the OAuth 2.0 scopes available for OID4VCI credential issuance, as published in the Credential Issuer Metadata. Use a value from this list in `credentialDefinitions[].scope` of a create or update credential definition request, when `authorizationRequestType` is `scope_based`."
sidebar_label: "List scope"
hide_title: true
hide_table_of_contents: true
api: eJztWN9v4zYS/lcGfLkEUGwnuwsURlE0l+QKt9vd4JLdfdgLzhNxZHEjkVqSsuMz9L8XQ0qWbCdpu0Cfei+JLHF+fTOc+ciNkORSqyqvjBZT8VY578DnBO/Pa5/D2WgCLjUVOcAlqgLvC4LMWHg/u3z98WIGqSVJ2issQDlXo04pAXRQ1feFcjlJUDrou+gXzpyrycKv5FGixxF8cAQISyxqgsyaEnyuHBTKeZae9zYuKVNasa/u890oODYHkwGyH+gJjIW6kvw0cExupcDS15qcT2CVk4Y51j43Vv0P+eO/47fbNStVDuZB/3/v0ZGcj/6jRSJMRTasnUkxFanRmVowZJdqoTwWn7AoyL+vSM/kTUBNJKJCiyV5sk5MP2/28H5Xl/dkOQRLqbHSgTfgHlQVQK5woXSwN4Jz0LRAr5YxSG0JZchGCxsWhYN7TB9Yw3wyH4lEKDbxtSa7FonQWJKYCpNljrxIBEOhLEkxzbBwlAiX5lSimG6EX1e8VGlPC7IiEZIyrAsvppNElEqrsi7FdNI0yaZTW6hS+X2Tu7H+io8sCPqpmC352mqoKERNo2918HTSNHcs6yqjHTlefTaZ8L9db25zAkd2Sba1Hcu+LXZGn3+mtbWk/dan1GhP2rM6rKpCpSE74y+OdW4GHlaWa8Wr6EHQeujDzQvG4ArTPLoDJVYBJBxWday+OtZjt8u6bfnCbuMkeSrdAEdz/4VSzt6u10oO1jhvlV4cJPWDVl9rAhWsZYrsNproekzxSDRJD8LLGvcaT1vfJVYVyQMQWNWfib1JROwU8twPXIkl+VRwj+BVSc5jWcGR0uAoNVq649hA+jhX6NoeFIONXeivsFKg81AayWizrWa4Uz5z0jqoh7EOPbprks4ltBbX7G/fap6qC698wS+u+1X7xdIW7zUu6JkdOoz5YlDqsMWFHrGs2NApe2g8FrO9Sn1O3y0vHnSWUOH9yBrqPnvTKWdfv0U5O8291pEEo6FrfVsLr5qk7Ye/r/vdnstdA9xBY9IkIkd3bWmpTD10+d6YglAfqJ1pyb2JHKiM68fSPxwgVK2GAxOhw0Yr7+jRf7sFTY/+QLu3NTVN05ddW1jhVU4ow3Dc8K/XsVf/4T47LH2y1tgLI4Ntfr4ceHy3b3y/gHvpp7K2jeX1hLNxoP6JtrYVEf9EpkFVzci0ZIBj53gPh5KxC9TKtW3dQa0ftFnpJLSBVWAY/FobD5KqwqxJJtD2XBX7XYqaPzNFGAw17vz7YJ/+jcH+oDv6R/IAmjd/6zqcaU9WY9ExpGBmDyOe6JTWVvl1ILbnlfqF+PGOCZjHBfNd0TJjiNQYjgI55jl9LBIRxzNDUpLPDXPqReCmFfpcTMV4eTaONGcso56TuAHGpiKt5NjJLys/dh3Vjt4+xbMvqTRtMDwKbSGmIve+ctPxWFJpTrBSI7WwqP1IGcHEdlfBtTWyTsOefEbN72m48Tw8F8+Ju/h535G7HuUbLrZYIx3W22RjfNHy75imnvOfD485B538/HoGD7QG3g3Mm9L2xMHNKJIvEzo8zHf0zCGagbJ2Hu6Jh0umHknCSvkc5tFHmMORNp6CAm9RFQGDClM6ToBGi9Ge2im0gt+vTW0ZjpMHWv8wj0xH6cx0+xLTsC+pRMVAurqqjPU/9uBt41c/9a92UR8mbA+WrRBU1iyV5CMwpIa3kidQ/L8k7WOfbhGK1R0o8EeyKlPhhNYTUhcYKR+S4ailq8eAWj4jeG3JbU1st871MXvkTWoKx1lSDjiFpFnGtfMjghlODWEoJJCbQibB2JItrKHdUgM67aB2IT0etUQr3UmIV6H2kBVm5WJqW6SDt59eXcDHCzj6+dPtcQKzq9t/wc3lyc+fbuHjRbQ2u3kPp99NTl+dvIHy0qTj8vLtkMJnxpbow3QqVErahcbXVW6FaU58GjhI3Wq1GmH4PDJ2MW5l3fjt7OLq3c3VCcs0PXXt08lgSZPW2+yJRHDbiGk/m5y9Hr0anQZSbJwvUQ/84cM+dOxa7vbd7az4/y3Ky7cobc/y9OjHVYFKhwMTJ3fTdv7PYnkWT9uZCifEne4fL2J0POnwBOhOPI5HSW6cZw2bDdv8YIum4dfxTiJMBuU4Af29wrN5/GtvZ56E4YHben9JE8TFVMR58ocd/7NXLS+40p1uek/u+IcNHSpM+44WBHCj0HmaUjWUOiBPzXDo/3R1KxLBZbQ70h7CSGsfWHv3Sa8HuvenW3SB/zJoT4p8zz3gF1r/sF0evzwrsJ2ocTUDdNc0zW9d+GUN
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List scope</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/scopes"}></MethodEndpoint>



Lists the OAuth 2.0 scopes available for OID4VCI credential issuance, as published in the Credential Issuer Metadata. Use a value from this list in `credentialDefinitions[].scope` of a create or update credential definition request, when `authorizationRequestType` is `scope_based`.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server returns the scopes for the current page.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>scope</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Scopes for the current page. Each scope maps to a credential configuration in the OID4VCI Credential Issuer Metadata.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the scope record."}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value mapped to a credential type in the OID4VCI Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when the scope was created."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when the scope was last modified."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"scope\": [\n    {\n      \"id\": \"string\",\n      \"scope\": \"string\",\n      \"createdAt\": 0,\n      \"updatedAt\": 0\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the wallet is not deployed, or the issuer cannot read the scopes.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List transaction data templates
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-transaction-data-templates

---
id: config-list-digital-wallet-open-id-transaction-data-templates
title: "List transaction data templates"
description: "Lists the transaction data templates that the digital wallet supports."
sidebar_label: "List transaction data templates"
hide_title: true
hide_table_of_contents: true
api: eJztWG1PGzkQ/isjfwJpkwCl0imqquMI10uvKkik8KFFZFhPEpdde7G9CTmU/34ae7PZvACV7r61X2Djtef1mXnG+yQkudSqwiujRVd8Us478BMCb1E7THkdJHoET3mRoSd+jT7skWqsPGYwwywjD64sCmO9a3/T3/QZppP6DIzVlBwgDP28oCGglkHAx8vzz3CZTihHGBlbSZ4X1IZLijqWJ1z1a2VWDz32aKS04l+DsM2MAKGw5Eh7jLbXO9ow2CFhGJXOTckKNDjSEmbKTwBhSlaNVBoFWXooyXnIS+dhZLLMzLZ8MKOGCxwF1pgp50E5GKlHksF1FZ1xmFNwm6Zk52DsGLVyuLLVkiuMdgQTdKANFDhWOr5fCndkp2ThnqiIQlG7GVlQGhBSTCeUgDP8PEE9Jl7fkTnF4j1MlVN3GUGpvcrCviABSHs7B3oslCXOrkiEKcgGS/pSdEVq9EiNGTy9KPg6yD0vSPflYD3ggyWORCKWDjrRfRJHBwf8bx2QDR85jiRfAWdbJGyNJ+1ZGBZFViWw892xxCfhQq74idMkusLcfafUi0QUlt3yKtrzLNTcDjP/Q7WIRChPudtl0Q9qiXDZqLZNcNaGbJdAKJtX0T7j+mABzxQYlC6oZXhzAWxFNMM7yhpuOm+VHm+5+VeZo25ZQomMRs1lEirrhcSzMnrEvMhY8AXOc9Ie2DuxSCp9r+nlFgJKkvZqpMi+rhO+OIr+TjEr6X9pUuyHLnPR/SqK6MUtK2Vj0eMtji1RWLWUGiuX61K5NDOutLRrywO5pZRKqEhEZsZK31rl7m8bBotEYJqaUvtbTFNyXKaUo5bo6dlDt9roW+8Oj8RNMw1rDiySFyoPpQzuY3bRQIy3JW0maQvRK7A7b8vUl5ZqfplipmQF6DIj92xKw3qN28WCW9NDqSxJTkTEbQWj2o2bGlgCrcX51rEXGsjNgjdPCCVZLg3+dRz73w93r6YqstbYUyPZvPDcawTtJnml061Or1KjtKcx2WZZHR8cLHaI31FXKwj8gRKULkoPBVrMyZMVi0XwfrvRNxmQOanU99rMdLKrfUoqMhOrvGIvS85kU5IJhEli+4SSYV9kSC60zfgf/sTx/6Kx9BNj1T8kt0Lz9qeGZl97shqz5SAS1GzEiLsbpaVVfi66X5/ESaH+Jn68WbCPOHYci2o6gjgewV4YkHrHV6f7IhFXgX/JclBy8hPDk9WYQkzQT0RXdKZHnThqdSpstyK2O6YgrWTHye8z32n0nRZ3t5ZsdB62k71wwcx1R3uUm8pJkYjSZqIrJt4XrtvpSMpNCwvVVmOL2reVEYtkU8CFNbKMbfUZMa9JuPQ8446fO+7i601DblbRD9QQsbPMQQ0CjAuJUKwqpk8kggcM0RUnFf6xosF1w04u+nBPc+Aq4Qkhbczpkf0rbhmuyRlCVBMHqbswO8WLQLhjDKONMIQ9bTwtyUllIQYFprSfALXH7Q2xXagOvpub0nI4Wvc0fz+M3KX0yCzrFdNQr5Sj4kBWU+fvq+DV/qsPq6X1qDcTthGW+hAU1kyVDLe81HCJeQLF//N6zKkiFFEfbj4R82HMO7UURi/MHPSdK1GnBHvnoTz6+4HSdx+8aE5SdUld7LNF3qQmc5wl5YBTSJrPuIpqYjAdeAPKuZISmJhMJkFZGIfnNYmkDfNKF9LjeSqy0rWCvwq1h1FmZi6mtop0sPb6zSlcncLex+vBfgL9s8GfcNlrfbwewNVp1Na/PIfD3w4O37TeQt4zaSfvfWroZCk5xstCplLSLjTEJXKLcE07ah9spW42m7UxvG4bO+5UZ13nU//07PPlWYvP8ByjfLaGgRAsadKyzp5IBLeNmPajg6Pj9pv2IZ8tjPM56oY9fBF84Y62WVsNYvn1AeLXB4gf+wBRtXRPj75TZKg0QzFg/6miy69iehS/BoxUuOytUWb8hqEVDzuBNlnmS8R5k4iJcZ7lPj3doaMvNlssePmhJBuoPhFTtKEpBeJfTgiBae+ZicRJmlLBqgJlBEramKMWTfb/cDbgy1HJ7jRZ7D6wWPXA0pev9Lwhe5PQogn8l3l355F3XPZ/0/x9vT2+efZATaJxN6eB7zb/AmGfNdU=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List transaction data templates</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions"}></MethodEndpoint>



Lists the transaction data templates that the digital wallet supports.

Each template gives a `type` and the JSON Schema for that type. Set the `type` as the `transactionDataDefinitionType` of a presentation definition. The `transactionData` that you then send with a verification request must follow the JSON Schema of that type.

The list is fixed and is the same for every organisation. The response has no pagination.

The server keeps the answer in a cache, so a change in the digital wallet is not visible until the cache entry expires.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server listed the transaction data templates.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionDataDefinitions</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data templates that the digital wallet supports.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the transaction data template.","example":"Payment Data"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`payment_data`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`, `payment`, `login_risk_transaction`, `account_access`, `emandate`, `login_risk_transaction_non_ts12`]"} schema={{"type":"string","description":"Type identifier of the transaction data template. Use this value as the `transactionDataDefinitionType` of a presentation definition.","enum":["payment_data","data_agreement_record","data_disclosure_agreement_record","qes_data","payment","login_risk_transaction","account_access","emandate","login_risk_transaction_non_ts12"],"example":"payment_data"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>schema</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Schema that gives the structure and the validation rules of the transaction data of this type.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"JSON Schema that gives the structure and the validation rules of the transaction data of this type."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"transactionDataDefinitions\": [\n    {\n      \"label\": \"Payment Data\",\n      \"type\": \"payment_data\",\n      \"schema\": {}\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the digital wallet deployment is not resolved, or the digital wallet did not answer.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List transaction data
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-transaction-data

---
id: config-list-digital-wallet-open-id-transaction-data
title: "List transaction data"
description: "Lists the transaction data records of the organisation. The server sorts them by the last modification time, and puts the newest record first."
sidebar_label: "List transaction data"
hide_title: true
hide_table_of_contents: true
api: eJzlWW1v2zgS/isDfrkWUOwkTQ8HY7G4bNLtudtrAyRNP7QBPBHHFhuJVEnKji/wfz8MKcmyLSfdHPa+9EteLHE488zMMy9+EJJcalXpldFiJN4r5x34jMBb1A5T/hwkegRLqbHSgZmG58bOUCuH/MIArjICR3ZOFpyxUUQBt8vwao7OQ2Gkmqo0vA9eFZQAagllVd+naUHO17fAVFnnB1/1V/1WzQkmqSVJ2ivM39ynGeoZjeUEvAFLKMHoPN7U0dFogvUpUM5VqFMafNUiEaYkGzQZSzESqdFTNWPTz9VMecw/Y56T/1iSHsurNQ7n6FEkokSLBXmyToy+PGwB+KEqbsmyAo0u3oC7UyVMjYUSZ0rXkJ2Cphl6Ns9YqDRbgrc5wRzzimCKee7gFtM7ljA5nAxEIhRf8b0iuxSJ0FiQGAkznTryIhGWvlfKkhSjKeaOEuHSjAoUowfhlyW/qrSnGVmRCElTrHIvRoeJKJRWRVWI0eFqlTw0YnNVKL995aat/8Z7Pgi6z2ZLvrIaSgpW0+C5Ch5FrTZv/l3lnizHV8fFVEdGE0MqPJgqsrU+VtGcAMGVlHIswsfx+cn12bgNDsiU88YugbS3y32A98Wi6DHGeav0TKxWN2y6K4125Pj58eEh/9o0qZNBEbon0pDDiV9IK2tJ+wByEpKP5OOJx3alRnvSntXAsszrx8NvjnV56NhSWs4Vr6LmfjMZ/hXh6jHmz2gd2QOtxSUoB1SUfgmLjDRo0/iyQJ9m5IJLPBWuA7O5/Uap3wnOPSqAz9AHFdjpZDnblEQGDWeotPOAcIHLgrU7rXzGnk7Rc/JacqR9QCoBdCBpqjRJUDoIDHxxfnJ9ses0uvekHac988cGpEruhsy2LWPtyWrMeyK7ZuM9YTKAsWdMtYk2OywafkEHky13juVkAKf5ApcOKkd9zzmTUEpLznUIdyBWyXZsjH/Ark9afa9oI1Eb79SpMFNzCnTyqJGfHIHPlOtKqp1Sos8akEKtIC1Lo7QPOvem8tPu2IG/p9C0XLIZd8rtmnFLudEzNjOmQnSQcoC6zoaoSEyKNeydg5wqfdWOjTShjn3s1OvnGdnE9xlIKnMTUySYtc6hPjf1Rcdv6OjvJ900Dvm/o0V8r7I5kE6N5Bu20Yv6u93EJsvqr/Oan93REm6Vlozmu89XW3hPdJXnkzXM25K0qW/r46GW7rlDCODENuLUe3KRNZ5GvZ95roMCoTm46JAQeHMXNK0Nz0wuuQGjOrq3MO/jTJRS8XPMLzqs5G1FT/JpicvcYGC/Mkel4d3lxw9JYHi6x6LMqU7AJVFo9fg/LEylPUdUEMC2PuEDbhq4MZzhvBUY7u0hsBgtkz7jr2sfdkC4NSYn1Ds+mLD5j0RBLxVl6DJyj8YaazUvr9hn5xSC+X/zSC2kBaRO02cEyw9lQWqqXIZKIsPFEQcW2lApM8Cp7xgVG8M+2r8PnYjzWJQJR5Cj1GjpksaIwqzZpVMO6ksij3ZqT1XKv/7y0E3FKrGtwarb3H7hmt5XD/fUmz0M/QiN7I/urh+6sNxwRnSJNrBUM4z0xaFXPqfASO1b261L3cRd4Iz29PBd4M86LR+0zqmpQoyOWEPjMR9v8eo+eVf8cmf2CHwMOEeVc/B3ZR+/boSzrs8RzkrzNOaIp01ohqP2hlerpJ6Ynpb9YUvlZkTaQONwlYgM3YWluTKV+wHaGmvJ5YIcqBDGlv7mmGVrCTtXhBks3vKB7v3zb9B073ekM2GtVqt12LWB1U2UPfPERmzeBCkZoQwT9wP/dxInqB+eYrp3krXGnhkZ1OW/zztG3uzquxnz69N9jm7NPzlkB+6I76n/7RHxWyimZcVg1hsGsYoY7o6K3fULk3al77RZaKjnq0XgjKb1j/0aSW5btoE8+omB/KSx8pmx6j+BOjehef1Tx1g7ctbFL1yzhdEqEY7Syiq/DJuw01L9QfznDa88PM54QSbqnRrEMgYv2jHipUjEOPQWDElBPjO8jZuFZRbPbWIkhvPjYVzPDWWUcxBDe8g1U8mhk98WftjhkQNuxxzvY4LifTu6cypMbRcXSZuLkci8L91oOJRUmAMs1UDNLGo/UEbsrp8urJFVbP72iHlKwqVngpvtO+7i421FbtaAX3LcxXBpYF+PUvGDensVPbZeX53WId/U9E3FTi/GoXHF9QDSLnhjh1g3SZMNOROI10BROQ+3xGVnqu5JwkL5DCZRR5jAC208NS20ygMGJab0MgEazAZbYkdQH/xlaSrLcBzc0fLXSWy5lJ6aJkUxDSlKBSoG0lVlaaz/5xq81n71dv3RJupdh23B0h6C0pq5ktzqQ2o4qzyB4t9F22lvzMthIOr05GdtC+hg3OwKXtSbyJdhUOo/uNHMt1l08ZI18iY1uWMvKQfsQtJ8xtVlIoIZ9gShmU9C9x8X8GGsWUKdXZ0lAu+Agns8aolWuoNgr0LtYZqbhYuurZEO2n5+dQbXZ/Di3eerlwmM31z9DpfnB+8+X8H1WbxtfPkRjv5xePTq4DUU5yYdFufvu4uLqbEF+rDny1VK2gUObCK3xDQjOB4c7rhusVgMMDweGDsb1mfd8P347M2HyzcHfGa1bmrX7mSwpEmr1nsiEUwb0e3Hh8cng1eDo9AuG+cL1B19+BuDnUlwO6M6FeRn+XalpiFP934YVgNhRGN/PdS8/kXMj+MWeqrCEmSD2+uJKExRgd83B56a4W8SkRnnWdjDA3fmn2y+WvHHcV8feF85zoP1Nw57XfPXfm/Ti8gdk/b665twXIxErBY/rPif/RLmEVWaqeaZmvzfvpR5xIQ9A/baohv+xwZGDY1K09GEcIkyTtOUyi4OO33fqtuvvH1zxWubiuO6W4LvQgmu/2DpzSO97MjersZRBf7J4Pce+YU56w9a/tq+Hp/sPdB2APFtxouHqv8CxF2Wyg==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List transaction data</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/transaction-datas"}></MethodEndpoint>



Lists the transaction data records of the organisation. The server sorts them by the last modification time, and puts the newest record first.

Give `credentialExchangeId` to read only the records of one credential issuance.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by credential exchange record identifier to retrieve a specific OID4VCI issuance history entry.","in":"query","name":"credentialExchangeId","schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server returns the transaction data records for the current page, sorted by the last modification time.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionDataHistory</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data records for the current page. The array is empty when no record matches.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the transaction data record. It is not the same value as `transactionDataId`. Always use `transactionDataId` to address the record."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier that the server gives to the transaction data record. Use this identifier in the path of the read endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential issuance history record that this transaction data belongs to. The value is an empty string when the record belongs to no credential issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VC deployment that validated the transaction data."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64s"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Base64url encoded transaction data strings that the issuer verified against the key binding JWT. The value is `null` when the issuer verified no string.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"paymentWalletAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authenticator Verifiable Presentation token that the holder sent."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data payload in plain JSON, for example the payee and the amount of a payment. The value is `null` when the request gave the payload as `transactionDataBase64`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data payload in plain JSON, for example the payee and the amount of a payment. The value is `null` when the request gave the payload as `transactionDataBase64`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the issuer verified the transaction data hashes against the key binding JWT."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>vpTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Presentation token that the holder sent. The value is `null` when the issuer could not decode the token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Presentation token that the holder sent. The value is `null` when the issuer could not decode the token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server created this record."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server last changed this record."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"transactionDataHistory\": [\n    {\n      \"id\": \"string\",\n      \"transactionDataId\": \"string\",\n      \"credentialExchangeId\": \"string\",\n      \"openIdOrganisationId\": \"string\",\n      \"transactionDataBase64s\": [\n        \"string\"\n      ],\n      \"paymentWalletAttestation\": \"string\",\n      \"transactionData\": {},\n      \"transactionDataVerified\": true,\n      \"vpTokenDecoded\": {},\n      \"createdAt\": 0,\n      \"updatedAt\": 0\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown or the wallet is not deployed.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List trust authority
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-trust-authority

---
id: config-list-digital-wallet-open-id-trust-authority
title: "List trust authority"
description: "Lists the trust authorities of the organisation. The service uses these trust lists to validate issuers and verifiers in OID4VCI and OpenID4VP flows."
sidebar_label: "List trust authority"
hide_title: true
hide_table_of_contents: true
api: eJztWVtz27YS/is7eDn2DHWznaTRdDrHtd0etW7iqeX4IfVUMLkiUZMAA4CSVY/++5kFQIqU5DrNtE/tiy2KwOLDt/fVE0vQxFqUVijJxuxSGGvAZghWV8YCr2ymtLACDai5e6F0yqUwnHb0YZohGNQLESNUBt1eU+/OvTQFC56LhFsEYUyF2gCXCSxQi7mgJyHh/eT85MPZxL14X6KkxyuY52pp+r/IXySdQ+LAWK6tgaWwGdilgvtK5LYnZPfIjFsHtoam0VZaGpgrDbhAvdq9xgoyvkC3a3JuYDacOTCz0SzyHxJh+H2OySyCWayRW0xObVhUlUnznC/5ykCm8gRmc54bpA21tOHMYbAZFp68XZ4b8G2IEE6EWBUIfG6xFjIreSqkv4dVlucTi4WZQawqWeuyzZPGWOnE+EtZuvdc5LlbNxfaWCh5ihvOuU7RWNJghWQCs1wUws5AGBgNh3049Ut0WJGKBRr433R6BSfDYZ9FTJWoHbpJwsYsVnIuUjKzc5EKy/NbnudoncqTKXFxGqhYsYiVXPMCLWrDxh+ftmz1XVXcoyZM4UpkaeZBlI7hFitwChJTbsWCOIVKauQJqTJgnvM8N3DP4weSMBvOCLagIz5VqAmH5AWyMVPzuUHLIqbxUyU0JmzsFBwxE2dYcDZ+YnZV0lIhLaaoWcQSnPMqt2w8jFghpCiqgo2H63X0VIt1jG4f2b3rT/yRNoLcd2dv3FCi9rr7UoCj4Xp9R3tNqaRBQ6uPhkP610Uz3eNZ+2NGsLGWNiDhlhPEWEmL0pJ0Xpa5iN3rwW+GjnjaBazuf8OYaCo1mRSJd2+7NrNZz7Xmu0TudzklHcq40hpl8ADnnd4jyH9qvrn2MWJf3IlgmYk4ezaQOLsi79x3rS7O0y2Uq/3hd2KhVEL6KMtbWHZDoI/OL8Xi/g7BImmhNVYLme6gvZHiU4UgEpTWyanRbl/Cs9iHn2vr/cNY53jkcHMzOQ/B8rmA3zC+gbAnhK9UBTGXUlmgEBCBD9sRWJWmuQsOCeZonagi5BiyXtS99t3qiObYwkdelDmRc/8mGc1P+FHvq/gYeyf87aj3dv7qqDdMjuPX+IaP7k9esXUUuNzlFCWFho/sYno9+XV6ye52jHdVYpdZun03CfM4xtIamAUpMzigTzC9htHoLbweHfmtmLjNh6Bkvureoz5/HTEXIF/W/6Xy3rsP3Hc+3bUAkawIbCYMZRF65/KF0u7/Ndz8fNkRFKBCouKqQGm7aDNrSzMeDDRf9lNhs+q+MqhDdOnHqhhc3J71YiWN0lZUxQCXcc/J7ZHUgca5GWTIEzMouJBu9fSy/1jkRIAP0S/d/x0v8BmT99rxiUaQswEWpV2BlwTLDEPscTbv8pMzSqAQTpk3JdOWCgjJlp5uwGVMoHRKYOsKpQX4XqkcudxBfEvnzqyuqDpxqth2VWGgluech7ymMpi47BprdP7Ac0JcR48gI0SYpj581mtDqRTyVyiWOnd0X60j1tRbrav5XLgvFj2CFQUay4sSDoQEg7GSiTms2d5z2yUnHKkwFjUmfw73sIt59ObkzXA0ej0criPWFIZ/J/CcGwuFSkgJfxn2dbuK+EhpIESuOioE52grp33fljnekbBNCbAv+1lhnU1fbVZtJ6KQna94is/UMW02z1q5HBrGNxelONxUy58hb0qLW/WXy+PAF1zkdMm27KNXtXDC+iXCCTRVpORuSkJdIDYnHK+jUDW+LPvdFuS6TOywQaaacXOlcSFUZT4jgExkQiUbGhAu7mn8jwEOZZCwc0TtyRk37/DRfvkJEh/tjnQKZOv1ts3a3X6isa47t5rivusunujpxBe7n12Zts9CrZU+U4mDRZ/PW5e5i16oYje79ym0ueaJiyk74vfVEk2W+JYnIGRZEWmhm2Jrz9VuadwpwybnlAQo7ruIHrk8tXT9Wv1Co1H5ApOI0kCrNQw9oc24dG0i26V69A+m+kaGAP47JjvUvPpHW+FEWtSS566gRQ3umC2O1hEzGFe+4fv4xE5L8SPSxzvqXy1PaVzAwoAB/IQBDuqx0tkhi5gvnE5lnClNxBRoM0UDitQ1+CW3GRuzweJo4CcWg8RL63n7H6gSpUgGvo5stZKMoBHwfROLcyxUuBelSp23ytcEC9XjpeiLVHNp+0IxGhF0BVxplVSxc85nxLwk4dpSCEyf2278620gdxvCr8nuvLnUtG9abv9FmGR4jW2mJyEQ/15n962G92oCD7hylQ1VlnGrgGyGT66P6MiZgT8GCtLnPVICmotHTHz3NvMYYQYHUvm+DqzmIncclDzGwwiwn/a3xI4hbPx6pSpNdPQecPXNrM/I+IScq9pFeexcFAsuiEhTlaXS9r8b8pr7i+83X3VZbytsi5ZmE5RaLURCMxWaAZauTRX0n1qiTvflDd3V6R9cZe5mXWdNyW5gYkzFZYxwEOauh63B6/bGK42mOaLxoqtDQmRVrHJDWhIGSIUoaY8JicST6cYObtoQubFotBk5rCD4VaujMFAZpx7LZcJ1YnruvoJL6wfCXrWBaYf29vgMPpzBwQ+308MIJhfT7+D6vPfD7RQ+nPnTJtfvYfTVcHTcewXFuYoHxfllu4uZK11w6xr6XMQojYuBteWWPM4QjvrDHdUtl8s+d6/7SqeDsNcMLidnF++uL3q0Z70pbzfqJLLqhrb2CAobXu1Hw6OT/nF/RHtLZWzBZQvPpRvwdBuBbYdqJZB/p/r/TvX/6ql+iPgWH+2gzLmQZKnONZ5C8vzIFkd+zDsXbmLSSaD+hwHpu8qdJHoXsUwZS0KenqgNutH5ek1f+/G4S63NsCOMuJ81/7/3h4K9TDxQXtz8XhDGaMwn5M8G/men/n8ApW4hN0ju6EG7EO8qp7rEcuT6TadultjatVOIrtul0/cXUxYx0mO3JnhwNUH4QNLrV3LVkr1dHngI9JdI27vlawqiP+Lqm2a5f/PshqYk8auJIOoD/w8m3CHB
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List trust authority</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/trust-authorities"}></MethodEndpoint>



Lists the trust authorities of the organisation. The service uses these trust lists to validate issuers and verifiers in OID4VCI and OpenID4VP flows.

The list starts with two built-in trust lists that the service returns for every organisation. They have the IDs `0` and `1`, and `disabled`, `createdAt` and `updatedAt` always hold `false`, `0` and `0` for them. The trust authorities that the organisation created come after them. `pagination.totalItems` counts the two built-in records, and they fill the first page.

The largest value of `limit` is 100. A larger value gives HTTP 400.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returns the trust authorities and the pagination data.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustAuthority</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust authorities on the current page. The first two records are the built-in trust lists, which have the IDs `0` and `1`.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the trust authority record. Records that the organisation created have a UUID. The two built-in trust lists have the identifiers `0` and `1`, and you cannot read, update, toggle or delete them with the per-identifier operations.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ETSI_TL`]"} schema={{"type":"string","enum":["ETSI_TL"],"description":"Type of the trust list. The service accepts `ETSI_TL` (ETSI TS 119 612 trusted list) only.","example":"ETSI_TL"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the trust list. For the `ETSI_TL` type, this is the HTTP or HTTPS URL of the trusted list document.","example":"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the trust authority. The value is an empty string when the create or update request gave no name.","example":"EU Trust List"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this trust authority is disabled and not used for credential or verifier trust validation. The two built-in trust lists always return `false`.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was registered. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was last modified. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"trustAuthority\": [\n    {\n      \"id\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n      \"type\": \"ETSI_TL\",\n      \"value\": \"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml\",\n      \"name\": \"EU Trust List\",\n      \"disabled\": false,\n      \"createdAt\": 1747011600,\n      \"updatedAt\": 1747011600\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation ID is not valid, the wallet is not resolved, or `limit` is larger than 100.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List verification history
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-verification-history-v-3

---
id: config-list-digital-wallet-open-id-verification-history-v-3
title: "List verification history"
description: "Lists verification exchange records. Each record holds one OpenID4VP verification lifecycle. The server sorts the records by `updatedAt` and uses `sortOrder` for the direction."
sidebar_label: "List verification history"
hide_title: true
hide_table_of_contents: true
api: eJztPWtzGzeSfwU1X1bOjaiH5Ty0e1unleQsE6+tWIr9wXJpoBmQRDQEJgBIiXGp6n7N/bD7JVfdeAzmwYcke/dSm63KWiQHQHej393AfEoKpnPFK8OlSA6TV1wbTeZM8RHPKXxJ2F0+oWLMiGK5VIUekFOaT9wnMpFloYkUjLypmBieHLw7aw4v+Yjli7xkA3IxYUQzNWeKaKmMJmYSZiXXC5LNqoIaVhyZjFBRkJlmmmTw6BtVMJWRkVQ4puCK5TD74FJcigucRVdSaEZoqaUDKovh+DvXRqrFuaFGZwiKZiSXM2GY0iSXABSbM7VYiTyRIwRAqjEVXOMzKRHSECnKBf6Uz5RiwpCKjhli0fjVY2sm1BA6VoyRW24m+NuIlwBMwMl9JrmcXnPhHqSklGOe05IcvT6xJM0U+3XGtDljouBinKVNzF9SXrLCUjRjdxVX8GlU0rEmVDGiJ1KZfGY0kjeX06kURBtqZjqA1FnDzta3DFDyVnHDEKfMTpS5mVKiJSkk0mSm8ZEpMXLMzIQpi6Af4XBrAEwKyTQOvpXqhhhZ0MWfiWaMcKNJxMmBho7dwjjFzEwJQv1+2n0gBSuZYURWTNl9V2wq56zAeTLNqMonGZlSk0+YJpRUVBnPC8BsTBFBp3a/5YhklWKaCYNznToWGhbZgAxNDUsp5Q2B5cWCSCRApQACsxg0uN7QG5ADqvOMSEUywDP7M67t0LOCgt/jJlpGtnPOaTljT2eU3DGxFLgwu4NvSnnLVE41s6uQzKgZywaXIkmTQMthkRwmuRQjPgbtcsLH3NDyPS1LZlBnFO+6cvrueZImFVV0yoABk8MPn1qa6vVses0UUDvIlCT6hldIgYqOucAJB+SICDamhs9BbslMKEYLel16oEe0LDW5pjkwFMl2s0GSJhyW+HXG1CJJE9ja5DCRo5FmJkkTICMQJzkc0VKzNNH5hE1pcvgpMYsKHuXCsDFTSZoUbERnpUkOd9NkygWfzqbJ4e79ffrJT1vyKTftJZu4/oPewUAi+nB2LF0xxJoNHgvgnoWqufJLFFvc8pVGAdS3mTCuIjMQNL/TJihM38M2TKUC2acCDYfdBiOtfFlxQNGaDshbVjFqcP3ADSls4xjmQbBgtCbczgXqi25rBg8bVpCSa9MwPDeMVSDBdlEeieONkLcpMj8qBQfVhIkg90I6dC2H9/GIxbRvC9hdVcqCJYcgIz07QpWiMBE3bKqj77VRXIyTNGECWOdD4oT4ChSMWwg+KpYzPmcFyE2kfa4qK+ztr2l+w4rk4/09QEanVclg7t5HljHF9YLEz5OCjbjg+CcvmDB8xIF1kEMVZ/OlLoLnIRBcSnTFcvit+Yxh06qkhi0TzhiSkwDIsNhIGhyNl/P/9YJwUfA5L2a0XIadR4NqLXOO7OdMdkCpnmQZHvUTnxH2Ka1APayBu+TihhXwUy/EOAsX42WQ20U+I9S1cf2TJicsZ8IoWvLfWEGGNSZbJ8OTZ8tgssNPOAD1ABjO0eATwxR4J853AR9zVhpQdcuEH4c9Ef9zCa4FWP7g7loNz4qwU1tU51asQRXCePtpKR2CN/EQ4GqVAyskaUJ1nnyMLIb9PrZl3g0/Bk3XAqWz7qp9Bz3qLYPzs45mZiIV/83qg7dW7TV0ey6nFVUMvGuu3WDrU86rC3nDhBsEQQDLBuRnjRYAdxjVPmu4hdeslGKMNhZMyy16LCHSGKxjqUCS2Od6IFHOGYJn/arI2PfHE7eUm8A0lvVT+wtvxlpIFOfiZ7E9sQ5m26SgL861dcGDf6/7HPxeqlxLWTIqGmTpOp5fijQNZLsGrhHKwEf2Kyg7mBrX/RLIO+f6i2E8kXqJvBC39Aq+oIEBTuHZxQWfsgz8K+uEaYN+3FdfncRhHNe1f0YWzAy++oocgUfAcuPHOimdYjhTB7xebAkdUy40hGM+DrJBFUIafC8b3GMg6YOU/7QUoeUtXWj0DDWhgrBpZRbWJyYXkYy7UR7rlEBA4LAbW40hZ8Yi5UAEFvFg9lEnxPA++jd8ytBPxbkbQzBIFoTVSRTrTq7gnI9p0KzoGu7v7sI/uRQGnMDDTwmtqtJJ084vGtjlU3dCef0Lyw16gkhfbmfrSZPA103me7fS+/dKJ05+WNWMbi3wmd2NW/Cn673EDIjupkB6/OAA/OZwWQi8Slc0v4kzVQi0HY7R4Fnsy24FV/VZww9NyUjJ6XJ7BGLZCZas49DOSVjp1S5YDyyP1o5rYncPOcVG8z6eTgFNVhmSFflRxd3CTo3hV2dKGpnLMoPYN0yMYjShGMZY27hgxqXKUCxwg1xMLBWmVID2hyS7TC6TzLvnaOJSCJTdNzYqTb2+dN867rVgiVlZuh8EsTtJ7AfkDysATa7sT6H0eSlNhvhZ8F8hsqs9ROc/9MavA/K9DSSDw0Cdal+SwiEVNZNI16EapkUaUkiwsXNacshkRsrVRZbI+WBUCSUnx+TobFinLi3RgfdDRJZ8y77Ld+l3B9vPr78ptg9G+/n2d8Xe3vb+6AXdvd7Lvy2es+Q+TfgGlBlCrlPQ0ktEHA5MXJDd0NEorNwQUAksthQD8lpGyTKaAz/Gbpf1rZbSEEKMolBMNyZtIP71t/t71wfXu6MX13v5Pn1eHLAXo6/pN4Cs8+Z+UuhmrsW7jjr7Rfbnt0PCRC4LVuAe/PSWwAdScF2VdGFdbFZhfGRVSohKnE+ocyo0PJeXHJQMEsJIglGo54NGrDwq5e2AnNY6cabBm2+zxFQWTJOtrMivaMVd+g//Hvxya7Jng4gcsXO7nij4WMTHXoOvIVYK9h75OJdKsbJmckvLoMlrN7kD4XrgXs7Kch0kuG2Y6VuUkhafi5jxLp3Prqdca27N6Wo79F7ZGNtq2aBUG0alni/oQKuaLBuhgTg5/umVd8vQsdOzqpIKkgnoJsJGTa0yAQ3y06sOdRy2OVWK26TVEiDQhzJdg+S09YQpFmWTm9kYmzYP5n5JGkgbqowGK+TSbdo/GpLJYA/KopWOPxm+bALtlUc8+ZQWDBKE4F/FAKB6GTOrz3LFUMvRUjfz9etMzpV+wOYvh7e75YjilFZ6NXzekXAxwZQJo5uWjKkB+RH8ANijmoYaSTvoIFdT7mojY9Gxnw0E6xSbtx3gstTIjmbliJelRpnyM0t1NaVV17c8Qh9RjshJeJD8g1YEEj7Awi7x5F1mFH9WRLRDXWs0KaXjTxdxLPHugDhrsq5LXGUQPrqBAjuuQbNDPBFtKrkB+xYbjAck++XWXM3zK3DeoTBT5P+hi23QSynJplpeTQuZOx31uP0bimpmYhIHT3b9zsJOLAjUO/WIM7ur4Aith+OH8zevz8BlYncgXsgcleTCwIY6Ho+2KSIcmJLV+0gMWJUAzJVAvlgvrq8t/6AnV0T0AAMeyeMtqvQCmImJOStlxdxuardpP7y/IFxoXoA79+4MPj/rSt6TmUZ0+P33wDMO6i/LOnkvv4Sl7a4NIPkSZVc++C1BsjhwPm76zCaU7AYh1r/iepkx7sLYVNgdLYqAfLyHUa7o9M+qGbWRfdWq860MuA4vxd6glXQ8jJO4YNY38UStJx4ifsh96lbyc3Ap9gc96Uy7nvPdm1Z3LA2mbcCjFzZNtizzfCmeD1oJRUe35gLoBLGi4RWT65lpmHJScNspAo4LxVwThpNLnLsFeosH7fVtQvMwilEIOlurdCh1WbEASaVkzjR4+dxYL6mOyhp8BI69y5r2ZK3aXPIWkyC9vOG+W2atGyn+CbMBFoj+ojJyrGg14TnRfCyomSmm07ZicFzpEXUUA4VaUj7VIe8IP6JHbR1tB9US3xb1WK6Y7VeK8LfZkD6NcIdZQW3otCJbXBDNcikK/czGLDZ47pZFyS3VxC2Ei4YmqS+9aEm1gaAJd7gTHDWKrI8wLctiBowvg7ZswWYlD0CR2DnyJurDehwYtZaJe7pcdtyF78UaWKyodf3aYykMsJb1/JihBTXUeRzXYMSoV1TkJcRZYNNfU0gce0cW/hpLwgZmkNdO6xLn1BYXHk6CGIYBAnEyPAElCLAQeQ04wJ6A6c9LDgolIMNHhM4pL0FquyYMIfrYYpwNeh4CgrQokCtoeRahCun++04MxmwGJ/bgQlrLKcMg+k6nTGiF5UUMLKyjMpJlKW/bwZlzyAY+Np4Jw8t4Zir0LSau42yHVdab93h0cFrp90boeUvDhImz7nVvpsdNWVTjyMnP0Z9kofrGimMP6m7VGHWjqNAUWzNPqOmtPSzf0jb2F/VkBJkNm8jUlBXN7gBSzBS6hL1Jth6w/kY1+/pgvajY52aqtOlBLLdbkTFt0NaQEXfCmwxH+ocktbtCG20h13pGRR45Q7UT3tBZzhNJQWqx2lLKWxyNPY3RjHTU1/Q1IEe2wmYrBa4TMLg0DjDNoAfS54YbxhszApBQ5oJA5lCl3gqxGgkEyiWOkvu68HWBBFqb6wX6k/3Bbg0XDFjdQxA5yvPqCoUL3evwZ8HmPGdXfkpUabxAKd80/UyOpRCQ/xmeEBxYh1Je/57FqTEkTBYjn0H6LPNQZS6qw7mc7nuauHkF6hKqIQT08DatBSoraugRVPAgO/U4NkbhoX6ORhqwy7+BvxvukMamo0etrSfXkipsNFdg8KJmJwShdt1Xmf9mcXcDV9hV8APvQx07s94odg830+W473H5PQ4uIExxRXioeLvK9oqACevR4ApDZ2Qtp9hlXs1MoxTmAVw4He+FWdgZojpXNI+rwrveBN9D0aYT1s0f7MDW/mtNvFVtDrqhfgD1Rm9QkMA1GzDAYmdY0dc6XC0Vl1o0qld73xx8s7v3Yn93t+X7vAOCcbP4Qj7QO7sfdc251+R7XorgSuvCTQikbKyV1i0TC/tNCKQUm8vaskCDr+OwLlsQ1zRDiWC3jvpQX9jMobJO57A4h5L4Bkbg2DqpwxNbRGc2pnA+Q4hzHRnWpRkaWRR78ORqpjgsimkZP98VNQbYFGFIk7sXu99daSquCqH9xwnVE7Qddpozqc1bN+XPim+QVXo7jB0vDw6WGq3JrqQ23hXqTx18rjqZf/ofDyzBNlYhBdQeoS1ejMlE3q6AG5RgwUo+Z4oVh5dim2RuMwDn7LB+EG3onFPy94uLM3L25vyi2ZSBhdss3sss9PwwgVkFe4KkuQTivnoZN5oV0ERAyQ/vT90slpDR4IAJdpQhcO+fHxN3NiLKgmvcGnQ3oQoYAP3h/WkMLDmG5iTDIVJASb6WeJSGj0XocJsJ/7HROGJdC9tFH4PbxvfRIC+jCqdqu3fvzETJ2XjiEtCGKXC054ExdKvhpkOb9ib6hXp38LGL9WIVt8zWnJOkSYuP4BskcvjDfetBjf7EXz7WuTZ1FOmZtYL3zmu7aBSWLSzystEqWik599ojkhUaC6R1O+Mm9Ud4Xm0/KypCh3zl0vYq16RYzfQEMqZReBJpthCJeGPt86uaGZLF8FvfJDSvr8Xm9M510XQ7jP7VaHkksq53/sTQoOmlI3K2zRKDYaameknKLvRZAURCinwT891I7OIga8E3s9hATCY0eDAjxfREQJsRaMBKsbkNMrCthxoDHYGWVnHb3HoIlym9EKBUbqqYSUIXf9jJpadntE11jGfK5UJ7TfTgUgTR0m5Ct+ycKk6FsWQLrt0qfb2VCTrnY2qkGkQptMGYma1n2TNrcSHpyouDebU939sO9sTWG/r3AvuCsZgwE7XKdHrnWslbbU93IH7Wf3TfQmgDxdXKNk3UbjfQQ3ENfigtF5pr22w2wjYtLPgBk+6AusOMDXRDdKHfDHb7VNt1/JMmNxgUFR45ig3HsqJQ9bNMsxzJM1Cz4GIFVxQ0LBDcS/xbBufYmPAdaZWSxSyvLZpU422u5TbWd1eh4LOZw/M3ZO/b3b3n29+QIyHYHTluhJHO23ZKSETW7fhvb96S7NR/9sYTDnm+gTyF7+dp5ivAK7T5iiVOZNNY9vKVPUPa3jH4NsLeutORO7O++u9p4/pxfMlwhXCksKWz3ARx9CzKRYiAwBNcKUKDSxHqAW78djhlFfE2thfAIscTJd2R4nM6oop/FpI3SwY5rrFBg9MSrdGEuwabz6bb1xSjLouqFdLQWosCoHRWE5ZUGziVnl6hi6fV4mSHbY5OFBR7TGRl0xirUOlpHHMI9cT1S1qdepYOs6Q2ZLfYLmyhKKh2Glt/aujKXvkOmF/SwLmmlD41my6zHc/izND6jbvYwPyHhtDzwFtgDpm2B1Yt3GjPoOC1xCoEUc0+kUsP32VySC6Tv9iHtn94f/HXy4TcZyn6/xcrjcWgf73IhjaKhSNogO1Hz6kte67NZkaufDnONgH9Wl5hBRs+ofcEf3g1cQWuQ+MLoLhTDitSTe5/aaJRF31WlWHV2wqF4cbE+uLLS38/VJ1lPWxPEf14QSf8uWUHEH6bI0cH1jLvA0S+aFbhVnRabdvfsNi/WrLIloU0uDSQHsQ8VH06BGKScNTjme1sZq6Gxg1ZcOY7pDUUmWszgLGFM32uYQez354HsnWSu4HArhfGIINclHD1ykpR3GrJUp+0BTlsimdXfv/3v/8HyGW7Lf5fquv7Whe4Wr8+DRmXDaofQ1GABbfnS/CKktVBnQ95ZhqO5PYlXkhcUOlziFpZvI5nFI4ubTBDPNoG2iFjfg5Fig0o8B5XsUumraS7K3RoMuFFwbCT2dmVs5OXurnesZSqgGtO+noMmkuewcnGPDwfevTqhf0hzbBYCgTOPtztpWSxl5K7/ZQs9j/iSVDswuw9pefvFbnH206G9tcDyK/c1R/qCyf2dndT+G8f/n2xC878iJdsvTJ9hdWrEcGnyZgJZu/7iFoBmsf2uMjLGaofhyFeMCVqdEkh8xm22T9Avdaq/MlV/PatEf74qU2dMKWk6lsByifQINKfuDmFYfY0Ex8h5kCBEZ63TgmMtbcE3XIdrXMSz/HQJU+YwekJTkWmTGvgvc2Wt9vxkpe9aSLfSJ24+kurOPIqZmq3qYGAfqufOneDZdzsqAsb7Yg/skW92esZ40e26EknQo7Bn9L2p65gcfyxVvWuraS5+ssNe85fNhrN/Q7dsEVqS4dWUkEBFoc3bGGVHxSzssEQs4461G1c4U4xLUufGrRImQXpnFzJuJaYkbj65gpabe+u8owIxuDeNjt/I5mOq7s6WqejrG5FPBe00hP5xHTnsazWtX8Sl96F2rR/tO4JaLXB8XaDddT6s6STcUWvZf+Bv84hu/YxybS+myh07YbWxbiVNe4wXdKvtKyjyqd4W107dbNMp5bbKiT2VzmWFUx7HZC0fYVOdC9Ny1J3O1hCO0mnq6OvfQH4sGGl8GiDv3isjwcNN9hHfVY/1TEp9kwdGOwl93U1WDW+bTA0UdSNCAChNLQcLrHTnQAbHo7uGUM7WLd4xnPvv/CTA6yPmRyAhpvXQLfhTZH2IrSwwvP71N2Otn7u1y2Q/XVoDWpAO8aE6jPF5lw2Tkysd1Ztz5xif8L7/9wMnSXQqbOrvGZ35vErCHZnOrO7SDztu7IBb7ZcH/we+ysvl5zs3ODCS5s59rdThrb6wNL+gsfQjMj8BYFwkWTfjYN4DyeGj7Nrbc9kNA42vPUnN8KR1ZGcqfr6TrcgLQoyq+wdKcBqWav9xx5v/Y0pGWHvJgmH3V1H1fWMlxYxC1w38MclHsSZq69VbXDq/rctG+dJ8KAFN70Cp7H2d1/XGTl/a9GTF93kkqGGcjlocbm7I+hLYL/2AqAYsBd4YV670+8BwKy/m6ex3rdtZ8Ky3RLm6GxcLxFrDDqH3vrugmkYtRW6xx5G6yZsnfxBwyErOqFZryBMGHXpdJjy4IHX3cQIYRTiHKBOcPNx3ZGKenTfXodNOsBGv01ip/oo1d8oFLTheGW4hCFxaZUuCRtnUyAcEHBbpcCjatjK6hJArpxXsKqUC6zVc3/vLXrlRR9x9/6Nifuz8N0t1h1ukObFvz3fhYv1ZmXh+Ci+KmsTmxaTFCJ8ls8UdsB++JQcVfxHBn9+hCuuDB3DRb8hm2mvCK6vYjp+lqShoQloOGVmIuF24TFey2tPFSc78+c7tn1ix4nFthWLHZvT3NHFL7dmJwZ8ZxJUncW478LhEzaVjiAQJ6gS7pc0ptKHOzsFm8ptSCfysaLCDLhMujc7noUq/rJp1s1wbkARj5cN1/bnNiAfa6rbqAtZzNO+TrTZL9yddHbb6hskGxarW9s4G9qWiFYjw8WkdYlj1pgHLhmBZUJyt1JsxO98CiyzMJKMbAnpLpoxivISaVDRnD1L7am55rSHxA38y0LOFJBj+4Yt/prZyJyLkfRiTXMUazalHAjp7lr5r5p49b2s39dfNakeb1iLLGGQr+3q+Gwvh3+nIbnQOJDYvpwszuwP/VGZrTcoFsNn6ME88FYzXxLQ7n5DrBcIGKOdufnNdfTD5RpwSCjFFI+9ewalZxHsTnzozjYVa0NFQVWhtxFf7EYaYS+KdccspRFaqPi/OyZbcHtCSoanFy/J+QlUa8i7Y7ta3b7ygkxPZL4zPXnVPZ2H6qbkOXOH7jznVjSfMDgT1Nm629vbAcWfB1KNd9xYvfNqeHz6+vx0G8bc11F7vZ1ALJ8vjvwie1tMsr+7fzB4PtjDfIDUZkpFBA+mrhtqs9Y+RVOLB8vzx3sZ/ngvwx/vZfjjvQyf4b0Mztobdmd2qpJyLDWjWvzkPKgPyRzevmB9KEy+xl5UaMsDZ6mwbesxtODyOX32EfLL0NbzIfn0CdJ8P6vy/h6+tjfeoo/FNdicJXfexirwy77woZcsUHOI3vuAw5PDxHpmGwP+0Lc3rADFp0gfCckfb3NY/jaHFVSvCydPIvu/7H0JK1BbVWV6KrJf4I0JKzBpVX2eDP1nf2fCCtijEtWT4TYPe2vCCqjilyc8EqwNXqSwSu78+xQeu/pTX6WwCrbojQqfZc9+H288WEGR1rsfHs0xv8M3HqykSjsf/4Xp8s993cEKzHsLD18c+z9effA7fPXBCi6qX5VRs85H+KC47UH7AF0YLlsJAYUddoRXkkejOpn7+ziB/P3pBXQIzRrXUtKK26Yj9wfM7n8Si2judm7UggD/D1zeO+QvkEH6kS3+Gh63vywdEPKx3ttJ7qHe9n8A9Gqu
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List verification history</h1>

<MethodEndpoint method={"get"} path={"/v3/config/digital-wallet/openid/sdjwt/verification/history"}></MethodEndpoint>



Lists verification exchange records. Each record holds one OpenID4VP verification lifecycle. The server sorts the records by `updatedAt` and uses `sortOrder` for the direction.

The response also holds `verificationHistoryStats`. These counters cover every verification exchange record of the organisation, not only the current page and not only the records that agree with the filters.

The filters combine with a logical AND. The `requestPending`, `verificationFailed` and `expired` flags are shortcuts for common status filters. `requestPending` and `verificationFailed` overwrite the `status` filter, so do not use them together with `status`. The `expired` flag does not work today; see its description.

The server does not return a record that a delete operation removed.

`search` matches a part of the holder name and of `presentationExchangeId`. It does not look at any other property. `sortOrder` takes `asc` or `desc`; the server uses `desc` for every other value. The `requestPending`, `verificationFailed` and `expired` flags act only on the exact lowercase value `true`.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter the verification exchange records by their OpenID4VP lifecycle status.\n\nGive more than one value to match any of them. Repeat the parameter, or give the values in one comma-separated list. The server keeps a value it does not know, and that value then matches no record.\n","in":"query","name":"status","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["request_sent","request_received","presentation_pending","presentation_acked"]}},"example":["presentation_acked"]}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by presentation definition identifier to retrieve OpenID4VP verification records for a specific verification template.","in":"query","name":"presentationDefinitionId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by individual identifier to retrieve records associated with a specific individual.","in":"query","name":"individualId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by mapper identifier to retrieve records linked to a specific individual mapping.","in":"query","name":"mapperId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by the holder's Decentralized Identifier (DID).","in":"query","name":"holderDid","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Search term to filter results by","in":"query","name":"search","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Sort order for the returned records (ascending or descending).","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"responseCode","in":"query","required":false,"description":"Filter by the state value of the Authorization Request. The server compares this value with `vpTokenRequestState`. Use it to find the record that belongs to one wallet response.","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"requestPending","in":"query","required":false,"description":"Set to `true` to return only the records that wait for the holder, that is the records with status `request_sent` or `request_received`. This flag overwrites the `status` filter.","schema":{"type":"boolean"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"verificationFailed","in":"query","required":false,"description":"Set to `true` to return only the records with status `presentation_acked` and `verified` equal to `false`. This flag overwrites the `status` filter.","schema":{"type":"boolean"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"expired","in":"query","required":false,"description":"Set to `true` to return only the records whose Authorization Request expired, that is the records with a `requestExpiryTime` in the past.\n\n**Do not use this parameter yet.** A defect in the server makes the filter compare against a property name that no record holds, so `expired=true` always gives an empty page. To find the expired records, read the page without this filter and compare `requestExpiryTime` with the current time, or read `requestExpired` on each record.\n","schema":{"type":"boolean"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server listed the verification exchange records.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>verificationHistory</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Verification exchange records for the current page. The array is empty when no record agrees with the filters.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the verification exchange. Give this value as the `presentationExchangeId` path parameter to read, delete or revalidate the record, and to receive a DC API response for it.","example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier that the server makes when it stores the record. No operation accepts this value. Use `presentationExchangeId` to address the record.","example":"6821b4b0f5b1c2a3d4e5f6a7"}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenQrCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID4VP Authorization Request URI encoded for QR code display or deep link. The holder's wallet scans or clicks this to initiate the presentation flow. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State parameter for the OpenID4VP Authorization Request, used to correlate the request with the response."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Full OpenID4VP Authorization Request URI or payload. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wrapper that holds the Presentation Submission object of the wallet.

DCQL is the only supported query form, and a DCQL Authorization Response carries no Presentation Submission, so the server returns `null` here for every verification that a current presentation definition starts. A value is present only on an old record that a DIF Presentation Exchange definition made. Read `presentation` to get the credentials of the holder.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation_submission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

DIF Presentation Exchange Submission object that maps the credentials of the holder to the requirements of the verifier. Kept for old records only.

</div><SchemaItem collapsible={false} name={"definition_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Presentation Definition that this submission fulfills."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>descriptor_map</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of Descriptor Map entries mapping each requested credential to its location in the Verifiable Presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the matched credential (e.g. `jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Definition that this entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression pointing to the Verifiable Credential within the Verifiable Presentation token."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>path_nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Nested path descriptor for credentials wrapped in envelope formats (e.g. JWT inside a VP JWT).

</div><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the nested credential (e.g. `jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Definition that this nested entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression pointing to the credential within the nested envelope."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for this Presentation Submission."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`request_sent`, `request_received`, `presentation_pending`, `presentation_acked`]"} schema={{"type":"string","enum":["request_sent","request_received","presentation_pending","presentation_acked"],"description":"Lifecycle status of the verification exchange:\n1. `request_sent`: The server made the OpenID4VP Authorization Request. The exchange waits for the holder.\n2. `request_received`: The wallet of the holder got, or scanned, the Authorization Request.\n3. `presentation_pending`: The wallet started the response but the verifier did not get a complete Authorization Response yet.\n4. `presentation_acked`: The holder sent the Verifiable Presentation and the verifier processed it.\n","example":"request_sent"}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Result of the verification of the Verifiable Presentation. The server checks the cryptographic signatures, the credential status and the presented claims against the DCQL query of the presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this verification record was created."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this verification record was last modified."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation definition used for this verification request."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VP organisation that initiated this verification request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Contains the metadata describing a holder. For e.g. Name, location, logo e.t.c

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder. For .e.g. DID or Name obtained from client metadata if available."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"presentation"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Decoded credentials that the holder presented. The shape of each entry follows the credential format. `null` until the holder answers."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenResponse"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Verifiable Presentation tokens that the wallet sent. The array holds one entry for each credential that the Authorization Request asked for. `null` until the wallet answers."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data confirmed by the holder during the presentation flow.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data confirmed by the holder during the presentation flow."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base64url encoding of the transaction data that the Authorization Request holds."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential issuance exchange that this verification started, if the flow issues a credential after the verification. Always empty on the response of the send operation. The server fills it in later, when the issuance flow starts."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token from the holder. Present only when `responseType` is `id_token`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token of the holder.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the ID Token of the holder."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement record that this verification exchange created."}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the dashboard user or individual that started this verification request."}}></SchemaItem><SchemaItem collapsible={false} name={"requestExpired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `exp` claim of `vpTokenRequest` is in the past. The wallet cannot use an expired Authorization Request. The read and list operations compute this value when they answer. The send and revalidate operations always return `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"requestExpiryTime"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the Authorization Request expires. The server reads this value from the `exp` claim of `vpTokenRequest`. `0` when the request has no expiry.","example":1747015200}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Validation result for each credential in the presentation, with the signature check, the expiry check and the revocation status. The revalidate operation writes a new value here. `null` until the holder answers."}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme used by the verifier in the OpenID4VP Authorization Request.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI the wallet redirects to after posting the Authorization Response. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`, `iar-post`, `iar-post.jwt`]"} schema={{"type":"string","description":"OpenID4VP response mode determining how the Authorization Response is delivered:\n- `direct_post`: Response sent via HTTP POST to the verifier's `redirect_uri` without encryption.\n- `direct_post.jwt`: Response sent via HTTP POST encrypted as a JWE.\n- `dc_api`: Response delivered over the W3C Digital Credentials API transport without JWE encryption. Compatible with both `signed` and `unsigned` `dcApiRequestType` values.\n- `dc_api.jwt`: Response delivered over the W3C Digital Credentials API transport encrypted as a JWE.\n- `iar-post`: Response sent through the Interactive Authorisation Request transport without encryption.\n- `iar-post.jwt`: Response sent through the Interactive Authorisation Request transport encrypted as a JWE.\n","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt","iar-post","iar-post.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifier Attestation JWT sent to the holder, proving the verifier's authorization."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual that the server sent the Authorization Request to with a push notification. Empty when the send request did not set `individualId`."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier of the individual that the server sent the Authorization Request to with a push notification. Empty when the send request did not set `mapperId`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement that gives the terms for this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Data agreement that gives the terms for this verification exchange."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce used in the OpenID4VP Authorization Request to ensure freshness and prevent replay attacks."}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiProtocol"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openid4vp-v1-unsigned`, `openid4vp-v1-signed`, `org-iso-mdoc`]"} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier returned when the presentation definition is configured for DC API response modes.\nIdentifies the protocol variant used with the W3C Digital Credentials API (`navigator.credentials.get()`):\n- `openid4vp-v1-unsigned`: The Authorization Request is passed unencrypted to the browser's DC API. The browser can inspect the request for risk analysis. Use for development/testing only.\n- `openid4vp-v1-signed`: The Authorization Request is signed by the verifier's key and passed as an opaque string to the browser's DC API. Provides verifier authentication. Recommended for production.\n- `org-iso-mdoc`: The Authorization Request follows ISO 18013-7 Annex C. The wallet answers with an encrypted CBOR `EncryptedResponse`.\nOnly present when `responseMode` is `dc_api` or `dc_api.jwt`.\n","enum":["openid4vp-v1-unsigned","openid4vp-v1-signed","org-iso-mdoc"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcApiRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Request object for the W3C Digital Credentials API, structured for browser invocation via `navigator.credentials.get()`.
Contains browser-specific request formats for Chrome and Safari.
Only present when `responseMode` is `dc_api` or `dc_api.jwt`.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>chrome</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials API request format for Chromium-based browsers. Uses the `providers` structure per the W3C Digital Credentials API specification.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>digital</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital credential request options for Chromium-based browsers.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>providers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credential request providers, each specifying a protocol and request data.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"protocol"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier (e.g. `openid4vp-v1-signed`, `openid4vp-v1-unsigned`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>request</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The OpenID4VP Authorization Request payload. Structure varies by protocol:
- For `openid4vp-v1-signed`: Contains `{ "request": "<signed-JWT>" }`, a JWT signed by the verifier's key.
- For `openid4vp-v1-unsigned`: Contains the full Authorization Request object with `client_metadata`, `dcql_query`, `nonce`, `response_mode`, `response_type`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The OpenID4VP Authorization Request payload. Structure varies by protocol:\n- For `openid4vp-v1-signed`: Contains `{ \"request\": \"<signed-JWT>\" }`, a JWT signed by the verifier's key.\n- For `openid4vp-v1-unsigned`: Contains the full Authorization Request object with `client_metadata`, `dcql_query`, `nonce`, `response_mode`, `response_type`.\n","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>safari</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials API request format for Safari-based browsers. Uses the `requests` structure.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>digital</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital credential request options for Safari-based browsers.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credential requests for Safari, each containing data and protocol.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"data"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSON-stringified Authorization Request payload (Safari's DC API expects a string, not an object).\n\nDecoding it yields the same structure that Chrome receives in `request`:\n- For `openid4vp-v1-signed`: `{ \"request\": \"<signed-JWT>\" }`.\n- For `openid4vp-v1-unsigned`: the full inline Authorization Request object (`response_type`, `response_mode`, `nonce`, `dcql_query`, `client_metadata`, …).\n"}}></SchemaItem><SchemaItem collapsible={false} name={"protocol"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier (e.g. `openid4vp-v1-signed`, `openid4vp-v1-unsigned`)."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the OpenID4VP Authorization Response must be encrypted as a JWE. `true` when `responseMode` is `direct_post.jwt` or `dc_api.jwt`. `false` when `responseMode` is `direct_post` or `dc_api`."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `false`, the signature stamp is hidden in signed PDFs."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Page coordinates of the signature in the signed PDF, as `[x1, y1, x2, y2]` in points.","items":{"type":"integer"},"minItems":4,"maxItems":4,"example":[100,100,200,150]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>files</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of files generated during the verification, including signed and unsigned PDF documents.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential associated with this file."}}></SchemaItem><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Error code if signing failed, null otherwise."}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Detailed error message if signing failed, null otherwise."}}></SchemaItem><SchemaItem collapsible={false} name={"signedFile"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL of the signed PDF file."}}></SchemaItem><SchemaItem collapsible={false} name={"unsignedFile"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL of the unsigned PDF file."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the presentation definition at the time of the request.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the presentation definition at the time of the request."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>verificationHistoryStats</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Counters for every verification exchange record of the organisation. The filters and the pagination do not change these values. `verificationFailed` counts a subset of `presentationReceived`, so the four counters do not add up to `total`. The server returns zero for every counter when it cannot build the counts.

</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of verification exchange records.","example":128}}></SchemaItem><SchemaItem collapsible={false} name={"presentationReceived"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records with status `presentation_acked`.","example":96}}></SchemaItem><SchemaItem collapsible={false} name={"requestPending"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records with status `request_sent` or `request_received`.","example":24}}></SchemaItem><SchemaItem collapsible={false} name={"verificationFailed"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records with status `presentation_acked` and `verified` equal to `false`.","example":5}}></SchemaItem><SchemaItem collapsible={false} name={"expired"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of records whose Authorization Request expired.","example":8}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"verificationHistory\": [\n    {\n      \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n      \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n      \"vpTokenQrCode\": \"string\",\n      \"vpTokenRequestState\": \"string\",\n      \"vpTokenRequest\": \"string\",\n      \"presentationSubmission\": {\n        \"presentation_submission\": {\n          \"definition_id\": \"string\",\n          \"descriptor_map\": [\n            {\n              \"format\": \"string\",\n              \"id\": \"string\",\n              \"path\": \"string\",\n              \"path_nested\": {\n                \"format\": \"string\",\n                \"id\": \"string\",\n                \"path\": \"string\"\n              }\n            }\n          ],\n          \"id\": \"string\"\n        }\n      },\n      \"status\": \"request_sent\",\n      \"verified\": true,\n      \"createdAt\": 0,\n      \"updatedAt\": 0,\n      \"presentationDefinitionId\": \"string\",\n      \"openIdOrganisationId\": \"string\",\n      \"holder\": {\n        \"name\": \"string\"\n      },\n      \"presentation\": [\n        {}\n      ],\n      \"vpTokenResponse\": [\n        \"string\"\n      ],\n      \"transactionData\": {},\n      \"transactionDataBase64\": \"string\",\n      \"credentialExchangeId\": \"string\",\n      \"responseType\": \"vp_token\",\n      \"idToken\": \"string\",\n      \"idTokenDecoded\": {},\n      \"dataAgreementId\": \"string\",\n      \"userId\": \"string\",\n      \"requestExpired\": true,\n      \"requestExpiryTime\": 1747015200,\n      \"presentationValidity\": [\n        {}\n      ],\n      \"clientIdScheme\": \"redirect_uri\",\n      \"directPostRedirectUri\": \"string\",\n      \"responseMode\": \"direct_post\",\n      \"verifierAttestation\": \"string\",\n      \"individualId\": \"string\",\n      \"mapperId\": \"string\",\n      \"dataAgreement\": {},\n      \"nonce\": \"string\",\n      \"dcApiProtocol\": \"openid4vp-v1-unsigned\",\n      \"dcApiRequest\": {\n        \"chrome\": {\n          \"digital\": {\n            \"providers\": [\n              {\n                \"protocol\": \"string\",\n                \"request\": {}\n              }\n            ]\n          }\n        },\n        \"safari\": {\n          \"digital\": {\n            \"requests\": [\n              {\n                \"data\": \"string\",\n                \"protocol\": \"string\"\n              }\n            ]\n          }\n        }\n      },\n      \"requiresEncryption\": true,\n      \"signatureStamp\": true,\n      \"signatureCoordinate\": [\n        100,\n        100,\n        200,\n        150\n      ],\n      \"files\": [\n        {\n          \"credentialId\": \"string\",\n          \"error\": \"string\",\n          \"errorDescription\": \"string\",\n          \"signedFile\": \"string\",\n          \"unsignedFile\": \"string\"\n        }\n      ],\n      \"cryptographicKeyIdentifier\": \"string\",\n      \"cryptographicKeyFormat\": \"did:key\",\n      \"presentationDefinitionSnapshot\": {}\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"verificationHistoryStats\": {\n    \"total\": 128,\n    \"presentationReceived\": 96,\n    \"requestPending\": 24,\n    \"verificationFailed\": 5,\n    \"expired\": 8\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, or the digital wallet deployment is not resolved.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The server could not read the page of verification exchange records.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List verification
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-verification-v-3

---
id: config-list-digital-wallet-open-id-verification-v-3
title: "List verification"
description: "Lists the presentation records (V3) in the wallet of the holder. You can filter the records by status and by a search term, and set the sort order. The wallet sorts the records by `updatedAt`."
sidebar_label: "List verification"
hide_title: true
hide_table_of_contents: true
api: eJztPNty27iSv4Liy0lqJfmei/fUqfXYnhknmcQTO05tJS4LIlsSYgpgAFC2JuV/P9UNkAQvkmUn2d2q2ZfEkohGd6Pv3eC3KAETa5FZoWS0H70Rxhpmp8AyDQak5fgD0xArnRj25GLnKROSHrjhaQqWqTF9mqo0AT1g/61yFnPJxiK1oOmnYvFowYzlNjeMywQ/cWaA63jKLOhZj741YGmNUdoypQnkebUZfm2aQId5lnALyYEdDj7Lz3LooA7ZjNt4CoZxlnFdYhprSEBawVNmFxn06MvhPLZD/2eiYvxhSAjhN4kwWcoXTPIZFFDmoMVYIHonliUKDJPKslSpa8Ztm4GCtsQFZsCGSMY7JG7ILL8Gw4bcxEOmNBvicQz/M2RwbvAB+p6NlWYwB71gyk5BszlPcyCiAyaV2GiwuZaMe2YxO+WWcZZAChaYykAXpztTc0gGn2XUi8qvT5JoP4qVHIsJSsWRmAjL04+0x7sM5ElyQTyI6emLnagXZVzzGVjQJtr/9K0hWm/z2Qg08q84O6uYuRYZUZXxiZAEacAOmIQJt2IOyJJcauAJH6XgyGVjnqaGjXh8jRCGm8NB1IsEbvE1B72IehEeVLQfqfHYgI16kYavudCQRPtjnhroRSaewoxH+98iPOloPxLSwgR01IsSGPM8tdH+Zi+aCSlm+Sza37y7630rwKZiJmxzyzqtf/BbXMhkF83+WDIgqmHwWAS3HFb1nc8qjcK9vBpqMHlqUVuWsMqpzFqYGKuFnERde5dKS0fq1BRphaSyINzEIBMhJ3i2uN59errsEEtdeQhyvQgkntsnwjDqRdzE0WXAO/d9Bw2/Vnar0wKOFiwVY4gXcQrenC3FnH59HNrh3leZYxEqWPg1j68hiS7v7i5xC5MpacAg0O3NTfwvVtKCtPgnz7LUK+rGF4OEfmsjoUZfILa0CxoBKxy0cM/gaa41bwv+aRfPlPSy8DUHYyFxYk92naAwYRjMMrtgN1OoORf0KmjLClDEagsz04X2vZis9lznpVdhVvP4GvEGRpbuiOTZmTsyRDXgT9wzuxenT9lBbqdKi7/cL+8dxc7wVnuxibK90rvUxKz5JP5Cps4beWHYxQ4zU54BuwbIDBvOs3N1DXLIODpWx9EeMyokFT2yAZmwmdKAm0gibhlFAp2GEXKSQosiJ2dNn+P03Hjn5AVo4VgsDHOyhoLgHrjYKQgs3Q2a/XIdsWHK6eid0V+U0oBkOWnx7kBpJjAqWGSwz4afo8+Rc5ScObXqoY/w3ziD3GND0sTi25FSKSDvZMKGMk9T/4NkTriY+0CsdV6yriIi6dLlujyeSAta8rSUxTIiKAQxFAQUdLjlsyxFkM9ebG+Ndkeb473RVrzNd5Jd2Bs/48+ju7pJOFkDjw9SfM2htb0wjYBllap8MOCWBFDIsfEkCM565OChQ8x7yFCrikikWlIne2e8zZ/HWy/6L0e70N9NNnn/Rfxs3N+CvdE2f5nsxs93miw4vo2nXE5gHVactI5gHkQ0DDyoIqCrhXypkNemg29WtQFNhbFKL4qTb0aQNZpfwMt4k7/c7e+Mnif93fF23H+ZbG31t8d7fHO0Fb9IdgBpVhSBvdMTLoVZ+/DbFCcurCtjR8hStZih1XE66FWuSWZxXIjJd+MQQnDbqhtplstf88zP8tFMGFP3T+u4hWphqehuo6OTX+sWsRArZjKIy5MlSZjxzDQSC1NHuBAKHwcgd01LCtCgHh3++QadITFFpgtGEQXaopkP3iUTv2ku7UCocinpmHEOhTOC0W20Wcy1FpQcsCV8aDqOwq57qzgF7QyuyeMpJRbk4NB2O2NcyYkjgBw62tHcGpFAgLMVaeowR6SX8juBsZCCmN1heKtfr9aywSttbrBX4YfRdVUyMs7TsUgNyV8BWOmrGc8cLuFWR+Xv7A+eMZAWOT9gxzye0qcFm4g5+FxbGbetGpNfriKlIFn1FnmJz0Yr0ojMlgZKdR6idHF7P/MOK1TckoKHLs0Oce25RNUZNTb8cmOv5vEVBp7DHhsm8X+YpP/lxrqMd2bU1SxR8ZD4+rhjPJFZblnA8+r8HK/RuJgxngAZD26n92/z6uzd21NupwxuUUxMKReZEqjBXqvXPiJmMU4rEbiSdMT3m6y3RdBsp6wSO2JxaHIEKRrIOaQqA39G9ZPg7NXHcxfdXZzi34MfLw2yKbj/l4TBI/e/IBPFuQww6Qwywk8Fx4laj8blus+sw6DlAd8SH9BGsW5mW8aP8Li860U+FenIEpu2qCgiNJFdqTqmSo+KeiAFKqoRnlWJpQtf0KS6IydJRAscFgELmN25GzfXkODCzoQ1l1akjYQtaRdQScJ8PeDHZP1Nxr1pFCU6HdyKoH7/s9wasGEXBsN9otwTOMsN8j3FaKm0/ljOCW2RK+X6yH/5mTYjoO0mBkSs37925CvAFnl1GWrwOIYM1V5YF0NU0XYnw1GQ3dpQu3yO2FKvodU5DKvKRXvb1jEUGMZToDJDPRJkGTcGkrIgAVgHLRla5suG8fSGL0xRTvQZrVtmQM9JGK0P3l10lnKLyW8DV5+l3MBoiuVrDVlQZce6YSvgvuCpSIRdrKHopU/jSUIWhKengcNB5rWNAIIv8gxEoFNvvTDX1CwMr6pqgQfi+WzERHKba89/V/SH20zohfumPB8Nc+WZQz88+EgoaP5pJzLPvI06s9zC/Y6AHvP7el50m7xWi6Oj0BPQcCPstBOazzooo2jk0FSRItNBX9sbVU+D95IX4+345agfb/Pd/u54M+6/5M+T/la8Pdrhu8kePBsjD+JUgLTrpJ2H9GRH2aVEaazVbDlXmpHUh/cnVBZiRydHdBwaEqEhth+0uB+b9/5hArN64xr7M1X055Ywm4yqMAjXY0VA1kTKnT+RtkJAahhNwCM0ztN0iUB5Ah1aHaaSLF4h327JCMslY9AgY/CEOArfP5rNbSEsuxPeliypdTbcj7cqYW7vKePjondQkaZVDGjPu2OC8IujMsq6n7B1EuamgPeoQoyWSPBUIEoYzfoi6YAd1yvwYXXBFnUFqkeguRLx9LGFigF7j3XCYRJ/Tf/EZcOyWxRYd7SuccrFrFY1IZ5JJeM1zN2hXmRWTTTPpiJmtOhBmpbXLbUXkdewYL8I18DCZMoqqsO3nfxYg5k6V6KYsSpDM57yRd3O/bUbX7x5b76+zF7fbr6d/Pn8eGf6ahLK+zkReR+x75Agtj3YZLq0BItstZ2n6pUFbKYGUeENaYkv3FLnIQhQ59kVReIU8pd/JjAXMVwVO1MqUB3l42qCbUfv8Wt2SOKpMuAlqFGlHFQe4g+wPOG2s93VaN36Jx/oHupGYqpuvPAI6XK3IOD1iI9g7Jox5Tc8y7Qqa0KN4k49TXdUvaVG4722YtX4ArIoVRO1ljn98P5NAQDXLAEWN1uFS6C9KYIrdKNJgul0J8RYzUE/FD9axMSMT7ppri28l4PVpw5gjWQ5OJqKtQFfAoLq+1w2/MG9zdbDIOMq1WJZWkTh8PflsGuXFB9XtyEPE+i98ylV8Sb4qSrdsF8pCNNhpNFVbyYwruhMAzWdzrPnddZ015Gq2NHJ5c8yce1uh607gYdWVQ7rI0/N4gAk7OPOYSg51YKaXUuBO/NEhrbo8eYuP3MTSXGzLmgavDrLncw8KEXsMGlxqjCEoRiBCOJNcg7JQcc/mpR5vEZ5tJOX7Ny75BDVk+PzX9nZUR9xvTj88ej6abY1jJyKc9f468Ly7B3berG5tdPfY7MjFf94PN1B/lyxqNis9E8ho+EKqFhaMxNUtbWaS8Njivl9TFKn47x6gFEscl9qyk1HzC58UFJ25iTimaaLcpYB+TPiBp7t5jr1iYD3EWG1z8cljh2ETxC7tPKiekHGxfoNio8gVgkkQ4ozp+rGdaIRcC1Ecqavc+lPqjx56Mw2DqAzugMDvm1sGqEdDY8Q03jqlJBbfjDRQFnMd8o4sokXsO6NSk9s0GfEqUAfKkwwBpE+wemaenDBHEx4eiqSA2vBtKKSZXEdLmKnoI2SrHB7HrrDvoK2stZEjlpQNuIKcxR4EnTniosJo2YI2sb6VGX3I36qFTZgx1hlMb65U6Sm30VUiNTF40vLxTAX8sIXFL4HrXoduig7U9/NFFh+FHZ6rnNjcQT48SiPVd6sylMX0o0X55pUDk1NKoz1ap8bewYaM8tTreYCJ0C/S3GIDOZBsgKmLxY3G0s5VWxCuVspcYTtgYynSq9TuzliM7BTldAc1DUs/CC6h+w4wQlaF2JmWbYbTL2KZP8a0Cre7m2+pMziep2gHKsb7QopYdiFB5pvMeksjFQjXjHWYVaV11ynt9k5XFbocPOYh0pKrOudHDFauGZn8LQ1mzIM6yxD9JLDorIxDDFr+53H2G7vXjK+SBUvJ8FWEjEIy9xnOEe5Tu3LFbtPjtzk5Rp1IGpMFK64UtJCFtAOG0jHBUsdgqHIFeXvq9wlthT7FICuAjPkhfLKcHmVSFN8nHIzdU1kv+ZBPueiwDhYReF/6R9r03tlnaVZEZ7xBXZ8g/n19iSOj6uL8uX3hqxu/i7M5Qkse8PlJMfyxRNMjJ8WJdZ7/L2LtwJkP10ORDIMSvA+rVZslIvUGeXw+WEVGlK3rNbhGhSDYMvLxOsUpoU0FrjzNSDJQAglX91cfx8vT/NRKmIyVy1XZ2j45fWy+MJjsaqzUpJcVlhnKgGUFmeQK0JCuiApABzL+AIjcXOWZ9jPWyuIbY0IHGxtvzj85bD/+9n23rOoR59/O/wD/9ree4Z/Xbai2lcfj5m/DBBgyXg6UVrY6axLEVz32pSKUJKzyopXwA8K2GuM1Hw8piObccknLqgtMVvql+8/r1ZDo35s5SWpQtvD46vYfXx49Hv/+MyXtIOGwmtYVBWdLiJRTzD/7xbVexytMCWlpYMNajJRBza/Lh3cWo3Jr7XpLdwNPfg1LBpzW9ciwXmtLzfXblILjfawqO2463fB5m7OvmsW6ZZZMUMTPcswBjQQK8wcmxHjjCc+4eyYDN96vvt8c2vr2ebmXS8qb//9yO1TbjDQRsOVrINGV+LfmMxfOqe+ZJi7NVndq24UlfMprSmAoCVeb0nXWsHd7dSl7cii59boSjVqG61eS3f+uDQ/68iRlqci9ZjbhbdVGNmKmLrDim6LFUp0KF5Uu6nuKdK9qjR9N6a7jk2vZYWlBt9p9Xyrh5NrDdKe8kkY0YUX/WohnXua7k6xUr4rWcQsRFmenjQ8yDJ45/hwcEGRPA/jcy6csQhgb+8VwBHXxwBHpA2VmhK8BFTcoCx32MEEmb68H/bbBsrFPcoaN9AwTLk51TAXqjZ0tyxzPZEJJs4YEZAp1PAP44qHBKG1BY1buV3ewu06ufGSHSTc2hZ0qk7Rzb5GiMMpkrJcpIa1Lll23Vh0jvkW4hy/PRe19KGUo2LsN0pU7k6/caBiBqG9LP2yn2sqvFURU5LBLCKDgK7NwebudvP6huV2jQt9hyoP7k10Xs4sGBIaThfxxW6x6wrytLiFZXoUA1A6aINb5cpXxvBYqpt6frLS36ktIwgf39opzNqNWlKbTqkuWS6kfbZ7vwp1Eez7Rq7s+A8TpmWl8u422T3luhZ7ro3S29XIlHNgnk9do5x1//migdqpn8D8n8atGHStYfes6dTdUXYys5uM1hh3rbtb8yVNFe3SkMu7u1Zo3zmZ160dSNwUeEK3878hqN0H3hMOSQGtlT5UCVkt/DvokeN08uoGcbW666jLI9ilAK8Fvis9KidqfuE4zoWd2/JtBNHd3RLW1W6eYdAtr6W68fcTK9YKp+jucpybBm/bmQ72bv2N2ftBcp+XkX7UWbP3t5a88iqwd560TYNHeF8A4lzTlPWnb9FBJl4D/nmJQYHlE3zFRlk9cm/lqG6iHz6NetHv5BWQJa7aHO1HE3odhrvqEm3MdzZcAX7D3wLtO3nfwHxEJBsm+XJjN8LuEOYeDumuN3wcwUx5mjBw1mm0H02tzcz+xkYCM9XnmRiIiR8LjNovXzjVKsld120JmPsgnFm0qZNly437uYnIZcVsly+QqBQsr4o07gv/tgd3WtXrHmpliJZ/Ojg9ofQelQIzpjgITmoj2cMaHLxyyctG7Igs+1jcQuI82tDhyIbsiVT+JrXVXKTEg4zH8LTHYDAZNMDuM7/wnwuVa2RH/xoW/xq6FjbOrBXqyd20A8y4QEYaV7v6r4p5Jf3lvGeL6+GBNdhSDYlmriFjqCuEGmWBCfx/Vjoyz6HuVzKEBdQTY3KO855P3pE2nDylGO6B73LItLIqVil1xIVheIQgcY3xlv8vP/ZvFRPG5NCjSMwFjKQ2i/J+dXg7Jjd0PJbLhOvE9IlewbGbm2JrmY7Wc5qw9eMsT159PH/aa0yMuN2a8xkbs6M3nSMKmGfFgFOa++ULbQ4yHk8Bp0dbR3dzczPg9PNA6cmGX2s23pwcHr89O+7jmrsq262OE5mV+ImSQiPQbLhj397c3h3sDLZoBFoZO+MywAcT/FpTuqlNgef4/zdW/e3fWOWts4Vbu5GlXEiUKhLjb97VfYrmOzR3ic6OmlOhu/MFOCogkcsrq0WF07vsRVOF/e9P0bdvWMX4oNO7O/zavfKHXKEwaBqql/wsldif+yKsTm5gLzh4HxYtj/Yj50DXRvyhb7VagUpRAXokJmu85WrF5uXLrh67+/e+52oVbsHrrh6J3iNfYbUKqbLuXGJ0iR+0cH2FT9ge8fEQ6oJbdUAtpGBVK8a/C2PT347PsduX165h80y4OQb/R1Bq5XIRwG5GXw4F/BeZ17nkn+ijXsPiX+Xj7pelC8qIzz2NHMKc/N+rdeE/
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List verification</h1>

<MethodEndpoint method={"get"} path={"/v3/config/digital-wallet/openid/sdjwt/verifications"}></MethodEndpoint>



Lists the presentation records (V3) in the wallet of the holder. You can filter the records by status and by a search term, and set the sort order. The wallet sorts the records by `updatedAt`.

`search` matches a part of the credential type, the `vct`, the `doctype` and the display name of the verifier. It does not look at the presentation identifiers. `sortOrder` takes `asc` or `desc`; the wallet uses `desc` for every other value.

The wallet does not return a record that a delete operation removed.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Search term to filter results by","in":"query","name":"search","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Sort order for the returned records (ascending or descending).","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter the presentation records by lifecycle status.","in":"query","name":"status","required":false,"schema":{"type":"string","enum":["presentation_pending","presentation_acked"]}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet returns the presentation records.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation records on the requested page. The array is empty when the wallet holds no records.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the presentation.","example":"6821b4b0f5b1c2a3d4e5f6a7"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this presentation in the wallet of the holder. Use this identifier to read the record, to send the presentation, or to delete the record.","example":"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the verification exchange at the verifier. It links this presentation to the verification history record of the verifier.","example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the digital wallet deployment that holds this presentation record."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that owns the wallet of the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation Submission object of the DIF Presentation Exchange specification. It maps the credentials of the holder to the requirements of the verifier.

DCQL is the only query form that an iGrant.io verifier sends, and a DCQL Authorization Response carries no Presentation Submission, so the wallet returns `null` here for such a request. A value is present only when an outside verifier still sends a DIF Presentation Exchange definition.


</div><SchemaItem collapsible={false} name={"definition_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation definition that this submission fulfils."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>descriptor_map</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Descriptor Map entries. Each entry gives the position of one requested credential in the Verifiable Presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the matched credential, for example `jwt_vc_json`, `dc+sd-jwt` or `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor that this entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that points to the credential in the Verifiable Presentation token."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>path_nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Nested path descriptor for credentials in an envelope format, for example a JWT in a VP JWT.

</div><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the nested credential, for example `jwt_vc_json`, `dc+sd-jwt` or `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor that this nested entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that points to the credential in the envelope."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this Presentation Submission."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vpToken"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Verifiable Presentation tokens that the wallet sent to the verifier. The array holds one entry for each credential that the Authorization Request asked for. The array is empty until the holder sends the presentation."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`presentation_pending`, `presentation_acked`]"} schema={{"type":"string","enum":["presentation_pending","presentation_acked"],"description":"Lifecycle status of the presentation in the wallet of the holder:\n1. `presentation_pending`: The holder must select the matching credentials and send the Verifiable Presentation to the verifier.\n2. `presentation_acked`: The wallet sent the Verifiable Presentation and the verifier accepted it.\n","example":"presentation_pending"}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the verifier accepted the presentation and the checks of the verifier passed. The receive and send operations always return `false`. The server sets this value later, when the verification webhook reports the result."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Validation result for each credential in the presentation. Each entry holds the result of the signature check, the expiry check and the revocation check. The receive and send operations always return `null`. The server sets this value later, when the verification webhook reports the result."}}></SchemaItem><SchemaItem collapsible={false} name={"vpRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the Authorization Request of the verifier. The wallet returns this value with the Authorization Response so that the verifier can match the two.","example":"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the verifier from the Authorization Request, for example a URI or a DID."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI from the Authorization Request. The wallet posts the Authorization Response to this URI."}}></SchemaItem><SchemaItem collapsible={false} name={"requestUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Request URI of the Authorization Request. The wallet gets the full Authorization Request from this URI when the verifier passes the request by reference."}}></SchemaItem><SchemaItem collapsible={false} name={"responseRedirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the verifier returned in the Authorization Response. The wallet sends the holder to this URI after the verifier processed the presentation."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinition"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"DIF Presentation Exchange definition of the verifier, as a serialised JSON string. Empty when the verifier sent a DCQL query, which is the only query form that an iGrant.io verifier sends. Read `dcqlQuery` for the credential and claim requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce from the Authorization Request. The wallet puts this value in the Key Binding JWT to keep the presentation fresh and to stop replay.","example":"z4cVLRsq9pKx0NgQ7E3hJg"}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request. It tells the wallet what to send back.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet that the holder chose for this presentation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata of the verifier from the Authorization Request. The wallet shows this information to the holder before the holder approves the presentation.

</div><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"logoUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location or address of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"coverUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the cover image of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the verifier."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credentials that the Verifiable Presentation holds. The array is empty until the holder sends the presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the DCQL credential query that this credential satisfies. For a request from an outside verifier that still uses Presentation Exchange, this is the Input Descriptor identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet of the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential types of the presented W3C Verifiable Credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Disclosed claims of a presented W3C VC JWT credential. The wallet leaves this property out for other credential formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Disclosed claims of a presented W3C VC JWT credential. The wallet leaves this property out for other credential formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type of a presented IETF SD-JWT VC credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type of a presented ISO 18013-5 mDoc credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Disclosed claims of a presented SD-JWT VC or mDoc credential. The wallet leaves this property out for other credential formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Disclosed claims of a presented SD-JWT VC or mDoc credential. The wallet leaves this property out for other credential formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionData"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Transaction data from the Authorization Request, as the verifier sent it. The value is normally an array of base64url strings. The holder must approve this data before the wallet sends the presentation. Read `transactionDataDecoded` to show the data to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDecoded"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Decoded transaction data. The wallet shows these objects to the holder for approval."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement from the Authorization Request. It gives the terms that govern this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Data agreement from the Authorization Request. It gives the terms that govern this verification exchange."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification Data attestation of the verifier. The wallet uses it to check the legal identity of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of possession for the Legal Person Identification Data attestation of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet checked the Legal Person Identification Data attestation of the verifier and the check passed."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet found the verifier in a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust Service Provider entry that the wallet used to check the identity of the verifier.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust Service Provider entry that the wallet used to check the identity of the verifier."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"DID method, or key type, of the trust anchor that the wallet uses for this presentation.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that the wallet uses to sign the Key Binding JWT, or to decrypt the Authorization Response."}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token that the wallet sent to the verifier. Present only when `responseType` is `id_token`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token that the wallet sent.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the ID Token that the wallet sent."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifier Attestation JWT from the verifier. It proves that the verifier may ask for the requested credentials."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query from the Authorization Request. Read `credentials[].id` from this query to build the `credentials` array of the send operation. `null` when the verifier sent a DIF Presentation Exchange definition instead.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query from the Authorization Request. Read `credentials[].id` from this query to build the `credentials` array of the send operation. `null` when the verifier sent a DIF Presentation Exchange definition instead."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>encryptionJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key of the verifier as a JWK. The wallet uses it to encrypt the Authorization Response when the response mode asks for encryption.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public key of the verifier as a JWK. The wallet uses it to encrypt the Authorization Response when the response mode asks for encryption."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]},"description":"JWE content encryption algorithms that the verifier accepts for the encrypted Authorization Response."}}></SchemaItem><SchemaItem collapsible={false} name={"encryptionAlgorithm"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ECDH-ES`]"} schema={{"type":"string","description":"JWE key management algorithm that the wallet used to encrypt the Authorization Response. Empty when the response mode does not ask for encryption.","enum":["ECDH-ES"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `kid`, `jwk` or `x509`."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet made this record.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet last changed this record.","example":1747011600}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"executionTime"} required={true} schemaName={"double"} qualifierMessage={undefined} schema={{"type":"number","format":"double","description":"Time in seconds that the server used to build this response.","example":0.042}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationStats</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Counts of the presentation records for the organisation. The counts cover all records, not only the records on this page, and the status filter does not change them.

</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Total number of presentation records in the holder's wallet.","example":24}}></SchemaItem><SchemaItem collapsible={false} name={"presentationShared"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Number of presentation records with the status `presentation_acked`.","example":18}}></SchemaItem><SchemaItem collapsible={false} name={"presentationPending"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Number of presentation records with the status `presentation_pending`.","example":6}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presentation\": [\n    {\n      \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n      \"presentationId\": \"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73\",\n      \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n      \"openIdOrganisationId\": \"string\",\n      \"organisationId\": \"string\",\n      \"presentationSubmission\": {\n        \"definition_id\": \"string\",\n        \"descriptor_map\": [\n          {\n            \"format\": \"string\",\n            \"id\": \"string\",\n            \"path\": \"string\",\n            \"path_nested\": {\n              \"format\": \"string\",\n              \"id\": \"string\",\n              \"path\": \"string\"\n            }\n          }\n        ],\n        \"id\": \"string\"\n      },\n      \"vpToken\": [\n        \"string\"\n      ],\n      \"status\": \"presentation_pending\",\n      \"verified\": true,\n      \"presentationValidity\": [\n        {}\n      ],\n      \"vpRequestState\": \"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f\",\n      \"clientId\": \"string\",\n      \"redirectUri\": \"string\",\n      \"requestUri\": \"string\",\n      \"responseRedirectUri\": \"string\",\n      \"presentationDefinition\": \"string\",\n      \"nonce\": \"z4cVLRsq9pKx0NgQ7E3hJg\",\n      \"responseType\": \"vp_token\",\n      \"credentialId\": \"string\",\n      \"clientMetadata\": {\n        \"clientName\": \"string\",\n        \"logoUri\": \"string\",\n        \"location\": \"string\",\n        \"coverUri\": \"string\",\n        \"description\": \"string\"\n      },\n      \"presentation\": [\n        {\n          \"id\": \"string\",\n          \"credentialId\": \"string\",\n          \"type\": [\n            \"string\"\n          ],\n          \"credentialSubject\": {},\n          \"vct\": \"string\",\n          \"doctype\": \"string\",\n          \"claims\": {}\n        }\n      ],\n      \"transactionDataDecoded\": [\n        {}\n      ],\n      \"dataAgreement\": {},\n      \"legalPidAttestation\": \"string\",\n      \"legalPidAttestationPop\": \"string\",\n      \"legalPidVerified\": true,\n      \"isVerifiedWithTrustList\": true,\n      \"trustServiceProvider\": {},\n      \"trustAnchor\": \"did:key\",\n      \"kid\": \"string\",\n      \"idToken\": \"string\",\n      \"idTokenDecoded\": {},\n      \"clientIdScheme\": \"redirect_uri\",\n      \"verifierAttestation\": \"string\",\n      \"dcqlQuery\": {},\n      \"encryptionJwk\": {},\n      \"encryptedResponseEncValuesSupported\": [\n        \"A128CBC-HS256\"\n      ],\n      \"encryptionAlgorithm\": \"ECDH-ES\",\n      \"cryptographicKeyIdentifier\": \"string\",\n      \"cryptographicKeyFormat\": \"string\",\n      \"createdAt\": 1747011600,\n      \"updatedAt\": 1747011600\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"executionTime\": 0.042,\n  \"presentationStats\": {\n    \"total\": 24,\n    \"presentationShared\": 18,\n    \"presentationPending\": 6\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, or the wallet is not deployed for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List wallet units
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-wallet-unit

---
id: config-list-digital-wallet-open-id-wallet-unit
title: "List wallet units"
description: "Lists the wallet units that the wallet provider manages. Use the query parameters to filter by holder DID or by device platform, and to page through the results. The organisation must have the wallet provider capability enabled."
sidebar_label: "List wallet units"
hide_title: true
hide_table_of_contents: true
api: eJztWVtvG7kV/isHfIkNjCXZ8RaFsFjUtbJbJdlY2NjxQ2pg6OGRxDWHnJAcyYqh/14cckYzGsmXGmiLxfbFlijy8Dv3Cx+YQJdZWXhpNBuyj9J5B36OsORKoYdSy7DAfXu1sGYhBVrIueYzdD24chg2fCvRrqDglufo0TrwBqZSebRwu4K5UXRqNB6BCQsCFzJDKBT3U2PzBLgWdKTgM6JnTTmbB7oWXam868HlHMHYGdfScQINeek8zPkC9wLMeMFvpZJ+Baj5rULR+6cmGg5tuNpioXiGDriG1EynDn0a+ZUOFLrAvIZBQMYhVTKXrR0DYiRsW0ofoQqc8lJ5WHBVYg/G04YukeR2hjYSpd26zG/RgpnWLCZhuYHnS6ujShR3PkimxxJmCrRBAGPBhiwzeipnpL2RnEnP1XWQw0WBeizi5ystPUtYoxo2/PrQUf/PG03RfVFbbxyMMEPtLVfyOwoYC9ReTiVaOBiNR4eERtLpoHuWMM1zZEMWj4+kYAlz2RxzzoYPzK8K+tF5K/WMrdfJ0xg6BkJy6lhnNIk7bZY6itwBtwipNC5NIOVaWCNFGvSXti0njSdrSQuDDrTxkM0xuwu3BHIJOEPGUerWHZBzn83DgS0sj4iihs8SZvFbKS0KNpxy5fAJ0SQM73leKFqTxrFdUX1q2U5mrAje5u5kAVNjyVKkDpz24Aw0zriXC3IeKLVFLsgbKm6mXCkHt5z4NpAO0scYiYb8Ijak9jhDyxJWOQQbDhKWSy3zMmfDQVB9RTY4VffKbV5/5fd0cMtfNjxHL4EC7cY/XgXweLBe39BZVxjt0NHuk8GA/m2judwTaiIIFDvhk+BkRnvUnijxolAyC4rp/+6I3MMuOHP7O2bBXy15upcRzLJx5WYvt5bvCuyyG8RNDDhZaS3qKpAED1DShViGeeFXIKcdowY+s4itABfjeWBLeswDMK7UxTRElC4DXvpgwltRaBvq2dZ1FmfS+RjcHs88FF3ctgdzteQrBw61cIALSkRTiUrEoCEdREzkDXE9EJ/z4MXREWTIA1EQ0Q8TcocE0mBFKXlPqkulgods60aKXSfucnql5Te6pgmh5Kkdg6ksu06q0lXgeEwDaWMEY5FCwf28Sbg9ihuZkqj9+AV4zsPONp7tACu181xnmIBfFTLjSq2A1/n76rePAWPI2BWJVfu0KOlSuBiPTr+cj0MEDhlpdPplQpr0JjMKyA8tzwiRa8G/suoF8vztI6AWhZHaPwq9JIgkZyEtZh4yk+elrlywdeOkvFUy+4CrfX7IhZC0n6tJS+velpgwMgiKpvX3bYyRLNzhCt5ff3gapTewQEtijO4CpGU48x6djw4xscZMicjEOIfO1SxId1b6ubHSYVvvt8Yo5HpHcNdz1JAS3DSJNtY2QHKDSO17pd1KR00QqPBNKn9842o3jDrkzpGMjL40d6hfbIibY/D++nJPsm8p84L4hZPeALLqbOnnZIOVXuGy8RxJ6DKLVCxYpMqNrgIOmcVgt1wF6xQmVABLKz3SHm9Amdk+ji4DN89xRbtqLrIuh57oRPMjTCjO/N7sRIUD93HpL6f7Qso9eJmTheQFHEhNvBot3CEsScs72l1yVwVZtCgCgrIQ/00EMcAFIKGozY2g6BOxNOFtFIq/SV08PSvu0f+8WKSs0K3aWgyNSaRW+tULvaJiSNbHos2AK6mEQFEXyW3RVjG3nUST4C8VLMpvZ0VRxRQK4xPFVzDevqKjiA+4ekk2Ge+kkcyuCm9mlhfzKgR2E3or5ZM1Bqi8iXcdIL+i54L7vZXS6yP02eYk5NUF+3FuBL9Hyj1qZlpl51cWOp9NLm7ntd2M0wngOwF0b/xpR462Dz/hQ09Y467C90r+hur2p6tUbzxX56bU/mJ6vomw/5DOG7t6TYRpGp3H0qJ0rqQ82nQFpL9bVEbPKIx3Q9CWo77tau5pBm7WN3Sg6a/2WWNd9k6aXV0xVZX4hM/wkbZkK0O26vaqC2rzcLxOIuxxXZI/Q++SNrfaqVDKA19wGT2lRfvkh5o4YX0NcQJNDSYlb6Oh7vdaGkiqJvB52p86kOuub0sag3XC5txNLC6kKd0LKqKxFlQ6oKMOyM/R4huqEIqKws4VoSGIt3zCe//6GzTe+x3qFKbIyDqlJOleoOdSuU3nEOdG4NDvhqBlu+lqGezNmnbOkYswCHqgb6ex0X1xp9q+B6019tyIwAN9HrVw3yTPxIvm9D7tb2RyOiCt7pDfk5aaFPx3LkDqovRNi8TW6/WuaHfmijImeN7tPClydAV3/CcW3JVuWoUd0fzwp7YpSrCWqgoqG9FCuKYjo3XCHGYlpeEwPjkrZOhAv97QJMrzGc1pWTXVrdPfQd1Gnx+yhHVaMZJNjn5uaDA8w+j5fs6GrL846cdJcV9EgkfRuPumQC1FP347qk29/h7mRzTFDWzsGxyPMDcVl1SJUOvO5t4XbtjvC8zNES9kT84s174nzZ5R5sQaUYYZwGNknqPw2VN4mz123MWfu0BuGvF/JiuMxlMroRmxxYVqQhn110xFq8Lte53mO9XlZBwq393+tB6/VsVyukUnhXhNfOC4RcpEU3mPIvbgacQIKRxo4+Pjh7dcqiCDgmd4mAD2Zr0O2SFUB39cmdKSOI7ucPVTGnOH1FNTOyzPgsNiziUJkmpfY/3fGuFt+Je/NEvbUm8rrCOWzaE6soZ+3JCPUfNN/3PUVXlXSSiafch8X2hMIsMMu6nQHIzrOvCgmjodtsZO3YMTi25zxcanJoeb2ZSrpgikwvh85KokEYUZhs9UemISBpLx/aqa4FQu1poxOChdUI/nWnAr3FHgV3LtYarMspqxVpIOaK/fnsOXczh4f315mMD43eXP8Hl0RMORL+fxtvHnCzj+6+D47dEPkI9M1s9HH9tzjVhah2mtkhlqFyJibbkFz+ZIU5Qd1S2Xyx4PP/eMnfWrs67/cXz+7tPnd0d0Zt3UuY06SVjCZOVGeyxhFDai2k8GJ6e9t71jOlsY53OuW3joBWtrat31plYu+f9j5R/msbKKoh7vfb9QXOowc4oD3pibvrLFSXwmmcowWNjKT/G9U8umJd3kqGYl2stNwubGeaL48EANx5VV6zUtx3elkLukC9LdvA09amKvfhDdy/Ed5ZStd9EgdjZkMZ+9EtYf7430Cem0nkpfKZz/7KvoE9A3j6OvBP7vPnE+AaVusBskN/TFyjgE+3qz6f6CQ8RDZ1mGRfvUTq2+bpeWv7y7pLFUSe7bLpTuQqFUfWi9CHK9atHu1kwRAv1tzZe2j/xImeUDrn7abI+/PHpgU6fF3SQganz/BXjaTUA=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List wallet units</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/wallet-provider/wallet-units"}></MethodEndpoint>



Lists the wallet units that the wallet provider manages. Use the query parameters to filter by holder DID or by device platform, and to page through the results. The organisation must have the wallet provider capability enabled.
The service replaces an `offset` that is less than 0 and a `limit` that is 0 or less with the default value. If `offset` is larger than the number of results, the service returns the last page.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Filter by the holder's Decentralized Identifier (DID).","in":"query","name":"holderDid","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Filter by the device platform of the wallet unit. The known values are `ios`, `android` and `organisation`. The service does not check the value, so an unknown value matches no wallet unit.","in":"query","name":"platform","required":false,"schema":{"type":"string"},"example":"ios"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet provider returned the wallet units.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"walletUnit"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The wallet units on the current page. The list is empty if no wallet unit agrees with the filters.","items":{"allOf":[{"type":"object","title":"WalletUnit","description":"A wallet unit registration that the wallet provider holds. The service always sends every field of this object. A field that has no value is an empty string, `0`, `false` or `null`.","properties":{"id":{"type":"string","description":"Unique identifier for the wallet unit record. Use this value as the `walletUnitId` path parameter."},"clientId":{"type":"string","description":"Client identifier of the wallet instance, typically a DID or URL. Used to identify the wallet during OID4VCI and OpenID4VP protocol interactions."},"clientUrl":{"type":"string","description":"URL endpoint of the wallet instance, used for direct communication."},"clientPublicKey":{"type":"object","additionalProperties":true,"nullable":true,"description":"Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession."},"isAuthorised":{"type":"boolean","description":"When `true`, this wallet unit is authorized to interact with the Wallet Provider's services."},"assertionToken":{"type":"string","description":"Client assertion JWT of the wallet unit, used for OAuth 2.0 client authentication. This value is secret. Treat it as a credential and do not write it to logs."},"assertionTokenType":{"type":"string","description":"Type of the client assertion token."},"createdAt":{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when this wallet unit was registered."},"updatedAt":{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when this wallet unit record was last modified."},"walletUnitDevicePlatform":{"type":"string","description":"Device platform of the wallet unit. The known values are `ios`, `android` and `organisation`. The service does not check the value.","example":"ios"},"walletUnitIntegrityToken":{"type":"string","description":"Device integrity token supplied by the wallet unit during registration, for example an App Attest or Play Integrity token."},"walletUnitKeyId":{"type":"string","description":"Identifier of the cryptographic key that the wallet unit registered for attestation."},"walletUnitMetadata":{"type":"object","additionalProperties":true,"nullable":true,"description":"Additional metadata that the wallet unit supplied during registration."}},"required":["id","clientId","clientUrl","clientPublicKey","isAuthorised","assertionToken","assertionTokenType","createdAt","updatedAt","walletUnitDevicePlatform","walletUnitIntegrityToken","walletUnitKeyId","walletUnitMetadata"]},{"type":"object","properties":{"totalCountOfCredentialHistory":{"type":"integer","format":"int64","description":"Number of Wallet Unit Attestation issuance records that belong to this wallet unit.","example":3}},"required":["totalCountOfCredentialHistory"]}]}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Page details for the result set.

</div><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"walletUnit\": [\n    {\n      \"id\": \"string\",\n      \"clientId\": \"string\",\n      \"clientUrl\": \"string\",\n      \"clientPublicKey\": {},\n      \"isAuthorised\": true,\n      \"assertionToken\": \"string\",\n      \"assertionTokenType\": \"string\",\n      \"createdAt\": 0,\n      \"updatedAt\": 0,\n      \"walletUnitDevicePlatform\": \"ios\",\n      \"walletUnitIntegrityToken\": \"string\",\n      \"walletUnitKeyId\": \"string\",\n      \"walletUnitMetadata\": {},\n      \"totalCountOfCredentialHistory\": 3\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not a wallet provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List sandbox organisations
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-sandbox-orgs

---
id: config-list-sandbox-orgs
title: "List sandbox organisations"
description: "Lists the sandbox organisations of the organisation. The service sorts the list by the time of the last update, and it does not list deleted sandbox organisations."
sidebar_label: "List sandbox organisations"
hide_title: true
hide_table_of_contents: true
api: eJztWVtz27YS/is7eDnxjKyLL0mOptM5PlZOjto08dSK8+BqRhC5olCTAAOAslWP/ntnAZIiKcpynfapzUNMkdhvF3tf4JGFaAItUiuUZEP2QRhrwC4RDJfhXD2A0hGXwnBaYEAt3Mfqyy5MaDnqlQgQjNI5QCyMhfnaPVuRYEEbc2MhS0NusQNchiAshAoNSGU9UYgxWgzbRej+In+Rnw06rJlaLAzamcNxL2KRCDuDrxnqNaRc8wQtagNWQcojotIqi5alhF0osQxyHSx3aIl0IWL3lBN1tvxov590iLqVLlhyGXl4Wgih0Bg4pdEuSG8aTaqkQYjECvdrHjQGSocGlIzXXZgoiNC61Z9SlOMRoAxTJaR1JlKyHaUDGrlT+L2wS5i9fzeBXqDkQkS9fP2x0lHvMf/xSUfjcDPrsg5TKWqHMQ7ZkHkacpbrcqVhHbZVOBvePjZ862OWzFGTfMVmrAJzJ1JYKE3WETJ3qAuQGHErVuRpkEmSms9jhBWPM4QFj2MDcx7cEcKs7wQUxMKZgHWY5AmyIfPewTpM49dMaAzZcMFjgx1mgiUmnA0fmV2ntFRIixFq1mEhLngWWzbsd1gipEiyhA37m03nsYB1PtZkWd/rT/yBCEG27VmjzbSEFN2usftSAQdeqjrna+fFYFEnFc/VaLLYGpiv96jKO/+zJDFWCxmxNt7k44qiwZnUOv+mvWJY7v8VNwHKUMiIbEv0/tfRPiOWEfZHhOswlGS3Wych6zBuAjat6M6/32ymBOpD0BDMSb9Pf+r7qiY4v6GncmSRG7YeDSG3nPYXKGlRWuLA0zQWgfvc+9UQm8fd3aj5rxjUHfiWmUbIFVxof6mmQLXCb6a6cgvKtea7HjvZn/Ol206QaY3Sli4rLCamTda6DCJss06d92cpvmYIIkRpxUL4gNmnYLYpXOMQ7EiYNOZroNWHEGuUh4D/nyVcQpmVKh8PsVGUrcMRprFaJyjt+BnaGe+ohRujAsGpRubpPywRiYux3GZmT/KoBaxbCIEKDyooxjBCXZN3H+qTAnscQhRyobmxOgtspvFKq5WgKD+oj48Vc9YxIC1ANh22Qm2eZc0bv/ApBYAveJku1aFV/AwP/FnFTyoWhI8tDJRZG4sJQVudGXshg6V6hjImtBi4W10LIA2j8cip2XzhcYy2RcFzpWLkcteAMqTUhAbul2iXrvMRpn0HPLAGuAEO945NzQYGg0zjjU+5L/CbVIuE6zV4HFg5oDpuW2aTWRxTZLKh1RnuZ1P2s1V8Su3c7jdZZtD4nnchMA5hqeLQwIx4zkhfcj/pklOXW+PWlkkL/Wwo7FSkxgmP8GWZgshBEH1VZGGAzw0l82fJWwEh5QdqhfobZHL03yxUFYVVFfVZx4elusrmsQjg888fyk5lu8v6Jl+KVxHQAWqk/HfxnECYiASN5Ul6QBX33ECOSyz8UPXns6hMbKHPKD9xIV+eR4TvnhIuZKPMbOqdjgiLNrCO3FpHy7JXqVV7i8y2POSpvJ52W7JmPZk1/K3pL1VzV+1S6m5KW620bi1tlBWWMhi72q5q9lZ5S3ZFLnbY5JeVBi4fTKhPfuBJSowGVHqU5fF4TzracSFaXJlwXBoDvuLCJ98K9sl5AU6yvgSchKaZz2BIDWkxgpUcTikFuJeHsT82RC4GsZo2+psOW3JzpXElVK2ZOuztwiU6jf+ispjmCDss3AjjuXzEB/tyDhIf7A46Vb4N/au8a0wEt747Z6/fvv03DvhZcD4/WZz2+/0BPw3fDPrbGewiSBAmaCyMjcnaGsm23EGZUBiTcRkgWDTWtEfuXgkG26AenlRb0P7+7pGJ95pLW4nwIRt0+91+EelD1gh292K3SyomzGoL02+2HlT1G0W6fTOvF33WLJ37Vg6a6WXIltamZtjrhZioY56Krohol12hequTnpJzxXXYc8Wmt49/7x7nO5nqT4EeFNDbGjd4c3725uz8zeuzWl2qvi7KiI+DaTMf1pLboJ6bBvVsMihjf9BvRG1uxTLGPDMXFkvkoTupeqRfZ/2B4/rcCb1ap1BrpS9V6AKQnkeV4Jh2DkzIW+q21FUG71mfUtIOfNvRR0HC/kunfTLN7PZYkuVJoTmB88wulRa/IVXNumrO/ZnI31Q1Y2lRSx67EyDU4Ng0dFSMJMKuXVq9SMWPSI9T8mvLXbZlIxEJqmo+08ArP7uf3VwesU6RQdGQVhK0S0UZInLHlym3SzZkFI+7p7XGtSYkWtuh6wgTlUtOnciBiGe7Z3pXWoWZO7PeB3MI4dpSXEf7yI3/3BRkulXpNXmWd4hCsduRz7/Ijw69TSp1K3fqon2qC3ZxNYY7XAO5Pg0pQeU+w5805xPLrIYzA88GEhq95zSl4kI8YJifqnsZYQavpLL+8N9qLmKng5QHeNQB7EbdBuwQcsLv1irTpI7jO1x/P+u6tljIhSqCkAcuCDHhghRpsjRV2v5nq7xy/74W+ld1rVcN1lBLSVSM8tRjBIrixiII+kuFm1fPu/JjKKr4N6jFQriDsUuNbvrjsXGNg2sEXn1yPj8+cgel7YRXGk3JooyTqyOSyKpAxW4CFwbIhCiJxuS9x2/5qaVVrvfAjhvQ/Y3NijisIczjMKiIlxlnHstlyHVojt1+BZcWFrG6N960uaadtF9OL+HmEl798GVy1IHxu8n/4Hp0/MOXCdxcem7j608weNsfnB6fQzJSQS8ZfajwJJSEW0MnALEIUBqX5QrPTXmwRDhxfUvddPf3913uPnfpsianNb0P48t3H6/fHRPNZjs/bM1JygpVkJXWqzVJJ/2Ts+5pd0C0qTI24bIiD931tJ8PN8OqUij+uU785zqx/Toxz94WH2wvjakN3ORu/phXu1u2OvE3JgtBlbtW8aYdtlTG0qrHRxoKP+t4s6HX/vLI1UFhKC9s74r2eulfezHZutU7KmLb+0lHToOIq57PFvyP3jI+IUoxUL9QkmfcOj7BvLx8fCn3b713fEq2yvXjVrwp/dDCHzLfTstpwnmeJ7wIAkyrKt1pmjfVTu/9uwldU2bk+9Xu5s51N/kDoRef5LqC3Wx0vAj0P2myleQ7Kgc/4vr7crn/spegbK78alLSdLPZ/A4mw/mv
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List sandbox organisations</h1>

<MethodEndpoint method={"get"} path={"/v2/config/sandbox-orgs"}></MethodEndpoint>



Lists the sandbox organisations of the organisation. The service sorts the list by the time of the last update, and it does not list deleted sandbox organisations.

Use the `offset` and the `limit` query parameters to page through the list. Use the `search` query parameter to filter the list, and the `sortOrder` query parameter to change the sort direction.

The response gives the sandbox organisation records only. To get the OpenID endpoints of one sandbox organisation, read it with `GET /config/sandbox-org/{sandboxOrgId}`.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Search term to filter results by","in":"query","name":"search","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Sort order for the returned records (ascending or descending).","in":"query","name":"sortOrder","required":false,"schema":{"type":"string","enum":["desc","asc"],"default":"desc"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returns the sandbox organisations and the pagination data.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrgs</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The sandbox organisations on the current page.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human readable description of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdDeploymentId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the associated OpenID deployment"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Status code of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the associated ledger"}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the infrastructure provider"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the sandbox organisation configuration"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role of the sandbox organisation in the ecosystem"}}></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trust anchor identifier or DID"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this sandbox organisation acts as a wallet provider"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVault"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the primary secure vault"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVaults"} required={false} schemaName={"integer[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Identifiers of the secure vaults that the sandbox organisation uses. The field holds `null` when the sandbox organisation has no secure vault.","items":{"type":"integer"}}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the logo image. The field is absent when the sandbox organisation has no logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cover image. The field is absent when the sandbox organisation has no cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the logo image"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the cover image"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was created"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was last updated"}}></SchemaItem><SchemaItem collapsible={false} name={"isMain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this is the main organisation"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sandboxOrgs\": [\n    {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"description\": \"string\",\n      \"openIdDeploymentId\": \"string\",\n      \"status\": 0,\n      \"ledgerId\": 0,\n      \"infrastructureProvider\": \"string\",\n      \"version\": \"string\",\n      \"role\": \"string\",\n      \"trustAnchor\": \"string\",\n      \"isWalletProvider\": true,\n      \"secureVault\": 0,\n      \"secureVaults\": [\n        0\n      ],\n      \"logoImageId\": \"string\",\n      \"coverImageId\": \"string\",\n      \"logoImageUrl\": \"string\",\n      \"coverImageUrl\": \"string\",\n      \"createdAt\": 0,\n      \"updatedAt\": 0,\n      \"isMain\": true\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"sandboxOrgs\": [\n    {\n      \"id\": \"6889e1a4c5b2f30001a3d710\",\n      \"name\": \"Acme Test Issuer\",\n      \"description\": \"Sandbox organisation for issuance tests\",\n      \"openIdDeploymentId\": \"6889e1a4c5b2f30001a3d711\",\n      \"status\": 2,\n      \"ledgerId\": 0,\n      \"infrastructureProvider\": \"iGrant\",\n      \"version\": \"1.0.0\",\n      \"role\": \"\",\n      \"trustAnchor\": \"\",\n      \"isWalletProvider\": false,\n      \"secureVault\": 0,\n      \"secureVaults\": null,\n      \"logoImageId\": \"6889e1a4c5b2f30001a3d6f0\",\n      \"coverImageId\": \"6889e1a4c5b2f30001a3d6f1\",\n      \"logoImageUrl\": \"https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f0/web\",\n      \"coverImageUrl\": \"https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f1/web\",\n      \"createdAt\": 1754745764,\n      \"updatedAt\": 1754745764,\n      \"isMain\": false\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 1,\n    \"totalPages\": 1,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": false\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all webhooks
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-webhooks

---
id: config-list-webhooks
title: "List all webhooks"
description: "This endpoint lists all the webhooks of the organisation. Each item in the list also gives the result of the last payload delivery to the webhook. The server does not list deleted webhooks. Use the `offset` and `limit` query parameters to page through the list."
sidebar_label: "List all webhooks"
hide_title: true
hide_table_of_contents: true
api: eJztWm1zG7cR/iuY+1I7c6QoynYdNpOpK6kexrKtiWSrjqMRocOSRIQDzgCOlKrhf+/sAvfGF0tx2i+ZfrHFO+zug93FvuHuEwGFhYx7EMloypWDNBHgMisLL41ORsn5XDoGWhRGas+UdN4xrhTzc2BLuJ4bc+OYmdJvY2dcS8eRtM+OeTZn0kPOpKbXSMy4cobN5AIcPbPgSuUrBoo7zwp+pwwXTICSC7B3zJu2tD47nwNzYBdgmTDgmDYBGFKAB1Hj6rMPDoh2YqZTB37CuBZsomQu/YR9KZF7wS3PwYN1KKjgM6SwppzNa9D9X/WvGqVqWILzFX+WmRwcm0rrfAeVhULxDBzjupHs59wz6ZgCh1vnmg0IDa/xVCsGzNiwbCl9QCFgylFPC65KIDiNdudGiaBMB5kFz27grlJohVRqlinglnm4xe0kaWIKsGSpsUhGSWb0VM5OpPMXUXlJmjSqSUaf79cc412ZX4NFQRYyYwWpz93Igk2NRT1KHR3hFdMw414u0ENYqS1wwa8VhN2wKVfKsWue3SCHyWDST9JEoggyUJImmueQjJKgySRNLHwppW25rMvmkPNkdJ/4uwKXSu1hBjZBbybNJaNBmuRSy7zMk9FgtUrvK7ak/XWR3b2+5bdIyPS2PVvwpdWsANo19L8V4P5gtbpEWlcY7cDh6uFggP9lRnvQHv/kRaFkRprd+80huvsW98KiWb0M1I0RiFKp91MyZMRgrn+DDHfupVf44LRZn66xykprQftTPoMdu2jr6zCsDqcpKC1JE7jleYGC9ldp4o3nauwhd4/gd46LW9pHv3eML7hU6Eht3sPnFXPE+i3METT6owPBjGaVe9QSDlZp9JmHeb9bg1w5SUcbg1WazLk7tbCQpmxDvjZGAdcbbMdaoA+AY5LOuYW/OMZZETlsiCAvDFLewa3/dgkabv0Gd29LWJHvrqcOaMUBJrjnFBvqsJqs0qSK1Yhpk7zJMDqmiy8lOIzx1VGTlQs17t2cvs+JFBjq7GwsKJ5RZvlgVZJWZ+oc9ZAmrrxG2dcgjhegPUY/IR06FxKGwPoGMDJgiDtz6iNYOY0HkY5QDs7zvEgu053nK4bWDWW/amUUDMNlCMzb02qVZ2QGjKslv3PMgRaOASXLqQQlAqV0LEBIGdxmUHg2cVyLa3P7HhVCcbZ7yqVouYbzVurZBtgPWn4pgUkB2supDN7dzs9t10hevOT702F2IJ7B8+kL/tfrl9n3YgD7aPpglm8X2NZLSJ5mqV0XyypN2nv+A9Iim69YI5iB9B6toNUdeTyvDUwwr0EZPaPkwWu+Agpl7nLQHjNmtd5CBlQsES/EAeSfIaQ43DFzmSmAttpy8Ic3+vNJQFOLaBcMkVPXmHPvCzfa24tP+pnJ9+h47smZ5dojhPaxehDDYVjMcNV6ydJGoDFpf97MfWnn0W1vuVz2psbmvdIq0JkRIJLL1ZbTPdqdBLdFgo24REYg2C4osY28UmiKZdcBm1lTFg6NGusP3Ol+td0Dxq3FQ5yXzlMtx3h3YSOr624WpqULRWazpC4isShu193RXwhMl09dQ1vIzQKYKINKY33mNsNEhvWJ9m+55jNAj60CW6NW2tQ2eyMhy2vKtiYJlms8PMtKy5Zz0LhFqYVcSFFyFbsHY2sNRDwpPuPuhg5W6AVSJsxSUzuBpWchcFt+DtJSOuokkK+76lntFgFfyy2JU+Ddl1p6Se1U2nmecZ2BCtkkwu1zpcyy8wRTzsZDXnpzBbeFDIUpMg2b2xRWbXbLm0DRhtGlaN5crlaY/GbSc3XBlYJHm/coELElUXVNe0zZ6f346NnHw/iGbEfhkrzyb7FTK0BL0f9uEt2PcRt6OIqA8Rl5OdeR3xiN+74Ajb9OGRVjMYVqABEci03ingK6loAQjqs20ygBlh2Njw5NnrPCGm8yo+oWsMKXWaAUwRVyii47NWg9YiOdK8EyJwVFthZWuM3mXM/iaa74zUnug2zDMmLbpS8soLeEtPRdf3GwTo0IahVVGEZsEkuqK6SepM3vGMVE7Jnb/K94doMvsP9lU2tygragiiiCS7dQFaCF1LNHM2zvlVrWP35UN41nplOwtPnQE299Xeli65Lmzysy+oOraLMPL8KK7eF1ceaxdRnCwWN9JUDLHWu8uQG9AXzTG1siox0fuXpttw+sXd90x63brtpfHDywqjLa7pWbLvjItVEDuDpES+75W25vwNPg59HxEjuivKF7XDL0rdydWaAmrU5u2KRRoyWky5RxpQXGZxZCsg1Ti/9e1mth7+Pvq0bqVS31KkhFTYXMEtuqh5vQC9zuBNvLSbq1wmLaRJ1Vw8JQ8dft2sMbbEZmdR1XKTfkJ8MyrrJSxcqBTf7VG7/Gard3Jmea+9LChM2Bi9AqAM7lajS7+oMw+epM5fBXaOGaXYZJUMqcoUQEma+GpvSCccfuTNl5dwNRB1va1G/Q+EaRSFE+dCLnJ2csw6pwGsrFWNFW89sPP58QkqY1frgnOT9kuHyXo4u2F1B5Pfn06dOn3tu3vaOj8/l8lOcj536ZYNOVc7+jzg2pr20IQyVmLNU6Lc9wMHzRG7zsDb4/3x+M9vdH+8NfkhWND9daZ3fCnT+Khj8rswzcjqHGt868o9O4aKA4mQkMakKJ5TCC90B5llrGanxPxTdnznNf4joRs+1wMECJw8FLqqGHwxdrEmlq3xUbZ905F4DHcAdyVmovFdNm2V8fGaXrzojRoTO72arSjfnK5uCpaZ/rAXqjc+yCtuq8vzmpuZB+3sFAiiOnbsf1deDL9gi9HqluAqdw2EH+/k2SJiGYoPPggmeD/d81Am4DAWuNPTSCxnX491FL2pZBVdelG+ptg87als8GOMDcYL/lsDfH6h9cMKmL0jfXL6iOTYV80Lz0c2Plv6kq6Krm+e+cjv+5VDPWHqzmqjqJJGZNRyEZllb6OxqNviokpcXPl3hqPJ/hzU49l7xMkxz83OCF0IxuWgru58ko2VsM98Jocq/l20HutruhI8hNhJWkSYnjqHp4JCA3PV7IfpgZ9aVJMJp2GZxaI8qMOrgdbB7icObx5M12kbvweh3IZaOvM3SbYO1Ka005Fx7EO6Og8Oae6lX02Go2vBacTsdUbqBfY9mbtSaJMRuFADvp8KlrDJoTXQMO+6fyFm87McZNAkY2YU+0iZWKt1wq0kHBM3iaMujP+mtsRywS/nBnSovq6N3A3Y+TPgU1qaemOmE8oxMGOZeKxmRFYaz/e6O8ev/ydfOoq/W2wdbUUhNhNbOQgirZOpNJ/D+v6u9KQ6GfpQlrqHPoVvGw7iccG8cOiD2J3fdTSorbCU9bJT57UjfLT+shABXl0jE0IWikcXEcHJRJ1SK1Uik1r6EJjhVTnD6wrAWvdGQez7XgVrge7Vdy7dlUmWW8/42aJrQXB4fs4yF78tPF+dOUjY/P/8nOjno/XZyzj4dB2vjsPdt/Odg/6D1n+ZHJ9vKjk5bMWBnRUE/JDLSjEFZ5bsGzObBhf7BhuuVy2ef0um/sbC/Sur2T8eHxu7PjHtKsmgTamBOVJUxW1tZL0gTDRjD7cDB81j/o031AYZzPuW7hOQlfDCjWijqiG0jr4P//LxX+rF8qxKCLD/YKxaVGZynDHUdIUJ+TxTBMTKcSs2ntLpdpMjfO44r7e7zS/WDVaoWPw0U/pa66Id32AUzbw/63nzxs3eYN5p3mywciT0ZJSHiPBv57v1/4CpTqOrxBcok/LIVQKiyqCoSUG4he0VynRbVRp63atcfr43O82inRtO2ce0M5N/7R+pCB67sW7/X0GyDgv6i0rSQ/YJB6A3c/1svDm50EdcoPq1FBON74D7MvMv4=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all webhooks</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhooks"}></MethodEndpoint>



This endpoint lists all the webhooks of the organisation. Each item in the list also gives the result of the last payload delivery to the webhook. The server does not list deleted webhooks. Use the `offset` and `limit` query parameters to page through the list.

The newest webhook comes first. The server replaces an `offset` that is less than 0 and a `limit` that is 0 or less with the default value.

Each item holds the secret key of the webhook in clear text.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"webhooks"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"description":"The webhooks on the requested page.","items":{"allOf":[{"required":["id","orgId","payloadUrl","contentType","subscribedEvents","disabled","secretKey","skipSslVerification","timestamp"],"type":"object","title":"Webhook","description":"A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.","properties":{"id":{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"},"orgId":{"type":"string","description":"Unique identifier of the organisation that owns the webhook."},"sandboxOrgId":{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."},"payloadUrl":{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"},"contentType":{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]},"subscribedEvents":{"type":"object","title":"subscribedEvents","description":"The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.","properties":{"consentManagementWebhook":{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}},"digitalWalletWebhook":{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}},"dataMarketplaceWebhook":{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}},"disabled":{"type":"boolean","description":"When `true`, the webhook receives no event delivery."},"secretKey":{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."},"skipSslVerification":{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."},"timestamp":{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}},{"properties":{"isLastDeliverySuccess":{"description":"The result of the last payload delivery to the webhook. The value is `true` if the last delivery is complete and the endpoint sent a status code from 200 to 208, or 226. The value is also `true` if the server made no delivery to the webhook until now.","example":true,"type":"boolean"}},"required":["isLastDeliverySuccess"],"type":"object"}],"description":"A webhook with the result of its last payload delivery.","title":"WebhookWithLastDeliveryStatus"},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"webhooks\": [\n    {\n      \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n      \"orgId\": \"string\",\n      \"sandboxOrgId\": \"string\",\n      \"payloadUrl\": \"https://example.com/hooks/igrant\",\n      \"contentType\": \"application/json\",\n      \"subscribedEvents\": {\n        \"consentManagementWebhook\": [\n          \"data.update.initiated\"\n        ],\n        \"digitalWalletWebhook\": [\n          \"openid.credential.offer_sent\"\n        ],\n        \"dataMarketplaceWebhook\": [\n          \"datamarketplace.data_disclosure_agreement_record\"\n        ]\n      },\n      \"disabled\": true,\n      \"secretKey\": \"string\",\n      \"skipSslVerification\": true,\n      \"timestamp\": \"2026-08-09T10:11:12Z\",\n      \"isLastDeliverySuccess\": true\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Ping webhook
Source: https://docs.igrant.io/docs/openid4vc-api/config-ping-webhook

---
id: config-ping-webhook
title: "Ping webhook"
description: "This endpoint pings a webhook that was defined to trigger events to an external IT system. Use it to check that the payload URL answers."
sidebar_label: "Ping webhook"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/isHfkoARXbTdBiMoliWdJ3bYgliJx3QBjBDni02EqmRlB0v8H8fjpQl+SVru31blw8JQ/KOzz13vDvqkUksLQruUbLBlOcOEybRCatKr4xmAzbOlAPUsjRKeyiVnjngsMC7zJh78Bn3sOAOJE6VRgnegLdqNkMLOEftHc1wDfjg0Wqew3AMbuk8FilcOwTlaYPIUNTKfIZQ8mVuuITrq/fAtVugdekn/UmPMwSHdq4E/dWSkFxejMawUD4LpxSlX8KdkcsAZFNVCqcBPwhurUIH2sDk96PhG8u1Pxqpmea+sjiBDLlEm4CLKiwKVHO0ILjWxtdglXfAK5+h9koov0yhi06aoN+TsLESeDyZd7mTmJPa5Y5ptcnRqslxvz+BqbHAwSIXGb/LtxmScV1DpdstRmMKV8hlMGLiPPeVm8BUYR7dhHkelvzCAC+59eknzRJmSrScnD+UbMCE0VM1u1R69iHCZgkrueUFerSODT4+MkVhUnKfsYRpXiAbsNrEoWQJs/hHpSzFl7cVJsyJDAvOBo/ML0va7LxVesZWCXN+mYcZVZQ5stUtSbvSaIeOBI77ffojjPaoPQ15WeZKBLi9z44C9nH3AHP3GYVnCfPKB/21KWQV2473K3RV7sFMO54i3236l+cLvnTrIMxz+CES69INiz82+EeB/jMjkSVbkyNvWcLwAUVFGEaeWz9WBTrPi7K78lrL7nz0aDM475hxm7DSkiO9isztgdHyo7THGRKIqbEF93Hq+fEON7+Ox5cQTwNhJO6/sQ61j2zNeV4hKAeT/gQWGeqwd82hMFUu60vCRbZzXYPpPETC4LjfX+3jbSeK/g6yxwf/1ZCbbBIV/zv4FLlw8Y5i/Ck/f9GS6/EZeFVgiySkFEdqUKYbujci5Z9qRi1rvXWkfVFRe3fWSlKYCEMceJQTKJBr90SGR5nCZMpVvrnxKbaVDwTrqqBb1pxBMRx00BVo6W/XV/uuy1cYxp3RdRamAyqLXxMvTdalO9ASkbIV/eyW2q699eYOleM9eRzz3MHSVKCmTxPLEhZrGvmQzj3pP/umRNrNaGitsXUiC+OtxLOddDcTUSu9L/80HjsJ931H/R5HtU7+mUtQuqw8NAVqP8/Xmgq3serPEDDb1Jx8x9RcoTOVFRhu2tRUepegF99YhP9bBA113cfSRaUml47Z4ohyDIrKKr8MDdJpqd4hDW+po/F8Rn3Tugkhswv0maFuqzQumE3N1ID15se92H/16k6k99h0VqteGY2IQGIrton1HAtT42QJq2zOBizzvnSDXk9iYY54qVI1o/Y3VYatkm0Fl9bIStA/T6n5koaR57NQpfaLu7i8DeS2JXBEcRTdv6ax8SOPE0nsQKMH2h70tL7jIS53Mvrp5RDucdm28GFbN6fXVWyyoWf9OICich7uEEqLU/WAsm7WI0aYwIE2HmN7bbnKAwclF3iYAKZUFjfUDqAWfLk0lSU6ju5x+SoUCjJvatZXjotw5bDgioh0VVka639qyWvsV2/aqU3Wuw7boqURgtKauZJID5Z1LYLQlheofQC9ZuiiRD08D8XxBq2aqvD8OLMoiVieOxg6V3EtEA4uhucnN2fDw/Bo2S94adE1RxzEPSc3l4eEyBthckdeUg7IhahJxoGxM65rMsOTUzlXYQKZyWUSDpvTCUuQaqY8z0F04FWubqS05Fa6o2Cv4trDNDeL+h1WMx3Qfnh+BjdncPD2w/gwgeHr8S8wOj96+2EMN2fxtOHoAp792H/2/OgFFOdG9Irz950zITba4bWQK4HahZy2jtySiwzhOO3vuG6xWKQ8LKfGznq1rOu9H569/m30+ohkVu1Dp3UnkSWNqBrvsYRR2ohuP+4fn6TP02ckSzmo4LqD5zL0M83zT24m1aYQ/P+p4Hv7VFDnYXpX9cqcK03xEwL2sa5hH9mcnpGxirGEtVE06H4jCKXsNmEZ1b/BR/b4eMcdXtt8taLpPyq0oX4mbM5tSBOx3ClH4yc+XXVD8+Cq7kIO4Snc66KiqaKEEsAGjCXsnmpO54vG6na1LvcBRFw/FQJL35HcaYpW3UJPocgSRlGxWdDuQ0GrB6R+L6zt2hYx0G8qwXtFXlIGeIfLV832uPKkQFNP424i6Xa1Wv0FhEgK7A==
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Ping webhook</h1>

<MethodEndpoint method={"post"} path={"/v2/config/webhook/{webhookId}/ping"}></MethodEndpoint>



This endpoint pings a webhook that was defined to trigger events to an external IT system. Use it to check that the payload URL answers.

The service sends a POST with an empty body to the payload URL. A ping carries no `X-IGrant-Signature` header, so the receiver cannot check its authenticity. The service does not record a ping as a webhook delivery.

The service answers with `200` for a reachable payload URL and for an unreachable one. Read the `status` field to tell the two apart.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service completed the ping. The `status` field tells you if the payload URL answered.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"responseStatusCode"} required={true} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"HTTP status code that the payload URL sent. The value is `0` when the service could not reach the payload URL.","example":200}}></SchemaItem><SchemaItem collapsible={false} name={"responseStatusStr"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"HTTP status text that the payload URL sent. The value is an empty string when the service could not reach the payload URL.","example":"200 OK"}}></SchemaItem><SchemaItem collapsible={false} name={"executionStartTimestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the ping started."}}></SchemaItem><SchemaItem collapsible={false} name={"executionEndTimestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the ping ended."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`completed`, `failed`]"} schema={{"type":"string","description":"Result of the ping. `completed` means the payload URL answered. `failed` means the service could not reach it.","enum":["completed","failed"],"example":"completed"}}></SchemaItem><SchemaItem collapsible={false} name={"statusDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason for a failure. The value is an empty string when `status` is `completed`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"responseStatusCode\": 200,\n  \"responseStatusStr\": \"200 OK\",\n  \"executionStartTimestamp\": \"string\",\n  \"executionEndTimestamp\": \"string\",\n  \"status\": \"completed\",\n  \"statusDescription\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Preview credential definition from URI
Source: https://docs.igrant.io/docs/openid4vc-api/config-preview-digital-wallet-open-id-credential-definition

---
id: config-preview-digital-wallet-open-id-credential-definition
title: "Preview credential definition from URI"
description: "Fetches a credential schema document from a URI so that you can inspect it before you create a credential definition from it. The service downloads the document at `credentialDefinitionUri` and returns it unchanged in `credentialDefinition`. For OpenID4VCI 1.0, the document is a claim path pointer document: its `claims` array holds one entry per claim, each with a `path` array. Send one request per URI."
sidebar_label: "Preview credential definition from URI"
hide_title: true
hide_table_of_contents: true
api: eJztV99v2zYQ/lcOfEoAWXbSFBiMoljqpJvbYTFiJ3lIA5gRzxYbiWRJyq5n+H8fjpQt23GyvgwY0OXBUkTe8e67H99xyQS6zErjpVasyz6iz3J0wCGzKFB5yQtwWY4lB6GzqkTlYWJ1CRxurvvgNPice1joCjKuQCpnMPMgPTziRFuMKxa5x12lAidSSTo26pM+hVGO4NDOZIYg9FwVmgsHPsfmbO5h3Gi52Ci5sXIMXAmw6CurHFlQqSznaooCpDosNU7ho7ZwZVD1L85ue304STvJ7okyoFFwWYLhPgejpfJoNxu6IL2DcdjhxsCt5QvIdSEcaIWAytsFGLRRRwLIsxzm0ufAYUwaa5kUhqhEkLH4rULng9TNdT/9oljCtEHLyei+YF2WaTWR04HFmcT5hZxKz4s7XhTogzOid8BblrBa8wctFqy7JC0eladXbkwhs3BA+6ujZFiyGHh68wuDrMv041fMfK1HWhSse89eCAd7SJixZLWX6MJpL2xs9DtvpZqyhE20LblnXVZZyZK9JP19NBqAtkDPYUhDPQkxeyVnvYYJ5XbKEobfeWkKOi/33rhuux13u7ReSTNdtgsjRRqQWIU/ctoZrVx05rTToceuZb1XiiZUlgBXZRk6N6mKYsGSfy8CPwb/Ic27LoWa3AeTSt5vFevauVDJL9ZnUhcniqY0KR5ciLCHF4Mtg72tsAY+Ry7QkhP031lE/oeR20YKrdW2pwVSGtD7xZazD8kzLHYRbKQb2KgZTNFup9VZp7M6oP5AmjeZ+IFTlzKVB8MtL9GjZbX3z+Oh7ZQr6YLD1J8q9aT0XMXGNQ9dgD4r7UGgKfQCRVyjWpEOSumcVNOEimin12W6KkSQe2yCqi1Y5CFS+4E4+YkDcaN45XNt5V8onkHz9qfO0T4RpKImiHaGFsIxexitEuYwq6z0C9a9X7JzIz8jvT6syEc+dYRFzWwQqQ2ONkx9zBLWd65CS5CU6HNNtGi0C5Bwn7Mua89O25Eo2yIqasXqaGuDSoq2E1/nvt30q1YzlbRN5FZGdpIXLpi56+gFlrp2kiWsssUWpwgsdYsbmcqp5cqnUrNVsq9gYLWoslDHL6j5Jw1Dz6dSTV8Sd3F535CHBv0hJWHMnXUMNknA44eESToqho8lTPGSVs/r/Of1cLFr2PmgD0+4AKoSQjfmfhzyZryocM3a4x09Y4jHQFm50IaMxYn8jiLOTONoI4zhSGmPQYG3XBYBA8MzPE4A02m6p7YLteC7ha4swdF6wsX7ccooE6kgr5vR6HKd8q/MLD86OxB2E71uBjwLzQBLLilKrjJGW/9rE5kNuPK35tNuSLezYQ/zjRAYq2dSxElek10eQdKT+nwkjhr+WFIw0RZu0cqJ5I8FQjPJOKA64ypDOLqKU/JxmLQPCw4sus0Rm3odHJNFXme6cJQC0gHlByqScTWhxUg5mtUklXYSxugkHDajExZQl/HWpOegciH2nivBrXCt4K/kNHMVeu5i3tRIB2vv3vTgtgdHn+5Gxwn0L0cfYXjR+nQ3gttePK0/vIKTXzonb1pvobzQWbu8+GN7uozjqSNKLGSGyoVcWZeF4VmOcJp2noVuPp+nPCyn2k7btaxr/9HvXf45vGyRzCphXvpiJwcCWGuWXpcb9aQY9tPO6Vn6Jj0hWeqAJVdb9tSXhNcuXzfX/f363SKv/2+F/91bYd2oPX73bVNwGTpOSLplzYL3bHYaLxoTSXy+y4TxYqkkjTCBDWnrIT4Mg0ZkxIeE5cSz3Xu2XD5yhze2WK3o87cKbeDwhM24DQ0hMPqa+gOFPhHFsF7MrtaIHKDtRRUZZ29MIsaLEudZhsa/und7FBhcDUcsYY/1VbcMIxGznBidfrvsC/vCgv+h7YQxjL4vWcHVtOJT2r++ACaMeGyXGp8CNdYv5Nl6SS22rNxnyegM/ZJrB0XeUbl/xsX7zfa48qLAhpnjbsqCh9Vq9TcwzkWk
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Preview credential definition from URI</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/preview"}></MethodEndpoint>



Fetches a credential schema document from a URI so that you can inspect it before you create a credential definition from it. The service downloads the document at `credentialDefinitionUri` and returns it unchanged in `credentialDefinition`. For OpenID4VCI 1.0, the document is a claim path pointer document: its `claims` array holds one entry per claim, each with a `path` array. Send one request per URI.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"HTTP or HTTPS URI of the credential schema document to fetch.","example":"https://schemas.example.com/lpid.json"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential schema document fetched successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The schema document that the service fetched from `credentialDefinitionUri`, returned unchanged.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The schema document that the service fetched from `credentialDefinitionUri`, returned unchanged.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialDefinition\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the wallet is not deployed, the URI is missing, or the document could not be fetched or read.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read admin authentication configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-admin-authentication

---
id: config-read-admin-authentication
title: "Read admin authentication configuration"
description: "Reads the authentication configuration of the admin that owns the access token. The answer shows if password login is enabled, if passwordless login with EUDI Wallet is enabled, and if the admin has linked a wallet."
sidebar_label: "Read admin authentication configuration"
hide_title: true
hide_table_of_contents: true
api: eJzlVm1v20YM/isEPyWAYjsvBQajKObZWeG2a4Pl7UMRIBeJlq6R7tS7kx3P0H8feCfbkuOsSz9u+RDLPpF87iH5kCtMyMZGlk5qhUP8k0RiwWUEonIZKSdjwUcQazWTaWXCNz0L7ySFVOAy4UAvVGMXx2QtOP1IqgdX/IuyCzJgM72wIGdQCmsX2iSQ61QqkBZIiYeckqh9mrOX8MZCugzOrydTuBV5Tq5jIlTCZls4mbCQS/VICQhYeIMeRqhLCuCnCQ4xXIdvO2KjUeeyGKEhW2plyeJwhSeDAX90mbp6DUcMINbKkXLsSZRl3hj1v1l2t0IbZ1QIfnLLknCI+uEbxQ4jLA1jdzKA6cbc934X57gDaqbNLuqCXKYT+yzQOhE/E2KTYrFLbDdGk8VWiAetcxIK67qOUMskvmjVw89AadvDp7319ApYu/FuM3IZ7Y2yLVKPg2uhsmSwjjCU5yvcr43bxe0ykqbTFvuvywFbadBmbCjhLyI/f4ozoVKatrFYZ6RKnzO7sYK1GUwn6yqX1laUgHxvhHI9qWHUjgjxxpgT2/xFeDY45sD/ujMMfa+kYea+IhmjzVgnhFF4nrTg3kU/6KKt9fbiUjlKybC/J1GUOeHwbDCo97jfQ9bGBH8TCUhVVg5KYURBjnMe7ttl9FpxWrSRf1GCEWYkEjKMjl99EzTnf0rNVDkySuRgyczJgA+zw1EdoaW4MtItcfh1haNSfiR+vKv5jiK1zMVEptKJfN0iB19KUtPJ2c34ECO85pb6QyiRUsEs30UY1BCHmAZdEC7DIfbnp/2g7n2v5/2urvV9YzMeRms9nO6FJlTo5jIYYWVyHGLmXGmH/X5ChT4SpezJtOkerKNdBxdGJ1XsVe0FNz/ycOlEKlX6krkNx7tA7rYsX3KxhRpZc71Jtgg/RCg5VEgTRqhEwaejps7XQ6ALbHQxhUda7syKsDvMRV7RWmTuO37uIYSBorIOHghKQzP5REnQ9/uAEe7hQGlH3oEzQuaeg1LEdBgB9dLejtshNIZvl7oyTMfRIy3f3feQK06qmV73pYh9X1IhJBNpq7LUxv26JW9z/40sPmO9nbAdWrZaWho9lwlZEBBrbiVHIPmTi7azbITq9oPghoycSZ4/sJVuC1NrK6FigoMvvg2mh36D2m94YchuQmxa5+KQETkd69xylqQFTmEYdha0SYVqyOQ9MMyGCDKdN+vanCMsIWlaM27Bq6xPjxMqESaxR/6+UigHs5zXR5/ahmmP9vZ0DDdjOPhwe3UYwfT86ne4nBx9uL2Cm3GINr38Ase/DI5Pj95AMdFxv5h8asVkL4Vwlle0XMakrBe+deWWIs4ITnqDZ6lbLBY94Y972qT9xtb2P03H558vz4/Ypo7QSZd3asCTlei42mQPI2TZCGk/GZyc9U57x2xbausKoVp4eGNt9tx/Wj53e6w1SP7DK36jRY6eXL/MRVh9fNJWjZB/xflpWMVnkkeTd4fR7lIdoRf0uwgzbR2brVYPwtK1yeuaf/5ekfGjJsK5ML5Z/OBZTyg/AR5ZIXEUx1TyKPFS5qVyZ47X7bHz/vyqwdNV10evrs0De18fqWXL967QBgj8n+fBXpO3XI4faflu83o4edFgI+7hbWb5rq7rvwGN1wD0
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read admin authentication configuration</h1>

<MethodEndpoint method={"get"} path={"/v3/config/admin/authentication/user"}></MethodEndpoint>



Reads the authentication configuration of the admin that owns the access token. The answer shows if password login is enabled, if passwordless login with EUDI Wallet is enabled, and if the admin has linked a wallet.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The authentication configuration of the admin.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Configuration for authentication methods

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>password</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Configuration for password authentication

</div><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>oidcPasswordless</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Configuration for Passwordless Login with EUDI Wallet

</div><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether Passwordless Login is enabled for the user"}}></SchemaItem><SchemaItem collapsible={false} name={"linked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the user has linked their EUDI Wallet for Passwordless Login"}}></SchemaItem><SchemaItem collapsible={false} name={"authenticatorCredentialExchangeId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Exchange ID of the issued iGrant.io Authenticator credential"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"authentication\": {\n    \"password\": {\n      \"enabled\": true\n    },\n    \"oidcPasswordless\": {\n      \"enabled\": true,\n      \"linked\": true,\n      \"authenticatorCredentialExchangeId\": \"string\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read admin avatar image
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-admin-avatar

---
id: config-read-admin-avatar
title: "Read admin avatar image"
description: "Reads the avatar image of the admin that owns the access token. The service gives the binary image data."
sidebar_label: "Read admin avatar image"
hide_title: true
hide_table_of_contents: true
api: eJzlVk1v4zYQ/SuDOSUAYzsfCxTGYtHUThfe3TZB83UIAmQijSVuJFJLUk5cQ/+9GEq2FTdpb730YskiZ+bNm5lHrjBlnzhdBW0NjvEPptRDyBloQYEc6JIyBjtvv6WlNhByCmCfTbcvSdh7CPaJzQCucgbPbqEThkwvuN3zqA25ZecrpUADVGgrdiRhZymOMbFmrjMJfypBTmN0VOjYV9Z49jhe4dFoJI/XkK/+CawC8m+HT6wJbIL4iwvD7xVn8s8nOZckb2FZMY7RB6dNhgrn1pUUcIytQ2yaplF4MjqUzT1/VFWFTmJuw+9eQPa9Ov5Ra8cpju+QnbNuYlNG1b5Pe6ndqzUC+/idk4AKKyesBd3SsbXegtUmcMbCHL9QWRWM45PRqHnD/RsJbkzwF0pBm6oOUJGjkgO7mG6jdti/NlSH3Dr9J6eoMGdK2Qk62fqhrdf/lJqZCewMFXEg2EEMs8NRo9BzUjsdlji+W+Fppb+yvN43kiNlXriY6kwHKuCWioID7J1XbGbTk5vJPiq89uzgNzKUcSks3yssOeRWpirjSA2FHMc4XBwNrXm05NJhHI5hOzax/VGACEwfcbzOZMql7bJAhbUrcIx5CJUfD4cpl/aAKj3QmSMTBtpio3YdXDib1on8ec/Nv3m4DJRpk71n7tvlXSD3W3ovpcva5liTvKkytR8UagnV1gcVGipl9bRr8Ni1uFvl04sZPPESZAzYhK65WyVcUFFv9OjhlZ8HaMNAWfsAjwyV47l+4RSedcjhocUID7BnbODoIDjSReSgooT3FfAgG+y4HUNn+HFpayd0HDzx8tPDAKXVtJnb9UBSEgeSS9JCpK+ryrrw85a8Tf768/bTa9b7BduhZWMElbMLnbIHgsTKDAUGLU/p1gh6zVDb1jC3Dm7Y6bmmx4Jh4jgVYqnwMPO+JpMw7J3H/p/tA5n0HcMLx34TYjMzF/uCKNjEFl6qpD1ICdmIjQfrMjIdmXKqgfa+ZgW5LVIVgy0kwhLSbiaTHrzax/IEMim51B/EfDWZAPPCPvu2tB3TEe3t8QRuJrD35fZqX8Hs7OpXuJwefLm9gptJG212eQ6HP40Ojw8+QDm1ybCcfuvFhPZM8nKiFTph46PirTu3oiRnOBqM/la65+fnAcXlgXXZsLP1w2+zydnvl2cHYtMoDDoUr3ogkpXapN5UDxWKbLRlPxodnQyOB4diW1kfSjI9PHK8d5eI/om9O1O9E+O/vJB0YhD4JQyrgrSRJCJrq05C73BxJDeXVkRRYYwvz56Q3ivMrQ+ye7V6JM/Xrmga+fyjZhe1XeGCXGzSqPTrIyEq75MoE54mCVei3VFCpADbO0rTV/jPZ1cSvxZ4fT17inrWvYjf9ZJZ9rzuSlsbXH5Fgd80+SgN8JWXnzbb25V3DTZy2u4WWu+bpvkL1UmaSQ==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read admin avatar image</h1>

<MethodEndpoint method={"get"} path={"/v2/onboard/admin/avatarimage"}></MethodEndpoint>



Reads the avatar image of the admin that owns the access token. The service gives the binary image data.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The avatar image of the admin, as binary image data.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"image/jpeg"} value={"image/jpeg"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read admin profile
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-admin-profile

---
id: config-read-admin-profile
title: "Read admin profile"
description: "Reads the profile of the admin that owns the access token. The dashboard uses this operation on the Manage User page and after login."
sidebar_label: "Read admin profile"
hide_title: true
hide_table_of_contents: true
api: eJzlV9tu3DgM/RWCL00AzyVpFlgMimKzmWwxbbcJmttDESCMzRmrsSVXkieZBv73BSXPNRN0sE8LbB4Sx+Yhj0jqiHrGjF1qVeWV0TjAr0yZA58zVNaMVcFgxuFfykqlwefkwTzqaEJpys6BNw+su3CZM2Tk8ntDNoPasRgpB6ZiS+IejA6wv0nThOHKsYVKnkhnQGPPFgozUbqLCS5AowwHmBo9VhPhdiw0ziM1TNCyq4x27HDwjIf9vvxZX9DlK0uRIKnRnrUXEFVVodIQsffdCfIZXZpzSfLkZxXjAM39d049JlhZ4edVjGvshLRyARz4bYN45Qt5cfbCOMGnjja+o3QnI0/35BgHYyocy/p+1MpyhoNvqKlkvN0MrrKVaM5bpSeY4NjYkjwOEBPkJyqrEBuTjeRgkyCXpIptPtZNT4NZk0QavzT/IlZNgjQlT3ZU0oRHW5muw46DOSixh9Fww8OV3YHomgtBNAkW5Py1csrzDhw+k/MwjdaQkWfwKi7GmmJ9FUp7nrB94eKrKeb0BfNlp5QFkG7zVuVG74AJHfTGQTAHXZf3bAWudk34lVY/agaVsfZqrNjC2NjlLnnjYiIXPncqwdXXz+DNdi/85NlqKnYhd9ravkov0Arf/OzcmqnK2O7ieNRiRBkCqC1W3Mk/F8Lz77O36mnT827tIFZzxVr31v4keNQ/ED87y9iqmrC1xp6YTFQ0PA9Xot8mv5C8JXrbZlgozlG/32xxv2XtS5H6kzJQuqo9VGSpZC8dHde7mXyqfW6s+skZJpgzZWyFnZj+Fs+C/2lqRrrdOI7tlC2EMBs5ahJ0nNZW+RkOvj3jcaU+sTzeNrJGmjjJxVBNlKcCbqgo2MPeWcV6NDy6PtnHBMMJHk/zUrJ8m2DJPjdyZE84pIZ8jgPsTQ97RofBoEftoRepuRB7nf2QS9MyxwRrURzMva/coNfLuDQdqlRXTSxp31UGm2TTwbk1WZ2GkeMVN7/ycOFpovTkNbiLnzeJ3C5TeiGdFRtinthFZSm+SFAmhbYmOD9Y8bht6rjZXwj++QgeeAbS+iI6saHj8DWlol5Ixt2anzuIYaCsnYd7GYl4rJ44g0flc7iLHOEO9rSRAy9n8JZUEXJQUcr7CXB30t1wO4AW+G5maivp6Dzw7P1dF6W9lB6b+SakNGzCdthAV1eVsf6PZfIW61cflq/Ws75asI20LEBzRXdAkBrZN55ByV/p0HYMjRmKrRwU+5qtGiu6LxhOLAc1p8LByLmadMqwdxZ6frQfRtXtwHPLbhFisU/O94WRN6kpnFRJOZASshaMWxN2GaRBOVdzArkpsiQEm0qEGWTtPkxX6NUulMeTzshmrhPWq0h7GBfm0cXStpkObG/ensD1Cex9vLncT2B0evkXXAw7H28u4fokRhtdnMHB7/2Dt53foByatFcOP6/EhDhXOhmeC5WydkHl5p1bUZozHHb7L0r3+PjYpfC5a+yk12Jd7/Po5PTLxWlHMM1ySF6WU5KVmbReVA8TFNmIZT/sHx5133YPwsRknC9Jr/CR+0J7b6kWN4ZsXWwXB8R/5ubTioTnJ9+rCopDTh3Hriin33B6KFekKKiYYJTU2wRz47x8f36WW8SVLZpGXv+o2QZlT3BKNrRr0Pn5gRA0+EE0Co/TlCtR7iAmQaw2js1mVeU/nF5K/FporerbQ9C39kG8zz/p2YrvTamLFOS3KPJWyDtpiE88e78wj19eBSzkNVpLOm+bpvkHPgksgg==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read admin profile</h1>

<MethodEndpoint method={"get"} path={"/v2/onboard/admin"}></MethodEndpoint>



Reads the profile of the admin that owns the access token. The dashboard uses this operation on the Manage User page and after login.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The profile of the admin.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisationAdmin</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name"}}></SchemaItem><SchemaItem collapsible={false} name={"avatarImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Avatar image ID"}}></SchemaItem><SchemaItem collapsible={false} name={"avatarImageUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Avatar image Url"}}></SchemaItem><SchemaItem collapsible={false} name={"lastVisited"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Last visited date time"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Role ID"}}></SchemaItem><SchemaItem collapsible={false} name={"roleName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role name"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Admin's phone number"}}></SchemaItem><SchemaItem collapsible={false} name={"imageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the admin's image"}}></SchemaItem><SchemaItem collapsible={false} name={"imageUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to the admin's image"}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier for the admin"}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity provider ID"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the organization"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the organization"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"organisationAdmin\": {\n    \"id\": \"\",\n    \"email\": \"string\",\n    \"name\": \"string\",\n    \"avatarImageId\": \"string\",\n    \"avatarImageUrl\": \"string\",\n    \"lastVisited\": \"string\",\n    \"roleId\": 0,\n    \"roleName\": \"string\",\n    \"phone\": \"string\",\n    \"imageId\": \"string\",\n    \"imageUrl\": \"string\",\n    \"externalId\": \"string\",\n    \"identityProviderId\": \"string\",\n    \"organizationId\": \"string\",\n    \"organizationName\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read credential definition cover image
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-credential-cover-image

---
id: config-read-digital-wallet-open-id-credential-cover-image
title: "Read credential definition cover image"
description: "Retrieves the cover image of an OID4VCI credential definition. This operation needs no authentication, because wallets read the image from the URL that the issuer publishes in the OID4VCI Credential Issuer Metadata. Anybody who knows the credential definition ID can read the image."
sidebar_label: "Read credential definition cover image"
hide_title: true
hide_table_of_contents: true
api: eJztV1Fv2zYQ/isHPiWAbLlpCgzCMCyzs8Jd1waJmzxkAUyLZ4uJRLIkZdcz9N+HI2Vbce3tdcD2FEviHe++u/u+y4YJNBZz7lGwbM5LhwkT6HIrjZdasYzdorcSl+jAFwi5XqIFWfEFgp4DV/B5PLq8H44htyhQeclLEDiXSpJ9HyaFdKANWk7PoBCFA6WB176g43l4n8AMc147hBUvS/QOLHIRbox3za2uwuOX24/gC+7jN+dqtGDqWSldgQ6kCu+3MQ33MY3j0d/Rc8E978OVWs+0WMOq0PCi9KrN71gWMB5BztVBTP0/FEvYLrWxYBnLtZrLxS1yMZIL6Xn5ENL5bFCNxT6aIaE4JicsYYZbXqFH61j2uDlA/4uSX2sEGQznEi2hfjrQgIwzmNPZ7zKaa1txn4BfG0yAKwF5yWXlwHlb5762SEd26BG6XOXYZwmTFIzhvmAJU7xCynXneLQLYCxYwix+raWlhvK2xoS5vMCKs2zD6GKWMeetVAvWNE902BmtHDr6fjEY0J/XEEwKBIeW+s6ir62KeVm+antjtvboqNMQpkOtPCrfm6wNTmHrHArkAi0UuhQOpsEsfTa4mFJuebShm/df6OlU4AmLSLKMzaTids2apklYvIQSoafLmEvHOTembPs9fXaUW/eKPWqPDK3VdqgFtUf4Peog8pRsw9GzZ8w9tZClNvQyori33kculccFWvL3jVemRJZdDgbNEfdHst2ZsF+4AKlM7WHXtZQ75fu6aJ/0iQ6tuM9pUqfH2ycU5DWQ7/7TQE5OznpsZqW7nJyAtmE62oHJuVLa74nLeW1RtPx1gHSTMId5baVfs+yRwOELoiTWUhlELoOzwGZEEecsYZFXCcsKfaGJBBcYoCSyyFi6vEgjK6Yi+ulFik+1QSVF6sTzyqf7FHv7FNPN8SZp0pCybAk05nqMPUdY6RYKlrDalixjhffGZWkqsNI9bmRfLixXvi81a5JDBzdWizoPcJ9w808e7jxfSLU4Ze7i58NAnva1uKPGjv14ZeRvuO40Fo8vWnqOxdwT9FXtC23ln2FQ2GFjXd2M4QXXB0IcaXTJyxq3SjN95We65dKqdh5mCMbiXH5DASvpC5jGGGEKZ0p7DA685bIMGBie43kC2F/0D9xm0Br+uNa1JTh6L7j+adpn1JdSzfWWA3geOAArLglIVxujrf95D94uf/l+/+o16t2CHcCyMwJj9VIKdMAh1zS2noTflFih8nGbaRGKAxG08x6tnEs+K7GzfLiwfZCUwlkrrudBfo8b3lh0uyt203ZzThF5nevStWsVlRAV2TjQdsFVC6YDr+NulASWiFpPEzNfQzuFHVJxULtQHs+V4Fa4XshXcuVhXtJmFErbIh2ifXg7hPshnH14mJwnML6e/Ap3o96HhwncD+Nt47vP8OaHwZu3vXdQjXSeVqOP3+8ijkiolDkqF0h227mG5wXCRX/wXelWq1Wfh899bRdpa+vSj+Ph9ae76x7ZNAnz0peveiCAJXRe76rHEka0Ect+Mbi47L/tvyFbo52vuOrEQwvdCRbukO/hiHU06/8t+u+36JbPPH7zqSm5VFSHUPhNKySPbHkRd7W5JCl9LSZxEVeS1s8gKHT0mKSwhGUnF9eOqjwlrNDO072bzYw7/GLLpqHXX2u0rUAuuQ0TG5VHOvp94t+obi+c3bYbyjn8W9b7o/hvRUaRwgRJYBljCXshDTq1/jdPu004wBIPX+U5Gt9x01m0m+7u8P56wprmL44jHwk=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read credential definition cover image</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/{credentialDefinitionId}/coverimage"}></MethodEndpoint>



Retrieves the cover image of an OID4VCI credential definition. This operation needs no authentication, because wallets read the image from the URL that the issuer publishes in the OID4VCI Credential Issuer Metadata. Anybody who knows the credential definition ID can read the image.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential definition that specifies the credential format, type, and claims structure for OID4VCI issuance.","in":"path","name":"credentialDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server returns the raw image bytes. The `Content-Type` response header holds `image/jpeg`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"image/jpeg"} value={"image/jpeg"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

No credential definition matches `credentialDefinitionId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The credential definition holds no cover image, or the server cannot read the stored image.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read credential definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-credential-definition

---
id: config-read-digital-wallet-open-id-credential-definition
title: "Read credential definition"
description: "Retrieves a credential definition by its ID, with the credential configurations that it holds in `credentialDefinitions`. Each configuration holds the credential format, the claims and the issuance settings."
sidebar_label: "Read credential definition"
hide_title: true
hide_table_of_contents: true
api: eJztPWtvG7eyf4XYe4DaOJJs59GeGEVxXTvpUZM2Rpw0uMg1vNTuSGK8Ijck17JO4P9+MUPuLvchS07cNLhNPzSWlhwO582Z4epjlIJJtMitUDI6jF6B1QKuwDDOEg0pSCt4xlKYCilwDJusmLCGjU8GbCnsnNk5hCMTJadiVmiOgw2zc26ZsGyustQwIVlcjz2pgJp4xJ7yZN6c7Se1FpgqveB24L7OuFgYxmVKH4UxBZcJMAPWCjkzo/+V0SBSOTiA4zQ6jNwSr4CnJ2ImLM/e8iwD+zIHOU6Pe5CLBlHONV+ABW2iw3cfWyR7I8WHApigiVMBmqlpG+mAfkQRk0OCY9fvbpXDgDbm92isLhJbaMAh7OX45NEfx+Nqx6NoEAlEJud2Hg0iyReAe+3ZzjiNBpGGD4XQkEaHVhcwiEwyhwWPDj9GuHB0GBmrhZxFNzfnONjkShow+PzB/j7+0yTBce9OtZellJkiScCYaZFlq2iALLAgLcLheZ6JhLiz994gsI8BMrlG3lnhlu7bTYCymryHxEaDLXFLlE4ZR8IqDSmKdSlCoEfs9RyYVTnL4AoyNhWAkojySKNK+So5vZyrDDxMx7U1Yu5FWklgIK1eETOBJH+NCjl5qVFjeTHJhJkDaRN+X8pCsNGxG/obWJ5yy50aNIkp0i6326QbbyfSSC1hHJECnTV8AeyKZwUgmXsJMk5jlFy45os8Q0SeTA+SB/zho+Hjyffp8BH8MB3+iz/ZHx5MHiQP00fwePr9fnQzWCfYG3fU1VVujJhJSJlVtyhtkSuJj7jb7xsDzOKexyc4T8MUNKDhWQ9BSEYm5oRY/gdoMRV8kkHANkN8IwO245m6yyrjZT6NUors2ks941IYvi2dupz3yC/JWLIU8kytFiCtk8+S68KsERHPNG4hPbLB+rJYTED38emaWbEAY/kiZztCMgOJkqnZZUKmZDHkjC3nIG9ZlS25YX7VBvUOfni87/67GURFnv4FaGXcWLZQKRK5F7nvCbmMTyDbzK9/Fwsuhxp4SjJFs5gbMkGMyH6g0U0hZYUBx9W1CO7AaDZi35EZYadKW4J6opKCWH508N1uUxrXj1ynrSbYFNear24z3K2g4lbkne3uGEsyss7mcgxuDKBTt+tjlzuYV1rRWTphWCyLLItJzXnpZwIlkaq5DrluCwuz2ZW9lLeia0QK68K2we2u7ouS65N80ZooqykFTcKGO5uBRDvqAy7ilTPjwpaYBx7KvDsfiTT2Ls1bQIIUroZBFBjrHH4XSCDrbXAcPUraImcjOiHIo6byHIe7+zQrvpZ73FTMT+8q+d4nFAa8C3CqQI6R9nE7n1ha6MpGlQ5wmqklbf8LGsCWWt6ggcuFJ7c84Suz2UP8Tl8j9JSvDCukFVktPWm4HAEHQwuZIs+Vtq/gSrlgOFhpolQGXHaWeoteJsb4PR6EAaKHZZiuoCE+gXSzqVYLv/3OnutZv4Gdqy3EzI1DqqZk9RoqUgIbsdhYbgtzkQlj41JagI2fvn7GXqtLkOyMBrAXwlQnpL7JFw/2HxwEEN4+PG5Mxcfd+UthzIXFdS5CWFchpDMcxHKtpiIjEengRW5PFovo8F0UgIkGURtB/GrtmtH5TTkDoR7rVW7VTPN8LpLnsHpGp8DNlHfjSuXGQBZl/RJWhyxORXp4CauYKc3i68f7T+IQd/80GkT4aAM6tR3ZjNJzWIVGeie+FGm824PiiP2PKljCpVSWJXMuZ1DbZsanFjRb4QiK3245fZCiyqnSCdSWyrkLCcbcVZPap7FCpqB7lAVdfeGcUg6anDvoUJlrZF5BadfuioyDapBMlTHVFTSkqrMiKXJZAtdD+rwKtb3lRX7GQFXOnNJuE4UFsoB8YxMHgC0chHs5oLI4UQYuSF6dAxEpUzJzB2RyrAujLhapSmKfI+mLmyqZ7Ir5++UlZR7cKtH5zc0g4oWdKy3+Q/x85cj7miBtdDdq6Q7+zvV51hjWgBg6tnbCxjk4FjcmXKRguciMt0ivnh2zJw+ffM9eiWTOjhqgPbYGLVuicriYcAOpn/gSx7IHo31Gz5xKmVD9e5dFi1XDcjYBP28mR++CdwvQDFgfPbgoic5Q8ToOkZQ0dk5SngqTZ3y1OZI+cQNZHYdWghZiyzUFQ57Lb8amG7u6TNsmApXr4ei+lVqLYNyjEp5tAfnn49NHP7CMy1nB0YLyWQU/7WyyQXGeLTFEIcLHIIe//Bz7UHYmlcYMsFwxh4bTcbTGBmTztBrRTCJ+iNcd47XgYU+omhc6VwaILhOeXM60KmR6rDK1hUP6N1yzBIeyRKW9xCc213D96Tf+r2f0X7xL61q4tp+xIlxbpmTvyuVyLiHhl8vUTG0W4xdqpphYION7Anyu0668Flpscdh69aIEmFVLEF48s6/heovQ5CizoCW34grc7kvCNwDeNDg6xm837/rnmlV/7t4nrYUI4ZuGN33lc+NjaUFf8WzzCeE3IcWiWLBcZRl6B+FnNrNJJbW8VSBrWJi2NznBxCN6/8C1PpVproRsHx63DSkDSNMguuwcFVj8fmkvrpILzNqTOcYw/I9jtvPr29e7IxanyT9NOny/tPSQovyzk+Gvb1+zP45HoTvHp2cv2cG/9g8eDh+zxYlK9hYnL0J3FSyFCJeQo0FUgiFvRWEDoXeKZZCNe/317OXvOBKDKA3G1OUZyCCx7kyQc237bBJfZYqnnejH44Dmc8aFNDYoVLUTRf8YXblwpklMX0H4h38UEJK+ryjn7FIzXimDuDWRUdtMh+zGkcyNM1u45rZoOZcc7oOAmDL8YDzPgesqUWLJjXczLGlTkBDlq2QLwe1NqTMMFoLzyCfvK2CCt9eFlodQjKDQKucjSEZQpOIwF+nhgbfhqUrsVtFklS6194RtrVweWaVnI2HUiJRs9Hh0MMpyPJeN1qVn39zRVMI1mfusKldSDa+jHZQjsIpNCuFLaX58v5Fx2H0FZ+M2El//iThIG3ILM6UpKuZZ9nJKNew2zlZYCueOO/OoYNzcEomly2Q2va6bwXbI0WMupvsUY+2qqLV76KRnfHJ0Vk/vwG15HqkkxGwHM+no3CnLA0wXGewOWIyCzXZy0AYP6Z7wPg+Gh00cA5wTADn8UPCMajCMW4t1HUJrwOIPbkz/cxKcvJgM3aDgUWnEJisc44oAdCJO0LlbpdlEpavdUN5wOxirCCQ0cB4Nog/uH79CdN4IuDmPsCzfZUkfK3oV6w4Mqsjti1rQ7tHgrqTh1ztEzjUGUK5xAlOlOyIbLIhg3EIuheK04jmsjueQXPaKbhUdlqJ71prUSyJ80qN7t8vcgC041lacLcMCYAmCS7NEQz22LFFXmKqxS0WiaJxohxLq5+ByU2E7vR9NnkEbhbLLpcRWssXJC7bjvUyfjV+cvIh3ibSUaD17uTd+elwFWpXXQbph3salPZ3TMfwKOjQJC+JlypSq/ETVATOuhK7BFJlFRxR8Ik/AHdyZwAYjiQmQ1/WIOFVghlLZ4VTYmOEnhpbQYB9G2OjSDOrd7M1mOFippC9ifchi5EU8aK2PRuIaFrl1TgK/pvGYavBT1jI4lKuK0SQTo9YqXRDVtqcC6YWzBq5LxBkANoGEFwY6E5M5FzIUMedBUu84rGfqiJ1RcMu4VHYOGocOcItlepE3oFYtXjFGyGDHaVyRr7L2ZOVIHF0hwg1lMYYgw9SL2ZD6LHSMFsVT9vbdD9iksNVuUIq5ZG4mmTDMkRoLKWasn5ZfxwEFuuAF5SQ58zPJAu5WckuyWWGgYVpQfXDU5P5hc/OitFuVfnayxAitJI9RaC2Rq4xan5ppORQWFNxARCjXgpvDrq4ajaZLoHk3g2gBxvAZbM7qUnsTXFvT0IUBNSZVLUmEZRXBIROa7KlkYyqunUepqEJTp0Ib16jnHAeaK3LSI3YkGe5p5XwQHXNIpUbsGf7t5WPgQLDYsfeQRrv65I/4509YtvzRgL4SCfwUB0t5ZXvWVt0ByVC1Mgk+x9q1O+vSARCTFZWzq0SPnY5PGrLUz+6KQq5aTNNuzVR3K/yIgK8+ev6+o2x13bP3rjR6AcfP14QEob/bYKrKA2vcjR1Jup0dKiU5PN5u6VoGt3nQlvk3c7U0TemTimVKzkCTUW1aRWfkOJOw7FrFUd1Y1fAqvlozmwGKVTfy7eMXNnfgIbPsnGyS3AWf7aNZTcXKWjhDGV8lzr/QB+/JaZSTtx1/yqwOloPbz53otNqPRrlIRwfxbh1AdNwTYY2OwTZtGyl41aswKjtb0IRmGXPuI+GmacMojMWBoYXCz3Vl7KgOl0+1UtPPKHbzJIHckmuIgyg8RpFTU7ZDch0E7mGB7telvbflKfNRrqqmLFfG+IzSjmudo4TdwWgfPalS0wtc0Vx4VKA8i1/CKqCOeVXp/MbeIPral71XlUoHBxNvP1AvDZUsHbIu7VOiUTYHdWp13cArgL0Zvee3IVMmO78LRnwXoNdd+xJWF9jN1MwX9/u6I+IRpEQQPwnPYoUW6Aawwde4PMkgNGSPHrMJNyLZ3arQKIy6oEkXNAmnVN+AnKPtSYfdRwuVUltS48u5mM2b/r0NHd1BYUBfYH0M2dRpGtlACpzMmpPbJPkqt40bx8TvPcnb+6X9snL2VRL1bytLVMqh/OMW1wiCPGV4aqfGSgLC8O4Fo9oL6E/PoAeZZoxeg2x/Wzg7qPczirpGOwgGNw/o2doujlv7U5sI5c2qy5qGki4qnZqLQ0l06qW+6OIvC0FG+uzCJSdOZYTqEHRnW4rvLcz8nrlkhBg2bMP1wJ3uq45duAK9qiC7NAsN94eJih0Df/LB80mAiDvnqIQq/Sbn/mpOSb9en+2w/BScmqeEiKcplrGoz6XA3l3KXS+4TLlthrN3jnNcr4CQSVakEDDJFavFQtgTYZJMmULfuckJgblGJ+pzSh0gCCTByYa4ggz3jGXoNKU8FM9OAwlEeO0C7Z2uCn0pHW9WyUiYCbCxHBs3Ke4Opp4VhO/f0ARMIFNLXyh11O5o3Bo6fSGV6yyOS9fFoS+hfxvVgTQCc9Nbdeb84Qa27v2svbTUd2ep0XvbVwOsQ7B2P5xH82L/gDSleXQasaPGhYq6GJZWZ1XgOsMy21W4DWHY0emYrAvd4Stzn/4eQFeLq6KbrW59uaQFnqElSodPrxpMEDb6oeodfKtefm4/79s3R5+hND7mN6GDscplpyUmul2b6VvfeCeFZcHZm+28fXO0u7mHM0goUBMQJ0fluzXdjbuyJecz9lI31fpwxq9Tdpy6hRj4lbx+3Xodz6yMhcVvXPJZI8GwNWp5xi3mTdmCYNx6/69HOJRmKWSAqVTmcPGA0tsE49qCNERTNER3xptKCB4EZT2ynkvYWCXehoKf027aH2R80h0cJ8CG+apQ3XFjFUs1X27XHHc/jayYtpXNdlZ39cxfeL/Lxhpm9QXMeMZOXVW/NGDew5xwy7/1zH5lPbPhfv3XX7qPtoGC+/qTemudUPcv2x89qOC+tet4peMASkOqXP0Bbc+Kcfbm1bhPxDTYQksPjTD0bYGFFhQauSpW3ZXRW6avrpwiDl93M3DLjOFZuhzJ6e0RYiIyYf0BMCyG4S5qZM7/zJbizcymLhAP5C/mebd9+c9oiO7yolOtJNdSmecm/K51Cm2EV9YuR8+/2O3MwIg83P9Lr2qujUO+jiubgztf0hx8yrXM+7yB+SdeG/QSFdweDF8G8u3q4F96dbD3hQ2VWfUphtqONrC+h3uH93Ero/EKGydbLrj2JBuxs6qm66aYw9adjR3faI999oNmi3vzugY+DVrK+25r7H67rvEXXtdoiUCoOa178PdwIyMMXNRC9GS9AyUiG16m2zrvObvn2x3On21XXBuxsUum1q/uoGYcl3dubr91ealxrrilHede7oBs3lMtYNW5uJvS8HvsU93Somy8KtI4wfa3GeGWq8rX5k3/Xg4NN4xa1Itn6JiaquniYl/da7XbrHkdTthG2yzYlWW8ZqUB/WVdKsHaxVd3d8apnEPrW1X7ay1pfatqf6tqf6tqf6tqf6tqf2ZVu5ljostza9932/sWzPCNlOFrIMuXjtUFnp5cU88pbn000Dnr1PX4QUSXUY5kMqd816W7BVjXP/syTj0pn9uTGbdnFrYvYIbRXbuC2FOco9NuU7WIcXPgKb1M+SN+euReKbz1W4FDtoPWSh+rFNGhv08CyTtvL97W63p2LcTeq4bR7iN6FWcHfN/5vwqQf+Z4sMgLy6qXR5dvj+je0mhkkCk5dCnVUjpl8ZU0f5HIvXkVUtJtvHjZmwNecJtgGuW2t+62mXDwN2bCG1m+aYgEuUmax39r+SSbgKcTvGcFmtEyLRph5tJ3/NIN3aNcPIcVXVzCPfIZvjc98u9bLxsu6nsRu9HAvUFWI0kWPocdzYAoQr432rt6sOeuWu2lDs7QKcYe2naR7pn0/dLu1fI+rNVh72O/GtygDaNd9b3X/QQWym8a3YPOosNobm1uDvf2UlioIc/FSMw0l3YkVHQzaAM41SotEt8P3QtmE4Qzy2cY/6+ZbtzjNiLnNTfOUCidLJU8qaMY94V/cbxjZ/3q+MbrxroFvdOxu1/SaPsOT+U+3IwbcGLmlmGLwlg2oZuiU3Fdtm/FDkdGV/N9j5DVXNB7csjp7A6Yy1I0wB4yP/HHlSo0kmN4CaufYhdG4OW+Un+5yzXBggskpHd7/10Tr9q/+KX+qkn1kGEtslSTsFhxJVL3MwoKVQ5vn+K/GHpVhZ5tGux63wqOmcX+iaeuu8m3MJUqdrqLGFmVKJc78Q1xQH7aeP/zn/I3G5QL0FwNwaU3r3CFFfOq16hQudcSGYsBoU7NkPYrODYhZXiHj1jrKU3YhtnEQSu55lbbkP4pE9roxTKRgDRQd7BERzlP5oBvo+uwbrlcjjg9Hik92/Nzzd6L8fHT38+eDnHOTf1CgZqdSKzyInOpEVVHZfRg/8Gj0UOX/cqVsQsuA3zwpyb63XRbrQIf8//yhzi84cHy7l6ecSGRYMSh8oj1Lrp64H4gYiooZ9Yw9T6QpwiZzH0j5B42CHu45ixwPojmylhc6uNHfHXgG53d3ODXHwrQ5LMwWtfCXfJEryCMbzWb8sy0r3yGPNspr+vtsq/lR0F6SV46ALlyJ5MCP0V0+XD9j4bcnFeBO5HFDXa3gAIwndDoJnTpvzx9Hbn3bjYdkauV+T+Cd3w0UWz7JIcC/h9dZ++UH1Fzn8Pqp2q4e7J2QuUH3Wgk2PnNzc3/AYPleOk=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read credential definition</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/{credentialDefinitionId}"}></MethodEndpoint>



Retrieves a credential definition by its ID, with the credential configurations that it holds in `credentialDefinitions`. Each configuration holds the credential format, the claims and the issuance settings.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential definition that specifies the credential format, type, and claims structure for OID4VCI issuance.","in":"path","name":"credentialDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential definition retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential definition record as stored by the issuer. The top level fields hold the settings of the whole record, and `credentialDefinitions` holds one entry for each credential configuration that the issuer publishes in the OID4VCI Credential Issuer Metadata.


</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition. This field holds the same value as `credentialDefinitionId`.","example":"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier assigned to the credential definition upon creation. Use this ID to reference the credential definition in OpenID for Verifiable Credentials Issuance (OID4VCI) operations.","example":"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that holds this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) indicating when this credential definition was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) indicating when this credential definition was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label describing the intended use of this credential definition (e.g. 'Issue Portable Document A1').","example":"Issue Portable Document A1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configurations of this credential definition. The issuer publishes each entry as a separate credential configuration in the OID4VCI Credential Issuer Metadata. The value is `null` for a record that holds no configuration.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this credential configuration. The issuer generates the value. Use it in the `credentials[].id` field of the issue credential request, and in the `credentialDefinitions[].id` field of an update credential definition request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialConfigurationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration as published in the OID4VCI Credential Issuer Metadata. The wallet uses this value to request this credential configuration during the issuance flow."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label describing the intended use of this credential configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"expirationInDays"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Number of days until the issued credential expires."}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer supports revocation of credentials from this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationMethod"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`status_list`, `status_list_2021`, `swiss_token_status_list_v1`]"} schema={{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List specification. `status_list_2021` uses the W3C Status List 2021 specification. `swiss_token_status_list_v1` uses the Swiss profile of Token Status List.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]}}></SchemaItem><SchemaItem collapsible={false} name={"statusListCryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"statusListCryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"enforceCredentialUniqueness"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, each credential under this configuration is unique per holder."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialReissuance"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, holders can request reissuance of expired or near-expiry credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. `cose_key` is valid only for the `mso_mdoc` format.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`authorization_details`, `scope_based`]"} schema={{"type":"string","description":"How the wallet requests authorization during the OID4VCI issuance flow. `authorization_details` uses RFC 9396 Rich Authorization Requests. `scope_based` uses OAuth 2.0 scope values.","enum":["authorization_details","scope_based"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value of this credential configuration. The issuer sets this field when `authorizationRequestType` is `scope_based`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display properties for the credential card in wallet UIs.

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties. The issuer always sets `en-GB`, and ignores any locale that you send.","example":"en-GB"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`)."}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format of this configuration. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL.","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]}}></SchemaItem><SchemaItem collapsible={false} name={"validationPath"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. The value is `$.vc` for `jwt_vc_json`, and `$` for `dc+sd-jwt` and `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential type strings. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. These values appear in the `type` field of the issued W3C VC (JWT)."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type identifier. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` (e.g. `urn:eu.europa.ec.eudi:pid:1`)."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type identifier. The issuer sets this field when `credentialFormat` is `mso_mdoc` (e.g. `org.iso.18013.5.1.lpid`)."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the external claims schema that the issuer used to build the claims of this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialCategory"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signingKeyCheck</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The check of the signing key of a credential configuration, made at the time of the answer. It covers two rules: the certificate of the key fits the credential category of the configuration, and the key of an mDL (doctype `org.iso.18013.5.1.mDL`) has the ISO/IEC 18013-5 Document Signer profile. The save of a credential definition uses the same check, so the result is the result that a save gives now. The result `does-not-fit` does not stop issuance.

</div><SchemaItem collapsible={false} name={"result"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`fits`, `does-not-fit`, `exempt`, `not-checked`]"} schema={{"type":"string","description":"The result of the check: `fits`, `does-not-fit`, `exempt` or `not-checked`. `fits`: the certificate of the signing key fits the rules. `does-not-fit`: the certificate does not fit a rule, for example because the certificate chain of the key changed after the save. Select another key, or request a certificate with the `presetId` of the category (for an mDL, the preset `mdoc-document-signer`). `exempt`: the certificate does not fit, but the key has an exemption (`trustedListExemption` of the key: the certificate is in a trusted list), so the save does not refuse it. `not-checked`: the category is `none` and the configuration is not an mDL, so no rule applies.","enum":["fits","does-not-fit","exempt","not-checked"],"example":"fits"}}></SchemaItem><SchemaItem collapsible={false} name={"messages"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The texts of the check, one for each rule that the key does not fit, with the fix (the category rule first, then the mDL rule). An empty list for `fits`. For `exempt`, first `Exempt: listed in <list> as <service>`, then the rules. For `not-checked`, an empty list, or an information text when the key has a PID certificate and the configuration does not issue a PID.","example":[],"items":{"type":"string","description":"One text."}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"suggestedCredentialCategory"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`pid`, `null`]"} schema={{"type":"string","nullable":true,"description":"`pid` when `credentialCategory` is `none`, the `vct` or the `doctype` is a PID (`urn:eudi:pid:1`, `urn:eu.europa.ec.eudi:pid:1`, `eu.europa.ec.eudi.pid.1`), and the signing key fits `pid`. Set the category with an update. `null` in all other cases.","enum":["pid",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"supportAttestationProof"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer accepts an `attestation` proof (key attestation)."}}></SchemaItem><SchemaItem collapsible={false} name={"supportJwtProof"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer accepts a `jwt` proof of possession (OpenID4VCI 1.0 `proof_types_supported`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyAttestationsRequired</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Object specifying key attestation requirements per proof type supported by the Credential Issuer.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key attestation requirements for the 'attestation' proof type.

</div><SchemaItem collapsible={false} name={"key_storage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted key storage security levels (e.g., ISO/IEC 18045 basic).","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem><SchemaItem collapsible={false} name={"user_authentication"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwt</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key attestation requirements for the 'jwt' proof type.

</div><SchemaItem collapsible={false} name={"key_storage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted key storage security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem><SchemaItem collapsible={false} name={"user_authentication"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. For `mso_mdoc`, the first element is the mDoc namespace.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><SchemaItem collapsible={false} name={"limitDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. Each path starts with `credentialSubject`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. The first element is `credentialSubject`.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the OpenID for Verifiable Credential Issuance (OID4VCI) specification that the issuer uses for the issuance flow. `version_01` is OpenID4VCI 1.0. A record that you created with an earlier version of this API can hold another value. The issuer sets the value at creation time and never changes it.","example":"version_01"}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"enforceWUA"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires the holder to present a valid Wallet Unit Attestation (WUA) during the OID4VCI issuance flow."}}></SchemaItem><SchemaItem collapsible={false} name={"supportInteractiveAuthorisationEndpoint"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes an interactive authorisation endpoint for this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the platform manages this credential definition. You cannot change or delete a system managed credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"extensionEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, an extension supplies the credential data for this credential definition."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display properties of the credential, as published in the OID4VCI Credential Issuer Metadata. Wallets use these values to draw the credential card.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential shown in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata.","example":"Legal Person Identification Data"}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties. The issuer always sets `en-GB`, and ignores any locale that you send.","example":"en-GB"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`).","example":"#FFFFFF"}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`).","example":"#000000"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image shown on the credential card. The issuer sets the organisation logo when you do not supply a URI. The issuer always returns the object, and `uri` is empty when the credential definition holds no logo.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image. Wallets use this text for accessibility."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card. The issuer sets the organisation cover image when you do not supply a URI. The issuer always returns the object, and `uri` is empty when the credential definition holds no background image.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"expirationInDays"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Number of days until the issued credential expires.","example":30}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer supports revocation of credentials from this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationMethod"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`status_list`, `status_list_2021`, `swiss_token_status_list_v1`]"} schema={{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List, `status_list_2021` uses the W3C Status List 2021, `swiss_token_status_list_v1` uses the Swiss profile.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]}}></SchemaItem><SchemaItem collapsible={false} name={"enforceCredentialUniqueness"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, each credential issued under this definition is unique per holder."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialReissuance"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, holders can request reissuance of expired or near-expiry credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. `cose_key` is valid only for the `mso_mdoc` format. The value is `null` when the record holds no binding method.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format identifier as defined in OID4VCI. Supported formats: `jwt_vc_json` (W3C VC JWT), `dc+sd-jwt` (IETF SD-JWT VC), `mso_mdoc` (ISO 18013-5 mDoc/mDL).","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]}}></SchemaItem><SchemaItem collapsible={false} name={"validationPath"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. The value is `$.vc` for `jwt_vc_json`, and `$` for `dc+sd-jwt` and `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential type strings as defined in the OID4VCI specification. These values appear in the `type` field of the issued W3C VC (JWT). The issuer omits this field when the record uses another credential format."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type identifier used when `credentialFormat` is `dc+sd-jwt`. Included in the `vct` claim of the issued IETF SD-JWT VC.","example":"urn:eu.europa.ec.eudi:pid:1"}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type identifier used when `credentialFormat` is `mso_mdoc`. Identifies the credential in the ISO 18013-5 mDoc/mDL format (e.g. `org.iso.18013.5.1.lpid`).","example":"eu.europa.ec.eudi.pid.1"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Namespace identifier for ISO 18013-5 mDoc/mDL credentials. The value is empty for an OpenID4VCI 1.0 credential definition, because the mDoc namespace is the first element of each claim path."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the external claims schema that the issuer used to build the claims of this record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. For `mso_mdoc`, the first element is the mDoc namespace.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><SchemaItem collapsible={false} name={"limitDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. Each path starts with `credentialSubject`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. The first element is `credentialSubject`.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialDefinition\": {\n    \"id\": \"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60\",\n    \"credentialDefinitionId\": \"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60\",\n    \"openIdOrganisationId\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"label\": \"Issue Portable Document A1\",\n    \"credentialDefinitions\": [\n      {\n        \"id\": \"string\",\n        \"credentialConfigurationId\": \"string\",\n        \"label\": \"string\",\n        \"expirationInDays\": 0,\n        \"supportRevocation\": true,\n        \"revocationMethod\": \"status_list\",\n        \"statusListCryptographicKeyFormat\": \"did:key\",\n        \"statusListCryptographicKeyIdentifier\": \"string\",\n        \"enforceCredentialUniqueness\": true,\n        \"supportCredentialReissuance\": true,\n        \"credentialBindingMethods\": [\n          \"did:key\"\n        ],\n        \"authorizationRequestType\": \"authorization_details\",\n        \"scope\": \"string\",\n        \"display\": {\n          \"name\": \"string\",\n          \"locale\": \"en-GB\",\n          \"description\": \"string\",\n          \"backgroundColor\": \"string\",\n          \"textColor\": \"string\",\n          \"logo\": {\n            \"uri\": \"string\",\n            \"altText\": \"string\"\n          },\n          \"backgroundImage\": {\n            \"uri\": \"string\"\n          }\n        },\n        \"credentialResponseInterval\": 0,\n        \"credentialFormat\": \"jwt_vc_json\",\n        \"validationPath\": \"string\",\n        \"type\": [\n          \"string\"\n        ],\n        \"vct\": \"string\",\n        \"doctype\": \"string\",\n        \"credentialDefinitionUri\": \"string\",\n        \"cryptographicKeyFormat\": \"did:key\",\n        \"cryptographicKeyIdentifier\": \"string\",\n        \"credentialCategory\": \"eaa\",\n        \"signingKeyCheck\": {\n          \"result\": \"fits\",\n          \"messages\": []\n        },\n        \"suggestedCredentialCategory\": null,\n        \"supportAttestationProof\": true,\n        \"supportJwtProof\": true,\n        \"keyAttestationsRequired\": {\n          \"attestation\": {\n            \"key_storage\": [\n              \"iso_18045_basic\"\n            ],\n            \"user_authentication\": [\n              \"iso_18045_basic\"\n            ]\n          },\n          \"jwt\": {\n            \"key_storage\": [\n              \"iso_18045_basic\"\n            ],\n            \"user_authentication\": [\n              \"iso_18045_basic\"\n            ]\n          }\n        },\n        \"claims\": {\n          \"claims\": [\n            {\n              \"path\": [\n                \"address\",\n                \"country\"\n              ],\n              \"mandatory\": true,\n              \"limitDisclosure\": true\n            }\n          ]\n        },\n        \"credentialDefinition\": {\n          \"claims\": [\n            {\n              \"path\": [\n                \"credentialSubject\",\n                \"identifier\"\n              ],\n              \"mandatory\": true\n            }\n          ]\n        }\n      }\n    ],\n    \"version\": \"version_01\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"enforceWUA\": true,\n    \"supportInteractiveAuthorisationEndpoint\": true,\n    \"systemManaged\": true,\n    \"extensionEnabled\": true,\n    \"display\": {\n      \"name\": \"Legal Person Identification Data\",\n      \"locale\": \"en-GB\",\n      \"description\": \"string\",\n      \"backgroundColor\": \"#FFFFFF\",\n      \"textColor\": \"#000000\",\n      \"logo\": {\n        \"uri\": \"string\",\n        \"altText\": \"string\"\n      },\n      \"backgroundImage\": {\n        \"uri\": \"string\"\n      }\n    },\n    \"expirationInDays\": 30,\n    \"supportRevocation\": true,\n    \"revocationMethod\": \"status_list\",\n    \"enforceCredentialUniqueness\": true,\n    \"supportCredentialReissuance\": true,\n    \"credentialBindingMethods\": [\n      \"did:key\"\n    ],\n    \"credentialFormat\": \"jwt_vc_json\",\n    \"validationPath\": \"string\",\n    \"type\": [\n      \"string\"\n    ],\n    \"vct\": \"urn:eu.europa.ec.eudi:pid:1\",\n    \"doctype\": \"eu.europa.ec.eudi.pid.1\",\n    \"namespace\": \"string\",\n    \"credentialDefinitionUri\": \"string\",\n    \"claims\": {\n      \"claims\": [\n        {\n          \"path\": [\n            \"address\",\n            \"country\"\n          ],\n          \"mandatory\": true,\n          \"limitDisclosure\": true\n        }\n      ]\n    },\n    \"credentialDefinition\": {\n      \"claims\": [\n        {\n          \"path\": [\n            \"credentialSubject\",\n            \"identifier\"\n          ],\n          \"mandatory\": true\n        }\n      ]\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the wallet is not deployed, or no credential definition matches `credentialDefinitionId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read issuance history
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-credential-history

---
id: config-read-digital-wallet-open-id-credential-history
title: "Read issuance history"
description: "Retrieves a credential exchange record by ID, including the issuance status, credential offer details, and holder information. The issuer reads the stored record and does not contact the issuance backend. A record that you deleted from the issuance history is still available through this operation."
sidebar_label: "Read issuance history"
hide_title: true
hide_table_of_contents: true
api: eJztPNtyGzeWv4Lql5FqScp2HCdhzc6uVlISxXas0sV+yKjcYPchCasb6ABoShyX/n3rHAB9b4m2PLMPs3mIRbKBc3DuN/TnKAWTaFFYoWQ0j87BagEbMIyzREMK0gqeMbhL1lyugGlIlE7ZYstOjydMyCQrUyFXzK6BCWNKLhNgxnJbmklzA7VcgmYpWC4yM2FcpmytshQ0E3KpdM4R/oxd+m1AMw08NbSvsUpDGkDj0lSBYVJZlihpeWLb4Bc8uQGZzthhWGPX3LKtKlkKGVhI2VKrvL1oLRDMlgnDjBVZxviGi4wvMmB2rVW5WjO7FoapArRDNppE1YfTNJpHiZJLsToHnh6LlbA8+8CzDOy7AuRpelTR4lcHKZpEBdc8BwvaRPM/Pnc4cSXFnyUwQauWAjRTS0L5AbZYzZMbZAdnRshVBuzd6fHL90enzUXVkTOxhGSbZIBHEQiz4HYdTSLJc8DzVGtOPJzTNJpEGv4shYY0mltdwiQyyRpyHs0/R3Zb4DpjtZCr6P7+Gh82hZIGDP7+4tkz/Kd9zpowFQ+0F8KUmTJJwJhlmWVIMGQ3SIub8KLIRELEP/hkcKfPDUwKjayxwsFNerSvkVWLT5DYaDKOVY/IKExEacOUrEkc6NqSYp7d8q3BE5VaGgYb0Fu2FJCluC8UlsVWc2l4goCPueUxyq17giCtOYo62/AMpSFsBSm7FXbNhDUM8sJu3QNzFv89+nsUs6XSKATEiQmLn4VvZJkvQE9YvOSZgfDtQqkMuCTdimWZZf4HyRx5mPvAteZbFJY2eUXaZ36XnqdfIMZIQGE8DdBKeDPAc/Bk4IbFRwPSGSNycMfzIkNcvuPPl8+SVy+mPy5/4tOX/PkP05/4Sz59sXy2fJ78lL7iz59H95NoaKvHj9RXUKTZw0eb1CqKD6Jc12qIlNlFcb/ukIPa/Oghj3gO2TThBhjPBDeI4wjpSewN6A1oZsAatlB27bhomFUdHs7YlQFnUh2jhWQSbpmQFlbOqJqvO6jSKy6Fqezyl4tmcwenhKTNpsPcGUEj6/7uyTDJSxyzW3IZLIUiU9scpHXwC63QDhIKwlRSRRik3PLDlQbAx78OOG7BeNjDgVypDaDJIoBt2+YZFizP7Rpk25mWphtApLAUUhBBhTQWeOqkvQ25Po+1WixKC+9RVkzjTGSDekeqnnfCZZgp0T+gpycD1zngghtIxw7lDeCXnYpcqIXcDLmWtrl03vUxJv2OmtJiTzjiBM0fQQbSmj4DiYxEiMfhEIGHAXl7JowP1WjbTOTCQnosTJIpU+omCO9GejA+ICljjBbiSUVS0CznN0Gia6AGMkis2EC2ZamDglHYLLq/b8Yefzg6hnNe46/CHFK4AOkOSJ3KFOMHMMhpuwZnun1QiloNadeYUxBLVBDmUt2A/FbgEtR6By7Yfdqfnci0UELamhUt1Q+i+ValO7D6NAhyrlKS5nRgWxafykuRQ8xy4LJr8tgtd8YARS/PIRXcIqM2grewb4RP4QgzFh/DErSGdGRvYVgBktKJsF9YMbghegdZ5igL0SRyaEeTKKyJrolCZxoOS7tWWuzGqEFhDfrf5tGZhqnf+x+II5L150zdzpjbxMVYbpfwnHMq1aNEUNx41vbR71DUHmfp5TDNaTW7Oj9lhuy5agqbVZig6U7StES8W/4WdUCk0xqnKcn//ODgv+rvPtJ3H0st/nNtbWHmBwe8EDOx0lzamVAHs9nQyQIPdwhAujkkBJXwNsufyjnOVuxtQPrQsUcaoogw7Or8DemAWzElY85t0ze0kb+gzHYI64YkeiGmVImn2+i6e6Yz581R0F2q3I+JZyz224wrywJwh0JDwTWkMxYTuPC8wKilkcWG4LSWgpBm0RnNLidzzEaZqj5oSEBsABNDiybro7MOUZNqg99hkt77CjOi7rc+Z49qc/cxBSlQwbuEfVOF0mN0rQNy7zmD9hRaWZWojBRhzuL6qDHb68lPUCtHzP1JeD5QI2Z7ns4m4RJdicKKhvvRxZj4PC5sUi1me1X1IwMKUjDtIi/D6EFc0SNszPY6aQKkZEIHrGZnA+JCjS1PbqS6zSBduYILiKK/wjGpuch90yBzZ41nYb0k1GHaKzr8ranhPldKuV85P9CokV8a5gSex26LjygsELOqHNOyIhT1CeL2Qsh0wJifw58lGFsZlZaL5t730KP+yR1xpsd8xhswR8jsxezZGApUm1hDyCNMiAZFSgHFkxE4PfaRSQ9ibXQ7DmcA/g6xypfDwbAY0+eVJNl1y1wM3ucEOuCvoEIXi1DXsWrlgjoqyuADLWgsUemAOBztFLbVPO/vGZQ9GPeRKINAF81AaDfQGODwas0gxEdjITo1WQhUXWLq44APqwXO7NWE97wmrbSKFSrLWng8HDGiM1cpHK1RPeRqFxK8PjpxB0/CokEtC/5kUC+7Kdv5z0fsh1ffveoj9BbsWu2Qww+hldPaCbHGh3Esvnjx/auY4GhIhYbEXmnx+P7n/mEKIrvn1bASxoLeUfCSTOxYmTiiJwdq3o7rfzEegwmz20Jg1rRlnB2fHqN7vTp/M2NnWm1ECilLSx2qbO2UyrPElRp2KV0eQwLSap6RYPeLJ94UEJHQ+gyWiUoD+kzsIPmXdTXY8XfP3n3EP/YrWj+oaokGDGAPmzaWamqghyqYd8yKHIzlecH2hGQGEiVTsx/KHw13FurfmLF4KK2E4fkP3z9z/+F5i/RfgEbGjcVsFvmROq+dCbT6oS/DjNIWy/SNSuMQ0q8I6RBfHLf9whPwhsHGy5oXrr7QS78bFfCnHeWfUabp1Qmroo0Zq9oEq+idRkcp6o9DVTOeplRa49lZo37mek79LLhB54JvM8VTnx850DN2hK1CIQ2LEVDseh2NzK4kuK7x8eG7I/b+iO399uGS1C7ndoImJt4kNj6IU5U098i4yI1beHpy+TO7OJ7+9uESNzhgpxfv2PMfnz3/bvo9y49VcpAfv/E7Gm+CAofe8qJAi/AkUlwEPrB6Y5a7nYcwrAlgZuyEJ2uGtm6LS6jWiWdj2BZEZ4vNpsa2BqwVctVh5Ru+gOxxO0ePDeRnjUKx0oOF6VZBmgKBDgbH1RZfVw0fxuZLYe/kZrH+gHVwyeDOgpY8+wrohQaMQMhKPOXsnDV3akIPZVeSoHQreS6SJqI+2u6j8yWtpj4jWuhUJtJg6URJlgl5g8m0wvr+KE6Ekgsf+r3nt2C5E7GFKm2X+aEWvEC7MRxS1GXTy35SoGS2padjLFXH3mTTkykseZlZn1UsYKk0NMNbKtA5m4v1CGpLXEnMzSX1OL9Fh6FPbwd8MLhKhSkyvmW4NdNgVLYJYxQ+KHRRHgahRNJ2LdHjPlzDv25p0M9kHL+oMOjsaaeiXXd34k+39uMm+YhjAjGSsmneZyxOk/8w6fTTraUf2wZyxuLcqI95qhL364A9n7Fz8tpVWITjMcB1JupCjmEJVnIy42pGRO4MVjzZho5VvKnQmLB4U1Q4kZNxR4g7Ne9qCf5d1H+nje8bh68+RZMonAqLaDWf6oVYEiyLQml7DhvlBi2+qs2hq+XUMZQYFtR5w3BgUK8ZL7h2pKHUGsWvAc2VAOcsfhdCKJ7FbG/DM5FitQnP5YpfBeicS5A22zIh6QFkIz50URqsw9JjFvJCaa5F57GHm6LD9ryaYPJEbiDe4XED+2gSeaSjSVRh5vSHtO/QGLQCaoc8o64qeMXlYS1DyS9CHrXYDiVgxL+wsLRrPGDAvo/NJWHyaOazLaoyUw8nqgJ0UttSy7kAu5xT4c7MFWIyd0un1dIpQp1/urXTBXANOh7C8D1oyiGe2Mj7ixmmJuYqGw+CwDsqXklhD63F/GE3prmBMobrWGMh2/twdbjfCoGd5+zyb8ISxGq5DX7McxNb8hRTCMNWIEshYRzNM3W2S+VIqSVy80yZ4LCDzo+cYhzik7kzRrcH+PIe1VvY5qjYyOgBfosn9bQsEcjGr/b5nHGDikLSbF4DAbTtRSBVUZPKIdUyZA9OGDyUILRjAz4obyNTcB8aR2qiPYJeZyzMnNwVztF/JduaIHEMDtx+vvofTOG32n0BIMkM31Qgnix4fFzY7ilUVmr5blnryOMsOdtdWr41O4YEtc+WJ9NsCMwA7Sr/+61qTDCswQQ6wCLYrXB1x4I2zca51kTDTLvaNsahEx9yUpkBA8v9EBr1eymJXD6tSHCEg8p+5tqn+HtxIpfxftNOtdxaUS4ykbAb2LLfPrwmU45/Y0cslAA+2R0SXvSGrg7bSD/24k9WxPsTpPzISGUvTnS08wmnUstdXdJ4cNPtCDcSjKqMn0KupLEYkMkVUaAW0hqXL493nMxXeHlM+hiwPZitXEYT79cAn6xzPnMNKtbhfVDIgfOmgLXp9MMj8cxXCOmx27mq5nU7AWM+vZNK+MbjDgGxG8A8UlJi36NqQJo1Tld0RKVRCuhM0NQg/QH+uVQYwbqJx7eLbcdI1AujqkI69e3PgZtdottfy5zLKQ6xUOlY0zJ2u942RdSPAoyV1ptVH++Xjtq2emiYtBtXhRsMo7FeoWEjVGkwExy2TCZM72+g5SB7SO2Czw6CM46rV9GAxUCl3NXtOvcQnliSb7SxqMK2UKVMqxGJwK+hWVYnZS/fnzHb3QSLpNL4m0K0jZulwUJb48pEQ1wy4HiZCat75OZF+0JFp3p77m+rnMhEb4un27B6n3q4xAy0U131tNdTb9l/h9kjs8p+R25ujJ98LjIuMKz1y3thIc9Wu3jtEzL+OZd85Xs/2UppYdd5Jyk/OTr+dXpy4bJskMlum/uLPQxqgo0BOHz+4sdfjt46AJ9ub57GoTMX1/x28e539gEW7DVsezIUZg08cn3XHGh7f1+NJV3q0tgL0BuRgO9J66dqVGks3a8QCYRQQYduaKsXPelUaPEXS8uxpdioiP8fYRmKEY9iidHlRqQlz76ugVCvRwxEIVwTqT/UTS7MjxQRZGyZgd4F6lt6shmzYmMiRAc9QNiuaHR72hhi63fYIp1KC3rTapSOpTpvhRR5mdNoDDVA/dJ20tO1NY/OzWD2wm2pcWwqL57QTuZpiq3FjTAC3Xy1L3Opmc93vFtNVVJWVxqqR4+U0qmQ7Tb9cHnmTBnfTXQi0QWn/AUKD4cVfAUTthIbkOiblqrUrBB3kLGkAjpYiwnsQOER8tT9+hIl6S58IM5uC6tWmhdrkbyGbS2zQ5KG1h1joWFdQ1vVH5W5CRZMGD+xrujQHbPl5ayNzXjv5WFM3LomiX161LHdqUjnN7CNqZd+9/2zn+LR9umF5IVZK/vUTLfYPtzW9aYeSwNNI+pnvzvtKoGF98HbgiP363q30UYujPVvcQ3fg2rdcelfQ+ncCOlff+hfMRgfzR+Ye6/GxNvTtw9NuQ6PnvYGQkfHM4dGJodmGftDht1Rv+FJu/ZcXGNYzU2H1ZNbzdGq5nzT0KxNa7RlaMajPzAxOsAwPl3wQOd/tAtf9cIHWq5DHb+BXly/2TTc8Blvsoz1Px5oODzWGRgs3ffrdK545mpVoXDULNp06ymPFDjq8kIv6++n3yNp8XieOpgsPpKuPBh/Phj2daKtRgj0YDzSCwyG3TTdz2vbcYqW18BTev/BZ/z00r0gYOdr/k3bDFor7U0B/X3c8ATXj41M1KuHAqyqQf6Shut62w/dmql66v/DMbUtSlvngFRF7mXsl92rx+jB3eDEpNWtc51jd0cYUioZS/XQeyFybpM1zhgMOSkaKujy4fm/MR+uJK+ma3uk+f7fWkRJ7TFv8ff8CUyHRhioQ1Jqap7+8Tk6LMRrwD+v8YUglq/wbSeRf0VKKOPuharP0T7e5SQbhiTJ/Tx8tAKiCL6gZB4dbF4cuLetHKRun6nTjQN3afHApJ9u7UEt7Qf+1SIHn4c04B6NFh1o6EUsx5Arf150/DqL5lG464j9gGnrwmN0P+lucKZVWroq1sg2j+1wYfmKbgsOLzfu5y4i1zUjLlAenRgFdtR5k/vCvwLGcbJ+CUxrsL/f/D47pYSjMwNCRarWvaG4tU/MHBiWY7q/oEm/pbgLLzWJHY4sZntSWfCVAS4onTUFT2B/wlwjpLXtnPmFf92qUiM5pjew/VvsAnl80VBQXZ6Q6kLOBRLSxz3/XROvOr/4pf6qTfUmwzpkqRaFCgjN0irUNgtM4L95NdjYfgEE5ksuZKAieMP1s+r+9p5P2vdpfmB44VlzdrLSrrP96qKj8TVUZKGbyjLe+zhiUsmLgokJFWzcS5uozI8j3k57G+PDrAwXWmXKdWqmdF7B8fJ6pm6NY20Yd+pOWU86c3cO2uD0dMPPVYPUGIQnIA3U44/RYcGTNeCIU491t7e3M04/z5ReHfi15uDN6dHJ7xcnU1yD8YqwWUsGiFihVBA0As2GY/uLZy9ezr6b0VtICmVszmUDH3wxVO99U12NaniW/38X1xe9i8tbMwt39oCK3nTtRlPFzLmNP6LNC/cSqaWgOl7LdfjUnHI+ch/dLK7m2Hww17/G8BrvNv4Rff6Mbxi50tn9PX79ZwmaHCBOLWjh6ijoZwRdkkijOb0p4AFR2Dv3YcQ++xe/F2yQrMFzyG31Ao45zireoGMZroTcX1fRPp3dPeru+TU26QVT980g4JeTS18QaPuvG/Jf/g/cfRDBritzKOD/0eMOLvkrKvxr2P6tetz9Mrqgcp/uaSTX9f39/f8C+ZZDBQ==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read issuance history</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/history/{credentialExchangeId}"}></MethodEndpoint>



Retrieves a credential exchange record by ID, including the issuance status, credential offer details, and holder information. The issuer reads the stored record and does not contact the issuance backend. A record that you deleted from the issuance history is still available through this operation.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential exchange record tracking a single OID4VCI credential issuance lifecycle.","in":"path","name":"credentialExchangeId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential history retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialHistory</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential exchange record that tracks one OID4VCI issuance. The issuer always returns every field except `transactionData`. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange record. This field holds the same value as `CredentialExchangeId`.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"CredentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential exchange record, tracking the full lifecycle of a single OID4VCI credential issuance.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Camel-case alias of `CredentialExchangeId`. The server sets both fields to the same value. Use this field in new integrations.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that issues the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that processes this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement that governs this issuance. The field is empty when the issuance uses a credential definition instead of a data agreement."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributeValues</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attribute values supplied for a data agreement based issuance. The field is `null` when the issuance uses a credential definition.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the data attribute, as defined in the data agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the data attribute for this holder."}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes this attribute selectively disclosable."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder opened the credential offer."}}></SchemaItem><SchemaItem collapsible={false} name={"isTokenAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder called the OID4VCI Token Endpoint for this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode used for this exchange. `InTime` means the credential was issued immediately via the OID4VCI Credential Endpoint. `Deferred` means the credential is pending via the Deferred Credential Endpoint.","enum":["","InTime","Deferred"]}}></SchemaItem><SchemaItem collapsible={false} name={"isPreAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuance used the OID4VCI Pre-Authorized Code Flow. When `false`, the Authorization Code Flow was used."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOffer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The OID4VCI Credential Offer URI sent to the holder to start the issuance flow.","example":"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/..."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential offer endpoint of the holder wallet. The issuer sends the Credential Offer to this URL for issuer-initiated issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `pending`, `ready`]"} schema={{"type":"string","enum":["","pending","ready"],"description":"Processing status of the credential. `pending` means the credential is being prepared. `ready` means it is available for the holder to retrieve."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Lifecycle status of the credential exchange in the OID4VCI protocol flow: `offer_sent` (Credential Offer sent to holder), `offer_received` (holder scanned or received the offer), `token_issued` (issuer released an access token), `credential_issued` (credential issued via Credential Endpoint), `credential_acked` (holder acknowledged receipt), `credential_accepted` (holder accepted credential), `credential_deleted` (holder deleted credential), `issuance_denied` (issuer denied issuance)."}}></SchemaItem><SchemaItem collapsible={false} name={"issuerState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the OID4VCI `issuer_state` parameter. The issuer uses it to bind the Authorization Request to this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the OAuth 2.0 Authorization Request that the wallet sent."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the ID Token Request that the issuer sent to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID Token Request that the issuer sent to the holder as a signed request object."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCodeState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value that the issuer returns together with the authorisation code."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorisation code issued for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorised code issued for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token that the holder uses to poll the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallenge"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge that the wallet sent in the Authorization Request, as defined in RFC 7636."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallengeMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge method, for example `S256`."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the wallet registered for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the holder's wallet, typically a DID or URL. Provided during the OID4VCI Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"did"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Decentralized Identifier of the issuer that signs the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was last modified. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDate"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the credential issuance happened for this exchange record. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes the data agreement attributes selectively disclosable in the issued credential."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>disclosureMapping</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialLabel"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label of the credential definition or data agreement that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of an external credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a presentation definition required for dynamic credential requests."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation exchange session linked to a dynamic credential request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata about the credential holder obtained during the OID4VCI exchange. The issuer returns only the `name` field. The default value before the holder starts the flow is `Unknown`.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder, typically a DID or display name resolved from wallet client metadata.","example":"Unknown"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format used for this issuance. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL. Records created by earlier releases can also hold the legacy values `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc`.","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"example":"dc+sd-jwt"}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether revocation is enabled for the issued credential."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status: `Operational` (valid), `Revoked` (permanently invalidated), `Suspended` (temporarily invalidated). The field is empty when the credential definition does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client assertion JWT provided by the holder's wallet for client authentication."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token, for example `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's client assertion JWT was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Wallet Unit Attestation (WUA) credential presented by the holder, certifying the wallet instance is genuine."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationPoP"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession for the Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the Wallet Unit Attestation was verified."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitValidity</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of wallet unit validity records containing attestation and proof of possession verification status.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wallet unit attestation verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isRevoked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has been revoked."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>proofOfPossession</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Proof of possession verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"validatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the wallet unit validity was validated."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed credential token (JWT, SD-JWT, or mDoc) issued to the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>cnf</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Confirmation claim (`cnf`) containing the holder's public key JWK for key binding.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Confirmation claim (`cnf`) containing the holder's public key JWK for key binding."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT Token Identifier (`jti`), unique identifier for the issued credential token."}}></SchemaItem><SchemaItem collapsible={false} name={"proof"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof JWT provided by the holder in the OID4VCI Credential Request, demonstrating key possession."}}></SchemaItem><SchemaItem collapsible={false} name={"proofType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the proof provided in the Credential Request (e.g. `jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"proofVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer verified the holder's proof of key possession."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedWalletUnitAttestation</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's Wallet Unit Attestation credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's Wallet Unit Attestation credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token shared by the holder during the issuance flow."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's OpenID Connect ID Token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's OpenID Connect ID Token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idTokenVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's OpenID Connect ID Token was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDeniedReason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable reason why the issuer denied the credential issuance request."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialResponseEncryption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."}}></SchemaItem><SchemaItem collapsible={false} name={"enc"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public JSON Web Key that the issuer uses to encrypt the Credential Response.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.","properties":{"alg":{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."},"enc":{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."},"jwk":{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the issuer, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the issuer, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holderTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the holder, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the holder, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual recipient the credential offer was sent to."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Mapper identifier linking the credential offer to an external individual record."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum polling interval (in seconds) for the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer adds a visible signature stamp to the issued document."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={true} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Position of the signature stamp on the document page, given as four pixel coordinates.","items":{"type":"integer"},"minItems":4,"maxItems":4}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `did:key` or `x509`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the credential definition at the time of the issuance.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the credential definition at the time of the issuance."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialHistory\": {\n    \"id\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"CredentialExchangeId\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"credentialExchangeId\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"organisationId\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"dataAgreementId\": \"string\",\n    \"dataAttributeValues\": [\n      {\n        \"name\": \"string\",\n        \"value\": \"string\",\n        \"limitedDisclosure\": true\n      }\n    ],\n    \"isAccessed\": true,\n    \"isTokenAccessed\": true,\n    \"issuanceMode\": \"\",\n    \"isPreAuthorised\": true,\n    \"credentialOffer\": \"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/...\",\n    \"credentialOfferEndpoint\": \"string\",\n    \"credentialStatus\": \"\",\n    \"status\": \"\",\n    \"issuerState\": \"string\",\n    \"authorisationRequestState\": \"string\",\n    \"idTokenRequestState\": \"string\",\n    \"idTokenRequest\": \"string\",\n    \"authorisationCodeState\": \"string\",\n    \"authorisationCode\": \"string\",\n    \"preAuthorisedCode\": \"string\",\n    \"acceptanceToken\": \"string\",\n    \"codeChallenge\": \"string\",\n    \"codeChallengeMethod\": \"string\",\n    \"redirectUri\": \"string\",\n    \"clientId\": \"string\",\n    \"did\": \"string\",\n    \"userPin\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"issuanceDate\": 1750000600,\n    \"limitedDisclosure\": true,\n    \"credential\": {},\n    \"disclosureMapping\": {},\n    \"credentialLabel\": \"string\",\n    \"credentialDefinitionId\": \"string\",\n    \"credentialDefinitionUri\": \"string\",\n    \"presentationDefinitionId\": \"string\",\n    \"presentationExchangeId\": \"string\",\n    \"holder\": {\n      \"name\": \"Unknown\"\n    },\n    \"credentialFormat\": \"dc+sd-jwt\",\n    \"supportRevocation\": true,\n    \"revocationStatus\": \"\",\n    \"clientAssertion\": \"string\",\n    \"clientAssertionType\": \"string\",\n    \"clientAssertionVerified\": true,\n    \"walletUnitAttestation\": \"string\",\n    \"walletUnitAttestationPoP\": \"string\",\n    \"walletUnitAttestationVerified\": true,\n    \"walletUnitValidity\": [\n      {\n        \"attestation\": {\n          \"isExpired\": true,\n          \"isRevoked\": true,\n          \"isVerified\": true\n        },\n        \"proofOfPossession\": {\n          \"isExpired\": true,\n          \"isVerified\": true\n        },\n        \"validatedAt\": 0\n      }\n    ],\n    \"credentialToken\": \"string\",\n    \"cnf\": {},\n    \"jti\": \"string\",\n    \"proof\": \"string\",\n    \"proofType\": \"string\",\n    \"proofVerified\": true,\n    \"decodedWalletUnitAttestation\": {},\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"idTokenVerified\": true,\n    \"issuanceDeniedReason\": \"string\",\n    \"expiredCredentialTokens\": [\n      \"string\"\n    ],\n    \"expiredCredentials\": [\n      {}\n    ],\n    \"transactionData\": {},\n    \"credentialResponseEncryption\": {\n      \"alg\": \"string\",\n      \"enc\": \"string\",\n      \"jwk\": {}\n    },\n    \"issuerTrustServiceProvider\": {},\n    \"holderTrustServiceProvider\": {},\n    \"individualId\": \"string\",\n    \"mapperId\": \"string\",\n    \"credentialResponseInterval\": 0,\n    \"signatureStamp\": true,\n    \"signatureCoordinate\": [\n      0\n    ],\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"string\",\n    \"credentialDefinitionSnapshot\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the wallet is not deployed, or no credential exchange record matches `credentialExchangeId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read credential definition logo image
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-credential-logo-image

---
id: config-read-digital-wallet-open-id-credential-logo-image
title: "Read credential definition logo image"
description: "Retrieves the logo image of an OID4VCI credential definition. This operation needs no authentication, because wallets read the image from the URL that the issuer publishes in the OID4VCI Credential Issuer Metadata. Anybody who knows the credential definition ID can read the image."
sidebar_label: "Read credential definition logo image"
hide_title: true
hide_table_of_contents: true
api: eJztV1Fv2zYQ/isHPiWAbKVpCgzCMCyzs8Jd1waJmzxkAUyLZ4mJRLIkZdcL9N+HI2XLce3tdcD2FEviHe++u/u+ywsTaCzm3KNg2YJXDhMm0OVWGi+1Yhm7QW8lLtGBLxEqXWiQNS8Q9AK4gs+T8cXdaAK5RYHKS16BwIVUksyHMC2lA23QcnoGhSgcKA288SUdz8P7BOaY88YhrHhVoXdgkYtwYbxrYXUdHr/cfARfch+/OdegBdPMK+lKdCBVeL+JadTHNIlHf0fPBfd8CJdqPddiDatSw7PSq5jewSxgMoacq72Yhn8olrBtahPBMpZrtZDFDXIxloX0vLoP6Xw2qCaij+ajLvSEfLCEGW55jR6tY9nDyx72X5T82iDIYLeQaAn043EGYJzBnM5+l9BC25r7BPzaYAJcCcgrLmsHztsm941FOrIFj8DlKschS5ikYAz3JUuY4jVSqlvH420AE8ESZvFrIy21k7cNJszlJdacZS+MLmYZc95KVbC2faTDzmjl0NH387Mz+vMagmmJ4NAu0YJF31gV87J81bXGfO3RUaMhzEZaeVR+MF0bnMHGOZTIBVoodSUczIJZ+mSwmFFuebShm/sv9HQs8IRFJFnG5lJxu2Zt2yYsXkKJ0NNFzGXHOTem6to9fXKU2+4VPWoPDK3VdqQFtUf4Pd5B5DHZhKPnT5h7aiFLXehlRLG37iOXymOBlvx947WpkGUXZ2ftAfcHst2asF+4AKlM42HbtZQ75fu6aJ/0kQ6tuc9pUGeH2ycU5DWQ7/7TQE6PznpsZqV3GDkBbcNwdPOSc6W072nLeW1RdOy1B3SbMId5Y6Vfs+yBsOEFMRLriAwik8FJ4DJiiFOWsMiqBGWNvtREgQUGJIkrMpYuz9PIiamIfgaR4FNtUEmROvG08mmf4aDPMH053CNtShnLjj5jqoe4c4y17pBgCWtsxTJWem9clqYCaz3gRg5lYbnyQ6lZm+w7uLZaNHkA+4ibf/Jw63khVXHM3MXP+4E89qW4pbaO3Xhp5G+43mkrHl905Bxr2dPzZeNLbeWfYUzYfltdXk/gGdd7KhxJdMmrBjc6M3vlZ7Zh0rpxHuYIxuJCfkMBK+lLmMUYYQYnSnsMDrzlsgoYGJ7jaQI4LIZ7bjPoDH9c68YSHINnXP80GzJqS6kWesMAPA8MgDWXBKRrjNHW/9yDt81fvu9fvUZ9t2B7sGyNwFi9lAIdcMg1Da0n1TcV1qh8XGU6hOI8BOW8QysXks8r3Nk8XFg9SEjhpJPW0yC+hw2vLbrtFdthuz6liLzOdeW6nYpKiIpsHGhbcNWB6cDruBglgSOi0i/phjV0Q7hDKQ4aF8rjuRLcCjcI+UquPCwqWotCaTukQ7T3b0dwN4KTD/fT0wQmV9Nf4XY8+HA/hbtRvG1y+xne/HD25u3gHdRjnaf1+OP3m4gjDqpkjsoFit10ruF5iXA+PPuudKvVasjD56G2RdrZuvTjZHT16fZqQDZtwrz01aseCGAJnTfb6rGEEW3Esp+fnV8M3w7fkK3Rztdc7cRD29wRDu6pd3/CdgTr/wX6bxfojs08fvOpqbhUVIVQ9pdORR7Y8jzuaQtJMvpaSeIOriStnkFN6OghPWEJy44urb2kPCas1M7TtS8vc+7wi63all5/bdB24rjkNoxrlB3p6PeR/592O+HkpltOTuHfstkfhH+jMIrkJegByxhL2DMJ0LHNv33cLsEBlnj4Ms/R+B03Ozt2u7s3vL+asrb9C408HAc=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read credential definition logo image</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/{credentialDefinitionId}/logoimage"}></MethodEndpoint>



Retrieves the logo image of an OID4VCI credential definition. This operation needs no authentication, because wallets read the image from the URL that the issuer publishes in the OID4VCI Credential Issuer Metadata. Anybody who knows the credential definition ID can read the image.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential definition that specifies the credential format, type, and claims structure for OID4VCI issuance.","in":"path","name":"credentialDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server returns the raw image bytes. The `Content-Type` response header holds `image/jpeg`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"image/jpeg"} value={"image/jpeg"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

No credential definition matches `credentialDefinitionId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The credential definition holds no logo image, or the server cannot read the stored image.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read credential revocation status
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-credential-revocation-status

---
id: config-read-digital-wallet-open-id-credential-revocation-status
title: "Read credential revocation status"
description: "Checks the current revocation status of a credential by querying the IETF Token Status List. The wallet reads the status list token of the issuer, updates the stored credential record, and returns the record."
sidebar_label: "Read credential revocation status"
hide_title: true
hide_table_of_contents: true
api: eJzlW1tz2ziy/isovqxdR5bvyca1tXU8tjNRkh2rYifercRlQkRLQkwCHACUrE35v281AJLgRbacmfNyNg+xRBGNRqPRl68bPyIGOlE8N1yK6CQ6m0Nyr4mZA0kKpUAYomAhE4q/E22oKTSRU0JJooCBMJymZLIivxegVlzM7MjRxfVbci3vQZArN+Ij12ZIrudAljRNAYlS5qbxNFOuDTF2jJzaH7jWBagBKXJGDZQvSwUsnFtBIhUbECoYUWAKJdyb7vkwGkQyB2XZH7HoJEqkmPLZJ6DsnM+4oemNZegyBzFiZxXdT9Wi3QqiQZRTRTMwoHR08vVHS26fBf+9AMLt8CkH1RGSZ50Ly95cpgzUX7SXB/LJkU5OzTwaRIJmgMxWw0csGkQKfi+4AhadGFXAINLJHDIanfyIzCrH97VRXMyix8dbfFnnUmjQ+PvB3h7+afLc2g4vttZmI2eJFAaEQQo0z1PuXtj9rpHMjy4bcvIdEoMiUyh8wx0T9WospTS9nFpJtke1NLK918TMqQmEWK7BClg3tIymS7rSlV7AAtSKTDmkbEhO3QdHbU41EZIsaIqbWI4ARpbczAk3mkCWm5V74YTE36JvUUymUhFKnNAHJN4rn4gim6DmxlOaaiifTqRMgQqrqbEo0tT/IIhbOXFfqFJ0NewIj7PuPrdF1auE9ii3ZYhS4tpLAMXojxfNwAuBahKH6hcPo8dBUyF/gh9ccIuhZ85FY9KLh2ROxQw2mXz0lBTAE3K7nyvJigRQF7gOXmvNbi3a8xOj/im6JO9vrgfk6nzH/pWKZOcy6bFwjHwBxaecTlIggbJT1MIE+AIYmSqZBTbxL5pYe3Vu5dk7XJOR1gUVCZCty9H50Zez0XZI/UKwXHLRFnDfIaaMcVwaTceBRjoL1Fz5OSSSASM5XaWSsnKZ/euzkhiSMykM5d5o51RpNO8p5ZmuV31zeEa+nJGt9zfX2wPnXZxcyZczK9rR1SXZ/+ve/uHOsRXzbnb+MdxHaxOcsnNdHr7lnKdg6XtrsaR40Lsq2pKRdwg9egCiyKKTrxE6nekU1J1Gq1l+KXczGkR27Xdu+6OQdu+zHARzEwQPaXLffo8mCeSm/ZRBCu4h9xpxx0BwYNFtx9R6j1+7+daxWXNIyWmPYxZSZTRNV968SAGOoAJvYvQwtDDlKmOSAfXqEFIDYJpkUmEMALke2H2CB5rlKRBKjKJC08Q6LlRCa0xJQlNUNEvMnwJyDlNQyGvfaWhwZEUc8lM5S38s0ZL7hbc0pkXH7UtIyruu8qfOeFRYaeagvKxIIjNo2gF7uFM+hWSVoAwEIwn6jzwHqgLtrmwd17iBuZIzBVpbrXbzI6UNjdtpNcCbsq1A8nfc2vHK3lReFPeKlXIveW946kLbCI9r3K5c4rbN4em9Qv5LouXDDXzSp4+lYm+mEWMFeIzXrKHlFK15fp6JYCI3hATeimqchwsIhTkk16ucJ/ZANRzBhGoguKgCLaeRRIGW6cJtfXeef4ChjBpqGc8VnBZmLhXXwM4kg+c5HyvYoW7Mv/G841GrtDI4r9bkNYUXihzJnNZkcG7yNpVLy1ahQY35Jp62fei3zMMdfkDVc6Hyy2ZOFFAD7DTUIy4MzED1BTcPxPAMtKFZTra4IBoSKZjeJss5iHYwUUavS2qf4jwY5XkTFp3svz7ec/9QBDbn+b9nJKXakEwy1Lxedl5ZdpxXehk3ZKvNRam1ZdzT9rLrZpc2N7tUMyq4rjK5nw6GfegkA3pki7lksDRHDPJUrjIQZtsnCD5G7saH8s/iq8HQM5P6I/KpSgirWX2W0Zn2BvcgxqgtHoQeKCu0DYAXnPX60fpIGYlOKMdoYqMT5REA5BF0O9B8i9FBr7kOgqhF8j+a7XxfYgy1yOvPLHj+fWnuFsmdzUXLb9EgyrS8y5hMukGOm7kUeuXLg/OxxgDHwVSxy+Lck5hQ1QxS0epk1OgBias1xPglr79YAtVKHI1maFtTse+WS4rRkVuYpS/qdWNaEa9LXgtheBoGMvdCLh0pP8o7BTTZG+tz4LlSLu4dBtQ0OEYSSkK6VUwyIHwaxFMaMwDjoBO2EjTjSR3qTFGnuFjIdIGT9GdA43CWLffO0Zfxtl0ab7vnNZDDOdd5SleECycXpEUnsjCdeNhDVN7nBonaes/bhLeegivsxvCF30c9cGCE20u3GdqZVm4w8hPSNJx/Vrn6EDn66rClQZR6nMfiOwtryVM5ky1h3LZxCIdMPacUpQTx7daCcSOquZ8l9LFEo7pEHNcvCfiqoMkOJTyjM/D8zOTPUcKRAaHGgGeFVH/rLO+xYS3PLGhZOBhT/7EkPdDMJCT7ct11TsoigqBdmtX0VFa372GFSXWKpzd0G6V6etvTTOjiRWINJpMJrhQ/NlLaKRd2ud4OM6duDqMyD61Qds0p70aPsfd18TapwV5iKLqxSjol/4GULl2wW6220EC0oPdAEozOJ5BQfGTmsCIZV6oVki65gobdrvJMZwfiH9+iFMTMzL9FJ2RvQL5FXOSFucskA3yEaCQ+DdZXPn6M6+jLxuQl1Nl29F3E0U25Qcj3m4U7UTeSOVU0cVIrQdpORDGnHqSt0FZETjfnsgoSj9CkV4LYwFPhu6h3c1nnBe0ZBmvdvygyUBy9vc2BNbExIyIb6WpIYgMPpv6Npvmc+hGBWBr76wBry4UTRSUzf740CKathjMJKA9DEqzPEG5aEnRO4SdkGHkeX2y8RkIbVTiqpSx9SGmXAQ95anG9OZ57SWbQrw5o65r+yetdY29bTgmRCx9xWtt1DobyNDSMFkXvohfhIMLcqI7YK9jCw13lOS3jWVdX6QcVS1GsTzMHETeQ9RrxJrOXOJ4cDPcI7WHb5fs4XcleKy7BmKmtzJ/enpE3h29e/Tm2qmMx3HqehZD6VoND2lYB8z7O7up1VQWTJ5ZsM3+bb4Ra3iHVzEbuGp7wbpNay5PlhaZj9Wq0cUjY4Hw8l0aGlckW53Ue2af+bVUrC4RPBAUBwT90MkojZ21Yhf6CLtHfHrHUqWLLJFjun96wtUK5dcRa5dznIbp11e8hiS/LijKqpMN0FzTlbEBirBsHqHEOKqMChEkxm7AvIa4zIPFVoRHxDlBhyHKpqOLNV3szucrQeyELrGw63+BxFcerLY5ULwcKWvkTXeS5VOEyh80cPFhrNIj88qJBVPFvrXEKM5qOOTs1BmGoDWN7HETGoLQUFQDqZb31cTw63ya0ptdEF5sdAh76XGAe2MJHLWdeqc2qVLqLz+cj4ir/BBKpV9pA5lKB7krGMt8EGJVyioyNpdagtV3EWI63K5dQsYRLC1c2cPiLb57wRw1r7kqmLjygWsuEozqQXPEFNdZ4N/h1OfBGUNBIMBQz2OzR1hieZM/GERMAQXSRJKD1tEAUeuEndHWEwkifev8MFlXmv4WRmG47mNsDBh0AzCk0JRk1ybxGAo6+jEnTtXhz4ur5DmKwzC5A6Y0U9It7sV0vqFxNrqSRiQx8cW8GxGBKi9TyETNFp+Zu/zAOj5ln6G5v3x6mRK1yI2eK5nOefIBV7WqeZ/kDrEJocSu+5yzeLleg+UygxErlac+0HpV7CkMLqJ5gLsZO7mEVo+mJH4733sQti+JfiAYR/mpXDA85mvraFViH8kcc2im+jwzmChZcFhqtqoOdG8AUTlO2gCywVmYZscLpMLUJPxsk5Ot5Zb5+7mcOOfUldVe1865RXwi7gU1d3vjQVT7dESPgqAHrS3FL36571dyBa6UJuuFmfq0KbbDr6w9wZtWrdfSprgwPoTNMMAzWeX00gG4AJ7bdZA4MwK9XoBY8gbFDuXsBwJc0ObiswSu/m0+7GUogXREQRq2cYlk75d2yXxkrlDX3Fa9+Ud4Dr2lXaPr8qSwEw/zO0nelCLR/mGU8f4Lr5MLCqpUB64mohySeKikMIrYC0tjVaidKLrVVH8YVJBbrntDkvvkWygXUjpE77hNWELJC9C/UxTabZFCBNQlZiwZRwEI3TfQO4SXSaaZePrew9daSz6bPadYTuXYxxmfBTX9otOGZaJ4CrgktoxckTQLaZOvm8+m2BQ0wvqNEwaxIqWp4pU/QTpe0rT/YEa7DD8F0IxFpwIUIWcdmmxQF4nDAHWdxu4VpUBdmvfc+G5HfgkHNOn9IbvNafy+9HiQ5pH61WQjjtobQqfHhU53uuIwppFm2oARTUhtJWTd3vVHWjG+VrLvBvgGjV7AVjjoBqkA5Z3w+lmMHkbJc5u+X989jEO+vLn8jNzAhGFdsvb/5gJV1H5iVAWvVDZQXk5QnGAZYHnA6MuG2q6eLFdB0tgFUkM6k4maeEcQeMduwlBGgsLUQM/eBcJgxX1wdHL9y0c1ik1aMIATCnudFCyAb73hy95vAAiin0XmVkVjbjD2iOSSoDl1unfR2vJx29qeHh/uHMH1D6Zsj+xf2jvb26Otkf/pqjyY7k+NjSOib4+TN0cHR8WQ62Z8cTQ4O4fXB5Pg1Ozi0nJrVZpxa1KUpvDMk8PD88H+SRErFuMBkpDzLF2ehEmz9QjW8OkJjCcJGNtvNyab087vz49PFq+loPL4q3l2t5MUy+bx/+s/94pc7xSf/ePVGvXs7ufrrKXK1waL+9SdwNTv6cPDrYm/JZ++y8fcb/vrgaKJO3/4+u3tI4YMxNw9vj4/T01+vr446QAVK3ikeChFZvm2/0sIqRs2vQYdrt/W00anZ05LY7efq6ZDq6Vfq6wSq23DCtpiwM2VNY0anI6LbrdDTCNCpO1fV2ifqYFWtZw0c3IP79EMVa9P+nvy6mezW2aSPNU9FMpfI9b3d6HWZTW960RvZr4+s10S3YRy4JgBaH5ncPnYaJj67He9vIi/Dt7gt6Zjoedld4PtJKzQxvHRQua/wHki3GoqnaA6UOZgTvx25Kw0b300IzyAgru01x34OSrFY8n76HkM9uq82VpenbPNSh3xfy0tle36hiK1imaoqQJar7zaZNxqGuMPzPA7ZgvtG5/h7IbDhQ1hQMNiGqnWAsmc2gty8DEockLi9/LhsaoIH4wtFiA9bbx4/QcqCCG0F2P8vVoDPom7D7Ijm+L/6bIyEASXwaonLOe00LRk9DiINSaE4hkpff0SnOf8A+NEaQENneMkr8lfEylyr6ic6244G0TsbuaFIXEkZQwewEsE7XCfR7uJg1wETu767cMeduF1XjdrV7PvS7NZHafdHGBY87tbav6NL7+WW1HcD7Rwy6VeMLlelGFwak+uT3V0GmdyhOR/ymaLCDLmMHgdtAmN7C8ZVOvrJPEfhytAZZgVrhmv3c5uR23orrlAjnSKVG1Ijbu6Bvyfn9rK+KdfIwrt5xHhkYz88MijfEH5w9UZv6OIGnZi4aVyT5AThHZjyh/JaWOx4JDHZEtI3RRpFeWplkNMEtgcEhrNhi+wJ8QP/tpKFQnHs3MPq77Gre2HTWXl4aWIPL2SUoyC9WfzfWnjV+vmv9aOm1MMNa4mlGlTiVtpiab7Hk+PfrGqma3bPvuziEaIRL+vXq7B17a+q4RaCwDHaOz4nTNt4ZP3TwLoW1yzpK0FlV28SsFdouz2GCkYV0zt2vZxik3qKAYvd2tIBIbdP3z7C2Z65flT2caILS3kCQkPdSRed5jSZA4JNna1bLpdDan8eSjXb9WP17sfR2cVvVxc7OAYxTm7Shg5YYTGZFNXuBXHqSXSwd3A0PBzu225PqU1GRcAPXo1txnqtAmj7dAV+5v/j9WFvfjBg2bUtLbb/Wtmrcs7Sf40WB+6W7JTblLRh7X2eZLMBa/HbadxJ55Zv2+zfDqK5RNzya/TjB174+KzSx0d8bOWGXmsQLaiyR8q5Bq7xM4tO7BXUJ3Zsq8zKtsmfcIe5V1ilARdova25jU4QusUiUOuO8+NtFefbdbhX3KWjYHAnmnkMvfCvF9c+8Wm6D1d08h+Ci8dNxtqexLGA/6PD6x3yNzxvH2D19+p198vaAZX3cm+jmG4fHx//AwUZcvU=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read credential revocation status</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/{credentialId}/revocation-status"}></MethodEndpoint>



Checks the current revocation status of a credential by querying the IETF Token Status List. The wallet reads the status list token of the issuer, updates the stored credential record, and returns the record.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a credential stored in the holder's wallet.","in":"path","name":"credentialId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet read the revocation status.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential record that the holder wallet stores. The wallet always returns every field. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request.","items":{"type":"string"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of previously issued credential tokens that have expired.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of decoded expired credential payloads.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": {\n    \"id\": \"string\",\n    \"credentialId\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"credentialToken\": \"string\",\n    \"credential\": {},\n    \"credentialStatus\": \"\",\n    \"acceptanceToken\": \"string\",\n    \"deferredEndpoint\": \"string\",\n    \"credentialIssuer\": \"string\",\n    \"preAuthorisedCode\": \"string\",\n    \"userPin\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"issuedAt\": 1750000600,\n    \"openIdOrganisationId\": \"string\",\n    \"organisationId\": \"string\",\n    \"userPinRequired\": true,\n    \"credentialFormat\": \"\",\n    \"presentationId\": \"string\",\n    \"issuer\": {\n      \"name\": \"string\",\n      \"location\": \"string\",\n      \"cover\": \"string\",\n      \"logo\": \"string\",\n      \"description\": \"string\"\n    },\n    \"credentialConfigurations\": {},\n    \"txCode\": {\n      \"length\": 4,\n      \"input_mode\": \"numeric\",\n      \"description\": \"string\"\n    },\n    \"authorizationDetails\": [\n      {\n        \"type\": \"openid_credential\",\n        \"credential_configuration_id\": \"PhotoIdCredential\",\n        \"credential_identifiers\": [\n          \"string\"\n        ]\n      }\n    ],\n    \"revocationStatus\": \"\",\n    \"legalPidAttestation\": \"string\",\n    \"legalPidAttestationPop\": \"string\",\n    \"legalPidVerified\": true,\n    \"autoPresent\": true,\n    \"version\": \"version_01\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"\",\n    \"expiredCredentialTokens\": [\n      \"string\"\n    ],\n    \"expiredCredentials\": [\n      {}\n    ],\n    \"requiresEncryption\": true,\n    \"isVerifiedWithTrustList\": true,\n    \"trustServiceProvider\": {},\n    \"oAuthFlow\": \"\",\n    \"authorizationRequest\": \"string\",\n    \"isWalletUnitAttestation\": true,\n    \"notificationId\": \"string\",\n    \"notificationEndpoint\": \"string\",\n    \"notificationSent\": true,\n    \"accessTokenType\": \"string\",\n    \"dpopJwk\": {\n      \"alg\": \"ES256\",\n      \"crv\": \"P-256\",\n      \"kid\": \"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23\",\n      \"kty\": \"EC\",\n      \"x\": \"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A\",\n      \"y\": \"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the credential ID is unknown, or the wallet cannot read the status list of the issuer. When the credential does not support revocation, `errorDescription` holds text that ends with `does not support revocation`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-credential

---
id: config-read-digital-wallet-open-id-credential
title: "Read credential"
description: "Retrieves a credential stored in the holder's wallet by its ID."
sidebar_label: "Read credential"
hide_title: true
hide_table_of_contents: true
api: eJzlW1tz2zqS/isovqxdK8v3ZOKamlof2zlRkjlWxU48W4nLhIiWhJgEeABQsibl/77VAEiCF9lyTmpfJg+xRBGNRqPRl68bPyIGOlE8N1yK6CT6BEZxWIAmlCQKGAjDaUq0kQoY4YKYOZC5TBmo/9JkSdMUDJmsCDeajM6H0SCSOSiK1EYsOokSKaZ89gkoO+czbmh6Y4dc5iBG7KyaIBpEOVU0AwNKRydff7TY+iz4nwUQbl+fclBETl/AIfLFkU5OzTwaRIJmgMxVw0csGkQK/iy4AhadGFXAINLJHDIanfyIzCrH97VRXMyix8dbfFnnUmjQ+PvB3h7+afJ8PYdSQFNZCGYZq6dEnhIpDAiDY2mepzyxgtv9rpHAjy4DcvIdEoPCUihmw930NVFLKU0vp1aG7VFN/mrpEwWJVMggNYH4Su6taPWQBAui6ZKuNFFgCiU0gQWoFZlySNmQnLoPjtqcaiIkWdAUt68cAYwsuZlbrYEsNyv3wgmJv0XfophMpSKUOHEPSLxXPhFFNgE1IPGUphrKpxMpU6CCUMFILIo09T8I4lZO3BeqFF0NO8LjrLvDbVH1ql9zO70MUUpcewmgGLV9T9MMvBCoJnGoePEwehw0VfEn+MEFtxh65kQ0Jr14SOZUzGCTyUdPSQE8Ibf7uZKsSAB1geuG7jdmv5b3IJ6fGPVP0SV5f3M9IFfnO/avVCQ7lwkxSKNkiGtdACNfQPEpp5MUSKDsFLUwAb4ARqZKZvUIFI+1TOdWnr3DNRlpXVCRANm6HJ0ffTkbbYfULwTLJRdtAfcdYsoYx6XRdBxopLM9zZWfQyIZMJLTVSopK5fZvz4riSE5k8JQLpz+5VRpYCRJKc90veqbwzPy5Yxsvb+53h6Q0cX1Wy9X8uXMinZ0dUn2/7a3f7hzbMW8m51/DPfR2gSn7FyXh2855ylY+t5aLCke9K6KtmR0ZagpdJ8egCiy6ORrhO5lOgV1p9Fqll/K3YwGkV37ndv+KKTd+ywHwdwEwUOa3Lffo0kCuWk/ZZCCe8i9RtwxEBxYdNsxtYVSINCS4gp7js2aQ0pOy1McvCukymiarrx5kQIcQQXexOhhaGHKVcYkA+rVIaQGwDTJpAKiDeR6YPcJHmiWp0AoMYoKTRNcCEEltMaUJDRFRbPE/Ckg5zAFhbz2nYYGR1bEIT9eT6pjiZbcL7ylMS06bl9CUt51lT91xqPCSjMH5WVFEplB0w7Yw53yKSSrBGUgGEnQf+Q5UBVod2XruMYNzJWcKdDaarWbHyltaNxOqwHelG0Fkr/j1o5X9qbyorhXrJR7yXvDUxcatDO/RpJc4rbN4em9Qv5LouXDDXzSp4+lYm+mEWMFeIzXrKHlFK15fp6JYCI3hATeimqchwsIhTkk16ucJ/ZANRzBhGoguKgCLaeRRIGW6cJtfXeef4KhjBpqGc8VnBZmLhXXwM4kg+c5HyvYoW7Mv/G841GrtDI4r9bkNYUXihzJnNZkcG7yNpVLy1ahQY35Jp62fei3zMMdfkDVc0Hyy2ZOFFAD7DTUIy4MzED1BTcPxPAMtKFZTra4IBoSKZjeJss5iHYwUUavS2qf4jwY5XkTFp3svz7ec/9QBDn7f2EkpdqQTDLUvF52Xll2nFd6GTdkq81FqbVl3NNNNPpnlzYLu1QzKriucrafDoZ96CQDemSLubSvNEcM8lSuMhBm2ycIPkbuxofyV/HVYOiZSf0R+VSlgtWsPsvoTHuDexBj1BYPQg+UFdoGwAvOev1ofaSMRCeUYzSx0Yki1qUQ5BF0O9B8i9FBr7kOgqhF8t+a7XxfYgy1yOvPLHj+fWnuFsmdzUXLb9EgyrS8y5hMukGOm7kUeuXLg/OxxgDHwVSxy+Lck5hQ1QxS0epk1OgBias1xPglr79YAtVKHI1maFtTse+WS4rRkSPvvVGvG9OKeF3yWgjD0zCQuRdy6Uj5Ud4poMneWJ8Dz5Vycc/FrGNwjCSUhHSrmGRA+DSIpzRmAMaBJmwlaMaTOtSZok5xsZDpAifpz4DG4Sxb7p2jL+NtuzTeds9rIIdzrvOUrggXTi5Ii05kYTrxsCU4KH1ukKit97yN5E89BVfYjeELv4964MAIt5duM7Qzrdxg5CekaTj/rHL1IWb01aFKgyiVDsax+M7CWvJUzmRLGLdtHMJhUs8pRSlBfLu1YNyIau5nCX30b/YQcVy/JOCrgiY7lPCMzsDzM5M/RwlHBoQaA54VUv2ts7zHhrU8s/Bk4QBL/deS9EAzk5Dsy3XXOSmLCIJ2aVbTU1ndvocVJtUpnt7QbZTq6W1PM6GLF4k1mEwmuFL82Ehpp1zY5Xo7zJy6OYzKPLRC2TWnvBs9xt7XxdukhnmJoejGKumU/AdSunTBbrXaQgPRgt4DSTA6n0BC8ZGZw4pkXKlWSLrkChp2u8oznR2If3yLUhAzM/8WnZC9AfkWcZEX5i6TDPARopH4NFhf+fgxrqMvG5OXUGfb0XcRRzflBiHfHxbuRN1I5lTRxEmtBGk7EcWcepC2QlsROd2cyypIPEKTXgliA0+F76LezWWdF7RnGKx1/6LIQHH09jYH1sTGjIhspKshiQ08mPo3muZz6kcEYmnsrwOsLRdOFJXM/PnSIJi2Gs4koDwMSeaQ3BNuWhJ0TuEnZBh5Hl9svEZCG1U4qqUsfUhplwEPeWpxvTmee0lm0K8OaOua/snrXWNvW04JkQsfcVrbdQ6G8jQ0jBZF76IX4SDC3KiO2CvYwsNd5Tkt41lXUekHFUtRrE8zBxE3kPUa8SazlzieHAz3CO1h2+X7OF3JXisuwZiprcyf3p6RN4dvXv0aW9WxGG49z0JIfavBIW2rgHkfZ3f1uqqCyRNLtpm/zTdCLe+QamYjdw1PeLdJreXJ8kLTsXo12jgkbHA+nksjGzXIJud1Htmn/m1VK0uDTwQFAcG/dDJKI2dtWIX+gi7R3x6x1KliyyRY7p/esLVCuXXEFj6QXI/e92Ph9UgPiw9JfFnWjlElHaa7oClnAxJ/goUMUOMcVEYFCJNiNmFfQlxnQOKrQiPiHaDCkOVSUcWbr/ZmcpWh90IWWNl0vsHjKo5XWxypXg4UtPInushzqcJlDps5eLDWaBD55UWDqOLfWuMUZjQdc3ZqDMJQG8b2OIiMQWkpKgDUy3rr43h0vk1oTa+JLgZaOaigzwXmgS181HLmldqsSqW7+Hw+Iq7GTyCReqUNZC4V6K5kLPNNgFEpp8jYWGoNWttFjOV4u3IJFUu4tHBlA4e/2MS5OmpYc1cydeEB1VomHNWB5IovqLHGu8Gvy4E3goJGgqGYwWaPtsbwJHs2jpgACKKLJAGtpwWi0As/oasjFEb61PtnsKgy/y2MxHTbwdweMOgAYE6hKcmoSeY1EnD0ZUyarsWbE1fPdxCDZXYBSm+koF/ci+16QeVqciWNTGTgi3szIAZTWqSWj5gpOjV3+4dxeMw8Q3d7+/YwJWqVGzlTNJ/z5AOsalfzPMsfYBVCi1vxPWfxdrkCzWcCJVYqT3um9ajcUxhaQPUEczF2cg+rGE1P/HC89yZuWRT/QjSI8Fe7YnjI0dTXrsA6lL/i0E7xfWQwV7DgstBoVR3s3ACmcJqyBWSBtTLLiBVOh6lN+NkgIV/PK/P1cz9zyKkvqbuqnXeN+kLYDWzq8saHrvLpjhgBRw1YX4pb+nbdq+YOXCtN0A0382tVaPOR658yB54zq16to091ZXgInWGCYbDO66MBdAM4MUm5R5zt1ytQC57A2KHcvQDgS5ocXNbgld/Np90MJZCuCAijVk6xrJ3ybtmvjBXKmvuKV78o74HXtCs0fb5r1hLS0XelCLR/mGU8f4Lr5MLCqpUB64mohySeKikMIrYC0tjVaidKLrVVH8YVJBbrntDkvvkWygXUjpE77hNWELJC9C/UxTabZFCBNQlZiwZRwEI3TfQO4SXSaaZePrew9daSz6bPadYTuXYxxmfBTX9otOGZaJ4Cjm2PPnpB0iSgTbZuPp9uW9AA4ztKFMyKlKqGV/oE7XRJ2/qDHeE6/BBMNxKRBlyIkHVstklRIA4H3HEWt1uYBnVh1nvvsxH5IxjUrPOH5Dav9ffS60GSQ+pXm4UwbmsInRofPtXpjsuYQpplC0owJbWRlHVz1xtlzfhWybob7BswegVb4agToAqUc8bnYzl2ECnLZf5+ef88BvH+6vIPcgMTgnHF1vubD1hZ94FZGbBW3UB5MUl5gmGA5QGnIxNuu3q6WAFNZxtABelMKm7mGUHsEbMNSxkBClsLMXMfCIcZ88XVwfErF90sNmnFCEIgkhRq0QLIxjue3P0msADKaXReZSTWNmOPaA4JqkOXWye9HS+nnf3p4eH+IUzfUPrmyP6FvaO9Pfo62Z++2qPJzuT4GBL65jh5c3RwdDyZTvYnR5ODQ3h9MDl+zQ4OLadmtRmnFnVpCu8MCTw8P/xfJJFSMS4wGSnP8sVZqARbv1ENr47QWIKwkc12c7Ip/fzu/Ph08Wo6Go+vindXK3mxTD7vn/5rv/jtTvHJP1+9Ue/eTq7+dopcbbCo//0FXM2OPhz8vthb8tm7bPz9hr8+OJqo07d/zu4eUvhgzM3D2+Pj9PT366ujDlCBkneKh0JElm/br7SwilHza9Dh2m09bXRq9rQkdvu5ejqkevqV+jqB6jacsC0m7ExZ05jR6Yjodiv0NAJ06s5VtfaJOlhV61kDB/fgPv1Qxdq0vye/bia7dTbpY81Tkcwlcn1vN3pdZtObXvRG9usj6zXRbRgHrgmA1kcmt4/drtD1Dfje6dk+FVu0RGWfA2UOjcRvR+7OwcZXCMKjAgg/+w22n4OKKVamn75uUI/uK2HVVSTbY9Qh39eZUpmI3yhCoFhNquqE5eq7veCNvh7uYDcL75FuM/zoHN8oBHZmiCF55woq1V0VF6XRVEsXqi0oT22k5m8iUMEm8qExI9q29o7s/wfvyGdRty92RHP8H62sI2FACbyS4XI1O01LRo+DSENSKI4hxtcf0WnOPwB+tIbD0Blei4r8JaoyR6n6cM62o0HklBpF4kqx6HLBSgRvPZ1Eu4uDXZfQ7/quvB1nZ3ZdFWdXs+9Ls1ufmt0foTt9jJBFXEDfDa1zyKRfHzomlWIIZkyuT3Z3GWRyh+Z8yGeKCjPkMnoctAmM7V0RVw/oJ/MchStDZxg7rxmu3c9tRm5rwV+h/jm1KcVf41Lugb9H5nauvknWyFW70fZ4ZCMkPCAozTBJd1U5n3/EDToxcdO4VsIJgiAw5Q/l5anY8UhisiWkbx00ivLUyiCnCWwPCAxnwxbZE+IH/n0lC4Xi2LmH1T9iVx3C1qzyqNLEHlXIKEdB+pLG/9TCq9bPf68fNaUeblhLLNWgEt2xlw7LTkiOf7Oq5azZY/qy6zmYs7+sq61CoLW/0IVbCALHaO8F/u0dB+byGFANrLd2LYW+XlL2viYBe4W222OoYFQxvWPXyym2cqfYNGi3tiweIbdP39HB2Z65pFN2O6LDSnkCQkPdbxad5jSZA0Iyna1bLpdDan8eSjXb9WP17sfR2cUfVxc7OAaRQG7Shg5YYTGZFNXuBdHcSXSwd3A0PBzu255IqU1GRcAPXhUljWi81T1R+ZBfcFfVn23sMNm1XRW2BVjZ21rOaH6NFgfuouaU26yoYTh9qG4DUms825nESSMfuR1Ec4kw2dfoxw+8X/BZpY+P+PjPApQ19oNoQZXVTWdjucbPLDqxNx6fEMZWmQRsk19wWbZXMKUlFGgGrd2KThApxJpD6zLt420Vr9p1uFfcHZdgcCcIeAyd1+8X1z7ObtphV+PwH4J7rk3G2ibZsYD/o+foHfJ3VNwPsPpH9br7Ze2Ayg24t1FMt4+Pj/8HOjSewg==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read credential</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/{credentialId}"}></MethodEndpoint>



Retrieves a credential stored in the holder's wallet by its ID.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a credential stored in the holder's wallet.","in":"path","name":"credentialId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet found the credential.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential record that the holder wallet stores. The wallet always returns every field. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request.","items":{"type":"string"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of previously issued credential tokens that have expired.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of decoded expired credential payloads.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": {\n    \"id\": \"string\",\n    \"credentialId\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"credentialToken\": \"string\",\n    \"credential\": {},\n    \"credentialStatus\": \"\",\n    \"acceptanceToken\": \"string\",\n    \"deferredEndpoint\": \"string\",\n    \"credentialIssuer\": \"string\",\n    \"preAuthorisedCode\": \"string\",\n    \"userPin\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"issuedAt\": 1750000600,\n    \"openIdOrganisationId\": \"string\",\n    \"organisationId\": \"string\",\n    \"userPinRequired\": true,\n    \"credentialFormat\": \"\",\n    \"presentationId\": \"string\",\n    \"issuer\": {\n      \"name\": \"string\",\n      \"location\": \"string\",\n      \"cover\": \"string\",\n      \"logo\": \"string\",\n      \"description\": \"string\"\n    },\n    \"credentialConfigurations\": {},\n    \"txCode\": {\n      \"length\": 4,\n      \"input_mode\": \"numeric\",\n      \"description\": \"string\"\n    },\n    \"authorizationDetails\": [\n      {\n        \"type\": \"openid_credential\",\n        \"credential_configuration_id\": \"PhotoIdCredential\",\n        \"credential_identifiers\": [\n          \"string\"\n        ]\n      }\n    ],\n    \"revocationStatus\": \"\",\n    \"legalPidAttestation\": \"string\",\n    \"legalPidAttestationPop\": \"string\",\n    \"legalPidVerified\": true,\n    \"autoPresent\": true,\n    \"version\": \"version_01\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"\",\n    \"expiredCredentialTokens\": [\n      \"string\"\n    ],\n    \"expiredCredentials\": [\n      {}\n    ],\n    \"requiresEncryption\": true,\n    \"isVerifiedWithTrustList\": true,\n    \"trustServiceProvider\": {},\n    \"oAuthFlow\": \"\",\n    \"authorizationRequest\": \"string\",\n    \"isWalletUnitAttestation\": true,\n    \"notificationId\": \"string\",\n    \"notificationEndpoint\": \"string\",\n    \"notificationSent\": true,\n    \"accessTokenType\": \"string\",\n    \"dpopJwk\": {\n      \"alg\": \"ES256\",\n      \"crv\": \"P-256\",\n      \"kid\": \"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23\",\n      \"kty\": \"EC\",\n      \"x\": \"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A\",\n      \"y\": \"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid or the credential ID is unknown. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-global-configuration

---
id: config-read-digital-wallet-open-id-global-configuration
title: "Read global configuration"
description: "Reads the global configuration of the OID4VCI issuer. An organisation has one issuer global configuration. The wallet makes it with the default values when the organisation wallet is deployed, so you do not create it. The organisation must have a deployed digital wallet."
sidebar_label: "Read global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztGtty27j1V86wD2vPSLJly/FG3dmpYyepNjdP7CQPWU8EEYcSYhJgANCyNuPv6X/0yzoHACmSoi9Jd2fabvPgSCJx7veDrxFHE2uRW6FkNI7eIuMG7AJhnqoZSyFWMhHzQjN6AVTinr2ZnIzeH09AGFOgHsCRBKXnTArjX1swA0pieN4JagDnC4QlS1O0kLFLNCAsLIVdOAwcE1akFq5YWqCB5QKl+72BJpwWBjjmqVoh74FRsFIFcAVSWYg1MosgrEfXOJ0VxsKCXSGw6jxwMReWpQH04Ff5q6SDGk2upEFgqVEwF1doYGrQWiHnL0UmrJmOHX26SBG2TEbHTSC/BynT89rXkjkmORRS2G2SK7J4AbLIUIsYAugBvDNEPVgF8QLjS2AeBswwURodq0XOiUfC3pRw1ItUjv7LhEfjyD8mFZ94Nj84Lt/kKCf8uVPScR1C1ItKxk00/hrt7e7Sf02LIfEY1FeoQaMttPTmc4fqHd+VsG5jPeoRvRalJZwsz1MRu+M7nw0h/hqZeIEZo0+5Jkat8GTOOzjpJPsuGoOl1y2GSLKrHKNxpGafMbZRr4VZcPob3jFWCzmPehseFivNQXCUViQCdYnqdi8h8YoYg5vYhTDBCpxbCAuGXaEXu3bQBzCxzgnpJ8MyDO8zA9MO6Uz4lHjDa5blKZH+6NFBsjf7MX7MhnyEu7vDPTbbH8U8uul1SXfyALbfSfGlwA6274wR3xFYXAjwomDcu5h3kMoXTBkdCoM1aTZFMDvkw2TE9vo/xvvYH7HHw/7j5GCvv8v340d4yIaz0QGJQznneVMj8iHSmGyIwTnhSRnSfDzKUFqwC2ZhoVIeNN/y8ZteFGt04Fj69DoXQSXyhK1MjRBZZDPUG4SchFCE1UnIUQvFYUtI4GxltiFRGliawhqP8Qqg6MVRd9EFE8nFleAFq5+jyCek8EqImQR1hVoL3lBDw+QLgwb2d9cJQOOXgkJpiMG7U1AaUqwcIBGYclCFbahzf7chpyeaSU56Wcun8uhu+XBh8pStYO3vpeJq3MWMHLvKS+8mpskMS5dsZWphUhjweAcboUSyDO+3ozZ5dMrpq6GrOkU9CgImx5isz1FbT+jHa2Ym3sVeoWWcWeYsLVUxSx9A1pPj09EhpEzOCzZHsGzuiHKJfVOQWziYD2CKsv/8yXS7KTJFudVLymu2DHneI6QqffemRcNDJbcoMib7FCvYLKW6o3ppQ46BdGzrmHDPWHw516qQ/FilSn8DfryGmI5ArDhWYmpb1Rp+Ka6/PHP/ptvNuBV+JposXtvfgRq8tqBkJ1UlKbvu3wYp/mdvOHN1v7O9VHPl452XrgGzUMtbkDftxNDb00KLqQv5Yi6VDhHBpz7RDB8zxVebTldo8YBM9vZl6ftlIUfs1cxDyTax5q6w4Gh3Jk6grdosdAl+zzNmIV4wOQ+81Q40yxdHEUssamASijxVjJdvumciI8+scqIzYpbac7y294vgKLXeLkpzXYPsUcjmPmfEMRojZiIVdjWIbm6onPxSCI08Gn90wl7jvGg40YRA3W8wT9Ze4fn5bzSeWZuJZtzx9tMtvov2jy5rNHFuxqZ6ZAiuuSn7i0bCfOs5fypjvXJg31ZIK45nSqXI5AbLHyhiT60ucNpzjJdNH/Vf6CHWSyBi/z1qkQgXkY9rEZhyEpMxwlZIWNv1jBWIhMIIOa/Vlj+YEg15xiWuvLEXdqG0+I2V7BB/VAWtajwJaXHeUTadiwz7VvVTcYWuUjIYK8lDsVTPqEd1NCWJAzhyrumc3tdbvbaZqiRB7esyNK1iplXNCFfMvEK7ULxe8zGt2erWWO8kouaa5QsRk1hg5gFB5iF5b6rV6HkxS4VZoPmGssE5WiqMLasfKuGnsTL46RJXUx/VqO1XhQUGxiqNvHQ719tPueBj/+708/LS++gagut1hAEGFrM8pUqfdCBxeUvhOfb9ZudDuETMveeXQlAJUAmSKJ0xV6cJi5np8nSURUZOGOiNetHn5aVrYz2pzqcqLd7zXt33fAs+kRb1FUvvL+pfCSmyIoNcpSnpU4ST3ZYa3NEVVmvXKVV7gglqUklNx08lz5WQzRL74KYXSUVNjW/Ty5eeSnJjfn8wP1uopZMzLBciXlQUhGLVQ4Ur1Ma1D512ST++rhGxJvUBVeVmFm0Xme2QzzVL7Kfh/vdEwYfT7mUSkprzSWpcS/E4GmC470tgT9DBfwBBB3WCDv8DCDqkHHrTizzYMkA9wC7FXJJXhMGUaQ9B7wt+v7fRGTGXyEscm+7178n3dm6ocWTgscMvH87D7KGWRF7gaj3Y6IqQskhTIjcaExltAl/gqmM+RInJqZQw30fjQyQeOMhKtqgJT5JObp65oP/tnPhzJQcmGNAlrnrOUkPMhOml4FVWUxqm1we7j6dNHrhC40fZbv5bH1e1i79uw6Bk4ivxc3WJ8qVI0IoMJ/LMJ4IHVDt/V0tIlZxTK+FBgSVYnkFhSkvypAnemO3PySeZy8c0uXMTflKLxkSjWXhIHfVNoz47Vhx9cfYtdJ/5cIBg7y3XGth887v19tkxPDocPYZ//mM0GA72tjvKtuC/HMtKzVUnNNqSyskMNczooe/aQmN0K9M8V/nDPfp8TXhoFMMg3hR5rrQ1cHKqTj0jj0ejx9vjsrLxlk9lmQHC+SnY6CeWzj/5ncunAAR5Na9v6F4YmLmmJXSV5KfB4L3mfwjoc61UMoA3SQKzVdn1DMCFI5UkPhZ5mFjGc2dQBp4g0yRvekhNc6GdIwlyrcTvYvwojb6GlsQhbYg2YanBINxv6FtehWk71tioyRIyJjmzSq8gVMlXw8Fui5Fx+B46R1OrdD08pqmtpLyDfACvEbkBbwAO618dfyXPssGyrL84gCPakJD92bpBN+yiByLLkAtmMV11ikgqGf+xjhZ/cjjKAXIwnhArAu1OZjv+PawKuG7fC2/VnK/dYpZdOwMfcCgKhfUZTVOYJFVceQPOlTE0s1BdzumXifzI3l+Bv5Pi2gnDWJblTUmEtN8emcOSmbCv5A3kw8PR4e5w+MjR4HcZfygNKTMWMsXdgPg2SlqpR/Dots3QLSuSO9cWnbP6h80j7mzs7+ia7+y46rqv64Bya2ML3L1nvGvP+aA12HmIr8J7mZvyl8WFB9MqLLr8eNq1v2Scu8aXpaeNIvPukrjOFLnT9/IU3FQtfWFnPFSzWfNmvqN9yGSGZNJYv6/HGO1FoEtouW1OV4Y3vShj19+ArrHd/0Zs+96tQ1bsRHh3qXleDSnb0xq3Oqt6jFI1wleTBi1sTQk0bVz8h82XaVYjVZWzN0Mi3V64f+hJNNKbpV2EaxANizU1I12vEMKvVJv/hlpNzGtlz9B+T7fjhUQLQ9HVdbnMmiGTtbHXpsw6kmYrEpaWujaiIKWLm/arXfcU2vHkou2yDsoCGUdNnkHfRv5axoNvS9RpQK2VpuqaGKPPJzUpbiBvu+X6dJfhVoIaOVvZAN81Qqs0/4TRmi0vLORMswwtauL9pr3nizbu9QgDhbyUakl3Bzp260Gb5ZUfUmlbnsM/sTzfyTKBumzaFs3oTyya510XhciWEmqEOm60bYaZcn3trc/cdqctXGIRBhwrEKuMbhzIdFUGaRqIWMwhYSJFj5sKWhevw623KvOMiQjLYls2hps2f/CnjiGu0JMsLftnh6YlI1fqxYUWdhWNP36NjnLxAunjxQ3xyOaGZBEu1oG/WQdbPvSM3h9vR73ID6tIJH65EI2jOTqJMLuIxtHO1d6ON5edcA+x781hh0powXd8Zt/xiaMfb2QOIt446torn0wF3igd6TQaRwtrczPe2eGYqT7LxUDMNZN2IFR002sDONWKF3GtldwAcx+EM8vmforaedz4x21CLtZCPyPb8yZTin696PI/9CJBqLzWqHJyd2iixgpuc5d9OnG1NUU9Kv/jWn3qa4ZQtUwbcKbg0fgec4aQa0zENfplFkw9jTCFLanC7UyrmXD7GJOzGLd74G9PNMCOIRz8aaUKTeLoX+Lq56mf9gmZqNJNWezcFDMmSJDBs/+2Fl7Fv3i+/qkp9brCWmKpDrnuWHBqrikM5SnShVr6n66nNa8Ff88Cl1r27oOnGk2FovKk022iyKpYpe4ehTBAKkQ3CzEhmP4WLvpZ5avhnpuq+2XjFWFYVTd96zd8/PrLWJrsaG76jl/BaMGQ0nLKqTZI2lH7Yf8Y3h/D1i8fzrd7MHl6/gzOTvq/fDiH98ce2+TsDQx/3B3u9w8gO1HxTnbysr579HtF1xSkIkZpcH37KzrKWbxA2BvsbqhuuVwOmHs8UHq+E86anZeT46evz5726QzdARI2bdiAExZXcVFpL+pFYakWjaO93b3RYH8wpLO5MjZjskYPXR3ubOfaXlXLJP+/Uv6/daU8hFy6QrKTp0xIMhVnm19DHvsYXe3529uJcM1gI5eFgZCbGHllVqOjVka76EULZSwB/Pp1xgy+0+nNDf38pUDtUm8vumJa+O7440XVGbkUSJv0cXTkmm6ycWLS5YpWXXNTz8fPn56HEVIzvfg9ffhA0MtHclWD3c40ngT6Swmx88hP5I8vcPVz9bp/cuuBKrv5t0n+1Fr+C24rl+w=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read global configuration</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/issuer/global-configuration"}></MethodEndpoint>



Reads the global configuration of the OID4VCI issuer. An organisation has one issuer global configuration. The wallet makes it with the default values when the organisation wallet is deployed, so you do not create it. The organisation must have a deployed digital wallet.

The response also gives `settingLimits`: the rule (smallest value, largest value, default and unit) of each numeric setting. Use it to check a value before you update the configuration.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server returns the issuer global configuration and the rule of each numeric setting.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>globalConfiguration</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The issuer global configuration of the organisation.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Record identifier of the global configuration. The service makes this value when it saves the record. It has the same value as `globalConfigurationId`.","example":"665f2b8c9a1d4e0012ab34cd"}}></SchemaItem><SchemaItem collapsible={false} name={"globalConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the issuer global configuration. An organisation has one issuer global configuration, so the read and update operations do not use this value.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that holds this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExpirationInDays"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Default expiration period (in days) for all credentials issued under this configuration. Individual credential definitions can override this value. The service uses 30 when the request gives `0` or leaves the field out.","example":30}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialBranding</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Default display properties of the credential card in wallet UIs. The service always returns this object.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default display name for credentials in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties (e.g. `en-GB`). The service omits this field when it holds no value."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default human-readable description for credentials displayed in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default hex color code for the credential card background (e.g. `#FFFFFF`).","example":"#FFFFFF"}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default hex color code for text on the credential card (e.g. `#000000`).","example":"#000000"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo that wallets show on the credential card. The service sets `uri` and ignores the value in the request body.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the default logo displayed on credential cards in wallet UIs. The service sets this URL to the organisation logo, and it changes the URL to the configuration logo after an upload to the logo image operation."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alt text for the logo image, used for accessibility."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image that wallets show on the credential card. The service sets `uri` and ignores the value in the request body.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the default background image for credential cards."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialRequestEncryptionRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet must encrypt the OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Request using the issuer's encryption key."}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequestExpiry"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Time-to-live (in seconds) for the OID4VCI Authorization Request. After this period, the credential offer expires.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Default cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. The list always has `cose_key`, and without a stored value it is `did:key`, `jwk` and `cose_key`. It is a template for new credential definitions: each credential definition keeps the methods of its format.","items":{"type":"string","enum":["did:key","jwk","cose_key"]},"example":["did:key","jwk","cose_key"]}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint.","example":5}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>notificationEndpointEnabled</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shows for which OID4VCI specification versions the issuer publishes the Notification Endpoint. The service omits this field when the configuration holds no value.

</div><SchemaItem collapsible={false} name={"draft_13"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 13."}}></SchemaItem><SchemaItem collapsible={false} name={"draft_15"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 15."}}></SchemaItem><SchemaItem collapsible={false} name={"draft_17"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 17."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerMetadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signing settings of the OID4VCI Credential Issuer Metadata. The service omits this field when the configuration holds no value.

</div><SchemaItem collapsible={false} name={"signedMetadataEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Credential Issuer Metadata as a signed JWT."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that signs the Credential Issuer Metadata. The service omits this field when signed metadata is off."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `kid`, `jwk` or `x509`. The service does not check this value."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"accessTokenLifetimeInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"How long an access token of this issuer is valid. The wallet gets a new one with its refresh token.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationCodeExpiryInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Sets the time-to-live (in seconds) for the authorization code (RFC 6749 §4.1.2). After this period the code expires and can no longer be exchanged for a token.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"dpopEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The authorisation server supports DPoP (RFC 9449): the metadata lists dpop_signing_alg_values_supported and the access token is bound to the key of the wallet's DPoP proof. Off by default. When off, the token endpoint issues Bearer tokens. Turning it off also turns off Require DPoP.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"dpopRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Makes the DPoP proof (RFC 9449) mandatory at the v1.0 token endpoint: token requests without a proof are rejected. Needs Enable DPoP; turning it on also turns on Enable DPoP. Applies at the authorisation server, immediately.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"nonceExpiryInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Sets the time-to-live (in seconds) for the c_nonce issued to the wallet at the token/nonce endpoint. After this period the nonce expires and the wallet must request a fresh one before it can prove key possession.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this configuration was created.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this configuration was last modified.","example":1747011600}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>settingLimits</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The rule of each numeric setting of the issuer global configuration. The key is the name of the setting, for example `nonceExpiryInSeconds`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The rule of one numeric setting of the issuer global configuration. The wallet owns these rules.

</div><SchemaItem collapsible={false} name={"minimum"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The smallest value that the update operation accepts.","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"maximum"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The largest value that the update operation accepts.","example":3600}}></SchemaItem><SchemaItem collapsible={false} name={"default"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","nullable":true,"description":"The value that the issuer uses when the setting is not set (`null`). `null` when the setting has no default.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"unit"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unit of the value, for example `seconds`.","example":"seconds"}}></SchemaItem><SchemaItem collapsible={false} name={"zeroIsNotSet"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the value `0` in the configuration also means that the setting is not set.","example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"globalConfiguration\": {\n    \"id\": \"665f2b8c9a1d4e0012ab34cd\",\n    \"globalConfigurationId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"openIdOrganisationId\": \"string\",\n    \"credentialExpirationInDays\": 30,\n    \"credentialBranding\": {\n      \"name\": \"string\",\n      \"locale\": \"string\",\n      \"description\": \"string\",\n      \"backgroundColor\": \"#FFFFFF\",\n      \"textColor\": \"#000000\",\n      \"logo\": {\n        \"uri\": \"string\",\n        \"altText\": \"string\"\n      },\n      \"backgroundImage\": {\n        \"uri\": \"string\"\n      }\n    },\n    \"credentialRequestEncryptionRequired\": true,\n    \"authorizationRequestExpiry\": 300,\n    \"credentialBindingMethods\": [\n      \"did:key\",\n      \"jwk\",\n      \"cose_key\"\n    ],\n    \"credentialResponseInterval\": 5,\n    \"notificationEndpointEnabled\": {\n      \"draft_13\": true,\n      \"draft_15\": true,\n      \"draft_17\": true\n    },\n    \"issuerMetadata\": {\n      \"signedMetadataEnabled\": true,\n      \"cryptographicKeyIdentifier\": \"string\",\n      \"cryptographicKeyFormat\": \"string\"\n    },\n    \"accessTokenLifetimeInSeconds\": 300,\n    \"authorizationCodeExpiryInSeconds\": 300,\n    \"dpopEnabled\": false,\n    \"dpopRequired\": false,\n    \"nonceExpiryInSeconds\": 300,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  },\n  \"settingLimits\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown or the OpenID wallet is not deployed.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Global configuration not found. The wallet makes the configuration when it deploys the organisation wallet, so this error comes only when that step failed. There is no create operation: contact support.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read holder global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-holder-global-configuration

---
id: config-read-digital-wallet-open-id-holder-global-configuration
title: "Read holder global configuration"
description: "Reads the holder global configuration for OID4VCI and OpenID4VP flows. An organisation has one holder global configuration. The wallet makes it with the default values when the organisation wallet is deployed, so you do not create it. By default the wallet checks the revocation status of the held credentials once a day (`refreshCredentialStatusInterval` 86400)."
sidebar_label: "Read holder global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v4zgO/iuEPrWA89q0M1MsFtttu3PZHVyLvkw/DApEkehEW1vySHIy2SL//UDJSewkbWfvcPdl7kvr2BJFPiQfknpmEp2wqvDKaHbKbpBLB36KMDWZRAuTzIx5BsLoVE1Ky2kdpMbC1fBi8Pl8CFxLuCpQ089rSDMzd20402DshGvl4oYpd2D0q0LbcDdFmPMsQw85f0IHysNc+WlQR2LKy8zDjGclOphPUYf3jWOq3cqBxCIzC5QJOAMLU4I0oI0HYZF7BOXb8OtiLdRvThZTFE8RAYszI6Jg57kvHZg0QoOZJEkStVc8I9MEAgfJF3AwsphadNPz9ffbsHmoPdoZz0bw/mTQ7R62WcJMgdH4oWSnLMJBHrhQE+V59hBUCuDKfwTkPgbgzuu4sYRZdIXRDh07fWb9bpf+Nd1ag9aiL61+08eknjDao/YkjhdFpiIYnT8dyXxmTkwx5/TkFwWyU2bGf6LwLGGFJcu8ihpN9ihNIrPsKmWnX3a3N3X/uC8CV56IBkTT2jD04U00zqH3Sk/oB/eAM7SLV4J2JbERT6VD196xR8mazc5bpSc7St+gMFaCCiGQKrRbGr+cAQ7tTAmsUsBPlYsxH0NeeXB8hqsApUOi2bwymudYrecORtOXomYoR2QYfuN5kZEdJyfHaX/8XnzgPTnAbrfX5+OjgZBsmbBXpLyNxL1WX0v8u0j8GwQSUj3CwmXwcFlISvZ1lrkVC5QOa8g2gRi/k710wPut9+IIWwP+odf6kB73W115JE7wHe+NB8cEiglpeVVT8nvQGO7AIGOur9IzEleO2se4XcWzctv5uUyYK4vCWL+hmkst7KJYZVilytiYDLne0eWBAmrkbYmjpE6BXAgsvAOMwlCu02ZzENysOKeBHglbEiG9SoE13ZT2OEG7i1O1FJQGh8Jo6WCMfo5E+3NTY989NB05vA2j7gicN0VMDV56k3OvxPr7Xa2uNOmFEj/yNBxQ2IUdgFxMieQPGzaHZcFoqSwKf2+z7+GHuBjubz5FR9cc4JDMVbHAXZ2Vfgr9dhfowVj1V1TxBr+W6DzIkg5Yu6gGjHKu5FpgGx4q6lAOMC/8ouHuYKvyDsxcg+BZNubiifRq5sXU+8KddjoV11Yf2sLkndUmFlD4WiqL16WbomxoXCns/oPIDKpyiMJfwOPg+uwmgZvfzuFDr39yGHqVgGMFUHPXuZEY+D9GA1FHsuINopBMOV8nEMF1VUGD0Mi0qTU5jDE1FsPbjDtfCWnDLcaX22TUQDflmaPEie2JPPM1kHSZj/dkyL1W38CrHJ3neQEHm0Q5XHVH25wBc+6qDkg2ju+9G7zr9nonIY6jov9VHQJAuZFEhC9qsgkmyU6/UNV9vRK9QMmvs+TbXNVM7O8K8Lof63g+Lh+3Ebx7o9Pe05W02TY0+xqsxyWtmiKXaCnl6Ncgtobf3dbVz0BrjaVsIW/R80XNjsfkjRZws3sf9a+9H4l0R/weNt3w0q9cgtJF6aHglufo0bLlMli/C3Wjp1AOSv2kzVwnUJHEZoCgNmE1RKw5pOmGXXh7PzC895pXyYByDzSDHxiavRMMBVhqSi33DL4Ua1usWVXwGJLupdG36oGpzpMpIEyO1DhnixUfcw/OYwEpVxnGsy3GgF8Nx+sSdUpKeC48VBS6G/PHPzSlhCKheRaGNrQR9C2MqE1HUVrlF2HYPSvUH0iPoRp4PnGERTXxQxz54WA1nJ4fsoTF2Z8gydFPDd0VTDAgwv2UnbLOrN+J4dKppolWDIcOVUQlO7HCdGKdaImt64OovAvaNe27wNxUtlEho8Z23QdKzE2LF6qtJpZr31aGLZNtAdfWyFLE3ny/mLck3Ho+of72he0uft5W5HED+i3FXgyZFfRr3/P4ImGKjopeYwnTPKevjeK+0/ucXQ/hCRc0VkypcRC1GT62hVXtHjXkjCAeA3npPIwRCoup+oYyXnWNoo4wggNtfOwcveUqCxgUXOBhAtietLfEnkK18aeFKS3B0XrCxc+j2CwonZpVmnIR0hRzrgjIKrN/2YC3tl993Lxqol532BYs601QWDNTMjTswlBm0b0b/afhttHdxGAPVfYzWpUqPs6wNmw6GFajDBxUbfxh7Qpne+O1Rbc+Yp1J14ekkTfCZGH0Uw7Ihahpj6vI9K+qzfcmTE+YhOYsCYfN6ITFel6v3/+VLrjHcy25la4V7FVc+3gfGl1bIR20fTg6h8/ncPD7w91hAsPLu9/g9qL1+8MdfD6Ppw1vr6D3vts7ah1DfmFEJ7/4VB/uUmNz7sP0nSmB2gUeXEVuwcUUaWjccd18Pm/z8Llt7KRT7XWdT8Pzy3/eXrZozzJhXvmsEQMBLGlEufYeSxjRRnR7v9sftI/aPdpbGOdzrmv60J3ma23udnLVCsr/b6T/pzfSFTF6/OY7RcaVJoeW8UYjVpsvbNaPd8OpCvcajYpTTWG1YY0lbG/deaQFzpPA5+cxd3hvs+WSXn8t0YYCmbAZtyGnQ7lc1dVQqJ6IyNlZuKqiSCQnBEbf6j6W9ar58fKOJYwYu1kEnkIRqB5qN9JcL2qyt+tBVIH+Utnau+Unypo/cPHzenn88uKGdQ2Kqwl/muT+BQkCCFg=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read holder global configuration</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/holder/global-configuration"}></MethodEndpoint>



Reads the holder global configuration for OID4VCI and OpenID4VP flows. An organisation has one holder global configuration. The wallet makes it with the default values when the organisation wallet is deployed, so you do not create it. By default the wallet checks the revocation status of the held credentials once a day (`refreshCredentialStatusInterval` 86400).

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet returns the holder global configuration.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>globalConfiguration</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Global configuration of the holder wallet. It holds the settings that every OID4VCI and OpenID4VP flow of the organisation uses.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Record identifier of the holder global configuration. The service makes this value when it saves the record. It has the same value as `holderGlobalConfigurationId`.","example":"665f2b8c9a1d4e0012ab34cd"}}></SchemaItem><SchemaItem collapsible={false} name={"holderGlobalConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the holder global configuration. An organisation has one holder global configuration, so the read and update operations do not use this value.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the digital wallet deployment that holds this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet accepts encrypted OID4VCI Credential Responses.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"refreshCredentialStatusInterval"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Interval in seconds between two credential revocation status checks. `0` stops the automatic checks. The default configuration uses 86400 (one check each day).","example":86400}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URL that the wallet sends in the OAuth 2.0 Authorization Request during OID4VCI credential issuance. When it is empty, the wallet uses its own callback URL.","example":"https://wallet.example.com/callback"}}></SchemaItem><SchemaItem collapsible={false} name={"requirePushedAuthorizationRequests"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet uses a Pushed Authorization Request (PAR, RFC 9126) for the OID4VCI Authorization Code flow. The read, update and list operations can return the value from before the last update. See the update operation.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this configuration was created.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this configuration was last modified.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"globalConfiguration\": {\n    \"id\": \"665f2b8c9a1d4e0012ab34cd\",\n    \"holderGlobalConfigurationId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"openIdOrganisationId\": \"string\",\n    \"supportCredentialEncryption\": true,\n    \"refreshCredentialStatusInterval\": 86400,\n    \"redirectUrl\": \"https://wallet.example.com/callback\",\n    \"requirePushedAuthorizationRequests\": false,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, or the wallet is not deployed for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Global configuration not found. The wallet makes the configuration when it deploys the organisation wallet, so this error comes only when that step failed. There is no create operation: contact support.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read notification
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-notification

---
id: config-read-digital-wallet-open-id-notification
title: "Read notification"
description: "Retrieves a wallet notification by its ID. The wallet creates a notification for each OID4VCI credential lifecycle event."
sidebar_label: "Read notification"
hide_title: true
hide_table_of_contents: true
api: eJzlWFtz27YS/is7eLJmqKvlONF0OsdHSlu1ncQT28lDxnMEEUsJNQkwAChZ1ei/dxagJJJS4vShcx76YtHk7mL32zu2TKCNjcyd1IqN2Ad0RuIKLXBY8zRFB0o7mciYEwXMNyCdhemkA/dL3JPEBrnzPDXiRBtAHi/h/XQy/DieEp1A5SRPIZUJxps4RcAVKtdhEdM5Gs84FWzEYq0SufiAXEzkQjqefvJnvc9RTcW7yjEsYjk3PEOHxrLR523DpAclvxQI0p+cSDSgE+Dq20pV7QimrnhaIGSFdTBH4PDwMJ2Q1pLOyLlbsogpniEbsSrzVLCIGfxSSIOCjZwpMGI2XmLG2WjL3CYnDuuMVAsWsUSbjDs2YkUhBdtFDJ95lqdE80r0eD+5xPZgfh23h/Fr3n6T9PvtSz6/il+Ja3ydvGG7RzrN5lpZtHTAoNejnzokFdcZdIVRFtyyYTSLyAUOlSN+nudp+aX7hyUh21Mr9PwPjB35w5AvnQwqVMV6WWn6PvGOavLVtbw5G4EUVC957xBSdUWkOAf5d0TLOXD+rmOiGg73XomXlCGq/fl7g2tgBENhdkThfzkqIdViBhcCEzQGBUhrC65iBKkgN3ph0NpWVOPi8ROKGVzQSUudCjTA4yel1ymKBQqvwZG8wWxwpY/sdBoaKF9+mxOfc8qLkrPiy/JDyyOtioyNPrNTIylGGzbUX5VK1F+Wstlj1Ykncs447AOm3KGYfkcYTU/ix6DVhYkR3JK7k4gCaYHPdeGiUDWDXg3wKlFZj8D5tegnQz5ov44vsT3kb/rtN8nVoN0Tl/ErvOb9+fCqadD4mNx11W/5JtVcnI37atFfSN8mFHBj+IbIQx7bYCFFkRdQ8fes5v2xr/BFqPl2BlwJmIXomYFAx2Vqq7VXWpipIk1nsF6i8rJLVegsC0pDHnT33URhvcp4NalgO8zsuarFhZCkCk9vK2WDKvZuF/0t8sddxKzjrrAvRwp1OAjE5yG/AYXrerAseSjYJdusUAa5mAWwilxwh3DopmDR1cidhpmnjzzkjaYdc6W0g4WGOY+fPPFefCUX6QWLWPhSz6Ty3c7nHOXLjaugoIpsjuZc2X0GJzO0jmc5XEhSO9ZK2NbR2zU919yWc4eoJUP/enjd6/df9Xq7iAUs/kENUm4dZFpQUn5Vj111AvhMbehMM/hWuTmfuYcYqyJdtfmRpoG6le+arZSsokxWddtotmnqXevjjzv6vEQu/NS1pf+GYdb47rGhKhyN0WasBQHhnycVvR+jF0aMI/fRz1I5XHhHH3wy9EFxIv5Mjh7D+b9cgFR54eAwZbLdzlt/OlQ1MKSSVShqo35kaKLV/xej9aB44ZbayD99e65Dc/WvDqSpcmgUT8GiWaEBf0wDI2owGBdGuo3vcTe5/A3p0ee84wvahFi5OUFYneDCL080RrZYxH7xYx5BkqFbatq5FugRoWVmxLqrQTcsYV0R5LRDu+3qHJUU3Wqwd7f1pWdH1cmrf24lm2CmS+uoYJmUjdjSudyOul2BmW7zXHbkwnDlOlIz6r6NGcVoUcRldzsr5iUJd44vpFp8jd2Gz01FHo+w31H0haDZg38cNcKLcjkMfjuuhzdl4O+318bWczuFJ9wApQfNSac7aDklzGpyZhCOOWyoucFEPqOAtXRLmAUdYQYXSrswWDrDZeoxyHmMrQiws+g0xI6gZPxhowtDcLSfcPPjLHQHqRK9T1Qe+0TFjEsC0hZ5ro37zxG8g/3y5+OrOupVhzVgOTDRBrOSwt82xJpyyyFI+s1QuVB59yuTD3ff5j6ikYnk8xRhfBhALUz3m9FFuV61/Eh0nvHWoD0cccil2xZp5HSsw7QqLZALURGPBW0WXJVg+tHLD7iRH1nD/LWiEzZQ5lhl3LdQWO8ex5XgRti2t1dy5SBJ9doG15ZIe20/XY7h4xgufv1034pg+vb+J7ibtH/9dA8fx+G06d176L/u9S/bV5BNdNzNJr9XV4xwAWGpXaUyRmV9JdxHbs7jJcKg0ztx3Xq97nD/uaPNolvy2u7v0/Hbd3dv28Szi5iTLq3FgAdL6Lg4eI9FjMpGcPugNxh2Ljt94s21dRlXFX387Kzqd0GiXo8PPeT/erVV1gWHz66bp1wqsscDuC3L7We2GoQrl0T6JaFWcsPtmDqZHFnERo3bpseILbV1JHG7nXOLDybd7ej1lwKNbxERW3HjYzrUZmnpWbBRwlOL34Dw4kPZaFvwD9+qnQVsX10VlVbPyUaMReyJim/z1s0vYWXpJSsD0U0cY+4q7CeDxa7aEH9+e0+bXkEeqlb3J1/dy4fqjllTrVnogwr0t7JP1ll+oHT4DTc/HsjDl68yHJpLoCagaDT/CynunVQ=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read notification</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/notification/{notificationId}"}></MethodEndpoint>



Retrieves a wallet notification by its ID. The wallet creates a notification for each OID4VCI credential lifecycle event.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of an OID4VCI credential lifecycle notification. The value must be a UUID.","in":"path","name":"notificationId","required":true,"schema":{"type":"string","format":"uuid"},"example":"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet returns the notification.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>notification</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A wallet notification for an OID4VCI credential lifecycle event.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the notification.","example":"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9"}}></SchemaItem><SchemaItem collapsible={false} name={"notificationType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`credential_pending`, `credential_acked`, `credential_revoked`, `credential_expired`]"} schema={{"type":"string","description":"Type of the OID4VCI notification event. `credential_pending` (deferred issuance in progress), `credential_acked` (the holder acknowledged the credential), `credential_revoked` (the issuer revoked the credential), `credential_expired` (the credential expired).","enum":["credential_pending","credential_acked","credential_revoked","credential_expired"],"example":"credential_acked"}}></SchemaItem><SchemaItem collapsible={false} name={"notificationTypeRelatedId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the resource that the notification is about, for example the credential identifier.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>notificationContent</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Payload of the notification. The wallet gives an array of objects that hold the `credential`, `credentialConfigurations` and `issuer` details. The value is `null` when the wallet holds no payload.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`read`, `unread`]"} schema={{"type":"string","description":"Read status of the notification. A new notification has the status `unread`. The update operation sets the status to `read`, and a notification cannot go back to `unread`.","enum":["read","unread"],"example":"unread"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when the notification was created.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when the notification was last modified.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"notification\": {\n    \"id\": \"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9\",\n    \"notificationType\": \"credential_acked\",\n    \"notificationTypeRelatedId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"notificationContent\": [\n      {}\n    ],\n    \"status\": \"unread\",\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The notification ID is unknown.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read presentation definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-presentation-definition

---
id: config-read-digital-wallet-open-id-presentation-definition
title: "Read presentation definition"
description: "Reads one presentation definition by its `presentationDefinitionId`."
sidebar_label: "Read presentation definition"
hide_title: true
hide_table_of_contents: true
api: eJzlGmlvGzf2rxDzpUl2JB9NemiLYl3JTZSksWs7yS5SQ0MPnyTGM+SE5EhWDf/3xXvkHLpdtAss0C+2JJKP7z55HwmwqZGFk1pFvegCuLBMK2CFAQvKcVxgAsZSSfp4s2DSWZa01wf18lAk3d/Ub+pqCiyRImF6zNwUGFd2DoZJS9+kcmAUz5iBVBvBpADl5FiCiRlXgkmHO5V2tNvyHNiMZyUwvvNihrdm0joGShRaKscMuNKoXaeYVIRp9zcVxZEuwHC/EvWiVKuxnCBPBnIiHc8+8iwDd1aAGorzjRCjOCq44Tk4MDbqfbpfYfB7Jb+U0KK44tA2frspd8wWkOJuz77UAB3nGXErzbjMLTPwpZQGclDOsrE2jNAcPP9wzmZg5FimBLsbxZFETAruplEcKZ4DftvCnyiOAmAR9ZwpIY5sOoWcR737yC0KPGudkWoSPTxc42ZbaGXB4vrx4SH+W+YACsmCmYFhY10qsYt6RDbVyoFyCIgXRRbIOPhsEdr9Ojb65jOkDuVgUJpOelw2E7j/nBTrlMYrJA236vMe6e5SWTzmtV6Pd+nvFAx4OKkB7iBmBrggzSgLwR3UoG2AzTgTcjwGA8o1ttgg3WUn2ZwvLCst7LrZacaFMGDtbhk+kF2poTgzE66krQ1sL1/X+FjpdJ8JKDK9QG33JqLnxDNpd+KxVc334rJuuHSta7R5ImdooHq3wN9b8Gi2IEkUSdtIyZjBOu8NlYfI3bRiA0o4rsSLewRk0JY0EZvxG8j2U/aqzLnqIEh+kwGjU564QBFeXppCW/D3b+dxTI4H7nheZMC++oAkLdi5No5AD3RaksROjr7yKiu4nd5obgSzUz0PAiQMiAKRfsl+LcEsNtkpF4Iu5dl5y2K9j1qmMHhv1q8dp2UElr3lalLyCbAng/6vb5+yL/TrCvFp6xgPDis43VoHvPTAMG5vLRsbndPPU50JMHVI9ODxR8s4S1qAE8aN4YsuO+XplIFyuI/jfRSdYtw+1ibnLiEcOPPfOiE0pCzJwfGEefb0WCJ0ihwbkQ9JSDBJbvUoFzpNYpbMUufXbMJwrdlsw26R/sOKzue5S3xY3rDl89yNZukInXHSZScqYJ5yxXhmNZHKEs8svJQ+jSw4+hYiyyg1i8LpieHFVKYjz7PRjVRCqgnuy8vMySKDJKBhSutAjHjpptpIlDtezpwuOhnMIGtz1l/muUt4TYwui9U4ioKRYGtBBZPOgHslIJUnJVswXTo2n4LaGbZRdkoz1CovdcwvHuLIGa4sT8n/cMcbH3RF2r3PVnEXGWEDhgnu+KoirrgR5KX1Fue5y/ISvUtRGD0DOrcG8QbG2vi1OaU9zIIS667eg/WRykIGqfN7Xl+evWOXFJ3XXGVpvaec8UySD8O1ZIU3dfK4iaQuw7SMJS9Pr9jB7PjAp2oHwlt6x2N8gGFHigMrPs/dQQt8BynsNOIK6kwYeoz1mAFaIoqj1gpPpCSrhLxwC+bFtF8dSACoEKts9mknqDKPep8iyh4pqI1wsfkaxVGmJ1KNjLS3oxaQrQsjpdXI2aNj9JRpqkvlRjxNwVq8L+cK+Y76xR0f8YkByhxHPoOpfhfSppm2pYFNW76A9WheP8SRTz7EiWspsSrzGzCbQukdczIH63hexBjgLKRaCRtXIs91E9lbehMu2R/nfWj8H2OTcetYOuVq8hiUZmDscsa5xcZ9jkMKSQFUUuxslxuWPamT+6csAK6QPfFe8XePxEVlLknYNjo8SlCFm+rgqHvYZYm0+ui7w6OvR9+OuFJwN0qTqlwbXp4xWut8y05wjfXRG45lBjGbT2U6DVFPG5YPdLoUMPUMvGFtCsIn58NuS/0bFLFIWUMo6FkrVryBRZMj7ufsG1hsyM1vIUR8SRmvQMdk5cQbdIMtCXH19p8pCO+/2e+rbkTo6DZuYbGcMSVCit4tLHxEvntx+H3SHaLjdZZN9byVUjADVmdVhuKJwtg0XspGtshVAQhbwW/xP9wexREuEbttqh8Tl85Q69hx95DRgeApkTTuf+nccGTtkoHUrvzP+VafTintLyIxVVXo44Jqg3x1jtz+XoMqRk7fgkoa7efbLBYFIda3q2CGrK+VgtSx4YBd4aYuSwTMZAqjCqXlY41JvmAD2nhRoU4lA/ZwsoXP0TZowJLRBTLQ5ET9ceV2b3qZBOWGgoL6I/jap/1IEwXVfQxdVfQ6pa5N1mLrCbJxVWSFvCSADbk2ppVCGkjdqDQy8bkGZ9WP7P3FMCZDq5cGw0FM/pGuG3HnMBYgcvWWDxUuJ80ie/3xKvZWNLJcjQSmET6zmQK7PHnHBu8uGfZXEEOu2L+7Lw6/ZylWKpTOQEirCcKU22nrOH7ddqzLPko39U61jz600dtcC7DxKgsqdeAMc4V0qdgnFLDVhiyiFkbgk+NmAsE496XDj9GzNkqoKhJTiE1MD+6n4mn1FTlCaujBnGvrLgLI90Y+ooC/GDYRfJPmMMwWLeNjhzrnWKFtSGVXFdYzu8vOKhuj9DWQh8eSZYksMdHAOEi5zUVfcDUQuk3ZJV1VTeTAKW5UV26U/uMk9niv+v5iuORTf9HiEbZ/0cYpNDHbxr1RAAIyiTnATqY/ezbwCooa0Hv2bIXxjdRqtlAK8urq6ry7zuJN+33ZDYqCPQi0c7qWuO1vTEe8kC1z/fh1f1uCQzJsN/Xqe+bSTVEWrz+eVrf5UOHBe/zqK/4weCQDYS9H+Jr8KI5WmIG/0M31B/qVbC49KWTw1I8Lqpchx2lH0lpfg8dfsZ/AVPKJbRas6neC+ROIhOxhUw8G1zcrURW7S7UXRl3sVkV0deavNjDKfNpC8tdEcVTdSCKAuwJSB+LMyIlUtiUB6m2sZzV+35rPwyKwcFW+4i9Yk8xfS6EmVGjy4CC3m0YHSH2wt8rUT1X6gXpNl2VRaONA7KUZLSnMC1oWxXg2wT7RdHPDrsWPXX5nSP2STDY93nVnsqSp/2yrtV8fZ3rO5ERpQ7mM7+T5XjsXM4zwaO3JydHxdy/7vwRTODl+8Q1++wubU5VgasaEHHxT78ghtDHPMstueHpLXf8MG8QGoMVZ38jYIt9Gt5G0/k/9zqvL4xffRHEUSMVPnszoGpXBLqyD/Beu+GRJ7DdaZ8DVmuCxJwhJi/KMO2yQPmIswP6jS2wMYg4U2uic+ftZ7hHYWdfDHaqb1OpUYdr/R7HFSIMQqIRvJwb7sQ39f1tiAb69JY9KtFijMde2Cr95l73ToQlnC8gy9NtNpz9oFiayO2Yof65D/xYmPF20O7JL40xMhHdPSLliPodYmnoSU0PTaKXMTFSZZb7tBzPsyu8ET4JJ6nFEsiQHC26ZV11yaM3c9FNEye6OGasf1exrD8fRLQHyRflKmdtuwbUbYFuGb6s2tkGRr1ep2CL56wfcOAUuaOZ9j9+e+9Hvo4e37WvAGG36mGbG/vOgpSvX8Z6BbXO60Ugcck6o9xc6LVHv+eHhwwbwm1xXdST6ieM0rigdq2f80cMDUb8+49YtflNrSd0qPVcxmVnoU1cxuTXMDA8fQntHxNgJUnrnnIHstqTYJHa9j4jWhXT0NxbSexUGSL+T+i+z5sXfWn/rBw0h1aBrVniEURrS0ki3oHcuJ4V8A/jxGt+BOD7B5y/16NW/nGn61v2nURxVXRVkSg5uqvHRzQSIJ/g6pRc9crTT1vnWWOfgfpsxPKD/I9o2PdIZQK4D6ehKTRb1oqlzhe0dHAjIdQcTOjkxXLmu1NFDvArg3GhR+iHPFjD7IFw6PsEwvOW49curiFw3MvFNOtKoSjJN8ux/CA+BvFCbp0BLCfBa7oJlAnbM0XYwXKRrQ8BQ7CVLcPCdCq8HjzeUm47lHQiqglnicWQJe6KqVMQZLikVsQVP4WnMoDvproDtsXDwh4UuDbKjcwuLHxMfgaUa68qKeUpWDDmXyEjra4p/Ncyr6Zcvm5+Wud4W2Apb6kOYBMykoK5hqtHwHDCJ//Pafy89Zlkd9LTr+6G1JVcpsCdnZDTDp5TN7Z8QLQ2ICqOdTnVGrSHpuwZAMd6GKPV7GCs5zaS1JcRUIvjUceYfcVQRqz3bKS2Jx+Ew0QjbIXolV44KHetFGzhN2GKb5EOfPXn98eppzIanVz+zy0Hn9ccr9qHvb2s3tnGWdJAP3rbTQv/qwWIsy2QK2Jru3deaW/B0CtjJXxPdfD7vclruajM5CGftwdth//Td5WkHz+B4XrpsSQeIWSK8W6ksoh7lRceHx8+7X3ePKC/W1uVctfChEfWWyL1qWK1Y87d/hRnclIM7d1BkXNLLCZLnfQgMn6LZsX8bOJbUe1oKDiHn9bmy8J2tLSEiiqPe1rz8Oo6m2CnrfYru73GA9d5kDw/48xf/KOnTdRzNuCH783FE2lAEjnlmV8uctoyfXISM4Sn7v3gTupHnVbxQGCxI+FEPHyngkHDHm9GH67oeIK747SfUaGkBWsuoHtp5wMvTKywhSxR3O3L5AWX4gNA3IrkaxDwK+Bdj7cYjP6Cpv4HFj/V2v7L1QB04/W5kGZZC/wVY6TPz
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read presentation definition</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/presentation-definition/{presentationDefinitionId}"}></MethodEndpoint>



Reads one presentation definition by its `presentationDefinitionId`.

The `id` of the answer is the internal record identifier, and it is not the same value as `presentationDefinitionId`. The list endpoint returns `presentationDefinitionId` in `id`.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the presentation definition that specifies the credential and claims requirements for OpenID4VP verification.","in":"path","name":"presentationDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server found the presentation definition.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinition</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the presentation definition. The list endpoint returns the value of `presentationDefinitionId` here. The create, read and update endpoints return a different internal identifier. Always use `presentationDefinitionId` to address the presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VC deployment that owns this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier that the server gives to the presentation definition. Use this identifier in a verification request and in the path of the read, update and delete endpoints."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label that gives the purpose of this presentation definition, for example 'Verify Portable Document A1'. The dashboard shows this label."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder.

The query holds a `credentials` array. Each entry has an `id`, a `format` and a format-specific `meta` object: `doctype_value` for `mso_mdoc`, `vct_values` or `type_values` for `dc+sd-jwt`, and `type_values` for `jwt_vc_json`. An entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.

The server leaves this property out when the presentation definition has no DCQL query.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder.\n\nThe query holds a `credentials` array. Each entry has an `id`, a `format` and a format-specific `meta` object: `doctype_value` for `mso_mdoc`, `vct_values` or `type_values` for `dc+sd-jwt`, and `type_values` for `jwt_vc_json`. An entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.\n\nThe server leaves this property out when the presentation definition has no DCQL query.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDefinitionType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `payment_data`, `payment`, `login_risk_transaction`, `login_risk_transaction_non_ts12`, `account_access`, `emandate`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`]"} schema={{"type":"string","description":"Type of transaction data that the verification request binds. The holder must approve the transaction data before the wallet sends the presentation. The value selects the JSON Schema that the server uses to validate the `transactionData` of the verification request. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.\n\nThe value is an empty string when the presentation definition binds no transaction data.\n","enum":["","payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server created this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server last changed this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`, `iso18013_7_annex_c`]"} schema={{"type":"string","description":"OpenID for Verifiable Presentations (OpenID4VP) version of the Authorization Request. `version_01` is OpenID4VP 1.0. `iso18013_7_annex_c` is the ISO 18013-7 Annex C profile, which asks for mDoc credentials over the Digital Credentials API.","enum":["version_01","iso18013_7_annex_c"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value for a scope-based presentation request. The value is an empty string when the presentation definition holds no scope."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request. `vp_token` asks for a Verifiable Presentation. `id_token` asks for an OpenID Connect ID Token. `device_response` asks for an ISO 18013-5 DeviceResponse and is only for `iso18013_7_annex_c`.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet of the holder. `redirect_uri` uses a redirect URI, `did` uses a DID, `verifier_attestation` uses a Verifier Attestation JWT, `x509_san_dns` uses the SAN DNS name of an X.509 certificate, and `x509_hash` uses the hash of an X.509 certificate. With the DC API response modes, `redirect_uri` is only a logical identifier and not a real redirect target. The server leaves this property out for `iso18013_7_annex_c`.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI that the wallet of the holder opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`, and it has no meaning for the DC API response modes. The server leaves this property out when the presentation definition holds no URI."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`]"} schema={{"type":"string","description":"Response mode that sets how the wallet of the holder delivers the Authorization Response. **Direct Post:** `direct_post` posts the response over HTTP. `direct_post.jwt` posts the response as an encrypted JWT. **DC API:** `dc_api` uses the W3C Digital Credentials API and returns the response without JWE encryption. `dc_api.jwt` uses the Digital Credentials API and returns the response as a JWE.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signed`, `unsigned`]"} schema={{"type":"string","description":"Signing type of the DC API request. Only for the `dc_api` and `dc_api.jwt` response modes. `signed` means that the verifier signs the Authorization Request. `unsigned` means that the verifier sends the request unsigned. The server leaves this property out when the presentation definition holds no value.","enum":["signed","unsigned"]}}></SchemaItem><SchemaItem collapsible={false} name={"expectedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Origins that the wallet accepts for a signed DC API request. The server leaves this property out when the presentation definition holds no origin.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the Authorization Response. It applies to the `direct_post.jwt` response mode; the `dc_api.jwt` flow ignores it and always advertises `A128GCM` and `A256GCM`.\n\nThe server leaves this property out when the presentation definition holds no algorithm. The verification request then falls back to all three algorithms.\n","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the platform owns this presentation definition. You cannot delete a system managed presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"extentionEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when an extension uses this presentation definition. You cannot update such a presentation definition, and you cannot delete most of them. Note the spelling of this property name."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Legacy credential requirements of a presentation definition that an older OpenID4VP version created. The value is `null` for every presentation definition that uses `dcqlQuery`. You cannot set this property.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Legacy credential requirements of a presentation definition that an older OpenID4VP version created. The value is `null` for every presentation definition that uses `dcqlQuery`. You cannot set this property."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presentationDefinition\": {\n    \"id\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"presentationDefinitionId\": \"string\",\n    \"label\": \"string\",\n    \"dcqlQuery\": {},\n    \"transactionDataDefinitionType\": \"\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"version\": \"version_01\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"scope\": \"string\",\n    \"responseType\": \"vp_token\",\n    \"clientIdScheme\": \"redirect_uri\",\n    \"directPostRedirectUri\": \"string\",\n    \"responseMode\": \"direct_post\",\n    \"dcApiRequestType\": \"signed\",\n    \"expectedOrigins\": [\n      \"string\"\n    ],\n    \"encryptedResponseEncValuesSupported\": [\n      \"A128CBC-HS256\"\n    ],\n    \"systemManaged\": true,\n    \"extentionEnabled\": true,\n    \"presentationDefinition\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the digital wallet deployment is not resolved, or no presentation definition has the supplied `presentationDefinitionId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Stream verification status (SSE)
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-presentation-status-sse

---
id: config-read-digital-wallet-open-id-presentation-status-sse
title: "Stream verification status (SSE)"
description: "Streams the status of one verification request over Server-Sent Events. The server sends the current status at once, then a frame for each change, and it ends the stream after a final status. Use it to show a live status while the holder answers the request, for example a Digital Credentials API request."
sidebar_label: "Stream verification status (SSE)"
hide_title: true
hide_table_of_contents: true
api: eJztWVtv27gS/isD7ksMyLITJ3sxiuJ0k+wi3UuKOm0f6gBipLHNjUxqScqOT+L/fjAkJUu+pMXi7Hk4m5dcKM5wOJdvZjiPLEOTalFYoSQbspHVyOcG7AzBWG5LA2oCSiIsUIuJSDltBI1/lmgsqAVqGKFeoO6OUFq4XKC0JoYbonfrYFBmnmFaak2bAmNuQckUI/omgcNE8znCRGlAns4gnXE5xQi4zEBYqLkYJyLwiUVNVELyPLCM4YNB2mwVmJlaAodcLOqbLGciR8djpvKMqKVZovZsw5UiL8ADnxc5AocLMRWW53CuMUNpBc8NvHl3VW2Px3Isv/nmG3hT0i1sUBCtjlBmjnNC35QW/3afEpghp8OPkjeF+AVX8OoeV68TUBqSH5Fr1PDKqnuUr5OOV+SdVkuDGhKn3ZEqdYqJkyLlUioLBm1tEs/dDGGKFjiZrmvFHMGK9B4tLIWdQfLuenQDvcVJL1VyIqY9Y2gXbUjg6E5lK0gex6zgdjZmQxiz3mJQbc28QrpLnudoe6pAKbKeVLb2DtMrNBqU1v3X9cqnI8ZsnXScPYvSkpmE9Aqqjv6zRL2CgpMjWNS1ct+jKZQ0WF2O1pNzJS1K271ZFTgEiw+2h6SfrneQJILknKcz7NJGrfIhSNVNaSWpGf9EJ5H9ufW+5V12qYVFd8pxDIlGq1dDGPT7/X4C3d2NYGfCVO4rtLExnMRwLRFKKfkcM3CCwRGHJOOWJ5ALiRFIBYn74hc63ji7kRJVoRLDYB/frZChiN3EbwynMSRDuEcsupzCge7AJYxGl5Cq+Zw40PHETK/g+AwMpkpmJoYrCynXWqAhWd1hPh7TXFCcjyUAiKlUmqLOaXUsyWPDNScC88wFmwEOb0fXv4O6+wPTyg2bmHKVJXBEYi94XtZ32PKITgSJv1ZCcvhgTSZc5Ji5FUjwoRAaMzK/Rm6UTHwQTbypZ3yBTvEiC/INgYf7eD9IlZSYWgN8yoWkMNqLXsF3nb0989qrRm6Hd6CnjcBP8BtyKeQUnmrZ4AmeoNvtbv18gqRAmQk5pR03G3gCYQhQrbvrjDu7eBSDFdqYGHhyjSmKBWnF0wfE87TQDNAKYIUh1Ysshp8IUhu8Kv1+kZPTnyChrOcVEapxCai10g3GxGeOxvCNtwZFuqMgnWF6T/HiUcbTAzeQvHJ/vh7Cq0biep10IsDcICTvmvI0RUlif5nKP7b0GpbhDifkzVwGtTaEbvPeIkzgicz9ZmvdZTmHcfhQJJvIVHRWnUVdTIQbkAatgVRj0CmBd5GXBpKmrt972kt/ypWsefuYQg3TXN3xHDxsl9pzO8pwwsvcwuDbfr8K9E7tuZcy28hIKFoFdMC7/UlY2JDk29kYjjZeGG28iCK2UlonCiwGP2zEcU6zpJrAhZ0PzTRXBkMg+gAVSsZwSd5gKqs1JDviEkp5L9VS7i1dIrBKwZzLFVAKC2SmQ5CI5GkBr0JwObzicPrwQMKdPTzU0EwO5rZ7DGARUwXqAGlsyLz+3yPPQinxybn0dYHyKmt6lEeNkUEWsRrwDBt+ftyq0a5cIeJs3LL5Vm3mwLTlM5cPPkEQ1O6jnAlyzFWHLiHoJIe+LGKUbNiQteGaRYyOIjuyodUlRsykM5xzNnxkdlUQhbFayCmL2ETpObdsyMpSEGUosNiQfc+PJyfpIOue4tld9zT9Nuv+gN9Nun1+fEfrp3g2Yet1tK2F663ChjLBFpBXxdGzdVi74LPPlVsx/Iw+mr+2mIo8TNZ5/UApyIOEf2vl5dNgkLwCe3f5QR16ThJaooq/ciSrfIFDQsXwpo6rCEqDGTjtefAMzKdigQZO+8cxbPDwSzqQiJlLZ57JIR/0X1u+N+G5ecb51utb2u0rSEPfT/p9+tX2pwbKkWbRW2S3twlIEVocDzYe/PY1JCwiAKA61Qm2XaTS4uGg2WrNDolCsdwqCL0ZNwVfq8wLzVmrQlMTl6RdMXmwWvNJGumrmrSTYQ1dl76avcNcLRt3/w0zwW/87XhR5MFde38YJTe7RtuK8KeziFlhHVYcPnNHW+/4Kle8zmaHrktCFpoQ2wrvHFsg90WzOGVuF7Lh1KpJ/AuAFzHvQV/hF3WbfigVxLA3EbfKZeAaves6aWU5Z8PPLBShLtw8A8JyR+/u5GjZbfN6FcmaaKjG/fINrmW+eqaSH8JytmrqEzKRubxryjRFzNr6fa5Ko0TSQI7PuyktaP123WTZ7ACpIiJnGsLjeIt8zIbjrzLvmEXjcJKjCTobszVxb/Zqf8dplSndcWxNKgl9NZmq1TM/C5M8X/KVCaVfsmmu2XOFwEapFQFJsI7YqQflBlruIEULLJtWdD3BucqodHJ/XzRkvo128KQd8RvqjbxCWpyibgp82u+v97B/9o4/8gyEpNeOuqJz111/FYpsNb+UtOfCGCGnrkSmiFB6yqUwobgPi4bL7E49dKoG0dWaF6cfz6t2KsMiV6t5wL+N8b0djv/pdthfoGy0T8pvt7i2VVkdqo/2Kfv0H6PsxpbW8af9030nsI97WhOn9okqZcYOGC94ePD8vY1RqGaE2Ym42pb+DSo8H3D48OHqYtd4Z/3BP954Z/3BXuPdtJprX1mGFvuQ5UJWIcvZw9Qx3OhVeJrLOT0Sb9mFKidMSy3syvXO/pGdDT/fUh9g+ZRaalY96/tmHI5qiOywKHgeajLEHO1MUR8/dV0H9UBs+F/qyihRukvv6/IvcK6CTljESp2zIZtZW5hhr5fhXHV5IWIx1VzaWCi22yC/0yor3TPJITZf4jCyfEpwd4Dc+M/bgtxuDOAqeu+ylRlq3+N+IXR53oKbNq8FwTsFI40+7nEFvDV08Y1N6/n4AJTPS2PhDunxciIeMAuNfJjHJHAklfVvAVZzkTsdFDxFemWMp/EW2yFUg5yVKjWpo+smOrGrNoWcqAomeOpgAudckCJNWRRK239tlFffX/y8WWprvWmwLbXURFBotRAZvT5S71fkaBEE/Z7XlXHQkHd8V317t+d3ObamXVfGlFymCEfXLkKu/AhnP2Gr+K6j6l2HJLIqVblrP4WfoaEkGhOKGK9MCn4QxpQYuVbUzxscTq8gxBo9jtbilS4jG8tlxnVmuu6+gtNYJFdL400bNO2k/TQ4h4/ncPT2000ngqvLm59gdNF9++kGPp77065G13D8ff940D2D+YVKe/OLXxtngn/Mcs19LlKUxqFi5bkFFbVwEvd3TLdcLmPuPsdKT3uB1vR+vTq//H102SWa9abb3ZiTlJWptKytxyJqBow3+0n/5DQexMdEWyhj51w25PET3XYmrN5nR6PLznZwNRLayzT4ZRr8Mg1+mQa/TINfpsEv0+CXafDLNPgvTINDu+MyUpFzIalMc3XhY+gmP7PFwE9BJsI9jrdyqh8oSzc1beVV9yqwk1mppzRInetMGUvMHx/vuMEPOl+vadnP01y/KQzV35sJ2sE68Oh9eLrowP9k+LxXZ/fUPu4+2LsEwYbM969ffaWX8fH//fj4GS+qp8gb77mlf7TrYt1jUfWq5ELFU71JUyyaVLvz3HXzyejnyxsWMXqkaL973Lt3j/AHsa8+yVWD+fYTiJeBfpKn7yV5RV3AL7h6XW/3Xw4S1M8ufjep6Ha9Xv8HhCJ+Rw==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Stream verification status (SSE)</h1>

<MethodEndpoint method={"get"} path={"/v3/config/digital-wallet/openid/notifications/presentation-status/sse"}></MethodEndpoint>



Streams the status of one verification request over Server-Sent Events. The server sends the current status at once, then a frame for each change, and it ends the stream after a final status. Use it to show a live status while the holder answers the request, for example a Digital Credentials API request.

### Authentication

Send the `Authorization` header (`ApiKey <key>` or `Bearer <token>`). The browser `EventSource` API cannot set request headers: get a one-time ticket with `POST /v2/config/sse-ticket` (body `{"path": "/v3/config/digital-wallet/openid/notifications/presentation-status/sse"}`) and put it in the `ticket` query parameter.

### Response headers

`Content-Type: text/event-stream`, `Cache-Control: no-cache`.

### Frames that the server writes

1. `retry: 30000` - the server writes this frame first. 2. One unnamed event (a `data` line, no `event` line) with the current status, at once. 3. One unnamed event for each change of the status. 4. `: keep-alive` - an SSE comment line every 15 seconds. It carries no event, and clients
   ignore it.


The `data` field holds a JSON object with `verificationId` (the value of the query parameter), `status` and, for `failed` and `expired`, `reason`. The frames have no `id` field: a client that connects again gets the current status in the first frame.

### Statuses

| `status` | Meaning | `reason` | | --- | --- | --- | | `pending` | The request is sent and has no answer yet. | - | | `received` | The holder sent a presentation and it is valid. Final. | - | | `failed` | The holder sent a presentation that is not valid, or an error. Final. | The message of the first failed check (a wallet error as `<error>: <description>`), else `Presentation is not valid`. | | `expired` | The request expired before an answer. Final. | `Presentation request expired` |

A request expires at the `exp` of the stored request object, else at its creation time plus `presentationRequestExpiresIn` of the verifier global configuration (default 3600 seconds).

### End of the stream

The server ends the stream after it sends a final status (`received`, `failed` or `expired`), after 3900 seconds, or when the client closes the connection. Errors before the stream (an unknown verification request, too many open streams) come as a JSON answer with a 4xx or 5xx status, not as a frame.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Identifier of the verification request (the `presentationExchangeId` of the verification history).","in":"query","name":"verificationId","required":true,"schema":{"type":"string","format":"uuid","example":"8a1f2c3d-4e5b-4c6d-9e7f-0a1b2c3d4e5f"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"One-time ticket for a client that cannot send the `Authorization` header, for example the browser `EventSource` API. Get the ticket with `POST /v2/config/sse-ticket`, sent with the `Authorization` header and the body `{\"path\": \"/v3/config/digital-wallet/openid/notifications/presentation-status/sse\"}`. The ticket is valid for 30 seconds and for one request to this path. An unknown, used or expired ticket gives 401. A request with the `Authorization` header needs no ticket.","in":"query","name":"ticket","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server opened the Server-Sent Events stream. The stream ends after a final status.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>Cache-Control</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The server always sends `no-cache`.

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"text/event-stream"} value={"text/event-stream"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The `verificationId` query parameter is missing, or the organisation (or the sandbox) has no OpenID4VC wallet deployment.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

The `Authorization` header is missing or not valid, or the ticket is unknown, used or expired.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The wallet has no verification request with this `verificationId`, or the value is not a UUID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 404,\n  \"errorDescription\": \"Verification history not found\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>

The server has too many open event streams. Try again later.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 503,\n  \"errorDescription\": \"Too many open event streams\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read transaction data
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-transaction-data

---
id: config-read-digital-wallet-open-id-transaction-data
title: "Read transaction data"
description: "Reads one transaction data record by its `transactionDataId`."
sidebar_label: "Read transaction data"
hide_title: true
hide_table_of_contents: true
api: eJzlWN9vIkcS/ldK/WRLY2C9zumEougc25ewiWIrZu2HXUsU0wXT65nu2e4eMIf430/VPcAAg71KlIcoL2uWoX59VfVV1SyFJJdaVXpltOiL3wmlA6MJvEXtMOXvQaJHsJQaK2G8AOUdjBrPr9HjQI46n/VnPcwIpJoqjznMMc/Jg5mAzwiMnaJWDoPGonIexgSSytwsSHZgMAHlQTnQxidBwJGdkQXUbk7WwVz5DH4eDu/gotfrfNYiEaYkG/QNpOiL1OiJmnIE19GBx2D/tiQ9kMNdd0UiSrRYkCfrRP/Tcg+Hj1p9rQiUJO3VRJHlKPAoKOicSRV6ktFNhNRSkMUc6CXNUE+pIxKhWHmJPhOJ0FiQ6IsDIEUiLH2tlCUp+t5WlAiXZlSg6C+FX5Qs5LxVeipWqyf+sSuNduT4+Xmvx392oxlu0bTkK6tdAJitkGOnj8TFHqdGe9KelWJZ5ioNgHe/ONa8bHhWWk6HV9GPvah+Vs4bu2h37RXrdbhm/IVSz0nbMaLkISTJnoGB9mQ15utU7abUv2IeBut6jOWIBcEM84oA2+sfLvM5LhxUjtqegzeAUlpya/hjlKukpQbejOuwQn2Gvtk4UzUjx0ZfDfKjI/CZck1NSgcZrtM1SJZQAmlZGqV98Hlb4Td1gX+L24MD+BudopyrUKcEWSyXdc7qyJQ7DGNMudFTDrMDXEsxQcoBaqCi9AuIjsA8I92AvSEI2rQ5EYI0gTxuG9T1x4IMJHR98XBVM15B2sewZpgrGZijLU1t1fEjOvrXhWu4gdbi4sCL+LvK5kA6NbKtzaP/bls6HDxZmJFl9yXgFJV28dkzLWCstGQ0PzwO9/Ae6SrPR1uY9zVpU1sLNOipcG10xrQcwIncfek9OY8xoLdQv4uScFn5jPFP0RsLD8EBHOcEd5Yc6agOvHkOntaBZyaXZIGft2HesL7hIpRS8XPM7xqsFAl7j+T2cS9xkRuU3GhljkrDh/vb3xKYGAv0gkWZU92ACyJAHWsDC1NpHwdRjdIbOagJHqY42ygMdlsILFbLqC34hzqHDRDGxuSE+iAHIw7/lSpopaIMXUbu1Vpjr2blkHN2TaGY/1xGaiUbQOo2/QPF8k1dkJoql2GSyGA44sBK11TKDHDpG0HpqhiTbaP9F/Cq4LYoyoQryFFqtHTJOojCbNmlMQ5qI5FHG7OnKuVfbzxH5yFOiX0PVs115xPP9LZ5eGTeHGHoV2jkeHU389CE5Yld3C+1pstHdp2nFQtmhDLsmEv+30Vcz755qWqaIWuNvTKSRBI/XzeS8/TWrrSV3qZZaU/TkOeadUT/otdbtahvId+NiPgxMFlZedjs1GK1CtEfLns7Z4ByUOlnbeY6aYzJ9eFQL1/rGyEBY3mMHFvCC/Qp80jbaiYOE/HuH5yIjxornxmr/hfqfhea7/7RNbq5F2rmCmb2MFolwlFaWeUX4Xa8LNUvxB+f+B7zOOWTUtRXKEQOgpPNDngqEjEIg4EhKchnhu/XKQVE+Djsi+7svBsP2m59Tp/Frugy4SnZdfLL3HcbpX7GvdBdHhT/SrC3HEvboXtNhalDZdKzueiLzPvS9btdSYU5w1J11NSi9h1lxCrZV3BnjaxiMx5R85aGe49TnvNHxF18vO/I0zYH91yKsYLWmdiuxvGL+vKOSdze3pd1F6xHw65jl3eDsIjgdqFURjcnfj30Rjt6RhDNbF5ylJYm6mX9bmAUfYQRnGjjab0SqTxgUGJKpwlQZ9rZU9uHWvD7haksw3H2TIsfRnGEKj0x667FNHQtFagYSFeVpbH+P1vwNvGrn7Zf7aLeTNgeLBshKK2ZKcmrG6SGG80TKP5bbDannfsnLLiNHetqM9IdDNa338ltaJLBaVh82wV3lrNNY92dskfepCZ3nCXlgFNImmVcPXkimOHuC8tZEra5JBgLa+pi8/4qbbhXuZAej1qile4sxKtQe5jkZl6/naqRDt4+vr+Chys4+fA4PE1gcDP8L9xfn314HMLDVbQ2uL+Fd//uvXt/9h0U1ybtFte/Ng/RibEFesezK1cpaRdocV25JaYZwXmnd5C6+XzewfC4Y+y0W8u67q+Dq5vf7m/OWIY3GuXznRoIYEmTVpvsiUQwbcS0n/fOLzrvO+9YtjTOF6gb/vBrt4PJvN9RjaHyN3vTWLOJpxffDRdb2JwZ9mXN2J/E7Dy+LpuocJvusHa9qIblNjD37h56VqPVP1x8nxKRGefZwHI5Rkcfbb5a8ddfK7Jh6CRihjY0RiR45fizFP0J5m7/9Gnm4OT3enSfwl/1wrMVuDU3aybmwKSiL0Qinpm6W5b/1dNmkQ4Rxt9dpimVvqHhYE1ZNcfrTzdDPhErTlZzPDyH8VB/YO2t3u1PiugC/8sDrVXke+6nX2jxw+bn8clRgc10ir9mrPiG+D8Ww1qK
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read transaction data</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/sdjwt/transaction-data/{transactionDataId}"}></MethodEndpoint>



Reads one transaction data record by its `transactionDataId`.

The digital wallet of the organisation must be deployed. If it is not, the server answers with HTTP 400.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a transaction data record associated with a credential exchange.","in":"path","name":"transactionDataId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server returns the requested transaction data record.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionDataHistory</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The transaction data record.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the transaction data record. It is not the same value as `transactionDataId`. Always use `transactionDataId` to address the record."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier that the server gives to the transaction data record. Use this identifier in the path of the read endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential issuance history record that this transaction data belongs to. The value is an empty string when the record belongs to no credential issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VC deployment that validated the transaction data."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64s"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Base64url encoded transaction data strings that the issuer verified against the key binding JWT. The value is `null` when the issuer verified no string.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"paymentWalletAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Payment Authenticator Verifiable Presentation token that the holder sent."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data payload in plain JSON, for example the payee and the amount of a payment. The value is `null` when the request gave the payload as `transactionDataBase64`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data payload in plain JSON, for example the payee and the amount of a payment. The value is `null` when the request gave the payload as `transactionDataBase64`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the issuer verified the transaction data hashes against the key binding JWT."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>vpTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Presentation token that the holder sent. The value is `null` when the issuer could not decode the token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Presentation token that the holder sent. The value is `null` when the issuer could not decode the token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server created this record."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server last changed this record."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"transactionDataHistory\": {\n    \"id\": \"string\",\n    \"transactionDataId\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"transactionDataBase64s\": [\n      \"string\"\n    ],\n    \"paymentWalletAttestation\": \"string\",\n    \"transactionData\": {},\n    \"transactionDataVerified\": true,\n    \"vpTokenDecoded\": {},\n    \"createdAt\": 0,\n    \"updatedAt\": 0\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the OpenID wallet is not deployed, or no transaction data record matches `transactionDataId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read trust authority
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-trust-authority

---
id: config-read-digital-wallet-open-id-trust-authority
title: "Read trust authority"
description: "Reads one trust authority of the organisation. Give the trust authority ID in the path. The ID must be a UUID, so this operation does not read the two built-in trust lists that the list operation returns with the IDs `0` and `1`."
sidebar_label: "Read trust authority"
hide_title: true
hide_table_of_contents: true
api: eJzlWG1v2zgS/isDfkoA+TVpuzUWi8vF2Z53g22QOM2HwDjT4tjiViJVkrLjNfzfD0NKtmQ7bRe4+3Dol1iRyOHMMy/PDDdMoI2NzJ3Uig3YPXJhQSsEZwrrgBcu0Ua6Neg5uARBmwVX0nJa34YPcon+9eHq0RCk8l9y7pI2jBOkdxmtmiFweHwcDSOwGlwiLegcjRcJQqMFpR0Y5CKIXmmYFTJ1LZLoz0mldRZcwp1fQf/WRBh0hVEWVtIl/vtoaGHanQJXAqa9aZtFbLd6JNiAxVrN5YJsH8qFdDx94mmK7mOOaiTGdORVZRmLWM4Nz9ChsWzwvDkA8FHJLwWCFKicnEs0BBz/PjQJpCVPCzyNU11qw6BK2qtIcYMe0yVPpYAEDRIGkvQl97CIKZ4hGzDXsHUkWMQMfimkQcEGzhQYMRsnmHE22DC3zmmPdUaqBYvYXJuMOzZgRSEF20YMX3iWp7Rm9k705pe83/opvsDWJX/fa72fv+m3uuIifovveG92+YZtJ3SazbWyaOmAfrdLP02ACSSLZiljhLkulDgVf2RerJVD5UgCz/NUxh7lzp+WxGyO7dCzPzF25F9D0eFkUKIJyWl9Dr0718ZrtZBLVDAakjpfP0WKU4h+R2idSj6DsTaiDff+t5Yo9XCD2CB3KCDhyyrQQgi+GkZ+5VfiMPIPa11AzFWVwxEUueAOI3B6sUhJCRCYovOisn2W5mhadduqDLWE3t8NpQrvY0xRFRkbPLOb8cPo3+NbNjmEebzOsYksWR+gqQKPxzHmzsK0lDKFM3qC8QP0eu/hba8ftqLwm89Bq3TdtKM6fxsxn/Pf9v+tDiF8Srlfy4jbK0SyolBdpfXf/jUe3xH69PsAj/e3DUGlqiB0XGSoXFPbxLncDjodw1fthXRJMSssmjLF2rHOOjdP161YK6uNk0XWwVXc8nJbJLVjcG47CZFLJ+NS+dXj2/ZLlhIAofp8y/4/eIavhHy9dkoLXAFmuVtDkASrBAMZhZgnEEJQAlU3tA4WFNpKA2ly4KdH8AwAt9I6UlZIy2cp1hN2pnWKXB1p/ETnTqluTktXHKaqtFDJ88lDWVNYFL6ExAZ9PvCUNF6iCZkRZPhaXiOO14t/uuJrW7IiTOc8tTht2OhfbSNWVoQrVzNNFdkMzala9AJOZmgdz3I4kwosxloJe16hfcLaFSc9FtI6NCj+nt7dps69d5fvur3e2253G7HgzP+x4im3DjItyAn/Nd23dYJ9JhooK1dVFcrkqDunbm8tHCeHwg6Ya7KlBZSDvnPZ0H+XgWG/myrr4tEYba61IOX887AG9ORbhLffvXeZVA4X3mc7qC69f4/En6rru4z9JxcgVV442HVqbLv11h9Td4MSqWu1+04p8jVj5XvB6oNBq9MligjKitsQkHBadRw+geOkLXuBQyf0fmAnPKoSp79QHEHz5oeOz5FyaBRPfduBBvwxBxhtI2YxLkJv+rxhV7n8HelxQu204wsaUlg51kCYa+DMTzbDy0/X5yxigd6uVJxoQ8Bk6BJNY9ECPS40IQxYZ9nvhDmpI4K0VsiMjs5RSdEJbL8L+s7mcJjYMtKVLDk1OA0x06WhVOFMWus6BGa6xXPZlgvDlWtLzbbRoYA7o0UR+zR8Rcy3JDw4vqB24ZXtNnw+VGSy98ADBWKIn8oPu0Dg4UU5dgUX7gevEqa/fGAfkdbV3Qg+49pXFGoI4qOBsWyLpg05UwjH7MbJ3OBcvqAIBWkadIQpnCntqjmey9RjkPMYzyPA9qJ9IHYA5caf17owBEfrM65/mbYZRaNUc13lLI99zmLGJQFpizzXxv1jD97Ofvlh/6qJet1hB7DsNkFu9FIKtMAh1pRmDkHSL3WyjaY5RL5vrz75horIE653nZaFkbUFVzHC2UefIqNz35md3nhn0O6O2KXV3Tlp5HSsU0tekhbIhahojy0pI4BpwWmQ1hYYQaJTEWYo3+utoUy0WiNoobDePY4rwY2wLW+v5MrBPNWr8tajRNpr+3RxDZ+u4ey3p/F5BKOb8a/wMGz99jSGT9fhtNHDR+j91O1dtN5ANtRxJxve1pvPMNj7OSyVMSrri2IVuTmPE4R+u3vkutVq1eb+c1ubRafcazu3o+ubPx5uWrSHJjXp0kYMeLCqOaTKCCobwe39bv+yfdHu0d5cW5dxVdPn3t8bNQn4MKFqjPLD3HiVZcjhi+vkKZeK4PP+2pQl/pkt++HeZC799NUo8+HSTIUOtVnqWeQvh5o3R5OIJdo6ErvZzLjFR5Nut/T6S4HGMxT1uMbnUeCD3WDlB5Kv+OzsvuT5c/g/um876YGKHdR61/IPGIvYZyKP4/u47WTXw3vMwrIrfx1RE3DUJW3rvP7hZswiRuA0+emz56fygaSfVO6QqoIK9JcY9eSWnymhf8f1L7vl4curG3b0GFYTVDS+/AcKWuH4
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read trust authority</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/trust-authority/{trustAuthorityId}"}></MethodEndpoint>



Reads one trust authority of the organisation. Give the trust authority ID in the path. The ID must be a UUID, so this operation does not read the two built-in trust lists that the list operation returns with the IDs `0` and `1`.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a trust authority of the organisation. The value must be a UUID, so the identifiers `0` and `1` of the two built-in trust lists are not valid here.","in":"path","name":"trustAuthorityId","required":true,"schema":{"type":"string","format":"uuid"},"example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service found the trust authority.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustAuthority</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust authority for the given ID.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the trust authority record. Records that the organisation created have a UUID. The two built-in trust lists have the identifiers `0` and `1`, and you cannot read, update, toggle or delete them with the per-identifier operations.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ETSI_TL`]"} schema={{"type":"string","enum":["ETSI_TL"],"description":"Type of the trust list. The service accepts `ETSI_TL` (ETSI TS 119 612 trusted list) only.","example":"ETSI_TL"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the trust list. For the `ETSI_TL` type, this is the HTTP or HTTPS URL of the trusted list document.","example":"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the trust authority. The value is an empty string when the create or update request gave no name.","example":"EU Trust List"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this trust authority is disabled and not used for credential or verifier trust validation. The two built-in trust lists always return `false`.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was registered. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was last modified. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"trustAuthority\": {\n    \"id\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"type\": \"ETSI_TL\",\n    \"value\": \"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml\",\n    \"name\": \"EU Trust List\",\n    \"disabled\": false,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation ID is not valid, the wallet is not resolved, or the organisation has no trust authority with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read verification history
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3

---
id: config-read-digital-wallet-open-id-verification-history-v-3
title: "Read verification history"
description: "Reads one verification exchange record by its identifier."
sidebar_label: "Read verification history"
hide_title: true
hide_table_of_contents: true
api: eJztPOty27aar4Lhn2PP0vIlTtN6Op11badHaU7jxk7yI/aYMAFJqCmABUDJOhnPnKfZB9sn2fk+ACQoUpck7e7ZPduZ1BJFAt/9Dn5KGDe5FqUVSiYnyVtOmSFKcjLjWoxETuEHwh/zCZVjTjTPlWbkfkGENUQwLq0YCa4HN/JG/iRmnNgJJ1mpueHS4sMX/tkhy0ipVcm1XRA1whvdcimRyuKCmYhuwjWvJ5wYrmdc483TsrLckEzz3ytu7MVjKTRnGRlpNXVb88cyI3lBxRQ2yWbltXrg8q27PyP3fKQ0J8ISKs2ca5MSo/DJGS0qToQhtJjThSF5pTWXdkCGljDFDQJZw9AGYXEtpjxLyXwi8gl54Lw00Zo1cFZMeUDdcMkIIIpE8rgK01wixoqiIJrbSktDaKC9nVBLKGG84JZHt2s+VTPOBjcySZP68pAlJ0mu5EiMgbfnYiwsLT7QouD2TcnlkL2PGP1XYazSi/fPkjQpqaZTbrk2ycnHT0ty8k6K34FatQAEtNaJzYAghsL8kUKSpIkAiEpqJ0maSDrl8K137SRNgGsgMsmJ1RVPE5NP+JQmJ58SuyjhSWO1kOPkKU34I52WBVz7ln+XH9Dvjvee3b9ge8ejo3zvO3Z4uHc0ek4P7g/zb9kznjzdwuqmVNJwAwseHRzAnzbhInkeqUqyzURLUuCf5dLCarQsC3/n/m8GlvzUxUHd/8ZzCzx0VBIOoFmX030PtQF+v4GhtU2wmuYPznagYJ2TkdLEPU7vC04uI56QHXfP8fvL3Rb6aaMtp5WdKC3+7h7wGkys6pJMc1MVtmsvnObwGdeLJakShjiqEcAKb6hVJgU0eWlJxvLTUtSmg0rmL11qZVWuimxATpuFUTEnFAyFV/wFt2SiCuYEnk9LuwgmQWmUZaD9Cclukpskw4uUOAFMSXYQrshqes91SrIRLQwPV++VKjiVDixZFYX/QRLHSeK+UK3pwhmFtjSsUJGOJiwLxOep/oB4ryCMR51uUn9qJ6Q2PsBvzSlLa4MHjJ3RQjBqecs+ACHw7pzDlpScn5HTyyEJSumJDgr1uaqdJmILygyl5VrSImhERCKUDdvI5pQ+cEPmEy7BFYEqchMhMyC/qMi00xzk0URUHJB3Zg0NrSKUMc1Na9EW4t98e3R4f3x/MHp+f5gf0WfsmD8ffUNfALLeaf6qzxTjm/GuVXmFyr57OyRc5opxhjz49S2BL4QJUxZ0ASxlnJekEPLBmRRQGq7/YsgcHRUxOZUG7ssLAUYGCWEVEVJYEeQgJgYZFWo+IBeockjmygg57ojEVDFuyE7G8jtaigy28J8Hv81ttjuIyOHRubLUbkEUvC2SY0AcoNxArJRUhqMc50prXjRC7mg5F3biLzgUeiDcDNzLqig2QYJsU5qUdFEoyv4oYsZcuqrup8IY4dzYej/0QdOyDJrUGNWWU2nWq22gM01OjNBBnJ/9+jqEIEoWC2KqslTackZ+r8APjJSeOmMCFuTX1x3qeGxzqrXAsHAVEHVoueSQvLWecO1skvM/LfPpgzwfg7ZFm/ERyj2GiFRbA16ojl79rQ43sB2SqIItBY/nw5dtoIPxiBefUsYHBKLGtqFB8zLmzp7lmqOVo4UJxHbKu8nl3JnPYP5qeLssRxSn1EfgK+ELgYQPCKdcWtP2ZFwPyM8QBwCPGhoaJO2gg1xDubutnEXHf7YQPG/44H0HhCwNsqOqGImiMKhTYWWl76a07AadpxADwDbn9Y3kb7QkXFoU4SktS1BoTvNJsDScRbRDW2sNKZSXTyER5BXRHRDHY4/hB8Tolk/N5hAVlI9uYcDOGtDcI4GIU2rzSRv2HT4YD0j229zezfI7CJqzFAzTvxm2B3YpJdnUqLspU7m3UV/Gv6EsKxuTuI5kN3MWOLEghlphRoI7rmJGsxGOV1dvfrmEkIk/gnqhcJRKSAsM9TIesSkiHLiS9XwkFrxKDcydRLnYrK6/OPnBSI5F9AAHHunjHE06A2HicsYLVXLPTeOZ9urDNRHSCAbh3PtL+L7b1byvFhrZkff/DTLjof5zRSfvlZd6a8e1QfL0FKfWHwNLkCwenNtt79mGkt0kxMVXwqxyxl0Y2wa7Y0URkNsneMpYaivTBxWX1RTW8kbzDnb2VQb46nMRxC/2fSWXzC3QukzzB86S22VkX4sRzxd5wYkDZG3CdXIjDwd1dQoByk7IdZx6ML5NJOoi8Trjn1NwACGKrX38UbRXwNbv52P3ttcdK5tCYAgRveQsXZ3pD27ks0E78gh0a2+AQRBnraiY3Fe25coJEwwrSBC4UAJVPEwnVwR3C4wWj5f3Rwb53T1CGGyts6G0VeThGgoGOTcQ5QvroqQmK2vJEQT27qFYI3ze31GJt1gE6ZUNf22Vt46lI59wl2CB6i9Kq8aalhOREyPGktpKc5MuGwYvlQFRTzEwqFCGNYSOqZDGUQkjahdoe6hWxLZox3LNqeXsNDburhrSZxEescBqLJ2WZEdIYniuJDO7LmdxyXO7bIQx8Zwa4jfCTauS/fdsWlBjIWlCDneSo8bmb1OV6bqWVTkD5pe1tVyCzWkegKKwOPxGj6kUhn45GI2VUdFazo2F9J1tgMWpWjeuPVPSgmi5yI9byqilPuK4BydGg6EiLyHPAp/+C53ytA5k4dNYET6wg7wJWlcEp662/PkkiGEYIBDnw3MwggALUfeAA/AEXH9eCDAoNTJiROiMigK0tuvCEKLbJcGJQNwYfVPGUCpocRmhCqXxp04Oxl0FJ47g6rKWN4a16nubMqElNjwwsXCBykgVhZovJ2c+IBuE3LiSVhTxyr5b0652OGO9Bb5NUb+vuL0i7o3QC54G+0GAGW7kyxBQ8Q64aYdqnDmFNfqLLNQ8OHXsQd3vGqNuNZWG5mgfqO2t+a9m6TL2181iBIUN+0R6yrHBFxGfVRpDwt4iWw9YP1LDvznerCruvkoXrjwIe3iVscugbSAjciK4DE/6zylqd5U2YqEwpqIyj4KhJghv2SwfiaSgtbAG0Aef5tC/i1akIyxtL/npATl1rUfXKVCyHdL0Nw5j540VASgoC0mgcqjT4IV4gwQC5QtHyVPTs7pGAm2s9QL9ydHgoIELHgjA9UdyUaA8K+9QuTC8rj8yPhM5vwtLokkTDLV82/IzOVNSQv1neE7wwSaVCvb3Mi6NIWGyGPkMymdZgCrzWR2u5W3f16lbMKC+oFqngAHetrdAY0UtPR1rjtWpLxNjVB4a1miVAbvyW8t3KxwyXH/p3mZyr6hmEHNocHhCMjETrAp2sQnd17n/drN/i1A4A/JnjexvGgqAprS7s6Qh8fHGF9IUZQEBqKRyB8K6hAmaVRgKF8LYRk8NCYMDUSssALjwNj4os3QrRH2uaB0/nuCKyaEn2KETTiR8dgDbxK8N8foNrqOEaZkfjcMjEX7bTmUMsNlZ7xh6Hb6XilstWt2rwxfHLw4Onx8dHCzFPu+BYMIu/qQY6L3jR9Nz7nX5QZYiuNKmcVMnUi7XctmUw9FdqRMpzWeq8Sy2MkHCumJB5lpY9DKSzz31ob+wXUDlgs4hu4KW+BZO4MwFqcNz10TnLqfwMUOd53oybCoztKooTGie27tKC9gUyzJhvTtqLYgpwpAmj88PvrszVN4xacLXCTUT9B1umUtl7Fu/5DsttqgqvR3GgVcAB1uNzmWXytgQCvWXDv6oPlm4+2+f2YJt7UIY9B6nQgIYEzVfAzcYQcYLMeOas5MbuUcyzwzAOTtpbkQfOhOU/PX6+pJcvrm6bg9lYOM2i3mZofSrykKcB1UFN/HU3gJxX7+Nf5ozGCKg5NWHC7+KI2T0cI0JUTMfaX14dkb8+FNUBTfIGgw3oQtYA/rqw0UMLDlT05JaAZkCavK9shOSgS7D+BnOYFQyfG0NjrjQAlXSxOAu4/vFIK+iiqB6r5d3dqJVNZ74ArTlGgLtWS0YZmngpkObZSaGjXo5+KWb9WIV2YpIcpI0WZIjuIJErj/4qwHU6CP+ctvU2vRpZGc2Kt77YO2ip7Bt4ZBXkclNofI3C9Yj0hUaK6QLO+s46csir+U4K2pC1/XKleNVKN+UlJWZQMU0Sk8iy1ZnIsFZh/qq4ZZkMfwuNpli934bbC4e/RRNd8LofxqtgETWjc6/MjVoR+mI3FjM/EwQmHCzomRXz1kBRFLJfBv33Srs4kPOg2/nsYGYXBqIYEaam4mEMSOwgKXmM5dk4FgPtRYmAh2t4rG5zRCuMnp1glL6pWIhcRExZw0nV5VAhXGljnGlfS2010UPbmStWsYv6LedUS2otI5sdWi3zl7vZJLOxJhapQdRCW0w5nZnN9t1HheKroIdz8q92eFe7U9cv6GfFzDxQbGZUMnGZHq7c6/V3KCJcfi5+NFfhdQGmqulG5powm6ghxYG4lBaLIwwbthshGNa2PADId0Hc4cVG5iG6EK/HezuruXQ8S+GPGBSxAJy4AMkUSWFrp8TmtVIXoKZhRCrDkXBwgLBg8a/hTHuKZdhIq3UilV549GUHu8Jo/awv7sOhVDNHF69IYffHhw+23tBTqXkj+SslUb6aNsbIRl5t7Mf37wl2UX4HpxnNriRb6BOEeZ52vUKiApdvWJFENl2lr1y5cbElzkGVyPsXTgdhTObu/+BNn4eJ7QM1yhHCiytclurYxBRIesMCCLBtSo0uJF1P8A/vwfCDbYylm0cL4BNziZaTTlK2RUdUS3+EJK3WwY57rHFgNMKq9GGuwFbVNO9e4pZl0PVKWk9WosKoE3WEJaUWwSVgV71FM/SiJN7bHt0oqQ4YKJKV8ZYh0rP4JhHqCevXzHq1LN1vUrqUnaH7cI1imrTTmPvTy0dbD+9VP65Ds4PpfSZ2XSV79iNK0ObGXe9hfuvB0KvatkCd8gNmPEAN/ozaHit8Aq1qmafyE2A7yY5ITfJ9+6mvVcfrn+4SchTlmL8f73WWQz694t8aKtZOIIB2H70vNlCS525yshdaMe5IaDfizvsYMM3jJ7gQzATdxA6tC4Axb1xWFNq8v+liUFb9IeaDGfe1hgM/0xsL/587e+HqrNtgO1rVD/e0Ct/7sQBlN/VyDGAdcL7GSrP2l24NZNWe+43bPav1yyy4yCtQxooD2IdqjkdAjlJfdRj1002c99DE5YsBA8T0gaazI0bwNzCuz4/sIPV7yAD2SbN3UJhNytjrYNCFkKuiq68Ku4s6VKfttV62FbPrv7+5z/+A8jlpi3+Kc31U2MLfK/fXNQVly26H0PJwIO78yV2wjedOwgpT2Usued9hRcSN1T6AqKlKl4nMqqPLm2xQvy0S7TrivkVNCm2oMAH3MVtmS4V3X2jw5CJYIzjJLP3K5fnL017vzOlNBOyfd6j3/hcUmib1ffXM3rNxj65bjZLgcDZx8fDlCwOU/J4lJLF0W0GN+IUpukzQ0JaPuYaSypCDt2vx1BfeWy+1H2Sj4cHByn8O4K/zw8gmB+Jgm82pq+xezUieDcZcwmNBs7iUYD2sT0h86JC8+MxBIMa5BrQJUzlFY7Zf4Z5bUz5V3fxqTEqd9NGPmEXBtFDnnOtle7bAdonMCDSX7i5gMfcaSYxQsyBAiMqChgDgGeJAhWcCxPtcx6v8blbnnOLyxNciky5MSB7223v2PFSFL1lojBInfj+y1Jz5HUs1J6pNQEDq7927ZbI+NXRFrbGEX/mi4bZmwXjZ77oKSdCjcHNoZn61BVsjj82pt6PlbR3f7nlzPnL1qB54NADX6Sudeg0FQwgO3ngC2f8oJmVDYZYdTR138Y37jQ3qgilQYdUc1a6ObmSCaOwInH34g5GbR/v8oxIzpkJ67eK6bi776N1JsqaUcQrSUszUV9Z7jxT5abxT+LLu/GR+WYmYGkMTiwPWLeOfPdOMq6Ztew/8Nc5ZLd8TLIeE4+mduvRxXiUNZ4wXTGvtGqiKpR4l6Z2mmGZTi93qZHY3+VY1TDtDUCWuhNRab/jqbsTLPU4SWeqo298oXNkoO8EuxvRn3Dq6wPw7dgdvd/63Hy8B5pVz9GOtb7dNCPaPN312ZFjPsbJhW2cQTMb/iOFCj2cF6lPlSY+Tuwm8a1hW7Bv8kGquXTRkM/kQnGS8bJQC+w8iPCaC7QxDEf14Tj7upeBTPyJbjhIWUBys+pYMlicZT4d/gvz6Z0MnT9nKlqkef4vLcL1UXrf3nPhWZtGEM7wvNI47vPxU3Jaip85fLyFV3FYOoYXl9Spm3vlSfPeibPdJK27t0CUKbcTBW9LGXMbziOdJPuzZ/uuV7TvtWbPac2+S+D2DfttbvdjBdmfOMu0/6lfD57AUCJafW9WOedT5bEGa6mL5CSZWFuak/19xqdqD5IqMdZU2oFQyVO6vMBl3ctYtcymFa4sHWMg3/+4cT8vA3LbsMP5HhSmwJQm3XAX/FtbHD+b97a0ctNuhedy6BpDS+2c6/pVOz5SyFrrwFFr2KZOcUvNR+IxJAKZg5FkZEcqf9zeaioKpEFJc76burMD7WVPiH/w+4WqNJBj74EvfshcfCLkSAUFpjkqMJ9SAYT0J87/vSFejb/4qbnUpnrMsCWy1A+FCreJTzgJ+DutQ6zWsYzlV7TE9Y1hGBjeeYP6MtzFlO4z3+0SCiPGv/wHqyYSnjHeR/3dzzXCEWMYlU4x0HUn8FGtFrW/io8euNEqY6lkVDOzh/hiT3aEHTlkrac0Qgt9j/dnZAfOkKZkeHH9klydQ82KvD9zuzVNvOdkeq7y/en56+4ZBUxfC5Fzf/QgSG5J8wmHyegO6+bz+YDizwOlx/v+WbP/enh28cvVxR48A0P0whYtGUBihaw5aASYDcf2o4Oj48GzwSGWspSxUyojePDcfstve7O0rFWRj/n/13/9H3n9l7e1lj/a/bKgAsudKJSfvGP7mMyeuTdLjQRmrS3nVreGwVUxNzoVSwR44lqaTlZkXreQ/UDT6WPy6RNU+d/p4ukJLmN5Fhx1muAgBdY6wBMKA59ZcoK1uzWCuvPWhzu75J/qVWS9hA+eTwK1UCaSkyRJE8i4V76q7Om2zmqQNu7mU3wTULRMJyh8ikOZny6uITGvWqfBaSlcru8/wOq9IC47YwcC/B9iht5HvgeT9TNf/FDf7n5Z+UAdALi7gWCQ0P0X3YTXcw==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read verification history</h1>

<MethodEndpoint method={"get"} path={"/v3/config/digital-wallet/openid/sdjwt/verification/history/{presentationExchangeId}"}></MethodEndpoint>



Reads one verification exchange record by its identifier.

Give the `presentationExchangeId` property of the record, not its `id` property.

The server recomputes `requestExpired` from the `exp` claim of `vpTokenRequest` before it answers, so the value is always current. It does not recompute `requestExpiryTime`, which keeps the value from the time of the send operation.

This operation still returns a record that a delete operation removed.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the verification exchange record. This is the `presentationExchangeId` property of the record, not its `id` property.","in":"path","name":"presentationExchangeId","required":true,"schema":{"type":"string"},"example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server found the verification exchange record.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>verificationHistory</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Verification exchange record. The record tracks one OpenID for Verifiable Presentation (OpenID4VP) verification, from the Authorization Request to the verification result.

The server returns every property of this schema on every operation, except `dcApiRequest` and `dcApiProtocol`. A property that has no value yet holds the empty value for its type: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.


</div><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the verification exchange. Give this value as the `presentationExchangeId` path parameter to read, delete or revalidate the record, and to receive a DC API response for it.","example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier that the server makes when it stores the record. No operation accepts this value. Use `presentationExchangeId` to address the record.","example":"6821b4b0f5b1c2a3d4e5f6a7"}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenQrCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID4VP Authorization Request URI encoded for QR code display or deep link. The holder's wallet scans or clicks this to initiate the presentation flow. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State parameter for the OpenID4VP Authorization Request, used to correlate the request with the response."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Full OpenID4VP Authorization Request URI or payload. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wrapper that holds the Presentation Submission object of the wallet.

DCQL is the only supported query form, and a DCQL Authorization Response carries no Presentation Submission, so the server returns `null` here for every verification that a current presentation definition starts. A value is present only on an old record that a DIF Presentation Exchange definition made. Read `presentation` to get the credentials of the holder.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation_submission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

DIF Presentation Exchange Submission object that maps the credentials of the holder to the requirements of the verifier. Kept for old records only.

</div><SchemaItem collapsible={false} name={"definition_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Presentation Definition that this submission fulfills."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>descriptor_map</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of Descriptor Map entries mapping each requested credential to its location in the Verifiable Presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the matched credential (e.g. `jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Definition that this entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression pointing to the Verifiable Credential within the Verifiable Presentation token."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>path_nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Nested path descriptor for credentials wrapped in envelope formats (e.g. JWT inside a VP JWT).

</div><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the nested credential (e.g. `jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Definition that this nested entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression pointing to the credential within the nested envelope."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for this Presentation Submission."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`request_sent`, `request_received`, `presentation_pending`, `presentation_acked`]"} schema={{"type":"string","enum":["request_sent","request_received","presentation_pending","presentation_acked"],"description":"Lifecycle status of the verification exchange:\n1. `request_sent`: The server made the OpenID4VP Authorization Request. The exchange waits for the holder.\n2. `request_received`: The wallet of the holder got, or scanned, the Authorization Request.\n3. `presentation_pending`: The wallet started the response but the verifier did not get a complete Authorization Response yet.\n4. `presentation_acked`: The holder sent the Verifiable Presentation and the verifier processed it.\n","example":"request_sent"}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Result of the verification of the Verifiable Presentation. The server checks the cryptographic signatures, the credential status and the presented claims against the DCQL query of the presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this verification record was created."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this verification record was last modified."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation definition used for this verification request."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VP organisation that initiated this verification request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Contains the metadata describing a holder. For e.g. Name, location, logo e.t.c

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder. For .e.g. DID or Name obtained from client metadata if available."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"presentation"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Decoded credentials that the holder presented. The shape of each entry follows the credential format. `null` until the holder answers."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenResponse"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Verifiable Presentation tokens that the wallet sent. The array holds one entry for each credential that the Authorization Request asked for. `null` until the wallet answers."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data confirmed by the holder during the presentation flow.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data confirmed by the holder during the presentation flow."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base64url encoding of the transaction data that the Authorization Request holds."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential issuance exchange that this verification started, if the flow issues a credential after the verification. Always empty on the response of the send operation. The server fills it in later, when the issuance flow starts."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token from the holder. Present only when `responseType` is `id_token`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token of the holder.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the ID Token of the holder."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement record that this verification exchange created."}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the dashboard user or individual that started this verification request."}}></SchemaItem><SchemaItem collapsible={false} name={"requestExpired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `exp` claim of `vpTokenRequest` is in the past. The wallet cannot use an expired Authorization Request. The read and list operations compute this value when they answer. The send and revalidate operations always return `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"requestExpiryTime"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the Authorization Request expires. The server reads this value from the `exp` claim of `vpTokenRequest`. `0` when the request has no expiry.","example":1747015200}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Validation result for each credential in the presentation, with the signature check, the expiry check and the revocation status. The revalidate operation writes a new value here. `null` until the holder answers."}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme used by the verifier in the OpenID4VP Authorization Request.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI the wallet redirects to after posting the Authorization Response. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`, `iar-post`, `iar-post.jwt`]"} schema={{"type":"string","description":"OpenID4VP response mode determining how the Authorization Response is delivered:\n- `direct_post`: Response sent via HTTP POST to the verifier's `redirect_uri` without encryption.\n- `direct_post.jwt`: Response sent via HTTP POST encrypted as a JWE.\n- `dc_api`: Response delivered over the W3C Digital Credentials API transport without JWE encryption. Compatible with both `signed` and `unsigned` `dcApiRequestType` values.\n- `dc_api.jwt`: Response delivered over the W3C Digital Credentials API transport encrypted as a JWE.\n- `iar-post`: Response sent through the Interactive Authorisation Request transport without encryption.\n- `iar-post.jwt`: Response sent through the Interactive Authorisation Request transport encrypted as a JWE.\n","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt","iar-post","iar-post.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifier Attestation JWT sent to the holder, proving the verifier's authorization."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual that the server sent the Authorization Request to with a push notification. Empty when the send request did not set `individualId`."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier of the individual that the server sent the Authorization Request to with a push notification. Empty when the send request did not set `mapperId`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement that gives the terms for this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Data agreement that gives the terms for this verification exchange."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce used in the OpenID4VP Authorization Request to ensure freshness and prevent replay attacks."}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiProtocol"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openid4vp-v1-unsigned`, `openid4vp-v1-signed`, `org-iso-mdoc`]"} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier returned when the presentation definition is configured for DC API response modes.\nIdentifies the protocol variant used with the W3C Digital Credentials API (`navigator.credentials.get()`):\n- `openid4vp-v1-unsigned`: The Authorization Request is passed unencrypted to the browser's DC API. The browser can inspect the request for risk analysis. Use for development/testing only.\n- `openid4vp-v1-signed`: The Authorization Request is signed by the verifier's key and passed as an opaque string to the browser's DC API. Provides verifier authentication. Recommended for production.\n- `org-iso-mdoc`: The Authorization Request follows ISO 18013-7 Annex C. The wallet answers with an encrypted CBOR `EncryptedResponse`.\nOnly present when `responseMode` is `dc_api` or `dc_api.jwt`.\n","enum":["openid4vp-v1-unsigned","openid4vp-v1-signed","org-iso-mdoc"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcApiRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Request object for the W3C Digital Credentials API, structured for browser invocation via `navigator.credentials.get()`.
Contains browser-specific request formats for Chrome and Safari.
Only present when `responseMode` is `dc_api` or `dc_api.jwt`.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>chrome</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials API request format for Chromium-based browsers. Uses the `providers` structure per the W3C Digital Credentials API specification.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>digital</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital credential request options for Chromium-based browsers.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>providers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credential request providers, each specifying a protocol and request data.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"protocol"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier (e.g. `openid4vp-v1-signed`, `openid4vp-v1-unsigned`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>request</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The OpenID4VP Authorization Request payload. Structure varies by protocol:
- For `openid4vp-v1-signed`: Contains `{ "request": "<signed-JWT>" }`, a JWT signed by the verifier's key.
- For `openid4vp-v1-unsigned`: Contains the full Authorization Request object with `client_metadata`, `dcql_query`, `nonce`, `response_mode`, `response_type`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The OpenID4VP Authorization Request payload. Structure varies by protocol:\n- For `openid4vp-v1-signed`: Contains `{ \"request\": \"<signed-JWT>\" }`, a JWT signed by the verifier's key.\n- For `openid4vp-v1-unsigned`: Contains the full Authorization Request object with `client_metadata`, `dcql_query`, `nonce`, `response_mode`, `response_type`.\n","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>safari</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials API request format for Safari-based browsers. Uses the `requests` structure.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>digital</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital credential request options for Safari-based browsers.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credential requests for Safari, each containing data and protocol.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"data"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSON-stringified Authorization Request payload (Safari's DC API expects a string, not an object).\n\nDecoding it yields the same structure that Chrome receives in `request`:\n- For `openid4vp-v1-signed`: `{ \"request\": \"<signed-JWT>\" }`.\n- For `openid4vp-v1-unsigned`: the full inline Authorization Request object (`response_type`, `response_mode`, `nonce`, `dcql_query`, `client_metadata`, …).\n"}}></SchemaItem><SchemaItem collapsible={false} name={"protocol"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier (e.g. `openid4vp-v1-signed`, `openid4vp-v1-unsigned`)."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the OpenID4VP Authorization Response must be encrypted as a JWE. `true` when `responseMode` is `direct_post.jwt` or `dc_api.jwt`. `false` when `responseMode` is `direct_post` or `dc_api`."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `false`, the signature stamp is hidden in signed PDFs."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Page coordinates of the signature in the signed PDF, as `[x1, y1, x2, y2]` in points.","items":{"type":"integer"},"minItems":4,"maxItems":4,"example":[100,100,200,150]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>files</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of files generated during the verification, including signed and unsigned PDF documents.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential associated with this file."}}></SchemaItem><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Error code if signing failed, null otherwise."}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Detailed error message if signing failed, null otherwise."}}></SchemaItem><SchemaItem collapsible={false} name={"signedFile"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL of the signed PDF file."}}></SchemaItem><SchemaItem collapsible={false} name={"unsignedFile"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL of the unsigned PDF file."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the presentation definition at the time of the request.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the presentation definition at the time of the request."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"verificationHistory\": {\n    \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n    \"vpTokenQrCode\": \"string\",\n    \"vpTokenRequestState\": \"string\",\n    \"vpTokenRequest\": \"string\",\n    \"presentationSubmission\": {\n      \"presentation_submission\": {\n        \"definition_id\": \"string\",\n        \"descriptor_map\": [\n          {\n            \"format\": \"string\",\n            \"id\": \"string\",\n            \"path\": \"string\",\n            \"path_nested\": {\n              \"format\": \"string\",\n              \"id\": \"string\",\n              \"path\": \"string\"\n            }\n          }\n        ],\n        \"id\": \"string\"\n      }\n    },\n    \"status\": \"request_sent\",\n    \"verified\": true,\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"presentationDefinitionId\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"holder\": {\n      \"name\": \"string\"\n    },\n    \"presentation\": [\n      {}\n    ],\n    \"vpTokenResponse\": [\n      \"string\"\n    ],\n    \"transactionData\": {},\n    \"transactionDataBase64\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"responseType\": \"vp_token\",\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"dataAgreementId\": \"string\",\n    \"userId\": \"string\",\n    \"requestExpired\": true,\n    \"requestExpiryTime\": 1747015200,\n    \"presentationValidity\": [\n      {}\n    ],\n    \"clientIdScheme\": \"redirect_uri\",\n    \"directPostRedirectUri\": \"string\",\n    \"responseMode\": \"direct_post\",\n    \"verifierAttestation\": \"string\",\n    \"individualId\": \"string\",\n    \"mapperId\": \"string\",\n    \"dataAgreement\": {},\n    \"nonce\": \"string\",\n    \"dcApiProtocol\": \"openid4vp-v1-unsigned\",\n    \"dcApiRequest\": {\n      \"chrome\": {\n        \"digital\": {\n          \"providers\": [\n            {\n              \"protocol\": \"string\",\n              \"request\": {}\n            }\n          ]\n        }\n      },\n      \"safari\": {\n        \"digital\": {\n          \"requests\": [\n            {\n              \"data\": \"string\",\n              \"protocol\": \"string\"\n            }\n          ]\n        }\n      }\n    },\n    \"requiresEncryption\": true,\n    \"signatureStamp\": true,\n    \"signatureCoordinate\": [\n      100,\n      100,\n      200,\n      150\n    ],\n    \"files\": [\n      {\n        \"credentialId\": \"string\",\n        \"error\": \"string\",\n        \"errorDescription\": \"string\",\n        \"signedFile\": \"string\",\n        \"unsignedFile\": \"string\"\n      }\n    ],\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"presentationDefinitionSnapshot\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the digital wallet deployment is not resolved, or no verification exchange record has the supplied `presentationExchangeId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read verification
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-v-3

---
id: config-read-digital-wallet-open-id-verification-v-3
title: "Read verification"
description: "Retrieves a presentation record (V3) from the wallet of the holder. The V3 record adds DCQL, transaction data, trust list and response encryption fields."
sidebar_label: "Read verification"
hide_title: true
hide_table_of_contents: true
api: eJztXFtz2ziy/isoPiV1JPmei2tr63hsZ0aJJ/HEjvOQuCyIaEmIKYABQDsal//7VjfAO2XJudRu1e5LIolEs7vR1w9N30UCbGxk6qRW0X70HpyRcAOWcZYasKAcx0vMQKyNYE8udp6yidFz5mbAbnmSgGN6Qt9mOhFgBux8BuxiJ1/BhbDs6PCvkx5zhivLY6InuOP4S2YdS6R1jCvBDNhUKwsMVGwWxBObSEiEHXxWn9Xv8gboSaMqa0MxYqnRKRi3yFnxz+4xpR2TzrKRrNzkOTQQA9LD33IRXWaUZW7GHbvhSQaDzyrqRcUdQxHtR7FWEzl9D1wcyal0PPlISniXghqKCzByImO6+2In6kUpN3wODoyN9j/dNZT9QcmvGTApQDk5kWBy9rs0L9WDKpeWSfszlBP1IonMpdzNol6k+BzwW41m1IsMfM2kARHtO5NBL7LxDOY82r+L3CLFFdYZqabRfS+Cb3yeJvjbzmSbP4+3XvRfjnehvys2ef9F/GzS34K98TZ/KXbj5zvR/SVS94ZgkeD25ib+V9fdeamLct86NYcSxVo5UA7J8DRNwg5tfLFI667NvB5/gdjh/nm1SM9JlTrRSpJ3E9rY5ro6s6eP3898m9Bp4mvLtAJGNnbEJtowb2h8nACrEX/i79m9OH3KDjI300b+7a+8h68ZWOetu3wWm2rXI+drqa95J15hYx5fkzOSyV3sMDvjKbBrgNSy0U16rq9BjRi3jCvGjeGLHrO6KmrMFZISbK4NujNXJNwyiaRinFmppgm0JPJGEthp2QPcgFk0rF9a5jebaRVuuNjJBSwcfcAOynWkhhm3TGkfFdgCHC3xJgfz1C3CFdwadCk0h302+hx9jkb0I2feH3pstJn/orL5GEyPjSY8sZD/OtY6AdSdEmyksiQJFxTzxsX8F1Ktj091G5Wi7YRNexwqB0bxpLDFByMQOlDpw89ebG+Nd8ebk73xVrzNd8Qu7E2e8efo6Y0osZKPJQFQ2rohPugqHyz4JRUqTjMDXNSindPe6prS9VChTjMBCTioLKmLvV7oqqvg+Fs842oK66hi2NqCm0ouYRBIseCS/iLKP8T8qa5th96cbhOaSeu0WeQ7X3sWmLrML+BlvMlf7vZ3xs9Ff3eyHfdfiq2t/vZkj2+Ot+IXYgdQZk25752ZciXt2pvfllj4hJpvtIA00Ys5Rh3vg8HlmmLm24Wc/DAPVQr+sfo25JZO+2vu+Vk2nktrQ4J4RFooFxaO7h90NHxVj4i5WTGbQlzsLFnCnKee19gAicYTW2c4N4qQv1G7tmUFGFCxZMtLCq2SBfuaYbScaDP3euGKyd8NV24gdbGUfMz6hMKp7FsStFnMjZFAUXWJHpqJI4/rISrOwPiAa7N4xjhJBNZh7PbBuLQTL8DtDBTF0cxZKaDCs5NJ4jlHppfqW8BEKknK7gi85dWrtWLww1VfSS3Pw5i6ShuZZMlEJpbsLyeszdWcp+1a6ai4zv7kKQOFNb4dsGMez+jbgk0l1vzEhbb+sXpCeTmoFUTFpvKIvCRnYxQJwlOawpLSwdyuLrDQurhbrbzDkhW/JNfhnLt4VuO1RzYSghobfbl1VzfxFVZ+ox4bifj/rOh/uXUjTAOjudVXc6HjEen1+7ZxqNLMsYrOy/3zusbgYie4AxQ8sM5e+ZjXZ+/ennI3Y/ANzcQWdpFqiR4cvHrtLWIO67SCgStFW7w6ZL31poBrWGl2pOJqyJHkaKBuINEphD2q7wRnrz+e++ru4hQ/D36+Naim4f4nGUNg7t9gE/m+DKL7+2on9ynXOEkb2Lhc9551FLS84FuSA9os1sNsK/gRH5f3vSi0IhWelsWislOtM/ug69iyPQrpiRJNreTKOzl6cChfMKT6LSdLxAhc2aCCZnfvxu01CFxYpYtxhVqQTDmZNBo20W6LycKs4y7rUEIvApXNUc/VJVcpKOEv137m8TWI6LKpuBM5gXgRJ8D8YzoT3ANF/f5ntTWo4xg5B6N9kjwIOEf0yEKC1VIR/aWa1mIRliJF5b98T5sV0HaTAxI2PL+25Q+QzfvqotTgcQwpur10voYoq+1OhaMh+7VV7wo9Ysu9RojFjHyh0/3Y1jbkHMYzIJihXgmylFsLoo6YFQot+mXLeHLLFzaUaHlH65dZMDdkjC4U7746S7jD5rfBa+hSbmE80/qaGUi1cTZUrDZLXKvgvuCJFNIt1nD0IqdxISiC8OS0knBQee0ggOTzPgMZ6PTbYMw1N6uWVyVaEIgEPVs5VdxlJui/58Pzt1Sahf+l2B8DNzoohy48ekuoaP5lO3KThhh15riD1YmAbgvPDbroDnnN1oR1An+FDLfSzTqpha6DOopGD02IFIUO+tnd6nobvCdeTLbjl+N+vM13+7uTzbj/kj8X/a14e7zDd8UePJugDuJEgnLrtJ2HdGcH7FKwVEDsnVppVlIf3g8JFmJHwyPaDgNCGojdByNXc/M+3ExkHn5wTf2ptsEQliibgqq0SDdwRUTWZMrvP4n2gIHUOJpCYGiSJckSgwoCerY6QiVFvNy+/ZIxwiUTMKBiCIJ4Cd9/t5rbRuiNGQpgeAnW2Ug/IapUe/sgGZ84/KUmmtExYDzvrgmqPxwVVdZqwdZpmJsG3iOEGCOR5IlElrCaDSDpgB1TQdPeHEq4AVcgPALDlYxn3wtUDBge5GDl/zX5C5d5sLVRNmN0jRMu5zXUhHSmtIrXCHeHeJqlp4anMxkzWvQoT8vqkTqYyBtYsN8kFQrUTDlNOHw7yU8M2JlPJZpZp1MM4wlf1OPc37vxxcl7+/Vl+ubb5tvpX8+Pd2avp1V7PychVwn7DgVi24PN8jwPF6xw46FjDpKkBrXdkpcE4JZOHioF6k16RZU4lfzFRwE3Moar/MnUCpRb+X2YYDvRB/6aJyTxTFsIFtRAKQdlhvgTHMfjz9Xddn7nI9NDPUjM9G0wHql871YpeAPjY5j4w5jiF56mRheYUAPcqbfpXqq3dFC4MlZIi4bH8FixDT7f96JET/Va4fTD+5OcAK5ZQizm68Wwk7y4wjQqBLbTnRRjfQPmsfzRIibnfNotc23hSg2W3zqINZrlytaUqq3opSJQ/TmXjXzQUV0vw2AqnfGytojK4R/rYdeGFL8Pt6EMU/F7n1NK8KZyqYRu2Csqwky10ujCm4mMB50zrDU6k2cv+KztxpHK2tHb5a8Kce3TDldPAo9FVSpgHd7ZBAdAsI87h1XLKRfU4loC3IcnCrT5GW/m+zPtZlBFJAMuaBu6Osu8zTyqRewIaXGisYShGoEE4k1xDilBxz9blJt4DXi0U5fsPKTkKqvD4/NX7Oyoj7xeHP58doWO3VolxJGOM3/w18Xl2Tu29WJza6e/x+ZHOv75fPqN/LVmUapZm18iRiMVEFhaCxOE2lZmso5CTdIYtGkMba1sTbntqNllKEqKkzmFfCbJophlQP2MuYVnu5lJQiMQckQV7Qt1iVcH8VOpXVp9UR2Q8bV+Q+IjiLUAMaI6c6Zv/Uk0Eq6VSD70dS79RchToN6amuus7sBCODa2jdKOhkdIaTzxTsgdP5gaoC7mB20c1cRzWiur0qGrnDM6MPNQKkyxBlGhwemaevDFHEx5cirFgXNgW1XJsroOF7FTMFYrlqe9QN1zX1J7EGuiRC2pG/HAHBWeRN2n4nK+rl6Ctrk+1elqxk+NxgPYCaIsNhzu5K3pDwlVZeri+6HlfJgLdREAhR9hq45D57AznbvZnMuP0s3OcWD0RFr3/SxPdNZE5ekU0g92ZoZcLh9LDW6fWXcGBjvLU6NvpADzY45DYrBAkuU0A1jcPFjKCLGp2t2DFkfcHqh4ps062M0Rm4ObaUFzUNewoJTbyyl7TXCi1sWYXdbtln26kGL/GjAqftvbfEmdxfU6RTmiG22ElDjs4gPDt5x2AiPliBdNFT8Er/mT3ubJ4TKgw89jHmqlENcbHjFauObJ4GlrNmVUxVlGmCVHObIxqnLWzjvfE7tDekn5ItG8mAR7UIhBFeY+wznKdbAvD3YPj/zk5Ro4EB1M5Km4dNLcFjAOW0gmuUo9g1WTy+Hvq8w3tlT75ISuKmEoGOWV5epKKJt/nXE784fIYc2jcs5FznFlFZX/RX6sTe8VOEsTEZ7zBZ74FmG/axIn1NU5fPmjJaufv6v28kSWnXA1zRC+eIKN8dMcYl2R7329VWH20+UAZ81LCD601ZqNM5n4oFy9f1SWhnRaVjvhGuSDYMth4nWAaamsA+5zTfnawevb6x/T5Wk2TmRM4aqV6iwNv7xZVl8ELh46WSlELhDWuRaA1uIDcilIVS4QOYFjFV9gJW7PshTP89YqYlsjAgdb2y8Ofzvs/3G2vfcs6tH33w//xE/be8/w02Wrqn398ZiFafzqWx48mWoj3Wze5Qj+9NoWjlCI81AUL4kf5LTXGKn5eExbNueKT31RW3C2NC+v3q/WgUZ924SmOUhXeHt1+0p1Hx8e/dE/PguQduVA4Q0sSkSnS0j0E+z/u011RaKVtpC0SLAVTCbq4ObV0sGthzl5VZvewqdhBr+GRWNu61oKnNf6cnvtJ7UwaI9ybIc7EAfVh/s5+65ZpG/MyTmG6HmKNaCFWGPn2KwY51yEhrNjMnzr+e7zza2tZ5ub970oS8XPf3zCLRbaGLjEOmx0Nf6t93eWzKkvGeZuTVYXE0SV+ZTWFEDlSLx+JF07Cu4+Tl16HJmfuTVOpRrYRuuspbt/XNqfdfRIy1uRes3ty9uyjGxVTN1lRXfEqlp01bwu71tTV10vGeURE9tuVT8TpEmBhqnUEP/Le7w8Ay7o7bU7/LbrX8Va+3WqKnEwRptDLVAB9LlykoEzZA/D+OXq0rOkcjAl1yrcYJfcsEW+K4kV556/cTx0R3y9eFsvur8n6dvvnDV0SNFRXSt9S6G6qa2t/2JtfVA8JENynrpq9v6rDal4/ypMYtFjGjrCIU2IM0OjbZ/uooNUvgH8SK7v+BTfKC1Kdv8Savn63+HTqBf9QQggqsS3+NF+NAWXD+3uRxs3Oxse9dgIr970fcrZwCQgxYYVX27dRhWS27irZ5J7zAQkRNcLrkcw10FGjF4mifajmXOp3d/YEDDXfZ7KgZyG2YzovtckcGq0yDz0uYTMKgpnjk+xiFiy3PrLTUYuS+X7oE2mk29BWSn7H8Ibs373yndma7VgK/8fnA6pxkInwbSVv8VTouShDBrV6OB7L7xAw8cUkCbyGwg/+jbyPLIRe6J0eJ3NGS4T0kHKY3jaYzCYDhpk91lY+I+Fzgyqo38Ni3+OfI7AwYHcXbk/coI5l6hI6xuI/y+VV8hfDN20tF7dsIZaykmd1KNilqA59DAHTOL/8yL+Bg11vxdb7WKH1mYch26evCPvGD4lwPGRL9SmRjsd68SGF65xC0HhGhveG/s7zF46zaS1GfQIhfevQ5EbLYqX3Kojypml7XFcCW6E7ZO8kiOkniC+T1sbNE3chjPFJ68/nj/tNY7t/NOah2Qb86OTznOiXpTIGHBUZv+usNyUxzPAEZ7W1t3e3g44XR5oM90Ia+3GyfDw+O3ZcR/XIAgpXVKzAVKWCMd6uUdg2PDbvr25vTvYGWzRHJq2bs5VhR8CEqphqOlNlUzyvz9h0PEnDEK8cvDNbaQJlwr1TBt7F5LBp+hmx78oP5HUF9cSQugLqK6lpFAUscV+7DdajMteNNOI03+K7u7wYO+DSe7v8eevHqn6dNmLbriRvh3E3CEtfhbRPo2PP7DFT96HcuAp+0/9GwqdGs/ThsKcQdsT7UfYMGBWafZo95dF+U3q8TcdEBZSWd6qm+6r+f7343OErbLa+0Q8lR6QDx8qf8Cgzlozg3kW8F9MtJ1L/oF+/gYW/yxu91eWLiiypr8bFYWdx78A2BxqnA==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read verification</h1>

<MethodEndpoint method={"get"} path={"/v3/config/digital-wallet/openid/sdjwt/verification/{presentationId}"}></MethodEndpoint>



Retrieves a presentation record (V3) from the wallet of the holder. The V3 record adds DCQL, transaction data, trust list and response encryption fields.

Give the `presentationId` property of the record, not its `id` property. The receive operation returns that value.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the presentation record in the wallet of the holder. This is the `presentationId` property of the record, not its `id` property.","in":"path","name":"presentationId","required":true,"schema":{"type":"string"},"example":"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet returns the presentation record.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation record in the wallet of the holder. The record tracks one OpenID for Verifiable Presentation (OpenID4VP) Authorization Request that the holder got, and the presentation that the holder sent back.

This V3 shape keeps `vpToken` as an array, so the wallet can send more than one Verifiable Presentation in a single Authorization Response.

The wallet returns every property of this schema on every V3 holder operation. A property that has no value yet holds the empty value for its type: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.


</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the presentation.","example":"6821b4b0f5b1c2a3d4e5f6a7"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this presentation in the wallet of the holder. Use this identifier to read the record, to send the presentation, or to delete the record.","example":"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the verification exchange at the verifier. It links this presentation to the verification history record of the verifier.","example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the digital wallet deployment that holds this presentation record."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that owns the wallet of the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation Submission object of the DIF Presentation Exchange specification. It maps the credentials of the holder to the requirements of the verifier.

DCQL is the only query form that an iGrant.io verifier sends, and a DCQL Authorization Response carries no Presentation Submission, so the wallet returns `null` here for such a request. A value is present only when an outside verifier still sends a DIF Presentation Exchange definition.


</div><SchemaItem collapsible={false} name={"definition_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation definition that this submission fulfils."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>descriptor_map</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Descriptor Map entries. Each entry gives the position of one requested credential in the Verifiable Presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the matched credential, for example `jwt_vc_json`, `dc+sd-jwt` or `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor that this entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that points to the credential in the Verifiable Presentation token."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>path_nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Nested path descriptor for credentials in an envelope format, for example a JWT in a VP JWT.

</div><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the nested credential, for example `jwt_vc_json`, `dc+sd-jwt` or `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor that this nested entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that points to the credential in the envelope."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this Presentation Submission."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vpToken"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Verifiable Presentation tokens that the wallet sent to the verifier. The array holds one entry for each credential that the Authorization Request asked for. The array is empty until the holder sends the presentation.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`presentation_pending`, `presentation_acked`]"} schema={{"type":"string","enum":["presentation_pending","presentation_acked"],"description":"Lifecycle status of the presentation in the wallet of the holder:\n1. `presentation_pending`: The holder must select the matching credentials and send the Verifiable Presentation to the verifier.\n2. `presentation_acked`: The wallet sent the Verifiable Presentation and the verifier accepted it.\n","example":"presentation_pending"}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the verifier accepted the presentation and the checks of the verifier passed. The receive and send operations always return `false`. The server sets this value later, when the verification webhook reports the result."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Validation result for each credential in the presentation. Each entry holds the result of the signature check, the expiry check and the revocation check. The receive and send operations always return `null`. The server sets this value later, when the verification webhook reports the result.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"vpRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the Authorization Request of the verifier. The wallet returns this value with the Authorization Response so that the verifier can match the two.","example":"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the verifier from the Authorization Request, for example a URI or a DID."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI from the Authorization Request. The wallet posts the Authorization Response to this URI."}}></SchemaItem><SchemaItem collapsible={false} name={"requestUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Request URI of the Authorization Request. The wallet gets the full Authorization Request from this URI when the verifier passes the request by reference."}}></SchemaItem><SchemaItem collapsible={false} name={"responseRedirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the verifier returned in the Authorization Response. The wallet sends the holder to this URI after the verifier processed the presentation."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinition"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"DIF Presentation Exchange definition of the verifier, as a serialised JSON string. Empty when the verifier sent a DCQL query, which is the only query form that an iGrant.io verifier sends. Read `dcqlQuery` for the credential and claim requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce from the Authorization Request. The wallet puts this value in the Key Binding JWT to keep the presentation fresh and to stop replay.","example":"z4cVLRsq9pKx0NgQ7E3hJg"}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request. It tells the wallet what to send back.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet that the holder chose for this presentation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata of the verifier from the Authorization Request. The wallet shows this information to the holder before the holder approves the presentation.

</div><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"logoUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location or address of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"coverUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the cover image of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the verifier."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credentials that the Verifiable Presentation holds. The array is empty until the holder sends the presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the DCQL credential query that this credential satisfies. For a request from an outside verifier that still uses Presentation Exchange, this is the Input Descriptor identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet of the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential types of the presented W3C Verifiable Credential. The wallet leaves this property out for other credential formats.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Disclosed claims of a presented W3C VC JWT credential. The wallet leaves this property out for other credential formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Disclosed claims of a presented W3C VC JWT credential. The wallet leaves this property out for other credential formats.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type of a presented IETF SD-JWT VC credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type of a presented ISO 18013-5 mDoc credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Disclosed claims of a presented SD-JWT VC or mDoc credential. The wallet leaves this property out for other credential formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Disclosed claims of a presented SD-JWT VC or mDoc credential. The wallet leaves this property out for other credential formats.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionData"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Transaction data from the Authorization Request, as the verifier sent it. The value is normally an array of base64url strings. The holder must approve this data before the wallet sends the presentation. Read `transactionDataDecoded` to show the data to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDecoded"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Decoded transaction data. The wallet shows these objects to the holder for approval.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement from the Authorization Request. It gives the terms that govern this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Data agreement from the Authorization Request. It gives the terms that govern this verification exchange.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification Data attestation of the verifier. The wallet uses it to check the legal identity of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of possession for the Legal Person Identification Data attestation of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet checked the Legal Person Identification Data attestation of the verifier and the check passed."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet found the verifier in a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust Service Provider entry that the wallet used to check the identity of the verifier.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Trust Service Provider entry that the wallet used to check the identity of the verifier.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"DID method, or key type, of the trust anchor that the wallet uses for this presentation.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that the wallet uses to sign the Key Binding JWT, or to decrypt the Authorization Response."}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token that the wallet sent to the verifier. Present only when `responseType` is `id_token`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token that the wallet sent.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the ID Token that the wallet sent.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifier Attestation JWT from the verifier. It proves that the verifier may ask for the requested credentials."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query from the Authorization Request. Read `credentials[].id` from this query to build the `credentials` array of the send operation. `null` when the verifier sent a DIF Presentation Exchange definition instead.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Digital Credentials Query Language (DCQL) query from the Authorization Request. Read `credentials[].id` from this query to build the `credentials` array of the send operation. `null` when the verifier sent a DIF Presentation Exchange definition instead.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>encryptionJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key of the verifier as a JWK. The wallet uses it to encrypt the Authorization Response when the response mode asks for encryption.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Public key of the verifier as a JWK. The wallet uses it to encrypt the Authorization Response when the response mode asks for encryption.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the encrypted Authorization Response.","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptionAlgorithm"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ECDH-ES`]"} schema={{"type":"string","description":"JWE key management algorithm that the wallet used to encrypt the Authorization Response. Empty when the response mode does not ask for encryption.","enum":["ECDH-ES"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `kid`, `jwk` or `x509`."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet made this record.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet last changed this record.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presentation\": {\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n    \"presentationId\": \"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73\",\n    \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n    \"openIdOrganisationId\": \"string\",\n    \"organisationId\": \"string\",\n    \"presentationSubmission\": {\n      \"definition_id\": \"string\",\n      \"descriptor_map\": [\n        {\n          \"format\": \"string\",\n          \"id\": \"string\",\n          \"path\": \"string\",\n          \"path_nested\": {\n            \"format\": \"string\",\n            \"id\": \"string\",\n            \"path\": \"string\"\n          }\n        }\n      ],\n      \"id\": \"string\"\n    },\n    \"vpToken\": [\n      \"string\"\n    ],\n    \"status\": \"presentation_pending\",\n    \"verified\": true,\n    \"presentationValidity\": [\n      {}\n    ],\n    \"vpRequestState\": \"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f\",\n    \"clientId\": \"string\",\n    \"redirectUri\": \"string\",\n    \"requestUri\": \"string\",\n    \"responseRedirectUri\": \"string\",\n    \"presentationDefinition\": \"string\",\n    \"nonce\": \"z4cVLRsq9pKx0NgQ7E3hJg\",\n    \"responseType\": \"vp_token\",\n    \"credentialId\": \"string\",\n    \"clientMetadata\": {\n      \"clientName\": \"string\",\n      \"logoUri\": \"string\",\n      \"location\": \"string\",\n      \"coverUri\": \"string\",\n      \"description\": \"string\"\n    },\n    \"presentation\": [\n      {\n        \"id\": \"string\",\n        \"credentialId\": \"string\",\n        \"type\": [\n          \"string\"\n        ],\n        \"credentialSubject\": {},\n        \"vct\": \"string\",\n        \"doctype\": \"string\",\n        \"claims\": {}\n      }\n    ],\n    \"transactionDataDecoded\": [\n      {}\n    ],\n    \"dataAgreement\": {},\n    \"legalPidAttestation\": \"string\",\n    \"legalPidAttestationPop\": \"string\",\n    \"legalPidVerified\": true,\n    \"isVerifiedWithTrustList\": true,\n    \"trustServiceProvider\": {},\n    \"trustAnchor\": \"did:key\",\n    \"kid\": \"string\",\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"clientIdScheme\": \"redirect_uri\",\n    \"verifierAttestation\": \"string\",\n    \"dcqlQuery\": {},\n    \"encryptionJwk\": {},\n    \"encryptedResponseEncValuesSupported\": [\n      \"A128CBC-HS256\"\n    ],\n    \"encryptionAlgorithm\": \"ECDH-ES\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"string\",\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The presentation ID is unknown.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read verifier global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-verifier-global-configuration

---
id: config-read-digital-wallet-open-id-verifier-global-configuration
title: "Read verifier global configuration"
description: "Reads the global configuration of the OpenID4VP verifier. An organisation has one verifier global"
sidebar_label: "Read verifier global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv27gS/isDPiWAfI3Ti7FYnGyS0+PdYhs0bvPQBCtaHNtsJFIlKTvewP/9YEjJlmwnaYF9674kskQO5/p9M3xkAm1iZO6kVmzIPiIXFtwcYZbqCU8h0WoqZ4XhtAD01H/7kKMaXQw+X8ECjZxKNG04U6DNjCtpw9I5t6AVblaUAm9VQ2IbxnOEJU9TdJDxe7QgHSylm/uDBE55kTpY8LRAC8s5Kv++cVK5W9pbJTBP9QpFBFbDShcgNCjtIDHIHYJ0bfhttZFKkjbqCY3Wr+VJgrkDVIlZ5Q7FrTor3Fwb+Xc47iPaXCuLFo5iW+S5Nu7coEDlJE8vwy6pVQzSQjzlqcX4GLgSwBXsSvpWoHW3SlqyUAqYagMnr7pdsJhoJWz7Vt2q8a7BWWEdzPkCgUNlMQg5k46npTfaMJqSJykKSiuMvLEWzQINcGWXaGxw8//G4ysYdLvtW8UipnMMgRkJNmQhVJQTF0H6jRfuwy8+l5575+N6Xo8qi5ipvMSGj6zf7dK/ZqqNtwpNdaFEMxyH0q/NIlLJoXIkjud5KhP/pfPVksxHZpM5Zpye3CpHNmR68hUTxyKWG7LNyaDR7IDSBzY1NX73gyUxcjDXaVlPFp2TakY/uANcoFmVS4MJYEI2VAIbES8s2vaeEVLUdLbOSDXb0/kjJtoIkD4/vWdL+c97GmrRCWXp5iFLCwxlKB1YvsBgnPGnBIt5aS/PsFzPLcSLp7NlJGKyDR94lqdkyqtXp9P+5E3ylvfEALvdXp9PTgaJYOuIPSvnZXd8UvJbgT/uju9Et+Y2j0LBPVx4CChyQTi0qTJbAVRhsebhpjsmr0VvOuD91pvkBFsD/rbXejs97be64iR5ha95bzI4JddoX5Yfamp+j0dGe65oIkmJMBkqF1K3Smlpd6tzHbFnALGmykTrFLna0+WGEit2psA4akYlgLIlDN0Ac63mDiN0FBSWFjhUeASZFkiWxkIaTNxfubau/XXpYtAGYpH8xXPpfzeCQDqtqf7QonL+mBK9Lx9yadCO6vapIpug2TPvvZyik5k//ikyAKk24F8vwqWRrlmFLuRWjA95DEnKZVYFsESScn9GYbQlh5IziGAin451ii0/NKymF+uIBfYUZ+5lEz8p+QBko3U8y2vGbLl7gyoCD2ZR7fze68Hrbq8XtAi18w9rkXLrIJlzNUPxA9qsieC+FdKgYMMvBMQvIdMT5fl8xbyQcPXI1P1zt6vfIba7W9OqOXKBhtiEfg0CT383x9bPQGO0OdcCyWX0fFELyV30Ah9vd2+DK5XDmY/uJgQDnwl74g+A3BY+f+MCpMoLBzk3PEOHhq3X3vr9hqQB8tJCoe6VXqpon5JDZ/VU/xURmjwPpjK0mwatThcoKNV2o9H7iaPxSfESH1EccM3gJ3bNwT6Ucsn30QdGKkrE5uqqhQv5aJ8aqsoORlrwpkCiM6TGJ11VSModWIc5TLlMMZxtMOR2NXVtup0hKeF44qAEvf2cP/2pEWikHBrF04qd/DE7PqImC5PCSLdiwy+P7CyXfyA93q3JRj6z5ItyXoMwsMFR1SqdH7OIVZMbOSVDN9c0683Q+4S7ORuyzqLfCQnTKQGsFRKiQywmRaciu06gllayM/4FA6zXsGnjBWa6tI9Iy6RsyObO5XbY6QjMdIv6LzkzXLm21Gwd7Qq4MloUiU/SJ8S8JOHa8ZlUs6e22/B5V5G7reOvKf9C2lTu38SfhxcRk3RUiByLmOIZfW30fHt9y9nVCO5xBYR81AwktWEstG9lhxc35MQQjgkXAxOE3OBUPqAIE34cdIQYjpR26AU4w2XqfZDzBI8jwPasvSN2COXGX1a6MOSO1j2ufo3bjJJQqqmuSpUnvlQx45IcWVb3f7bO29gv321fNb1eD9iOWzabIDd6IQVSQ59oqi661KH/WdUkNedxf6ES0p1PUoRtl2VhZG3BVYJw9MFXxijc0hzeeFXrw7bVdHVMGjmd6NR369IChRAV7bEloP5dTnpOg7S2wMhPUKEB92W02jQJSU29wvrwOK4EN8K2vL2SKwfTVC/Ly5vS017bm5Nz+HwOR7/fjI8jGF2O/wvXF63fb8bw+TycNrr+AL033d5J6xSyC510sov3tTNJSsadv2hIZYLKeiysMjfnyRyh3+7uhW65XLa5/9zWZtYp99rO+9H55Z/Xly3as46Yky5t5IB3ltBJsYleaKNtCHu/2x+0T9o92ktTWsZVTR+6lXp+/N4trxqt/HvP+ZPfc5Zg7fDBdfKUS0VJ5rP6seTAL2zRD/eNU+lvTRo8WM5zjcGPRewgG95FbK6tI5GPjxNu8ZNJ12t6/a1A46k7YgtuPNJ4Iq8Y39PnPdELO/PRotMoRTzP7PRF6zqbv7scs4gRjzSp6d5TU/lA0qtPalWTvctSQQX6S2R6cMsvVMt/4OrXzfLw5ckNG2YMqykCNJL+H4OOsRY=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read verifier global configuration</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/verifier/global-configuration"}></MethodEndpoint>



Reads the global configuration of the OpenID4VP verifier. An organisation has one verifier global
configuration. The wallet makes it with the default values when the organisation wallet is
deployed, so you do not create it. By default the verifier does not accept encrypted
Authorization Responses (`supportCredentialEncryption` is `false`) and an Authorization Request
is valid for 3600 seconds.

The organisation must have a deployed digital wallet. If it has none, the server answers with HTTP 400.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server found the verifier global configuration.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>globalConfiguration</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Global configuration of the OpenID4VP verifier. It holds the settings that every verification request of the organisation uses.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Record identifier of the verifier global configuration. The server makes this value when it saves the record. It has the same value as `verifierGlobalConfigurationId`.","example":"665f2b8c9a1d4e0012ab34cd"}}></SchemaItem><SchemaItem collapsible={false} name={"verifierGlobalConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the verifier global configuration. An organisation has one verifier global configuration, so the read and update operations do not use this value.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the digital wallet deployment that holds this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the verifier accepts an encrypted OpenID4VP Authorization Response, that is a response mode of `direct_post.jwt` or `dc_api.jwt`.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"presentationRequestExpiresIn"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Lifetime of an Authorization Request in seconds. The server writes this value to the `exp` claim of the request. The smallest value is 3600, and the default is 3600.","example":3600}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the server made this configuration.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the server last changed this configuration.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"globalConfiguration\": {\n    \"id\": \"665f2b8c9a1d4e0012ab34cd\",\n    \"verifierGlobalConfigurationId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"openIdOrganisationId\": \"string\",\n    \"supportCredentialEncryption\": true,\n    \"presentationRequestExpiresIn\": 3600,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the organisation has no deployed digital wallet, or the digital wallet deployment is not resolved.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Global configuration not found. The wallet makes the configuration when it deploys the organisation wallet, so this error comes only when that step failed. There is no create operation: contact support.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read wallet unit status
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-wallet-unit-status

---
id: config-read-digital-wallet-open-id-wallet-unit-status
title: "Read wallet unit status"
description: "Reads the wallet unit status from the holder's point of view. The status follows the Wallet Unit Attestation (WUA) lifecycle and the presence of a Legal Person Identification Data (LPID) credential in the wallet."
sidebar_label: "Read wallet unit status"
hide_title: true
hide_table_of_contents: true
api: eJzlV9tu20YQ/ZXBvtQCKFKWXaAQgqCu5KZKjMaobw+xUa3JEbUxucvsDqWogv69mF1KpmSrKfrY+MGmtDuHM2fOXLwSGbrUqoqU0WIg/kCZOaAZwkIWBRLUWhE4klQ7mFpT+rOZKTK0PziojNIEZgpzhYsYrme4vWuKwiwC1F2AumGoMyLkK8poOLq7OetAoaaYLtMCQerM368sOtQpMrCEC8xlAZdondEwzlCTmqo0IIwkSTi6uByPOpBa9IeyAKVbIcQiEqZC6y3GmRiI1OipyjnUkcoVySI4+LFCPc7CM/t65SMRkbDoKqMdOjFYiX6vx392afOBo52jBYtUW32IQ3YmNZpQE6PIqiqaWJLPjqFWwqUzLCU/0bJCMRDm8TOmJCJRWY6DVHAkALbuObJK5yLa8+3uhRODe30cw0Qb+lNpR3yeTQY+e8bmUisX2J1JB9psosiwKsyyRE3xve7HMNm3be4p11zFLILHmkCRF4zHmstCZYcEEd/rkxgm22TJYhc5oMh/Bgnv1AZYFS1RxPf6NIaJt/0PsF6cUr+CKiKBui7F4JPYYVREov3cikpEwr9LPEQCv8qyKnyaWxfW/BOJGcoMLeeYP50G5f1r+Vj8UiuLGXuG1ho7NBmyt/w8amnkIfqG1J6tn9WmNGGOVrRCOO311q/Av6LQ56h/kRkoXdUElbSyREK7if5giaVSa0NgUWYHW5Wx/qitZ669fUaPv2NGb7SsaWas+ssLdJeaH797se20QuWg1k/aLF6oaB0Jh2ltFS3F4NNKnFXqA/Ljw5pDlbljSppBs+kuR37WjE5vhx0Rid/8OGVmSqSZ4RGVoydG0kwMRDLvJ2FmJVnA6QbJJ6ZCrbIkfOpyASRuM7VCsTjv1G50IyxNU0siErUtxEDMiCo3SJIMS9OVlYpVbqWmWBmxjvYBLq3J6tQTcwDmWwhXJHOl80PmLhzvO/LwzPUVKy8IZsP4NvMyfMH9lzF9skQktCz59KwRvU/si2l5djmGJ1wClwa3+CD4sNrMZVH7pYQ7y2QHZwLhNVDWjuDR7zBT9RUzWCiawST4CBM40obQA5CVqvAcVDLFTgQY5/Ee7AAawzdLU1umo/uEy7eTWLDulJ6aTZHK1BcpllIxka6uKmPp52fytvGrd89f7bLeTtgeLVsjqKyZqwx5YKaG64oQFP/lzSAUS8NQ0Lhvxbdo1VTJxwJhuJ2dDsbO1ZIXvaOPvhjGHT9mXze89FvhZnXcFNBlhz0ik5rCcZaUA04harZxTREHMh2QAeVcjZGf+ZF/2ZzfsISmsFqj3UHtfHpI6kzazHV9vEpqgqnfbX1qG6a9t3cnQ7gdwtH7u+tOBOPz61/hatR9f3cNt8PwtvHVRzj+qXd80v0RypFJk3J00d5cp8aWkvyaWKgUtfNdcKPcSqYzhH7ce5G6xWIRS38cG5snja1LLsbD89+vzrtss44EKSp2NODJykxab7PHywlaF9Le7/VP45P4mG0r46iUuuUPb9CvDN/9mmpNkf/r/xdN4yH8SklVSKWZMJ+hVdPEP4l5P+z+U+V39J1GHvZDrXgOt5o5d/FA6UMkZsYR46xWj9LhjS3Wa/76S43WjxteKq0vFT98NlPK9/8n7o/iLE2xorB91qFR7o30dXsGvTu/FpHgRrjbW598b20eGH1zpJct7P02G1zg3zwNXjV5w2L8gMu32+vh5KDBtrWH20z7w3q9/hsrPSrM
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read wallet unit status</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/wallet-unit/status"}></MethodEndpoint>



Reads the wallet unit status from the holder's point of view. The status follows the Wallet Unit Attestation (WUA) lifecycle and the presence of a Legal Person Identification Data (LPID) credential in the wallet.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server returns the wallet unit status.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`not_installed`, `installed`, `operational`, `valid`]"} schema={{"type":"string","description":"Wallet unit status:\n1. `not_installed`: The organisation has no wallet deployment.\n2. `installed`: The wallet is deployed, but it holds no valid Wallet Unit Attestation.\n3. `operational`: The wallet holds a valid Wallet Unit Attestation, but no LPID credential.\n4. `valid`: The wallet holds a valid Wallet Unit Attestation and an LPID credential.\n","enum":["not_installed","installed","operational","valid"],"example":"operational"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"status\": \"operational\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The server cannot read the wallet unit status for the organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The organisation is unknown.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read wallet unit
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-wallet-unit

---
id: config-read-digital-wallet-open-id-wallet-unit
title: "Read wallet unit"
description: "Reads one wallet unit that the wallet provider manages. Give the wallet unit identifier in the path. The organisation must have the wallet provider capability enabled."
sidebar_label: "Read wallet unit"
hide_title: true
hide_table_of_contents: true
api: eJzlWG1v4zYS/isDfmkCKHY2mx4ORlE0tbcL725vjY2TfFgEMCOOLTYSqSWpOG6g/34YkpZlWZsExeGAol/8InFmnnmf4RMTaFMjSye1YiP2BbmwoBXCmuc5OqiUdOAyTh/Nw9LoBynQQMEVX6EdwHv5gO0TnkwKVE4uJRqQyr8tucsGMM8QtFlxJS0nuVBU1kHG91k0QlJe8juZS7cBVPwuRzFgCdMlGk89FWzEUq2WckXoJ3IlHc9vPJPPJaqpCL+vlHQsYSU3vECHxrLR16eO+ldKfquwDVwvge8pZXAlrTMRuNdfwN3GIw+CYBaRE0xJbEltljDFC2Qjtm7gTAVLmMFvlTQo2MiZChNm0wwLzkZPzG1KOm+dkWrF6vqWDttSK4uW3p+dntLXvgrzHgsadJVRKLoeIoCpVg6VI0a8LHOZes2Gf1ji9nSIRt/9gak3pCEXOBmw7JR6FlI0YaqNd2KXp5Mupwf7HtsTJMWhaZIX3bjU5iA8Iwy4shR30sIDzysEbv3JRdtNCx+50MTOgNUJS3OJinz4Ip6xP9kJqxYcqazjKsUE3KaUKc/zDXCYTCegDVx9+eQxCnB6y2LTphYVCYXP08n59XgKXAnwcT85v55RDDid6hykcmh4SohsC/6VyV9hzy+fAJUotVTuu9Argkh2FtJg6iDVRVGpGE8tibPqLpfpR9z0BRUXQtJ5ns9aXg+Joao8p/Tf/t/HGNjCPW7gw83H51E6DQ9oyIwxY8nLcOEcWhcSe2a0XhKTmbYWrd2qIO1F5TJtpMW23++0zpGrA8PdZKhgQXAXSYixvfpogQduf0bvRh/BWrqsr6L8YMGieZApBh9ya8lGWs31PapXB2JDBh9u5h1TEbKWMz+TvnA2OIU00lYuoxiMfoX5LnMkoUsNugHMDXIHkkQBh9Sgj1ue++gUGpR2sDbSIZ1xGnK96tNo7rV5SSs6tdUi7WroiE8IP8KE4sK1OJLFV2hYwpbaFNyFR/867yspj+BkQRFSlHAkFemqlbDHsCYvH3h3zW1sFmioZdUJq0rx/0QQCpwHknProNCCqk/AsitvE6SAmuXcEYKXzR3OQxkJeuIntPh7pdcqhIYFbhAWUttFAguuhNFSLHwwLNqTwCJQxhgHodH6UEkzTO+9FM+OWgc+8qL0zUJqu6/QlExqpNu8MiuiQnJLFmIGbEX9cNfd26aNNbc9DCQ+XyIs4AouyjLWFCrjs5xvYLovouOIj7h5TTeZHrSR1GxKp1eGl1ksgd2JrTW6UDR6qHxX7zpAfkfHBXe9bf+vV+iLhhKKKKAfZ2P4HisPWF23Z6avNBC0enG7rx12nE4BPyigvfWnXTnaOfxMDj0TjYcO77X8bVfN1oB1W9PLDLnwU+wT/TsPs+Crp7k2azRGm7EWpKr/PWn57fZwStsfyHbUfUWtSdPz09O6h31PtO8y+1cuQKqycrvJi9W11/75CbMpHPgorUsgTn97S4cMJ3h3Wqbi0rXtm3+wba/Ubkg5MM2P/+iwo9Q2VM+oYaEBL6ZjozphFtOKCoBfOC9K6Wffr7e0zzm+oj2Uxa11O+8dbQf48TFLWGcIJNsU6DJNi+8Kw1LrMjZiw4ezYdiEhyIwPAnBPdQlKimG4d/JNtS3/ylnhk/thadmBJuU6luTJ1joqDNVRFohWOZcaUfDocBCn/BSDuTKcOUGUrM66TKYGS0qv4t8j81LHC4dX1Fv+A65Da+7QG53zrikmAyhtHVJExM8PIjbe/Dmbn+PDeRPH+MH3fliNvUd+HBOjsPLtmkv9vgsIIgJdyF3CKXBpXxEEXaBRcAICzhS2oV7Eme4zL0NSp7icQI4WA06bEcQCX/a6MqQOU7ucfPzIrRRqZZ6m7489emLBZdkSOrB2rhfdsZr9Jfvd4/2rd52WMcsDdG2zvq9QFPG0RJA3wWquH1FC4Uk8LPKNa1rkmYLGDfLhIWptRXtdXAUt9/j1vrbJZwZtI2IJsNmx82ObOM2Qy4MN002toxgTOt3NGsrTCDTuUi8sLhJxoRr7ToWKuvd47gS3Ah74vWVXDlY5nptg2ujpT3am7djuB7D0Yeb+XEC03fz3+ByckJL2vU4SJtefoY3/z598/bkRygmOh0Wk0/t/SosEZaaWC5TVNbXx23kljzNkLa5A9et1+sB968H2qyGkdYOP03H7/5z+e6EaOrdBc3OnWQsodOq8R5LGJWN4Paz07PzwdvBG6IttXUFVy08dF/X7tvdZGo1lr/RzWQsIg4f3bDMuVR+9Qv3LKFQf2UPZ+HqbSn9fL9XrMPlppK7ybAp2Lsn0VyjvcvE24Rl2joS8PR0xy1embyu6fG3Co1vOgl74EaGIZ3qurQeNxsteW67I3vb/kdfYus+hv/9LWmvybbFWFEl9qWTjRhL2D3V6v1b1Pq2GYi9WuHIRZpi6VrEB7NJ3W6l79/NaQGoyEPtVnDvW0H8Qdx7gXW7QoBAn9S8ekl+otz5iJufm+PhzXcJmk4UTpOZaBf4L32FYHk=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read wallet unit</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/wallet-provider/wallet-unit/{walletUnitId}"}></MethodEndpoint>



Reads one wallet unit that the wallet provider manages. Give the wallet unit identifier in the path. The organisation must have the wallet provider capability enabled.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a wallet unit registration managed by the Wallet Provider.","in":"path","name":"walletUnitId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet provider returned the wallet unit.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnit</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The wallet unit record.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the wallet unit record. Use this value as the `walletUnitId` path parameter."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the wallet instance, typically a DID or URL. Used to identify the wallet during OID4VCI and OpenID4VP protocol interactions."}}></SchemaItem><SchemaItem collapsible={false} name={"clientUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL endpoint of the wallet instance, used for direct communication."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientPublicKey</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this wallet unit is authorized to interact with the Wallet Provider's services."}}></SchemaItem><SchemaItem collapsible={false} name={"assertionToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client assertion JWT of the wallet unit, used for OAuth 2.0 client authentication. This value is secret. Treat it as a credential and do not write it to logs."}}></SchemaItem><SchemaItem collapsible={false} name={"assertionTokenType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when this wallet unit was registered."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when this wallet unit record was last modified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitDevicePlatform"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device platform of the wallet unit. The known values are `ios`, `android` and `organisation`. The service does not check the value.","example":"ios"}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitIntegrityToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device integrity token supplied by the wallet unit during registration, for example an App Attest or Play Integrity token."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitKeyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cryptographic key that the wallet unit registered for attestation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Additional metadata that the wallet unit supplied during registration.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Additional metadata that the wallet unit supplied during registration."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"walletUnit\": {\n    \"id\": \"string\",\n    \"clientId\": \"string\",\n    \"clientUrl\": \"string\",\n    \"clientPublicKey\": {},\n    \"isAuthorised\": true,\n    \"assertionToken\": \"string\",\n    \"assertionTokenType\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"walletUnitDevicePlatform\": \"ios\",\n    \"walletUnitIntegrityToken\": \"string\",\n    \"walletUnitKeyId\": \"string\",\n    \"walletUnitMetadata\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The wallet unit does not exist, or the organisation is not a wallet provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read digital wallet deployment
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id

---
id: config-read-digital-wallet-open-id
title: "Read digital wallet deployment"
description: "Reads the OID4VC digital wallet deployment of the organisation. The response gives the deployment status, the service endpoints, and the well-known metadata URLs that wallets and verifiers use."
sidebar_label: "Read digital wallet deployment"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zgS/isDfkoAWZbd9NA1FotL42zXbbfN1m7yIRtAtDS22cikSlJ2fYH/+2FISZYcJ821uEXv5UvjSpzhzMN5eTi6YymaRIvcCiXZgH1AnhqwC4T3o+HJ5RmkYi4sz2DNswwtpJhnarNEaUHN3Dql51wKw0lBCJMFgkaTK2kQ5mKFXllDzFhuCxO4xwb1SiQIKNNcCWlNAFym7tUas6xzK9VawhItT7nl8PHDW1LHbWmNcatXqMVMoDZQGAz/lH/KSUM1l2ZN79bCLuC3yeQC+lEEuEIJ6wXKey7AghuQqmFxCCPpd024QYi9AzEIA3EUB9WDsdX+2Ttl4UzJmZgXGlO3AJNC4yUvMlvKySLLYu8srlBvagTco6bDtJxLwGVuN2CsFnIeAp3SzpApzpRG2KiCEHAeEVIhC5jKUTu3RikbsMRZRcJDf6pXDsb3OdL7gFUHZ9jgjvWjiP60w6OJrEZbaIn+uJyO4SPRkqLlInNGJUpalJa08zzPROIs7H4ytMUdM8kCl5x+2U2ObMDU9BMmlgUs1+SPFd5APkdpx96Y8xK+hpTHigV7HrykMyRcy/D1YT5yuHsnTi4vah8fjPEVzwo8cDZPDioWMPzCl3lGti6szc2g2+W5CMVcc2lDobqrfreppPu3fvoTRtOf8Pm0x19EUdRLo9mLaa9bWsu2AUs0piit4Nn72Qz103E5AMlZrQucsjpI/x3Gd3eWdxTtRt6sUBvho+Jx68dqZtdcI5QSlSsecEzBBUvb7l4YhRHt4vOosYmQFueo7+0y3K9i1TZeO0wWwkCdcmX5i6MYjto14RiUhrgfw9GwtO8YlMw2IYwsaMyVtqasC9U+doGaipCEYe1SWX+MAmFB0vpqy14MRx/wc4HGYnrs3JbFkg2uo6B/08CgX3s/tvrrKD/uPxlk8cuDOOzVRYdB5Uzs/A9gprRvDHxJBYYbJZ2fZalreMLa6ljAKl2s6eHu6TZgGaZz1O/4Er/uK62qo0jQomlhMQWvw/eDneuFQeOMH46GoHFOAo1q0S6Z1MOEgURJY7m0ZS3hmVHfVj3OC6qLXMLLTCW3yYILCWVdNDCSM82N1UViC407FD5+ePsvFYX7GPwVrlW1ZVFMQ5waEWLR3fkwGj4haUeuqhBBqFwpj1CiXSt923YjVUgGWTBovS8zgVnq2gPP1nxjak/jKG4ZG20DJlpoX2i1Eik+IbPapwR5KejDbKGMNe06cx/3WLwqS2/8HXjXSgjk3aIPOH9SGX6Faq55vhCJS4JdHfZZ0uRUf1VaDOBXzeXtrNCWfBLGc54DRzNVKkMu7zl1RZvHVhcYB/eNIApQ0Z362ChaEk4vTYHgd4SPUlg4tRapmAklTcvcGc8MUjlucMWGcVxrvmEBI+LIpyRABu2b+gY3sOSSz9EV6SlPblGmZletWqYndfXc4zSenj6A+k4KpJJITgiLy6f0z3Yqcrg9aG7oWqYw0K7woWtrwidCHaewIqRC101LNvbFopY882/giEjdS66o3fzGzUKcKZ2Dw/c4hPiZF4M/Cp6RZSlMdGFsVT+hihM4+mMyviCJk9oIouhTbrDjDE9LU5rNthf0g2fByc22cdDXvZsWTxtRjOjfS8r/vUTNa4NKHaQqKXYJ9yOy1m64u+p1VY5SpJ0GF3Qp5MggL+xCafEPp5bO51tROy3sAvphBKdNjeBV/udCR/h0WiB1jHOJwJOKEs/ftL7rUvCuoQgqTT8wRE3HCYhP61vzTQC8Hr9/B1c4BSqyY3xk/vFD4kB+s+2WLvmfC0GMeXB9+Ar98CVydyGrL03N+0OLYDd5ZoOvPUiRDtCNA916rz8+UkcfrxcPJMReeNxsCbAF8hQ19Tf630nUo7B58gyjCTdqrfSZSgkd93vYCLab4Cvzjp30oU5bB8xJRET0nvoDob6LsZc8BSHzwkLONV+ipaKxdd7v5YOsUHVXrjY0z/3E6H8UmiahTbikO4SmMd2hGtG6HlcXfi6hkH7i2aoPbnLpqHE1OiXdu3nmSRSFe2dR8UhhN2xwfcdOc/EG6efNlrDkc0OYl0PAip8eVeOvs2MWsPJhnXk3AVuiXSiaI87RHQG3CzZgVIo8J+yW07+Op8NlM3c5S8lnnCn7E4WlgrJLBazQWaPgpbhUnVbVY9tgX8GFVmmROJweUPM1DWPL51ScHxA3/vW+ITc7hMcU0D4OK5x3tN0/oKpHOt0RUfFxIwjW4h/3es/pxcgxZMo4KnHJvRZTdqC4pScGvw0sicdO6TKJM/EFUx8ysbcRYjiSyvppsdVcZA6DnCd4HACG83BP7QBKwZ83qtAER+cWN7/EoWsqQs5Ulfs8cbmPSy4ISFPkFN9/34FX+7+7be6j3jywPVh21L+8bhF9TxSlq0UQ9Jd6iM+dirz46TQNaC7d1wK6QjVos3G8mcsE4agkOseNifC+4IVGU29Rp83FMVlkVaIyUyY5HSFKkjFlTnswDVjlL4cBLFSWBrsPGZt6hp40zCuMOx7LZcp1ajrOX0G35Fmm1uXXjRJpZ+3VszO4PIOj11eT4wBG55NfYTzsvL6awOWZ3200fg+9F1HvWec5LIcq6S6Hbxt7kpYlt+6SmokEpXHFtYrcnCcLJBJ97+jW63XI3etQ6Xm3lDXdt6Oz83fj807fD12tsO2JgwOr4txVRtQDYNaP+ifhs7BHsrkydsllwx73QeTBjw/7qdXoUf//4PXf9cGrrLs0h+7mGReO87sAvSsb1jVb9f1HqJlwhL/VtPw3M2pbNwGjwRsJ3N3RNf+jzrZbevy5QO2aacBWXAs/jrm+qami63O31AfYaZJg7ogzFWzXEPYY0bbZWF+dT0ri2u4ht66HlD9Ie/VKbhq699uJN4H+pa53UORnSro3uPmlXu7fPChQtzC/mvAllvxPPhGkqQ==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read digital wallet deployment</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid"}></MethodEndpoint>



Reads the OID4VC digital wallet deployment of the organisation. The response gives the deployment status, the service endpoints, and the well-known metadata URLs that wallets and verifiers use.

The service answers with HTTP 200 even when the organisation has no deployment. In that case `status` is `0`, `statusStr` is `Not Configured`, `secureVaults` is `null`, and every endpoint and metadata URL is an empty string. Read `status` before you use the URLs.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the OpenID digital wallet deployment details.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"agentServiceEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the OID4VCI and OpenID4VP service of the organisation. The value is an empty string when the organisation has no deployment.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Credential Offer endpoint.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/credential-offer"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Software version of the deployed agent.","example":"1.0.0"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** [`0`, `2`]"} schema={{"type":"integer","description":"Deployment status of the agent. This operation gives `0` (Not Configured) or `2` (Deployed) only. It reports every status other than Deployed as `0`, so it never gives `1` (Requested).","enum":[0,2],"example":2}}></SchemaItem><SchemaItem collapsible={false} name={"statusStr"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`Not Configured`, `Deployed`]"} schema={{"type":"string","description":"Deployment status of the agent as text. This operation gives `Not Configured` or `Deployed` only, for the same reason as `status`.","enum":["Not Configured","Deployed"],"example":"Deployed"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the distributed ledger that the agent uses for DID registration. The service returns this constant value also when the organisation has no deployment.","example":"European Blockchain Services Infrastructure"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerURL"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the distributed ledger. The service returns this constant value also when the organisation has no deployment.","example":"https://hub.ebsi.eu/"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerID"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the ledger network. The service does not set this field and always returns `0`.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Infrastructure provider that hosts the agent. The service returns `iGrant.io` also when the organisation has no deployment.","example":"iGrant.io"}}></SchemaItem><SchemaItem collapsible={false} name={"deploymentRegion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Geographic region of the agent deployment. The service returns this constant value also when the organisation has no deployment.","example":"Europe: Frankfurt"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the organisation is a wallet provider and can issue Wallet Unit Attestations.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"secureVaults"} required={true} schemaName={"integer[]"} qualifierMessage={"**Possible values:** [`0`, `1`, `2`, `3`, `4`]"} schema={{"type":"array","nullable":true,"description":"Key management backends that the organisation configured. The value is `null` when the organisation configured none.","items":{"type":"integer","description":"Identifier of a key management backend. `0` is Not Configured. `1` is the iGrant.io vault. `2` is an external vault (OpenBao or HashiCorp Vault). `3` is a Qualified Trust Service Provider (QTSP). `4` is the database-backed vault.","enum":[0,1,2,3,4]},"example":[1]}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuerMetadata"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Credential Issuer Metadata document. The value is an empty string when the organisation has no deployment.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/.well-known/openid-credential-issuer"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationServerMetadata"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OAuth 2.0 Authorization Server Metadata document. The value is an empty string when the organisation has no deployment.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/.well-known/oauth-authorization-server"}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Notification Endpoint. The value is an empty string when the organisation has no deployment.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/notification"}}></SchemaItem><SchemaItem collapsible={false} name={"jwksEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the JSON Web Key Set of the organisation. The value is an empty string when the organisation has no deployment.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/jwks"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"agentServiceEndpoint\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service\",\n  \"credentialOfferEndpoint\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/credential-offer\",\n  \"version\": \"1.0.0\",\n  \"status\": 2,\n  \"statusStr\": \"Deployed\",\n  \"ledgerName\": \"European Blockchain Services Infrastructure\",\n  \"ledgerURL\": \"https://hub.ebsi.eu/\",\n  \"ledgerID\": 0,\n  \"infrastructureProvider\": \"iGrant.io\",\n  \"deploymentRegion\": \"Europe: Frankfurt\",\n  \"isWalletProvider\": false,\n  \"secureVaults\": [\n    1\n  ],\n  \"credentialIssuerMetadata\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/.well-known/openid-credential-issuer\",\n  \"authorizationServerMetadata\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/.well-known/oauth-authorization-server\",\n  \"notificationEndpoint\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/notification\",\n  \"jwksEndpoint\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/jwks\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The service cannot read the organisation. This operation reports an unknown organisation with this status, not with HTTP 400.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read webhook delivery
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-recent-webhook-delivery

---
id: config-read-recent-webhook-delivery
title: "Read webhook delivery"
description: "This endpoint reads 1 payload delivery of a webhook. Give the webhook ID and the delivery ID in the path."
sidebar_label: "Read webhook delivery"
hide_title: true
hide_table_of_contents: true
api: eJztWG1vGzcS/isDfrKB9Up+SZsTiuJyVpqqCc6GrTgfEgOiliMt611yQ3Kl6AT998OQ+yatjKRXoP2Q8weL4JLDmWcezgu3TGBhMOEOBRsteGYxYgJtYmThpFZsxKaptIBKFFoqBwa5sHAOBd9kmgsQmMkVmg3oBXBY4zzV+imGN3KF4FKsZ2AyBq6En2q2TMYglZ8quEvjT+qTmqYIFs1KJvSrhN3foee/Y+KAh+l1qjMEg7bQyiLMtdjEME3RIEgLSsPa8KJAAwuJmejJFxpplfMHeYEGP5doHaTIBRob7U1WFteT1aHVUtBmf56UIUy66scwcfCEWHj18wjmpSM1G3CXcoXhG8x58hR/UixiukDDyRcTwUYs0Wohl3fIxR0mqNyHgO+4OoJFrOCG5+jQWDb6uGWSfEj4sogpniMbsconE8EiRtZJQ853psSI2STFnLPRlrlNQYutM1It2S5i1m0yPyPzIkO2i44Kr439s9IfaXcA09KGi+GQfhKtHCpHQ14UmUw8NIPfLXF12z8gMIZFzEnn5fcB26f7jcI+ublzmBcOnO6SvEsmnq35xlac5VkGPwbW2XgPho9MEi77HghW3jvuSnutBfYm753xFuRoHc8LRmjRfDMYd0x4jFhhiDROBuSk6AN+aPV7JT+XCFKgcnIh0fS56+OADDdv1nh5PAt2HqxHUYNI9uMX7p06Yj+85OeLi+RSXOGLxQ/8x/nL5B9iiOfEgBaU/13dOty4lDvIucB9I+iYI3i350nlcImE9kKbnLswdXnR0+DX6fQWAviQaH8Od1UsC+R5f/eO6OACT1Y8K31Ymg1nsE4xxL2aPYkuM+FjkUGepIdy9jC8GA57VhBBvgpaV2WHX9w3q8wVEPs3EAT/OfXpIsPNW/JES+ivO3x6DbS8Pbu5m9Zx41DEIYj4a/FVcXdoy8z1OT5LNGnpUMwgR65sDx6u7JroHQHPrA7qSNdMw1q61ANmjDaeGTFQtIZZn3cziicWA0eDhBhmCy6z/fP/CMyqzCnKNHYQk71AigutE9rvu2Mx5BsA5FYrWGgDHOiA0uC3sqb1XJkkiML7jv76lUdru0FXGoVi75a39zpiVSJmoy0JuvqD2aIbob3rqjjsxwfR9TCz7EfbdvexqNJ44Mrf4p74I8C3TvsXFyBVUVItUuX454GrMUq5L4Ua0D1BCUQqNlS3GDuG4vl3jOJ7xUuXaiP/46/RITRX3zE0RDBtllxJ6w2uWVaT7oBkbRPQ59iL7/qmTpRDo3jm4xyakDYOMKIIjUlppNv4iv5VId8iDR+pSHZ8SYV+XdeS2Tm6VFOzsERvNdXnIzZYXQxC9zCo/GEH26bm2g3qSDDYtiX8jipMr1loJvaVH2OuK8VZxEqTsRFLnSvsaDAQmOszXshYLg1XLpbaNwz7Am6NFmXiCfSMmK9JuHd8Scnlme02fD5U5LFF9J6IFfhQ49o4loeJKLQ5wSVto/OqCg6eqL0E+ep2Ak+4AQohVKQGPndTZFV8zPbkzKqGEvLSOpgjFAYX8ktdWMyCjjCDE6VdKByc4TLzGBQ8wdMIMF7GB2JHUG38aaNLQ3CcPeHm5xklXjJvoes7yBN/BzHnkoC0ZVFo4/7ZgtfYL9+0U/uodx12AEuzCQqjV1KgBQ51MQK+9ctRuRBUKoRuClSTsa81HtDIheTzDOHaoK/+eWZhYm3JVYJwcjMZXz1cT079Y8PxjbcGbXPESVhz9XB7Sho5nejMVr0OuRAV7bFVsAtgWirbpLUlRpDqjEpBJWBFJ2xAyKV0PIOko15pvXscV4IbYc+8vZIrB4tMr21wbYW01/bD5TU8XMPJbx+mpxFMXk9/gfvx2W8fpvBwHU6b3N/A+cvh+eXZC8jHOhnk43edMyF0L775zGSCyvogVzO34EmKcBEPe65br9cx959jbZaDaq8dvJtcv/73/esz2rNrm+nWnQSW0EnZeI9FjMJGcPvF8OIqvox9m1do63KuOvr4+viwpju8UZ0U8f8nqb/5SaqKj9REDoqMS0V+9UTaVtnmI1tRzxzyTfvgQS8Wo+7jR8fbo87L0WPEUm0dydlu59zie5PtdjT9uaTVo4+PEVtx4290yEzS0viZR8wueU7uqgriFJ4zpY7/ivTy0ZqNGIvYE6WHzjuFz0d/3cEdgHaPu7pI8OaHBa+SBAvX2dorpXbd8uDN6ymLGGWo/aT35JNeNSDpR9U6zH9BBfpPsBzd8hNFibe4+blZHr48u6HJuWE1gfS42+3+C5L16uk=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read webhook delivery</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhooks/{webhookId}/delivery/{deliveryId}"}></MethodEndpoint>



This endpoint reads 1 payload delivery of a webhook. Give the webhook ID and the delivery ID in the path.

The service sends the delivery object as the whole response body. There is no wrapper field.

The service does not send the request headers, the request payload, the response headers or the response body of the delivery. It keeps them, but no endpoint gives them back.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"deliveryId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the webhook delivery.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the delivery. This is the `deliveryID` field of the delivered payload.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"webhookId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook that made the delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"responseStatusCode"} required={true} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"HTTP status code that the payload URL sent. The value is `0` when the service could not reach the payload URL.","example":200}}></SchemaItem><SchemaItem collapsible={false} name={"responseStatusStr"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"HTTP status text that the payload URL sent. The value is an empty string when the service could not reach the payload URL.","example":"200 OK"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the delivery started."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`completed`, `failed`]"} schema={{"type":"string","description":"Result of the delivery. `completed` means the payload URL answered, also when it answered with an error code. Read `responseStatusCode` to see the answer. `failed` means the service could not reach the payload URL.","enum":["completed","failed"],"example":"completed"}}></SchemaItem><SchemaItem collapsible={false} name={"statusDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason for a failure. The value is an empty string when the delivery succeeded."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n  \"webhookId\": \"string\",\n  \"responseStatusCode\": 200,\n  \"responseStatusStr\": \"200 OK\",\n  \"timestamp\": \"string\",\n  \"status\": \"completed\",\n  \"statusDescription\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The webhook has no delivery with the given delivery ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no webhook with the given webhook ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read sandbox organisation
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-sandbox-org

---
id: config-read-sandbox-org
title: "Read sandbox organisation"
description: "Reads one sandbox organisation of the organisation. Give the sandbox organisation ID in the path."
sidebar_label: "Read sandbox organisation"
hide_title: true
hide_table_of_contents: true
api: eJztWm1v2zgS/isDfmoA+S1JX85YLC4bd3tuu03RpMmHboDQ0thmI5EqSdn1Bf7vhyElWZLlOH3J3gF7XxJb4gyHD4fzzAx9xyI0oRapFUqyIfuAPDKgJILhMpqor6D0jEthOA0ANQU7x9qzLrwSC3SPW0XGIxDSvU65nXf/lH/KizmCRpMqaRB4bBTMxAKNG3SWohyPAGWUKiGtKaZc8jhGW3xrm6kLH42zw2BF3Cpwn4DDXMUR6lKTBi4Bv1rUkscwvgCzMhYTkrBzYXbMMd5tAMy5AamKJUSYxmqVoLQB8Dh2YoVdMBUYR8aZ5MxIUrsCY7WQsy4LmEpRO53jiA1ZqORUzGhrzv20Z3rGApZyzRO0qA0bfrprbORHKb5kCCJCacVUoL4XOhYwQVK0RSxgkifIhsyUs40jFjCNXzKhMWJDqzMMmAnnmHA2vGN2lbrxzn62Xl/TYL+/ht4f9vv0r24heYFBvRAheYPNtDT3GhgqaVFaUsTTNBahe9P7bEjb3bY1avIZQ1uz+1NlSew6YKkmoK3wVlbetRvbtudLYec7HVdYk7sbLcAKG5Nhm028Enb+shD4XWmng6DmcXw2dbvaXEzdZBFtwx/8iCewdbH7+9SOhEljvgIavU9jTXKf4n9lCZegkUd8EiNUXu6bRjn4RuW5Gz8AnfEWLNwYFQpuMdo+yTSLsdxmpqJZSIsz1Fuqz91ACFW0F6AYoxnqmr27tN5rsNdDGoWcam6szkKbaXyv1UJEqPfj8a6ynXUdkBZK1gFboDYP2s1LP/A+AMDHt0yXcGgVP8ADP6j4XmAL3sFQ+dBOqq3OjD2R4Vw9AIwLGgzcja4dIA2j8cjBbK7c+W4BeKJUjFxub6CMKHahgeUc7Rz1broBHloD3AAvWKu6BwbDTOMlz2L7XX6TapFwvQKvBxZOUV1v1c251nxF5JDFMZ3MggZ2TVNSd1U/hXhud29ZZtB0gaKtY0hHkAZuaM4bwkvuZd/qbI7XLCZtp3VNx07N1DjhM/y+SEHiIEi+arIwwCcGpX2YvRUlBH6oFqh/wCYn/8NGVbWwKlAfdbzfqvfZJBYhfPzwFqZKN6CqL/J79VUMdAo1Uvw7echBuBAJGsuTdA8US24g10tTZGn0KFPE3FjIlfuI8gcX8vvjiPBZVMKFbNDMup4KiajI9OqaW3m0pL0KV+0kmQ095KG8HnZbomY9mDX8rekv1e2u7kuJ3fU6uD8L5DOU9tznnkX+5dW688TjsTEZ6j/Q8ohbTglZZudKi387KEmy9lYqOoQ+Ia3o+7y8NeXXrXSz1Yi9Z+E3btCdhIfXRSxg+JUnqUs+59amZtjrRZioDk9FV8w0l7YrVG9x1KvK9Z69ePEPHPDj8OnkcHrU7/cH/Ch6Phj08qw9P3jtkO1PSzdr2CgB4bRAkqu5v947KVavXdXq3D9SYUY+S2WcsVwTfcPZeHR8eTqGaayWjwZHr7vEOO7cSrWUPTpCIupsVtbxKyPM7vOlb4GtpseVUj8NuamQkRO36hblpmzl+WOTpanSlHE6uIBsNn8RsrTsTm3tHb92V7u0ncRvAbVwlaqizfofBqpBGfkorNFksRPjTS/nMsSy11BM8HgQVtdDQNVi07cA9Pr87B1c4QTe4ArO97VkthwNIfVsfosrA1OtkjoCBMmCx4KCutcrZpK7+qOB4uNhRdiw9Xp9vSbOLOdodgio+GY7lPU3XZSTMEG4QGPBh8jtOrEtNaBEZ+MmaKxpJ+adFgw2nD08rFaY/d3FIROvCLQKgQ/ZoNvv9gsiH7IGl7sH20XQlMcGGxVKv1lZUFLfyMHbF/Ns2mfNzHjXyEEze7jfNQ57Sk4U11HP5ZLtvvFs2u8tcbKViPwU1YNC9SaFHTx/evz8+OnzZ8e1tLP6uMgSc6Dbc4mfSvb3cf1fT6N7WPS/wT67yOfxwngzij9KEFwHbI48cl3mO/p23B9Q9HtwO7aaeKPWSp+qiNzJfR5VIuF1sKfbuZFuK8HKOH3c769b1LeQ3IY+fuMRCJlmFsquult8s3nJPspi85EqoCY0x39jaC4aN0NlR+aevrkwMB51t4B86i8M/qZAjmV+KZXn9G6aBkZFn07YlbsnOEnFG6SP13T7YvmMLoXYSMyE5TF4foYnvqF9fHl6wIIi70BDqCRo54p4dYYOFLoIGjJiMd+d7eW72FF61rur3gytXfVOhrbdQ40wUVBGyGwPazKq3BvNH62iLKyUOFtq9mk4t3wm5GyXuPGvm4ZcbwA+Jz/z7lHAvOmK+gf5/ZnfoUruVyWKrcTv5P2Y0mBXyBG9hXnSTAdpweOs7G7f1PTcgJ8GEupOT6iRi1PxFSN/qG68jXADT6TKk2iruYgdBikP8SAA7M66DbVDyAV/WalMExydW1z9etN1nSMhp6o4kjx0RxITLgjIvBj85wa8cv0+n/SP6qhXN6wBSylUdLup/x0qOkUWQdB/Sn5rN9L5TQ1lzZeoxVS4u6PTMm8wLvl2yfSTvMQ7cNVsu+B7jaacojw17w/IIqtCFbsmtTBAW4iSZEwe3zyY7uLZ5SqB62EHbrIFzbCCKD+VYcW8zLjtsVxGXEem49YrqLampoXxW5sj7ay9OjqFy1N48vrq4iCA8cuL3+F81Hl9dQGXp3628fkZDF70B0edp5CMVNhLRm+rVehU6YRbV7bHIkRpXMwrPDfl4Rzh0OX+9a1bLpdd7l53KRjksqb3dnz68t35yw7JrDfXnZvtJLCKLkNxIjaFxmH/8Lh71B2QbKqMTbis2EO33+3XZ1vXiyVr/P/XDP8bv2bIQ6XFr7aXxlS3rHOfusuJ5hNbHPor/qkg0qyQDQvYsPZDhOuAzZWxJHR3N+GGSrH1mh5/yVA7CgzYgmvhL6mIkYShz1FZLu10mCcf8kTiAL75BxStqyxYQhJFuJjuS+ZbIpH6DyzW12Wq7az2Q07CEFNbEd5KhNZV9n718iKvjeocdes4Kv9Q+V1B3bAmXXkT6G+lo14X+YUO9Rtc/VoO9292CpQU6UcTTNRn+Q/axszD
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read sandbox organisation</h1>

<MethodEndpoint method={"get"} path={"/v2/config/sandbox-org/{sandboxOrgId}"}></MethodEndpoint>



Reads one sandbox organisation of the organisation. Give the sandbox organisation ID in the path.

The response also gives the OpenID endpoints of the wallet of the sandbox organisation. Use these endpoints to point a holder wallet or an external IT system to this sandbox organisation. If the sandbox organisation has no OpenID deployment, all the endpoint fields hold an empty string.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returns the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human readable description of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdDeploymentId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the associated OpenID deployment"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Status code of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the associated ledger"}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the infrastructure provider"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the sandbox organisation configuration"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role of the sandbox organisation in the ecosystem"}}></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trust anchor identifier or DID"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this sandbox organisation acts as a wallet provider"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVault"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the primary secure vault"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVaults"} required={false} schemaName={"integer[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Identifiers of the secure vaults that the sandbox organisation uses. The field holds `null` when the sandbox organisation has no secure vault.","items":{"type":"integer"}}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the logo image. The field is absent when the sandbox organisation has no logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cover image. The field is absent when the sandbox organisation has no cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the logo image"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the cover image"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was created"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was last updated"}}></SchemaItem><SchemaItem collapsible={false} name={"isMain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this is the main organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"agentServiceEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the wallet of the sandbox organisation.","example":"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuerMetadata"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the credential issuer metadata of the sandbox organisation. A wallet reads this document to start an OID4VCI flow.","example":"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/.well-known/openid-credential-issuer"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationServerMetadata"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the authorization server metadata of the sandbox organisation. A wallet reads this document to find the token endpoint and the supported grant types.","example":"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/.well-known/oauth-authorization-server"}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI notification endpoint of the sandbox organisation. A wallet sends the result of a credential issuance to this endpoint.","example":"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/notification"}}></SchemaItem><SchemaItem collapsible={false} name={"jwksEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the JSON Web Key Set of the sandbox organisation. A wallet reads the public keys from this endpoint to validate the signature of a credential.","example":"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/jwks"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"openIdDeploymentId\": \"string\",\n    \"status\": 0,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"string\",\n    \"version\": \"string\",\n    \"role\": \"string\",\n    \"trustAnchor\": \"string\",\n    \"isWalletProvider\": true,\n    \"secureVault\": 0,\n    \"secureVaults\": [\n      0\n    ],\n    \"logoImageId\": \"string\",\n    \"coverImageId\": \"string\",\n    \"logoImageUrl\": \"string\",\n    \"coverImageUrl\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"isMain\": true,\n    \"agentServiceEndpoint\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service\",\n    \"credentialIssuerMetadata\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/.well-known/openid-credential-issuer\",\n    \"authorizationServerMetadata\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/.well-known/oauth-authorization-server\",\n    \"notificationEndpoint\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/notification\",\n    \"jwksEndpoint\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/jwks\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"6889e1a4c5b2f30001a3d710\",\n    \"name\": \"Acme Test Issuer\",\n    \"description\": \"Sandbox organisation for issuance tests\",\n    \"openIdDeploymentId\": \"6889e1a4c5b2f30001a3d711\",\n    \"status\": 2,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"iGrant\",\n    \"version\": \"1.0.0\",\n    \"role\": \"\",\n    \"trustAnchor\": \"\",\n    \"isWalletProvider\": false,\n    \"secureVault\": 0,\n    \"secureVaults\": null,\n    \"logoImageId\": \"6889e1a4c5b2f30001a3d6f0\",\n    \"coverImageId\": \"6889e1a4c5b2f30001a3d6f1\",\n    \"logoImageUrl\": \"https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f0/web\",\n    \"coverImageUrl\": \"https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f1/web\",\n    \"createdAt\": 1754745764,\n    \"updatedAt\": 1754745764,\n    \"isMain\": false,\n    \"agentServiceEndpoint\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service\",\n    \"credentialIssuerMetadata\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/.well-known/openid-credential-issuer\",\n    \"authorizationServerMetadata\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/.well-known/oauth-authorization-server\",\n    \"notificationEndpoint\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/notification\",\n    \"jwksEndpoint\": \"https://demo-api.igrant.io/v3/organisation/6889e1a4c5b2f30001a3d711/service/jwks\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no sandbox organisation with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read webhook event types
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-webhook-event-types

---
id: config-read-webhook-event-types
title: "Read webhook event types"
description: "This endpoint lists all the webhook event types that you can subscribe to. Use these values in the `subscribedEvents` field when you create or update a webhook. The list is the same for all organisations."
sidebar_label: "Read webhook event types"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zgW/isHfGoXipymHWBhDAbTjbMDT2e2xSZtHtogPhaPLY4pUiUpu97A/31wSMmW7WSdzuNiXxJZPJeP37naD0JS7ajAQFIMZ6g9ZUKSL5yqg7JGDMVNqTyQkbVVJoBWPnhArSGUBCualtYugJZkAoR1TR5CiQHWtoECDfhmyramBMHm8NETq3mCJeqGPCgTzUy2YvKKLfkJzBRpCauSTLLlCAOBddDUkp+w853DTUkRFigfrXmsCGbWRZTWzdEoj3wZn38xXwyLWyfJgZ1F+R0WwqIEdA7XUJRo5uRhSmFFZKBArX0OIwvGBpBUk5FgE/xoLf9iRCZsTS76GksxFIU1MzX/N6G8TWDj7W6YJpEJR762xpMXwwdxcX7O/wprApnAj1jXWhXR2OAPz6F4EL4oqUJ+qh27CippF2zHhN/R4JwqMuHY3/DhKK60FzdmrLUD1dZQpNe3kh5sUTQuhQUNKCPVUskGNczVkjzHx9Gs8eQ7Uxm/Q7/wECxI0hQoA2lXRluUvXiGkpQDiQFzkQkVqIqQGZoYCh+cMnORiaCCpsTsqQtngkxTieHnTjhHre2KpMh2b5pg7+lbrdxaZCJ6TxhzZVRQsSra9wnn8fvuLnmBpiCtjzSO3m81jm0l332NDqlUvoN/t8k6XmKuik1S/x3dgkKtsaC/GH5OZrYE1c7U0wkQa43cklxbnh4wqUvlC2194whw7igGCBwV1slnRffkbXaxZdE+Wv58v/N/v/V/n/w/zp6aq4D6FrWmv1o6kbtkB1bR0KPMyYbvCsj1Yahggxl/ciTJBIUalPcNJ0AsnP7BkpyatR2h1/W4ZaAyqfeNxqNLW1V76NDIePa+JjMevfl02T99Xjz+Oz+HE+PtARE9fwn3xNZklMz/NumaLzpKGCPAccTc4f2whzcZaB20RO/sTElbM+deExuz5jbfcVI7G2xhdd5LnxbIjuXczmbk7rnmUjt/9NhRQWoZC/RYZPd4z7E8LYXF4jlCBdXhtFzqIY+Ldal1L8moJ2SCXZA5Al5GKp9wybMwJcxzpA9ue0L28NK1I45NKgJHXxvyIUYrX74+IdUF7WnJ/oeE85myLQMsfdxfNjzqvzbK8Yr1+Xmj63TFnWqRd1sYdvoHFUFsGMh+ob5/JzJREkpyXP8s8Ob81XftIf2bkXPWXVpJXGD8POp5O8KTHewwO+1dJ1Im0Jwc2/uGVc3N6M35+eYR8490r62K+AdKUKZuAtTosKJAjuk4JuSjwSaU1qn/xJzbp+aH71zR/reoGZtAzqDuRn50c8DRJhOeisapsBbDzw/iba3eET/ebfiOOPfMRZurfO2KQml5U55TvDWGUgzFYHkxSKvzoF3y/SCOgLPQZn/C4KOTfZgjqmwLUWSicVoMRRlC7YeDgaTKnmGtcjV3aEKurNhkhwY+OCubOJefMnPKwnXAOc/4J9R9Oj4Ecrfj7ppTKEW+Y3AbQkwvMqHYVSJfZMJgxadv2+yNKXk8lz+MYUFr4BznBttfJeL87L4RTfbsTCC5garxAaYEtaOZ+kYSViqUMEkYYQIvjE2bPASHSkcOaizoZQaUz/MDs0NoFX9c28YxHWcLWv80yWPHVGZmu2rDIlYbVaiYSN/UtXXh5x152/urX3av9lnvB+yAlq0SbwhLJeMeW1gukECg+H/VdfqOobSbxMXvU1zLcKoJLreTy8O4W+NetDvNy95Sc6j4oTdM4MV28Xm53Vni3qM8cAjJsI5vv9omMuPXqzi0M+CJmkVncWNcb7exogev8TE8AY1EJ/1ZvK9CE2Cm7cqn0LZMR7S3ry/h0yW8+PX25mUG46ubf8L16OzX2xv4dJm8ja/fw6u/n796ffYDVCNbDKrRb/39dWZdhSFunFoVZHxsZ13m1liUBBf5+VHoVqtVjvE4t24+aHX94Lfx5dW/rq/OWGezW1Z34WSypC2abfREJrhtpLBfnF+8yV/nr1i3tj5UaHp4+Ev7Yz9vHBZVbx78/5eS7/mlpO1ngb6FQa1RGY5DDPxDOwc+i+VF+gY8Uzy0ulnA86s3De4yUVofWP7hYYqePjq92fDrrw25OH0ysUQXKy3Oom5oxfGx4PYq3sZFk/ODrxj77MFo3/TH1S9XNyIT3Ef3W/Mitub2ga13R2bds33YpRME/svD5FGVHzmX39H6p614OnlSYTsZkjTTe7fZbP4E6DcXqA==
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read webhook event types</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhooks/event-types"}></MethodEndpoint>



This endpoint lists all the webhook event types that you can subscribe to. Use these values in the `subscribedEvents` field when you create or update a webhook. The list is the same for all organisations.

The order of the values in each array changes between calls. Do not depend on the order.


<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"consentManagementWebhookEventTypes"} required={true} schemaName={"consentManagementWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`consent.allowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.update.initiated`, `data.download.cancelled`, `data.update.cancelled`, `data.download.initiated`, `data.delete.cancelled`, `consent.disallowed`]"} schema={{"description":"The event types for consent management. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","title":"consentManagementWebhookEventTypes","enum":["consent.allowed","consent.auto_expiry","data.delete.initiated","data.update.initiated","data.download.cancelled","data.update.cancelled","data.download.initiated","data.delete.cancelled","consent.disallowed"]},"type":"array"}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhookEventTypes"} required={true} schemaName={"dataMarketplaceWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"description":"The event types for the data marketplace. These events occur when the server creates a data disclosure agreement record.","items":{"type":"string","title":"dataMarketplaceWebhookEventTypes","enum":["datamarketplace.data_disclosure_agreement_record"]},"type":"array"}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhookEventTypes"} required={true} schemaName={"digitalWalletWebhookEventTypes[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"description":"The event types for the digital wallet. These events occur during a connection, a credential issuance or a credential verification. The list contains the DIDComm event types and the OpenID4VC event types.","items":{"type":"string","title":"digitalWalletWebhookEventTypes","description":"A digital wallet event type. The `openid.*` values are the OID4VCI and OpenID4VP event types. The `digitalwallet.*` values belong to the older DIDComm protocol.","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"consentManagementWebhookEventTypes\": [\n    \"consent.allowed\"\n  ],\n  \"dataMarketplaceWebhookEventTypes\": [\n    \"datamarketplace.data_disclosure_agreement_record\"\n  ],\n  \"digitalWalletWebhookEventTypes\": [\n    \"openid.credential.offer_sent\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Read webhook
Source: https://docs.igrant.io/docs/openid4vc-api/config-read-webhook

---
id: config-read-webhook
title: "Read webhook"
description: "This endpoint reads 1 webhook of the organisation by its ID."
sidebar_label: "Read webhook"
hide_title: true
hide_table_of_contents: true
api: eJzlWetz27gR/1d28Cm5oR5+JM2pNzdNLfdGl6TOxE7cXOKxIGIl4UwCDABKVj363zsLgCIpyZXv8an9ksjkPn7YXeyLD0xgYTDlDgUbTHlmMWECbWpk4aRWbMCu5tICKlFoqRwY5MLCESxxMtf6DvQU3BxBmxlX0nLigckKpLMwGnZZwnSBxj8eCTZgqVZTOfuAXFwHASxhBTc8R4fGssGXhx3tCKNhpabS6rQHQvLxnudFhmzAXr7iR9Pj9ESc4ovpS/6Xyav0e9HHI5YwSaIK7uYsYYrnRB1FjQRLmMFvpTRkAWdKTJhN55hzNnhgblUQsXVGqhlbJ8y6lVdmpde6viFuW2hl0RLDcb9P/6VaOVSOfvKiyGTqTdD71dKhHhoKCkMGcjJwR1CeLcsupt4gNbovTBJcbWYedsFXmebio8lYUmm8IsAJs+WErDhBcb5A5SxLmJCWTzIkRoupQfcGV/T7ThaXNvuERk4jTJYwJ3O0jucFu0kqI+jJr5g6/9J5G9QubPvs9cZPwd1lCIB9sdIFcrBFs5ApAs+WfGXBohIWcIFmBVOJmQic0kKAkADep1g4GFuuxETfX5BBxhQNbXNKsevDbbAflfxWIkiBysmpRLMVa0+MsXXllt+vsHWH3Jw70Etl21goAhtn/gPaopj/4o3gBm/36AWVrWCqDfD6IhLMCWZazSzdSr6RK7DI9CpH5bpQB4TBFOUCbZBFONDHJ6GinKGXCmyqC/RHbQT44YN+eBvQbFQ0E0aU1Hbm3LnCDnq9+KSb6rxH1LYnZ4YrRxCa1+oghrNADES1nbKaCFSZ02XeyQxJ69F9Z7lcdqba5J3SZKhSLVCwm/We210j27mk+zLBTob1TvCwbTBiE3ll0ASkghOYGV0WlpyaSyXzMqeTHlXHPQFuDF3ivLQO5joTwNuEta52uBmclhYtcNUgCWikBaUdqScVmbSuihcPpi1HaAzkBnO9QBBlMCnCgmcl2t00kVL2Vu4dV3yGFLHXdRqOZvWH2udvYoR8w9m0pIdl6whP09LAco6KjiiVkAspSp7BLFwIs7FAxJPQM27v/MUSmKHDBIReKoojelcWgo7l5igNCO44HU06zO3hUL3chEXA1whLLynI7kolnfTNQdJ6nnKVYhaqSYTb5Vmml60nVHJ2HvLS6Vu8L6RZVULD4XaVVYfd8yZwNGG0Oeo3N+s1Fb+ZdDy75lmGT3bvMDDB0nO1XXvuq9PFaHj66Sy+8b7z6dJH5V99sI51gUqK7nfjGH7ADYZ0TxkwPvNRzlWUNyLnXhSo6K/3IJXDWSyhClGEwIJxPFNA11AQ0jEFjVeTCTQwHA3PdJ5DYbTTqc66X9VXddXAlxr0JYJnJCmG7FST97wYaW2JBqwUPrM1sOJ9OudqFm9zJW/u9R4UG8i82DZ/YZCiJZSl77qLk21uQrAxUYVhAGPqltC6W+IeJ/XfMYuJMXAlYNyUf8vTO3qR6hxhanTuoS18RxTBJXu4ClRCqtmTBTbP+lX9KVd113l6OkXjDx96772vK1vsJal/3nqnH6Tyhz1MRB3bYbpwsfeTERy61rcClXyExuk7VDvAd6OxoTL68YnUW6c9QLt96FZYN0O1uzg5QFU57XHK3RB8Im20AFGHbMkdf8fNHboi4yk+OV9yxyGv+Z5WDF2jdqcGuQvFMBQaC9xXNhDSppm2pUHgM4Oh2BpMtRF/XtVrYO/S37e11tuN1tuglSwVKkscq2rlE60z5GpH+zUdd0wj5jjZ22GB0tFmAjNJFSZ0/Jtx7fABPSnc4aru4yrjhvqkIeVZWmaxc4Dxvzqjn6jb7VzKmeKuNDiGOXIRRgXk6bxG89h84CsP9WdphtyAw3vfrYURrj5lmJMTsNoXIkwDwOoFcAsrXbbe3WG0wZ4x9XdYfKdJ9Fk+TCJXby8hpa5wGtrF2NHGxh0+fnjrkdSj8eGZ5OoMiPyxQBfNKPDt9fjz58+fO+/edYbDq/l8kOcDa38Z09CVc/dInxtKX9MR2reYsVVrjTzH/eOXnf6rTv/7q6P+4OhocHT8C1uvaY2xOxXsneK7jKK+uZOolhY7m4JwP1piL96whIXooutKBKf9o9+0MWmqRmO0OdOCVh7+97Chbc/mot3319y1J32zhaZptNN+f71H/B7v13b+OxcgVVE62Gy3yBy7BvmoeOnm2sh/+zKxbZrT/2PTfECrS5OiD/KpLpUIF6C1J5lznzWrUF1KN/eXioYqBaOhH6KauVbaOEv5utG294vfuLz737L3SDk0imc+w6ABr2bLRqEalUa6ld9Nvi6kr0tfbiiFOD6jHe5mMXiTsBzdXNPmd4b+1LSDHbDe4rgXskov+qX3sFnIrv2GkiDsWwgPMdcRIUtYSauhzSJHYK47vJDdsL/pSs3WybaA90aLMvXB84iYQxIuHZ9JNXuM3YbX20BuatNdUgQFx1cGrFur8CDurIPt663165gsqj3t1uL1/ciXfkop1IKmja1erAyhpo1bcjb13u9sJgiFwam8RxGu0zhghDE8Uzp2Dc5wmXkbFDzF5wlgd9bdEjuAyPjDSpeGzNG5w9WP41BBpJrq6rLx1F82zLnM/MqqKLRxf6uNtzm//Kl+1LZ602FbZtkwUWexkMJ3lamm++EQ/CI/r3rhykJhtvTbztBzUJMHZ5ve3sIoTiPwLE7Cz/0guJ/xfaPdhmebwfX5ZiD3DbK0QC5ERTw2JrpgTN+5+bEm8YNkGEhj9xI3AZA24JXWu8dxJbgRtuPPK7lyMM300gbXRkt7tNcnZ/DpDJ79fH31PIHR+dU/4HLY+fn6Cj6dBW2jyws4etU/Oum8gHyo014+fNvQGbsUv2DLZIrK+mxWRW7B0znCcbe/47rlctnl/nVXm1kv8tre29HZ+T8vzzvEs643mrU7yVhCp+XGeyxhlDaC24/7x6fdk67fzRfaupyrBh76BlUVhe2L1CgBf/TzV7zV1BH3ioxLRWjKsNAOyfALWxyH9dhUUuauMQ3qb1Q3CZtr64j64WHCLX402XpNj7+VaHwCTtiCGx9tIWtu5pJ9X/WaJ3z2IZax53Dwa9ve41SZS1Ha8nmGDRhL2B0ltsaHtjXtrmNGI4jh/Ws/JDc4d2ruullHfjq/oj15SaZrJs07nzTjD5K+F9V2/gwQ6F9K83tZfqAoe4OrHzfk4c2jDJucHajJRjQr/ges0GA7
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read webhook</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint reads 1 webhook of the organisation by its ID.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to read.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Receive deferred credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-receive-deferred-digital-wallet-open-id-credential

---
id: config-receive-deferred-digital-wallet-open-id-credential
title: "Receive deferred credential"
description: "Polls the OID4VCI Deferred Credential Endpoint to retrieve a credential that was not immediately available during issuance. The wallet uses the acceptance token of the credential record to make the request. If the issuer is not ready, the wallet returns the credential record with the status `credential_pending`. This operation has no request body."
sidebar_label: "Receive deferred credential"
hide_title: true
hide_table_of_contents: true
api: eJztW1tz2ziy/isovqxdR5bvyca1tXU8tjNRkh2rYjveU4nLhIiWhJgEOAAoWZvyf99qACTBi2wlM/u0Jw+xRBFAd6PRl68b3yMGOlE8N1yK6CQayzTVxMyBXI7Ojz6fjcg5TEEpYORMAQNhOE3JhWC55MIQI4kCozgsgFCS1G+YOTVkSTUR0hCeZcA4NZCuCF1QntJJCoQViosZ4VoXVCQwJNdzIEuapmBIocFRQZMEcoO/EyMfQBA5tc+DpRQkUjEkJaMPYH9V8HsB2gzJyL2Na4Ai3JGjgLLVwP7gl1NgCiX0mpmX3MztT9pQU2gS16/c5yAYF7MYqeeayBwURVGSueW9pIRMJFsNo0FUvTBi0UmUSDHls0+QAF9AKehzPuOGpreWtMscxIjVoo8GUU4VzcCA0tHJl++t/bsR/PcCCLevTzkoFFhjZ7SRuJtcWJbmMmWg/qK9JJBEjvPk1MyjQSRoBkhnNXzEokGETHEFLDoxqoBBpJM5ZDQ6+R6ZVY7va4NbGz093eHLOpdCg8bfD/b28E+T5mDfc5mmwCxlrNQ78MrmFKScjiRSGMr9phU5owZYd/OQIXwThMGFaZ6nPLEbsPtN4+rfu9TLyTdIDEpa4XYZ7miv57Yzpenl1G5Ae1STubOuouLRqGVfsm73RTdOAU2XdKUr7YQFqBWZckjZkJy6D242r2wLmuLelyPAqy43mkCWm5V74YTEX6OvUUymUhFK3F4NSLxXPhFFNgE1IPGUphrKpxMpU6CCUMFILIo09T8I4jgn7gtVilpNbwqPs656tEXVq7u9R9KfNicBFKPTAk0z8EKgjWM6YvEweho09fgn6EGGWwS9cJwai148JnMqZrDJ4qPnpAB+Irf7uZKsSOyx4Tp4rbX6NdrPlxe2h4wuyfvb6wG5Ot+xf6Ui2blMmjbYWlVGPoPiU25NeqDsFLXQ2jVGpkpmgR3+iybWrJ1befYO12Tk3QLZ8o5ou88BtVjsO8SUMY6s0XQcaKQzXE3OzyGRDBjJ6SqVlJVs9vNnJTEkZ6EVyqnSaIRSyjNdc317eEY+n5Gt97fX2wMyurh+6+VKPp9Z0Y6uLsn+X/f2D3eOrZh3s/OP4T5am+CUnevy8C3nPIXQiS0pHvSuirZkdGWdWJ8egCiy6ORLhG5qOgV1r9Fqll/K3YwGkeX93m1/FM7d+8y7yOZDmjy033Ouvv2UQQruYRko3DMQHFh01zG1hVIgTOmmu8dmzSElp+UpDt4VUmU0TVfevEgBbkIF3sToYW8gQDKg3UhCADBNMqkwiIBcD+w+wSPN8hQjJ6Oo0DSxkQMqoTWmJKEpKtrG4ViTIivikJ4q2PHHEi25Z7ylMa153L6EU3nXVf7UGY8KK80clJcVSWQGTTtgD3fKp5CsEpSBYCRB/5HnQFWg3ZWt4xo3MFdypkBrq9V1dLihcTtth5NbgeTvubXjlb2pvCjuVRWOPBevco3bhUGMJf3ZvUL6y0nLhxv4pE8fS8XeTCPGCvAYr+Gh5RSteX6ZiGAhN4QE3opqXIcLCIU5JNernCf2QDUcwYRqIMhUgZbTphNapgu39d11/gGGMmqoJTxXcFqYuVRcAzuTDF6mfKxgh7ox/8Lzjket0srgvFqT1xReKHKc5rSeBtcmb1O5tGQVGtSYb+Jp24d+yzze44dtUkbYP7ZyogCj4NNQj7gwMAPVF9w8EsMz0IZmOdnigmhIpGB6myznINrBRJUMUfsU18Eoz5uw6GT/9fGe+4cicOH4f5yQlGpDMslQ83rJeWXJcV7px6ghW20qgjTSxj1tL7tudWlTuEs1o4LrKvf76WDYh04ymI9sMZczluaIQZ7KVQbCbPsEwcfI3fhQ/ll0NQh6YVF/RD5VeWS1qs8yOsve4h7EGLXFg9ADZYW2AfCCs14/Wh8pI9EJ5RhNbHSiiHUp5JOHEpqW8i1GB73mOgiiFsn/aLbzbYkx1CKvP7Pg+beluV8k9zYXLb9FgyjT8j5jMukGOW7lUuiVLw/OxxoDHAdLxS6Lc09iQlUzSEWrk1GjBySueIjxS15/sRNUnLg5mqFtPYt9t2QpRkeOtPdGvW5MK+J1yWshDE/DQOZByKWbyo/yTgFN9sb6HHiulIsHRKTaBsdIQkk4bxWTDAifBvGUxgzAOMSFrQTNeFKHOlPUKS4WMl3gIv0Z0DhcZcu9c/R5vG1Z4233vAZyOOc6T+mKcOHkgnPRiSxMJx62Ew5Knxskaus9byP5U8/BFXZj+MLvox44MMLtpdsM7UwrNxj5OWSudv5Z5epDwOmLg6QGUSodjGPxnYW15KmcyZYw7to4hAO0XlKKUoL4doth3Ihq7Rcn+ujf7JnEUf0jAV8VNNmhhGd0Bp6emfy5mXBkMFFjwItCqr912HtqWMszC3MWDvjUfyxJDzQzCaf9cd11TsoigqBdmtX0VFa3H2CFSXWKpzd0G6V6etvTTOjiRWINJpMJcoofGyntlAvLrrfDzKmbw6jMYyuUXXPKu9Fj7H1dvE1qjJgYim6skk5JfyClSxfsVtwWGogWiKUnGJ1PIKH4yMxhRTKuVCskXXIFDbvdAtXj71+jFMTMzL9GJ2RvQL5GXOSFuc8kA3yEaCQ+DfgrHz/FdfRlY/IS6mw7+i7i6JbcIOT7zcKdqBvJnCqaOKmVIG0nophTD9JWaCsip5tTWQWJR2jSK0Fs4KnwXdS7uazzgvYKg7XuXxQZKI7e3ubAmtiYEZGNdDUksYFHU/9G03xO/YhALI39dYC1pcKJopKZP18aBNNWw5kEV3pJ5pA8EG5aEnRO4SdkGHkaf9h4jYQ2qnCzlrL0IaVlAx7z1OJ6czz3ksygXx3Q1jX9k9e7xt62nBIiFz7itLbrHAzlaWgYLYreRS/CQYS5UR2xV7CFh7vKc1rGs65+0g8qlqJYn2YOIm4g6zXiTWIvcTw5GO4R2kO2y/dxuZK8VlyCMVNbmT+9PSNvDt+8+nNsVcdiOH5ehJD6uMEhbauAeR9n9zVfVcHkGZar0mVDyztTNbOR+4YnvN+k1vJseaHpWL0abRwSNigfz6WRjQJmk/I6j+xT/7aqlXXFZ4KCYMI/dDJKI2dtWIX+gi7R3x6x1KliyyRY6p/fsLVCuXOTLXwguR6978fC65EeFh+S+LKsQaNKOkx3QVPOBiT+BAsZoMY5qIwKECbFbMK+hLjOgMRXhUbEO0CFIculooo3X+3N5CpD74UssLLpfIPHVRyttjhSvRwoaOVPdJHnUoVsDps5eMBrNIg8e9Egqui31jiFGU3HnJ0agzDUhrE9DiJjUFqKCgD1st76OB6dbxNaz9dEFwOtHFTQ5wLzwBY+ainzSm1WpdJd3JyPiGsQIJBIvdIGMpcKdDkZy3wTYFTKKRI2llqD1paJsRxvVy6hIglZCzkbOPzFJs7VUcOau5K+lYRqLRNuC/S54gtqrPFu0Oty4I2goJFgKGaw2aOtMTxLno0jJgCC6CJJQOtpgSj0wi/o6giFkT71/hksqsx/CyMx3XYwtwcMOgCYU2hKMmqSeY0EHH0ek6Zr8ebE1fMdxGCJXYDSGynoZ/diu15QuZpcSSMTGfji3gyIwZQWqaUjZopOzf3+YRweM0/Q/d6+PUyJWuVGzhTN5zz5AKva1bxM8gdYhdDiVvzAWbxdcqD5TKDESuVpr7QelXsOQwtmPcFcjJ08wCpG0xM/Hu+9iVsWxb8QDSL81XIMjzma+toVWIfyRxzaKb6PBOYKFlwWGq2qg50bwBQuU7aALLBWZgmxwukQtQk9GyTk62llvn7uVw4p9SV1V7XzrlFfCLuBTV3e+NBVPt1NRsDNBqwvxS19u+5VcweulSbolpv5tSq0+cj1T5kDT5lVr9bRp7oyPITOMMEwWOf10QC6AVyYpNwjzvbrFagFT2DsUO5eAPBHmhxc1uCV362n3QolkK4ICKNWTrGsnfJu2XPmO/dqWj1T3gOvaVdo+vypLATD/M7O70oRaP8wy3j5BNfJhYVVKwPWE1EPSTxVUhhEbAWksavVTpRcaqs+jCtILNY9oclD8y2UC6gdI3fcJ6wgZIXoZ9TFNptkUIE1CUmLBlFAQjdN9A7hR6TTTL3KZkREAks6mz6nWU/k2sUYN4Kb/tBowzPRPAVcE1pGLzg1CeYmW7c3p9sWNMD4jhIFsyKlquGVPkE7XdK2/mBHuA4/BNONRKQBGRGyjs02KQrE4YB7zuJ2C9OgLsx67302Ir8Fg5p1/nC6zWv9vfP1IMnh7FebhTBuawidGh8+1emOy5jCOcsWlGBJaiMp6+auN8qa8a2SdDfYN2D0CrbCUSdAFSjnjM/HcuwgUpbL/P3y4WUM4v3V5W/kFiYE44qt97cfsLLuA7MyYK26gfJikvIEwwBLAy5HJtx29XSxAprONoAK0plU3MwzgtgjZht2ZgQoqp5iG8uEGfPF1cHxKxfdLDZpxQhCIJIUatECyMY7frqHTWABlNPovMpIrG3GHtEcElSHLrVOejteTjv708PD/UOYvqH0zZH9C3tHe3v0dbI/fbVHk53J8TEk9M1x8ubo4Oh4Mp3sT44mB4fw+mBy/JodHFpKzWozSi3q0hTeGU7w+PLwf5JESsW4wGSkPMsXZ6ESbP1CNbw6QmMJwkY2283FpvTm3fnx6eLVdDQeXxXvrlbyYpnc7J/+c7/45V7xyT9evVHv3k6u/nqKVG3A1P/9CVTNjj4c/LrYW/LZu2z87Za/PjiaqNO3v8/uH1P4YMzt49vj4/T01+urow5QgZJ3iodCRJLv2q+0sIpR82vQ4dptPW10ava0JHb7uXo6pHr6lfo6geo2nLAtJuxMWdOY0emI6HYr9DQCdOrOVbX2mTpYVetZAwf34D79UMXatL8nv24mu3U26WPNU5HMJVL9YDd6XWbTm170RvbrI+s10W0YB64JgNZHJndPnYaJm7VXA4LwLW4rY0z0HLsLehoq+bSZf6RAdacdyEJXvf2hvNuWqok2PE3ryykNCPIBIPf97a5Z0wOQckri1oGxNcfWiWkWH52+Np811RJ/c3qJn/oUE59Xe+RLmH375LtEKrBOwVSBtm4vI9I3dlUXYmzVGK3NHChzcDB+O3I3Rja+wxHaKkD8358w+zkoWWNrwPP3PerRfTXEuoxnm7w60/e1BlU2+heKGDSW86pCbcl9txm/0VjlrzB5vLalSKNz/L0Q2BgjrAb2XqRplcErVJwKYtkYkneuElbtjQuvaaqli7GrO1z+CgkVbCIfG5SiU2rv5P5/8U7eiLrvtCOa4/9qJR8JA0rgXRqXZNtlWjJ6GkQakkJxjA2/fI9Oc/4B8KO1+IbO8DJc5K/Olcll1UB1th0NIqfUKBJXQ8dbboWVCN51O4l2Fwe7DonZ9e2UO84C77ry265m35Zmtz5vu9/DOOhp16O0O+WBi5Bm5Kjvot45ZNIzjCGGSjGYNibXJ7u7DDK5Q3M+5DNFhRlyGT0N2hOM7a0fV9npn+alGa4MnWEWtGa4dj+3Cbmrd+IKFdLpUbkfNcLoHvjrhG4r6wuFDdShmzeNRzbWxROD4g3hFldf9RYsbswTE7eMawqdIJwFU/5YXoOLHY0kJltC+iZQoyhPrQxymsD2gMBwNmxNe0L8wL+tZKFQHDsPsPp77Op82GRXnl2a2LMLGeUoSF+c+t9aeBX//Nf6UVPq4Ya1xFINKnE6bbFD39PK8W9WNQ82u4V/7KIVeu0f60+sagnaX83DLQSBY7R3C//yngRRGXQ8A5t5uxDBV77KLuYkIK/QdnsMFYwqpncsv5xiU36KAZrd2rIMiNQ+f9sKV3vhulXZt4oeLOUJCA1152B0mtNkDgiudbZuuVwOqf15KNVs14/Vux9HZxe/XV3s4BjEdLlJGzpghcVkUlS7F8TlJ9HB3sHR8HC4b7tbpTYZFQE9/vJw7eUbOVarJ6ZyMP9/z/s/fM/bW0Hsqtq1nUS27V3ZG4rO33yJFgfucvKUWySg4XN8emqTMOt32tnzSedOdsv53A2iuUS0+Ev0/Ttes7lR6dMTPv69AGVd5yBaUGUPtnNQXONnFp3Yi7/PaM9WmQtvkz/hwnmvrEo3ItCHWKMfnSBgjqW31oX0p7sqa7B8uFfcVa9gcCekegpDgfHNtU83m07Mlfr8h+C6d5Owtj9zJOD/6HZ7h/wNT/0HWP29et39snZA5UPd2yimu6enp38DdblDVw==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Receive deferred credential</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/{credentialId}/receive-deferred"}></MethodEndpoint>



Polls the OID4VCI Deferred Credential Endpoint to retrieve a credential that was not immediately available during issuance. The wallet uses the acceptance token of the credential record to make the request. If the issuer is not ready, the wallet returns the credential record with the status `credential_pending`. This operation has no request body.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a credential stored in the holder's wallet.","in":"path","name":"credentialId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet polled the deferred endpoint. The response contains the updated credential record.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential record that the holder wallet stores. The wallet always returns every field. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request.","items":{"type":"string"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of previously issued credential tokens that have expired.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of decoded expired credential payloads.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": {\n    \"id\": \"string\",\n    \"credentialId\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"credentialToken\": \"string\",\n    \"credential\": {},\n    \"credentialStatus\": \"\",\n    \"acceptanceToken\": \"string\",\n    \"deferredEndpoint\": \"string\",\n    \"credentialIssuer\": \"string\",\n    \"preAuthorisedCode\": \"string\",\n    \"userPin\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"issuedAt\": 1750000600,\n    \"openIdOrganisationId\": \"string\",\n    \"organisationId\": \"string\",\n    \"userPinRequired\": true,\n    \"credentialFormat\": \"\",\n    \"presentationId\": \"string\",\n    \"issuer\": {\n      \"name\": \"string\",\n      \"location\": \"string\",\n      \"cover\": \"string\",\n      \"logo\": \"string\",\n      \"description\": \"string\"\n    },\n    \"credentialConfigurations\": {},\n    \"txCode\": {\n      \"length\": 4,\n      \"input_mode\": \"numeric\",\n      \"description\": \"string\"\n    },\n    \"authorizationDetails\": [\n      {\n        \"type\": \"openid_credential\",\n        \"credential_configuration_id\": \"PhotoIdCredential\",\n        \"credential_identifiers\": [\n          \"string\"\n        ]\n      }\n    ],\n    \"revocationStatus\": \"\",\n    \"legalPidAttestation\": \"string\",\n    \"legalPidAttestationPop\": \"string\",\n    \"legalPidVerified\": true,\n    \"autoPresent\": true,\n    \"version\": \"version_01\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"\",\n    \"expiredCredentialTokens\": [\n      \"string\"\n    ],\n    \"expiredCredentials\": [\n      {}\n    ],\n    \"requiresEncryption\": true,\n    \"isVerifiedWithTrustList\": true,\n    \"trustServiceProvider\": {},\n    \"oAuthFlow\": \"\",\n    \"authorizationRequest\": \"string\",\n    \"isWalletUnitAttestation\": true,\n    \"notificationId\": \"string\",\n    \"notificationEndpoint\": \"string\",\n    \"notificationSent\": true,\n    \"accessTokenType\": \"string\",\n    \"dpopJwk\": {\n      \"alg\": \"ES256\",\n      \"crv\": \"P-256\",\n      \"kid\": \"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23\",\n      \"kty\": \"EC\",\n      \"x\": \"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A\",\n      \"y\": \"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the credential ID is unknown, or the deferred endpoint of the issuer returned an error. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Receive credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential

---
id: config-receive-digital-wallet-open-id-credential
title: "Receive credential"
description: "Processes an OID4VCI Credential Offer and initiates the credential issuance flow. The wallet resolves the issuer's metadata, performs token exchange, and receives the credential."
sidebar_label: "Receive credential"
hide_title: true
hide_table_of_contents: true
api: eJzlWN1z2zYS/1d28HLJDC3Jjp22ml7vXNlt1WbOmtiJH1JPBRFLETEIsAAoW/Xof79ZAJRIWU7v4V46fbFFfOz3/nYXT0ygy62svTSajdnMmhydQwdcw9X04vTjZAoTiwK1l1zBVVGgBa4FSC295B4d+BIh3x2RzjVc5wiFMg8DuCkRHrhS6MGiM2qVbtAxtP9wUKHngnueQY22MLZy4M09asDHvOR6iVngZzFHuXrGbsAyZmq0nBSYCjZmudGFXL6Pxy/kUnquboMAVzXqqdhpwzJm8fcGnf/eiDUbP+0Zo6O32epN7O9xDRX3aGnLl9yH1aRlQ9bzphX4gLzEVFoUbOxtgxlJ7FF7EoDXtZJ5UGb42ZEUT8zlJVacfvl1jWzMzOIz5p5lrLakupfoaHfHJHipc8F5K/WSZayS+h3qpS/Z+Dh7Wdvo5a1i0VXgUIugGa2VRgm0A/ixVbFolIK5qVFLcbQT5ShYbjwczuHD+ykYux8u0bK0t8+vbhZKuhJdL4i4cgZ4nmPtYywUEpUAzSuE+aRvgjk8SF8Ch5zXFAYwn8zJAfjIq1oFU74o7792a7+Ftd8aK/9Zel+78XAosDJHvJYDubRc+4E0w9XJ0Ngl19JF9709wZNvxGl+LL4642dni1PMxQjPRkOHdiVzHO4zHb59ezYSb/I3i68Xx/kJPy5G4hs8zb9im4zxxpuZRZfiJDl2YYxCrtm+L29L1DCn6Jpn3disIwUynHRdLxD5inuZc6XWIAvgoCjAIeTMxenHGZw3vjRW/hG0g/cxcSgN8hIdSB+9JLDgjfIgHcwLrhwGg6dVNg5LHQeE782mmxOfngXy3WYTj7jaaBeD/WQ0ep6wPawJ2ScOpN//Pd2+iBz78NAKtoeMvrHaAQcn9VIhRJ7kiIPpQipwqR0Y3dPuIE0N3Fq+bontUaiMpQTm+ku0nDc2Qa/F3FgBrjTWqzXwwgeokA5a/2RAGQoWuQATeTrKzo4WOddQcKmgMJaUJmLgZYUBzjVeFWz86bkDXjRyEmpr64hOfen3UOSBr93WRrhCu45IMoDzBCmBWskdaAMrrhoCpnQDRUQW6R1gVft1PDCG+a/sVzZv1Qqwm8F81K7oplqgzdrUSKspi0N5metGqbSh2zCIH8GL/frxiUlBEb21xLT/eZlK6N7yDdXX3krv49pz3ziWsQizVMzbGwILtBbFpRa1kdr3mQfcDomCCS0ciokRyDLWOLQzmbhyj+KcLje12P42oTxfdTA0iG32FxKl960VuiL8YGzFY64GpNvdkq1wu8OT0Ck0sXcgff1jEpZ3se4CPZfKBcOvTESLrYkULrmaSXHuPbrI7vDqzNSdjY9oZSGD8F1kz9gKrYs0vG2cP9d5aUjq++BofKxJ5Unfk+7QjtsFirvUuV3XSTbpWua30pc3xOWddL7leB2r08yalRTBYIZ8+YMyD/uGSTUg0Iwd1gctfdcSd5tsm8UhfNkmgPkmYyVygZaQlL5OI5z/z9DcTQG01tjkuPD7ogMTd9mfwPju9g7xpfa4DLpvC9XpaLQ5QP5Aj7VrLr7n1CbXjYeaW16hR8uS9s/rVjfMCWi08QQqUmSHS0D/SOqrUudksWhcqn2pwx3ATxETt82yA24xtlNEiK+4VHyhsAUvrsXCPPbkIvDZ99vx39hvH3SbDyGT+6Y5+1uH9FR7tJoroG4XLQQ2ezbaZMxh3ljp16Hcn9fyF6SfdxvSkS8d2SKNcBARBl61HenkNctYDGoySYW+NDT/1SZAUs1pymHUlseJcCgioaPYAgxj6z904vOD7/Tiw9SgMRKORHdBtr52F1iZpBkVJKvYmL08GjBCwWdztmjykOsvkPkzCteeL6VevnTdxe19Qe52Jr+myIsB0xp+h9VxIWOSWEWfsYzRkMXGrDcJPGvLzmfTMCBTapBJY8DH7iu2UakpnPfozCGygapxHhZIs0ohH9tOax5lhDm80sbHkdNbLlWwQc1zfJ0BDpaDPbJjSBe/XZvGkjmO7nH93XzAKPwoC9/vngAu2zg/MEz/RUbFvUkxzlfkx8K0aMTzgEZYcUkR45q6Ntb/exclW0fLH3dL/fDqRuae/7eXoI49BI01uSHDegRJ/6u2M2tDIeZ0qDyxOQmFqNPMwLR9VXqVXqVeh3b58MVZp/nbAcbsNUnkTW5UGAakA4pV1HTHpUL3R6qN3sRimoVZIj5BrYjDGhKOdEqyg8aFOPRcC26FOwr6Sq59eAVzMYaTpYO0t28m8HECr36+vXmdwfTy5ge4vjj6+fYGPk4it+n1FRx/PTp+c3QG1YXJh9XFu24bUIRW11FNVjJH7ULctila87xEOBmMnrnu4eFhwMP2wNjlMN11w3fTyeV/ri+P6M4mY1561YuBYCxh8mbrvU67OmYno5PTwZvBMd0lCK647siTnuOgN3GIftXZVsq/5itkgk6Pj35YKy41WSKY/ikVo09sdRLfHwpJZbVfkNIEFPr8UJT2B7S2MN1lrKQaN/7Enp4W3OEHqzYbWv69QRvqZ8ZW3IZcCNW0Lbuhkt0T0rNJNPbRDUlNx1UTgX+vRaHCE2+ch2Hwi2e7ZXh2dX3DMrZIL6tVaEeY5TRF0N8xo1E5KB3HL2qBaP2JKa6XDV/S+Uh3Ex/Ayn6Fug8VKv3oPBdwve5IuV+sojL0tzub9K58S5H+C66/2x6POy9e2BbIeJpcT2POfwEX2DpG
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Receive credential</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/receive"}></MethodEndpoint>



Processes an OID4VCI Credential Offer and initiates the credential issuance flow. The wallet resolves the issuer's metadata, performs token exchange, and receives the credential.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Credential offer and the key material that the wallet uses to receive the credential.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"credentialOffer"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty`"} schema={{"type":"string","minLength":1,"description":"Credential Offer that the issuer sends to the holder. Give the full `openid-credential-offer://` URI or the credential offer URI that the issuer publishes. The wallet also accepts the field name `CredentialOffer` with a capital `C`.","example":"openid-credential-offer://?credential_offer_uri=https://demo-api.igrant.io/v2/organisation/62e29d4c1d75a55b4ecd0e50/service/credential-offer/6650d3c3b8b1c2a1f0d9e4c7"}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet presents this credential automatically if a later OpenID4VP Authorization Request matches it. The default is `false`.","default":false,"example":false}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet received the credential.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>credential</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential that the wallet received. The wallet returns a single object if the credential offer contains one credential. The wallet returns an array if the offer contains more than one credential. The wallet stores the record shortly after this response, so a read of the same credential can fail for a short time.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the credential offer is not valid, or the issuer refused the request. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Receive DC API verification response
Source: https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-dc-api-response

---
id: config-receive-digital-wallet-open-id-dc-api-response
title: "Receive DC API verification response"
description: "Receives an OpenID4VP Authorization Response delivered over the W3C Digital Credentials API (DC API) transport for a previously created verification request."
sidebar_label: "Receive DC API verification response"
hide_title: true
hide_table_of_contents: true
api: eJztW+lyGzmSfhVE/Rmpo0hJtDxjM2Yn1i3KXqrdtm65bTlEsJAkYVUBZQBFilZoYp9m5j32UfZJNhJHXaRky+uYmIju/tGmqnAkEnl8edRtxEAniueGSxH1o2NIgM9BEyrI2xzEcLB7fkheFGYmFf9CcRQ5Bp1LoYEwSPkcFDAi56CImQG5eLJHBnzKDU3JngIGwnCaavLicEg2Bnv47yYxigqdS2XIRCpCSa5gzmWh0yVJFFADjMxB8QlP3IYKPhegTfdSXIrTGfiXoMhESWFAMMLFXF6DtiSMlVxoUH/SZCTonE+pkaqbVLR0p2A2Nkdkwc3MTvDLEwWmUAJwNTJiyYucH7s3oy45rRYmShbG7xWmGmn/nMmU2Z0XNE3BxGQx48mM5EqyIkGmkooOojwb3eLlUSZSLahiuD415SC3A9cEBMslF4EZtSeE4waOt1SBMGRKDSzosk+4IbQwM9w4oYH2BGlUMUmlvNakyO3DFt8TqRgZL8koV6BBGPt8/yaZUTGFIRvFOEngAW94iyVjyZZkvDTQmUjVwR+BS4VgoNIlF1PCvKg4fhEGeSqXGQjLOlBADi72CYNELa2Ako0FbjcKXPlVMhjhuUcsuaI5735amNFmTM4Pyam8RsKo0rhPDoq8dbK8090m//PPZ92dmAz2jl4TbVSRmEIBmdOUM3vCmFDBcJLm2oBIgFAF+PdEqgyYuzFH8590dUf2yDjzv05PD4k21BTaziwly3PAsZ4UwjGS2cs8w1tuXKgU6ZLYE6+5GsflBdWlzliBbvFGgxVOz58RkarBqy55aZ9wBYm5yqU2I3uA+hM7kExSuXAX7O8KX4UbD/bATkqX4ZhBT1EVFfglC8XdHqYtvEIaUmjLjSiOZA7KnnXIon6USDHhU2+dvIG5sIRYK8UGTl0dIVEc5VTRDAwoHfU/3LaM3Jngnwsg3GqiNSRysspi8GLu1QAvnWukE0fepxCoCjkoswxLusmxPRw3mox4bVA3iiOOFOXUzKI4EjQD/Gvt2lEc4a1zBSzqG1VAHOlkBhmN+reRWeY4UxvFxTS6iyO4oVme4rNn8DzZps93O0/Gf2Gd3Ukv6TxnOzud3uQp3R7vJM/YE4juPrrVQZufJVviku3Nmjy0BhHlPSu0sYavEr1RTEbz/MqgCo5ilLmxNDNv5zikjOBBnWokVENHg9Dc8DlYwUjlAhQ+dzNaNoJPhVQ4OU2JNDP0Arik7pKBtFzWYIULSJ2NRBfjjGvNpejXpZiBsu6OG7TAmX1lzcLnApRT5vJ5ZSnkpHZAq7xWjZqq9x8NTYvru2qgKpmBtv4Pn6OZ4zXD5jQEn9T4aB8ZQlMtSSEWiuZo8A9O3r4h7t6dy8C70EQK8CKogVzDUntVv4fGJn0KKNO1vcmEK20cN2iaajKmybW1KyXBTmkT68QMig/N89Sr0tYnjTJzW5NXKpZvJ1Y1DTdWTEsrsuEOsxm1RQ6ZlMgspwlyUHGaBkQilWVDB0QiGTDPji4pTeqcKk6FwxsPXhPZAGG9DTB7KWHsZs1yeujgWN/xrM/pMpXU2y6vjXL8CRLT0NsP5Tmjj3dxdfrAarLhJq2efmDNJ7o2N9CNe+QZR5U7KdGM9U3OqqG7xIOjSLn1S5v+9YOFI0Qf7z5WBkjjbR8OB6RDhvunL8nJoHNwcUrO9wIcjMmZ0HwqgG3i0DlNC7A/wnI4H5SWojP0BttJVWdADe0cDge4OSwPZuNXCX/LD16efRnuvOFDPcxM/n5v+Ofhp33+eu9gG969wPfXvy3Nl/d7O5/ZkyM+OerC8qD325MjfHX0/t3Bl3Hv6cH7V+cFe5Vm9OLNjL1K5+Pr4xl7ZZeZJL0j/jbV/F1vNkt605t3y6Eeps/lb+/eyF/TZ/zdu+0uHoiiqfj7xfLgy28XN9tDvuDvs5eGXtw8fdd7OhtfnOFq++PeGX931BzWS3vvL55OxtlL8/5kqIfX+Wyc2WHRx7u7u/gb+UnmnFbOOWhVncelLPaj28uS45dR//byKzy/jPofLv8/XO92/36Jp4m+dh5ycHEak5M1ElKjvk7I0fbx8PXZ+all5cXTT8NPkh+dDnfeXLPB6UmNQPE+TTK84/Pl6wuTwsn2zVBsd0sD8Assu3zeTXg+A2XgxnQNnUZ39r+43N0KeG97G/9ZdZEt55UrmYBGHXOOxh6wGQhYp+pRBhV6UaGTEFT4CAFYE15bP/TTTxalhEXQH64AmxnXRqol0TOag/MZOMY50zK2CshMewvR/eknMjSBMkUXa2MFT2rz2O5gzmx56IPRQoFSKeg1XKGzJxulv7nySKSOI65q4OJ///sfmw6mSjWlgmuPE0eBulVktybAQN74tz5QIvXluuRUWkdYg3HokW0EowuaOv7FFsyT0av9U7I1f7LlgOqWZ0DH7bslcxCcbWn2aWG26nzb8pexdbse9N2NCJ0YG1xzbbd6pKNtW+ymiJ5/6xV6KvjXRBihd3nDuD9nq/A0jjCOoibqR0XB2QpVw4eBefMuVkXN+sK0AAKfC8w9PIjXmxLQRejcFKofQX59xfV01yTT0lAndwATLvi3UyOKNKVjhBXrgPsqdQ2czMrNgmVAdtbZX2jQlsa2ul5hxAvrKHyYohOc5q/Mk9ROOLn8z7pNH7/dyyJN79mgDPEo8S7UOh+bpDo7Hq6mjKows0ncZ3WFSPTxxK2ly+7tUmVHxwQXdiQxgJykXFx3yX6Wm6Ud09JIkkm2el/BcZbkUaXocg113ECm1waY6wwJziSHdXGyG+rKyZQB0Bo5PylDtHWGizJmxZKmhzUD46h8mKcNgqpNKqI0KMxfuliQ3RsIrsSA+CCkmuxpXMpn3a2DKDKH/r2qoPEuQ+4r5RIbLGpy5Iom18Cij+0TveYTSJZJCiHJ9FD+wnlfp16YKlvdIPgYSqZSslWbjrLjYEHd/oylTIGKFfN3DLpIzVqSAs/WC4vdyKVQf6wA/AqGMmoooWNZmFqm1mIp4iMV+xwTE5UAJCnHPGrm569I7Hco0DccZ0W5BuDC2loSuxJed5JgxIGtEHmOaU1ulv8iYs/LLCpKEEqC5TFNZvXkt3eCefv6qyG1xNejreiqj6tvrXVBMadbJvjucXTaUBUYatPqNLHumJq1yOr75fO0WpxYOW1fLs1zJefrSfmZavjz7uN55OYVKiU2a4I5DM8rcy85672TTThZ0oQUyXc4vT2Mt+RU0XzGE2IX+ToQCObp1G719S2DBS7zCnHEWfmTwZwnUHnGFZP7Fikhve52rSSzzL+BTs5OQxrjcVxx5TeyJ4XARMxw4GsapXVywlHfxBuKHyudwfr4DFc4cUmP/7tGjTObQ3aCUcijLqdeJcBbsXg2hKRX1BjQ3vLG0c3T7edXmoorJnT4c0b1bPXu9pwZHw6IjYseIVy/fiOIC/TXyiaW/EYRBZ/YLFz5wz/lVHX8lPDTvlk5yHEd1D18CtKsDdIkgdxoV1Iqk4Gu1FMrB9VcvXpR4/ajhfc8pBFqqyCYXgFdaP6b5VNLhGPdodTm2IvEmeKPJwOBcxt7Yiyua/FsWcdaX+Xukje+LvUVeO3zRlyKQ8Xn1MAvsPwO1yUMKEFTXyi5J5/iSx2YQeGmXo7EmjyECq8U0NEzWasiVzRiTaBigi+xYuDTyIY3MKBP9ur9cpG1aPDh843wYS0N7cm2VSRP3QOXQagteVzsO6tHFQ47gXbQ8K2Bp5tYTxeFgoy9BvSB85IU3fR6WBBdE3fZOmnQo28lqzQfik7M1c4uGgj381n5s/ckKte82t5BW6HlzrPtnSdXf7miQsDNVbLGbZU9HLmSE55aQN6Mfu4L/8s4H6fpfxF6fIl7VbQ18FhGGTQRuw/S0YwVIel9OHhJmEwKTKU4+uutHD/WNQZZ8LWSIDwPNMHELoeA1TmXfsU5ezMlM1f7xBf46IROqOIV+YdKGpnI9DHS5JKOu/O8M9/pBP64ynr13D9dEZwAv1Fu7M7rtOSBg7p4OJRBTgzN8h9gLWp37MqclMy55mMvC3YvxO1Z3tx/T0rFuGimp75VjrkwMAWFC2ZcDN3b3TjK6E31RyvlQKdAknLTMkCviOTtA8Vo20YfbnZistyJyU0vJsvexxEOdHl4JwzU0BdTBZD57O8PxHk2Qg5rOx2c2uK4DQpAZaFe3Q6UykxD8BKgzf5N7gqDX80XtO94BDf5iCQp5Vmj0F5WBTCLEeJH6gGb74F5UeeJKLIxqJX9zgS/IYZnYOUEV9KQSMH0qlOizNdWfQsI7lTk7MfvlFJtiG8Gau1416yyWkTcylCXiac6H+qUuqrhDCizDTG3+NfufSWrUAxJZIGdGg4+yHQOq6lsbwbWFFekhRX1JXwhBStTDrCEfWw/Q9n1hhVLFOVauqiVKfdJWK598qvfbEKqQ+NQKXCFMBp8NA6J280WtW4H7EvBjhViM4UYGGOvFh4BtQcrR20gNYZUiqkOQDY0/YTWjloH24TyFFgcWFd2qtUSi6rWiebH29revlJS6XbNqtDg1QZf79l6vz2P/XtQXe/IeZwu8euUTjasVN5BGWG2OH+N+eZwie2qpGt1RNBgs+dimgIZMTCUp6PQkPG40pUU4HtE6gpQHhOzqq0johtrGkTbY9EykaHnYtA8nV1sRYctsxoHbjLl/nJsqz3CscI2R6xTxp1VZTwT1INgzPw8gnHfz6529a6aveoOaz1mu9vbd2uWX5cHL9vSfqZYwsuLWhEl8qX1Nm92V3nzRj7YrEdm1LktXSCngN1bAPwdM/bpOg9Qxp8+Prd7kw1nhtC+OQ/jyuC5NgpoFsphzqrVquZlO1mtQXbzd83x3irHX5as9ZZkXWE9eJYHqsa/U64izIekULbC8eE2epFzm3j58BF7Wg2dYgdwaetdzzDZCHHxHjbahWQVHjcDM5PYcewTcrYztx9tzXs/vLVjy1f9EL9ZZVvXqzyATHpdREin0qgfzYzJdX9ri0EmO5ir4VNFhelyaf1du/qJHx+4gsb6Zb62womhU0RB90zX7nWbkI/Vvbg8sJWXcDtVEOYe+D5od7FVJ3QjC7Tim1FBbBqr+rbBNe7MWu0Eo8Y6I+K2cUmnsc2ATPhN2UHvaCQjsiGkt3RGUZ5aHuQ0gc2YQHfabS3bJ37iX5eyUMiOzjUs/zZyGB6V8LhqsN4PYt5oY6uq61xMJL5ElaaJVWnIED/0I3RpUpn/rHhdsou/qh41L6l+vy0ulpMw1J9z5r5TkUieAcLx36zMD3mG+toEhoO1Ym49BTAMVbYN+93F3tB1bK2f2KjQl7p5uFkmH7TPZ+ONg8A52kcijvcWeWNhD2KbGHDN0lYbl6XNrJdPC4vrtaGCIeTt2PO69ln7oYOVBM9pSy2mOrAp8eDidDNutSq63YYnb4nNx3Wekmwgk61s8Lped3RtOhoNdcoT8P0XQdBzmswA60srV7dYLLrUvu5KNd3yc/XW6+He/puT/Q7OuatQbXWdyKyQCQsKVCYlo952b7f7pLtjy8VSm4yKGj3+S4vghlr9V+VnFqxpzEsH9Md3ZH98R/bHd2R/fEf2b/AdmccZ2L+9laeUC5vEUzaT7sDdh2jec+h5wqe2bFsHeGXCHGEacwXbOgujOPJAL4qj/gOfbjms9xFbnLAO8SG6vR1TDWcqvbvDx7bRDHFrHNlPOWyiFvEg1/ibRf0JTXU7bVs3uhvHHtdvkn+rT9zWXkHAfwL55nv6oyiOrhEe3vcJnP2yxINE5I0bvOc40LGtINViKzEQQls344Uthz84th4LHL49OY3iaOy/jMtsvBMpusCLpYuoH11Gl5GVFItGLKzD57dRSsW0oFMc79ZFMIhGtImBry0G9j/sZ1Hr2NOGw+4w+P9anqs55a/oMX+B5d/K4e7NvRNKCO5G42Vhxur/AJemGuI=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Receive DC API verification response</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/verification/history/{presentationExchangeId}/receive"}></MethodEndpoint>



Receives an OpenID4VP Authorization Response delivered over the W3C Digital Credentials API (DC API) transport for a previously created verification request.

The verifier frontend invokes the browser's `navigator.credentials.get()` with the request returned in `dcApiRequest`. The browser routes the request to the holder's wallet, which produces a credential response. The frontend forwards that response to this endpoint.

This endpoint is a transparent gateway: it authenticates the caller, looks up the verification record by `presentationExchangeId`, then proxies the request body byte-for-byte to the underlying digital wallet deployment, where JWE decryption (when `responseMode` is `dc_api.jwt`), VP Token parsing per OID4VP 1.0 §8.1, DCQL structure validation, and persistence are performed. The wallet's response body and HTTP status are returned to the caller unchanged.

Use this endpoint only when the verification request was created with `responseMode` set to `dc_api` or `dc_api.jwt`. For `direct_post` and `direct_post.jwt` flows the wallet posts the response directly to the verifier's `redirect_uri` and this endpoint is not used.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the verification exchange record. This is the `presentationExchangeId` property of the record, not its `id` property.","in":"path","name":"presentationExchangeId","required":true,"schema":{"type":"string"},"example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The body must hold `response`, `vp_token`, or both. The field names are case-sensitive and lowercase. The digital wallet ignores all other fields. Do not send the presentation submission: the wallet derives it from the DCQL query and from the structure of `vp_token`.

For `responseMode` = `dc_api.jwt`, the wallet searches for the JWE in `response` and in `vp_token`, and it also unwraps a JSON string that holds one of these keys. For `responseMode` = `dc_api`, the wallet reads `vp_token` first and falls back to `response`.


</div></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"response (string)"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"response"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"For `responseMode` = `dc_api.jwt`: JWE compact serialization (five base64url segments separated by `.`) returned by the wallet. The downstream wallet decrypts it with the encryption key minted for this verification record and extracts `vp_token` from the decrypted payload.\n\nFor `responseMode` = `dc_api` (alternative form): a JSON-encoded string whose decoded form is `{\"vp_token\": { ... }}`.\n"}}></SchemaItem></TabItem><TabItem label={"vp_token (object)"} value={"1-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>vp_token</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Map of input descriptor / DCQL credential ID to the wallet's Verifiable Presentation(s). Encoding of each VP depends on credential format (`dc+sd-jwt`, `mso_mdoc`, `jwt_vc_json`).

May be supplied as a parsed JSON object or as a JSON-encoded string; the wallet parses string values automatically.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"description":"Map of input descriptor / DCQL credential ID to the wallet's Verifiable Presentation(s). Encoding of each VP depends on credential format (`dc+sd-jwt`, `mso_mdoc`, `jwt_vc_json`).\n\nMay be supplied as a parsed JSON object or as a JSON-encoded string; the wallet parses string values automatically.\n","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The digital wallet processed the DC API response. The body is the answer of the wallet, forwarded byte-for-byte.

**This body is not the verification history shape that the other verifier endpoints return.** It is the raw verification record of the digital wallet. The token properties use snake_case (`vp_token_request`, `vp_token_response`, …) and `organisationId` is the identifier of the wallet deployment, not of the gateway organisation. To read the record in the usual shape, call `GET /v3/config/digital-wallet/openid/sdjwt/verification/history/{presentationExchangeId}` after this call.


</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"Identifier of the verification record in the digital wallet. This value equals the `presentationExchangeId` of the gateway."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"Identifier of the organisation in the digital wallet deployment."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","nullable":true,"description":"Identifier of the presentation definition that this verification uses."}}></SchemaItem><SchemaItem collapsible={false} name={"vp_token_request_state"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"State value of the Authorization Request."}}></SchemaItem><SchemaItem collapsible={false} name={"vp_token_request"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Full Authorization Request. This is a signed JWT, or a URI with the request parameters."}}></SchemaItem><SchemaItem collapsible={false} name={"vp_token_qr_code"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Authorization Request URI for a QR code or a deep link. Empty for DC API response modes."}}></SchemaItem><SchemaItem collapsible={false} name={"vp_token_response"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"string"},"description":"Verifiable Presentation tokens that the wallet sent."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation Submission that the server derived from the DCQL query and the structure of the VP Token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Presentation Submission that the server derived from the DCQL query and the structure of the VP Token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`request_sent`, `request_received`, `presentation_acked`]"} schema={{"type":"string","enum":["request_sent","request_received","presentation_acked"],"description":"Lifecycle status of the verification exchange. The value is `presentation_acked` after a good DC API response."}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Result of the verification of the Verifiable Presentation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata about the holder, for example the name from the client metadata.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Metadata about the holder, for example the name from the client metadata."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"presentation"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"object","additionalProperties":true},"description":"Decoded credentials that the holder presented."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"object","additionalProperties":true},"description":"Validation result for each credential in the presentation."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Identifier of the credential issuance exchange that this verification started."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data that the holder approved.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Transaction data that the holder approved."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Base64url encoding of the transaction data that the Authorization Request holds."}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Cryptographic nonce of the Authorization Request."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","nullable":true,"enum":["vp_token","id_token","device_response"],"description":"OAuth 2.0 response type of the Authorization Request."}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"OpenID Connect ID Token from the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token of the holder.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Decoded payload of the ID Token of the holder."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","nullable":true,"enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"],"description":"Client ID scheme of the Authorization Request."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`, `iar-post`, `iar-post.jwt`]"} schema={{"type":"string","nullable":true,"enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt","iar-post","iar-post.jwt"],"description":"Response mode of the Authorization Request. This endpoint accepts only `dc_api` and `dc_api.jwt`."}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Verifier Attestation JWT that the server sent to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"URI that the wallet opens after it posts the Authorization Response. Not used for DC API response modes."}}></SchemaItem><SchemaItem collapsible={false} name={"encryptionPrivateKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Internal field of the digital wallet. Do not use it. The wallet deletes the one-shot response encryption key after it decrypts a `dc_api.jwt` response."}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true` when the wallet must encrypt the Authorization Response as a JWE."}}></SchemaItem><SchemaItem collapsible={false} name={"iarAuthSession"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Session identifier for the Interactive Authorisation Request flow. Empty for DC API flows."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft_14`, `draft_18`, `draft_23`, `version_01`, `iso18013_7_annex_c`]"} schema={{"type":"string","nullable":true,"enum":["draft_14","draft_18","draft_23","version_01","iso18013_7_annex_c"],"description":"OpenID4VP profile version that the presentation definition uses."}}></SchemaItem><SchemaItem collapsible={false} name={"files"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"object","additionalProperties":true},"description":"Files that the verification made, for example signed and unsigned PDF documents."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcApiRequest</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Request object for the W3C Digital Credentials API, with one shape for Chrome and one for Safari.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Request object for the W3C Digital Credentials API, with one shape for Chrome and one for Safari."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dcApiProtocol"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openid4vp-v1-unsigned`, `openid4vp-v1-signed`]"} schema={{"type":"string","nullable":true,"enum":["openid4vp-v1-unsigned","openid4vp-v1-signed"],"description":"Exchange protocol identifier for the W3C Digital Credentials API."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","nullable":true,"description":"`true` when the signed PDF holds a visible signature stamp."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","nullable":true,"items":{"type":"integer"},"minItems":4,"maxItems":4,"description":"Page coordinates of the signature in the signed PDF, as `[x1, y1, x2, y2]` in points."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement that gives the terms for this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Data agreement that gives the terms for this verification exchange."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"requestExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `exp` claim of `vp_token_request` is in the past."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet made this record."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet last changed this record."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"organisationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"presentationDefinitionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"vp_token_request_state\": \"string\",\n  \"vp_token_request\": \"string\",\n  \"vp_token_qr_code\": \"string\",\n  \"vp_token_response\": [\n    \"string\"\n  ],\n  \"presentationSubmission\": {},\n  \"status\": \"request_sent\",\n  \"verified\": true,\n  \"holder\": {},\n  \"presentation\": [\n    {}\n  ],\n  \"presentationValidity\": [\n    {}\n  ],\n  \"credentialExchangeId\": \"string\",\n  \"transactionData\": {},\n  \"transactionDataBase64\": \"string\",\n  \"nonce\": \"string\",\n  \"responseType\": \"vp_token\",\n  \"idToken\": \"string\",\n  \"idTokenDecoded\": {},\n  \"clientIdScheme\": \"redirect_uri\",\n  \"responseMode\": \"direct_post\",\n  \"verifierAttestation\": \"string\",\n  \"directPostRedirectUri\": \"string\",\n  \"encryptionPrivateKey\": \"string\",\n  \"requiresEncryption\": true,\n  \"iarAuthSession\": \"string\",\n  \"version\": \"draft_14\",\n  \"files\": [\n    {}\n  ],\n  \"dcApiRequest\": {},\n  \"dcApiProtocol\": \"openid4vp-v1-unsigned\",\n  \"signatureStamp\": true,\n  \"signatureCoordinate\": [\n    0\n  ],\n  \"dataAgreement\": {},\n  \"requestExpired\": true,\n  \"createdAt\": 0,\n  \"updatedAt\": 0\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The gateway could not resolve the organisation or the wallet deployment, or it could not read the body. The gateway also forwards a rejection of the digital wallet with this status: the response mode of the record is not a DC API mode, `response` and `vp_token` are both missing or unreadable, no encryption key belongs to the record, the JWE decryption failed, or the VP Token structure or validation failed.

Errors of the gateway use the `errorCode` and `errorDescription` shape. Errors that the gateway forwards from the digital wallet keep the body of the wallet, which uses a single `detail` string.


</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem><TabItem label={"Digital wallet error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"detail"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason the digital wallet refused the DC API response.","example":"Verification record response mode is direct_post, not a DC API mode"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

No verification exchange record has the supplied `presentationExchangeId`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error (failed to create the upstream request, or to read the wallet response body).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"502"} value={"502"}><div>

Failed to forward the DC API response to the digital wallet deployment.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Receive verification
Source: https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-verification-v-3

---
id: config-receive-digital-wallet-open-id-verification-v-3
title: "Receive verification"
description: "Processes an OpenID4VP Authorization Request (V3) received from a verifier. The wallet resolves the verifier's requirements and identifies matching credentials. The V3 record adds DCQL, transaction data, trust list and response encryption fields."
sidebar_label: "Receive verification"
hide_title: true
hide_table_of_contents: true
api: eJztXFtzG7eS/iuoqcquXUtSEiX5wjp7dhVJPpHtxIolyw+OSgRnmhxYQ2AMYEgzLv33rW5g7sOL7aSyVSd5cKjhAGg0+vp1g1+CCEyoRWqFksEouNQqBGPAMC7ZmxTkxdnRzSU7yWystPid42vsLXzKwFj26ObwMdMQglhAxKZazRlnC9BiKkAP2HUMbMmTBCzTYFSyAMNsDMUb/2mYhk+Z0DAHaXHFiIkIpMVvDZtzG8ZCzliogZ7yxLhJbw5xVaUjxqPIsLPTX1/3mNVcGh4SgRG3HJ9kxrJEGEtTazCpkgYYyFCvaMNsKiCJzOA3+Zt8Czxi41SDAWlpnxfR2G0Kic5HOwqmIrGge0zjIJzcgIyYSkHTSMMsvwdmY27ZgicZME5bF5ql3MYs5ZrPwYKurGwst5npWJFNYKo0sJXK2EwxJQfsfQySjXlm1aWjd8yEYWOrMxjTWM/2kEtmIIHQ0tMKI4loLs0SdO1MmJBGREi6MExJYCFPkh69ja85InExSyRU2XXHw3uIxp66ChVTISPDpKqsz6ZK+02SKPWYsMxYkSSeKMOWwsbsp+vrSzbc3ycCEuC5CHk6uG2QkIKMhJyNia9EB3IN9+B3lJ8Q4zMuJJHB5RrxpuOr7IMneNwrTyFEveqXGmymZU6d0hDlMoobUZllnIUxlzOgvRQPJQOtFQpC0AsK8i6iYBSESk7F7K3TrzMxE5Yn72k1Uszohs4spAE3h0Ev8Mz8UUWrYPSlodlb9hirJALNTMilhIgpXSh2efr3sEKtBI0n2OROhkajPFavLZ4qoSEKRiifPdyWBWmRQp6mid/A3keDZH4JTBjDnOMnu0ohGAVq8hFCW5voQ7BIr9U9yF/1qYoguO0FqUbmWQEGh9a/LucyVgs5C3oN3mwzdO/eXqzlVKGvFbP261sWqgiqXGQ21iqbxYyzCCBliZD360ykMG5FxWbg1pxmSdJNG3IYPvN5mhCvUpAiOlqko729/wkTAdLeiei/Y2tT88PhyQ/DFz8MXxQW2o8bhGr+H1527jItdnj9h+ELP+CH4Ytn0+HkIHwOwUMvqNikCtsnSiXAZYvvzo6R2aopk7NZTpm63EBhct0rThH4JAF2WbEGhZL5ExPSgnYeosZ5cy9Sz3ZjIWXL3H51CwM39yY3HBdnjARtwM5gyrPEkh2e8sTAeEDbpafBiB490H8oyE47SFSH+/ttZa3JhRcg78NQSKL15OGq36xhdSWqWlaaK0neTIPRh/a4ZgxROQNvBEXNI6hpRZPcWfj3rObhvfM8TimJ0+sO+FGhuI+32XAvAzNlS3tW3WBbv0FaNuHhPfmSa5SOm0NmYp6iIYTUsLG3MmP07lwyrjVf9ZhRbRcsIzZHH25jLmlz63YkJOPMCDlL2ufrTaojp+V4YAF6xfwJrhyLUaLpsJmS/oWbw3yDhbMZsJNyHLEh5uSvXeiyAqdBTtdgntqV/waPRqCarlIYsfFvwW/B2GkGc4a2x8b7+ROZzScYMnnt8E+9ZaAjGcssSca5ajnhYu4PYq3zkXUZFdF2636Bei95UshiHmPqXBCrglA3qE+eDQ8mR5P96fHkIBzyw+gIjqdP+FO0dfVYcTsd76T4lEFreWHqgrhRVd4ZH5tVZrHKxaG2UKMePiOpa+6uhwy1ikWQgIXKkPq2D6dD/jQ8eNZ/PjmC/lG0z/vPwifT/gEcT4b8eXQUPj1ssuD8s4tvdmHFResIFpVghsHnPFSyNdc6YBeWPKfp4JtV7YligbHYKj/52lqg63t+Bs/Dff78qH84eRr1j6bDsP88OjjoD6fHfH9yED6LDsnFKQq+3ugZl8LsfPjtHUcuossPOoI0USvMhLwOepVrbjM/LqTku2mozuCWVUsfxHbKX/PMr7LJXBjjHcRXuIVyYKHobqGzixd1i5iLFTMphMXJkiTMeWpaiU2N4FwoanlmUwrQoGIO6dMapmSyYp8ytJZTpeeOL1wy8S/NpR0IVWZLFIM4h8IpD11jtFnItcakViq2hg9Nx5HbdW8VY9DO4JosxCDSh19ou50xLuXEbYCiGLSjmaWMrqSZ0iwXPfEN/I5gKqQgZncY3vLbu51s8EabW1kr98PoukoZmWbJVCSG5C+fWOm7OU/bsdNZ8T37macMpEXOD9g5D2P6a8VmIk8kU2XcsmpKftmzFaJqsuot8hqfjVbEb57cVNALhIW52R5goXRxu515p7W8ec4LZaHYuEZrj2TEGzU2/ri0d4vwDiO/cY+No/C/TNT/uLRjdAPjuVF380iFY+Lrtx3jhUwzyyo8L8/P8RqNi0FAxxkPbuPty7y8evPLJQIl8BnFxBRykSqBGuy1eucjYpaC9JyAO0lHvN1k/eJEgTCbUuyIxVWTI0jRQC4gUSn4M6qfBGcv31+76O7mEj8P/nhpkE3B/f8kDJ64v0Am8nMZBC73KkEEz3HarSfjdtd3dmHQ+oBvjQ9ok1g3sy3jR3TcPvRywKNC0zpb5Gl9aBK7UXVMC+4hR1MLufJMjhb24QuaVHfkJIlogSsHVMy5NtFGfEXV5kW7QilIJq1IGgmbz1Hq4fxDL3BwYdeBgczmyOcuFDGoxzoO30Ssqc6412IK4SpMClSyy8FtCOpHv8mDwRocc0Q79xucI5xdgXM3IiNbzGEzAho2KXBg7qiGk7jYdP20eV5dhBo8DCFFtRfWxRBltN3JcBRkNzbaAT3yeHcB17SXbR1DTmEYA8EM9UiQpdwYiApAAnGXTnSfJ0u+Mj5EK/AeGmZAL0gYrQ/eXXSWcKoXNGj1WcoSJrFS90xDqrSHvTSYLLGtgPuGJyISdrWDohc+jUcRWRCeXFYcDjKvbQRw+jzPQAI69dYLc03NquFViRb4STyfjZhJbjPt+e8gP/icCr1yT4rz0bBQnjn0xVcfCQXNf9qJLFJvo64stzvgy/SaX9fzotvkNVMT1gH0VPZANZKu2XzWQRlFI4cmRIpMBz22S1VPg4+jZ9Nh+HzSD4f8qH803Q/7z/nTqH8QDieH/Cg6hidT5IFDl3dJO0/pzQ7YpSCpwNA7udKMpBAbJ/Do7OKMjkNDJDSE9p0W26l561+maTYvXGN/qowXhDXMJqPqoHtPFU2yI1FloWGTgNQomoEnaH11IN+gryi0TSVZvFy+3ZAJwiVT0CBD8BtxO3z7zWxuC6ETZiiA4TVYZ8P9eKtSze39zvjUNiuZqS9lt91Ay6qeFVHW9o3tkjA3BbxHCDFaIsETgSRhNOtB0gE7p4CmfTjkcD2uQHgEmisRxt8KVAyYKzVH4afkVxw2Lgp2FeuO1jVMuJjXUBPimVQy3MHcnWJ5Xc00T2MRMhr0VZqW1S21F5FXsGI/CgoUKJmyinD4tpOfajCxcyUKa7EpmvGEr+p27vej8Ob1W/Ppefrq8/4vs1+fnh/GL2dVeb+mTW6tHeKG2HCwXxbsccAWNb6wzEKS1KC2JWmJB26p8lAJUBfpHUXiFPIXHyNYiBDu8pUpFSiP8tswwbaj9/Q1KyRhrAx4CWqglIPSQ/wMlmM/xvZsO3/zK91D3UjEaumFR0iXu1UCXk+4b6ioPOFpqlWBCTXAnXqa7nb1C5/vIBtnwqDgMcnn0AafH3pBomZqJ3P67u3rfAIcs2aykO9mw17nwRW60SjCdLpzxlAtQH8tfTSIiTmfde+5NnArB8u/OiZrJMuVoylZW+FLZUP1dW4b/qAjul6HwVQy43VpEYXD35fD7gwpfhtuQx6movfOp5TgTeWrErphLygI09VIowtvpmkc6Ew9Ip3Os+d11nTjSGXs6OTyzzJx7WqHrTuBr0VVKmAdvtkEByBi7w9Pq5JTDqjZtaL3iQxtXuPNXH6mbAy60V01595nl4+vMiczX5Uidpi0MFEYwlCMQBvize2ckoMO/+itLMId4NFOXrJr75KrpF6cX79gV2d9pPXm9I8nN1Kh3SmEOFNh5gp/XVRevWEHz/YPDvvHbH6mwj+eTneQf65YlGxW+k/ZRsMVEFhaMxOE2laaRM98TNJovGl0kW5NTXm9p9XF7MIHJUVlTiKdSbIqehmQPxNu4MlRphOfCHgfUUX7fFzi2EH0VGKXVl5UB2RcrN/Y8RlgY1o0pjgzVktXicaJayGSM32dQ/8k5MnP3mrj7YzuwIAvG5tGaEfNI8Q0njgl5JafzDRQFvOdMo5s4vlcW6PSC1upM1rQcx8qzDAGkT7B6ep6cMEczHhyKaITa8G0opJ1cR0OYpegjZIsd3t+dkd9OdtGrIkctaBsxAFzFHjS7M4V5x1GzRC0TfWlSrcTfqkVFmCniLIYX9zJU9Pv2lSVqJtvh5bzZi7khQcUvoesOg6dw85UdzM5le+Fja+xg/21MLv0Uq4heaqyJipPVUjXXJxpUrm8T96rfWbsFWjMLC+1WogI9PcpDm2D+SlZPqcHizv6iKO63G2UOKL2RIax0rtgN2dsDjZWEfVBYT8zDujlMztOcJptU4NzK9st8/RIRKN7QKv4+Xj/OWUW97sE5YhutBFSorCLDjTfYtYJjJQtXnTNYRO85iq9zcrhxiZpdqqkRFwvb33dsTJ42epNGVdxFneBIUc2xlXK2n7nW2y3dy8pXyWKF51gGzcxqMLcV9hHuQv25cDuizPXebkDDkSFidwVl0paXoQR1kAyzVnqCKyKXA5/Y+820kOxTz7RXcUMeaG8M1zeRdLkf8bcxK6I7Md8lc+5ySmujKLwv9UYT7stcJYmIjznK6z4Nm+G1BoafFydw5ffG7K6/rtqLk/TstdczjKELx5hYvw4h1i3+HsXb1WI/XA7EOUVImHytFqxSSYSZ5Sr74/L0JCqZbUK1yBvBFsPE+8CTAtpLHDna8p7UC+X99/Hy8tskoiQzFXL1Rlqfnm1Lr7wVGyqrBRbLhDWOd6uKBrxy41U9wVRPsG5DG8wEjdXWYr1vJ2C2FaLwMnB8Nnpj6f9n66Gx0+CHv39r9Of8dPw+Al+um1FtS/fnzPfjV+9dsaTmdLCxvMuRXDV6/IuTbGdTVa8nPwkn3uHlpr35/5Oj+QzF9QWlK31y9vPq1XQqB9bpKgP0hbaXj2+kt3np2c/9c+vPKRdKSi8glWJ6HRtEvUE8/9uUd3iaIUpdlo42AomE3RQ82Jt49ZmSl7UurdwNfTg97Bq9G3diwj7tT4u712nFhrtcY7tcAvRSXVx12ff1Yv0mVkxRxM9TzEGNBAqzBybEeOc5/f/OjrDD54ePd0/OHiyv//QC7I0+uOXT7ix/qZctAsZXYl/ozN/bZ/6mmbuVmd10UFU6U9pdQFUSuL1knStFNxdTl1bjsxrbo2qVAPbaNVauvPHtflZR460PhWpx9wuvC3DyFbE1B1WdFusqkRXxev2odV11XXJqGmy/GRl0L6hfuSniHntgml3V9Ym3H5tk3BTUGv1hlu6FxYDj0CjE8K/jtzFsJ0vc1UnpzuldPex5z5X6ijYwba5iFCOLvUaL8/NSLELJTwiI9CavsuFFlXXHzmW/BHdL+5AB/5WXPsGXNGRoKKVQ9HoOrVw2Vv1oLnE7/ztuA1BWtBm8sG/MZPfSe7ZRBpfZ83xv7X8FZfGfPsYLdPgEXaWQphp6sf78CU4ScUrwI9kryyfGeRFnme4q9vlncXTx0Ev+InsB7LE4RLYGanIyLqu6GBvcbjnsJo9f2Go74R+z9313TPRx6XdqwKJe75PDt0WEW+IumZCPFd+b2hqdRKMArr3O9rbi2Cu+jwVAzHzjSTBQ685waVWUeZw2jXTbJvhyvIZRjxrhhv3dZOQ25LpzsOQyOSsL8N696AXCFzKnRp6U6rb1y/Dt4KVk8sLCghROdDH5leOSkjfx2zj2jx4SYcX0P2E8Pip+Azutj8bOxrZmD2Syt+9s5qLhHiQ8hAe9xgMZoPGtCPmB/5jpTKN7Ojfw+qfY+dSUA/flvf+z3NJb92B/4vvhjeuhrv70Hg6U5VbGe7KezDnAuXAuGTtf8uzL46vaHBqCU1V3hqnWnZFpQ6BNASDItkWmMD/z4uIwh9w9x3kKmJwYUzGscHp0RtS6ovHBO5+5eXlVCurQuV+4AQDlcsLBhLHGH9H73ff52oVE8Zk0KPQw109o1NYFRcKq+3gmSHpslxGXEemT/sVHMsXCdZSSDI9p4laX7999PL99eNeo0TqVmsWJPfmZ687a3K9IBEhYFvS6EuheCkPY8B2qdbRLZfLAaevB0rP9vxYs/f64vT8l6vzPo5BwFfYpCYDxKzIl1BzhUar5459uD88GhwODqjnTxk757JCj/91jVohpmkPKj7w79/H+fv3cf7+fZy/7PdxvG+38NnupQkXEpWarMgXHy99CBaH7hcwpoIAr1rM5BN+Slgpbiqy00Lz89jpthfEGIiNPgRfvmCl/p1OHh7w8ScHPX+47QULroXDdz7cFvkbBVtYAhoFp85u9H3OTqJOsUkjjsbYyI04IfBv47vVWPHyzdV10Asm/hd/5s7Ta77EnfBlMArwRxlo26R3FKfj8y9B4kHuYBS4eR/cz7fE9SDK1bL8h8pvf3C5qlDZjKfcZvBf3FrnkH+g2X4Fq38Wr7tv1g4oYjj3Nh4+ps3/B0YnZ70=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Receive verification</h1>

<MethodEndpoint method={"post"} path={"/v3/config/digital-wallet/openid/sdjwt/verification/receive"}></MethodEndpoint>



Processes an OpenID4VP Authorization Request (V3) received from a verifier. The wallet resolves the verifier's requirements and identifies matching credentials. The V3 record adds DCQL, transaction data, trust list and response encryption fields.

Read `presentationId` from the response. The filter, read and send operations take that value as their path parameter.

Read `status` from the response before you go on. When `autoPresent` is `true` the wallet can select the credentials and answer the verifier inside this one call, and the status is then `presentation_acked`. When the wallet finds no credential for the request, it still answers with HTTP 200 and leaves the status at `presentation_pending`.

When you call this operation again for an Authorization Request that the wallet already answered, the wallet returns the stored record without a change and without an error.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Authorization Request that the holder scanned or received, and the key material that the wallet uses for the response.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"vpTokenQrCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID4VP Authorization Request URI that the holder scanned from the verifier's QR code or received through a deep link. The wallet resolves this URI to get the full Authorization Request.","example":"openid4vp://?client_id=https%3A%2F%2Fverifier.example.com&request_uri=https%3A%2F%2Fverifier.example.com%2Frequest%2F8f2b1c9e"}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet selects the matching credentials and sends the Verifiable Presentation without holder interaction. The wallet skips this step when the Authorization Request asks for an ID Token. Default is `false`.","default":false}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet received and resolved the Authorization Request.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation record in the wallet of the holder. The record tracks one OpenID for Verifiable Presentation (OpenID4VP) Authorization Request that the holder got, and the presentation that the holder sent back.

This V3 shape keeps `vpToken` as an array, so the wallet can send more than one Verifiable Presentation in a single Authorization Response.

The wallet returns every property of this schema on every V3 holder operation. A property that has no value yet holds the empty value for its type: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.


</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the presentation.","example":"6821b4b0f5b1c2a3d4e5f6a7"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this presentation in the wallet of the holder. Use this identifier to read the record, to send the presentation, or to delete the record.","example":"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the verification exchange at the verifier. It links this presentation to the verification history record of the verifier.","example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the digital wallet deployment that holds this presentation record."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that owns the wallet of the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation Submission object of the DIF Presentation Exchange specification. It maps the credentials of the holder to the requirements of the verifier.

DCQL is the only query form that an iGrant.io verifier sends, and a DCQL Authorization Response carries no Presentation Submission, so the wallet returns `null` here for such a request. A value is present only when an outside verifier still sends a DIF Presentation Exchange definition.


</div><SchemaItem collapsible={false} name={"definition_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation definition that this submission fulfils."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>descriptor_map</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Descriptor Map entries. Each entry gives the position of one requested credential in the Verifiable Presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the matched credential, for example `jwt_vc_json`, `dc+sd-jwt` or `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor that this entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that points to the credential in the Verifiable Presentation token."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>path_nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Nested path descriptor for credentials in an envelope format, for example a JWT in a VP JWT.

</div><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the nested credential, for example `jwt_vc_json`, `dc+sd-jwt` or `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor that this nested entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that points to the credential in the envelope."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this Presentation Submission."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vpToken"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Verifiable Presentation tokens that the wallet sent to the verifier. The array holds one entry for each credential that the Authorization Request asked for. The array is empty until the holder sends the presentation.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`presentation_pending`, `presentation_acked`]"} schema={{"type":"string","enum":["presentation_pending","presentation_acked"],"description":"Lifecycle status of the presentation in the wallet of the holder:\n1. `presentation_pending`: The holder must select the matching credentials and send the Verifiable Presentation to the verifier.\n2. `presentation_acked`: The wallet sent the Verifiable Presentation and the verifier accepted it.\n","example":"presentation_pending"}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the verifier accepted the presentation and the checks of the verifier passed. The receive and send operations always return `false`. The server sets this value later, when the verification webhook reports the result."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Validation result for each credential in the presentation. Each entry holds the result of the signature check, the expiry check and the revocation check. The receive and send operations always return `null`. The server sets this value later, when the verification webhook reports the result.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"vpRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the Authorization Request of the verifier. The wallet returns this value with the Authorization Response so that the verifier can match the two.","example":"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the verifier from the Authorization Request, for example a URI or a DID."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI from the Authorization Request. The wallet posts the Authorization Response to this URI."}}></SchemaItem><SchemaItem collapsible={false} name={"requestUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Request URI of the Authorization Request. The wallet gets the full Authorization Request from this URI when the verifier passes the request by reference."}}></SchemaItem><SchemaItem collapsible={false} name={"responseRedirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the verifier returned in the Authorization Response. The wallet sends the holder to this URI after the verifier processed the presentation."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinition"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"DIF Presentation Exchange definition of the verifier, as a serialised JSON string. Empty when the verifier sent a DCQL query, which is the only query form that an iGrant.io verifier sends. Read `dcqlQuery` for the credential and claim requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce from the Authorization Request. The wallet puts this value in the Key Binding JWT to keep the presentation fresh and to stop replay.","example":"z4cVLRsq9pKx0NgQ7E3hJg"}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request. It tells the wallet what to send back.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet that the holder chose for this presentation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata of the verifier from the Authorization Request. The wallet shows this information to the holder before the holder approves the presentation.

</div><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"logoUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location or address of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"coverUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the cover image of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the verifier."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credentials that the Verifiable Presentation holds. The array is empty until the holder sends the presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the DCQL credential query that this credential satisfies. For a request from an outside verifier that still uses Presentation Exchange, this is the Input Descriptor identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet of the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential types of the presented W3C Verifiable Credential. The wallet leaves this property out for other credential formats.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Disclosed claims of a presented W3C VC JWT credential. The wallet leaves this property out for other credential formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Disclosed claims of a presented W3C VC JWT credential. The wallet leaves this property out for other credential formats.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type of a presented IETF SD-JWT VC credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type of a presented ISO 18013-5 mDoc credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Disclosed claims of a presented SD-JWT VC or mDoc credential. The wallet leaves this property out for other credential formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Disclosed claims of a presented SD-JWT VC or mDoc credential. The wallet leaves this property out for other credential formats.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionData"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Transaction data from the Authorization Request, as the verifier sent it. The value is normally an array of base64url strings. The holder must approve this data before the wallet sends the presentation. Read `transactionDataDecoded` to show the data to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDecoded"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Decoded transaction data. The wallet shows these objects to the holder for approval.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement from the Authorization Request. It gives the terms that govern this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Data agreement from the Authorization Request. It gives the terms that govern this verification exchange.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification Data attestation of the verifier. The wallet uses it to check the legal identity of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of possession for the Legal Person Identification Data attestation of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet checked the Legal Person Identification Data attestation of the verifier and the check passed."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet found the verifier in a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust Service Provider entry that the wallet used to check the identity of the verifier.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Trust Service Provider entry that the wallet used to check the identity of the verifier.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"DID method, or key type, of the trust anchor that the wallet uses for this presentation.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that the wallet uses to sign the Key Binding JWT, or to decrypt the Authorization Response."}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token that the wallet sent to the verifier. Present only when `responseType` is `id_token`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token that the wallet sent.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the ID Token that the wallet sent.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifier Attestation JWT from the verifier. It proves that the verifier may ask for the requested credentials."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query from the Authorization Request. Read `credentials[].id` from this query to build the `credentials` array of the send operation. `null` when the verifier sent a DIF Presentation Exchange definition instead.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Digital Credentials Query Language (DCQL) query from the Authorization Request. Read `credentials[].id` from this query to build the `credentials` array of the send operation. `null` when the verifier sent a DIF Presentation Exchange definition instead.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>encryptionJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key of the verifier as a JWK. The wallet uses it to encrypt the Authorization Response when the response mode asks for encryption.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Public key of the verifier as a JWK. The wallet uses it to encrypt the Authorization Response when the response mode asks for encryption.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the encrypted Authorization Response.","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptionAlgorithm"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ECDH-ES`]"} schema={{"type":"string","description":"JWE key management algorithm that the wallet used to encrypt the Authorization Response. Empty when the response mode does not ask for encryption.","enum":["ECDH-ES"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `kid`, `jwk` or `x509`."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet made this record.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet last changed this record.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presentation\": {\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n    \"presentationId\": \"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73\",\n    \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n    \"openIdOrganisationId\": \"string\",\n    \"organisationId\": \"string\",\n    \"presentationSubmission\": {\n      \"definition_id\": \"string\",\n      \"descriptor_map\": [\n        {\n          \"format\": \"string\",\n          \"id\": \"string\",\n          \"path\": \"string\",\n          \"path_nested\": {\n            \"format\": \"string\",\n            \"id\": \"string\",\n            \"path\": \"string\"\n          }\n        }\n      ],\n      \"id\": \"string\"\n    },\n    \"vpToken\": [\n      \"string\"\n    ],\n    \"status\": \"presentation_pending\",\n    \"verified\": true,\n    \"presentationValidity\": [\n      {}\n    ],\n    \"vpRequestState\": \"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f\",\n    \"clientId\": \"string\",\n    \"redirectUri\": \"string\",\n    \"requestUri\": \"string\",\n    \"responseRedirectUri\": \"string\",\n    \"presentationDefinition\": \"string\",\n    \"nonce\": \"z4cVLRsq9pKx0NgQ7E3hJg\",\n    \"responseType\": \"vp_token\",\n    \"credentialId\": \"string\",\n    \"clientMetadata\": {\n      \"clientName\": \"string\",\n      \"logoUri\": \"string\",\n      \"location\": \"string\",\n      \"coverUri\": \"string\",\n      \"description\": \"string\"\n    },\n    \"presentation\": [\n      {\n        \"id\": \"string\",\n        \"credentialId\": \"string\",\n        \"type\": [\n          \"string\"\n        ],\n        \"credentialSubject\": {},\n        \"vct\": \"string\",\n        \"doctype\": \"string\",\n        \"claims\": {}\n      }\n    ],\n    \"transactionDataDecoded\": [\n      {}\n    ],\n    \"dataAgreement\": {},\n    \"legalPidAttestation\": \"string\",\n    \"legalPidAttestationPop\": \"string\",\n    \"legalPidVerified\": true,\n    \"isVerifiedWithTrustList\": true,\n    \"trustServiceProvider\": {},\n    \"trustAnchor\": \"did:key\",\n    \"kid\": \"string\",\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"clientIdScheme\": \"redirect_uri\",\n    \"verifierAttestation\": \"string\",\n    \"dcqlQuery\": {},\n    \"encryptionJwk\": {},\n    \"encryptedResponseEncValuesSupported\": [\n      \"A128CBC-HS256\"\n    ],\n    \"encryptionAlgorithm\": \"ECDH-ES\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"string\",\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request body is not valid, or the wallet cannot resolve the Authorization Request.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Receive credential with user PIN
Source: https://docs.igrant.io/docs/openid4vc-api/config-receive-user-pin-for-digital-wallet-open-id-credential

---
id: config-receive-user-pin-for-digital-wallet-open-id-credential
title: "Receive credential with user PIN"
description: "Submits the transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow. The wallet sends the transaction code with the pre-authorized code to the Token Endpoint of the issuer, and then requests the credential."
sidebar_label: "Receive credential with user PIN"
hide_title: true
hide_table_of_contents: true
api: eJzlWFtv47YS/isEX04CyHaSTYEeoyia2tlz3C4aY+NsHrZBTYtjixuJ1JIjX2r4vx8MqZtlb7c46Nu+2BLJuXBu34z2XIKLrcpRGc2H/LFYZAodwwQYWqGdiGmHxUYCu8DtH/RwySx8LpQFyZbG+rMPk/Hth9GETS307gpMjFV/gmQjInubmk2fzRJgG5GmgMyBll8QsVGY+J3cQk80jPwmGr81M6+g2b2WuVEamVn6VeVcATZiQkt6115HcOVdYgsSNCqR9nnETQ5WkNCJ5EMeG71Uq/cQg1rDkwM7VfqtsWO1UijSZ6/zQw56Ikc1Fx7xXFiRAYJ1fPhx37Hjk1afC2DKH18qsKSmaKnBHBoyoNJev8SkEuy/XGkiUlIRn1xgwiOuRQakaU0+kTzilRf4EG0BEXdxApngwz3HXU7nHVqlV/xweAmHweHPRu7oxLG6s64fMBHYMitbiXVt/6ArM4W3/UJo2T+jTGw0gkaSJfI8VbE3+OCTI4H7U13N4hPESHa15B5U4Gi3CP44vVT0tSs00fp/BamFzKwhRE8KQiq9CrFlhUrpxeUiBlcHHBEIpWlnLdICWFY4ZAnZ7ZYsd33D4kRYEVPE9NmTAzbHLcnup6BXmMw9p2pN6bzAPzIjYV5FeCt4LMTGSmK7VKX4wKTWppbFHOCJO2GbQ4yO/JYp/c6T8uFtxDOxrd6ubyIOW5HlKVn9ze2/r/nh0Pbzx9o5L4dD2HK50S447ubq6kycte3r8012r1ZXgG5tIGX/oaBqxJ2q2OR4Y7WOyp04wcJqxwRzSq9SYEEmUydOM8slWEZXEEo7ZvRRWTrLUzNhrdhVzDocMmN9puouLypxGh6WvjB1TfHF61ZBVd26zPOqaFO9ckdqinQjdq7WFtZgd2ypIJV9dhceArdEOKZNmReqogAZnE14A1mOu3BgyOa/89/53KetYCHdIza/qlZ0kS2o0s+XInVQrS6MSYEMRkmkizQtN3TlkPDi7Xlcrz5yRdW0U1yb1/ttnAi9gs6yh6GjlaOXRxRYOB5xEceQo9AxVBQSlmAtyArCjoX7DPUhC2WRciCpJvCoTjhPIBDkHREXuayfjQeqB7sSWrkK4yJuugslp/eVFdoqvDU2EyFrwIHGhkpVyjWHRx49i4CndN9QwOjiZYn1O2NAoVLnDb82IW9rE6WwEulUyTtEcEHc+dWpyVsbH8AStsogy0yDtjzia7Au8EBbOLzTcWJI61fvaNjmdOXRsSfduR3XBIq717Hd5aVuylXCnxUmM5LyTjmsJD6CXasYptaslfQGM+RLApmuYd4HXPY8Q6/xpBW2LfFyiOos9uHLD77gHiKegJC+AdnT220ouX+7SLZTAKw1tnScfx63ysRL9JWC2lA3tVdphJW/e40it1dXhzPsz2B7Azw/C2qS8gJZ3XDx8van2NIOcyo02iAVFSWjbjGejGm/0K/abHTEyg6hhEcLy8KV0HQCQ+y/Zf9TNZGOCQtMpM54eWItVCoWKVQFTGi5MNsj3agAdX13/Q377kk3vf6Jab77psN6ohGspoEB7JpaNxLTsdEh4g7iwirceci/y9WvQI8v1PmjWNGIwsuBhoUqwy78TEMd8SWPeAhqMkkGmBiai/LCW4QmkCEfrG8GYVAayMCnF7qAASGOkgMnP21w0GTYYN8G1MOAAKeXe+wKNzk3No0hM+VFCaNsyoc8QczdcDCQkJmeyFVfrazQ2FeGU2E8ZjC1RhYhWb/A5mscHlGsfHt/ntyF7a4iL40HHikQQ/xUfmjKd1goh7vgwma8u2vjwkmndjedsFfYMcoUMmuI/9CQhc6qnBPmR3zmLIgJ88jCT9ZLta2ar3nQkc3ZhTYIVclrjTiXEYP+qt9hO2Ql4Q87U1gyR+8Vdj/O+35IoKR83wyc91XYt+a5cqIgUyxNld8i9vlNkxQZ3RV5biz+1Bi6tpX6T7N07KG2czsmrIlYHpCZ2vbYkG4ITNF/VvU7lTVDlvhaHiDfl/ZWi8CoY6P2jl2UA+alb0LPE05bLVWTgtNL0ghNbFLfYivHyN2gicaV0PFniTZoAk5FvkMPA+iaJOxYmZotoHOscN6VKLQUVrqev68SGtkyNRsXwqC0tNf2+c2IfRixi1+eZ5cRm9zP3rLHce+X5xn7MArSJo8P7Pr7q+s3ve9YNjbxIBu/a4Pr0jeQfrxMVQzaeddXUZ6LOAF20786cd1ms+kLv903djUoad3g3WR0/9vjfY9oDhFHhelRDHhjSRMXtfdaTeCQ31zd3Pbf9H205cZhJnRLn/LDz8kMSpHKppPfuonYQqJv5HNZWbwQtjjIU6E0GdJ7bl/Cw0e+vgnj+VL5TzNHEFGOJb759jDRnZqGndmrxoqXiCfGIQnY7xfCwZNNDwda/lyA9QgX8bWwPrcCnihHz5IP/XT4F767qGafS/YPfK07a6Oq6msq+b5G8yGnOYRA4XjgPLzU7by/RzgyCtr2ZsSoYXHS/xCMBYo7P23+5dk2xk+fZjzii/KjYOZbHW4FTSn0O+Q0inv/hfGO2ita3/NU6FUhVnQ+sKW6TyF4DHevHu7Kh9bniGObdJEv3IV+27PPEckPlPO/wu7H+njY+SJBjbbhNHmIxqj/AUNwFRQ=
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Receive credential with user PIN</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/{credentialId}/user-pin"}></MethodEndpoint>



Submits the transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow. The wallet sends the transaction code with the pre-authorized code to the Token Endpoint of the issuer, and then requests the credential.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a credential stored in the holder's wallet.","in":"path","name":"credentialId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Transaction code that the issuer gave to the holder out of band.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 4 characters` and `<= 12 characters`"} schema={{"type":"string","description":"Transaction code (tx_code) for the OID4VCI Pre-Authorized Code Flow. The wallet removes the leading and trailing spaces, and the remaining value must have 4 to 12 characters. Use `txCode.length` and `txCode.input_mode` of the credential record to find the length and the character set that the issuer expects.","minLength":4,"maxLength":12,"example":"3491"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet received the credential with the transaction code.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>credential</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential that the wallet received. The wallet returns a single object if the credential offer contains one credential. The wallet returns an array if the offer contains more than one credential.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credential\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the credential ID is unknown, or the issuer refused the transaction code. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Request credential re-issuance
Source: https://docs.igrant.io/docs/openid4vc-api/config-request-digital-wallet-open-id-credential-reissuance

---
id: config-request-digital-wallet-open-id-credential-reissuance
title: "Request credential re-issuance"
description: "Requests reissuance of an expired or near-expiry credential via the OID4VCI protocol. The wallet uses the stored refresh token of the credential to get a new access token, and then asks the issuer for a new credential. Reissuance is not applicable to a Wallet Unit Attestation. This operation has no request body."
sidebar_label: "Request credential re-issuance"
hide_title: true
hide_table_of_contents: true
api: eJztV99v2zYQ/lcOfFkCyJKTZsBgFMUyu9vcFkvQ/HooDJiRThZriVRJyo5r6H8fjpQl2U7WAttb92LLFu94/O67+45blqCJtSitUJKN2Ef8UqGxBjQKYyouYwSVApeAT6XQmIDSIJHrgfu9gVhjgtIKnsNKcLAZwtV0cnE/nkKplVWxykO4zRDWPM/RQmXQuFXGKnKnMdVoMrBqiZK2onc9p1bBAi1wkLgGHsdojF8bAJcJrZbAzdL7pJBRQ6p0Y9A5CuFjdyJhQCoLvCxzEfPHHGkbDg8+xDspLFxai8ZygoXiFwZUidr9hoyTPWiPFTyqZBOygLULpgkbsVjJVCwaPCdiISzP/QZXJcppMm5D6wJjASu55gVa1IaNPm0PsnMnxZcKQTjDVKB2uenD1aAqpMMjU3mC+ifTgE9BCvJTcpuxgEleIEXamk8TFjA6FmWajayuMGAmzrDgbLRldlPSemO1kAtW1zNabEolDRp6fz4c0td+zL3cN4ChS1uPYSFMj/IuzMsJCdzixmmi0GUzE3LhKKHRVlqSeYHG8AXSsWMlLUpL4TVZJ0fRZ0MxbntnVBKvUgd9c1r1+BljywJmhc3RlYijWdKLltXBt9Y73u2TjtWzuq4DliFPXL639OvCg/jdAXfp+sRQa6XHKiEiuedJLxWz4CjEUhNnrfDp66y7XAtpcYGa/D3xoqQDXQyH9TPuj/jRM2G/ceJkWVlo+c3q2p3+mC1KL7gUxtdaU6ornoskOCTJdELvK7mUai0Dak29LqAxrcwR13YkDOGBWseBwx2ZwFRlqbTtGQYwPzzz3BWYbz0WnyzMx9/lah7Cn64yu55igGsEnhvlSbLiIneNyfcyw2XyqJ72oCFaH1Ln7Aemzp3klc2UFl8xOYLm5x+6qqbSopYkD6hXqMFtc4BRHTCDcaWF3bj2d1mK90iPM+rzli9IkFgjZLvOfOK0jOT+lAXMk5ogKdBmilSwrBwipDcjFq3OIy+LUeL9DHwTj1SJUiSRST6vbdTVY7Tta1MdNbXLKFQ6yHMaOcFCNedkAat0zkYss7Y0oyhKsFADXopQLDSXNhTKde59B9daJVXsms8Lbr7l4cbyBanRC+bGvz4MZNYl4IZ46OmzS0PLA+7/aJTcZ7DT8sumBByv2SEPLq+nsMQNUKEQqnE73yB12Ap3A9h8z88c/DZQVDTuIJQaU/GECayFzWDuY4Q5nEhl0bdDzUXuMCh5jKcBYLgID9yOoDF8vVGVJjgGS9y8mYeMyChkqnYly2NXslhwQUA2HfXXDrz2/OKP7q991PsJO4ClNaKRdSUSpOEhVlRlFkHQd4HSzx47hDzxXXu+Ry1S4bp11/8NTHeKc9IMxKduPHne8Fqjabdoq+r6tB2iTTOFUgpRko1p1OBrIyBWeeULnCr58XhFO2ygqbae0hmojEuP5TLhOjEDd17BpYU0V2vjU7vTLor24dUY7sdw8u7h9jSA6dvb3+FmMnj3cAv3Y7/b9OYKzn4Znr0a/AzFRMVRMfnQV9dU6YJbQ8KVixilcT1xx9ySxxnCeTg8St16vQ65ex0qvYgaWxN9mI7f/nXzdkA2dTdwdekksBIVV232WMCobfi0nw/PL8JX4RnZlsrYgstePM3k3o9f46A3qSf7bbqVlv/vUP/iDtU0OZqmojLnQlJyHBu2jYp8YqtzP9CnguRwX0n8NUwKmgCcmtDSbk4P2OiZ2w5JyixgmTKW/G+3j9zgnc7rmv7+UqF2OhiwFdeuXL3sCEPPCRulPDf4D4Q4+dhME6fwH9zgnoVoJw6SlMG1cjZiLGBL0o79G149a+8c7hx+yWUcY2l7xkfzUd3X9eu7WxYw0pF9aVo6aWoeereo/cAOVcqHQJ+9i9S+yWuq5fe4edMu929eNGiV0a8mmOi69Tc8ovBW
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Request credential re-issuance</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/{credentialId}/request"}></MethodEndpoint>



Requests reissuance of an expired or near-expiry credential via the OID4VCI protocol. The wallet uses the stored refresh token of the credential to get a new access token, and then asks the issuer for a new credential. Reissuance is not applicable to a Wallet Unit Attestation. This operation has no request body.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a credential stored in the holder's wallet.","in":"path","name":"credentialId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet requested the reissuance. If the credential is a Wallet Unit Attestation, the wallet does nothing and returns a message.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Reissued credential"} value={"0-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential record that the holder wallet stores. The wallet always returns every field. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the credential record. This field holds the same value as `credentialId`."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential stored in the holder's wallet."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange that produced this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The raw JWT, SD-JWT, or mDoc token of the issued Verifiable Credential as received from the issuer's OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the Verifiable Credential token. Contains the parsed claims from the W3C VC (JWT), IETF SD-JWT VC, or ISO 18013-5 mDoc/mDL credential. The field is `null` while the wallet waits for the credential.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_pending`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_pending","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Current status of the credential in the holder's wallet. A stored credential normally holds one of three values. `credential_pending` means the credential needs more steps, for example a transaction code or a call to the OID4VCI Deferred Credential Endpoint. `credential_acked` means the wallet received and stored the credential. `credential_accepted` means the holder accepted the credential. The other values come from the issuance lifecycle and can appear while the exchange is in progress."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token (transaction_id in OID4VCI) returned for deferred issuance. The wallet uses this to poll the Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"deferredEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Deferred Credential Endpoint. Present for deferred issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIssuer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential Issuer Identifier as defined in OID4VCI. Typically the issuer's base URL used to resolve the Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorized code from the credential offer. Present for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this credential record was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix time (seconds) when the issuer issued the credential.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the OpenID organisation (digital wallet deployment) that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that holds this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPinRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder must provide a transaction code (tx_code) to complete the OID4VCI Pre-Authorized Code Flow Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"description":"Format of the received credential as defined in OID4VCI. `jwt_vc_json` and `jwt_vc` are W3C VC (JWT) formats, `vc+sd-jwt`, `vp+sd-jwt`, and `dc+sd-jwt` are IETF SD-JWT VC formats, and `mso_mdoc` is the ISO 18013-5 mDoc/mDL format. The field is empty until the wallet knows the format."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier linking this credential to a presentation exchange, if received as part of a dynamic issuance flow involving OpenID for Verifiable Presentation (OpenID4VP)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuer</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display information about the credential issuer, resolved from the Credential Issuer Metadata of the issuer. The wallet always returns the five fields, with empty strings when it cannot resolve the metadata.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"cover"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the issuer's logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issuer."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialConfigurations</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Credential configuration from the Credential Issuer Metadata of the issuer that applies to this credential. The keys follow the OID4VCI metadata format, for example `vct`, `doctype`, `credential_definition` and `display`.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>txCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction code (`tx_code`) parameters taken from the OID4VCI Credential Offer. The keys use snake case because they mirror the OID4VCI wire format. The wallet returns `{"length": 0, "input_mode": "", "description": ""}` when the offer has no transaction code.

</div><SchemaItem collapsible={false} name={"length"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of characters that the transaction code has. The value is `0` when the offer has no transaction code.","example":4}}></SchemaItem><SchemaItem collapsible={false} name={"input_mode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Input method for the transaction code, as defined in OID4VCI. `numeric` accepts digits only. `text` accepts alphanumeric characters. The wallet stores the value that the issuer sends and does not check it. The value is empty when the offer has no transaction code.","example":"numeric"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Instruction for the holder that explains how to get the transaction code."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authorizationDetails</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Authorization details that the issuer returned in the OID4VCI Token Response. The field is `null` for the Pre-Authorized Code Flow.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authorization detail type. The value is `openid_credential` for an OID4VCI credential issuance request.","example":"openid_credential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_configuration_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration in the Credential Issuer Metadata of the issuer.","example":"PhotoIdCredential"}}></SchemaItem><SchemaItem collapsible={false} name={"credential_identifiers"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential identifiers that the issuer returned in the OID4VCI Token Response. The wallet sends one of these values in the Credential Request.","items":{"type":"string"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status. `Operational` means valid, `Revoked` means permanently invalidated, `Suspended` means temporarily invalidated. The field is empty when the wallet never checked the status, or when the credential does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification (LPID) attestation credential of the issuer, used to verify the issuer's legal identity in the EUDI Wallet ecosystem."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession (PoP) for the issuer's LPID attestation, proving the issuer controls the associated private key."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer's LPID attestation has been successfully verified."}}></SchemaItem><SchemaItem collapsible={false} name={"autoPresent"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet automatically presents this credential when a matching OpenID4VP Authorization Request is received."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`]"} schema={{"type":"string","description":"Version of the OID4VCI issuance protocol used for this credential. The default is `draft_13`.","enum":["version_01"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["","did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of previously issued credential tokens that have expired.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of decoded expired credential payloads.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires encrypted OID4VCI Credential Responses for this credential."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer of this credential was verified against a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Details of the trust service provider entry that matched the issuer during trust list verification. The field is `null` when the wallet found no match.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"oAuthFlow"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `frontchannel`, `backchannel`]"} schema={{"type":"string","description":"OAuth 2.0 flow used for credential issuance. `frontchannel` uses browser redirects, `backchannel` uses server-to-server communication. The field is empty for the Pre-Authorized Code Flow.","enum":["","frontchannel","backchannel"]}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorization request URL for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletUnitAttestation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this credential is a Wallet Unit Attestation (WUA) and not a regular credential. Reissuance requests are not applicable to it."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"`notification_id` from the issuer, for the OpenID4VCI Notification Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationEndpoint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Notification Endpoint of the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"notificationSent"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` after the wallet sent the notification to the issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"accessTokenType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the access token from the issuer, for example `bearer` or `DPoP`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dpopJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON Web Key (JWK) representing the holder's public key for DPoP binding.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Algorithm intended for use with the key.","example":"ES256"}}></SchemaItem><SchemaItem collapsible={false} name={"crv"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic curve.","example":"P-256"}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key ID used to match a specific key.","example":"holder-binding-1f3313ef9aa943ef9ae0400a7c1f60ac-b55eca95c94245bfb1b4b23e72b57d23"}}></SchemaItem><SchemaItem collapsible={false} name={"kty"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key type.","example":"EC"}}></SchemaItem><SchemaItem collapsible={false} name={"x"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"X coordinate for the EC public key (Base64URL encoded).","example":"faUHD5Av6fIPPSuHSyoEwcU1AX1uB_ribM69rHFbS8A"}}></SchemaItem><SchemaItem collapsible={false} name={"y"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Y coordinate for the EC public key (Base64URL encoded).","example":"g4K2Gv0wigHmPjWi724brAFqg_xleKttWxF55lAGTS4"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"Reissuance not applicable"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason why the wallet did not request a new credential.","example":"Reissuance is not applicable for wallet unit attestation credentials"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, the credential ID is unknown, or the issuer refused the reissuance request. When the credential does not support reissuance, `errorDescription` holds the text `Credential does not support reissuance`. Holder operations are also not available for a sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Revalidate verification
Source: https://docs.igrant.io/docs/openid4vc-api/config-revalidate-digital-wallet-open-id-verification

---
id: config-revalidate-digital-wallet-open-id-verification
title: "Revalidate verification"
description: "Revalidates a verification exchange that the holder already answered."
sidebar_label: "Revalidate verification"
hide_title: true
hide_table_of_contents: true
api: eJztPOluHDear0LUn5GwpdZhOU6EIFhFkmeUeGJFUuQflqCiqtjdjKvJCslqqccQsE+zD7ZPsvg+HsU6+rCd7MxiMkDG6u4i+d0362NSMJ0rXhkuRXKUXLI5LXlBDdOEkjlTfMxzCj8S9pRPqZgwYqbUEDNlZCrLgilCS8VosSBU6EemWDG6FbfiespIwSfc0JI80rJkhuRTln/QuDJXrGDCcFoSzSeCmloxneJPis2lO1EbampNqCjwF6NqDbtQLgidUC5GBE7RTM2ZgicEeVQcIIenBXskWaWYZsLgdjeAGDeLDDfMLG6syMicljUsku78XKoCn1HM1ErY7cZ1Wbrf7LHSTJkilZIVU4YzTeQ4Xl9IIiRCKyYsUESx32qmDZlSTYQkD7JYtJAouM6pKoD28BvhY7KQNdFMFESKZp+Kmqk9kGsCEFiCcU2y3flBlpKH2jhodCWFtryymNy8WMJXC/kRyebVtfzAxKVbm8G+VBCqFF2kbaJ2fvOsunmxI0W5iMlDFSNuJaDMNayEZ/HBm4M2UA1OKG1WtDR55GbqkdBTWjUU8QSUTFvCy1lVG0YyR/Kzp4or4DZuGVNtRC4ZLWLe4SnZX8+uye78xW4uxZhPdp0w71hh3pUVE7zY1cWvj2Y3Bn13yrWRarH7MabTmSPyefGcgaRNmCGU5LVSTBgrgaNbkaRJAOu8SI4Se3ajlKcWiHcIw9uKifPiJjo7SZOKKjpjhimdHL3/2NHuXwT/rWaEo+6NOVNeaFcJRJtb2TBWmWf1oq0HKTKDG00yHj00StKEA0QgyEmaCDpj8Glw7yRNgInAvuTIqJqlic6nbEaTo4+JWVSwUhvFxSR5ThP2RGdVCd99zb7J9+g3hzsvHl4VO4fjg3znm2J/f+dg/JLuPeznXxcvWPJ8B7tbQdew4cHeHvzTJtyANVOBKVZ2YtitTg/oXixgn2OkgG65FIYJA0DSqiq92P2qAdKPfdLIh19ZbkA0gjLCrzHL/2ZFdmhRmw43a+QkYGgUBVsvBSMopqdkLBWxy+lDychFhDTZss8c3lxst0QxJWMlZ0ip49pMpeL/sAsunR11NrslvorpujRdw+BtOZsztegIK9fEUg2Mg30gqGEKaLLKkKzIjyvuDnbswa8ulDQyl2U2IsfNxmi2nJlH3pEFM5EksFllFu4XIA2oCND+iGS3yW2S4ZeUWLlOSbbnvxH17IGplGRjWoJttt8+SFkysMMAlqjL0v0giOUksR/QTFtD05aGJZrXU7CuQHyaRRmRv/I5sxS3qNN1VgUcXbBpwG+INVJSsJIZBlg1etgyO+iJ4OmcwZGUnJ6Q44vzRikt0UGhPtVipAnfgDLnwjAlqA8aYhKFAMrJ5ox+YJo8QgDDDQFVZLG5GJGfZOQQaQ7yqCMqjsgvegUNjSS0KBTTrU1biH/19cH+w+HD3vjlw35+QF8Uh+zl+Cv6CpB10cDP6kQWbD3eQZWXqOwvl+eEiVwWrEAe/HxJ4AOEPlVJF8DSgrGKlFx8sCbFhpl/0d7y6pwKDc/lJbcBJcfojQtuuJeDmBhkXMrHETlDlUMy15qLSU8kZrJgmmxlRX5PK57BEe7v0a+PJtseReRw6FwZajYgCj4WyTEgDlCuIVZKas1QjnOpFCsbIbe0DH7EozAA4XrgXkNouwnbpCIVXZSSFr8XMWMuXdUPM641t25stR96p2hVeU1qjGrLqTT7BRtoTZMVI3QQpyc/v2nFobquKqnAp/9Wgx8YSzWzxgQsyM9vetRx2OZUKY6h5zIgUqJlrPTeITlrPWXK2iTrf1rm04bAIVpsiXbBxij3Nl1SRoMXsraVa/+oxQ1shyCyLIKTtvuenr9uA+2NR7z5jBbMRcqdBMBFs+20LqRDVnnXuZx7/QnMXw5vn+WI4oxW3bSzA1+T/GGcOWPC6LYnY2pEfoQ4AHjU0FAjaUc95BrK3W/kLHr+s4XgacMH5zsgZGmQHdflmJelRp3yO0t1P6NVP5Y9hhgAjjkND5K/04owYVCEZ7SqQKEZzafe0rAiTtnB1hpNSp+nc2FzsuHoDojjsMfwA0J/w2Z6fYgKykc3MGAnDWh2iSfijJp82oZ9i40mI5L9+mju5/k9BM1ZCobpP3SxA3YpJdlMy/tZIXNnoz6Pf+eiqk1M4hDJrucscGJBNDVcjzmzXMVEaS0cP1y9/ekCQib2BOqFwlFJLgww1Ml4xKaIcOBKVvORGPAqAZh7gXKxXl1/svKDkVwR0QMceKSPj2jSCxAmJuaslBVz3NSOaT+8uyZcaF5AOHdzAZ+3+5r3xUIjevL+/0FmHNR/rOjkg/ISjrZcGyXPz3HG/t6zBMniwLnb9JlNKNlPQmx8xfUyZ9yHsW2we1YUAbl7hlW2KjkEFRP1DPZyRvMeTnbFC/jochHEL/Z9FROF3aD1Nc0/sCK56yL7ho9ZvshL5sujqxKuo1uxPwo1MAQoO4oLjuDWN4lEbSQeMv5HCg7AR7HBxx9EZ3ls3Xkudm973Yk0KQSGENELVqTLM/3RrXgxakcenm7tAzAIYkUrKg7VUO/KScELLEy5MpyENMj0j3bLFxgtHnbPRwa50x1CGGytsqG+QBogqZTMmYYonxsbJTVZWUuOILB31aBI9lze31OJSyyCDMqG+26Zt46lo1WxX1RGThStpjzvFe3jen67aO8oBga1pHymbeVeWyphRG0DbQfVktgW7ViuGFTbjmPjbqshQxbhiRg+Y9rQWUW2uCCa5VIUetvmLDZ5bpeNbGmOauIOwkPrqvi/ObSk2kDShBzuJUeNzd+kKtN3LctyBswvg7XswGY1D0CRWGp+qyZUcE0/H4zGyshoL+vGfPperIHFqlo/rj2RwoBo2ciPGVpQQ13E8QBOjHpDRV5DngU+/Sc6Y2kIZOGviSRsZEZ5E7QuCU5tyfrTSRDDMEIgTs9PwQgCLEQ+AA7AE3D9ecnBoARk+JjQOeUlaG3fhSFEdx3BiUBcG33TokCpoOVFhCpU3J97ORizFZw4guv2BYPqO5sC/RqgAiYWNlAZy7KUj72eoA0GRj43roXhZavjaNtB7WqHNdYb4Nv0CoaK20vi3gg972lcJ4vZqqorQ0DF2+OmLKpx5uT3GC6yUP3BquMA6u7UGHWjqNA0R/tAzWDNfzlLu9hfN5sRFDbsPakZK8jDIiZ+USsMCQeLbANgfU81++pwvarY52pV2vIgnOFUxnRBW0NG5IR3GY70n1LU7ittxEKudU1Fznr98K7NcpFIClqLHeRSPuJqbK1HO9Kxsf3r1voROS4f6UK7ToEU7ZDGAWY7w00rM3LeWBGAgjIXBCqHKvVeiDVIIFCucJQ8N62wayTQ2lov0J8cjPYauGCBB244kosC5Xl1j8qF4XX4s2BznrN7vyWaNF6glm9afiYnUgio/5yfElzYpFLe/l7EpTEkTBYjj43tzEOVuawO93K278vUzRtQV1ANKaCHt+0t0FhRQ48nimF16vPEGJWH+j1aZcC+/Ab5boVDmqnPPVtPHyRVBcQcChweFwWf86L2drEJ3Ve5/3Y/f4NQOAPyZ43sZ+ypymw0CrBl7XI58t0lthX1iY+fYKECsoZaM6ikMgvCqoQJmlUYCpdcm0ZPdRhPiFphHkA/SOOVWfhhlNDnivah1kbYYrLvCfbotLjmrWBlswC2iV8b4g0bXEsJ3TI/gHrcpGo0cA0DRtjsDCd2RmbwqEWre7X/6vDV3v7Lg729Tuzjm+l/UAx0Y/nR9JwHXb6XpQiutGnchETK5lo2m7I42m9CItWbi/IS1hcLPwZFcb7AUh/6C5sFVDboPC+uoCW+gRM4sUHq+altojObU7iYIeS5jgzrygytKkrBFcvNfa04HIplGb/fPTUGxNTYqZenl3vf3Gsq7guh/ccp1VP0HXabC6nNpdvyF8U3qCpdnseBlwcHW43WZVdSGx8KDZcOfq8+mX/675/Ygm2dQgroPc64ADCm8nEF3GAEC1byOczzHd2KHZI5ZgDO2VHzIPrQOafkb9fXF+Ti7dV1eygDG7dZzMsMpV/WBuI8qCpA4NI9AnFffYxbzQoYIqDkh3dnbhdLyGhxwIRINylI3r04IW6YKqqCa2QNhpvQBQyA/vDuLAaWnMhZRQ2HTAE1+UHCwBjoMozq4AxGLfzH1uCIDS3cME8EbhffzwZ5GVU4VTuDvDNTJevJ1BWgDVMQaM+DYOjOwE2PNl0m+oMGOfi5hw1iFdmKSHKSNOnIEXyDRA5/uG89qNGf+MtdU2tTx5GdWat4N97aRauwbWGRl5HJTaHyN/fWI9IVGiukDTtDnPR5kVc3zoqa0KFeuXS8CuWbkqrWU6iYRulJZNlCJuKdta+vamZIFsNvY5MZdu83websyU3R9CeM/tloeSSyfnT+halBO0pH5CZ87maCwITrJSW7MGcFEAkp8k3cd6uwi4usB9/MYwMxmdAQwYwV01MBY0ZgASvF5jbJwLEeagxMBFpaxWNz6yFcZvRCglK5rWIhsRExKxpOLiuBcm1LHZNauVrooIse3YqgWtpt6I6dU8WpMJZsIbRbZa+3MkHnfEKNVKOohDaaMLO1nW1bj2tHjA/n1c58fyf4E9tvGOYFTHxQbCbUojGZzu48KPmo0cRY/Gz86L6F1Aaaq5UdmmjCbqCH4hriUFouNNd22GyMY1rY8AMh3QVzhxUbmIboQ78Z7Papbuj4F00+YFJUeOQojpzLikLXzwrNciQvwMxCiBVCUbCwQHCv8Zcsl7MZE34irVKyqPPGo0k12eFa7mB/dxUKvpp5fvWW7H+9t/9i5xU5FoI9kZNWGtmaZodEMrDq5Pu3lyQ785/DBP7oVry18/S2aNGuV0BUaOsVS4LItrMclCs7et7lGHwbYW/D6SicWd/997Rx8zi+ZbhCOVJgaZ2boI5eRLkIGRBEgitVaHQrQj/Ard8B4QZbGcs2jhfAISdTJWcMpeyKjqnivwvJ2y2DHM/YYMBpidVow92AzevZzgPFrMuiapU0jNaiAiidNYQl1QZBpadXmOLpjDjZZZujEyXFHhNZ2TLGKlQGBsccQgN5/ZJRp4Gjwy6pTdkttgvbKAqmncbenxo62nx6qfpjHZwbShkys+ky37EdV4bWM+56A/cfBkKvgmyBO2QazLiHG/0ZNLyWeIWgqtlHcuvhu02OyG3yrX1o54d319/dJuQ5SzH+v17pLEbD50U+tNUsxLtdw+g5s2VvBNnKyL1vx9khoN/Ke+xgwyeMnuAPbybuIXRofQEUd8ZhRanJ/S9NNNqi39VkWPO2wmC4NbG9+OO1fxiq3rEeti9R/fhAp/y5FQdQflsjxwDWCu8nqHzR7sKtmLTasb9hs3+1ZpEtC2kIaaA8iHWo5nYI5CThqse2nWxmrofGDVlw5iekNTSZGzeAuYVzfW5gB6vfXgaydZq7gcKuV8agg1yUXCyLrpwqbnV0aUjbgh621bOvv//zX/8N5LLTFv+S5vq5sQWu16/PQsVlg+7HuSjAg9v7JXhldXVS51MeuGr7wIYKLyRuqAwFRJ0qXi8yCleXNtghXm0T7VAxv4ImxQYUeIen2CPTTtHdNTo0mfKiYDjJ7PzKxelr3T7vREpVcNG+7zFsfC4otM3C82FGrznYJdfNYSkQOHv/tJ+SxX5Kng5Ssji4y+BBnMLUQ2aIC8MmTGFJhYtz++sh1Feemg+hT/J+f28vhf8O4N+XexDMj3nJ1hvTN9i9GhN8mkyYgEYDK+JRgPa1PS7yskbz4zAEg+rlGtAlhcxrHLP/BPPamPIv7uJTrWVup41cws41ooc8Z0pJNXQCtE9gQGS4cHMGy+xtJj5GzIECY8pLGAOAtfbW+CPX0Tmn8R6feuQpM7g9wa3IjGkNsrfZ8ZYdr3k5WCbyg9SJ6790miNvYqF2TA0E9Kz+0r1bIuN2R1vYGkf8kS0aZq8XjB/ZYqCcCDUGO4emw60rOBx/bEy9Gytpn/56w5nz161Bc8+hD2yR2tah1VQwgMXRB7awxg+aWdnoHKuOOvRtXONOMS1LXxq0SDVXsJubKxnXEisS96/uYdT26T7PiGCs0H7/VjEdT3d9tN5EWTOKeCVopafyC8udJ7JaN/5JXHkXetPN/XI/E9AZg+PdAevWTfLBScYVs5bDF/56l+y61yTDmHg0tRtGF+NR1njCdMm80rKJKl/i7UztNMMyvV5up5E43OVY1jAdDEA63YmotN/z1P0JljBO0pvqGBpf6F0ZGLrBbkf0p4y6+gB8OrQ3+je+Nx+fgWbVcbRnre/WzYg2q/s+O3LMhzi5sIkzaGbDv6dQoYf7IuFWaeLixH4S3xq2BfsmPgj5KGw01HmvQcGqUi6w88DtqzScjcF3Oax8UwTOaKBlq4HArFh6Jxmn/gcOV2xsbW882eCqT12m7v8bM/UX4duE1q60SPPy31rew7171wu0sVybRhD7sLxWOBv0/mNyXPEfGfx5B68DMXQCL08JeZ5920rzkoqT7SQNrV4gyoyZqYTXtbhmsr1wlezOD373l8fsNvM+YGERxaE3vZyymXQUADOryuQomRpT6aPd3YLN5A5kY3yiqDAjLpPntLvBRWiCLNtm3Q5Xhk4wAxheru3PXUDuGtZYp4WC5RnU5Cn2C/cWGcvb5j0yraS2Xxq6OLcdpU4fCCylHZZyIUbW2gfuaMMxITeuFBvzJ59BZBZGkpEtId09faMoL5EGFc3ZdmovHbS3PSJu4bcLWSsgx84Htvgus4ENF2PplZnmqMxsRjkQ0l1V/8+GeAF//tfmqzbVY4Z1yBIW+dK4jq9Gcfh3FmKz1n2O7rtd4sLIuZ803nqLunO+jbngJ74UxldUtHsZEZZbBKzRzrn9ww1Ewt1kmLFOMUK2V/dRwxbB18R3FuxMljZUFPDerR3EF5u5Y2zlIWsdpRFaaJjcnJAtuHyakvOz69fk6hSKXeTmxJ7WdP9ektmpzHdnp2/6lxsw7y15ztydBS+5Fc2nDEaqe6x7fHwcUfx5JNVk163Vu2/OT85+ujrbgTUwfc9N2ZIBJJZPt71GgNmwbD/YOzgcvRjtYw1MajOjIoKnefVUy/N3dSryNn++Qu7PV8j9+Qq5f+Yr5JyLNOzJ7FYl5VjeRlvy0YUm75P5gX2T2JhjlaIFWBgFgAijsKNyHeV3ACZpcrTinW0hUrmD1Bc6ju+Tjx+hxfOLKp+f4WuszUPglSY4RYOFLohmuIa/i+QIC7crzM3WpQtft8m/1OvtBrngoxcBpEOWJUdJkiZQbln6+rvnu5DSIm3sw8f4Gqhom16Q/xyHpjAyC2WZuvUuAFpxW+lxf8D2gzB2IyoLA/w/BH6DS74Fv/MjW3wXHre/LF0Qojj7NFAM0vn/BQI+USw=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Revalidate verification</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/verification/history/{presentationExchangeId}/revalidate"}></MethodEndpoint>



Revalidates a verification exchange that the holder already answered.

The digital wallet checks the credential signatures, the revocation status and the trust chain again. The server then writes the new `presentationValidity` and `verified` values to the record and returns the full record. The other properties of the record do not change.

The request has no body. The server discards a body if you send one.

The path of this operation is `/v2`, but the response holds the V3 verification exchange record: `vpTokenResponse` is an array, `presentation` is an array, and the V3-only properties are present. This is the only V2 verification operation that answers with the V3 shape.

The server does not compute `requestExpired` on this operation. Read the record with `GET /v3/config/digital-wallet/openid/sdjwt/verification/history/{presentationExchangeId}` to get a current value.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the verification exchange record. This is the `presentationExchangeId` property of the record, not its `id` property.","in":"path","name":"presentationExchangeId","required":true,"schema":{"type":"string"},"example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The digital wallet revalidated the presentation. The response holds the record with the new `presentationValidity` and `verified` values.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>verificationHistory</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Verification exchange record. The record tracks one OpenID for Verifiable Presentation (OpenID4VP) verification, from the Authorization Request to the verification result.

The server returns every property of this schema on every operation, except `dcApiRequest` and `dcApiProtocol`. A property that has no value yet holds the empty value for its type: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.


</div><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the verification exchange. Give this value as the `presentationExchangeId` path parameter to read, delete or revalidate the record, and to receive a DC API response for it.","example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier that the server makes when it stores the record. No operation accepts this value. Use `presentationExchangeId` to address the record.","example":"6821b4b0f5b1c2a3d4e5f6a7"}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenQrCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID4VP Authorization Request URI encoded for QR code display or deep link. The holder's wallet scans or clicks this to initiate the presentation flow. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State parameter for the OpenID4VP Authorization Request, used to correlate the request with the response."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Full OpenID4VP Authorization Request URI or payload. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wrapper that holds the Presentation Submission object of the wallet.

DCQL is the only supported query form, and a DCQL Authorization Response carries no Presentation Submission, so the server returns `null` here for every verification that a current presentation definition starts. A value is present only on an old record that a DIF Presentation Exchange definition made. Read `presentation` to get the credentials of the holder.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation_submission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

DIF Presentation Exchange Submission object that maps the credentials of the holder to the requirements of the verifier. Kept for old records only.

</div><SchemaItem collapsible={false} name={"definition_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Presentation Definition that this submission fulfills."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>descriptor_map</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of Descriptor Map entries mapping each requested credential to its location in the Verifiable Presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the matched credential (e.g. `jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Definition that this entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression pointing to the Verifiable Credential within the Verifiable Presentation token."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>path_nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Nested path descriptor for credentials wrapped in envelope formats (e.g. JWT inside a VP JWT).

</div><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the nested credential (e.g. `jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`)."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Definition that this nested entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression pointing to the credential within the nested envelope."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for this Presentation Submission."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`request_sent`, `request_received`, `presentation_pending`, `presentation_acked`]"} schema={{"type":"string","enum":["request_sent","request_received","presentation_pending","presentation_acked"],"description":"Lifecycle status of the verification exchange:\n1. `request_sent`: The server made the OpenID4VP Authorization Request. The exchange waits for the holder.\n2. `request_received`: The wallet of the holder got, or scanned, the Authorization Request.\n3. `presentation_pending`: The wallet started the response but the verifier did not get a complete Authorization Response yet.\n4. `presentation_acked`: The holder sent the Verifiable Presentation and the verifier processed it.\n","example":"request_sent"}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Result of the verification of the Verifiable Presentation. The server checks the cryptographic signatures, the credential status and the presented claims against the DCQL query of the presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this verification record was created."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this verification record was last modified."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation definition used for this verification request."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VP organisation that initiated this verification request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Contains the metadata describing a holder. For e.g. Name, location, logo e.t.c

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder. For .e.g. DID or Name obtained from client metadata if available."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"presentation"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Decoded credentials that the holder presented. The shape of each entry follows the credential format. `null` until the holder answers."}}></SchemaItem><SchemaItem collapsible={false} name={"vpTokenResponse"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Verifiable Presentation tokens that the wallet sent. The array holds one entry for each credential that the Authorization Request asked for. `null` until the wallet answers."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data confirmed by the holder during the presentation flow.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data confirmed by the holder during the presentation flow."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataBase64"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base64url encoding of the transaction data that the Authorization Request holds."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential issuance exchange that this verification started, if the flow issues a credential after the verification. Always empty on the response of the send operation. The server fills it in later, when the issuance flow starts."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token from the holder. Present only when `responseType` is `id_token`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token of the holder.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the ID Token of the holder."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement record that this verification exchange created."}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the dashboard user or individual that started this verification request."}}></SchemaItem><SchemaItem collapsible={false} name={"requestExpired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the `exp` claim of `vpTokenRequest` is in the past. The wallet cannot use an expired Authorization Request. The read and list operations compute this value when they answer. The send and revalidate operations always return `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"requestExpiryTime"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the Authorization Request expires. The server reads this value from the `exp` claim of `vpTokenRequest`. `0` when the request has no expiry.","example":1747015200}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Validation result for each credential in the presentation, with the signature check, the expiry check and the revocation status. The revalidate operation writes a new value here. `null` until the holder answers."}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme used by the verifier in the OpenID4VP Authorization Request.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI the wallet redirects to after posting the Authorization Response. Empty when using DC API response modes (`dc_api` or `dc_api.jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`, `iar-post`, `iar-post.jwt`]"} schema={{"type":"string","description":"OpenID4VP response mode determining how the Authorization Response is delivered:\n- `direct_post`: Response sent via HTTP POST to the verifier's `redirect_uri` without encryption.\n- `direct_post.jwt`: Response sent via HTTP POST encrypted as a JWE.\n- `dc_api`: Response delivered over the W3C Digital Credentials API transport without JWE encryption. Compatible with both `signed` and `unsigned` `dcApiRequestType` values.\n- `dc_api.jwt`: Response delivered over the W3C Digital Credentials API transport encrypted as a JWE.\n- `iar-post`: Response sent through the Interactive Authorisation Request transport without encryption.\n- `iar-post.jwt`: Response sent through the Interactive Authorisation Request transport encrypted as a JWE.\n","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt","iar-post","iar-post.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifier Attestation JWT sent to the holder, proving the verifier's authorization."}}></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual that the server sent the Authorization Request to with a push notification. Empty when the send request did not set `individualId`."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier of the individual that the server sent the Authorization Request to with a push notification. Empty when the send request did not set `mapperId`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement that gives the terms for this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Data agreement that gives the terms for this verification exchange."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce used in the OpenID4VP Authorization Request to ensure freshness and prevent replay attacks."}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiProtocol"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`openid4vp-v1-unsigned`, `openid4vp-v1-signed`, `org-iso-mdoc`]"} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier returned when the presentation definition is configured for DC API response modes.\nIdentifies the protocol variant used with the W3C Digital Credentials API (`navigator.credentials.get()`):\n- `openid4vp-v1-unsigned`: The Authorization Request is passed unencrypted to the browser's DC API. The browser can inspect the request for risk analysis. Use for development/testing only.\n- `openid4vp-v1-signed`: The Authorization Request is signed by the verifier's key and passed as an opaque string to the browser's DC API. Provides verifier authentication. Recommended for production.\n- `org-iso-mdoc`: The Authorization Request follows ISO 18013-7 Annex C. The wallet answers with an encrypted CBOR `EncryptedResponse`.\nOnly present when `responseMode` is `dc_api` or `dc_api.jwt`.\n","enum":["openid4vp-v1-unsigned","openid4vp-v1-signed","org-iso-mdoc"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcApiRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Request object for the W3C Digital Credentials API, structured for browser invocation via `navigator.credentials.get()`.
Contains browser-specific request formats for Chrome and Safari.
Only present when `responseMode` is `dc_api` or `dc_api.jwt`.


</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>chrome</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials API request format for Chromium-based browsers. Uses the `providers` structure per the W3C Digital Credentials API specification.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>digital</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital credential request options for Chromium-based browsers.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>providers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credential request providers, each specifying a protocol and request data.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"protocol"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier (e.g. `openid4vp-v1-signed`, `openid4vp-v1-unsigned`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>request</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The OpenID4VP Authorization Request payload. Structure varies by protocol:
- For `openid4vp-v1-signed`: Contains `{ "request": "<signed-JWT>" }`, a JWT signed by the verifier's key.
- For `openid4vp-v1-unsigned`: Contains the full Authorization Request object with `client_metadata`, `dcql_query`, `nonce`, `response_mode`, `response_type`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The OpenID4VP Authorization Request payload. Structure varies by protocol:\n- For `openid4vp-v1-signed`: Contains `{ \"request\": \"<signed-JWT>\" }`, a JWT signed by the verifier's key.\n- For `openid4vp-v1-unsigned`: Contains the full Authorization Request object with `client_metadata`, `dcql_query`, `nonce`, `response_mode`, `response_type`.\n","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>safari</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials API request format for Safari-based browsers. Uses the `requests` structure.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>digital</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital credential request options for Safari-based browsers.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of credential requests for Safari, each containing data and protocol.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"data"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSON-stringified Authorization Request payload (Safari's DC API expects a string, not an object).\n\nDecoding it yields the same structure that Chrome receives in `request`:\n- For `openid4vp-v1-signed`: `{ \"request\": \"<signed-JWT>\" }`.\n- For `openid4vp-v1-unsigned`: the full inline Authorization Request object (`response_type`, `response_mode`, `nonce`, `dcql_query`, `client_metadata`, …).\n"}}></SchemaItem><SchemaItem collapsible={false} name={"protocol"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Digital Credentials API exchange protocol identifier (e.g. `openid4vp-v1-signed`, `openid4vp-v1-unsigned`)."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"requiresEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the OpenID4VP Authorization Response must be encrypted as a JWE. `true` when `responseMode` is `direct_post.jwt` or `dc_api.jwt`. `false` when `responseMode` is `direct_post` or `dc_api`."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `false`, the signature stamp is hidden in signed PDFs."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Page coordinates of the signature in the signed PDF, as `[x1, y1, x2, y2]` in points.","items":{"type":"integer"},"minItems":4,"maxItems":4,"example":[100,100,200,150]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>files</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of files generated during the verification, including signed and unsigned PDF documents.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"credentialId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential associated with this file."}}></SchemaItem><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Error code if signing failed, null otherwise."}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Detailed error message if signing failed, null otherwise."}}></SchemaItem><SchemaItem collapsible={false} name={"signedFile"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL of the signed PDF file."}}></SchemaItem><SchemaItem collapsible={false} name={"unsignedFile"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"URL of the unsigned PDF file."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the presentation definition at the time of the request.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the presentation definition at the time of the request."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"verificationHistory\": {\n    \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n    \"vpTokenQrCode\": \"string\",\n    \"vpTokenRequestState\": \"string\",\n    \"vpTokenRequest\": \"string\",\n    \"presentationSubmission\": {\n      \"presentation_submission\": {\n        \"definition_id\": \"string\",\n        \"descriptor_map\": [\n          {\n            \"format\": \"string\",\n            \"id\": \"string\",\n            \"path\": \"string\",\n            \"path_nested\": {\n              \"format\": \"string\",\n              \"id\": \"string\",\n              \"path\": \"string\"\n            }\n          }\n        ],\n        \"id\": \"string\"\n      }\n    },\n    \"status\": \"request_sent\",\n    \"verified\": true,\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"presentationDefinitionId\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"holder\": {\n      \"name\": \"string\"\n    },\n    \"presentation\": [\n      {}\n    ],\n    \"vpTokenResponse\": [\n      \"string\"\n    ],\n    \"transactionData\": {},\n    \"transactionDataBase64\": \"string\",\n    \"credentialExchangeId\": \"string\",\n    \"responseType\": \"vp_token\",\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"dataAgreementId\": \"string\",\n    \"userId\": \"string\",\n    \"requestExpired\": true,\n    \"requestExpiryTime\": 1747015200,\n    \"presentationValidity\": [\n      {}\n    ],\n    \"clientIdScheme\": \"redirect_uri\",\n    \"directPostRedirectUri\": \"string\",\n    \"responseMode\": \"direct_post\",\n    \"verifierAttestation\": \"string\",\n    \"individualId\": \"string\",\n    \"mapperId\": \"string\",\n    \"dataAgreement\": {},\n    \"nonce\": \"string\",\n    \"dcApiProtocol\": \"openid4vp-v1-unsigned\",\n    \"dcApiRequest\": {\n      \"chrome\": {\n        \"digital\": {\n          \"providers\": [\n            {\n              \"protocol\": \"string\",\n              \"request\": {}\n            }\n          ]\n        }\n      },\n      \"safari\": {\n        \"digital\": {\n          \"requests\": [\n            {\n              \"data\": \"string\",\n              \"protocol\": \"string\"\n            }\n          ]\n        }\n      }\n    },\n    \"requiresEncryption\": true,\n    \"signatureStamp\": true,\n    \"signatureCoordinate\": [\n      100,\n      100,\n      200,\n      150\n    ],\n    \"files\": [\n      {\n        \"credentialId\": \"string\",\n        \"error\": \"string\",\n        \"errorDescription\": \"string\",\n        \"signedFile\": \"string\",\n        \"unsignedFile\": \"string\"\n      }\n    ],\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"presentationDefinitionSnapshot\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the digital wallet deployment is not resolved, no verification exchange record has the supplied `presentationExchangeId`, or the digital wallet refused the revalidation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Send verification
Source: https://docs.igrant.io/docs/openid4vc-api/config-send-digital-wallet-open-id-verification-presentation-v-3

---
id: config-send-digital-wallet-open-id-verification-presentation-v-3
title: "Send verification"
description: "Builds the Verifiable Presentation from the credentials that the holder selected and sends it to the verifier."
sidebar_label: "Send verification"
hide_title: true
hide_table_of_contents: true
api: eJztXFtz27iS/isoPiW1knxPYu+pU+uxPDNKMhNP7DgPicuCyJaEmAIYALSicfm/b3UDJMGLbDmZqZ3aOi+JTBFAo7vR/fUFuosSMLEWmRVKRkfRT7lIE8PsHNglaDEVfJICO9NgQFqOL7GpVgt6IdaQgLSCpziAW3o4V2kCmhlIIbaQMC4TZkAmhgnLrKJ3bmlm0IPP8rP8RdwCGwdzjdlyDpJezMJ1NcRKJ7SAYZyNk/hr+kcOejUeMDeJkFluh34/ShczCcsSBYZJZXuOUGGqNQpikErLOBuOfq7v9/RbPOdyBiyBqZACnw3YxRyYXSqWaZWBtgIM4xrYIrc5T9MVg29xmhtxCz3iwErlbJEby2ZIqJLA1BRXXxALLvgNEC0grV4xQZxAmkzF7KlILWiGqxFZPaa0+7ZixCDg4qergUjGTK1lJK18PMVJOZsphaIyS9A9poEnbBwOGWgwmZIG3kMiNMT2gxbjAfvouSuItwwWmV31SNqhKpDQuWU8STQYg38jH83c7StVS+Z1J9CLqBeVWx0l0VEUKzkVs3OQyVDMhOXpR56mYN9lIEeJU9WY3g5ld7kX9aKMa74AC9pER5/uGvr+QYqvOQQs94LpVD3hmLmklYsX3S5RI4RBTuCzGvNGybhQk1UxyE3YI7YJa9hYBC8Nol4kkLiM23nUiyRfAP5VmzPqRRq+5kJDEh1ZnUMvMvEcFjw6uovsKsMRxmohZ9F9L4JvfJGl+Gxvustfxjuv+oeTfejvJ9u8/yp+Me3vwMFklx8m+/HLvej+ys0Oxv6kkhVOWWfbSalo/qSTYVDab45GFnstpOpOAj5RNA1PWaFWDGSsV/SU8XSmtLDzxaBji7GSFqRFgniWpV7kW18MUnUXcEBJeDcleXteqMkXiG3Ui6ywxIjhyR9vK+Kj3qY75JXFILUuzAZO95VOIftg8DgLw8ycZ/B0c1bb+KcoONXR1X1v/ZZqZmtYWqtgA89SmPF49fwJ25VM5daIBJr7tiJNvWnf1GoeSyZ+0VzagVA1w5sYx0AlU7QgiuV1FuLzTfgo1UOMbPqH6Or+6v7+/h7fcopoUHd2t7fbGn9RHXyS+EMesunmoicoblO2lYPBb8Od01xpukbN69SfPd2aFUaKWc3jG0NOi6ztkPRi3d6fuXf2L8+es+PczpUWf7pv3nuz0IQKM3TLhWmoibYNKqRlEx7fOK+J6nG55zXkBiAzbHybXagbkGPGDaou15o7hQq2GnPpnNRCadQyVHG5XppCMs6MkLMUWjtyWuPJKRfQYHMtDYNb0KuG7UeVJmGja3YvXO4VGyxd3oAdV+OIDXNO2n3L0xzYCqxXeEIN6Hf9NygadCioDkds/Dn6HI292XLeoMfG28UTmS8maJfHU54aKJ5OlEoBeScTNpZ5mo5LQ0DKxdwfxFrnqes6KpK2C2rq40ha0M4DOF180P/iAao82ItXuzuT/cn29GCyE+/yvWQfDqYv+Ev0cw0f+Sgda9y/MHVFfPColNY+mMUqh6JCX29VBY3C2QnJWcUSSMFCMKS+7c0cd50FhRHehBWjlghuA1SFgNbZ8yZWYyPLUiFvTAffaobQTzQXxiq9KiTfAAn1Pb+Cw3ibH+739yYvk/7+dDfuHyY7O/3d6QHfnuzEr5I9wD0rQoHv9IxLYTYWfnvHiYOWhaATyFK1Wjhzz6sj19xmIS6k5IdpCGdwy6qlNOv1rynz83yyEMZ4B/EEt1ANLA+6W2i9bzcZxKVkSRMWPDOt4LBGcKEU3jEjd01LC9CgEiDwgJr8P6ErtEULH1CsRxPOoXhU1m20Wcy1FhQWsjV8aDqOwq57qzgH7QyuyeM54wXuRdvtjHGlJwGA6QJU34GlOgxv9e31Rjb44Zinmq3ww+i6Kh2Z5ulUpIb0Lykx1fWCZ23wVGEu9hvPKMwVYAbslMdzH/RiYOxknSnjllVT8suerZAEOlVY5DU+G62I3zy5KQyoLCzM4wALtYvbx5kX4GU3pODhgtt4XqO1RzrijRobf1na69v4GpHfuIdo9b9M0v+ytGN0A+OFUdeLRMVj4uv3iXGEMJcFPK/k53iNxsVMUQJkPDDKfHSZ1+fvfj/jds7gG6qJKfUiUwJPsD/VG4uIWcRpJQHXkkT8uMn63akCjmGV2hGLQ5Mj6KCBvIVUZeBlVJcEZ68/Xjh0d3mGnwd/vTbIpuL+k5TBE/d/oBOFXAaRC76qEM1znHbrybja9J1NGLQe8K3xAW0S62a2ZfyIjqv7XuRDkYCmdbaoytPUiX3w6AQ511pc2og9KZKjhT18QZPqRE6aiBY4EFA5Z3fsxs0NJDgwnBftCoUgubQibQRsPkapw/n7XmQst3kHE3oRyHyBfA6HXGcgE/d17TGPbyCJrpqMeyumEK/iFJhbptPBPQDqjz7LnUE9i1dQMD6infsNUk7XJUwq6y/krGaLihT4k3IGn+VukwLarF9/01REEVeXUIPHMWR47IV1GKJC250MR0V2Y8PT5WPE1vEaY5pu3JFcL5dtiaGgMJ4DpRnqSJBl3BhIyoQEYP68ZGgZLxvG0yVfGQ/RiojWDTOgb0kZrQfvDp2l3GLw26DVRylLmMyVumEaMqWt8YjV5KltAe5LnopE2NUGB730aTxJhMuBngUOB5nXNgI4fRFnIAGd51a0M2M1eFVlC/wkns9GzCS3ufb87znz/C0TeuWelPLRcKs8c+iLJ4uEQPPfJpHbzNuoc8stPO4I6DW/rudFt8lrhiasI9ET7GEp7LxzNh91GFXZ2FLJMSNFpoMe26Wqh8EHyavpbnw46ce7fL+/P92O+4f8ZdLfiXcne3w/OYAXU+RBnAqQdpOw84Te7Ei7lCSVhadOrjSR1If3I0oLseFoSOLQVaHocWqKqhJN8/DCNfZnynhFWMNsMqrC4LyeKppkQ6Kc/GlrDyhIjaIZeIKmeZquUSi/QUdWh6kki1fotxsywXTJFDTIGPxGWvW4J7K5rYROmaFMDK/JdTbcj7cqYWzvd8aptljfmlYxoD3vxgThg6p88fjGNgmYO6pRGGsb0IKnAklCNOuTpAN2SoBmfZG4rPaguRLx/HsTFQP2nqqtVdGiLKMF1h2ta5xysahlTYhnUsl4A3N3guU1NdM8m4uY0aAnnbS8bqm9iryBFftJEFCgYMoqysO3nfxUg5k7V6KYsSpDM57yVd3O/bkfX759b74eZm++bf8+++Pl6d789SzU9wva5GObfYcbYruD7arAiAMeOcYjyyykaS3VtqRT4hO3VHkIAOptdk1InCB/+TGBWxHDdbEyhQKVKL8vJ9h29J6+ZoUknisDXoMaWcpB5SF+A8sTbjvrTXVSijef6B7qRmKull55hHSxWwB4PeETmLpiTPmEZ5lWZU6okdyph+luV79TmfxRWyEMKh7Dono7+Xzfi1I1UxuZ0w/v3xYT4Jg1k8V8Mxv2tgBX6EZ9p0TXjLG6Bf1U+mgQEws+695zbeCjHKz+6pisESwHoqlYG/Al2FB9nauGP+hA1+tyMEFkvC4sIjj8YzHsxinF78vbkIcJzr3zKVXyJviqSt2wnwmE6RBpPFLAzxFrdDrPnj+zpjuPVGFHp5d/l4lrVzts3Qk8NasSJOvwzWZyABL2ce8k1JxqQM2upcCdeSJDW9R4cxefKTuHMCPp84Kmwavz3OnMk0LEDpMWpwohDGEE2hBvbueEHHT8V2/lNt4gPdrJS3bhXXJI6uj04md2PuwjrZcnfz25iYrtRhBiqOLcFf66qDx/x3Zebe/s9Q/YYqjiv55OJ8i/Vy0qNiv9t2yj4QooWVozE5S1tZpLw6nhaOgxSaPzpnqBERZ5LDTlpgOzCw9KysqcRDqxVbPoZUD+TLiBF/u5Tn0g4H1EmO3zuMSxg+gJsEsrLqonZBzWb+x4CLFKIBkTzpyrpatE48Q1iORMX+fQvynz5GdntiGATnQHBnzZ2DSgHTWPENN46g4ht/x4poGimB/UcWQTL+Z6FJWObFBntKAXHirMEINIH+B0dT04MAcznp6J5NhaMC1Usg7X4SB2BtooyQq352d31FezPZhrIkfteqhdYo6AJ83uXHHVXVqHoG2qz1T2OOFnWmEBdopZFuOLO0Vo+kObCom6/P7UctHMhbzwCYUfIauehy7SzlR3MwWVH4WdX+jc2LfC2O8nearyZlaeqpCuxTnXdOTQ1KTCWH/sc2PPQWNkeabVrUhA/9jBoW0wPyUr5vTJ4mZhKaeMTah3D2ocUXss47nSm+RuhmwBdq4S6oO6gRW53F4xs+MEp9m6CDProt0qTk9EcnQDaBW/HWwfUmRxswkox+xGO0NKFHbRgeZbzDoTI1WLF7U5P5Rec5XeZuVwXaLD9WOeKCkxrzcaMhq4YWXwrNWbMg7zLGP0kuMiszEOKWv7ne+x3d69ZHyVKl52gj24iUGY5j7HPspNcl8u2T0aus7LDfJAVJgoXHF1SAtdQDtsIJ0WLHUEhipXpL+vcxfYEvYpJroOzJBXymvD5XUiTfHnnJu5KyL7MU/yOZcFxcEogv+lf6x175V5lmZGeMFXWPFtNvbXGho8ri7Slz8KWV3/XRjL07TsLZezHNMXzzAwfl6kWB/x9w5vtW/FVCl4H1YrNsGLTzRX/S5SCQ2pWlarcA2KRrAfukvEhDQWuPM11T2I18ubH+PlWT5JRUzmquXqDDW/vFmHLzwVD1VWyi2XGdaFSgC1xRnkaiPhviApJjiV8SUicXOeZ1jP2wjEtloEjnd2X538dNL/9Xz34EXUo79/OfkNP+0evMBPVy1U+/rjKfPd+J3XTroOgqtem/IglNt5yIpXkx8Xc2/QUvPxlES24JLPHKgtKVvrlx+XV6ugURdbcT2uPO2h+Cp2n54Mf+2fnvuUdlBQeAOrKqPTtUk8Jxj/d6vqI45WmHKnpYMNcjJRBzU/r23cepiSn2vdW7gaevAbWDX6tm5Egv1aX5Y3rlMLjfa4yO1wC8lxuLjrs+/qRfrGrFigiV5kiAENxAojxyZiXPDEB5wdneE7L/dfbu/svNjevu9FeZb89cun3CDQRsOVbEJGV+Dfur22pk99TTN3q7O67CAK+lNaXQBBSbxekq6VgrvLqWvLkUXNrVGVauQ2WrWW7vhxbXzWESOtD0XqmNvB2wpGthBTN6zotlihRofqdXXf6rr64L7s7I13bR+uGcvJmgBzV4PT2u6hB68l13xZac80uMpjM+eCh3ddGobuvdRyFK7V+79x+VVV4KRMUnBDt2iFqfBBKwVWK2hc0c2zOfCErqbe4V/77urZd1xzDJcBrZU+UQlKmj4HJRtslquDioduFA7rFyJospYhOcWnbKKSEmnU71GQ7VxyjWB/srLQnyrdxw/N+3kJWC5SfyuvFbE2a8qjIXkGeSPVUvZq/RIuyTNRdt51KZwEXAN5SjMJgjKZ/l52Md+6O5pBW1S4ZHu1nutDph4svMLllxmHxmKMycj6IxxYOwKlShsHmBqAvAvJuKiz3uIxzYvui3XnqLxaV+pxIT5CjdgkAY8InJqgMEHM/Vl3h5MGuHKSrlKm41JbvWSaGjsu7oC6pWbcwhIv9fnNjZ3WNN6qEzRgp3TTziWrm5ftika1vGi78Uu4GV2XZPOY7jzpmH7/4WwWE6vRlX8X0sKMHHzpjPcJDLSm74LSZffFTxxbf7DKV96Yj+7vO07iB8k9yCSnVGfNwRMt2P8v1pT3Gn2HY2EwQx5h8zPEuaaW0U930XEm3gB+JJdq+Qx/p6C0vO5nDqprtSd4d/tX0mBkiUudYfOuIhzgGvejrdu9LZdO3PInoe9OwhaiK5FsmeTL0m6Fue6tuzpEu9/CaBdxFm2l68cThrBQfqeIDXQaHUVzazNztLWVwEL1eSYGYuY7n8jRtHLMSe4KC2umeWyGc8tnCNHXDDfu6yYhV5UIHCQiBSoEUcWh7oH/NQYnw+r3GGqRVsspHp+NKILBo4JGPQ5QSq3rdFybB6EGL2tNE3J5U/ENEtdYOnY0sjF7JpW/LGo1FynxIOMxPO8xGMwGjWmPmB/4r5XKNbKjfwOrf48dRMFT+b76uYfTQu/vaj89gPLHtGnkEuz9eoK9jxiqfzYaNoHwUZTsHvIX8Q709yevpv19vpP0D+M96L+c4s3V7eQV7Ow0RtER8AfxypdDG09RiJ0hdhmmYr5STlVhjrgrVcMCMcZR5P3o/1RqUUq2bNZr6VOoig2BVx1+mcumG0rpIyctMIH/L0rs4mXffZ8+zH6NjMk5Nus9e0enf/ScnOQTL+JnWlkVq9T4nylB5QSJY4y/b/qn79m2igljcuiRl3TXKMlKrEqXGl5tyA0pnuUyQYDQp/0KjqW4FOuCpLQFYkFqfS/Cs9cfL573GuV+t1qzuL61GL7trC/3olTEgC12R3flmcx4PAds/WuJbrlcDjh9PVB6tuXHmq23o5PT389P+zjmvkK+lTiRWYlvByjOOhpEJ/bd7d39wd5gh/pXlbELLgN68PdqahXFpp0IPOV/fnvpP7+99E/57SXvAC18s1tZyoVE9abzdOchxqfods/9rslUUBqzBjN8GofSEAQ1ypxDeQyOWhkhwhtXvWiOUOboU3R3h+0YH3R6f4+Pv7r6wqerXnTLtXBJPMQkwuDnJDqiSz8PHLBn7z3YfM7+qb/71Mn4Ao5IxCIEHqKjCNM8iFaambX7qzKrQOxxL504JvR9qqqYpIXNEWG5EceUc3nw3RB/nr07v4h60cT/XNSCcHik+RJjfL6MjiL8LRLSC/I0hP3x+V2U+tpOdBS5eRGTIG6qQzFXwvUfgp+8qbOlicrcZvDfIM9RH/IvtPBvYPXv8nX3zdoBJRJ0b6OQMGPxvydzT5g=
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Send verification</h1>

<MethodEndpoint method={"post"} path={"/v3/config/digital-wallet/openid/sdjwt/verification/{presentationId}/send"}></MethodEndpoint>



Builds the Verifiable Presentation from the credentials that the holder selected and sends it to the verifier.

Give `credentials` when the presentation record holds a `dcqlQuery`. Give `inputDescriptors` when it does not, that is when the verifier sent a DIF Presentation Exchange definition. The two properties are mutually exclusive, and you must give one of them.

Take the entry identifiers from the filter operation, or from `dcqlQuery.credentials[].id` on the presentation record.

After a good answer, read `presentation.responseRedirectUri`. When it is not empty, send the holder to that address to finish the flow at the verifier.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the presentation record in the wallet of the holder. This is the `presentationId` property of the record, not its `id` property.","in":"path","name":"presentationId","required":true,"schema":{"type":"string"},"example":"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Credential selection for the request of the verifier, and the optional response encryption algorithm.

</div></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"DCQL selection"} value={"0-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentials</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credentials that the holder selected for each credential query in the DCQL query. Give one entry for each query identifier that you must answer.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the DCQL credential query that this entry answers. Use the `id` value that the filter operation returned, or `dcqlQuery.credentials[].id` from the presentation record.","example":"Person-Identification-Data-PID"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet of the holder that answers this query. Use this property when the query takes one credential.","example":"d29a6c1e-4b8f-4a1d-9c3e-7f5b2a0d8e11"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Identifiers of the credentials that answer this query. Use this property in place of `credentialId` when the DCQL credential query sets `multiple` to `true`."}}></SchemaItem><SchemaItem collapsible={false} name={"claimIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Claim path pointers of the claims to disclose from the selected credential. Give this property only when the DCQL credential query holds `claim_sets`. When you leave it out, the wallet discloses the claims that the query asks for."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"encryptionAlgorithm"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ECDH-ES`]"} schema={{"type":"string","description":"JWE key management algorithm that the wallet uses to encrypt the Authorization Response. Give a value only when the verifier asks for an encrypted response. If you do not give a value, the wallet uses the algorithm that the verifier advertised.","enum":["ECDH-ES"]}}></SchemaItem></TabItem><TabItem label={"Presentation Definition selection (legacy)"} value={"1-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>inputDescriptors</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential that the holder selected for each Input Descriptor. Give one entry for each Input Descriptor that the filter operation returned. The wallet reads only `id` and `credentialId` from each entry.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor from the Presentation Exchange definition of the verifier.","example":"input-descriptor-1"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet of the holder that fulfils this Input Descriptor.","example":"d29a6c1e-4b8f-4a1d-9c3e-7f5b2a0d8e11"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"encryptionAlgorithm"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ECDH-ES`]"} schema={{"type":"string","description":"JWE key management algorithm that the wallet uses to encrypt the Authorization Response. Give a value only when the verifier asks for an encrypted response. If you do not give a value, the wallet uses the algorithm that the verifier advertised.","enum":["ECDH-ES"]}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet sent the Verifiable Presentation to the verifier.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation record in the wallet of the holder. The record tracks one OpenID for Verifiable Presentation (OpenID4VP) Authorization Request that the holder got, and the presentation that the holder sent back.

This V3 shape keeps `vpToken` as an array, so the wallet can send more than one Verifiable Presentation in a single Authorization Response.

The wallet returns every property of this schema on every V3 holder operation. A property that has no value yet holds the empty value for its type: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.


</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the presentation.","example":"6821b4b0f5b1c2a3d4e5f6a7"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this presentation in the wallet of the holder. Use this identifier to read the record, to send the presentation, or to delete the record.","example":"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73"}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the verification exchange at the verifier. It links this presentation to the verification history record of the verifier.","example":"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the digital wallet deployment that holds this presentation record."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that owns the wallet of the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationSubmission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Presentation Submission object of the DIF Presentation Exchange specification. It maps the credentials of the holder to the requirements of the verifier.

DCQL is the only query form that an iGrant.io verifier sends, and a DCQL Authorization Response carries no Presentation Submission, so the wallet returns `null` here for such a request. A value is present only when an outside verifier still sends a DIF Presentation Exchange definition.


</div><SchemaItem collapsible={false} name={"definition_id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation definition that this submission fulfils."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>descriptor_map</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Descriptor Map entries. Each entry gives the position of one requested credential in the Verifiable Presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the matched credential, for example `jwt_vc_json`, `dc+sd-jwt` or `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor that this entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that points to the credential in the Verifiable Presentation token."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>path_nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Nested path descriptor for credentials in an envelope format, for example a JWT in a VP JWT.

</div><SchemaItem collapsible={false} name={"format"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential format of the nested credential, for example `jwt_vc_json`, `dc+sd-jwt` or `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the Input Descriptor that this nested entry satisfies."}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that points to the credential in the envelope."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this Presentation Submission."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vpToken"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Verifiable Presentation tokens that the wallet sent to the verifier. The array holds one entry for each credential that the Authorization Request asked for. The array is empty until the holder sends the presentation.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`presentation_pending`, `presentation_acked`]"} schema={{"type":"string","enum":["presentation_pending","presentation_acked"],"description":"Lifecycle status of the presentation in the wallet of the holder:\n1. `presentation_pending`: The holder must select the matching credentials and send the Verifiable Presentation to the verifier.\n2. `presentation_acked`: The wallet sent the Verifiable Presentation and the verifier accepted it.\n","example":"presentation_pending"}}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the verifier accepted the presentation and the checks of the verifier passed. The receive and send operations always return `false`. The server sets this value later, when the verification webhook reports the result."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationValidity"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Validation result for each credential in the presentation. Each entry holds the result of the signature check, the expiry check and the revocation check. The receive and send operations always return `null`. The server sets this value later, when the verification webhook reports the result.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={false} name={"vpRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the Authorization Request of the verifier. The wallet returns this value with the Authorization Response so that the verifier can match the two.","example":"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the verifier from the Authorization Request, for example a URI or a DID."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI from the Authorization Request. The wallet posts the Authorization Response to this URI."}}></SchemaItem><SchemaItem collapsible={false} name={"requestUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Request URI of the Authorization Request. The wallet gets the full Authorization Request from this URI when the verifier passes the request by reference."}}></SchemaItem><SchemaItem collapsible={false} name={"responseRedirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the verifier returned in the Authorization Response. The wallet sends the holder to this URI after the verifier processed the presentation."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinition"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"DIF Presentation Exchange definition of the verifier, as a serialised JSON string. Empty when the verifier sent a DCQL query, which is the only query form that an iGrant.io verifier sends. Read `dcqlQuery` for the credential and claim requirements."}}></SchemaItem><SchemaItem collapsible={false} name={"nonce"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Cryptographic nonce from the Authorization Request. The wallet puts this value in the Key Binding JWT to keep the presentation fresh and to stop replay.","example":"z4cVLRsq9pKx0NgQ7E3hJg"}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request. It tells the wallet what to send back.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet that the holder chose for this presentation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata of the verifier from the Authorization Request. The wallet shows this information to the holder before the holder approves the presentation.

</div><SchemaItem collapsible={false} name={"clientName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"logoUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location or address of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"coverUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the cover image of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the verifier."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credentials that the Verifiable Presentation holds. The array is empty until the holder sends the presentation.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the DCQL credential query that this credential satisfies. For a request from an outside verifier that still uses Presentation Exchange, this is the Input Descriptor identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential in the wallet of the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Credential types of the presented W3C Verifiable Credential. The wallet leaves this property out for other credential formats.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Disclosed claims of a presented W3C VC JWT credential. The wallet leaves this property out for other credential formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Disclosed claims of a presented W3C VC JWT credential. The wallet leaves this property out for other credential formats.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type of a presented IETF SD-JWT VC credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type of a presented ISO 18013-5 mDoc credential. The wallet leaves this property out for other credential formats."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Disclosed claims of a presented SD-JWT VC or mDoc credential. The wallet leaves this property out for other credential formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Disclosed claims of a presented SD-JWT VC or mDoc credential. The wallet leaves this property out for other credential formats.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionData"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Transaction data from the Authorization Request, as the verifier sent it. The value is normally an array of base64url strings. The holder must approve this data before the wallet sends the presentation. Read `transactionDataDecoded` to show the data to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDecoded"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Decoded transaction data. The wallet shows these objects to the holder for approval.","items":{"type":"object","additionalProperties":true}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data agreement from the Authorization Request. It gives the terms that govern this verification exchange.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Data agreement from the Authorization Request. It gives the terms that govern this verification exchange.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legal Person Identification Data attestation of the verifier. The wallet uses it to check the legal identity of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidAttestationPop"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of possession for the Legal Person Identification Data attestation of the verifier."}}></SchemaItem><SchemaItem collapsible={false} name={"legalPidVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet checked the Legal Person Identification Data attestation of the verifier and the check passed."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerifiedWithTrustList"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the wallet found the verifier in a configured trust list."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustServiceProvider</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust Service Provider entry that the wallet used to check the identity of the verifier.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Trust Service Provider entry that the wallet used to check the identity of the verifier.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"DID method, or key type, of the trust anchor that the wallet uses for this presentation.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"kid"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that the wallet uses to sign the Key Binding JWT, or to decrypt the Authorization Response."}}></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token that the wallet sent to the verifier. Present only when `responseType` is `id_token`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the ID Token that the wallet sent.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded payload of the ID Token that the wallet sent.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"verifierAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifier Attestation JWT from the verifier. It proves that the verifier may ask for the requested credentials."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query from the Authorization Request. Read `credentials[].id` from this query to build the `credentials` array of the send operation. `null` when the verifier sent a DIF Presentation Exchange definition instead.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Digital Credentials Query Language (DCQL) query from the Authorization Request. Read `credentials[].id` from this query to build the `credentials` array of the send operation. `null` when the verifier sent a DIF Presentation Exchange definition instead.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>encryptionJwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key of the verifier as a JWK. The wallet uses it to encrypt the Authorization Response when the response mode asks for encryption.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Public key of the verifier as a JWK. The wallet uses it to encrypt the Authorization Response when the response mode asks for encryption.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the encrypted Authorization Response.","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptionAlgorithm"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ECDH-ES`]"} schema={{"type":"string","description":"JWE key management algorithm that the wallet used to encrypt the Authorization Response. Empty when the response mode does not ask for encryption.","enum":["ECDH-ES"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `kid`, `jwk` or `x509`."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet made this record.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the wallet last changed this record.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presentation\": {\n    \"id\": \"6821b4b0f5b1c2a3d4e5f6a7\",\n    \"presentationId\": \"3f2a7c18-9b4e-4d0a-8c6f-1e5b2a9d4c73\",\n    \"presentationExchangeId\": \"8e9c0a94-3b7d-4f2c-9d11-2f5a0b1c8d3e\",\n    \"openIdOrganisationId\": \"string\",\n    \"organisationId\": \"string\",\n    \"presentationSubmission\": {\n      \"definition_id\": \"string\",\n      \"descriptor_map\": [\n        {\n          \"format\": \"string\",\n          \"id\": \"string\",\n          \"path\": \"string\",\n          \"path_nested\": {\n            \"format\": \"string\",\n            \"id\": \"string\",\n            \"path\": \"string\"\n          }\n        }\n      ],\n      \"id\": \"string\"\n    },\n    \"vpToken\": [\n      \"string\"\n    ],\n    \"status\": \"presentation_pending\",\n    \"verified\": true,\n    \"presentationValidity\": [\n      {}\n    ],\n    \"vpRequestState\": \"5d8f2c9b-c2a4-4f0c-9a7d-1c2b3a4d5e6f\",\n    \"clientId\": \"string\",\n    \"redirectUri\": \"string\",\n    \"requestUri\": \"string\",\n    \"responseRedirectUri\": \"string\",\n    \"presentationDefinition\": \"string\",\n    \"nonce\": \"z4cVLRsq9pKx0NgQ7E3hJg\",\n    \"responseType\": \"vp_token\",\n    \"credentialId\": \"string\",\n    \"clientMetadata\": {\n      \"clientName\": \"string\",\n      \"logoUri\": \"string\",\n      \"location\": \"string\",\n      \"coverUri\": \"string\",\n      \"description\": \"string\"\n    },\n    \"presentation\": [\n      {\n        \"id\": \"string\",\n        \"credentialId\": \"string\",\n        \"type\": [\n          \"string\"\n        ],\n        \"credentialSubject\": {},\n        \"vct\": \"string\",\n        \"doctype\": \"string\",\n        \"claims\": {}\n      }\n    ],\n    \"transactionDataDecoded\": [\n      {}\n    ],\n    \"dataAgreement\": {},\n    \"legalPidAttestation\": \"string\",\n    \"legalPidAttestationPop\": \"string\",\n    \"legalPidVerified\": true,\n    \"isVerifiedWithTrustList\": true,\n    \"trustServiceProvider\": {},\n    \"trustAnchor\": \"did:key\",\n    \"kid\": \"string\",\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"clientIdScheme\": \"redirect_uri\",\n    \"verifierAttestation\": \"string\",\n    \"dcqlQuery\": {},\n    \"encryptionJwk\": {},\n    \"encryptedResponseEncValuesSupported\": [\n      \"A128CBC-HS256\"\n    ],\n    \"encryptionAlgorithm\": \"ECDH-ES\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"string\",\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The presentation ID is unknown, the request gives both `inputDescriptors` and `credentials` or neither of them, the record holds a `dcqlQuery` and the request gives `inputDescriptors`, an entry has neither `credentialId` nor `credentialIds`, the verifier does not support the requested encryption algorithm, or the verifier refused the Verifiable Presentation.

This operation forwards a JSON error body of the digital wallet without a change. The body is therefore the `errorCode` and `errorDescription` shape of the gateway, or the `detail` shape of the digital wallet. Every other holder operation always uses the gateway shape.


</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></TabItem><TabItem label={"Digital wallet error"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"detail"} required={true} schemaName={""} qualifierMessage={undefined} schema={{"description":"Reason the digital wallet refused the Verifiable Presentation."}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Toggle trust authority
Source: https://docs.igrant.io/docs/openid4vc-api/config-toggle-digital-wallet-open-id-trust-authority

---
id: config-toggle-digital-wallet-open-id-trust-authority
title: "Toggle trust authority"
description: "Enables or disables a trust authority. A disabled trust authority is not used for credential or verifier trust validation. Give the wanted end state in `disabled`. The ID in the path must be a UUID, so this operation does not change the two built-in trust lists."
sidebar_label: "Toggle trust authority"
hide_title: true
hide_table_of_contents: true
api: eJztWN1v27YW/1cO+JQA8leatqsxDDdLsl1vwRo0TvPQBTMtHltcJVIlKTue4f99OKQkS7LT9g67Dxe7fagViefrd765ZQJtbGTupFZszK4Vn6doQRsQ0oZnDs4U1gEvXKKNdJs+XFRfRfcbSAtKOygsClhoA7FBgcpJnhLTFRq5kGhKshVPpeAkuw8/yhWCSxDWXDkUgEqAddwhSAWzSt6sD9MEYXJFb+l0zl0CGTGbI3C4v59cRWA1uERa0Dkazx6ExqBYnHC1DILcWsO8kKnrES+vUCqts30WsZpyItiYxVot5HKql8sUr+RSOp4+8DRF9zZHNRFTor2oIGARy7nhGTo0lo0/bDsY3yv5qUCQHhYPhl4cgkwvSUltllxJW4JEtq94WuBxk5tcLcyGM+BKwGw0q7g9ZzJwgx4e7xFI0CChIElfQphFTPEM2Zi5lq0TwSJm8FMhDQo2dqbAiNk4wYyz8Za5TU401hmplixiC20y7tiYFYUUbBcxfOJZntKZ+WsxWpzzs9438QvsnfM3o96bxcuz3lC8iF/haz6an79ku8cgDa37XosNiegKj7VyqBx94nmeytgjN/jdEvbbQ930/HeMXcuKD6yKNvYYsdxQLDiJlqjqL3sOc61T5IpFHT8/JKhgRlrNogD+YapU7PoQTi94aum4dPQVVfjIGkARv53/RyrbXCsbNDsbDr2CLR0oXopccHckUw3G2njmX41ZG4t2KBwX3hXKF46yP8EyEUl81xNtKVIci6SvSKljkJc2wzv/a8El3B2kGdUsj1jCV1WChdR7Nn38yc/kX+QfNrqAmCvKM4NcRKVrInC+sviqiyk6zyqDtXRJqHFoek3bqtpkW5HxlSlU4X2IKaoio+i/nt5NfpveUPB3HLrJsY0sWR+gsWhWMkbgcYy5szAruczghJ5gegej0Rt4NToLpCg88SlolW7adlTydxHzte7L/r/RIWSPKfeDDvG2V4h4RaFBSOu//Xs6vSX06fcO7t/dtBiVqoLQcZGhcm1tE+dyOx4MDF/3l9IlxbywaMqU6sc6G1w/XPZiraw2ThbZANdxz/PtEdeBwYUdJMiFHWRcKn96etN/ylICIFTdL9n/C8/wmZBv9gxpgSvALHcbCJxgTWXHp6OPeQIhBCWUdRaWFNpKA2nS8dM9+M4HN9I6UvavF0fyw/PV0SfPX5sqPpu1PF3zjQWDrjB18W3Z6F/tIlZWhAvXME0V2RzNsVr0BE5maB3PcjiRCizGWgl7WqF9xNo1Jz2W0jo01A7+E72HbZ1Hr89fD0ejV8PhLmJl8f/vKp5y6yDTgpzwt+m+a7dkKapOUVWFMjmazmna2wjHxy6zTud67PYg310pJ/0Et6W/zkN7/epW2RSHxmhzqQUp65+vGsAfCO82wD313oVSOVx6H9bQnXt/H7A/VufrDP6eC5AqLxzUEysrZ4t2bNDBsiAE/+4HclhITAWlayatlWoZHTZUbWDt5+Wq/c2pvlidrlBEUBbobmTVIzs+USFnhx4Z/YM9cq9KpP5AcQDNy390sE6UQ6N46mcSNODFdDDaRcxiXITB9cOWXeTyZ6THR9oxHF/S5sbKXQ/Csgcnft27On9/ecoiFnrfhYoTbQiYDF2iaVvMC48LrU1jNlidDcL6OBCBWy+kwkDnqKQYhFGgDvvBtrth7QZlrjHSmSw6tlVeYaZLg6kMmrQxmgjMdI/nsi+XhivXl5rtoi6DW6NFEft0fYbNlzjcOb6kmeIZchs+dxV53HvijgIyxFHljzogeHhR7qTBlfuttITrDx/gB53t4nYCH3HjawtNDfHBNl3OTrMWnxkEMfWunRtcyCcUYTKfBR1hBidKu/JKwXCZegxyHuNpBNhf9jtsx1ASfrvRhSE4eh9x892szygqKTnf7Vfc6yr8m6un3wEJiYWu0pzHPs0x45Iwt0Wea+P+tce5hkr+uH/VdlDTtx0EayLIjV5J4a+FYk2q0QUN/dJk3BrCQ7L4ce29H9BIe7isJzcLE2sLrmKEk7c+qyanftI7Tnhr0NYi6ky8PSWNnI51asmh0gJ5G+t7LOpCAXcLToO0tsAIEp2KsJP52XEDZW42BksLhfWedFwJboTteXslVw4WqV7bEAUl0l7bhxeX8P4STn56mJ5GMLme/gB3V72fHqbw/jJIm9y9hdE3w9GL3kvIrnQ8yK5umsNsuCDxe10qY1TWe74K8pzHCcJZf3jguvV63ef+c1+b5aCktYObyeX1L3fXPaKhzU+6tBUDHqxqr6mShypMcPvZ8Oy8/6I/ItpcW5dx1dAn3Id1+3Y3+xpt6P/Xi9X1YlnUHD65QZ5yqQhh79Jt2Tg+sNVZuJpZSL/wtZpHuKFUYShuNxAW+QLRvaSreshjxBJtHQnYbufc4r1Jdzt6/alA4zsgDdjGJ13oM3Xd8dvQZ9x78q6cI07hf+iS86gvqq6jNvW+MWYsYh+pKR1egu4e64XBYxaOXQZketPm2jI+nMWolQaKC3978tmzzUnj9n7KIjYvr0IzP3Yxw9d0ncnXbMx+Zb8yHyu+APpRj95vWcrVsuBLOh/YUu8hv7Rb7kffcssHMuwoLt3uG2yh/8myoyTfUuH5GTff1cfDl2cJ6o4fTpOXHne73Z8/CKEM
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Toggle trust authority</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/trust-authority/{trustAuthorityId}/disable"}></MethodEndpoint>



Enables or disables a trust authority. A disabled trust authority is not used for credential or verifier trust validation. Give the wanted end state in `disabled`. The ID in the path must be a UUID, so this operation does not change the two built-in trust lists.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a trust authority of the organisation. The value must be a UUID, so the identifiers `0` and `1` of the two built-in trust lists are not valid here.","in":"path","name":"trustAuthorityId","required":true,"schema":{"type":"string","format":"uuid"},"example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the trust authority is disabled. When `false`, it is enabled.","example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The updated trust authority record.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustAuthority</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust authority after the change.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the trust authority record. Records that the organisation created have a UUID. The two built-in trust lists have the identifiers `0` and `1`, and you cannot read, update, toggle or delete them with the per-identifier operations.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ETSI_TL`]"} schema={{"type":"string","enum":["ETSI_TL"],"description":"Type of the trust list. The service accepts `ETSI_TL` (ETSI TS 119 612 trusted list) only.","example":"ETSI_TL"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the trust list. For the `ETSI_TL` type, this is the HTTP or HTTPS URL of the trusted list document.","example":"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the trust authority. The value is an empty string when the create or update request gave no name.","example":"EU Trust List"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this trust authority is disabled and not used for credential or verifier trust validation. The two built-in trust lists always return `false`.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was registered. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was last modified. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"trustAuthority\": {\n    \"id\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"type\": \"ETSI_TL\",\n    \"value\": \"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml\",\n    \"name\": \"EU Trust List\",\n    \"disabled\": false,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The `disabled` field is missing, the organisation or wallet cannot be resolved, or the trust authority does not exist.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update admin avatar image
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-admin-avatar

---
id: config-update-admin-avatar
title: "Update admin avatar image"
description: "Updates the avatar image of the admin that owns the access token. Send the image as `multipart/form-data` in the `avatarimage` field."
sidebar_label: "Update admin avatar image"
hide_title: true
hide_table_of_contents: true
api: eJzlV9tu2zgQ/ZUBX5oA8iVpFlgYRbGpnV24zTZBc3soAngsjS02EqmSlB030L8vhpRt+ZLW2KcFNg+JQs4MD8/MHJIvIiEbG1k4qZXoibsiQUcWXEqAM3RoQOY4JdCTMJbkUoFL0YGeq9oujslacPqJVBtuSCV+OPihhVFeZk4WaFxnok3eStDhCHwYglFYxRuPYCIpS9oiErogg4xpmIieiLWayGnAds4Izr2TiISh7yVZ90EnC9F78f9KQ4noOVNSxI6OlOOpPSB42MYp5f7LLQoSPaHH3yh2degQ66togBSPkSgM43OSLDs2J9dxrDNSTUUkeDl0oifGUqFZiGiL8tuUQNF8g+62qPwPo7CFVjasdNrt8p9df0tmJmOC0lOU7KSPKW1wgUWRydjz2/lmOcrPiNjcrTZTVNJ6Z5+LfS5OuowHrnaMI/HcUtq1pPIpGKMl0ZtgZmmTcYX5Hqpl8lOGRSToGfPCr71DtKgiQTnKbF+MTdMLb1ZFAcYvzT+zVRXVlTBkxod7kW66nTcbbDjYinBnDgC6EYI9qkhkaN29tNLRARgu0TqYBWvg4gEnw2aMzjZ3IZWjKZmdEF90toTPPp8Posw7qZq3ItXqAB9fQW8seHNQZT4mw+7yUMLvlPxeEsiElJMTSQYm2qx17Y0NRK5iHpSCuy+X4PT+KPTsyCjMDgF3Udu+Cs/D8nNucW30TCZkDgk8rH2gqJ3qZIVO/rGS2X/PXjPSduTDyoGtlmfMZrRqqYRn3ROOc7CMNdWEjNGmrxNiheDvQWP1x+gXkrf23tcMK8U563arPeH37H0tUh8wAamK0kGBBnNyXNFhv9vkY+lSbeQPSkQkUsKEDKNj09/CufA/pWao6sbhU5AM+GW2OKoiYSkujXQL0fv6Is4L+Yn487HiPeLUMhcDOZUOM3jALCMHR1cFqeHg7L5/LCJxZ8nA36hwSjmz/BiJnFyq+YJSlJ4adKnoic7stKPVWKNJOr5xO80bAgNhmNbj2NzJgHJd70JEomT1Ealzhe11OgnluoWFbMupQeXaUosq2g5wbXRSxvzPa2F+FeHG4VSq6WvuNkxvA3lc03vDVRaKY0nyKssYBiLBt4Y6P2J5yIrzusBD4++I//UQnmgB3AYsQKG428DXnxlm5Uo+RhtxRhCWgby0DsYEhaGJfKYE5tKlMAoYYQRHSvPhlxI4gzLzHBQY03EE1J62t8L2oHZ8t9ClYTpaT7R4P+KLG29vopcNibFvyPriIWxZFNq4P9bkrfYv/1oPbbLeTNgWLSunpbpbQIg195DjO3iR+Wr1oJcMhbL26n1PRk4kjjOCviGv7JhZGFpboooJjq58/Q+PAVXyiuO1IbtaYtUz18eMyOlYZ5azJC1wCkmxj90QeX47gLS2pAhSnSWRX2zGKywgqXsybsArrU+PQ5WgSWzL71eicjDJ9NyG1NZMe7QPb/tw34ejjw+3xxEML27/hJtB6+PDLdz3w2rDmys4+b178rb1G+QDHXfywWVjTQh3TMsX6UzGpKxXvGXlFhinBKft7k7q5vN5G/10W5tpp/a1ncth/+LzzUWLfar1hXmdTiYr0XG5yp6IBMtGSPtp9/Ss/bZ94m9P2rocVQNPeCnVj7XmO2C7qxpnxn/m6VdrhaNn1ykyDPeeMtzEgsJ+FbNTfiMGjRWRwPppsfVMS7V1bP3yws+MO5NVFQ9/L8l46Y/EDI2vYX8QLE8ML8xPLFyiH9hp3TImNs9KxrbvLclSGpzO45gK1zDfOYyr5tlxfXcrIjGuX7C5P0v9k8aHjdafASPr36akPnlJrT8Y+3JKLRogttU1YOXfjHyvyzuuwU+0eL8yDzOvOqwUPVhz6h6rqvoHruKuww==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update admin avatar image</h1>

<MethodEndpoint method={"put"} path={"/v2/onboard/admin/avatarimage"}></MethodEndpoint>



Updates the avatar image of the admin that owns the access token. Send the image as `multipart/form-data` in the `avatarimage` field.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"avatarimage"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","format":"binary","description":"The new avatar image."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service updated the avatar image.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisationAdmin</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name"}}></SchemaItem><SchemaItem collapsible={false} name={"avatarImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Avatar image ID"}}></SchemaItem><SchemaItem collapsible={false} name={"avatarImageUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Avatar image Url"}}></SchemaItem><SchemaItem collapsible={false} name={"lastVisited"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Last visited date time"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Role ID"}}></SchemaItem><SchemaItem collapsible={false} name={"roleName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role name"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Admin's phone number"}}></SchemaItem><SchemaItem collapsible={false} name={"imageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the admin's image"}}></SchemaItem><SchemaItem collapsible={false} name={"imageUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to the admin's image"}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier for the admin"}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity provider ID"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the organization"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the organization"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"organisationAdmin\": {\n    \"id\": \"\",\n    \"email\": \"string\",\n    \"name\": \"string\",\n    \"avatarImageId\": \"string\",\n    \"avatarImageUrl\": \"string\",\n    \"lastVisited\": \"string\",\n    \"roleId\": 0,\n    \"roleName\": \"string\",\n    \"phone\": \"string\",\n    \"imageId\": \"string\",\n    \"imageUrl\": \"string\",\n    \"externalId\": \"string\",\n    \"identityProviderId\": \"string\",\n    \"organizationId\": \"string\",\n    \"organizationName\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update admin profile
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-admin-profile

---
id: config-update-admin-profile
title: "Update admin profile"
description: "Updates the profile of the admin that owns the access token, for example the name or the phone number."
sidebar_label: "Update admin profile"
hide_title: true
hide_table_of_contents: true
api: eJztWN1P20gQ/1dW81KQnA8oJ52iqjpKuFPaHqBC4KFFYrAnyRZ7191dJ6TI//tpdh0nTsI16sPdQ+GB2J7PnZ35zew+QUI2NjJ3UivowTBP0JEVbkIiN3okUxJ65F8xyaQSboJO6JkKLBjHZK1w+oFUJEbaCHrELE/JUxVmJLQJyiZakVBFdk+mDRHonAyy0UECPYi1GslxMH7Mdi6CbYjA0LeCrHunkzn0nvyrNJRAz5mCIpZ0pByTMM9TGXulna+Wl/MENp5Qhvzk5jlBD/T9V4pdpTco+gzajFFJ60W9ebiNIDfso5NkWXyTZYtOJ13KH843mCN4bCntWlK1EnR4j5agN8LUUtMTDtmmcZmsWLPOSDWGCEbaZOigBxBBFfbw0txSKCOgDGW6TUeT9dSzlVFw44fsZ8xVRoBTdGgGGY5psNXTptixZxeS+cWgv6ZhaHZwtKGCJcoIUrTuWlrpaAcfPqJ1Yhq4BWedcDIsxui0uQqpHI3JbKj4pNOF+yxztlPIvJCq4uZrYofFcga9so0SYnG5a8CHSn4rSMiElJMjScZXal3Tr2wIZK1zpy0YfvoonN6uhR4dGYXpLs6dVrzPuufd8jQ3vzB6KhMyuygeVDKMY16o2qxQyd9r8Pn56K1qWte8WzqceYQcbdFWrrNerSDySFKaMOyKwkNmG0r/x1hic61sgI3Dbpd/NvVYMlMZUyWdPIv2DNQ/DbAv+PmCny/4+YKf/xN+LhDxKIDgzjC2iiZkjDYnOuE51D/3V6zfRj+AvKX0tmKoEeeo2y23qN+y9iVIvcNESJUXTuRoMCPHGR3W2wwQM1YTNEQwIUzIsHMhMge/cGSGCgs30UZ+p2QjNL/90kkzUBWk8JxARngzazEqI7AUF0a6OfQ+P8FxLj8QP96WvEYcW45FX46lw1TcYJqSE3vnOalB/+j6ZB8iGFoy4m9UOKaMo3wbQUZuovlAmBc+NOgm0IPO9LCj1b1Gk3SwGgeCa9bbbnrfp0xXnkMEBWMxTJzLba/TSSjTLcxlW44NKteWGspoXcGF0UkR88tzan6k4dLhWKrxc+I2kNcduV2G9JIzKyTEIrD1zmL4EAHPUNWewGLkgOMqqQMMbrTCi4F4oLng1Gc4DgndFjwUTjEtajC9a+i5E8GMyArrxD0PizSSj5SImXQTcRd8FHdiT2kXzv7OoEx9DHKMaT8S1B6319T2RCX4Zq4Lw+FoPdD87V3bj79cZZ+Wh//TRR4/M0vyjOcnuTCqLQugCkz9vjZtbSX4Dr6kNEaj5efFqNNdnWCW5Go8WX6QmzblFmur3X+Fc0sLX1LXm/J2StNDDrJUI71AOow90tUBLPJcG/fHMkPrWMq/lp+aqb1aFWu5VwstBgorUMSaN9WRkPzLMOAdXaRhwAs/MFyTkSOJ9ymJE0M+GJhaMbC2QBWT2Dv3wDLYF6iSZwQvDNnaRA1GF/vskdOxTi2XgrSC64QUy9jGXOHPXNLagiIx0WkSeWNTtjAXSQV28Yp7hfU14FAlaBLb8uuVqJwYpXpmQ/1Ukfbe3rw+EdcnYu/9zdV+JAanV3+Ky37r/c2VuD4J1gaX5+Lg9+7B69ZvIuvruJP1P67YFOFYY/nslsqYlPU1s4CHHOMJicN2d2PrZrNZGz25rc24U8nazsfByenZ5WmLZcrlGW25nRysRMdFvXsQAWNz2PbD7uFR+3X7wA/s2roM1Yo/4cqvulvM60u/pNnT6j78391PVmDr6NF18hTDGF2EwT60pc8wPeT6Co2J8WNxczjR1jH96YnPqUOTliV//laQ8R0ygikan5G+Xy4aq+9lD4z1cBIW3LpiL5g9LQL0rw0h3HqCxHEcU+7+lXe1v14MryCC++pSNfPzBhicMarhDHrwBb6Av6b1ae9nHP7+BCmqccHnlB4EtQwj3E+aLerBt6jqgRe2IKn5ipPr3Sqshf/zyraKvOF0+0DztzV7oDwrUHfIwM07eVuW5T8U7faE
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update admin profile</h1>

<MethodEndpoint method={"put"} path={"/v2/onboard/admin"}></MethodEndpoint>



Updates the profile of the admin that owns the access token, for example the name or the phone number.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisationAdmin</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The profile fields to update.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name"}}></SchemaItem><SchemaItem collapsible={false} name={"avatarImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Avatar image ID"}}></SchemaItem><SchemaItem collapsible={false} name={"avatarImageUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Avatar image Url"}}></SchemaItem><SchemaItem collapsible={false} name={"lastVisited"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Last visited date time"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Role ID"}}></SchemaItem><SchemaItem collapsible={false} name={"roleName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role name"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Admin's phone number"}}></SchemaItem><SchemaItem collapsible={false} name={"imageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the admin's image"}}></SchemaItem><SchemaItem collapsible={false} name={"imageUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to the admin's image"}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier for the admin"}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity provider ID"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the organization"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the organization"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service updated the profile of the admin.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisationAdmin</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name"}}></SchemaItem><SchemaItem collapsible={false} name={"avatarImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Avatar image ID"}}></SchemaItem><SchemaItem collapsible={false} name={"avatarImageUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Avatar image Url"}}></SchemaItem><SchemaItem collapsible={false} name={"lastVisited"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Last visited date time"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Role ID"}}></SchemaItem><SchemaItem collapsible={false} name={"roleName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role name"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Admin's phone number"}}></SchemaItem><SchemaItem collapsible={false} name={"imageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the admin's image"}}></SchemaItem><SchemaItem collapsible={false} name={"imageUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL to the admin's image"}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"External identifier for the admin"}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity provider ID"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the organization"}}></SchemaItem><SchemaItem collapsible={false} name={"organizationName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the organization"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"organisationAdmin\": {\n    \"id\": \"\",\n    \"email\": \"string\",\n    \"name\": \"string\",\n    \"avatarImageId\": \"string\",\n    \"avatarImageUrl\": \"string\",\n    \"lastVisited\": \"string\",\n    \"roleId\": 0,\n    \"roleName\": \"string\",\n    \"phone\": \"string\",\n    \"imageId\": \"string\",\n    \"imageUrl\": \"string\",\n    \"externalId\": \"string\",\n    \"identityProviderId\": \"string\",\n    \"organizationId\": \"string\",\n    \"organizationName\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update credential definition cover image
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-cover-image

---
id: config-update-digital-wallet-open-id-credential-cover-image
title: "Update credential definition cover image"
description: "Uploads or updates the cover image of an OID4VCI credential definition. This operation is the only way to upload your own cover image, because the create and update credential definition operations ignore `display.backgroundImage.uri`. The server stores the image, then sets `display.backgroundImage.uri` of the credential definition and of every credential configuration that it holds to the URL of the new image. Use this operation after you create the credential definition."
sidebar_label: "Update credential definition cover image"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zYU/isHfEoAWU7SFhiMoljqdIPbbg2aOHnoApgWj2w2EsmSlF3X0H8fDinL8iXZ67DuJZFlngu/c/nO8ZoJNBYz7lGwQc4LhwkT6DIrjZdasQEbm0Jz4UBbqIzgHh34OUKmF2hBlnyGoHPgCj6Nrl7eDUeQWRSovOQFCMylkqQohdu5dKANWk6fQUY1WhUrWPIVeA1VsAQrXVnQS9U1kcAUM145jLYtco/AlWhcOm5za82BnCltESZCOlPwVTrl2ePM6kqJEelPKysn5COCQ0tmnde2uWrjgZ+jAofePa+F0GicPOIS+axzwAXaVfdIplUuZ1UDjp9zD9LDXBfCETSkcPz540a3wmX0KoVxwGQHWp57tATjBqgn3Un/UixhreRIsAGLnowDrldyJj0v7nlRoP9kUI3EsNUzpPCEe7OEGW55iR6tY4Mv6/0UUvJbhSCDYC7RPo9RuL0zmNFZt38w17bkPgG/MpgEPLOCy9KB87bKfGWRjrTZKJ2ruMowZQmT5Izhfs4SpniJdNtW8VXrwEiwhFn8VklLVeFthQlz2RxLzgZrRobZgDlvpZqxun6Ih9H5t1qs6ESmlUfl6bGsCi8Nt75PfvcE90EHqkwLEh+s665uYykYXqKLehZoQ5zpU7w4G7CpVNyuWLLnyX7hhtBALgukDAr5DPwAzoxbAds8fjYyKavrLjJfuh4+tP7o6VfMPKt3D0cYd138Y4NOiGoMfJPzm7qLF5AqvJls7U0gl1iIlAUjzmjlImgXZ2f0b9fQfmGLjoFtGxHPXD30ho0hmGqxohaGpfErSq05chGSf023fhl96OQBN6aQWaiy/ldHPq07Ye9CitZqO9SCqio8X3VucgByspcyW+ltpkrlcYaW9H3npSmQDV6endVH1B9kd0eEveUCpDKVh7bYKcZ030OwtZ1xJV3b6yv1qPRSJaD0E1Vfcp/N0cHkeElOEmKgEDXnKrSQcaW0B8cXuNsTwWKOFpua3w/M+U8cmLHilZ9rK3+gOIDm1U+fs02DaBLLIo/9II4lKGInyq0uj/Qial+hIYU03eRm6Lltp9lPR+r8mFVW+lUgzUsjPyA9PhCneD4jLmUNB0MkYTgJNEzcdsoSNgq1QBCX6Oea+NtUAWFiuQHrLy76kdD7IurpLYOevjaopOg78XXp+9uS620rsr8+Xol1v9P16QqE2jHav8JSN6CyhFW2YAM29964Qb8vsNQ9bmQqZ5Yrn0rN6mRfwbXVospCd3hCzT9puPF8JtXsKXEXv9535GEbmBvK95imm/C0+cbji2auiJHdThaXTamF+jkg58vrETziCqggCeJYZpFlFryocEPEkx09E4hmoKychymCsZjL7yhgKf0cJtFHmMCJ0s3g5y2XRcDA8AxPE8B0lu6pHUAj+JqGb4Kj94irN5NI+FLletMaeBZaA5ZcEpCuMkZb/+sWvPb+8vftq13UuwHbg6UVAmP1Qgp0wCHTVM2eqsgUWKLykVYahGJBhKHvDq3MJZ8WCNs51cGomQHhpJkKTwPpHxe8tuhaE221XZ+SR15nunDNLkMhREUyrqG7H82y4XUkqSQMM3FIpYrJV9BUYYcDHVQuhMdzJbgVrhfuK7nykBd66WJoG6SDt/cvhnA3hJP397enCYze3f4GN1e99/e3cDeM1kY3n+D8l7PzF71XUF7prF9efTwcoh11pEJmqFzovZvMNTybI1ykZwehWy6XKQ9fp9rO+o2s638cDd/9efOuRzJ1wrz0xU4OBLCEzqo2eixh1DZi2C/OLl6mL9JzkjXa+ZKrjj/j53a8zpK4X2QdMvt/i/3Pb7FNU/b43fdNwaWiZArZu27Y8AtbXLCkWXApWXYYMS7CStJkFFiRjh7jRZawwZNr4+5CNNfOk931esodjm1R1/T6W4U28HzCFtyGthPpUzp6fuKXmG46n3xupq9T+Lcs10fx3zClIpoMvMYGjCXskYj0qeW7fqg3g1KAJR4exsv3bknlVtmxBZvmgCh0mWVofOf4wUxbd2en6/EtS9i0WePLMJKGvTuoTbaPNKMljMh7dx54DPNA80C+HwVgfzSIvtJf8vyoyGtqoB9w9aY9Hr95UqAdR+JpCsdDXdd/AzeuCrY=
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update credential definition cover image</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/{credentialDefinitionId}/coverimage"}></MethodEndpoint>



Uploads or updates the cover image of an OID4VCI credential definition. This operation is the only way to upload your own cover image, because the create and update credential definition operations ignore `display.backgroundImage.uri`. The server stores the image, then sets `display.backgroundImage.uri` of the credential definition and of every credential configuration that it holds to the URL of the new image. Use this operation after you create the credential definition.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential definition that specifies the credential format, type, and claims structure for OID4VCI issuance.","in":"path","name":"credentialDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Multipart form that holds the image file in the `coverimage` field.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"coverimage"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"format":"binary","type":"string","description":"Image file to store as the credential card background of the credential definition."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server stored the image and updated the credential definition. The response body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, no credential definition matches `credentialDefinitionId`, or the issuer cannot save the new image reference.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The server cannot read the uploaded file from the `coverimage` form field, or cannot store the image.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update credential definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-definition

---
id: config-update-digital-wallet-open-id-credential-definition
title: "Update credential definition"
description: "Updates an existing credential definition. The changes apply to future credential issuances that use this definition. This operation replaces the whole `credentialDefinitions` array, so always send every credential configuration that the issuer must keep. Set `credentialDefinitions[].id` to the identifier of an existing configuration to change it, and omit the field to add a new one. The issuer always discards `display.logo.uri` and `display.backgroundImage.uri` from the request body and keeps the stored images; use the update logo image and update cover image operations to change the artwork. `version`, `trustAnchor`, `kid`, `supportRevocation` and `revocationMethod` are immutable after creation, and this operation does not accept them."
sidebar_label: "Update credential definition"
hide_title: true
hide_table_of_contents: true
api: eJztfQtz3DaS8F9B8bZqpTrOWPIj2WhTqU+W7FttnLXXstZ15ahEiMTMIOYQEwKUPOfSf/+quwES4GNmJCuykihbm9gcPBuNfnfjc5QJnZZyYaQqor3oZJFxIzTjBROfpDaymLK0FJkojOQ5y8REFhLajtm7mWDpjBdTaL5Y5EtmFJtUpiqF30VqXfEiFZqZGTes0oKZmdStoaRmaiFKDn9npVjknHoIdjlTuWBJM+Jh3VEnjJclX8ZMK8bzS77UTIsiY+JClEt/EakqJnJa2fFxITA2rE2UbF5pwz4KsRizY2EG5vpwOpZZAnvEnthgIkXJ1CSEVjiVsjBi0sSMFxlTc0mTT6TIM2jAs4xxVohLpgpBcLULs3vKpE55mWmWZFIvcr4c52qqxlUpExyy/nzO04/TUlVFdjTnU0EtJqWa44Sl+LUS2rBzlS2xH2yZgKyNKkXGJPTSf7eHJFiF2MBgNvoNu9mvqboQpf1cn532dgwj8NJcqvLjmCUXotRSFUnMElNW2uwX6UyV8NePMoP/6GqxUKV5Ky5UimPZzZX1h5+EmakMDl0wOZ9Xhp/ngvGJESUcNrYhIJsQoTIlNCuUYTxNxQLBPx//XERxVLc5yqK9iM6O7sChnErD8/c8z4V5vRDFUXbQgxdRHC14yefCiFJHex8+ty9UIX+t2vgCkOm9VYSaeiFSaKvbDSeqnHMTM7NcCNpomnM510ybskrx5k1UyV4fHT79z8FRffXGURxJWMyCm1kURwWfC9htz3aOsiiOAFFkKbJoz5SViCOdzsScR3ufI5g42ou0KWUxja6uTqmx0Oa5ypbQot03hMa/xCW74HklNC50EA5j9gKvMN0RPEv4zHMmPuEJDtCDMXs/EwVLcn4u8gQ6LkqhRWFiJg3d81QVhsuCccNywbVhTwBfS57CAQKkoIEoDGwGyJok3Hv0i4YdfO4CQ53/IlITxZGRJocPB307itaAgg+T2ftCG+/pFV6U0MpIoeFQ8OS7qBpHc1m8EsXUzKK9J+2z+Ec158WoFDzD5eAYjJqcA01HeABWZCJD4oh3WOqBS7wlxtMx++sRQJC9USVt8lCl1VwUhu3v/nXbIupSVQyABszTsYQY/4iosQnG+vyiIehpVZYwF23l0s0VMh/qi000S97wJS7vRIuSNTgM5+p+OuBlNvDTfpqqCpqEvx4dsiNLhSwuvJkpo1j4vQTmpEV5IbKaLixyboDewZUUn/h8gXdrGKbRVdxL0bSHDHgjCBeOjJjraG+3jQoHAxdDrz7zmHELeAUrNQL5eS61sTIFyA6qQEmhMOXSY5N8zQ3kOSDmki2q81zqmcjG7DUcY2LFkUZ8CMYZs1eCX4gVsomqjGNGCBgYrBRzdQHCypgdKrxvFj3bqyTKrKt0Bjv3SNBL5FEJUyVLiDslzG7IqAXLxYXIY3YuUu6kDLvPUgAd1b6oQhdc0lF9jniev54gj22T3vAMXxdimMDJQstMrKK39YocxDUTPJ3Zg+OacaYFMH2zchrciGPFHlod0eA/CcMzbrhjdTQ6XngHGM3ngiW8MjNVyv/Dcd8SYN4tF/Y+Ne10qhYiuRZNvH0qGKIg3EnxaSGtiFUc8qV/HYtqfi7KLmfEzzB6BlyrKozMG0TJ/OlwcKHH7FBMeJUbFD+f7ASnmPI8rXLUamAQ7LJkKMLWorGTlJiRc4HL7rAyb93nSuWCd1k6yR4g9yQxEwVAMQBOwwaZHT5ceDLhuRYJzt9mmeuPj9rBwRAR7Z14zBJtuKn0GdCmBFoTWI5evHvJ3qmPomDH2IC9kroWRfs6nz3eebzrjfD+yUHQFX4O+yPCSg28TWZMFfmSOFMP9ZCaJb9cmrOL9AwErwSmvpRanxlY4pm/jAt/EcfQiC1KNZE5ImhnSy2Q+9BAVlNU82jvQ+R9j+KovW34NLic6PTK9YAJD8rlwqhpyRczmf4olrTF9edJ7RyF1nJawCX8KJZ7oPBlex/Fkqjsp2c73wVrt79GcQQ/rVnOUa2ZrF/Sj2LpazJbKPdt9yxxzP5XVSzlBXAQTx0kqYbEPZBHUOQTK/QApCDFRJWpaEgo6VSF0Pr6l1JXpaPn3oxVkYnSErOQjAP9QQ1uIUo2U3kmyuFLa291s9K3wlGW666U57m61HZGTayZ1PeyHhMATxQwA0QoBC9Hlrw1e9PDy20aPZdFJospkZA+iaktJHk4BOfNzmkANqcROkJMw0qvwRgtDiGvSVKlxRnh/DrCMdfqbJ6pFC9FLT20Ubt7W365/Ij6H00UnV5dxdEQ911/WQ7BJDCXhYBTvCR9DY0J7iQ1CwZnWVU6NtvW4NkkV5fjlixwlgnDZa4t+Xv78oB99+S7b9hbmc7YfjD023rGApnDuQRrkpUY7B/OzrkWmR3sNfRnj8c7DH9zmip0txq+1z/Ar/4l+uSptwVQ1GYVRLPg7+vh3LtUq0asEk7YsVO8pLbirIdZw1KX1CHAxuyt4CSI8QsucxSeLLwupZnhLzkyU1xfrdPiHbSmuz57QgudqCFrRLs+EwrYCeGKWUw7OQoVRJ5lxCdVOeWF1IQdaN9Da5Jn0qt1xizQA5KW6bHP5DjuSKBkcVp7Y+wWoXXf5sJ9IfT8/teUb70fe2xyi6pcKE2yYLPHA5WrDfjkP8QnlkJTlqqsdyt4Ts241mSQ/NdL/CfZxnmN+GS+YEbxyTBV9M7sptvBf+x0cLLr8fBVYwzuQg0G755+Vcr1Ozh5+8oN2NibcV08N+/Epw0kpv3ciLLgRl4I2r0DfDDgVXCiiLXrd/28Oarfdu/nrYlwwVcBs34r9EIVWhwVRpQXPF+vUf0kCzmv5myh8hxYjLQ92ZYsmBapKjK9XUPL3jEkAJVus6RDMRElSBwe535RZAslC9OSKjaVdL2RJp7Q2xbGxqFKAIQYdI7/HLCtf75/tz1mSZb+t85Gv1ySHIAqzfHh6J/v37H/HIw9uQB/PX7Ndv+2s/tk9IzND1X6aH74imilXUPW8O/LGbBUNWEJbAQMWxepcb4XleJHpJWovhOl9Dmet2zYvFslWKLskpDhoV6EW30Dhvq1cPvn8et/QUsQAkuhdeNAEHltSlnw0vTRN77MFbKtUFCzawBeP+Wy0PQjGXLGYBtkyV/GF2myseZG1tzkL6t7eCcHKk0gwTkowrxRHP0FYWVCGczJqQPSXptV+CgHLRm102OUlFCgvt7+SKbKRFHfImVmorS4RExYN2LUYiF46URhQiongkx8U0eI355OhSIx+aZOCmn2jRGg4qHJfSZKIpwX6QaX7z+ilBOJHNEDCog6nqq3IVyaU9wIKo4NVWWxJ6qxqEq14GORjkWVyb2FzPZ2LWuyl2wDEcIZhM2NNlDj3bXWr8rpWGo1RnIyfjbeHecLUIzHQzbpk2swBbTfIl/La28fuqACwS5TlwXcZ+1dV2fekpqdvH3VJ+/C/QbZFSibs9Wi3bZnzQndfiQppbiQ4K6uvTNozRbpR/w5c2dwLiaqFEgYnUkTFkJQuQdGkfYi7r8ppPnlgBsxVeWy1y5er7nrknT90NEbbgnRCZGBh3IN9WBbtSLT/RXUkRodtvfI0np0uH/cdO+M2+LthSpEwrYKxVIQn9BoKFhZ5WI7ZglcKLa1EKUGq4wFvDUrgrUA2gjOcYBi9GvFcziYjPGGMkKTX6lN/++IOIvqfESNvJ8cPT5fQhvy16JJIwXxyagSgyq2fXyD7YA0KAHQgvMojn6l/9gZolPfsQUfwJ1eVDlqkP3+83dtkbOBbY/x6ssPTBpfgdZxo9DCuXgaqHdifVfAHh+4AxelupBgbfP6NIenBc9pErAqVRpEbeRF+zF7DrB/2XuK0A2xpD688Ldm3f9O3xw/Z3CsAmgUnXmDeohugIxVniMhQdUXiBmwB2wXOheA6ukNYFCLYOEJJcM0CMyVuSWb3gANRdgG7c6SDYwsKmxoTmztNBM05XDsjXJe7USfSEMgSZ7u7FhBVpSlKsnEkdiFgxnsDDqdFcqcTaRJxmwfh8POnMGB+vuGfprMKLhZh0r2/GtYb4/ZfsHmh6/YlieV46CW1fdx1fnhq2Sb8VwrVgiRua3VZ3t0/PrR0YuDWqyvhYFjOS3ACElugZhdzrgRaOoA/LaLHLOXsD7CLYSIw6Y4cMc6E8qL/f3grrx4d3zE3h2z3d3v2NNvH492gSuiobnjtxqz9wh8GtxO6ROf2LnA0xqXgumkrh3me6EP1Z05svMGNBD5w5IPP0duiJ+j04Rt1drRdryiD5yEMFqOd3a/e/rt453d8c4u/O/nKGbtEeEkt+PaNWllWyv3kqRntNwT8H/O90S1V99UC/W+NovqPGFbJA1vxytRV3B+5pZ0hjs6c6AC7C1IgiPua2a8gH3XYM1iQq9knkH8wlRewKpxoq3+MJvx97LIxKcfxl3WvEfq4LmAuD44RkD9mC1gFsF5zH7Ff7sz3w4tdRjmouur+KNYHgCtsTvW1XQqtBFZl7MnxGnBzsV4oS9FrWg4DwKMUJMCDP2jcBrPheEpFG9KpSbXdV+Y7k44WFV9PWUBA7MtuMI+F/aX8c9Lc2vTo9rmZlUTtlBaW6V5C+P7yL6xO95hCTY6gxn1mV2KcAL9R7H0oKPf1gFva8MS8LN1iS4dX/ClDGtaB5ql0eFEiyUN1S0DhBDYX8dz0jU+eWOvX96PqxbjGP1fvRZ/9ZbXnRtYB+BWaF7r9yft4xmJDAFiO4FgVZXSLClkxCpbsU/knz5j51zLdHsjP4/U6gw7nWEn6FJ/EcUM3CzZqPvTXGUgJYng40xOZ6H81h4dTHaVFuUZOBLgmDpRBGtAAZ1Z2LkNknu5bdg42LZuCd9+uTR3i2f3Eqh/WlxCyzdaJtYj1AFZPTq2TozNI9kGRRo0VWPoZNcichMbJfLTHk/ZgOUnaYfWbTi9b3T8u/WJ99lpnFWnLxKsA8p+xMEAug7A8FJS5AT+Nujj78Ol+szCBS1CQ/dAuEF3KR0zNy1Jdtxd1s49Zi8whC9H+gLw5NbmS9p8wWiBQBlAekUXydTuGYREDJBEUS8mlREVRIQIhe/Zkclih81dMPpaUyMF5Jba+OuDj+CXQG+oXvBUxI1UDmEhugkINpfKddUke9OisK2DSaB41gFTGDsYTE54E4TI1ofZK9AQyG4CIIoPtPf/Q8SzDNwYGINRQTgkWunmvMi4saaumwqBFAAvizSvMuFhTCBzg8gMiDGXGt1edCchvBVHJCepnEtzKHWaKwglusmaKKYHI1syGkh4KExILS8EuJCurvxsjA90XU5jgBRedp6/8a4TzHHV7mKv/OmAKfrrk9XAp3dtUorXGufXhpfGhlx4HY4r3FbSG3PceLs8s/m5yNWldXP9GYlosP+vQjff9RHEnjMdfyVC1VkJnFXjPLhvVOsWiUj7e9vXf3oVr8NWuUEsc2MF7aRXDjoQ6igsGwAGzq+VqZyNmUSVHTO5l85T2ngLDMVAENiI1Pcn+19wunUcnccTjHIJa4zbMOn3NuKpkIZ5dge29f5kf7svZrAn9xbDB5Fe47ZE5oSCFyeHR26G/TKdSSMojfAtRHkI6PoSkhsxh9Ozy2DoCUc2ZQMNKZTMBYJ8AViaSFFLTew8LljSxqwJO1NvoF/La7Z5jB0FMrKsP9ZuTercygSh1Xm9GwTVed5cS3J7U3jJ0gomboGGTswwE2SNnVuHxpi960vSjb8k77ePUT5E/f2Jov6CaIQasWuc7s81v9VYQX8Fcloooq1ecK/F4N9dUOFXAm0nFPEaALamm35ZwU/OPG0kK1wkeBRHrdA9TLuu5nMO0lR0QIQLfCp1SmSLEgNUKC2SghsZ+eKRNnoJcdEbCidw0oa1jB1yw9FXvR2FrB5TJwazTD+QaBM9mfztfDd9vDP6jj/NRk8nu7uj82/Tb0aPxTP+t2xn8vT8CeQPbbCGEfhXo74UuiffPFuTbULRAytTZzrbaWeBtHMjTlelQwyG9Xvc1xYe2ADsIVL+r6pKNtwrdh5WzM28aALaMqrh4Hteox7CHv3XBP+JAuIbWTrZH9MaRHG2Azejv0Q2+i5aEdsW+aZN96cPTp37EIH3sThDmJ0GCgWdbccSgZJ73PSf8LnMl18wwLkszQwu9DW6g3y80QVD5GZb88NX28Movgo3mzydG6Flz5HWwbgDJ1pHIUbd2ASK81l5np1OUfzFZ9w35s3O/RR1G0e2SePBnTze2elq1B4nIJqfDUeuITluSDW0w2z1wUz7zVPEvqRcR8uoczPb2IDCmKoSqZFlyNZjSwAjNlrnwhPzpEw/YuLCgKZbW9yoyAeNaYOpBwp+kFUYGCMlkzempk2rfdwkTa9H8L++ij8c9kgFUEjCoA3WZmsbQqn7AXKUJWHtiO8mu+lj/uTp6Nn5N9noqfh2Mvob/25ntHv+OH2SPRXPJt/sDEXsHm2wo26pH64hekNkrmpU//WoFi6OC/d74ipkHR1S2qfTxIdHkAWjCAY88t6Ibl3X22Bb9lC3ffXtRpBSWBbptZdLtgmcuidvF2/VvEwsckVVRRA/3amv1PEpDi7b9yX6gWyYk0J+wkR/bfh8EebAAJcBClJMyWa9osrLJdc2+i4LoLf77TMSHHbAbUvE8Y6XlYNTaK4yDKvqW9w3uLg7rAtxzeo4v0HNl1sp8/I1yoO8q02aGIJaW6u54zPeJYHg6bACxwonwq0VTYlXs7o7BdeNeNFAkbaV2cPezqaiwPgG3ZifiYxLU+f4eFHU1vzczfcJS3agEEsMvztI15pdD8eL2lI3IJ1QbZ1WPoG/u5tR8cHT49oT/66J+ZYnWH81FQ+ByM2mHsLKc/IN5GEyfXS3BPArFca5lVI2noBox9J+LRs18XMEPDt1d89/xKo2t1ia5qH+zH1MurrN+jNfVHfmlkvMuNoyEIhy4+Iyv4c6Ml7tmLD6lDPle7F8lNr5VQvH/OO+VIu5RmWYO6/vci0BTQuju+FI1yjxcjeVWu7MgZqrlOcbjPz84M3Tb1nOi2kF7inDp/X4XRd5n4cbAZ+IYvQ/z21KtfMb8WLJaBl0x52fOlT9sOeDy/eeunwfCr08FHr5nRZ6+SMWZwkNRVSlBY56oBwL/uQBEr97hVd+wyIra1nzJgVBb6Giym0XSbnhvrxDuMuKKDdcbXO57qL8CdYl6K1/0rkdaCMwip1X0rrSUi90vdce8VCG5KEMyUMZkp4yJHdTdqQGt3VqtbOUZpxcGnVCfacKPdgabZmhjpRWTwjD2NodaEIJM+p7UbfzqMdxq1MviLAEUn/tj2Gci9mcg2/F1siX81rmpOz9MTsyFHSrMdELK68QaveUHIHpJtLlcwydmWgvwdVrcKu1xTnWFuOY2WcPNiy9QUxHw7sEbZj4DvEgOQ2his+YUA0DDRHaUvt/Q07AaVyq2VCAAeRd0yKBegejQpkRVDEJqh8sgndyQqGeeq8nw95MDr6w6j2WwFlAjY9gfiASn8R8YTNJ4TO2xxIV1GXwgH28qg8acWLcmqU7RFD/hWOvmKJEiAAEKVJ+x3QGD5B4KEYcJLOMw9hDhbcucgpNpzIbmHGjyqbyRDBqXWkkwaQHc0RJGcavHLNlE4nmh69s/iM2hQodKh25UmMjjLMooYaGg+zq3cfsvDL1bgCLMckEelJdHnzgRmRgsX7hPiceBLrDS7RJcmZ7IgXcrvEWcbNeAdVpwWc2gtPfCzdf1xyq72fHSoxP4ljwQF0cog/4IJsMzXKALBjE1qAI2lpgc/AoVLOMkCVgP8hoEhrKMa236mJ4k/hkdHAXYgxMqkOScJW1BAeHEB5PjRsT+Yk4Sg0V7IrpYYgRxDiAXNniTfsFgz0tiQehmoNXyhb4sfgR2wyzhI53D1uTf/J7+OMP4Lb8HgrHyFT8kHhT2cv2sn11Mf+tmRkRH3NYSNdFBRCMFTWzq1GvU0ep/7hrCJG3GLuttFR3PfywgFY2WyepyxI978RPB0QCn9+tIVVOYU26siNid8z8i+6rtxtXdVrBQVvkX8+gtn6AfYViuSowc1FCErVPFYnI2Td22lRx3ARWBVzFemsGy/T0ndfq4m8kfLZVswaKNbUgQkk1ap2Hoy5TKx2+bVkts1Ys49V6JzCt9k8Q9jreTbyCTx32hKumR5CCW0wVxOqUARfZAiQ0z22dzZTrkIahGAsNfQoFf3+oXPRQueihctFDtZmHykX3DKh/Wlz6bSsXfbmluVNm/c9V5OKeVQp6GRzHxiWBAvj98YrzfJ2COyvrYtxhGZ1b8ZJtXB/nz0cCwjo316k582cpM7PBdcAbYR+G3siPqr0wnHVJS305S+GLkj0+wEYEa8fD2WWe7eziTQlVJ6hs7SdUNM6wrNZVBS9zcLNd+NuQmu2/OULqgjl83C8x3HeLa6ebqbO+yGgBOnSBdanJvKrBQBjEQzU7ePBefmk87/2s3tNNUvhdltzRS23E/Cde8GlgYNh4ae75bzbHMVbm//UghypZJvAdbs5oLXagbBVifDKi0AhTIETXXrd9qgWHoNJ1UnQcceAlvt2iRd1w034h40Y5OITA2pUGaiJujGJZyS83C467nUBWMNsWYTgrpZ4RS7jWxgKy+kpMeb6iwMRDzOw9i5n192s/33UcbbCEplLItWNrCan7p+2XHrpvdw681cnZydujPhQrhanKwo6GK4zd2wsSRSPyYjVRGb1u+jrlFKuX3etg4BYZA13atQQru9byXObS9FRchV00izm9qzJP/Ye9wfusd3Xm3fDl3yIgunsWHW8lspaaPIfjd6mTTyPsZe2e6OmdZWd6ROTJzldN1RyUQ+5HymZ87STN+CZpmbeZgfkbpg1ajPKyB/1iIA+pg181dbC3YENNVq2JoaGjwapvIe/wNrIyghI2fs1YCzIq8U0+XfsW5l4rZ8M+1sQgzj4OQ9zDdA341Qsp78vW2H5I1/iK6Ro9ZYPdzWnlwd/GG7ee4KLmssfq7V0ieurMmtvSNhbfcnYH8bPNnGtjdkTG1KZ0BwbjkN053H4reSnQK1YVD7yNHJD1e2oQrNaLuyYNu8e+q+soytpUkUCD7Q8zgi3Xnq/1m/6Xa+pvGG5R7zp9xhReTZKLrXevFW4zUA7HD6MNHXbOjRd6GoBfNq4S8F3cu9wZunK0rAev9n11aT14tR+82g9e7Qev9oNX+wu92qGNiWr79lwQTF/srYLpV6T0y0C6omONg6fH1tSjxQ1LAx1dp/HHxxEmo+wX6QztXR8pC7Dxf/ZZnHpMPquNGastC5s7MH3pru1B7HHO1dWKn1KB4hsXAu6m+L2A94R781rwpeE6dw1zHcrNyu1heMGk0jzvS4+wKTJYuN5v5x5ltmRm8EVo+27xDLKM/OeQm+eRXwKJ7aGH+OOBynweZJm/L5Q/xYqh2PjwOn4lIkD4IpHNEFiU6jwX8/oN7HqxTj4QeeZl2xD1It/MxDb/ySamtAr89pdH3DkdD8co7LF99m8ApHtQvPVuvJfuYSsRe/lieABePggkDf87PVDzRS7RDlY/Mx8z/On4+OCw8xH1TIEv2I9d6aWhRDmb/IYrXpTqQoIEsAUJvSP3Vwr1r6G6/oSGH3vfKAeRkLQ/TwnSDDuejpV5qNaqFqah2jTgjXNMV74B3k0irqHbPFc/+DC7zdfa7FL2vwq/5TMp95i867I9Zq/RnIEHqOlCF8q/JoGNeuDoKNd7CAZh8PLgGA6NkHJc56Y71RM6e5l8C6Vl4FDuK/Fak8uBYqf2ufVVd9raygbReoOxUUZMSMRZ09YatjAXn0xZlDy2+iH6L6Vb9eH8tGlW5n5O3qggM9NymsHczFvLyXwNNvPLFsG3CuLgQcEgS8Ztbj8mg0Mmfyt/f+zSFJN+xKKK+Q0R28fkKXzp1C2/5idsCzXWLCyHW/9ch6ZBSNpKy6on7/4BGUzHCdsIET0ywilKaX0J87QUTJxGGbb1rqFzWEvNyL9GGiJUhOgVtebcpODfGXoOIPYtyDQ31MtwadTk3QFHgG2YoKiO+qeegbcDla6CPYEoMxBlwQWmbNApiG10u5vYNbQhxh29NnR1uXcbPFcTUZOORdtmReIafLMKjt8pjYGkWOo6JPFcQRCrzZGtX5+w5aX54KMSWKe7u4cg7RST0L209cytqbBlvu+axfoi8EpCvI00vgl6IHPGhMucNVqVfch5Q2HI7TmQgjATtgd6AxIPjXA9uYfEZ8p4ppInPhCGiWxbRfgSzhu3BfS6QEjIdiCDfjj7n235nMYmFydtutKMHeoXjcJgq41QYfp+klFPS3Gj9JjJTHDwbkd7n0m93L2Werk5XYzXWIZuXTVrRI7nHK79ojLg0+RzYUCkuOoh1CeFK5OKWngImmfX1Lz/WKBBgwa4VpCWWJG9BSMIu7DpilheaH8hfxRLrLoAe+RTfMrq0L5TZqPFm6RueBqLYhLwJScbgBMtKoQIvUz16OLxIyL9j+x7ZyOKj30EhimZPdLZL5fmUYP/owb/H33uZ5VXYIDBXdETVi13opgru2mwbZXw0tfMmIXee/QoE3M14gs5ltOSF2YsVQTvVYUDvClVVqWGkjl7h1k3wrHhUyC6A901/dxeyGlzGseAlIRL7kwaAZo+xJGEqeg4rXUKBGm/bHBXzH5zRMnxQc6q71K0NDAJxkkYTcPmFUglKIhN5CeXe5LQGhnWFbMJDqbkEot8osVsO2bkYg2G3WO24/dLVZUAjtFHsfzBPgoNF9TKg89VtnzhrkDzftuKp1dWvYPounu3qx1Nt9Mb7EZlL7ohZ73BWKuK23tBMpuVnvfDbFbEbdECN3h5cTiwqQngudnDdbZstqeGdx5YHNDQ68/dFxCbUn3eA4j1RxfUjCGdzec6RNdTfHqiY4Ne6yrc7vS+zBcG/XQf5xtfQN42Xd8PbqpT9wZjA476Ab/606CP3W+yFsdWJUH1zdUUgbE1+QaLlwQI1xQVoc8rCnq0CmgEtQa66fCnA2n6PS2bIgm3OObVmqcTe9y013jYcNi52TPVOvdUZ16cQGYeip+GOWbBEa5P47Klf35flxpAUEyUkwY5hV2JOZfIB2jv/69hxTU3lf/TfAp5uM/+W3uuOzkbBSqMYBaBjC8J/wU25T3Lvj7XtPeBPNAp+ju+Ia3aZvM5ge3NNqzIqFRRGJHNDRXostI2mP//7EtjRpGpg8JpScvBx2uXPQ/XaluhWxvAvjLTo9SagQymCloXuIU0rtYPrItbcWY025pIKBfbCaauXKai0MLDx/0FT2cCHmboHN3l5eWY489jVU4f2b760aujgxf/On4xgj5XjeOtOU4Alqvp5+SrOrk4erzz+On4CQWCLZQ2c1546zlZ4YVr3xpPZ7H9bAFAqfGRvYE8Qyp6Rqm5HNMtjGKTylSlaIdnAyJZFbfOOem8allXQmWlQBMH6bP04ueQQQbNu1jsr04YKzLrfh98BqsdqIBiJjwcTpW5Vr4sZh+vDF9HC6AVTqVcEqa0KSYQyOkp6kbZx7mhnpoqRF+2SvPMuSWEY0wyqt88rz+3SBO1sHkNLTPf8Fvp+u8uv9H5cpvcIezmPLxe/k3zdqa3Y7TAlOZSlR+bfHOwinh+ePgr5DlDgkJbArabawvACRrB5XxekRxOCc8uedwVXwsQqjZsUBUxWNmcrBtWAgKe8GiRc1nAdcL72zDBi8f0su5EkoDpq5U24gFDCVC1DCSbUXDp9gaCJk7jaKa0gak+f4Y3Vk7K/OoKPv9aiRL1YxDzSknV8EADldrm5Npnywfv85YTg7bZwLt+Q656iqixyaSdKFcihjHG0BLIXUilKasUaQBQ3XYi93gI5E7ZLJbN0/RRhELdgE/oKItQ2LAaKYCFGh/Q5keoOTSDdYwxoEdTDyqwtLKtb3B4c/IOJAyVoUAyR7tLVPJLCBbhl9Fe9HP0c4SIYdzzm/gdVEFKhAUhHod1byOF+jaJ0fYPXh3mEDpt1Zv2Av+GnfV2+R5Yyo9i+UPdnH4Z7FCr+9QazgocGP8f0C5E7w==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update credential definition</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/{credentialDefinitionId}"}></MethodEndpoint>



Updates an existing credential definition. The changes apply to future credential issuances that use this definition. This operation replaces the whole `credentialDefinitions` array, so always send every credential configuration that the issuer must keep. Set `credentialDefinitions[].id` to the identifier of an existing configuration to change it, and omit the field to add a new one. The issuer always discards `display.logo.uri` and `display.backgroundImage.uri` from the request body and keeps the stored images; use the update logo image and update cover image operations to change the artwork. `version`, `trustAnchor`, `kid`, `supportRevocation` and `revocationMethod` are immutable after creation, and this operation does not accept them.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential definition that specifies the credential format, type, and claims structure for OID4VCI issuance.","in":"path","name":"credentialDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

New values for the credential definition. Every field is optional except `credentialDefinitions`. When `label` is present, it must contain at least 3 characters.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 3 characters`"} schema={{"type":"string","minLength":3,"description":"Human-readable label describing the intended use of this credential definition (e.g. 'Issue Portable Document A1'). When you supply the field, the value must contain at least 3 characters. The issuer keeps the current label when you omit the field. The labels `Payment User Credential`, `Payment Card Credential`, `Payment Account Credential`, `PID Issuance` and `Photo ID Issuance` are reserved for the platform.","example":"Issue Portable Document A1"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitions"} required={true} schemaName={"object[]"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"array","minItems":1,"description":"Credential configurations of this credential definition, as the complete new list. Set `id` on an entry to change a configuration that the issuer already published. Omit `id` to add a new configuration. Leave an existing configuration out of the array to remove it. Do not supply a configuration field such as `credentialFormat` or `claims` at the top level, because the issuer rejects the request.\n","items":{"allOf":[{"type":"object","description":"One credential configuration inside a credential definition. The issuer publishes each entry as a separate credential configuration in the OID4VCI Credential Issuer Metadata. Every entry must use the same `authorizationRequestType` and the same `scope`.\n","properties":{"label":{"type":"string","description":"Human-readable label describing the intended use of this credential configuration."},"expirationInDays":{"type":"number","description":"Number of days until the issued credential expires. Defaults to 30. The issuer calculates the expiry date from the issuance time."},"supportRevocation":{"type":"boolean","description":"When `true`, enables credential revocation support. Defaults to `false`."},"revocationMethod":{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List specification. `status_list_2021` uses the W3C Status List 2021 specification and is valid only when `credentialFormat` is `jwt_vc_json`. `swiss_token_status_list_v1` uses the Swiss profile of Token Status List. Defaults to `status_list`.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]},"statusListCryptographicKeyFormat":{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]},"statusListCryptographicKeyIdentifier":{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."},"enforceCredentialUniqueness":{"type":"boolean","description":"When `true`, ensures each credential under this configuration is unique per holder. Defaults to `false`."},"supportCredentialReissuance":{"type":"boolean","description":"When `true`, allows holders to request reissuance of expired or near-expiry credentials. Defaults to `false`."},"credentialBindingMethods":{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. You can use `cose_key` only when `credentialFormat` is `mso_mdoc`.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}},"authorizationRequestType":{"type":"string","description":"Determines how the wallet requests authorization during the OID4VCI issuance flow. `authorization_details` uses RFC 9396 Rich Authorization Requests and forbids `scope`. `scope_based` uses OAuth 2.0 scope values and requires `scope`. Defaults to `authorization_details`.","enum":["authorization_details","scope_based"]},"scope":{"type":"string","description":"OAuth 2.0 scope value for this credential configuration. Supply this field only when `authorizationRequestType` is `scope_based`. Read the available values with the list scope operation."},"display":{"type":"object","description":"Display properties for the credential card in wallet UIs. The issuer adds the organisation logo and cover image when you do not supply `logo.uri` and `backgroundImage.uri`.","properties":{"name":{"type":"string","description":"Display name for the credential in wallet UIs."},"description":{"type":"string","description":"Human-readable description of the credential purpose."},"backgroundColor":{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`)."},"textColor":{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`)."},"logo":{"type":"object","description":"Logo image of the credential card.","properties":{"uri":{"type":"string","description":"URL of the logo image."},"altText":{"type":"string","description":"Alternative text for the logo image."}}},"backgroundImage":{"type":"object","description":"Background image of the credential card.","properties":{"uri":{"type":"string","description":"URL of the background image."}}}}},"credentialResponseInterval":{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint."},"credentialFormat":{"type":"string","description":"Credential format of this configuration. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL. The format determines which of `type`, `vct` and `doctype` you must supply.","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]},"validationPath":{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. Use `$.vc` when `credentialFormat` is `jwt_vc_json`, and `$` when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.","enum":["$.vc","$"]},"type":{"type":"array","items":{"type":"string"},"description":"Credential type strings. Required when `credentialFormat` is `jwt_vc_json`, and forbidden for the other formats. These values appear in the `type` field of the issued W3C VC (JWT). You cannot use `WalletUnitAttestation` here."},"vct":{"type":"string","description":"Verifiable Credential Type identifier. Required when `credentialFormat` is `dc+sd-jwt`, and forbidden for the other formats (e.g. `urn:eu.europa.ec.eudi:pid:1`)."},"doctype":{"type":"string","description":"Document type identifier. Required when `credentialFormat` is `mso_mdoc`, and forbidden for the other formats (e.g. `org.iso.18013.5.1.lpid`)."},"credentialDefinitionUri":{"type":"string","description":"URL of an external claims schema. The issuer downloads the claims from this URL. Supply this field instead of `claims` or `credentialDefinition`. Use the preview operation to check the document before you use the URL."},"cryptographicKeyFormat":{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]},"cryptographicKeyIdentifier":{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."},"credentialCategory":{"allOf":[{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}],"nullable":true,"description":"The credential category of this configuration (the list credential categories operation): the eIDAS category of its credentials, with the rules for the certificate of the signing key. `pid` (PID provider certificate), `eaa` (seal with key usage Type A, B or F), `qeaa` (qualified seal), `pub-eaa` (qualified seal with the QcPSB statement) or `none` (no rule). `null` or not sent is `none`. The issuer checks the certificate of the signing key of the configuration (`cryptographicKeyIdentifier`, else the key of the definition) on create and on update, and refuses a key that does not fit with `400` and `errorType` `signing_key_does_not_fit`. A key with a PID certificate signs only the category `pid` (or `none`). An mDL (`mso_mdoc` with doctype `org.iso.18013.5.1.mDL`) also needs a key with the ISO/IEC 18013-5 Document Signer profile, whatever its category. For `qeaa` and `pub-eaa`, the issuer adds the EAA category of ETSI TS 119 472-1 to each issued credential. With `eaa`, `qeaa` or `pub-eaa`, the place of the EAA category is reserved: the issuer refuses a claim with the path `[\"category\"]` (SD-JWT VC), a claim with the path `[\"org.etsi.01947201.010101\", \"category\"]` (mdoc), and the `type` values `urn:etsi:esi:eaa:eu:qualified` and `urn:etsi:esi:eaa:eu:pub` (W3C VC), with `400` and `errorType` `eaa_category_claim_reserved`. Another value than a category id, also `mdl`, gives `400` (`credentialDefinitions.<index>.credentialCategory: must be one of none, pid, eaa, qeaa, pub-eaa`). The issuer accepts `signingKeyCheck` and `suggestedCredentialCategory` of a read answer in the request and does not store them."},"supportAttestationProof":{"type":"boolean","description":"When `true`, the issuer accepts an `attestation` proof (key attestation)."},"supportJwtProof":{"type":"boolean","description":"When `true`, the issuer accepts a `jwt` proof of possession (OpenID4VCI 1.0 `proof_types_supported`)."},"keyAttestationsRequired":{"type":"object","description":"Object specifying key attestation requirements per proof type supported by the Credential Issuer.","properties":{"attestation":{"type":"object","description":"Key attestation requirements for the 'attestation' proof type.","properties":{"key_storage":{"type":"array","description":"Accepted key storage security levels (e.g., ISO/IEC 18045 basic).","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}},"user_authentication":{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}},"jwt":{"type":"object","description":"Key attestation requirements for the 'jwt' proof type.","properties":{"key_storage":{"type":"array","description":"Accepted key storage security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}},"user_authentication":{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}}}},"claims":{"type":"object","description":"Claims of the credential, as claim path pointers. Supply this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc` and you do not supply `credentialDefinitionUri`. Do not supply this field when `credentialFormat` is `jwt_vc_json`; use `credentialDefinition` instead.\n","properties":{"claims":{"type":"array","description":"One claim path pointer for each claim that the issuer publishes.","items":{"type":"object","properties":{"path":{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. When `credentialFormat` is `mso_mdoc`, the first element is the mDoc namespace, the path holds at least two elements, and every path in the configuration uses the same first element.\n","minItems":1,"items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]},"mandatory":{"type":"boolean","description":"When `true`, the issuer always includes the claim. The issuer reads a missing field as `true`."},"limitDisclosure":{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}},"required":["path"],"additionalProperties":true}}},"required":["claims"]},"credentialDefinition":{"type":"object","description":"Claims of the credential, as claim path pointers. Supply this field when `credentialFormat` is `jwt_vc_json` and you do not supply `credentialDefinitionUri`. Each path starts with `credentialSubject`, because the issuer validates the claims below `$.vc`.\n","properties":{"claims":{"type":"array","description":"One claim path pointer for each claim that the issuer publishes.","items":{"type":"object","properties":{"path":{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. The first element is `credentialSubject`.","minItems":1,"items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]},"mandatory":{"type":"boolean","description":"When `true`, the issuer always includes the claim. The issuer reads a missing field as `true`."}},"required":["path"],"additionalProperties":true}}},"required":["claims"]}},"required":["credentialFormat"]},{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an existing credential configuration. Read the value from `credentialDefinitions[].id` of a read or list credential definition response."}}}]}}}></SchemaItem><SchemaItem collapsible={false} name={"enforceWUA"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires the holder to present a valid Wallet Unit Attestation (WUA) during the OID4VCI credential issuance flow, as defined in the EUDI Wallet Architecture Reference Framework."}}></SchemaItem><SchemaItem collapsible={false} name={"supportInteractiveAuthorisationEndpoint"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes an interactive authorisation endpoint for this credential definition."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Default display properties for every credential configuration of this credential definition. The issuer always discards `logo.uri` and `backgroundImage.uri` from this object and keeps the stored values, whether you send them or not. To change the artwork, use the update logo image and update cover image operations.


</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`)."}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image of the credential card. The issuer discards `uri` and keeps the stored image.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image. The issuer ignores this field on update."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card. The issuer discards `uri` and keeps the stored image.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image. The issuer ignores this field on update."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The issuer updated the credential definition and published the new credential configurations in the OID4VCI Credential Issuer Metadata.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential definition record as stored by the issuer. The top level fields hold the settings of the whole record, and `credentialDefinitions` holds one entry for each credential configuration that the issuer publishes in the OID4VCI Credential Issuer Metadata.


</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition. This field holds the same value as `credentialDefinitionId`.","example":"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier assigned to the credential definition upon creation. Use this ID to reference the credential definition in OpenID for Verifiable Credentials Issuance (OID4VCI) operations.","example":"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that holds this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) indicating when this credential definition was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) indicating when this credential definition was last modified.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label describing the intended use of this credential definition (e.g. 'Issue Portable Document A1').","example":"Issue Portable Document A1"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential configurations of this credential definition. The issuer publishes each entry as a separate credential configuration in the OID4VCI Credential Issuer Metadata. The value is `null` for a record that holds no configuration.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of this credential configuration. The issuer generates the value. Use it in the `credentials[].id` field of the issue credential request, and in the `credentialDefinitions[].id` field of an update credential definition request."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialConfigurationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential configuration as published in the OID4VCI Credential Issuer Metadata. The wallet uses this value to request this credential configuration during the issuance flow."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label describing the intended use of this credential configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"expirationInDays"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Number of days until the issued credential expires."}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer supports revocation of credentials from this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationMethod"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`status_list`, `status_list_2021`, `swiss_token_status_list_v1`]"} schema={{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List specification. `status_list_2021` uses the W3C Status List 2021 specification. `swiss_token_status_list_v1` uses the Swiss profile of Token Status List.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]}}></SchemaItem><SchemaItem collapsible={false} name={"statusListCryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"statusListCryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"enforceCredentialUniqueness"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, each credential under this configuration is unique per holder."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialReissuance"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, holders can request reissuance of expired or near-expiry credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. `cose_key` is valid only for the `mso_mdoc` format.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`authorization_details`, `scope_based`]"} schema={{"type":"string","description":"How the wallet requests authorization during the OID4VCI issuance flow. `authorization_details` uses RFC 9396 Rich Authorization Requests. `scope_based` uses OAuth 2.0 scope values.","enum":["authorization_details","scope_based"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value of this credential configuration. The issuer sets this field when `authorizationRequestType` is `scope_based`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display properties for the credential card in wallet UIs.

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties. The issuer always sets `en-GB`, and ignores any locale that you send.","example":"en-GB"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`)."}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card.

</div><SchemaItem collapsible={false} name={"uri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format of this configuration. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL.","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]}}></SchemaItem><SchemaItem collapsible={false} name={"validationPath"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. The value is `$.vc` for `jwt_vc_json`, and `$` for `dc+sd-jwt` and `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential type strings. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. These values appear in the `type` field of the issued W3C VC (JWT)."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type identifier. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` (e.g. `urn:eu.europa.ec.eudi:pid:1`)."}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type identifier. The issuer sets this field when `credentialFormat` is `mso_mdoc` (e.g. `org.iso.18013.5.1.lpid`)."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the external claims schema that the issuer used to build the claims of this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialCategory"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","title":"CredentialCategoryId","description":"The id of a credential category (the list credential categories operation): the eIDAS category of a credential configuration. `none` (no certificate rule), `pid` (person identification data), `eaa` (non-qualified attestation), `qeaa` (qualified attestation) or `pub-eaa` (attestation issued by or for a public sector body).","enum":["none","pid","eaa","qeaa","pub-eaa"],"example":"eaa"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signingKeyCheck</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The check of the signing key of a credential configuration, made at the time of the answer. It covers two rules: the certificate of the key fits the credential category of the configuration, and the key of an mDL (doctype `org.iso.18013.5.1.mDL`) has the ISO/IEC 18013-5 Document Signer profile. The save of a credential definition uses the same check, so the result is the result that a save gives now. The result `does-not-fit` does not stop issuance.

</div><SchemaItem collapsible={false} name={"result"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`fits`, `does-not-fit`, `exempt`, `not-checked`]"} schema={{"type":"string","description":"The result of the check: `fits`, `does-not-fit`, `exempt` or `not-checked`. `fits`: the certificate of the signing key fits the rules. `does-not-fit`: the certificate does not fit a rule, for example because the certificate chain of the key changed after the save. Select another key, or request a certificate with the `presetId` of the category (for an mDL, the preset `mdoc-document-signer`). `exempt`: the certificate does not fit, but the key has an exemption (`trustedListExemption` of the key: the certificate is in a trusted list), so the save does not refuse it. `not-checked`: the category is `none` and the configuration is not an mDL, so no rule applies.","enum":["fits","does-not-fit","exempt","not-checked"],"example":"fits"}}></SchemaItem><SchemaItem collapsible={false} name={"messages"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The texts of the check, one for each rule that the key does not fit, with the fix (the category rule first, then the mDL rule). An empty list for `fits`. For `exempt`, first `Exempt: listed in <list> as <service>`, then the rules. For `not-checked`, an empty list, or an information text when the key has a PID certificate and the configuration does not issue a PID.","example":[],"items":{"type":"string","description":"One text."}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"suggestedCredentialCategory"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`pid`, `null`]"} schema={{"type":"string","nullable":true,"description":"`pid` when `credentialCategory` is `none`, the `vct` or the `doctype` is a PID (`urn:eudi:pid:1`, `urn:eu.europa.ec.eudi:pid:1`, `eu.europa.ec.eudi.pid.1`), and the signing key fits `pid`. Set the category with an update. `null` in all other cases.","enum":["pid",null],"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"supportAttestationProof"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer accepts an `attestation` proof (key attestation)."}}></SchemaItem><SchemaItem collapsible={false} name={"supportJwtProof"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer accepts a `jwt` proof of possession (OpenID4VCI 1.0 `proof_types_supported`)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>keyAttestationsRequired</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Object specifying key attestation requirements per proof type supported by the Credential Issuer.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key attestation requirements for the 'attestation' proof type.

</div><SchemaItem collapsible={false} name={"key_storage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted key storage security levels (e.g., ISO/IEC 18045 basic).","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem><SchemaItem collapsible={false} name={"user_authentication"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwt</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Key attestation requirements for the 'jwt' proof type.

</div><SchemaItem collapsible={false} name={"key_storage"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted key storage security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem><SchemaItem collapsible={false} name={"user_authentication"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`iso_18045_basic`, `iso_18045_enhanced-basic`, `iso_18045_moderate`, `iso_18045_high`]"} schema={{"type":"array","description":"Accepted user authentication security levels.","items":{"type":"string","enum":["iso_18045_basic","iso_18045_enhanced-basic","iso_18045_moderate","iso_18045_high"],"example":"iso_18045_basic"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. For `mso_mdoc`, the first element is the mDoc namespace.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><SchemaItem collapsible={false} name={"limitDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. Each path starts with `credentialSubject`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. The first element is `credentialSubject`.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the OpenID for Verifiable Credential Issuance (OID4VCI) specification that the issuer uses for the issuance flow. `version_01` is OpenID4VCI 1.0. A record that you created with an earlier version of this API can hold another value. The issuer sets the value at creation time and never changes it.","example":"version_01"}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key: `did:key` or `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier (`kid`) of the signing key. You cannot change the value after you create the credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"enforceWUA"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer requires the holder to present a valid Wallet Unit Attestation (WUA) during the OID4VCI issuance flow."}}></SchemaItem><SchemaItem collapsible={false} name={"supportInteractiveAuthorisationEndpoint"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes an interactive authorisation endpoint for this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the platform manages this credential definition. You cannot change or delete a system managed credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"extensionEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, an extension supplies the credential data for this credential definition."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>display</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Display properties of the credential, as published in the OID4VCI Credential Issuer Metadata. Wallets use these values to draw the credential card.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name for the credential shown in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata.","example":"Legal Person Identification Data"}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties. The issuer always sets `en-GB`, and ignores any locale that you send.","example":"en-GB"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the credential purpose."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for the credential card background (e.g. `#FFFFFF`).","example":"#FFFFFF"}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hex color code for text on the credential card (e.g. `#000000`).","example":"#000000"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo image shown on the credential card. The issuer sets the organisation logo when you do not supply a URI. The issuer always returns the object, and `uri` is empty when the credential definition holds no logo.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alternative text for the logo image. Wallets use this text for accessibility."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image of the credential card. The issuer sets the organisation cover image when you do not supply a URI. The issuer always returns the object, and `uri` is empty when the credential definition holds no background image.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the background image."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"expirationInDays"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Number of days until the issued credential expires.","example":30}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer supports revocation of credentials from this credential definition."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationMethod"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`status_list`, `status_list_2021`, `swiss_token_status_list_v1`]"} schema={{"type":"string","description":"Method used for credential revocation. `status_list` uses the IETF Token Status List, `status_list_2021` uses the W3C Status List 2021, `swiss_token_status_list_v1` uses the Swiss profile.","enum":["status_list","status_list_2021","swiss_token_status_list_v1"]}}></SchemaItem><SchemaItem collapsible={false} name={"enforceCredentialUniqueness"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, each credential issued under this definition is unique per holder."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialReissuance"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, holders can request reissuance of expired or near-expiry credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. `cose_key` is valid only for the `mso_mdoc` format. The value is `null` when the record holds no binding method.","items":{"type":"string","enum":["did:key","jwk","cose_key"]}}}></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`jwt_vc_json`, `dc+sd-jwt`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format identifier as defined in OID4VCI. Supported formats: `jwt_vc_json` (W3C VC JWT), `dc+sd-jwt` (IETF SD-JWT VC), `mso_mdoc` (ISO 18013-5 mDoc/mDL).","enum":["jwt_vc_json","dc+sd-jwt","mso_mdoc"]}}></SchemaItem><SchemaItem collapsible={false} name={"validationPath"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath expression that selects the part of the credential payload that the issuer validates against the claims. The value is `$.vc` for `jwt_vc_json`, and `$` for `dc+sd-jwt` and `mso_mdoc`."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Credential type strings as defined in the OID4VCI specification. These values appear in the `type` field of the issued W3C VC (JWT). The issuer omits this field when the record uses another credential format."}}></SchemaItem><SchemaItem collapsible={false} name={"vct"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Verifiable Credential Type identifier used when `credentialFormat` is `dc+sd-jwt`. Included in the `vct` claim of the issued IETF SD-JWT VC.","example":"urn:eu.europa.ec.eudi:pid:1"}}></SchemaItem><SchemaItem collapsible={false} name={"doctype"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Document type identifier used when `credentialFormat` is `mso_mdoc`. Identifies the credential in the ISO 18013-5 mDoc/mDL format (e.g. `org.iso.18013.5.1.lpid`).","example":"eu.europa.ec.eudi.pid.1"}}></SchemaItem><SchemaItem collapsible={false} name={"namespace"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Namespace identifier for ISO 18013-5 mDoc/mDL credentials. The value is empty for an OpenID4VCI 1.0 credential definition, because the mDoc namespace is the first element of each claim path."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the external claims schema that the issuer used to build the claims of this record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `dc+sd-jwt` or `mso_mdoc`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim in the credential payload. Each element is a string for an object key, an integer for an array index, or `null` for every element of an array. For `mso_mdoc`, the first element is the mDoc namespace.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["address","country"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><SchemaItem collapsible={false} name={"limitDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the holder can disclose the claim selectively."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims of the credential, as claim path pointers. The issuer sets this field when `credentialFormat` is `jwt_vc_json`. Each path starts with `credentialSubject`.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

One claim path pointer for each claim that the issuer publishes.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"path"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Claim path pointer that selects the claim below `$.vc`. The first element is `credentialSubject`.","items":{"description":"Object key, array index, or `null` for every element of an array."},"example":["credentialSubject","identifier"]}}></SchemaItem><SchemaItem collapsible={false} name={"mandatory"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer always includes the claim."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialDefinition\": {\n    \"id\": \"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60\",\n    \"credentialDefinitionId\": \"9f1c2a34-5b6d-4e7f-8a90-1b2c3d4e5f60\",\n    \"openIdOrganisationId\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"label\": \"Issue Portable Document A1\",\n    \"credentialDefinitions\": [\n      {\n        \"id\": \"string\",\n        \"credentialConfigurationId\": \"string\",\n        \"label\": \"string\",\n        \"expirationInDays\": 0,\n        \"supportRevocation\": true,\n        \"revocationMethod\": \"status_list\",\n        \"statusListCryptographicKeyFormat\": \"did:key\",\n        \"statusListCryptographicKeyIdentifier\": \"string\",\n        \"enforceCredentialUniqueness\": true,\n        \"supportCredentialReissuance\": true,\n        \"credentialBindingMethods\": [\n          \"did:key\"\n        ],\n        \"authorizationRequestType\": \"authorization_details\",\n        \"scope\": \"string\",\n        \"display\": {\n          \"name\": \"string\",\n          \"locale\": \"en-GB\",\n          \"description\": \"string\",\n          \"backgroundColor\": \"string\",\n          \"textColor\": \"string\",\n          \"logo\": {\n            \"uri\": \"string\",\n            \"altText\": \"string\"\n          },\n          \"backgroundImage\": {\n            \"uri\": \"string\"\n          }\n        },\n        \"credentialResponseInterval\": 0,\n        \"credentialFormat\": \"jwt_vc_json\",\n        \"validationPath\": \"string\",\n        \"type\": [\n          \"string\"\n        ],\n        \"vct\": \"string\",\n        \"doctype\": \"string\",\n        \"credentialDefinitionUri\": \"string\",\n        \"cryptographicKeyFormat\": \"did:key\",\n        \"cryptographicKeyIdentifier\": \"string\",\n        \"credentialCategory\": \"eaa\",\n        \"signingKeyCheck\": {\n          \"result\": \"fits\",\n          \"messages\": []\n        },\n        \"suggestedCredentialCategory\": null,\n        \"supportAttestationProof\": true,\n        \"supportJwtProof\": true,\n        \"keyAttestationsRequired\": {\n          \"attestation\": {\n            \"key_storage\": [\n              \"iso_18045_basic\"\n            ],\n            \"user_authentication\": [\n              \"iso_18045_basic\"\n            ]\n          },\n          \"jwt\": {\n            \"key_storage\": [\n              \"iso_18045_basic\"\n            ],\n            \"user_authentication\": [\n              \"iso_18045_basic\"\n            ]\n          }\n        },\n        \"claims\": {\n          \"claims\": [\n            {\n              \"path\": [\n                \"address\",\n                \"country\"\n              ],\n              \"mandatory\": true,\n              \"limitDisclosure\": true\n            }\n          ]\n        },\n        \"credentialDefinition\": {\n          \"claims\": [\n            {\n              \"path\": [\n                \"credentialSubject\",\n                \"identifier\"\n              ],\n              \"mandatory\": true\n            }\n          ]\n        }\n      }\n    ],\n    \"version\": \"version_01\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"enforceWUA\": true,\n    \"supportInteractiveAuthorisationEndpoint\": true,\n    \"systemManaged\": true,\n    \"extensionEnabled\": true,\n    \"display\": {\n      \"name\": \"Legal Person Identification Data\",\n      \"locale\": \"en-GB\",\n      \"description\": \"string\",\n      \"backgroundColor\": \"#FFFFFF\",\n      \"textColor\": \"#000000\",\n      \"logo\": {\n        \"uri\": \"string\",\n        \"altText\": \"string\"\n      },\n      \"backgroundImage\": {\n        \"uri\": \"string\"\n      }\n    },\n    \"expirationInDays\": 30,\n    \"supportRevocation\": true,\n    \"revocationMethod\": \"status_list\",\n    \"enforceCredentialUniqueness\": true,\n    \"supportCredentialReissuance\": true,\n    \"credentialBindingMethods\": [\n      \"did:key\"\n    ],\n    \"credentialFormat\": \"jwt_vc_json\",\n    \"validationPath\": \"string\",\n    \"type\": [\n      \"string\"\n    ],\n    \"vct\": \"urn:eu.europa.ec.eudi:pid:1\",\n    \"doctype\": \"eu.europa.ec.eudi.pid.1\",\n    \"namespace\": \"string\",\n    \"credentialDefinitionUri\": \"string\",\n    \"claims\": {\n      \"claims\": [\n        {\n          \"path\": [\n            \"address\",\n            \"country\"\n          ],\n          \"mandatory\": true,\n          \"limitDisclosure\": true\n        }\n      ]\n    },\n    \"credentialDefinition\": {\n      \"claims\": [\n        {\n          \"path\": [\n            \"credentialSubject\",\n            \"identifier\"\n          ],\n          \"mandatory\": true\n        }\n      ]\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is invalid. The issuer returns this status when no credential definition matches `credentialDefinitionId`, when the request body is not valid JSON, when `label` is shorter than 3 characters or uses a reserved platform value, when `credentialBindingMethods` holds `cose_key` for a credential format other than `mso_mdoc`, when a configuration field is present both at the top level and in a `credentialDefinitions` entry, when `credentialCategory` is not a category id, when an entry with the category `eaa`, `qeaa` or `pub-eaa` has a claim at the place of the EAA category of ETSI TS 119 472-1 (`errorType` `eaa_category_claim_reserved`), or when the claims fail validation. When the certificate of the signing key of an entry does not fit its `credentialCategory`, or the key of an mDL entry has no ISO/IEC 18013-5 Document Signer profile, the answer has `errorType` `signing_key_does_not_fit` and `errorField` `credentialDefinitions[<index>].cryptographicKeyIdentifier`, `errorMessages` has the texts of the rules that the key does not fit (with the fix), and `errorDescription` has the field and the first text. The stored credential definition does not change.


</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The field and the problem. With `errorType`, the field, then the first text of `errorMessages`.","example":"credentialDefinitions[0].cryptographicKeyIdentifier: A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider)."}}></SchemaItem><SchemaItem collapsible={false} name={"errorType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signing_key_does_not_fit`, `eaa_category_claim_reserved`]"} schema={{"type":"string","description":"`signing_key_does_not_fit`: the certificate of the signing key of a configuration does not fit the credential category of the configuration, or the key of an mDL has no ISO/IEC 18013-5 Document Signer profile. `eaa_category_claim_reserved`: a configuration with the category `eaa`, `qeaa` or `pub-eaa` has a claim at the place of the EAA category of ETSI TS 119 472-1 (the issuer adds the category). Other errors have no `errorType`.","enum":["signing_key_does_not_fit","eaa_category_claim_reserved"],"example":"signing_key_does_not_fit"}}></SchemaItem><SchemaItem collapsible={false} name={"errorField"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The field of the error, with the position of the configuration in the request. `credentialDefinitions[<index>].cryptographicKeyIdentifier` for `signing_key_does_not_fit`. `credentialDefinitions[<index>].claims`, or `credentialDefinitions[<index>].type` for a W3C VC, for `eaa_category_claim_reserved`.","example":"credentialDefinitions[0].cryptographicKeyIdentifier"}}></SchemaItem><SchemaItem collapsible={false} name={"errorMessages"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"All the texts of the refusal, one for each rule that does not fit, with the fix (the category rule first, then the mDL rule). Only with `errorType`. For `signing_key_does_not_fit` they are the same as `signingKeyCheck.messages` of the configuration and `certificateAssessment.categoryMessages` (or `mdlConfigurationMessages`) of the key.","items":{"type":"string"},"example":["A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider)."]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"credentialDefinitions[0].cryptographicKeyIdentifier: A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider).\",\n  \"errorType\": \"signing_key_does_not_fit\",\n  \"errorField\": \"credentialDefinitions[0].cryptographicKeyIdentifier\",\n  \"errorMessages\": [\n    \"A QEAA needs a qualified seal certificate. This key has an EAA certificate (no QcCompliance statement, no QcSSCD statement, no QcType eseal). Request a certificate with the preset QEAA provider (qeaa-provider).\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Issue deferred credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history

---
id: config-update-digital-wallet-open-id-credential-history
title: "Issue deferred credential"
description: "Updates a credential exchange record. Used to issue a credential via the OID4VCI Deferred Credential Endpoint by providing the credential claims for a pending issuance."
sidebar_label: "Issue deferred credential"
hide_title: true
hide_table_of_contents: true
api: eJzlPO1yG7mRr4KaP5EqJPVhyx+sXC5aSbvRrh2rLNmuq41LA840SVgzwATAUGZcepvcK+QF9sWuugHMNyXacu7qKvmRlYcAutHd6G/gS5SCSbQorFAymkbvipRbMIyzREMK0gqeMficLLlcANOQKJ1O2DsDKbOKCWNKaI9dCc7sEtib89On70/O2SnMQWtI2Uk95kymhRLSstmaFVqtRCrkgmY1FkoyLnLD5kozzgqQNAYBcpnAJBpFqgDNEe3zNJpGiZJzsXDon4qFsDz7wLMM7JsC5HlaQ/+zMFbpdTSKCq55Dha0iaa/fukSQoq/lcAEzZoL0EzNuyh26MKs5skNosmZEXKR1VRoTApbYJmYQ7JOMtqMQJgFt8toFEmeA+6omnPm4Zyn0SjS8LdSaEijqdUljCKTLCHn0fRLZNcFzjNWC7mI7u4+usFg7A8qXeOI7tz2lk8GiY97DuRPAzMrPrCrJbC4RjVmcwEZDmA5lylHUjMuU5aXxjKpLJsB45JBXtg1U7NPkFi3CMmSZhp4aphUTNklaL/aXKucEJmpdI3kSpS0IC3uiRdFJhIShL1PBjfypUETLtdv5sReTx0HMhpFVtgMP5zCnJeZZTs8yxw4s9si868NTkQf70ablzo/u/qRXZ6Of/5wxd6ffOsil2/YwYv9gyfjI5afqmQvP331jUt9eHLC3p+wnZ8/XN27pY93owg+87zIwCDRLs5P2Zh1djP9Eq14VgL+0Zg9/RIJPH9/EOkfkTEkOET5NNVg6M9EldLqdTSNLs+iUZSphGfC0r+tSm6WKssJvYWTw+qjYdlv/5DRCEUawF5XS0aXK+Cr3/6xAMmeHkV3o2gmtF3i2Y+m0cHLl/vj/afjg8NoFEHORRZNI9DiZvJJLbk0Rsk/+e1ODESjaM5zka2v/bn7OQyKRtFCrECGH860uMGjaq7VCvT1wYtwjMKXw4Pul2dH4UuxVBKuZZnPQEfT6PdPnz3fPzh88vTo2fPo7u7ubhSoPsT+r6U9lBMotSr4BJIJlKmYFCKdHBBbFtBFv/pU4199qjdAFL6uSXw4PjgY7x81SJxxbSZcpqAfIvFxGNQl8SuuTbSRWC9fPH9GgmJILTflwSq94JZLdvCiOSJxYvaaZ/lv/2z90BbJ6ruxboOXN7/9t4Qgf42fURC7AO+aDGwdui0ZV/1yWbozvO35+em3f1qYKb1onp/3v/3DWM0Z/sgzLtPN5+h4BXIt2cFh/wy9OBrvvxwfPmkwmEvJJ5mQ6Qz04j7+vvJjuuw9lpJ/1xOEEnH09Ik/QWc/fHjzPVRXbfSJ5EdHz54/e3LwnGiRwYJnf3Hb+WG9WLDjH3rQv8cRVnoxEUZNaKHJkTu834JYE7PvJZvfhAehosEUShpnZw739/E/G72QpXPVWEleXcpMmSRgzLzMsvXXOAGFRl/RCgc16bmC074J3YhTz+dbcuscP8OUrD2+tofknRue3fK1YRpsqaVhsAK99i4OfE6gsCy2mkvDEwR8yi2PJ+zYjyBIS07OETEOnSy3FKTsVtglE9Z4z4oGTFn81+ivUeydaOcYjli8H764wzRi8ZxnBsLXmVIZcEluWyzLLPM/SO+vMfcPrjUnZ6xNXhSeri/apef5V3jVSEBhPA2WKksNTTA8B08Gblh8MuAsx4ic11LRNHrCD+b7ybPD8Yv5Sz5+yg+ej1/yp3x8ON+fHyQv02f84ADV4NBSD2+pHy8E53nz1kZ1xIADUa7rqAAps00c8W2bHAwuHtzkCc8hGyfcAOOZ4AZx3EB6EnsDegWaGbCGzZRdev8aQ8c2DymkZLZmtJBMwi0T0sLCRXnm2zaKZloKUwWKXy+azRXcIaTTbDrMnRA0CjbfPBomBa2n7JYiWJZCkal1DtI6+IVWqAcJBWEqqSIMUm758UID4PBvA45LMB7WcCAXaIylB9jWbVXA5zTP7RIkLVMFuqXpJhRSmAspiKBCGgs8ddLehlzvx1otZqWF9ygrprEn0kG9LVXjnXAZZkq0D5B6BdfZ4IybXkhbbcorwK/bFUX0FnIzZFra6tJ5Rg8xCe1pmz1hiyNUfwQZ6NT0GUhkrCz9/XCIwMOAvD4ThpQwaFo2E7mwkJ4Kk2TKlLoJwpuRHowPSMoYfbp4VJEUNMv5TZDoGqiBDBIrVpCtWeqg8BmmTJwzUQe0RMewz4/4qzDH5C5AugVS5zJF/wEMcpoyD4iZ2ynDU40Jr7YyV/O5p4IwV+oG5PcCl+CpT1tZNFq/zptVrGgd/SCar1W6BavPgyDnKiVpTgeWZfG5vBI5xCwHLrsqj91ypwxQ9PIcUsEtMqqbAxxI/U1YHDKDG9YWpko7hfXuyyWSdZBljrIQjSKHdjSKwhzMlETCXGg4Lu1SabEdowaFNZz/No8uNIz92n9HHJGsP2bqdsLcIs7HcquEcc6oVEOJoLjwpG2j36CoPczSq2Ga02z27u05M6TPVVPYrGLGcm3bm5sj3i17i2dApOMapzHJ/3Rv7z/rb9f07brU4j+W1hZmurfHCzERC82lnQi1N5kM7SzwcAsHpHP8GIQj4XWW35UznC3f24D0rmOPNEQRYdi7t6/oDLgZY1LmFHjUvlYL+UvLbWmGsG5IohdiCtB5uo4+dvd04aw5CrqhBfs+8YTFfpnNh2UGuEKhoeAa0gmLCVwYL9BrYXzFRYb6s3JOaynQYLWAlduj2WZnjtkoU9U/NCQgVoB5aosq69pph1YcOfiNJzf9TxgRdb+mkIH7GJhynYIUeMC7hH1VudKb6Fo75N5yhtNTaGVVojI6CFMW11uN2U5PfsKxcsTcHYXxgRox2/F0NgmXaEoUJrrdj87HxPE4sUm1mO1USfEMyEnBsIusDKOBOKNH2JjtdMIESEmFDmjNzgLEhRpbntxIdZtBuoDU4Vv0ZzgmNSe5Lw0yd+Z4FtZT/IfOjA5/a2q4f1eHcrcyfqAvXfruq9ycwPPYLeFSgDGrqkMtLUJenyBuz4RMB5T5W1dyqZRKy0Rzb3toqB+5Jc40zEe8AXOEzA4n+5tQoNzEEkIcYYI3KFJyKB6NwPmp90x6EGul2zE4A/C38FW+Hg66xRg+LyTJrpvm6009TqAB/gYqdLEIeR2rFs6po6QMDmhBY4lKB8ThZCu3reZ5f81w2INy3+BlEOii6QhtBxodHF7NGYT4oC9EuyYNgUeXmPow4ONqglN7NeE9r+lUWsUKlWVbV5+dMVcpnCzxeMjFNiT45eTMbTwJkwZPWbAng+eyG7K9/fGEPX/25Fkfoddgl2qLGH4IrZzmjog13o1j8eXh0bOY4GhIhYbEvtPi4fXf+sHkRHb3i3UHY0FvKXhJJrbMTJzQyIESvOP674zHYMTsuhAYNa0ZZ6fnp2he3719NWEX1FwAKUtLHbJs7ZDKs8SlGrZJXZ5CAtJqnpFg95MnXhUQkVD7DKaJSgP6Qmwh+Vd1Ntjxd8d+vsY/dita33vUEg3owB43dSzl1EAPZTA/MytyMJbnBdsRkhlIlEzNbkh/NMxZyH9jxOKhtAKGg+dH++5/uF+XwP8Xo5FxYzGaRX6kzmpnArV+aBRhRmmLafpGpnEI6WeEdPAvTtt24RF4w2AfyJIXLr/QC78bGfDHbeVfkabp5QmrpI3ZlLUJWtEbjc6haNegulkznqaUWuPZRSN/NtTGctWmc8HXmeKpj48c6Ak7UdJyIQ2LEVDsah29WpcrfDSrZvgh53aEKiZeJTbei1OVNNegCp6b2C5Dsr3ByqBf0XgVFDj0mhcFaoRHkeIy8IHVC7PcrTyEYU0AM2FnPFky1HVrnEK5Ttwbwy4lav6yprmsAWuFXHRY+YrPIHtYz9GwgfiskShWejAx3UpIkyPQweC0WuLbsuHD2Hwt7K3MLOYfMA8uGXy2oCU2Yn019EIDeiCkJR6zd86aKzWhh7QrSVC6ljwXSRNR72330fmaUlOfES10KhVpMHWiJMuEvHFNifwenAgl5z70K8+vwXInYjNV2i7zQy54hnpj2KWo06ZX/aBAyWxNo2NMVfs+OTcy9S1oLqqYwVxpaLq3lKBzOhfzEVSWeCcxNpdU4/weFYY+vR3wQecqFabI+Jrh0kyDURkmMqhLzzuFzstDJ5RI2s4letyHc/gfWyfoR1KOX5UYdPq0k9Guqzvxp1t7vUqusU0gRlI21fuExWnye5OOP91a+rGtICcszo26zlOVuF8H9PmEvSWrXblF2OUKXGeiTuQYlmAmJzMuZ0Tkxr6JZB0qVvGqQmPE4lVR4URGxm0h7uS8qyn4d1H/nTa+NzZf/SsaRWFXmESr+VRPxJRgWRRK27ewUq7R4pvKHLqaThVDiW5BHTcMOwb1nM0J1440lFqj+DWguRTglMVvgguFzao7K56JFLNNuC+X/CpA51yCtNmaCUkDkI046LI0mIelYRbyQmmuRWfY/UXRYX2eKjDUHOuJ3EC8w+MG9tEo8khHo6jCzJ0fOn3HxqAWUFvEGXVWwR9cHuYylPwixFGz9VAARvwLE0u7xA0G7PvYXBEmD0Y+66JKM/VwoixAJ7QttZwKsPMpJe7MVCEmUzd1XE0dI9Tpp1s7ngHXoOMhDN+DphjikYW835lhamKssvIgCLyj4jsp7LG1GD9sxzTX385wHmtMZDsf3h3vtlxgZzm7/BuxBLGar4Md89zEkjz5FMKwBchSSNiM5oW62CZzpNQcuXmhTDDY4cxv2MVmiI/mzia63cOX93i8qeXyodYD/Io79bQsEcjKz/bxnGGJiz7oqkADAdTtRSBVUZPKIdVSZPd2GNwXILR9Az4obxu64D40ttREewN6nbYwc/a5cIb+G9nWBIltcODW89n/oAq/1+ozAElq+KYC8WjB45uF7Y5cZaXmb+b1GXmYJRfbS8v3ZseQoPbZ8miaDYEZoF1lf79XjgmGTzCBDrAmvvO3VrVbJrSpN86VJhpq2uW20Q8deZeT0gzoWO4G16hfS0nk/HFJghO8OYUuMyUZKcTfiRM5j3ebeqpl1opylomE3cCa/fzhF1Ll+DdWxEIK4JPdIuBFa+jysI3wYyf+ZEW8O0LKb2ip7PmJjnY+4FRqvq1J2uzcdCvCjQCjSuOnkCuJrfaY+CAK1EJa4/L1/o6T+Qovj0kfA7YDk4WLaOLdGuCjz5yPXMMR6/A+HMiB/aaAuen0wwP+zDcI6albucrmdSsBm2x6J5TwhcctHGLXgHmipMS6R1WANEvsruiISiMV0OmgqUH6DfxrqbAB6yYe38+33USinhtVJdKpbv8WuNnGu/1zmXM5xiYWSh1rmsZul+umiPpWgE2p9WbWx9ulk7auHmom7fpV4ULlRl+v0LASqjQYCQ5rJhO691fQMpA9pLbBZwvB2YyrP6IBi4FMucvbde4hPDIl3yhjUYZtpkqZVi0SgV9DvaxOyp6+v2C2uwgmSSXpHndFQLgUGSXaGlcmGuKSAV+BYZjdIzMv2hcqOtnbt/6uyplM9Lp4vA6r16mbS8xAOdVlT3s19Zb+d5g90KvsV+TmprpHnXGBbq2f3nMLebbYxmqfkfLPueQLX/vJFkoLu8w7QfnZyemfx2eXLsoGmWy3uL/Yw6Am2CYAxweHL346ee0AfLq9eRyHLpxf8/Plm7+wDzBjv8C6J0Oh18Aj1zfNgbZ3d1Vb0pUujb0EvRIJ+Jq0fuyJwvvUxi0ZXAUdqqGtWvSok6HFXyxNx5JiIyP+f4RlSEY8iCV6lyuRljz7tgJCPR8xEIVwRaR+UzeZMN9SRJCxZAZ6G6ivaWTTZ8XCxMDzBip0njarPW0MsfQ7rJHOpQW9ahVKN4U6r4UUeZlTawwVQP3UdtDT1TUP9s1g9MJtqbFtKi8eUU7maYqlxZUwAs18tS5zoZmPd7xZTVVSVlcaqqEnSulUyHaZfjg9c6GMryY6keiCU/4ChYfDCr6AEaM7rGib5qrUrBCfIWNJBXQwFxPYgcIj5Ln79SlK0ufwD+LsurBqoXmxFMkvsK5ldkjSULujLzR81lBX9VtlboIGE8Z3rCvadEdteTlrY7O59nI/Jm5ek8Q+POro7lSk0xtYx1RL/3y0/zLeWD69lLwwS2UfG+kW6/vLul7VY2qgqUR973enXCUw8T54W3DD/brebbQNF8b6t7iG70G17rj0r6F0boT0rz/0rxhsbs0f6Huv2sTb3bf3dbkOt572GkI3tmcOtUwO9TL2mwy7rX7DnXbtvrhGs5rrDqs7t5qtVc3+pqFem1Zry1CPR79hYmMDw+bugnsq/xur8FUtfKDkOlTxG6jF9YtNwwWfzUWWTfWPewoOD1UGBlP3/TydS565XFVIHDWTNt18ygMJjjq90Iv6++H3hrB4c5w6GCw+EK7c63/e6/Z1vK2GC3SvP9JzDIbNNN3Pa+tx8paXwFN6jukL/uupex5g62v+Td0MWivtVQH9fdqwBB8fapmoZw85WFWB/Ck11/WWH7o1U9XUf+AY2halrWPA8ExDP0cc+tYxuHUl5sHWEgqi/R0XCv6kCj52zm2yxH6CIYMUj9zw1vtN+HKTcNeR0Fhj+XpUh5RV340Lg7CdJdwQFM0LhZS57s/CO0j3tOew26UyEHp5Wg0/whXI12Dr5BL7L1VSJwWF/E4JM956maFGs75u2EIUnbeu2B38G4vdO8mrZuIeaY7+rU8kaTkM0/yzBgSmQyOMSyApNdWKf/0SHRfiF8A/P+JzbJYv8K25yD9QF7LWOyHJdYLPdJ3T4UaS5L79PypKogg+DzeN9laHe+61u73UrTN21m7P3dHcM+mnW7tXn649/47K3pchJXCHOpo2NPQM3inkyu8X/RyNzwCFq51Y/hi37ndG+BpZr86Sli5pt2GZh1a4tHxBlyOHpxv3cxeRjzUjLlEenRgFdtRhovvgH+BznKyf4GvdY+jX+i/OKb7qtLyQhm5dk4pb68TMgXFP4s2osXEuPoc3XGKHI4vZjlQWfCKEC4reTcET2B0xV/dpLTtlfuIf1qrUSI7xDaz/GLu4Bc/m2/oxwLMg/d2nf4ae+7lrvEvkklpyroIe4O5FoPBElPcZ/1RzoiKm+Kn+1GZhk/sdGleTQvaI+pAVIm+BCfxvXtmI9uMZGGs6d4sKCA23iVV333d8wmOXei+GJ140zVB1VC92q0uixuefUR5cR5vxj4Y4zpjqqcwRJbtGBIysGLbHO1XQaL1mZbgMLFOuUzOm/QqOF/8zdWucnIRWsW6H+qjTs+igDXaeNwxw1YSOAUwC0kDdOhodFzxZAraH9Vh3e3s74fTzROnFnp9r9l6dn5z95fJsjHPu6hcJa3YisUKaJRwv1EGO7Yf7h08nTyb0gkuhjM25bOBDGrJ+jLIdXbXVfmWq/j+9bOp1k4XPdo8y9nRnSNMBdUbg12h16F7AmgtKQrYMgc8rUMBKxqAbgi6rN1Cng4mKjxgb4MXMX6MvX/B5lHc6u7vDz38rQZM5w5YLLVwSCK2GoBseaTSlZw7u4cPOW+8U7LL/5TdWB8ka7IBcV6+HTLHR8gbNxHAah97L9KYC9+6Gnrgdjn3kGJbqOUho4NwMd63x3rFNJ+Di3VU0imb+KdecfKFI81uMyvltNI3wrS9iPSkd8r/w+5co43JRcrzfGLll7/zd07YhvCFD6P9oPJnapk3XJrq94P83niJtT/kDHvZfYP3Harj7ZeOEyg670cipj3d3d/8DzKRQag==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Issue deferred credential</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/history/{credentialExchangeId}"}></MethodEndpoint>



Updates a credential exchange record. Used to issue a credential via the OID4VCI Deferred Credential Endpoint by providing the credential claims for a pending issuance.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential exchange record tracking a single OID4VCI credential issuance lifecycle.","in":"path","name":"credentialExchangeId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Credential claims for the pending deferred issuance. The `credential` field is mandatory and must not be an empty object. The issuer reads no other field from the body.

</div></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"Default (all fields)"} value={"0-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Updated credential object for the OID4VCI Deferred Credential Endpoint. Use `credentialSubject` for W3C VC (JWT) format, or `claims` for IETF SD-JWT VC and ISO 18013-5 mDoc/mDL formats.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"properties":{"credentialSubject":{"type":"object","additionalProperties":true},"claims":{"type":"object","additionalProperties":true}},"description":"Updated credential object for the OID4VCI Deferred Credential Endpoint. Use `credentialSubject` for W3C VC (JWT) format, or `claims` for IETF SD-JWT VC and ISO 18013-5 mDoc/mDL formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"IETF SD-JWT VC"} value={"1-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential object for deferred issuance in IETF SD-JWT VC (`dc+sd-jwt`) format. Contains the `id` from the `credentialDefinitions` array and `claims` as flat key-value pairs.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Flat key-value pairs representing the credential claims for IETF SD-JWT VC format. Keys are claim names (e.g. `given_name`, `birthdate`), values are the claim data.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Flat key-value pairs representing the credential claims for IETF SD-JWT VC format. Keys are claim names (e.g. `given_name`, `birthdate`), values are the claim data."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."},"claims":{"type":"object","additionalProperties":true,"description":"Flat key-value pairs representing the credential claims for IETF SD-JWT VC format. Keys are claim names (e.g. `given_name`, `birthdate`), values are the claim data."}},"description":"Credential object for deferred issuance in IETF SD-JWT VC (`dc+sd-jwt`) format. Contains the `id` from the `credentialDefinitions` array and `claims` as flat key-value pairs."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"ISO 18013-5 mDoc/mDL"} value={"2-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential object for deferred issuance in ISO 18013-5 mDoc/mDL (`mso_mdoc`) format. Contains the `id` from the `credentialDefinitions` array and `claims` namespaced under the doctype.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>claims</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Claims namespaced under the ISO 18013-5 mDoc/mDL doctype (e.g. `eu.europa.ec.eudi.pid.1`). The top-level key is the doctype namespace containing the data elements as key-value pairs.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Claims namespaced under the ISO 18013-5 mDoc/mDL doctype (e.g. `eu.europa.ec.eudi.pid.1`). The top-level key is the doctype namespace containing the data elements as key-value pairs."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."},"claims":{"type":"object","additionalProperties":true,"description":"Claims namespaced under the ISO 18013-5 mDoc/mDL doctype (e.g. `eu.europa.ec.eudi.pid.1`). The top-level key is the doctype namespace containing the data elements as key-value pairs."}},"description":"Credential object for deferred issuance in ISO 18013-5 mDoc/mDL (`mso_mdoc`) format. Contains the `id` from the `credentialDefinitions` array and `claims` namespaced under the doctype."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"W3C VC (JWT)"} value={"3-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential object for deferred issuance in W3C VC (JWT) (`jwt_vc_json`) format. Contains the `id` from the `credentialDefinitions` array and `credentialSubject` for the claims.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialSubject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

W3C Verifiable Credential subject containing the claims as key-value pairs following the W3C Verifiable Credentials Data Model.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"W3C Verifiable Credential subject containing the claims as key-value pairs following the W3C Verifiable Credentials Data Model."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"The `id` field from a specific entry in the `credentialDefinitions` array of the create credential definition response."},"credentialSubject":{"type":"object","additionalProperties":true,"description":"W3C Verifiable Credential subject containing the claims as key-value pairs following the W3C Verifiable Credentials Data Model."}},"description":"Credential object for deferred issuance in W3C VC (JWT) (`jwt_vc_json`) format. Contains the `id` from the `credentialDefinitions` array and `credentialSubject` for the claims."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential history updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialHistory</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential exchange record that tracks one OID4VCI issuance. The issuer always returns every field except `transactionData`. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange record. This field holds the same value as `CredentialExchangeId`.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"CredentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential exchange record, tracking the full lifecycle of a single OID4VCI credential issuance.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Camel-case alias of `CredentialExchangeId`. The server sets both fields to the same value. Use this field in new integrations.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that issues the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that processes this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement that governs this issuance. The field is empty when the issuance uses a credential definition instead of a data agreement."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributeValues</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attribute values supplied for a data agreement based issuance. The field is `null` when the issuance uses a credential definition.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the data attribute, as defined in the data agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the data attribute for this holder."}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes this attribute selectively disclosable."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder opened the credential offer."}}></SchemaItem><SchemaItem collapsible={false} name={"isTokenAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder called the OID4VCI Token Endpoint for this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode used for this exchange. `InTime` means the credential was issued immediately via the OID4VCI Credential Endpoint. `Deferred` means the credential is pending via the Deferred Credential Endpoint.","enum":["","InTime","Deferred"]}}></SchemaItem><SchemaItem collapsible={false} name={"isPreAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuance used the OID4VCI Pre-Authorized Code Flow. When `false`, the Authorization Code Flow was used."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOffer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The OID4VCI Credential Offer URI sent to the holder to start the issuance flow.","example":"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/..."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential offer endpoint of the holder wallet. The issuer sends the Credential Offer to this URL for issuer-initiated issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `pending`, `ready`]"} schema={{"type":"string","enum":["","pending","ready"],"description":"Processing status of the credential. `pending` means the credential is being prepared. `ready` means it is available for the holder to retrieve."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Lifecycle status of the credential exchange in the OID4VCI protocol flow: `offer_sent` (Credential Offer sent to holder), `offer_received` (holder scanned or received the offer), `token_issued` (issuer released an access token), `credential_issued` (credential issued via Credential Endpoint), `credential_acked` (holder acknowledged receipt), `credential_accepted` (holder accepted credential), `credential_deleted` (holder deleted credential), `issuance_denied` (issuer denied issuance)."}}></SchemaItem><SchemaItem collapsible={false} name={"issuerState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the OID4VCI `issuer_state` parameter. The issuer uses it to bind the Authorization Request to this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the OAuth 2.0 Authorization Request that the wallet sent."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the ID Token Request that the issuer sent to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID Token Request that the issuer sent to the holder as a signed request object."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCodeState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value that the issuer returns together with the authorisation code."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorisation code issued for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorised code issued for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token that the holder uses to poll the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallenge"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge that the wallet sent in the Authorization Request, as defined in RFC 7636."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallengeMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge method, for example `S256`."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the wallet registered for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the holder's wallet, typically a DID or URL. Provided during the OID4VCI Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"did"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Decentralized Identifier of the issuer that signs the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was last modified. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDate"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the credential issuance happened for this exchange record. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes the data agreement attributes selectively disclosable in the issued credential."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>disclosureMapping</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialLabel"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label of the credential definition or data agreement that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of an external credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a presentation definition required for dynamic credential requests."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation exchange session linked to a dynamic credential request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata about the credential holder obtained during the OID4VCI exchange. The issuer returns only the `name` field. The default value before the holder starts the flow is `Unknown`.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder, typically a DID or display name resolved from wallet client metadata.","example":"Unknown"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format used for this issuance. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL. Records created by earlier releases can also hold the legacy values `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc`.","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"example":"dc+sd-jwt"}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether revocation is enabled for the issued credential."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status: `Operational` (valid), `Revoked` (permanently invalidated), `Suspended` (temporarily invalidated). The field is empty when the credential definition does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client assertion JWT provided by the holder's wallet for client authentication."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token, for example `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's client assertion JWT was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Wallet Unit Attestation (WUA) credential presented by the holder, certifying the wallet instance is genuine."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationPoP"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession for the Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the Wallet Unit Attestation was verified."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitValidity</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of wallet unit validity records containing attestation and proof of possession verification status.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wallet unit attestation verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isRevoked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has been revoked."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>proofOfPossession</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Proof of possession verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"validatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the wallet unit validity was validated."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed credential token (JWT, SD-JWT, or mDoc) issued to the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>cnf</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Confirmation claim (`cnf`) containing the holder's public key JWK for key binding.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Confirmation claim (`cnf`) containing the holder's public key JWK for key binding."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT Token Identifier (`jti`), unique identifier for the issued credential token."}}></SchemaItem><SchemaItem collapsible={false} name={"proof"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof JWT provided by the holder in the OID4VCI Credential Request, demonstrating key possession."}}></SchemaItem><SchemaItem collapsible={false} name={"proofType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the proof provided in the Credential Request (e.g. `jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"proofVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer verified the holder's proof of key possession."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedWalletUnitAttestation</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's Wallet Unit Attestation credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's Wallet Unit Attestation credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token shared by the holder during the issuance flow."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's OpenID Connect ID Token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's OpenID Connect ID Token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idTokenVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's OpenID Connect ID Token was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDeniedReason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable reason why the issuer denied the credential issuance request."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialResponseEncryption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."}}></SchemaItem><SchemaItem collapsible={false} name={"enc"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public JSON Web Key that the issuer uses to encrypt the Credential Response.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.","properties":{"alg":{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."},"enc":{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."},"jwk":{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the issuer, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the issuer, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holderTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the holder, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the holder, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual recipient the credential offer was sent to."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Mapper identifier linking the credential offer to an external individual record."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum polling interval (in seconds) for the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer adds a visible signature stamp to the issued document."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={true} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Position of the signature stamp on the document page, given as four pixel coordinates.","items":{"type":"integer"},"minItems":4,"maxItems":4}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `did:key` or `x509`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the credential definition at the time of the issuance.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the credential definition at the time of the issuance."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialHistory\": {\n    \"id\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"CredentialExchangeId\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"credentialExchangeId\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"organisationId\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"dataAgreementId\": \"string\",\n    \"dataAttributeValues\": [\n      {\n        \"name\": \"string\",\n        \"value\": \"string\",\n        \"limitedDisclosure\": true\n      }\n    ],\n    \"isAccessed\": true,\n    \"isTokenAccessed\": true,\n    \"issuanceMode\": \"\",\n    \"isPreAuthorised\": true,\n    \"credentialOffer\": \"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/...\",\n    \"credentialOfferEndpoint\": \"string\",\n    \"credentialStatus\": \"\",\n    \"status\": \"\",\n    \"issuerState\": \"string\",\n    \"authorisationRequestState\": \"string\",\n    \"idTokenRequestState\": \"string\",\n    \"idTokenRequest\": \"string\",\n    \"authorisationCodeState\": \"string\",\n    \"authorisationCode\": \"string\",\n    \"preAuthorisedCode\": \"string\",\n    \"acceptanceToken\": \"string\",\n    \"codeChallenge\": \"string\",\n    \"codeChallengeMethod\": \"string\",\n    \"redirectUri\": \"string\",\n    \"clientId\": \"string\",\n    \"did\": \"string\",\n    \"userPin\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"issuanceDate\": 1750000600,\n    \"limitedDisclosure\": true,\n    \"credential\": {},\n    \"disclosureMapping\": {},\n    \"credentialLabel\": \"string\",\n    \"credentialDefinitionId\": \"string\",\n    \"credentialDefinitionUri\": \"string\",\n    \"presentationDefinitionId\": \"string\",\n    \"presentationExchangeId\": \"string\",\n    \"holder\": {\n      \"name\": \"Unknown\"\n    },\n    \"credentialFormat\": \"dc+sd-jwt\",\n    \"supportRevocation\": true,\n    \"revocationStatus\": \"\",\n    \"clientAssertion\": \"string\",\n    \"clientAssertionType\": \"string\",\n    \"clientAssertionVerified\": true,\n    \"walletUnitAttestation\": \"string\",\n    \"walletUnitAttestationPoP\": \"string\",\n    \"walletUnitAttestationVerified\": true,\n    \"walletUnitValidity\": [\n      {\n        \"attestation\": {\n          \"isExpired\": true,\n          \"isRevoked\": true,\n          \"isVerified\": true\n        },\n        \"proofOfPossession\": {\n          \"isExpired\": true,\n          \"isVerified\": true\n        },\n        \"validatedAt\": 0\n      }\n    ],\n    \"credentialToken\": \"string\",\n    \"cnf\": {},\n    \"jti\": \"string\",\n    \"proof\": \"string\",\n    \"proofType\": \"string\",\n    \"proofVerified\": true,\n    \"decodedWalletUnitAttestation\": {},\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"idTokenVerified\": true,\n    \"issuanceDeniedReason\": \"string\",\n    \"expiredCredentialTokens\": [\n      \"string\"\n    ],\n    \"expiredCredentials\": [\n      {}\n    ],\n    \"transactionData\": {},\n    \"credentialResponseEncryption\": {\n      \"alg\": \"string\",\n      \"enc\": \"string\",\n      \"jwk\": {}\n    },\n    \"issuerTrustServiceProvider\": {},\n    \"holderTrustServiceProvider\": {},\n    \"individualId\": \"string\",\n    \"mapperId\": \"string\",\n    \"credentialResponseInterval\": 0,\n    \"signatureStamp\": true,\n    \"signatureCoordinate\": [\n      0\n    ],\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"string\",\n    \"credentialDefinitionSnapshot\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is invalid. The issuer returns this status when no record matches `credentialExchangeId`, when `credential` is missing or empty, when the exchange uses the `InTime` issuance mode, or when the exchange is a dynamic credential request whose linked presentation is not yet verified. You can only update a record that uses the `Deferred` issuance mode.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update credential definition logo image
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-logo-image

---
id: config-update-digital-wallet-open-id-credential-logo-image
title: "Update credential definition logo image"
description: "Uploads or updates the logo image of an OID4VCI credential definition. This operation is the only way to upload your own logo, because the create and update credential definition operations ignore `display.logo.uri`. The server stores the image, then sets `display.logo.uri` of the credential definition and of every credential configuration that it holds to the URL of the new image. Use this operation after you create the credential definition."
sidebar_label: "Update credential definition logo image"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/isHfkoAWU7SFBiMolhqd4PbbA2aOPnQBTAtnm02EsmSlF3X0H8fjpRl+SXZ12Hdl0SWece7516eO6+ZQGMx4x4F60157jBhAl1mpfFSK9ZjI5NrLhxoC6UR3KMDP0fI9UyDLPgMQU+BK/g0HFze94eQWRSovOQ5CJxKJUlPCndz6UAbtJw+g4xatMpXsOQr8BrKcBGsdGlBL1W4IYEJZrx0GE5nFrlH4ErUphy/bHuNAzlT2iKMhXQm56uUlKallWOyCMGhXaAF57Wt/QouJfSowKF3R0TJ4dqcI5eTdXoKuEC7ah/JtJrKWVn77+fcg/Qw17lw5D0pHH2+3uhWuIympDAK3u+gx6ceLSG1geRZc9K/FEtYIzkUrMeiJaOA4EDOpOf5A89z9J8MqqHoN3qu9UwPyQiWMMMtL9Cjdaz3Zb2fI0p+KxFkkJtKtC9DFJx3BjM66/YPTrUtuE/ArwwmAc4s57Jw4LwtM19apCNNvknnSq4yTFnCJBljuJ+zhCleIDnbKB40BgwFS5jFb6W0lPbelpgwl82x4Ky3ZnQx6zHnrVQzVlWP8TA6/06LFZ3ItPKoPD0WZe6l4dZ3ye6O4D7oQJVpQeK9ddXWbSzFwkt09IlSKkSZPkS/WY9NpOJ2xZI9Q/YLM0QGpjJHyp+QwsAP0My4FbFYXwpJyqqqDcmXlmmPjSF68hUzz6rdsxG+Xdv+2KASohkDXqf6psai5VKFN+PmujFMJeYiZeEOZ7RyEauLszP6t3vPfg2Llv5tmxAvOB7awOYimGixot6EhfEryqg5chFyfk1OX0YbWuHnxuQyC7XV/erIpnUr2m1A0Vpt+1pQMYXnQcuTA4yTvUzZSm8TVCqPM7Sk7zsvTI6sd3l2Vh1Rf5DULRH2jguQypQemhqnEJO/h2BrO+NKuqaJl+pJ6aVKQOlnir3gPpujg/HxShwnxCwhas6VaCHjSmkPji9wtxOCxSlarEt9PzDnP3FgRoqXfq6t/IHiAJrXP33O1g2iTiyLPPaDOG+giI1oanVx2IqoeYV+FLJ0k5qh1TaNZj8bqd9jVlrpV4Eqr4z8iPT4SEzi+YwYlNXEC5F54SRwLzHaKUvYMJQCIVygn2sibVMGgInbeqy7uOhGFu+KqKezDHq62qCSouvE16Xvbiuusy3I7vp4IVbdbcsnDwizY1w/wELXkLKElTZnPTb33rhetyuw0B1uZCpnliufSs2qZF/BjdWizEJveEbNP2m49Xwm1ew5cRe/3jfkcRuXW8r2mKSb6DTZxuOLepiIgd2OE1d1oYXqOaDkq5shPOEKqBwJ4VhkkWMWPC9xQ8LjHT1jiNdAUToPEwRjcSq/o4Cl9HMYRxthDCdK18Oet1zmAQPDMzxNANNZuqe2B7XgG5qpCY7OE67ejiPZSzXVm8bAs9AYsOCSgHSlMdr6X7fgNf7L37evdlFvB2wPlkYIjNULKdABh0xTLXsqIpNjgcpHUqkRivUQJr17tHIq+SRH2M6mDob14Acn9Sh4Gij/uOCNRddc0RTbzSlZ5HWmc1evKBRCVCTjarL7Ua8SXkeKSsIkEyfTBd2wgroIWwzooHQhPJ4rwa1wneCv5MrDNNdLF0NbIx2sfXjVh/s+nHx4uDtNYPj+7je4HXQ+PNzBfT/eNrz9BOe/nJ2/6ryGYqCzbjG4PpycHTWkXGaoXOi8m8w1PJsjXKRnB6FbLpcpD1+n2s66tazrXg/77/+8fd8hmSphXvp8JwcCWEJnZRM9ljBqGzHsF2cXl+mr9JxkjXa+4Kplz+ilDW67Xe7XWIvJ/l9N/wOrad11PX73XZNzqShbQnqua7b7whYXLKm3VkqHHcaL262SNPgE1qOjx3iPJaz37DK4s+3MtfN07Xo94Q5HNq8qev2tRBtoPGELbkNbifQoHT0/8/tJO19PPtez1Sn8Wzbmo/BvmFARDQbeYj3GEvZERPncRl09Vps5KMASD/ej8507UrlVdmxrJp6PQldZhsa3jh9MrFV7NLoZ3bGETerdvAgDZ9img9pk+0gjWMKInHf5/inwff1Ath8FYJ/6o630lyw/KvKGGuRHXL1tjsdvnhVoxo14msLxWFXV31/w7YI=
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update credential definition logo image</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/{credentialDefinitionId}/logoimage"}></MethodEndpoint>



Uploads or updates the logo image of an OID4VCI credential definition. This operation is the only way to upload your own logo, because the create and update credential definition operations ignore `display.logo.uri`. The server stores the image, then sets `display.logo.uri` of the credential definition and of every credential configuration that it holds to the URL of the new image. Use this operation after you create the credential definition.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential definition that specifies the credential format, type, and claims structure for OID4VCI issuance.","in":"path","name":"credentialDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Multipart form that holds the image file in the `logoimage` field.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"logoimage"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"format":"binary","type":"string","description":"Image file to store as the credential card logo of the credential definition."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server stored the image and updated the credential definition. The response body is empty.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, no credential definition matches `credentialDefinitionId`, or the issuer cannot save the new image reference.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

The server cannot read the uploaded file from the `logoimage` form field, or cannot store the image.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update credential revocation status
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-revocation-status

---
id: config-update-digital-wallet-open-id-credential-revocation-status
title: "Update credential revocation status"
description: "Updates the revocation status of an issued credential using the IETF Token Status List."
sidebar_label: "Update credential revocation status"
hide_title: true
hide_table_of_contents: true
api: eJzlPF1zGzeSfwU1LyvVkZTtOE7C2ts7raRsFNtrlT7sB6/KA840SVgzwATAUOK59N+vugHM90i05dw9bB5iigTQje5GfwNfohRMokVhhZLRPLoqUm7BMLsGpmGjEo4/MGO5LQ1TS8YlE8aUkLJEQwrSCp6x0gi5ojmnJ5e/skt1A5JduDlvhLGzaBKpAjQtdppG8yhRcilWDtqxWAnLsw88y8C+K0CepkfV2ucVEm69aBIVXPMcLGgTzT9+6W5Aij9KYIKmLwVoRBoxa6ALd8mayxXuMFE6ZVbz5AZ3wBluJAP27vT45fuj0+Yk3DWXCbBMLCHZJhngrgTCLLhdR5NI8hxwa9WcEw/nNI0mkYY/SqEhjeZWlzCJTLKGnEfzL5HdFjjPWC3kKrq/v3aDwdi/q3SLI7pz21v+J9wO8GqpNO27xy1EO1HSgrS4Ni+KTLipB58NLvilj5tafIbEIu018tEKMA6vDnN6u9kJ1xmL3wXp4FnMNPDEig0JImemNAXItL0HFqNg3EAaswJ0ziVIm22ZkBueCRLhGYsvwsyYWcgLpbkW7UFsL+GSLaABMt1HAoEs82j+MWrgFU0iDzOaRNXS0fX9fZO5H/tEub6/d2NMoaRxlHvx7Bn+0yZOLfUD/CzprKTMlEkCxizLLNt+DSfbnKtJ+ZswVuntELNHsesdoDW37hQZpmR9fMKZmbHLIIma8eyWbw3TYEstDYMN6C1bCshSXBcKy2KruTTIECWPueXxjB36EQRpzQ2Tim14hic9LAUpuxV2zYQ1DPLCbt2AOYv/Ff0riulAcObkcsLiZ+EbWeYL0BMWL3lmIHy7UCoDLhmXKYtlmWX+B8kceZj7g2vNt7PewRDp40fh9CtUFBJQGE+DtcpSp6ENz8GTgRsWHw1onpik+Y7nRYa4/MCfL58lr15Mf17+wqcv+fOfpr/wl3z6Yvls+Tz5JX3Fnz+P7ifR0FKPb6mvfIMWGt/apFa/OBDlulaxZHF2UMrftslBTf3oJo94Dtk04QYYzwQnqzhCehJ7A3oDmhmwhi2UXTsuGmZVh4czdmWA2ZrRQjIJt0xICyunhcy3bVTpFZfCVOb360WzuYI7hHSaTYe5M4JGJvzdk2GSK3DMbskvYCkUmdrmIK2DX2iFepBQEKaSKsIg5ZYfrjQADv824LgE42ENB3KlNoAqiwC2dZtnWNA8t2uQlfUlr6E0ZMwaspvCUkhBBBXSWOCpk/Y25Ho/1mqxKC28R1lpmlrSQb0tVeOdcBlmSrQPkHoF19ngghtIxzblFeDX7YrcIwu5edyPcJ7To74DnpQWe8IWJ6j+CDLQqekzkMhIhHgcDhF4GJDXZ8KQEgZNy2YiFxbSY2GSTJlSN0F4M9KD8QFJGaM3F09qN02znN8Eia6BGsgAvRPItix1UPgC/c+u60F0DPskx0SYQ3IXIN0BqVOZov8ABjlt1+BUt9spw1MNaVeZq+XSU0EYcvu/F7gET70DF/S+CytOZFooIW3NitbRD6L5VqU7sPo0CHKuUpLmdGBZFp/KS5FDzHLgsqvy2C03wckWeQ6p4BYZtRG8hX3DfQpbmLH4GJagNXqog2sLw9DNROMY1gszBhdseK7RJHJoR5MozImuiUJnGg5Lu1Za7MaoQWEN57/NozMNU7/2/yCOSNZfM3U7Y24R52O5VcI4Z1SqoURQXHjWttHvUNQeZ+nlMM1pNrs6P2WG9LlqCptV6GVr297cEvFu2Vs8AyKd1jhNSf7nBwf/VX/3ib77VGrxn2trCzM/OOCFmImV5tLOhDqYzYZ2Fni4gwPSOX4MwpHwOsvvyhnOlu9tQHrXsUcaoogw7Or8DZ0BN2NKypwCj9rXaiE/Hvk1JNELMYXBPN1G1909nTlrjoJe5xo6vgWL/TLjh2UBuEKhoeAa0hmLCVwYL9BrYXzDRYb6s3JOaynQYLWAjduj2WVnjtkoU9UfGhIQGwoTLaqsT047RE2qDX7Hk5v+VxgRdb9NIQP3ZWDKpxSkwAPeJeybypUeo2vtkHvLGU5PoZVVicroIMxZXG81Zns9+QnHyhFzfxLGB2rEbM/T2SRcoilRmoUfnY+J43Fik2ox2/OyqyEDclIw7CIrw2ggzugRNmZ7nTABUlKhA1qzswBxocaWJzdS3WaQriB1+Bb9GY5JzUnumwaZO3M8C+sp/ovOjA5/a2q4v6tDuV8ZP9B4Ir/WzQk8j90Sn1BYIGZVqq2lRcjrE8TthZDpgDI/d/mrSqm0TDT3toeG+pE74kzDfMQbMEfI7MXs2RgKlJtYQ4gjTPAGRUoOxZMROD32nkkPYq10OwZnAP4OvsrXw0G3GMPnlSTZddOcD97nBBrgb6BCF4uQ17Fq5Zw6SsrggBY0lqh0QByOdnLbap731wyHPSj3ES+DQBdNR2g30Ojg8GrOIMRHfSHaNWkIPLrE1McBH1YTnNqrCe95TafSKlaoLGvh8bDHiMZcpXC0xuMhV7uQ4PXRidt4EiYNnrJgTwbPZTdkO//1iP306odXfYTegl2rHWL4IbRymjsh1ng3jsUXL358FRMcDanQkNgrLR5f/9wPJieyu18NK2Es6B0FL8nEjpmJIxo5UM9wXP+L8RhMmN0WAqOmLePs+PQYzevV+ZsZO9NqIzB9npY6ZNnaIZVniUs17JK6PIYEpNU8I8HuJ0+8KiAiofYZTBOVBvSZ2EHyL+tssOPvnr37hB/2K1o/eNQSDejAHjZ1LOXUQA9lMO+YFTkYy/OC7QnJDCRKpmY/pD8a5izkvzFi8VBaAcPzn3585v7D/boE/p+MRsaNxWgW+ZE6q50J1PqhkMGM0hbT9I1M4xDSrwjp4F8ct+3CE/CGwaLamhcuv9ALvxsZ8Kdt5c9I0/TyhFXSxoxlbYJWHKjLteKqoawZT1PhilFnjfzZUE3wsk3ngm8zxVMfHznQM3akpOVCGhYjoNjVOhqRXUlwXeHjww9H7P0R2/v9wyUdu5zbCaqYeJPY+CBOVdJcI+MiN24iVYQvjqe/f7jEBQ7Y6cU79vznZ89/mP7I8mOVHOTHb/yKxqugwKG3vChQIzyJFBeBD6xemOVu5SEMawKYGTvhyZqhrtviFMp14t4YlnzR2GKxqbGsAWuFXHVY+YYvIHtcz9GwgfiskShWejAx3UpIkyPQweC4WuLbsuHD2Hwt7J3MLOYfXJ8B3FnQkmffAL3QgB4IaYmn7J2z5kpN6CHtShKUbiXPRdJE1HvbfXS+ptTUZ0QLnUpFGkydKMkyIW8wmFaY3x/FiVBy7kO/Bv0WLHcitlCl7TI/5IIXqDeGXYo6bXrZDwqUzLY0OsZUdexVNo1MYcnLzPqoYgFLpaHp3lKCzulczEdQWeJKYmwuqcb5PSoMfXo74IPOVSpMkfEtw6WZBqMyTGQstcqDU+i8PHRCiaTtXKLHfTiHf906Qb+ScvyqxKDTp52Mdl3diT/f2k+b5BO2CcRIyqZ6n7E4Tf7DpNPPt5Z+bCvIGYtzoz7lqUrcrwP6fMbOyWpXbhFbbBlwnYk6kWMY9l7wzLicEZE7gxVPtqFiFW8qNCYs3hQVTmRk3BbiTs67moKfi/pz2vi+sfnqr2gShV1hEq3mUz0RU4JlUSht66akbypzNJo70NGR6BakDzXskIh8bavNUak1il+vlWTeabfZo3YYzDZVPTV7w001NKjRVbM33FaT7j9cFB3W56kCbOuwzBO5gXiHx7s05YQY69AY1AJqhzijzir4g8vDXIaSX4Q4arEdCsCIf2Fiade4wYB9H5tLwuTRyGdbVGmmHk6UBeiEtqWWcwF2OafEnZkrxGTupk6rqVOEOv98a6cL4Bp0PIThe9AUQzyxkPcXM0xNjFU2HgSBd1S8ksIeWovxw25Mc12DDOexxkS29+HqcL/lAjvL2eXfhCWI1XIb7JjnJpbkyacQhq1AlkLCOJpn6myXzJFSS+TmmTLBYIczP7KLcYhP5s4Y3R7gy3s83sI2W8VGWg/wW9ypp2WJQDZ+to/nDEtc9EF9lw0EULcXgVRFTSqHVLtv8KEOg4cChLZvwAflbaQL7kNjS020R9DrtIWZk7vCGfpvZFsTJLbBgVvPZ/+DKvxeqy8AJKnhmwrEkwWPjwvbPbnKSi3fLesz8jhLznaXlu/NjiFB7bPlyTQbAjNAu8r+fq8cEwyfYAIdYBHslru6Y0KbeuNcaaKhpl1uG/3QiXc5Kc2AjuV+cI36tZRELp+WJDjCfnR0mSnJSCH+XpzIZbzf1FMts1aUi0wk7Aa27PcPr0mV42esiIUUwGe7Q8CL1tDlYRvhx1782Yp4f4KUH2mp7LfhE+18wKnUcleTNO7cdCvCjQCjSuOnkCtpLDpkckUUqIW0xuXr/R0n8xVeHpM+BmwPZisX0cT7NcAnnzkfuYYj1uF9OJAD+00Bc9Pph0f8mW8Q0mO3cpXN61YCxmx6J5TwhccdHGLXgHmkpMS6R1WANGvsruiISiMV0OmgqUH6Dfy5VBjBuonH9/Ntx0jUc6OqRDrV7c+Bm12829/KnMspNrFQ6ljTNHa73jZF1LcCjKXWm1kfb5eO2rp6qJm061eF2ymjvl6hYSNUaTASHNZMJnTvb6BlIHtI7YLPDoIzjqs/ogGLgUy5y9t17iE8MSXfKGNRhm2hSplWLRKBX0O9rE7KXr4/Y7a7CCZJJeked0VAuBQZJdoaVyYa4pIB34BhmN0jMy/aFyo62dtzf2vlRCZ6Wzxdh9Xr1M0lZqCc6rKnvZp6S/87zB7pVfYrcnNjfOdzkXGBbq2f3nMLebbaxWqfkPLPueQrX/vJVkoLu847QfnJ0fFv05MLF2WDTHZb3F/sYVATbAzA4fMXP//j6K0D8Pn25mkcOnN+ze8X7/7JPsCCvYZtT4ZCr4FHrm+aA23v76u2pEtdGnsBeiMS8DVp/dQTVRpL9ytEAsFV0KEa2qpFTzoZWvzF0vRMtDLi/09YhmTEo1iid7kRacmzbysg1PMRA1EIV0TqN3WTCfMtRQQZS2agd4H6lkY2fVYsTATvoAcIyxWNak8bQyz9DmukU2lBb1qF0rFQ562QIi9zao2hAqif2g56urrm0b4ZjF64LTW2TeXFE8rJPE2xtLgRRqCZr9ZlLjTz8Y43q6lKyupKQzX0SCmdCtku0w+nZ86U8dVEJxJdcMpfoPBwWMFXMGErsQGJtmmpSs0KcQcZSyqgg7mYwA4UHiFP3a8vUZLuwh/E2W1h1UrzYi2S17CtZXZI0lC7oy80fNZQV/VbZW6CBhPGd6wr2nRHbXk5a2MzXnt5GBM3r0liHx51dHcq0vkNbGOqpd/9+OyXeLR8eiF5YdbKPjXSLbYPl3W9qsfUQFOJ+t7vTrlKYOJ98LbgyP263m20kQtj/Vtcw/egWndc+tdQOjdC+tcf+lcMxlvzB/reqzbxdvftQ12uw62nvYbQ0fbMoZbJoV7GfpNht9VvuNOu3RfXaFZz3WF151aztarZ3zTUa9NqbRnq8eg3TIw2MIx3FzxQ+R+twle18IGS61DFb6AW1y82DRd8xossY/WPBwoOj1UGBlP3/TydS565XFVIHDWTNt18yiMJjjq90Iv6++H3SFg8HqcOBouPhCsP+p8Pun0db6vhAj3oj/Qcg2EzTffz2nqcvOU18JTetviCf710DwXsfM2/qZtBa6W9KqDPxw1LcP1Yy0Q9e8jBqgrkL6m5rrf80K2Zqqb+d46hbVHaOgakLHIvYr9cV/kLNN6+xDzYWkJBtL/jQsGfVMHHzrlN1thPMGSQ4okbHndPNTU35IIuJVEO+mn16y5bn/8bs/VK8qpZt0eaH/+tJZ60CIZB/tkAAtOhEfr9kJSaarEfv0SHhXgN+PEa346xfIUP40T+WZ2QFd4LSaSjfbwaSocHSZL79vqoKIki+JbNPDrYvDhwb/QcpG6dqbMmB+4O5IFJP9/ag/okHKzdOyIHX4YO2f1BfRimlcPktjj0is8x5MpTAD0LnUXzKFymxILDtHWjMrqfdBc40yotXZpsZJnHVriwfEXXEYenG/dzF5HrmjUXKKFOsAKD6sDMfeHfD3K8rV8Qat0c6FfXz04pouk0mZBObF1MilvrxMyBYTnmExbUSrgUd+HVlNjhyGK2J5UFn3rgguJlU/AE9ifMVVpay86Zn/jXrSo1kmN6A9u/xS5SwNN6Xr9ldBLOw9DTQa22Hsp0LFVQBDwhRQA5F8gEr2H/uyZ8RTvxj/qrNseazO6QtJoU0jPU6KsQVwtM4L951XXZfp0Cgznnz1CGvuGXsOpy+Z7PKOxTc8PwxLNmY2d1Vs/2q1uYxid4kf2uZcz4VzkcIygfRzZxQtmkCQGjGgT2nztd0Oht9o92YZdLynVqprRfwfFmfaZujROLYMu6LeCTTlOggzbY2t2wllWXN0YICUgDdW9mdFjwZA3Yf9Vj3e3t7YzTzzOlVwd+rjl4c3p08s+LkynOQWdK2KwlA0SskMcIpwlVjmP7i2cvXs5+mNETKYUyNueygY97nKzdP9vppOuezYbV+hNfUvM6xMKdPaBcNt2m0ZQIc+r7Y7R54d6GWgpKz7VUuI+4KZQjNd4NzrwqjybRfPQxs642v0ZPGq8xfoy+fMHHRK50dn+PX/9RgibjhA0KWriUCWp8Qfch0mhOjwI8QMq9c2/i99n/8fNug6QOOlxuq7c25tiWeIMqfjjpcX9dOfa0dzf0yO1w6uOssFTP3UHj5Ga4S4APjm2a9LOry2gSLfwrcjl5NpHmt8hBfhvNI3wZi8SBNAjpZfz+S5RxuSo53gaM3LL3/qZm24jdkBHzH3Bjg7Tp2jO3F/w/7mxwyl/x5L6G7d+q4e6X0QmVDXWjkVP47tr/Athlyt0=
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update credential revocation status</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/credential/history/{credentialExchangeId}/revocation-status"}></MethodEndpoint>



Updates the revocation status of an issued credential using the IETF Token Status List.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the credential exchange record tracking a single OID4VCI credential issuance lifecycle.","in":"path","name":"credentialExchangeId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

New revocation status for the issued credential.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"New revocation status. `Operational` reactivates a suspended credential. `Revoked` permanently invalidates. `Suspended` temporarily invalidates (can be reactivated).","enum":["Operational","Revoked","Suspended"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential revocation status updated successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialHistory</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Credential exchange record that tracks one OID4VCI issuance. The issuer always returns every field except `transactionData`. A field that has no value is returned with its empty value: `""` for a string, `0` for a number, `false` for a boolean and `null` for an object or an array.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential exchange record. This field holds the same value as `CredentialExchangeId`.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"CredentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the credential exchange record, tracking the full lifecycle of a single OID4VCI credential issuance.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Camel-case alias of `CredentialExchangeId`. The server sets both fields to the same value. Use this field in new integrations.","example":"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11"}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the organisation that issues the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that processes this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreementId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the data agreement that governs this issuance. The field is empty when the issuance uses a credential definition instead of a data agreement."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributeValues</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attribute values supplied for a data agreement based issuance. The field is `null` when the issuance uses a credential definition.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the data attribute, as defined in the data agreement."}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the data attribute for this holder."}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes this attribute selectively disclosable."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder opened the credential offer."}}></SchemaItem><SchemaItem collapsible={false} name={"isTokenAccessed"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder called the OID4VCI Token Endpoint for this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceMode"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `InTime`, `Deferred`]"} schema={{"type":"string","description":"Issuance mode used for this exchange. `InTime` means the credential was issued immediately via the OID4VCI Credential Endpoint. `Deferred` means the credential is pending via the Deferred Credential Endpoint.","enum":["","InTime","Deferred"]}}></SchemaItem><SchemaItem collapsible={false} name={"isPreAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuance used the OID4VCI Pre-Authorized Code Flow. When `false`, the Authorization Code Flow was used."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOffer"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The OID4VCI Credential Offer URI sent to the holder to start the issuance flow.","example":"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/..."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential offer endpoint of the holder wallet. The issuer sends the Credential Offer to this URL for issuer-initiated issuance."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `pending`, `ready`]"} schema={{"type":"string","enum":["","pending","ready"],"description":"Processing status of the credential. `pending` means the credential is being prepared. `ready` means it is available for the holder to retrieve."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `offer_sent`, `offer_received`, `token_issued`, `credential_issued`, `credential_acked`, `credential_accepted`, `credential_deleted`, `issuance_denied`]"} schema={{"type":"string","enum":["","offer_sent","offer_received","token_issued","credential_issued","credential_acked","credential_accepted","credential_deleted","issuance_denied"],"description":"Lifecycle status of the credential exchange in the OID4VCI protocol flow: `offer_sent` (Credential Offer sent to holder), `offer_received` (holder scanned or received the offer), `token_issued` (issuer released an access token), `credential_issued` (credential issued via Credential Endpoint), `credential_acked` (holder acknowledged receipt), `credential_accepted` (holder accepted credential), `credential_deleted` (holder deleted credential), `issuance_denied` (issuer denied issuance)."}}></SchemaItem><SchemaItem collapsible={false} name={"issuerState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the OID4VCI `issuer_state` parameter. The issuer uses it to bind the Authorization Request to this exchange."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the OAuth 2.0 Authorization Request that the wallet sent."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequestState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value of the ID Token Request that the issuer sent to the holder."}}></SchemaItem><SchemaItem collapsible={false} name={"idTokenRequest"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID Token Request that the issuer sent to the holder as a signed request object."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCodeState"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"State value that the issuer returns together with the authorisation code."}}></SchemaItem><SchemaItem collapsible={false} name={"authorisationCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 authorisation code issued for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"preAuthorisedCode"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Pre-authorised code issued for the OID4VCI Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"acceptanceToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Acceptance token that the holder uses to poll the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallenge"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge that the wallet sent in the Authorization Request, as defined in RFC 7636."}}></SchemaItem><SchemaItem collapsible={false} name={"codeChallengeMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"PKCE code challenge method, for example `S256`."}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URI that the wallet registered for the Authorization Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the holder's wallet, typically a DID or URL. Provided during the OID4VCI Token Request."}}></SchemaItem><SchemaItem collapsible={false} name={"did"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Decentralized Identifier of the issuer that signs the credential."}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Transaction code (tx_code) for the Pre-Authorized Code Flow."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was created.","example":1750000000}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when this exchange record was last modified. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDate"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the credential issuance happened for this exchange record. The list operation sorts on this field.","example":1750000600}}></SchemaItem><SchemaItem collapsible={false} name={"limitedDisclosure"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer makes the data agreement attributes selectively disclosable in the issued credential."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credential</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"The credential payload being issued. Contains `type` and `credentialSubject` for W3C VC (JWT) format, or `vct`/`doctype` and `claims` for IETF SD-JWT VC / ISO 18013-5 mDoc/mDL formats."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>disclosureMapping</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Selective disclosure mapping for IETF SD-JWT VC credentials. Each entry maps a claim path to its disclosure setting."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialLabel"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label of the credential definition or data agreement that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of an external credential definition that this issuance uses."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of a presentation definition required for dynamic credential requests."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationExchangeId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the presentation exchange session linked to a dynamic credential request."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holder</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata about the credential holder obtained during the OID4VCI exchange. The issuer returns only the `name` field. The default value before the holder starts the flow is `Unknown`.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the holder, typically a DID or display name resolved from wallet client metadata.","example":"Unknown"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialFormat"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `vc+sd-jwt`, `vp+sd-jwt`, `dc+sd-jwt`, `jwt_vc_json`, `jwt_vc`, `mso_mdoc`]"} schema={{"type":"string","description":"Credential format used for this issuance. `jwt_vc_json` is W3C VC (JWT). `dc+sd-jwt` is IETF SD-JWT VC. `mso_mdoc` is ISO 18013-5 mDoc/mDL. Records created by earlier releases can also hold the legacy values `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc`.","enum":["","vc+sd-jwt","vp+sd-jwt","dc+sd-jwt","jwt_vc_json","jwt_vc","mso_mdoc"],"example":"dc+sd-jwt"}}></SchemaItem><SchemaItem collapsible={false} name={"supportRevocation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether revocation is enabled for the issued credential."}}></SchemaItem><SchemaItem collapsible={false} name={"revocationStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `Operational`, `Revoked`, `Suspended`]"} schema={{"type":"string","description":"Current revocation status: `Operational` (valid), `Revoked` (permanently invalidated), `Suspended` (temporarily invalidated). The field is empty when the credential definition does not support revocation.","enum":["","Operational","Revoked","Suspended"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 client assertion JWT provided by the holder's wallet for client authentication."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token, for example `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."}}></SchemaItem><SchemaItem collapsible={false} name={"clientAssertionVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's client assertion JWT was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestation"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Wallet Unit Attestation (WUA) credential presented by the holder, certifying the wallet instance is genuine."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationPoP"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof of Possession for the Wallet Unit Attestation."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitAttestationVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the Wallet Unit Attestation was verified."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitValidity</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Array of wallet unit validity records containing attestation and proof of possession verification status.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attestation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Wallet unit attestation verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isRevoked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation has been revoked."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the attestation was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>proofOfPossession</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Proof of possession verification status.

</div><SchemaItem collapsible={false} name={"isExpired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession has expired."}}></SchemaItem><SchemaItem collapsible={false} name={"isVerified"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the proof of possession was verified."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"validatedAt"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Unix timestamp (in seconds) when the wallet unit validity was validated."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed credential token (JWT, SD-JWT, or mDoc) issued to the holder."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>cnf</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Confirmation claim (`cnf`) containing the holder's public key JWK for key binding.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Confirmation claim (`cnf`) containing the holder's public key JWK for key binding."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"jti"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT Token Identifier (`jti`), unique identifier for the issued credential token."}}></SchemaItem><SchemaItem collapsible={false} name={"proof"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Proof JWT provided by the holder in the OID4VCI Credential Request, demonstrating key possession."}}></SchemaItem><SchemaItem collapsible={false} name={"proofType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the proof provided in the Credential Request (e.g. `jwt`)."}}></SchemaItem><SchemaItem collapsible={false} name={"proofVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the issuer verified the holder's proof of key possession."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decodedWalletUnitAttestation</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's Wallet Unit Attestation credential.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's Wallet Unit Attestation credential."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OpenID Connect ID Token shared by the holder during the issuance flow."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idTokenDecoded</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Decoded payload of the holder's OpenID Connect ID Token.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Decoded payload of the holder's OpenID Connect ID Token."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"idTokenVerified"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the holder's OpenID Connect ID Token was verified."}}></SchemaItem><SchemaItem collapsible={false} name={"issuanceDeniedReason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable reason why the issuer denied the credential issuance request."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentialTokens"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Array of previously issued credential tokens that have expired."}}></SchemaItem><SchemaItem collapsible={false} name={"expiredCredentials"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Array of decoded expired credential payloads."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transactionData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Transaction data bound to this issuance, as defined in the OpenID4VP transaction data extension. This is the only field that the issuer leaves out when it has no value."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialResponseEncryption</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.

</div><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."}}></SchemaItem><SchemaItem collapsible={false} name={"enc"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>jwk</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public JSON Web Key that the issuer uses to encrypt the Credential Response.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Encryption parameters that the wallet requests for the OID4VCI Credential Response. The field is `null` when the wallet asks for a plain response.","properties":{"alg":{"type":"string","description":"JWE key management algorithm, for example `ECDH-ES`."},"enc":{"type":"string","description":"JWE content encryption algorithm, for example `A128GCM`."},"jwk":{"type":"object","additionalProperties":true,"description":"Public JSON Web Key that the issuer uses to encrypt the Credential Response."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the issuer, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the issuer, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>holderTrustServiceProvider</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Trust service provider record of the holder, resolved from the trust list.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Trust service provider record of the holder, resolved from the trust list."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"individualId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the individual recipient the credential offer was sent to."}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Mapper identifier linking the credential offer to an external individual record."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum polling interval (in seconds) for the OID4VCI Deferred Credential Endpoint."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureStamp"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer adds a visible signature stamp to the issued document."}}></SchemaItem><SchemaItem collapsible={false} name={"signatureCoordinate"} required={true} schemaName={"integer[]"} qualifierMessage={"**Possible values:** `>= 4`, `<= 4`"} schema={{"type":"array","description":"Position of the signature stamp on the document page, given as four pixel coordinates.","items":{"type":"integer"},"minItems":4,"maxItems":4}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `did:key` or `x509`."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinitionSnapshot</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Copy of the credential definition at the time of the issuance.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Copy of the credential definition at the time of the issuance."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialHistory\": {\n    \"id\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"CredentialExchangeId\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"credentialExchangeId\": \"3a1f0c62-8f9a-4a17-9a4a-2f0f1c9d6a11\",\n    \"organisationId\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"dataAgreementId\": \"string\",\n    \"dataAttributeValues\": [\n      {\n        \"name\": \"string\",\n        \"value\": \"string\",\n        \"limitedDisclosure\": true\n      }\n    ],\n    \"isAccessed\": true,\n    \"isTokenAccessed\": true,\n    \"issuanceMode\": \"\",\n    \"isPreAuthorised\": true,\n    \"credentialOffer\": \"openid-credential-offer://?credential_offer_uri=https://api.igrant.io/...\",\n    \"credentialOfferEndpoint\": \"string\",\n    \"credentialStatus\": \"\",\n    \"status\": \"\",\n    \"issuerState\": \"string\",\n    \"authorisationRequestState\": \"string\",\n    \"idTokenRequestState\": \"string\",\n    \"idTokenRequest\": \"string\",\n    \"authorisationCodeState\": \"string\",\n    \"authorisationCode\": \"string\",\n    \"preAuthorisedCode\": \"string\",\n    \"acceptanceToken\": \"string\",\n    \"codeChallenge\": \"string\",\n    \"codeChallengeMethod\": \"string\",\n    \"redirectUri\": \"string\",\n    \"clientId\": \"string\",\n    \"did\": \"string\",\n    \"userPin\": \"string\",\n    \"createdAt\": 1750000000,\n    \"updatedAt\": 1750000600,\n    \"issuanceDate\": 1750000600,\n    \"limitedDisclosure\": true,\n    \"credential\": {},\n    \"disclosureMapping\": {},\n    \"credentialLabel\": \"string\",\n    \"credentialDefinitionId\": \"string\",\n    \"credentialDefinitionUri\": \"string\",\n    \"presentationDefinitionId\": \"string\",\n    \"presentationExchangeId\": \"string\",\n    \"holder\": {\n      \"name\": \"Unknown\"\n    },\n    \"credentialFormat\": \"dc+sd-jwt\",\n    \"supportRevocation\": true,\n    \"revocationStatus\": \"\",\n    \"clientAssertion\": \"string\",\n    \"clientAssertionType\": \"string\",\n    \"clientAssertionVerified\": true,\n    \"walletUnitAttestation\": \"string\",\n    \"walletUnitAttestationPoP\": \"string\",\n    \"walletUnitAttestationVerified\": true,\n    \"walletUnitValidity\": [\n      {\n        \"attestation\": {\n          \"isExpired\": true,\n          \"isRevoked\": true,\n          \"isVerified\": true\n        },\n        \"proofOfPossession\": {\n          \"isExpired\": true,\n          \"isVerified\": true\n        },\n        \"validatedAt\": 0\n      }\n    ],\n    \"credentialToken\": \"string\",\n    \"cnf\": {},\n    \"jti\": \"string\",\n    \"proof\": \"string\",\n    \"proofType\": \"string\",\n    \"proofVerified\": true,\n    \"decodedWalletUnitAttestation\": {},\n    \"idToken\": \"string\",\n    \"idTokenDecoded\": {},\n    \"idTokenVerified\": true,\n    \"issuanceDeniedReason\": \"string\",\n    \"expiredCredentialTokens\": [\n      \"string\"\n    ],\n    \"expiredCredentials\": [\n      {}\n    ],\n    \"transactionData\": {},\n    \"credentialResponseEncryption\": {\n      \"alg\": \"string\",\n      \"enc\": \"string\",\n      \"jwk\": {}\n    },\n    \"issuerTrustServiceProvider\": {},\n    \"holderTrustServiceProvider\": {},\n    \"individualId\": \"string\",\n    \"mapperId\": \"string\",\n    \"credentialResponseInterval\": 0,\n    \"signatureStamp\": true,\n    \"signatureCoordinate\": [\n      0\n    ],\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"string\",\n    \"credentialDefinitionSnapshot\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is invalid. The issuer returns this status when no record matches `credentialExchangeId`, when `revocationStatus` is missing, or when the credential definition does not support revocation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update global configuration cover image
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-global-configuration-cover-image

---
id: config-update-digital-wallet-open-id-global-configuration-cover-image
title: "Update global configuration cover image"
description: "Uploads or updates the cover image of the OID4VCI issuer global configuration. An organisation has one issuer global configuration, so the path has no identifier. The image URL in `credentialBranding` is a public URL with the `globalConfigurationId` of the configuration."
sidebar_label: "Update global configuration cover image"
hide_title: true
hide_table_of_contents: true
api: eJztV9tu2zgQ/ZUBnxJAtpw0BRZCUWxqdwu3xSbY3B6KAKapscWGIlmSius1/O+LIWVFdpLdD+i+JALJuZ2ZOTPesBKtQ8EDlqxYcOUxYyV64aQN0mhWsBurDC89GAeNLXlAD6FCEOYRHciaLxHMIh5dTCdnt+MpSO8bdLBUZs4VCKMXctk4TvqGcK7BuCXX0scDqLgHo/HfhDLwJhqwPFRRQBuQJeogFxLdEK4rbD25+esrSA0z4TDec/XBcV1KvZyB9MDBNnMlRXy3kqGKamfJ6Lhvc1rOdmHtB8AyZizuHrGCpeubCM1ELmXg6o4rheHCop6Wn57rHhN0U/KXZczhjwZ9+GDKNSs2pC2gDvRZNypIy13IF8bVg5IHTseohaGAWLHZZsyLCut4bh35FST6pKezUWwYKeCBFWwuNXdrlrGwtsgK5oMjVdttckQ6KoNvfen77q2Zf0cR2Hb/cayZeOKt0T5ZPx2N6N9+IV18YRmrkJfo6BGpORudHATNrVVSRJjy757kNr0Y+z6ic8aNTUkgxu9Jz9ozr7MDfJ6ki83uqdQBl+hI309eW4WsOBuNti+of5JpAeyJsA+8BKltE8Byx2sM6Ag0ivegszRvQmWc/BvLF6A5+4Wh+fQCDYA2ARam0WXq+FXsMqj5Q0dJ/derCjXIACVaZdbpxR7zJPmWXKSHGAoIUyMxklonDaHiAXxACwsuFSbbjviKWEg45AGhY4SCnAhcBPCNtcaF4bPEvk298YsmdqoDOs0VeHQ0QKKZA4yI1lA0ToY1K75t2LmVX5A+77cUI196wqLlWkhkC0eRbmkAHbOMTeM0IUhqDJUhnrZNRISHihUsfzzNU7nkZdIzSOWQG4talnkaR3maDIO9ysojO8qWv1McPjq6H+oEa9OGyTLWOMUKVoVgfZHnJdZmwK0cyqXjOgylYdvsUMGlM2UjYq2+oua/NFwFvpR6+Zq4T9eHjtw/4X9FZZiqZ5eFrgx4OsiYJFMpgSxjmtd0e95SW4SMHZbB+eUUHnANRIA0p0W7HVBfP3LVdDvFbE/PDJIZqBsfYI5gHS7kTyzTMJ8lH2EGR9oEjAqC41JFDCwXeJwBDpfDA7UFtILv1qZxBMfgAdfvZ8M4GKVemF3HchE7FmsuCci2yX9/Aq+LX356OtpHvZ+wA1g6IbDOPMoSaWURhpos0IpjFdaoQ+Kv3dYV6x4WxsEtOrmQfK4Qxt0C5IGagWuBcNRuaMfAdfmK4KVD35nomurymDwKRhjlKUvSA6UQNcn4llcTmB6CSdtcBpVRZRaNUccs1tA2G4iee42P6Qlcl9yVfhDjlVwHWCiz8im1LdLR27s3Y7gdw9Hnu+vjDKYfr/+Aq8ng89013I6TtenVBZz8Njp5M3gL9cSIvJ587dmEtA95ImclBWofKXFXuZaLCuF0OHqWutVqNeTxemjcMm9lff51Ov7459XHAclsMxZkUHs1EMEqjWi67LGMEW2ktJ+OTs+Gb4YnJGuNDzXXPX/SavniZtzfwg97rDdi/t/hn+3wLYcF/Blyq7jUhH1M9qadEd/Y4ynL2vWewN2bE+lngJa0uKWwWcZemhZRRTcv7jNWGR9I+2Yz5x5vnNpu6fhHgy7OuIw9chd7MU683WiMA+aBCJiNU14H1xQDPVcNxfLS7wUaCUnoXAi0off82dax7U/Ly5trlrF5+6ukjktD/BkR1WZPn8lH4vH90fAQR0P7Qb7vrvS658ThlEi+0l/y/EWRd9RLX3D9vnuebl4V6CZTek2pvt9ut/8AmHU9RQ==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update global configuration cover image</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/issuer/global-configuration/coverimage"}></MethodEndpoint>



Uploads or updates the cover image of the OID4VCI issuer global configuration. An organisation has one issuer global configuration, so the path has no identifier. The image URL in `credentialBranding` is a public URL with the `globalConfigurationId` of the configuration.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"coverImage"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"format":"binary","type":"string"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Global configuration not found. The wallet makes the configuration when it deploys the organisation wallet, so this error comes only when that step failed. There is no create operation: contact support.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update global configuration logo image
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-global-configuration-logo-image

---
id: config-update-digital-wallet-open-id-global-configuration-logo-image
title: "Update global configuration logo image"
description: "Uploads or updates the logo image of the OID4VCI issuer global configuration. An organisation has one issuer global configuration, so the path has no identifier. The image URL in `credentialBranding` is a public URL with the `globalConfigurationId` of the configuration."
sidebar_label: "Update global configuration logo image"
hide_title: true
hide_table_of_contents: true
api: eJztV1tv2zYU/isHfEoA2XLSFBiEolhqd4XbYAmW20MRwLR0LLGhSJak7HiG//twSNmWHWf7Ad1LQpPn+p2rVqxAYzHnHguWzbh0mLACXW6F8UIrlrF7IzUvHGgLjSm4Rwe+QpC61CBqXiLoWbi5Ho8uHoZjEM41aKGUesol5FrNRNlYTuL6cKlA25Ir4cIFVNyBVvhvTAk4HRQY7qvAoDSIApUXM4G2D3cVtpbc/3UFQsEktxjeufxkuSqEKicgHHAwzVSKPNAthK+C2ElUOuzqHBeTjVv7DrCEaYMbIpax+HwfkBmJUnguH7mU6K8NqnHx5bXsK13qMZnLEmbxZ4POf9LFkmUrEuZReTrWjfTCcOvTmbZ1r+Ce0zWqXJM/LFutE+byCutwbyyZ5QU6+kXBCYjQD+LnnmVsKhS3S5YwvzTIMua8JUnrdbRDWMqB7x3mpy2pnv7A3LP1Pm3Il3DjjFYu6j4fDOjffhJdf2MJq5AXaImIxFwMzg5c5sZIkQeM0h+O+FYdD7smorXaDnVBEIbzqKPtldXJATo77my1IRXKY4mW5L3w2khk2cVgsD4ifsfT4tdhYZ94AUKZxoPhltfo0RJo5O9BVSne+Epb8TcWR6C5+IWh+XKkB4DSHma6UUUs90UoMaj5c9uO9qkXFSoQHgo0Ui8jxV7bifxtZxEOgiuQ6xqpHclllOAr7sF5NDDjQmLUbalZUQvKLXKPsG0HGRnhee7BNcZo6/uvAvs+1sYvGtix8mgVl+DQztFG0A8woqaGeWOFX7Ls+4pdGvEN6fi0Jh956QiLttFC7LRwEnotTZ9TlrBxGCUESY2+0tSkTRMQ4b5iGUvn52lMl7SIcnoxHVJtUIkijbMojWOht5dZ6a45kqHkhgt27ns6wlq3XrKENVayjFXeG5elaYG17nEj+qK0XPm+0GydHAq4sbpo8pCqb4j5Lwm3npdClW+xu/h8aMjTDv5bysKYPJsgbLOAx4uECVIV48cSpnhNr5dtZwuIscMsuLwZwzMugfofzei83QyorOdcNtt9YrInZwJRDdSN8zBFMBZn4gWLOMgn0UaYwInSHoMAb7mQAQPDczxNAPtl/0BsBi3jh6VuLMHRe8blx0k/jEWhZnpTsDwPBYs1FwRkW+O/78Db+i++7K72Ue8G7ACWLRMYq+eiQFpXck015mm9MRJrVD62r83GFdIeZtrCA1oxE3wqEYbb5ccB1QJXOcJJu52dAlfFG4w3Ft1Wxbambk7JIq9zLR1FSTigEKIiHte21QimA6/jJpdApWWRBGVz0rCEttYg75jXuBAez1XBbeF6wV/BlYeZ1AsXQ9siHax9fDeEhyGcfH28O01g/PnuD7gd9b4+3sHDMGob317D2W+Ds3e991CPdJ7Wo6uOTojbkKPeLEWOyoWOuMlcw/MK4bw/eBW6xWLR5+G5r22ZtrwuvRoPP/95+7lHPOuEeeHlXg4EsAqdN9vosYRR24hhPx+cX/Tf9c+I12jna6469sS18uhW3FnAD0usM2D+394Pt/e2g3l88amRXChCPoR61Q6I72x+zpJ2sSds94ZE/ABQgra26DZL2LFRQQnW3aQr7TwJX62m3OG9les1Xf9s0Ib5lrA5t6EQw7TbjMUwXZ6p+7JhjGrvjlwgctmQK8e+FGgeRKbLPEfjO+SvNo51d1Le3N+xhE3b75E6LAzhCyKITXbHaCM18f258BzmQnsg2zdPatkx4nBERFvpL1l+lOUDFdI3XH7ckseXNxm2YylSU6Sf1uv1PzIvOhU=
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update global configuration logo image</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/issuer/global-configuration/logoimage"}></MethodEndpoint>



Uploads or updates the logo image of the OID4VCI issuer global configuration. An organisation has one issuer global configuration, so the path has no identifier. The image URL in `credentialBranding` is a public URL with the `globalConfigurationId` of the configuration.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"logoimage"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"format":"binary","type":"string"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Global configuration not found. The wallet makes the configuration when it deploys the organisation wallet, so this error comes only when that step failed. There is no create operation: contact support.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-global-configuration

---
id: config-update-digital-wallet-open-id-global-configuration
title: "Update global configuration"
description: "Updates the global configuration of the OID4VCI issuer. An organisation has one issuer global configuration, so the path has no identifier."
sidebar_label: "Update global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztXN1y2zYWfhUM96L2LCXLtpw02k5nHdvpqk2bTGwnF6nHhIhDCTEJsAAoWc3oefY99sl2DgBSJEXZTv8mbZ2L1hYJ4JyD8/PhfJA/Bgx0rHhuuBTBKLjMGTWgiZkBmaZyQlMSS5HwaaEovkJkYp+9Gp8O356MCde6ANUnx4JINaWCa/fajGoiBfjnnVOFREs7V07NzA4QknAGwvCEg+r/KH4U5yAYkSJd2hcTDilD2aghS1mQBRWGGEniGRVT6JNj98b6hRToHIgsDLkByDXhRhNtpAJG5jQtoE8uZkA0qDmPwb+DC8WFUiAMSeVUEioYieUcFOEZnQJaIIoVWEFp+lxRwbiYRqF9kRvCp0Iqa0KpgZiFJJdvXmrChZ1awU8FaEMmki37QRjIHJw5xiwYBc5AbhNO+ZQbmr6jaQrmVQ5izL6xZjypWzEIAz/lc8mWweij/ZUrYMHIqALC1gajwrgpVMSouTFcTHXDiGlaGpoqINIOpOkvsW4QokIGhEG5aJ6nPLZC733QKMzHQMczyCj+ZJY5BKNATj5AbIK21KeQ0CI1HZInUnU65BmNZ2S9TYRBwgW3vhlTQXA/FWdQ38qz25z7vRCndKkju6P1veZ2q78HM5NMR9ZDf0Nz4XR1f6Tpgi41qqq7PK6P3tkvFN+Us3xjQuObqZKFYGN0XfcyNxrS5A539ep0OSy5xHdm4CLDxcNGfJQeXXMrHJOhP+QKHxsOGjd9u+1rLiGKbAJqq0tANZLkoLhkZIcLwuhS71rnoGla8wPtHISRQjBAz+G6mZX6ZCwYn3NW0LTbf3TTgewUHdmk0KDJ4YAsZiDs/k/5HEg0iIhU3hfsUOclsjBoHrilWZ5CMDocrMJgc0cfHimM6zylS7I2eJm6a0rFVDHc54XNMeRyrDf3SNAMastqo1CO+5bFUdb8DdPXVwoJ1UTnEGO2Z6W3lWF8shZy7ErI92Aoo4Y2zBScZXkqlwDkOWVTCFZhkMqYpg+Q+PnJ6+FTklIxLdBrDZ1WuaTDdjvQn/ZJBKL3zfNotymD/RCXbizwUIvNioyKngLK6CQFUntpw35eLtjYs1UYrEP9RKZSfcL6cEtiHEJiyaCyQdtL1vOXtvjHC/uvbQ3/Mcpk4Nb8BtLArSFSdEpVijKw/zZEcR8Hq1UjmN64jHYmYrW067+pKmYl5kTKFKjYkPMdRnOEhTUKrUR+G7JCGwJuRufIWLBPrQJvQfGE2909qe3muKxlO97pd+te74UkheZiamd0le0LXS6DHnIDy4bKKNgqDGhhZlLxn2mpHaqLeXJZU5ELA9OOxHrBM+gZ2UsxX2Eu1RBLwXw6rQfpcX2ZUuI+OU5MmVpdRg7beyeTBJTL3KBbea+V+BoltyY9VYout7qRNZCcKprPeIxWIhM3EcncTK4sr81K8mKScj0D/QmZyOb7lGvEJYQSA1meUuO8VsBiW/mQiS1KiVQZNdrCYG7Kao84OIqlhusbWEYjK0oFCBirP3SlxZQyMAkIoQ2ZYW3hpk8iUaSprTfR+6vIgQ0HcJm3U8Q4G+FcIYk+LG5KJFGu0CfvyurVVbHcvtYxDNGGLjWCn27otYbYqkgtlEYU5CwxIlGm5XXGZBy1zGCPACGJWPxPzXofFsYL+mFhrufxNaLJyKldKWS1RpVC/GkizcweUgpxI+RCeGmxJGsSDQeDiOxEYzGnKWd10Ztes6N3R+T9V3as/vrKpRtuINNdCQ5EkQWj94GXKAiDD4sbC4mdVsHVqub497xXz146l0LDWBhQc5rej5S+54JnRUZymaaoDPcju4PbJzTrW+vkU0bDKSSgcLtrYXEmWC65aAKYo1UYCIlHOQf5y5fOBCZCdj+QOZHCKJnqxvI/1Gas1sUsUyIJ/2gOSlswdw6G0PJXxKMud+NPPuLt/FBOhVZwFvAporCAl5pqyg2AxBRNzPX+4S+pHhvJBz/sVrJTstIuVgayf2ihgBfo6DMQ6Kgu0NPPQKCnfYcG3LRlJr/fG8/5VGAsbD133g1Ymx6j+VQAK59vRsSvM852SRBxU+JWJ9++u2gEbEJTDTbT1Ernd7AcVx2ZriSHFQbF7242fAfLWkenPIBgObb7g5LcJzOGMKZ6V8psVoo67RdhEY6sFpH1urYiL2yV+XQl3LhSeO0d4QaWoXUCb0AS3XBWlVEsPrdHg2fRLxO/cZCs6no8g/imft50rkzjGLS+kDcgXvIEDM9gLM5dWn8A3PuPXJBUiimhgripiMG5nMJcl07mVuXMCeerxBRjjVqwg92+BTczW9EVJAowt+JMHQCvAVBPJAOHTj9F7nMX5kDMvXi1sZo7WOy8eXFCnjwdPiP/+++wv98/2O3ArQ624useqrpeBxXYqUSbgSITfOiaHMz1G7YqzXKZPzzYL9aC+54qOgRWuiLPpTKanL6Wr50iz4bDZ7sOK2ZlrCMm1ATXvPY+e03T6bUDL9d+EmBWJWuk+t5zTSb2rGdkFbI+ANzOf+GXz5WUSZ+8ShIyWZaw0sNGmSQuTbk5qxprHUqT50AV2hsf6j65KJQNLI6hhggZu8OFsng5If6IZhftTFuo6Cec476nNz5drtWo2ZJkVDBqpFoSf0yY7/cHLUVG/nffIdPW/bG/R/182BBUgPUEWJ/8AMA0cQ5gV/2X1a/UWTRUFvUX++QYe6fof6bu0A2/CAnPMmCcGkiXnSYSUsS/b6DF13aNssfmncfnCi+7tdmee6+05LbY82/Vgq995C67k5S4hINZaAKJVHgCsqGaKzl3DpxLrUGXIK4RnHUkfndb8nCwrS/nGmXtjlTbmtXjCT7GoDrzBeRVjT8JOho6VWel0VhZNzke2OJwJe6uDsHhYHDXEfyuk8rdB5WjLty1BQxZp70bjWBN3V7m8enK/kOGxIli3f1gMLCwvZMWAUUKy76wrRTYJ9EaTeA37eBvOkXppN6ojxHwIqIgbdTaXI+z+ztvbyCW2AXegGmdujeQSeaTaAlIHL7hhmg699lV2dn7ZGzskd4iKGwNu/fxkN9hkzGLmo28J0+OkoPJl/Ezus+GMBjsH9DJ4TBm6PSd4+9X+1LwnwroUPsOxvLX0ZzY4rU5zO1enSdh0gI8d9Zcw7u6CSZP2X4ypAe9L+ND6A3ps/3es+TooDdgh/ETeEr3J8MjNIe0RGE9lzzEGuMNM/j+pc+1DDBrZciJWuQ+k46I3WBPmmnoL87q1Okx30qq0Tt6zVl/PvQO6SAYFTjQYXV26/4ZaKA/iutpmExm3Oh6G7RMeS4ihKyOZo900GdLB6HjTOX9wfYSSW6b78q2kp7JxZbFm37iSPuKnF+T7GXp23IdpBl0heIPqGRvXpaxX7b1LTu/dg889DaF1XelBQ2li+PUHsQ3yh7OX10gcIdfp1ttQBO7uJs0FsBQQYo8lbQ6H9TuElQ10ToxTc0F3Ha2bJomOE6N84vSXddThpiy/cncnnD5hKfcLLF5Etbuyry3xl6vedUIInt94n6Heb6OCqfPn9F5Jm0lmnnH+U+3+a7aH9qq0VxzMzfVM4MPzU3bt0mQvxaF+8jZ/vGcbSfh6rLaupHTIDe5JXrv5UzHn8YHjwhsv6u2JkxLIzQ400cC8vcjIM9ncuF4nsWMx7NKgk6mUX8iWfUQVLlZRdsg85GKfKQidftK9n3J77d2us+Hzfwc2cv7Le41qIgbbhmPz4nCfDAb2QR/3Y5x9UhZPlKWj5TlI2X5SFn+KsrSQnIkqo7N/Qj8UvBbawxtaJY3LeHLfrtlThZUE79EY/H9p8Ong/39J1YGT5b9njKkVBuSSWYbxNskaZUezoJtzNAWiuRO2qKzV/+wfsSdB/s7Ts13nrjqe1/fg43+SxfheNVmDS0KnQFloDC48Leh40gfTHPW1wSlpMICiVuFP5/W3GBj8TaaXI/uCvNq64fW+zam7zoFV/3f5xQ75XlhSE4VzcCACjxBvFnHGv1OrsuLw2EHOcYdIHIcGbAQL5y6foF74G4V72gAEnnQ/pIjFIzKAmWpwar3uWuvLNcQcUwFzqPdDWzYpKPbm7f/N968S1EGnI2+tmmGf2PTfNN1qwA9K0Hg1EDJWQU2WgnZ013O2fUmNeDGe9Kba2JVIbHMkKHEL/L6VI8HKAM5SShPwa2tfMT4qrMOiBEKYWhsSiC56fNHf+uEZQuDoGmJt+0yLRutwkBDXChulsHo/cfgOOffAf54tUId6dRe7fFfOibuW8dkx2W64duT3SAM3OEWTeKakcEoyAtrEWpmwSjYmx/sOXfZY26ennOHPSy5nO25fLbnqlIvbn2P2QmvrXTtFnEmvW5Y71QajIKZMbke7e0xyGSP5rzPp4oK0+cyWIXtCV4ryYq4Bj03prlvhnNDp67r0jlcu8dtQa7WRj9H33MuU5p+3Rh3H4QBx6XcruGh3t0oa7TsN7mv12MLFTHrIVyIaxd1XBnyRSZqzBMRt4zDpBMguYKE34JrfpPIyUgisiOkcWXHKMpt/1bnNIbdkDi2tTHtiPiBXy1lodAcvRtYfh257gDG4Zv1t9XPHq/c/QWv3KEXJ7LMxjS22RgyyjFefAL/9zpGKjfn36w/agZXPS5be1sNsocmzvDMhdUmT8EA4fh/vLXU/NsVv4TXw5Nc98DXCnS1RJUwX++iREbGMrX0OtcEIxWssbWvmT+vvydvdym0zVbHQc1xhSXxibRx8cOxItrggV8x3bP6cvxjGEmKnIWNYG9pK+27wxPy9oTsfPvuYjck47OLF+T8tPftuwvy9sStNj5/Rfa/HOwf9o5Idirjvez0ZZ2S8l9WxMKb8hiEhlr8Hec0ngE56A82tm6xWPSpfdyXarrnx+q9l+OTsx/Oz3o4Bq+GcJM2fMAai8m4qHYvCAPPtQSj4GBwMOwf9vdxbC61yaioyeP+fkbnbbx2cqhBhse/feLw3h/3t0989cPUupenlAvcTus/Hz2keB/MD9x124TbywsNWOHP8vaw74xdnfpb4OIqDGZSG5zw48cJ1XCp0tUKP/6pAGVRUBjMqeKuh/7+qjoRWzSCidZ9IxGE6V2g2Ph6Wrji3QKaCB7ciOM4htzc+W4dTL2+vMAq5P+OS2YxZaDoAv/GC10Eo+DH4MfAKm3ThsWx+PnHoLzaFowCN+3Kd6ybIMNVEP8DKlY+EsuakG284XTB/6JmnUO+wnD9DpZfV6+7J1sHVBjHvY1bf7Varf4P1Certw==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update global configuration</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/issuer/global-configuration"}></MethodEndpoint>



Updates the global configuration of the OID4VCI issuer. An organisation has one issuer global configuration, so the path has no identifier.

Send only the fields that you want to change. A field that you leave out keeps its stored value. The service keeps the current logo and cover image of `credentialBranding`, and it ignores those two URLs in the request body.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The issuance settings to change. All fields are optional. A field that you leave out keeps its stored value.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"credentialExpirationInDays"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Default expiration period (in days) for all credentials issued under this configuration. Individual credential definitions can override this value. The service uses 30 when you give `0` or leave this field out.","example":30}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialBranding</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Default display properties of the credential card in wallet UIs.

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default display name for credentials in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata.","example":"Employee Badge"}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties (e.g. `en-GB`).","example":"en-GB"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default human-readable description for credentials displayed in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default hex color code for the credential card background (e.g. `#FFFFFF`).","example":"#FFFFFF"}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default hex color code for text on the credential card (e.g. `#000000`).","example":"#000000"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialRequestEncryptionRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet must encrypt the OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Request using the issuer's encryption key.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequestExpiry"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Time-to-live (in seconds) for the OID4VCI Authorization Request. After this period, the credential offer expires.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Default cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. The list is a template for new credential definitions of all formats, so it always has `cose_key`: the service adds `cose_key` when the list does not have it. `null` or `[]` stores the default `did:key`, `jwk` and `cose_key`. When you leave this field out, the stored value stays. A credential definition keeps the rule of its format: `mso_mdoc` has `cose_key` only, `dc+sd-jwt` and `jwt_vc_json` have `did:key` or `jwk`, or both. An unknown value gives `400` (`Invalid credential binding method(s): [<values>]`).","items":{"type":"string","enum":["did:key","jwk","cose_key"]},"example":["did:key","jwk","cose_key"]}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint.","example":5}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>notificationEndpointEnabled</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Controls the OID4VCI Notification Endpoint per specification version. Set a version to `true` to publish the endpoint for wallets that use that version.

</div><SchemaItem collapsible={false} name={"draft_13"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 13."}}></SchemaItem><SchemaItem collapsible={false} name={"draft_15"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 15."}}></SchemaItem><SchemaItem collapsible={false} name={"draft_17"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 17."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerMetadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signing settings for the OID4VCI Credential Issuer Metadata.

</div><SchemaItem collapsible={false} name={"signedMetadataEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Credential Issuer Metadata as a signed JWT.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that signs the Credential Issuer Metadata. Send `null` when `signedMetadataEnabled` is `false`."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `kid`, `jwk` or `x509`. Send `null` when `signedMetadataEnabled` is `false`. The service does not check this value."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"accessTokenLifetimeInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"How long an access token of this issuer is valid. The wallet gets a new one with its refresh token.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationCodeExpiryInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Sets the time-to-live (in seconds) for the authorization code (RFC 6749 §4.1.2). After this period the code expires and can no longer be exchanged for a token.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"dpopEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The authorisation server supports DPoP (RFC 9449): the metadata lists dpop_signing_alg_values_supported and the access token is bound to the key of the wallet's DPoP proof. Off by default. When off, the token endpoint issues Bearer tokens. Turning it off also turns off Require DPoP.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"dpopRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Makes the DPoP proof (RFC 9449) mandatory at the v1.0 token endpoint: token requests without a proof are rejected. Needs Enable DPoP; turning it on also turns on Enable DPoP. Applies at the authorisation server, immediately.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"nonceExpiryInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Sets the time-to-live (in seconds) for the c_nonce issued to the wallet at the token/nonce endpoint. After this period the nonce expires and the wallet must request a fresh one before it can prove key possession.","example":300}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The issuer updated the global configuration.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>globalConfiguration</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The global configuration after the update.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Record identifier of the global configuration. The service makes this value when it saves the record. It has the same value as `globalConfigurationId`.","example":"665f2b8c9a1d4e0012ab34cd"}}></SchemaItem><SchemaItem collapsible={false} name={"globalConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the issuer global configuration. An organisation has one issuer global configuration, so the read and update operations do not use this value.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID wallet deployment that holds this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"credentialExpirationInDays"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Default expiration period (in days) for all credentials issued under this configuration. Individual credential definitions can override this value. The service uses 30 when the request gives `0` or leaves the field out.","example":30}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialBranding</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Default display properties of the credential card in wallet UIs. The service always returns this object.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default display name for credentials in wallet UIs, as specified in the OID4VCI Credential Issuer Metadata."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"BCP47 language tag for the display properties (e.g. `en-GB`). The service omits this field when it holds no value."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default human-readable description for credentials displayed in wallet UIs."}}></SchemaItem><SchemaItem collapsible={false} name={"backgroundColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default hex color code for the credential card background (e.g. `#FFFFFF`).","example":"#FFFFFF"}}></SchemaItem><SchemaItem collapsible={false} name={"textColor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Default hex color code for text on the credential card (e.g. `#000000`).","example":"#000000"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logo</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Logo that wallets show on the credential card. The service sets `uri` and ignores the value in the request body.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the default logo displayed on credential cards in wallet UIs. The service sets this URL to the organisation logo, and it changes the URL to the configuration logo after an upload to the logo image operation."}}></SchemaItem><SchemaItem collapsible={false} name={"altText"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Alt text for the logo image, used for accessibility."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>backgroundImage</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Background image that wallets show on the credential card. The service sets `uri` and ignores the value in the request body.

</div><SchemaItem collapsible={false} name={"uri"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the default background image for credential cards."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"credentialRequestEncryptionRequired"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet must encrypt the OpenID for Verifiable Credentials Issuance (OID4VCI) Credential Request using the issuer's encryption key."}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationRequestExpiry"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Time-to-live (in seconds) for the OID4VCI Authorization Request. After this period, the credential offer expires.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"credentialBindingMethods"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`did:key`, `jwk`, `cose_key`]"} schema={{"type":"array","description":"Default cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. The list always has `cose_key`, and without a stored value it is `did:key`, `jwk` and `cose_key`. It is a template for new credential definitions: each credential definition keeps the methods of its format.","items":{"type":"string","enum":["did:key","jwk","cose_key"]},"example":["did:key","jwk","cose_key"]}}></SchemaItem><SchemaItem collapsible={false} name={"credentialResponseInterval"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Minimum polling interval (in seconds) for the wallet when using the OID4VCI Deferred Credential Endpoint.","example":5}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>notificationEndpointEnabled</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Shows for which OID4VCI specification versions the issuer publishes the Notification Endpoint. The service omits this field when the configuration holds no value.

</div><SchemaItem collapsible={false} name={"draft_13"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 13."}}></SchemaItem><SchemaItem collapsible={false} name={"draft_15"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 15."}}></SchemaItem><SchemaItem collapsible={false} name={"draft_17"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Notification Endpoint for wallets that use OID4VCI draft 17."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>issuerMetadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signing settings of the OID4VCI Credential Issuer Metadata. The service omits this field when the configuration holds no value.

</div><SchemaItem collapsible={false} name={"signedMetadataEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the issuer publishes the Credential Issuer Metadata as a signed JWT."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Key identifier of the key that signs the Credential Issuer Metadata. The service omits this field when signed metadata is off."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Format of the signing key, for example `kid`, `jwk` or `x509`. The service does not check this value."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"accessTokenLifetimeInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"How long an access token of this issuer is valid. The wallet gets a new one with its refresh token.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"authorizationCodeExpiryInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Sets the time-to-live (in seconds) for the authorization code (RFC 6749 §4.1.2). After this period the code expires and can no longer be exchanged for a token.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"dpopEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The authorisation server supports DPoP (RFC 9449): the metadata lists dpop_signing_alg_values_supported and the access token is bound to the key of the wallet's DPoP proof. Off by default. When off, the token endpoint issues Bearer tokens. Turning it off also turns off Require DPoP.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"dpopRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Makes the DPoP proof (RFC 9449) mandatory at the v1.0 token endpoint: token requests without a proof are rejected. Needs Enable DPoP; turning it on also turns on Enable DPoP. Applies at the authorisation server, immediately.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"nonceExpiryInSeconds"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Sets the time-to-live (in seconds) for the c_nonce issued to the wallet at the token/nonce endpoint. After this period the nonce expires and the wallet must request a fresh one before it can prove key possession.","example":300}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this configuration was created.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this configuration was last modified.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"globalConfiguration\": {\n    \"id\": \"665f2b8c9a1d4e0012ab34cd\",\n    \"globalConfigurationId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"openIdOrganisationId\": \"string\",\n    \"credentialExpirationInDays\": 30,\n    \"credentialBranding\": {\n      \"name\": \"string\",\n      \"locale\": \"string\",\n      \"description\": \"string\",\n      \"backgroundColor\": \"#FFFFFF\",\n      \"textColor\": \"#000000\",\n      \"logo\": {\n        \"uri\": \"string\",\n        \"altText\": \"string\"\n      },\n      \"backgroundImage\": {\n        \"uri\": \"string\"\n      }\n    },\n    \"credentialRequestEncryptionRequired\": true,\n    \"authorizationRequestExpiry\": 300,\n    \"credentialBindingMethods\": [\n      \"did:key\",\n      \"jwk\",\n      \"cose_key\"\n    ],\n    \"credentialResponseInterval\": 5,\n    \"notificationEndpointEnabled\": {\n      \"draft_13\": true,\n      \"draft_15\": true,\n      \"draft_17\": true\n    },\n    \"issuerMetadata\": {\n      \"signedMetadataEnabled\": true,\n      \"cryptographicKeyIdentifier\": \"string\",\n      \"cryptographicKeyFormat\": \"string\"\n    },\n    \"accessTokenLifetimeInSeconds\": 300,\n    \"authorizationCodeExpiryInSeconds\": 300,\n    \"dpopEnabled\": false,\n    \"dpopRequired\": false,\n    \"nonceExpiryInSeconds\": 300,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the OpenID wallet is not deployed, a value is not valid (see `settingLimits` of the read operation), or the issuer cannot save the configuration.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Global configuration not found. The wallet makes the configuration when it deploys the organisation wallet, so this error comes only when that step failed. There is no create operation: contact support.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update holder global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-holder-global-configuration

---
id: config-update-digital-wallet-open-id-holder-global-configuration
title: "Update holder global configuration"
description: "Updates the holder global configuration for OID4VCI and OpenID4VP flows. An organisation has one holder global configuration, so the path has no identifier."
sidebar_label: "Update holder global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWVtvG7cS/isDPtnA6mrZSYSiqCu7qdrg2PAlfkgMiFrOSqx3yQ3JlaIa+u8HQ66kXUm+FDkFTpG+JPIuyZn55vLNcB+ZQBsbmTupFeuz21xwhxbcFGGqU4EGJqke8xRirRI5KQynlZBoAxfDs97HwRC4EnCRo6I/LyFJ9dw24VSBNhOupA0bptyCVs8eGoHVXnDO3dRvUBqkQOVkItE0P6vP6hqVAK3ShV+YSEwFKcsdLHQBc64cOA3xlKsJNuE0rNgsSJHPEHTh4AExtyCdBeu0QQEznhbYhDMNSjuwJGekijQdeVtHtshzbdzAoFeIp+cqNgsP26jvlZnzNEUHXNk5Ggu/3txcQq/dbrKI6RyDiUPB+iwYHZA+kxPpeHrn93oQxa8eofceoEEVHxYxg18KtO5nLRas/7jlu5spgkXnpJrYb0OhlCQNCtZ3psCIlHaoHEnleZ7K2KvU+sOS6Edm4ylmnH65RY6sz/T4D4wdi1huyHon0fp1T8NY2TzWOkVOBtctvJuighEpNIpqmMcx5s4ChsNQrGNzIwiu0OZaWbRkHn7lWZ5isG5J5iYG7XSz/NpxV9ihcmhmPK3oJpXDCZod3VZLQSqwGGslLIzRzREVuLmGeKOJwZkO+IH1YiCeYvxgm3BrEUbtEXnPOp17G3nhdMadjFerquofnbTbXn0hDcbu1lRVtc5INdnR9KpcDLdXH0JQVKCkwLdkAz27OC3cFLrNNtAPbeSfQeurEIYgChKwBrtiorS24CrGmrJs6lxu+61WkNUsXzRjnbVinqZjHj+w5Tr2Lgs7RVGTXAq23xArhUULHMLhT9h1cHl6dejz3qNQmldfO9ACfbFrsuVyWbHyhSAP6fRivJFjt/z6Kvheh17CU4tLr7dZpQVp3m2399eVFXi+aImX6IG8/j8qGJM9dZCOTNOLhPU/7W6v6/5+H3nppGpAiSYMnX8SuG9TRyk/cIZm8QzfrU6sMV5Rlpq6PVK8JkFjbUSF+rY03gs5hPJvZjJGyPiDJ3FpQ0WHOWWDdGD5rGR344UEs3lpNM+wXM8tjKZPEdFQjOp5fXJynHTHb+N3vCN62G53unx81IsFJfMzp7yMxK2SXwr8q0h8S+9hkAvv4RDqsKZuCyK0BoXFCrJ1IMZvRCfp8W7jbXyEjR5/12m8S467jbY4ik/wDe+Me8cEivZMf1FR8jVoDHdgEKF9WKWnwDzViwypC6K4XcWztNv5uYz+peLnqZhomDjY7idhn24CE16kbqu8eIZ5e9Jrt+GAws7vAOTxFARfHNZs9sv+rwkc7srSIS1glrvFLptS/6jnClYkRHr9c4k/gqtfBvCu0z15fQvgo4FKR7SqG1RCUmldtYDEXIFBV5jgnFBpE6MzGGOiDfqnKbcrnm3CNYaH28Wohm4g84jFBomcT10FJFVk4z0ZcqvkV3AyQ+t4lsPBJlEOA1Xs1gyYcwuliJr4zpvem3anExrRskH4O3XwAGVaUCF8UpNldYL5RKz7PBM9UZKfr5Iv16p6Yr8qwKt+rOJ5v7zfRvDmhSGdJw5NJX6oU63jsq+7uvdt4RS5QEP5Rn/1Ql/46p6uKgON0YZShVxFv88qRtxHL/R/m9376v7a9aGK7hy/p5RuitLPXIBUeeEg54Zn6NBQK0/27uJcayikhUI9KD1XtQojrW8QAgujWFeP6t7o+asEOiNcO0SgDfCySJQnz3gqfchve6fzHXvnVvEykVDsgab3HUOzd/qhQEp0oURgrTJ2VxMDblfckv1DUNvdMSfsL/tn6hHIFIh1hjZc1JW1nDuwDnNIuEwxyDZlYJe0sqG3PinheOygzJXdmD/+riuSJxjFUz/woQmgb2FELT7GhZFu4Qfl01z+jvTTM4njE0tYlBeQEG4g4WA12A4OWcTCVSRBkqGbarq8zAuPCHdT1metWbcVwqVVTiKNEA4tYlMpWoGdWoFmGvHWbWZQ3nrt6vadYaZL24gEa7cfAjPd4LlsyonhyjWlZsto+4BLo0URh75+/zEvnXDt+IR64ye22/B6W5H7DejXFHshZFbQr33Pw4OISRIVvMYipnhGb2uNwU7fdHo5hAdc0EgyJf6IK/N/YItyOBzVzhlBEANZYR2MEXKDifyKAubSTWEUdIQRHCjtQtfpDJepxyDnMR5GgM1Jc+vYPpQbf1jowhAcjQdc/DgKvQbl4dXmzvr8n3RHVo6jUiV6VWl47CsNZlySrNKGnzb+X7tQvt88qgdONea2PLveBLnRMyn8vBJrMsAhSPqfZvvaJVbIV99qfEQjE8nHKVZmbQvDcpKDg3KKOazcYG1vvDRo1yLWxeDykDRyOtapn3ylBYpCVLTHlnzwZznlOO2HR4x8bxp5YTOSsFhfV8QV9QrrI8xxJbgRtuHtlfQhx39JCtFZIu21vTsawMcBHPx2d3MYwfD85he4Pmv8dncDHwdB2vD6Ajpv252jxjFkZzpuZWcfqrNtok3Gnb98SGWMyvqIXCVfzuMp0sy847r5fN7k/nVTm0mr3GtbH4aD8/9cnzdozzJiTrq0FgMeLKHjYu09FjGqfMHt3Xa31zxqdmhvrq3LuKroE74TPdfnb1eICiv++z3vb/meV1Zxh19dK0+5VOS6IlzdBGr8xGbdcAmeSH+BU6PHctysTKUsYntJ8p4WWEcHPj6OucVbky6X9PhLgcazecRm3Pjs9dy+agI8qz4Q67BBCIfGDalNy9MikNBWw0QkGHac+lu8Z9dWm4LL2xsWsXH5VTLzvREzfE6Vls9Zn31mn5k32pcI34/R80eWcjUp+ITWh2OJNYjZ6mT54Mmy/FG59edqUVFymzeDLfQvWbZ3yw+Umr/j4sf18vDmyQ1rrg6ryfU0MP8X2mMP4Q==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update holder global configuration</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/holder/global-configuration"}></MethodEndpoint>



Updates the holder global configuration for OID4VCI and OpenID4VP flows. An organisation has one holder global configuration, so the path has no identifier.

Send only the fields that you want to change. A field that you leave out keeps its stored value. Do not send `null` for `supportCredentialEncryption`: the wallet answers HTTP 400.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The settings to change. A field that you leave out keeps its stored value.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"supportCredentialEncryption"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet accepts encrypted OID4VCI Credential Responses.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"refreshCredentialStatusInterval"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Interval in seconds between two credential revocation status checks. Use `0` to stop the automatic checks.","example":3600}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URL that the wallet sends in the OAuth 2.0 Authorization Request during OID4VCI credential issuance.","example":"https://wallet.example.com/callback"}}></SchemaItem><SchemaItem collapsible={false} name={"requirePushedAuthorizationRequests"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet uses a Pushed Authorization Request (PAR) for the OID4VCI Authorization Code flow."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet updated the holder global configuration.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>globalConfiguration</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Global configuration of the holder wallet. It holds the settings that every OID4VCI and OpenID4VP flow of the organisation uses.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Record identifier of the holder global configuration. The service makes this value when it saves the record. It has the same value as `holderGlobalConfigurationId`.","example":"665f2b8c9a1d4e0012ab34cd"}}></SchemaItem><SchemaItem collapsible={false} name={"holderGlobalConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the holder global configuration. An organisation has one holder global configuration, so the read and update operations do not use this value.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the digital wallet deployment that holds this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet accepts encrypted OID4VCI Credential Responses.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"refreshCredentialStatusInterval"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Interval in seconds between two credential revocation status checks. `0` stops the automatic checks. The default configuration uses 86400 (one check each day).","example":86400}}></SchemaItem><SchemaItem collapsible={false} name={"redirectUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Redirect URL that the wallet sends in the OAuth 2.0 Authorization Request during OID4VCI credential issuance. When it is empty, the wallet uses its own callback URL.","example":"https://wallet.example.com/callback"}}></SchemaItem><SchemaItem collapsible={false} name={"requirePushedAuthorizationRequests"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet uses a Pushed Authorization Request (PAR, RFC 9126) for the OID4VCI Authorization Code flow. The read, update and list operations can return the value from before the last update. See the update operation.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this configuration was created.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this configuration was last modified.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"globalConfiguration\": {\n    \"id\": \"665f2b8c9a1d4e0012ab34cd\",\n    \"holderGlobalConfigurationId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"openIdOrganisationId\": \"string\",\n    \"supportCredentialEncryption\": true,\n    \"refreshCredentialStatusInterval\": 86400,\n    \"redirectUrl\": \"https://wallet.example.com/callback\",\n    \"requirePushedAuthorizationRequests\": false,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the wallet is not deployed for the organisation, `supportCredentialEncryption` is `null`, or a value is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Global configuration not found. The wallet makes the configuration when it deploys the organisation wallet, so this error comes only when that step failed. There is no create operation: contact support.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update notification
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-notification

---
id: config-update-digital-wallet-open-id-notification
title: "Update notification"
description: "Marks a wallet notification as read. The wallet accepts only the value `read`, because a notification cannot go back to the `unread` state."
sidebar_label: "Update notification"
hide_title: true
hide_table_of_contents: true
api: eJzlWG1vGzcS/isDfrKB1Ztf4kQoinPt3J3aXmLEdvIhNU6j5azEepfckFzJOkP//TDkStqVlDjFocABzYdE4XLImWfenuGzkORSq0qvjBZD8S+0jw4QFpjn5EEbrzKVIn8FdGAJZRfuZrTegGlKpXdgdL4EPyOYY14RjHnjOIEJpVg5AmyflKLWxsPUwATTR/AmiI4rHcTAefTUFYkwJdkgMZJiKFKjMzW9LyV6ulZT5TH/FLR4X5IeyXeNG0QiSrRYkCfrxPDz846Z91p9qQiUJM1CZMFkgBrej67PPl6NILUUPmEOucooXaY5tUyIIERji8p5mLCR9/eja9Zb8R0l+plIhMaCxFA0hUdSJMLSl0pZkmLobUWJcOmMChTDZ+GXJUs4b5WeikRkxhboxVBUlZJilQh6wqLMec8r2cdBdkqdk8lF2jlLX2PnTTYYdE5xcp6+khf0OnsjVg/xNnL+JyOXfEUbjXe0CJ4NwFcOMmODQ1oGH1A5NdqT9nwglmVe7+z97vjU532LzOR3Sn3roM8i3ikeElFa9rdX5IJ0XD+Ax77ytd4m21f7q8EaQxRQS7CUVY4cYJ6D8TOy0bGObSZdFawm72Ylt9iHlVX4wxa50mgXVT/p9/dBbuhRoH0kuafrJsHE/wBtG8Tm8eGsPH+fhXzYlWsre3mwAHBcvJQkNCftu3uKKPmyJw8m5aE4/KPxn7RwuAtKvKQM71rfvza4BUY0FMZbFP5dkpZKT8dwJCkja0mCcq5CnRIoDaU1U0vOHSctKUwfSY7hiG+amVySBUwftVnkJKd1mGy37whbmputON9GFurFb0vSU8kpWEs2fFl/OG5G/76RHKM7NrSXaiXai/XZ7UTaO+eAwz5Qjp7k6DvCaLQXP5acqWxK4Gfo99NOOcCJqXwSArzWawe8RlS2I3ByIQfZGZ50Xqen1DnDN4POm+z8pNOXp+krusDB5Ox816CrbXK3Vb/BZW5QvljIpmrO5UoDWotL3h7z2EULOYpiR90aMG55/yq00io2Vxer4DhGzxgkeVS5a7Y45WCsqzwfw2JGOpxdq8J3OdAGyqh7aNua2lUmqMl90VPhDlUtlFKxKpjfNMoGd5nVKvlD2x9WyXe3jg+NnncQ8kvQtGgHywxd2FiLrTlLBKsK3AQ2tAUc+dZ2bzbUiCF/kRZtjt/tRImIX9qZVK+tQs5xvlz6Bgq6KiZkD5XdJ/CqIOexKOFIsdqp0dIdb73d0nOBDuoLWskwuDi76A8Gr/r9VSIiFn+iBjk6D4WRnJRf1WPVJhuKkdtrBt8qN4czdxNjTaSbNj8w6dohKq1Wn3mKJCvKdMWuqq3W/RBIxoxQBj77zP87iyzju5lC83Cy1tgrI9n28Pu6oepD8gKr2EpvXau0p2nw7cYNZyEO9o4/kJbbCP4JJShdVh42/F3UFGufTrVCYnTNVarS3Dl1AjWFrfNOcYnyde5xrOxCOfgLQ3mvsfIzY9V/QrtuQ3P+l46ykfZkNebgyM7JQrhmByNuOJRWVvll6HmXpfqF+GeoAR6nPICKemCFOLHCUZhZmVYei0T8M9A+hqQgPzM87JZVQIRnyKHozU96cfrtyXhOJ7bfnilJK9lrZkLvuT1rrrhaBfUPTcLXVJjaOi5gNhdDMfO+dMNeT1JhOliqrppa1L6rjOBuvMNZrJFVWne7g8e8dMKtx6nS06+Ju/h5V5GHLey3HH0xaNbgb6lHXKhn8ui37VR+WQf++tFgZwq6GcEjLYHTg3nT/uhfs4Zx65wxxGs2DwOlpUw9kYSF8jMYRx1hDEfa+Eg0vUWVBwxKTOk4AepOuzvHDqEW/GFpKstwdB5p+eM4tg7OxA/bIf/tOta3g7RYcwOlM7POaUxDTlOBijF3VVka6/+2xXkDlfrHdqntoKZvdxDcCPHwM1eSWSukhlXzBIr/LUj7WMHX01bIjMDFP5JVmcJJTnC14a4ORuuh6qiezI4DmzoseGPJba7YpN3NMWvkTWoi0VUO2NukWcaBsVPUNe6BtQVunAS2G6nbnG9YQp2OjUnBQeWCJz1qiVa6TrBXofaQ5WbhYhTUSAdtP51ewccrOPr5091xAqO3d3+H2+vOz5/u4ONVvG10+x4Gr/uD0845FNcm7RXXvzank/hEFB4scpWSdsHz6yAvMZ0RnHT7e65bLBZdDJ+7xk57tazr/Tq6evvu9m2HZVaJ8MrnrRgIYEmTVhvviURwhYluP+mfnHVPuwOWLY3zBeqGPvEFr9W9d1Ov0XD+z54k67Li6cn3yhyVZhsDqM91tf4s5ifxBSdTYeZoVez4qqn3iKhIxHDnjfAhETPjPJ/4/DxBR/c2X614+UtFNnSYRMzRhjiPpV05/i3FMMPc0TdAPfpQ9+lj+JPfQg8Cti7OmitzkBRDIRLxyLV79600zHR15WYr46aaindqBr8+ZI+dcL+JEpchML65t9mBb+7vRCIm9YtpEYiIsLjg90tciKH4TfwmgjtDlQjkh9efRY56WuGU98djuUBzE2n3pcfQl+ofzWm5hcpui4q28N+Nybgt8gNn5y+0/HGzPX75qsCmLcbd7COeOP4LBDZqUw==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update notification</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/notification/{notificationId}"}></MethodEndpoint>



Marks a wallet notification as read. The wallet accepts only the value `read`, because a notification cannot go back to the `unread` state.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of an OID4VCI credential lifecycle notification. The value must be a UUID.","in":"path","name":"notificationId","required":true,"schema":{"type":"string","format":"uuid"},"example":"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

New read status for the notification.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`read`]"} schema={{"type":"string","description":"New status of the notification. The wallet accepts only `read` and refuses all other values.","enum":["read"],"example":"read"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet marked the notification as read.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>notification</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A wallet notification for an OID4VCI credential lifecycle event.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the notification.","example":"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9"}}></SchemaItem><SchemaItem collapsible={false} name={"notificationType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`credential_pending`, `credential_acked`, `credential_revoked`, `credential_expired`]"} schema={{"type":"string","description":"Type of the OID4VCI notification event. `credential_pending` (deferred issuance in progress), `credential_acked` (the holder acknowledged the credential), `credential_revoked` (the issuer revoked the credential), `credential_expired` (the credential expired).","enum":["credential_pending","credential_acked","credential_revoked","credential_expired"],"example":"credential_acked"}}></SchemaItem><SchemaItem collapsible={false} name={"notificationTypeRelatedId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the resource that the notification is about, for example the credential identifier.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>notificationContent</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Payload of the notification. The wallet gives an array of objects that hold the `credential`, `credentialConfigurations` and `issuer` details. The value is `null` when the wallet holds no payload.

</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`read`, `unread`]"} schema={{"type":"string","description":"Read status of the notification. A new notification has the status `unread`. The update operation sets the status to `read`, and a notification cannot go back to `unread`.","enum":["read","unread"],"example":"unread"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when the notification was created.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when the notification was last modified.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"notification\": {\n    \"id\": \"6d0a1f3e-2b7c-4c8a-9f11-3ab5c6d7e8f9\",\n    \"notificationType\": \"credential_acked\",\n    \"notificationTypeRelatedId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"notificationContent\": [\n      {}\n    ],\n    \"status\": \"unread\",\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The notification ID is unknown, or the status is not `read`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update presentation definition
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-presentation-definition

---
id: config-update-digital-wallet-open-id-presentation-definition
title: "Update presentation definition"
description: "Updates a presentation definition."
sidebar_label: "Update presentation definition"
hide_title: true
hide_table_of_contents: true
api: eJztXOtzE0mS/1cq+gsw15KNZ9iHbmPjPJZ3RsCAFxu4CSCkcndKKtxd1VRVS2gI/+8XmVXVL7Ukw3A3e7HMh7Gkrme+85fZfIpSMIkWhRVKRqPoZZFyC4ZxVmgwIC3HByyFuZACPw7fyrfyagmspJEMZFooIS3TwFPD5rAGzQqtCtBWgGF2ySWzS2CJhub4IZuEObOMX0M2i9ksTT5k/yxBb/CL1VwanuCmY275uDrC1aYAHJBkAqSdpJfJEnL6JRUaEnuhjH0B7vNLLfCBBlMoaeAXlbqByWkhXsCHEoyl5RiXKZvBxwISC+lzLRZCmhkdUiyk0mDYbAXaCCXd2UpjT2WyVBq/3ogU/5hEuZOF7ZpLy0RvCgvpC//sXCaveFaCuSyLQmkL6WzIrhRLllwugCkJTM2Jcu4AaYOqMUshAwv0eAejaFtPdGEZX3BRM8+AXoFmNwCFcdwptQZpAy/YegmSbVTJDMiUSVUziTP6hIfDMyZLrnliQcdM6fbDbMNMwRMwQ/ZSZuImyEAcZCdVYJhUlvGiyDaMs+8H1XIsF1LkZR4zoxhnJ40nbgthGE8SQJLSVY1FItENX5SZkzxLd/OXxU0EmNFbOaiumZfG0gmuoTo7zeOSwUcLEhnOkMB6hWSfK83gI8+LDNi90wWwV6DFXCRE/HsxuzdWSZkjIS/FQgq5uIdUufdEqvXgV1XqwVlprMpBs/tPfj17cG+Ih/lVlSzhEo/hCbNT+3oOVxowtExDe5iGIkPKu/sTZdj47J9P2Qd8PmSXyFV8Ni+zzP0Ys2tIeGmgSbOKQznoBcnRWthlc1Ulwe/eq3vEpixTaxqabZxg4XyYzyGxYgUd7cQZfrFpoYxFragPpGGOF8aTIC+aA4fv13YWKNFV795j9G2cTHkhZozWps9uWTZxunit0g1bckMq0bEqDbrRGfF7Zwuv0Z52GhKlU3fkrunB0+Rcptwq3Us17a7H7KYAOroRC+mMSEPmSUNaYrC9U7V443LEVbQVwtQm3gupAbtlfJlVbCbLLJt54UL69IzJ+Q10CIU08mwstUAORnGElo6Ef5JGoyhRci4WzjeNxUJYnr3mWQb2eQFykl40lKV2E1EcFVzzHCxoE43efOq6Oik+lMBECtKKuQAduLNX90wBCY42wanRdJ45c5txkRtijdCAdsCQmNIxxz+8umCrhr0YRnEk8CQFt8sojiTPAb/13maSRnHkF06jkdUlxJFBwvJo9ClCKYhGkbFayEV0e/vODQZjf1TpBkd057aJcVF77ENUCC6qJWjBScIK9IYpu6yjgA3eM1HSgrR4ELLDjgJH7w3u/mn7Iur6PSQ2iiMrbAZVYLLrVFEc8TSljzyr7xLuWjR++RSRmd8mWhzlQj4FubDLaPQwjnL+sfp2fNwl2DNYs2WZcznAIIZfZ1C7vj3kG7KXvb4Pp/R4v7BaJ3j6XKfIen2+NwhuZtvhf5GTf4q/er9b+ScTvCfjGrz5TofRbRxV7qqP7fu4uc0IbxPYWaWOhtHS7CmXi5IvgN1H9/cg+L+JZUuVpRjnzmodNjPGteabmGjnRBmk1RsmAXCwZDORuoCOs9lc6ZwH/xS+MZR0rTLD1kuRLNksB8tn7AY2phWMOMM8YrPcqGmeqmTGLL/BMDNVCVJjusLocEYkpoj1P0w6QF8Uxq0S68YY567qSWbmbjB7v7bTVTJFLaumNYfR4v78q2qDmM1WRbVbY6EZc5c0tBaZ+Op2DOOSLBuyc54sPdXUvEndqQFrZoGU6GMGkBd2w2aKeBmoXzseYlZvLOPZuE+s3eTtOLaOktDT3MbR3jyjz0xsyx/5YFTVeimWcsvrGLRp9yvXfS1kaobsBfCUzX46v2JHq5Mj5+uOUifSgzX5uSNVgBTpkUnfr+1RY5sBbjOo7YshHjk6kE3FYwGyBM+IlhhkmUejN1HBN+igprgAuUr6GsVRphZCTrUwN9PGRjsfTKWSU2senqDWJokqpZ2idBuDm7kQBpBq3PIpX2ggvzh1sU/4PRUmyZQpNfQN+QDGHfPdbRy1g4q78cfNYZOxI0qVWZ2Wdqm0+M2xxQeMXqzcQJRZtlTrBhPR24WYAQNRA9kcvSKOcNwKy6OJAd0SUwoM2wHPtoySdjZ51RyPFxRIlXCaKbcWjPM0URx9fHT816nhcppKE74uuVkS8XqD9LvR8OWLSS3O4Z4FSMP4HB2QsAyjcNNLWBcDD9lz9BdBQFtRPguBMstVCr0xv0WbEIKKHeE/KnQz5L7b3Tp7T2yb731cxQxcICKw774NFjZOGsVR59z4CyUb1Qf6lTjWSWXudqHxGTu9mFSGxrhk1NmAKlOgYNy0JRsf7VONWSnD7IVYUQhTT+alXaJi+PCWvcTgPgwXEnmXlkkIfQNl3IAojsLSdO9OltK4NjkJDJ0t5KYn9u2jRyYM8U+51bYEOeRJcwpv3DE6RHQi6ccnKi+4dsQz4BTW1LkxT2zJM78b2oa5oJCBXNlmGN3e0g0JR6ArnDnQB+e62Ir7/LxO2nEY7dMIYaPzEtWBS/ZjaYQEY5jLi9jztQSNBu/++Y+vn0/GD6JOwNWIeig3EphnPYUFzwYXoI2Sg4k3co6bA/SNg6cXk3EURy4MiEZRFZVg9AyWIvg6LkHu0pJuxfaC49qgY9JEh6BEaPQmqnMyHFH/nuFizzBNehcyHKFhSsiaWmheLEUydfo5ReeK8uCDxrzMrCgwlZjzzMBtnyvp2tm2IWmpMDLwF7UCZO4OgWkxrLtUreR9Kl7rxJYavImW1hZmdHQU1G7oBWmYqDx6d0v/1Wcn8To5PsY/bb1oeiXKSdK9icvvSeLa+Vd/gnt4HoroIeM3kRa05JnHVu6e3Tv1JjvRgLRtqaW3kMhJimh35ecztgTtPVcAOjE3JF3uoOXGr804S8V8DoS9inD2+tBDdpqt+cY4nGT3ziiFaarRAOzl4S0hK3KSPtcLLoWpIJaDdN2iY8A0zlgKRaYoenR2Va1l5ax3n2MnzHHwLNvATRfqda7Jx2S7M3HCOoVpriSQJb3BOnJRON+I5iiQATlcAdo4xiPzFafpsjshh/bNfu4DFOhy/ka4eakLZXwIu5vGHayacOoNu1Da0tIVTn368J4T2ZSb5bXiOmVmqdaegXSCr5mtf2am3r18w2tVLtKDbp1UC8MRc2PYXKu8GYyHCohbfg8I0MpkERT12X/cSP09EuC+DTw0mISs2JFntJXRU+Rapf3x/kzex7mN5JwS8u0hzVx/yE6lP3nCJeOZUXRVhGSRWK56xkXucnKqWB12pTguuFGPC1AdDNIpd9Ei8h03Z1YVgwxWkPUAAERdOtdCq7Lo4qjIGEEljVapKgO+2soBVGlr9HoXYOnR+kb546vk/Ve/K+e/qhMJqkHxotAUTixhe8VrmCsNzXgVM8VtU++WdZ7KQAaJz8YeXz5/xi4dHNA1lS6zopxTkA2jzKxDm6pw0Xel/1MAI0iFu6QgrXQokmPTYXEgBqBAdMnsCg8hK6khkf9/CAkFH+mpbQixLPNr0H2u9COzIkf8IC9idHAGEiVTEweW56r27A258Zsc9vM+tvzfPU3GjfVliTscyRfyD+u4i3FIIF2hl3xns9xk2P2quPOA+YUPwEuhkWB6/JDKfHV16OHweMhmwqiHfzl++P30z1MuJXycJjQMV5xcPmf0bPBndorP2Blaw7nIIPaAs/N6SrN8rJKWw1QrcIrV54RPLybNpLw+ImbaWwfyctbwFU9gU8eIhyn7BDY9sTniyMRaQRFvioapQiTq0xITu7v/w+ekh3Z246pKrEdGbmDTjphmqUhHN7BxHhlRtNmwiwt5A67BqCxEKO5SdtO2mBjJ9/LVoeF+/RZcRLt7AI/ITd0ld5BZlDp2MjxmNMFbSg9s4C+Da26om6ShIC2M48ttqwunpHIbtcC4uznV+vAVJFdh6/sUqphadQNyVks/36WxyIh0e7j0asjOlJSQEFh8hYOGbJbCSiQwDUdqT6tV8hEb08AA/7mUwbgiGcVoPRLQUjp/DVS5tPrY2f2LQPCzzwPAu4L+pcB3B+imWANRMPcjQsrUtJVWj8aTcUz2cQvZroa8Cmc5rR+yx6+vYqdFAfqe1T0Yl6fP2PjZJcP6Op6QS/bfw0fHf2UJZioUzoAPqyu0vDEdv+6aNmSvA+ZXgT8NKNnEXRIEceAMY4WklezTEagkjFllVtPJcr0A28LEd4bDd5GzP7qc0FtKaIHr/3KFBScfwoZsIgdOfiNs2cv9u3Hs7lb15YvJFxQ4XjTP5JtYvkp1g3333dgJKErA6LvvOoSvuVaRhUKQn6+uLobbJO4b79LuqncS9Zy2JWq7HX3DVqWur78/2xXgEA+boF61DyL3yIvHr8/Dbs5VNHrA6i0+e3m8Bq79xxSELhvVn8Dmbm2joz+eqGQTmyToynddSgIu+zAYfN4vRNsFpZ1rVMluSKLDnK+tYFuF1y+tTXWimt9bdfp6N3QlqeGe8hne73Cv8sE7oyb5ekFDoxjPFogTLfsBuwY99tmdiQ3NvCH82DYmLUn9z6ZYu+fzTK2rrjXh4F3usHaertDDU6X+9OHJX346+8WrwunJoz/ht68ITgXGVITxMXgfdoTVVTbnWWbYNU9uCPXPECDWAA3KOiBjB39r2carnf14Nvj58uTRn6I48lfFT+6aWEyKI7MxFvJfuOSLFtuvlcqAyy3GIyYIjabSIuMWAdI7lAWandAeRufM7Y+9sHiAvXk9NZ3ht3OJYf/nnnarrfrup/X4vykxAd8NyaMQbbbumCsT3G8+ZM+UB+FMAVmGdrtG+r1kYSC7p4by+xB6LNgmmyYi22pnxUD4YHe6iyFaXa9EVA8addJM1zfssm/qudu7vOugaXRxNfmArcktWg0jVwwNva9YW472FJ9CqeYQPBxHN7SQS8o7aW4TgmsCYDuKb10d6xHkd91b7OD8O6r9LoGn1PP8Cb/94Iq/dy7eNrcBrZU+wzAzdp/HDVl5Fx8o2Naza4nEIueCsD+PtESjH46Pb3uW7zNdYUr0I8dqXFFaVvV4R77yvV3lVg16E7Qkb6RaS9ex73Hq4JMbxUzhGnQ9vJPGaKb3FRlIaUtyTOmeYm3ca2h2uoi4elkFEZk7vKPS8/ZD3WyM0LHrU9l6J6r3DQRhTEhzdkQoO1+7wvmojzvyqXZ3SyA2lSGoy7iHN757mB45rcJApivtD/+Npf2l9JW438iOtEnz6N/aEFSdIT5mo206NMJwB5JSC7uhfqTTQjwB/EjtRpYvqAEnpH++1aoqAJxhk1WAp5AoOdilwr6qoiSaUBdTdMcaWdMcNOpjR592GZZbdCR0t763XcaQK3919Ekau8dCJ1EKuRpgZCwWmks7FCrCrqutN0R8896uZQ6tcGn5Ao3JjunGPe4e5F3NE4d2kkQFztRZiPvBv1HjmFq/U9PKJLaCQLRm1MLe6V+8avb9UAbRWgcbfnhVwb0mCz4XHyH1Btadkc3YfRliOqu5oJiO3pl4EDMYLoadZUfMT/zbBt8Y5IUY3MDm7zMXyqCavqjf7DkPilD3BNYoQKNl43C9u1vuPNQctwP7q7ff0z332T1vflFMvoWcq2DGeEJmDHIu6OYuO/2vWnoqARA/1T+1xa4psR25qCZhOLkSKeHP2PpJYbvAv3nlsVttUd2SYRMpmhhTcpkAu/+crMbkAeUFh2uNrVJjoZVVicoIZBQOfwKKFo2Pd37zBUqrmDCmhJiSTZeErFw7UPCvzSphSQ7fWCxL69QM6L6CS0sps29y9ZSm0yLg9uqM3X/8+upBzCbnV/9gl+PB49dX7NWZ261ZIsGq5FE+ftpMMPxbJejMM5EAFjlGnyrVLXiyBKwJbbFuvV4POT0eKr048nPN0dPJ2fmzy/MBzrmtXyGr2YnESn0HVDAJVVE4Ojk++WH4/fAhZVjK2JzLxnkOvoiWtl1X5W6/vVv/7d36b+/Wf3u3/tu79d/erf9D3633EbOFj/aoyLigbkjyrPWbFqsT1+8/FxRJtvIUj2M5/Ct11aod2UoUR6OdWNu7OFpiNDh6E336hE0pL3V2e4s/+xde3ryLoxXXFAm5lEYYD+zSSxx7fO39Fz55fcD+Jd7z76V5SF0k5i3+VRFsPMTGnz3/DgC9u+IzHKSKG37m7j7wCGRYbivFx7zMzTglAd47tpnEXry8iuLo2v9zArmL6jVfY6jP19Eoehu9jUg2KO4kBAF/x8zEtXZHo8gti4kMJlvt/M31O/kPeLFe+nRTOXcX/D/erHfK3zDeewKbv1fD3ZOdE6r00Y1GbiGy+j8kC0bi
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update presentation definition</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/sdjwt/presentation-definition/{presentationDefinitionId}"}></MethodEndpoint>



Updates a presentation definition.

The update endpoint reads fewer properties than the create endpoint. It reads `label`, `dcqlQuery`, `transactionDataDefinitionType`, `clientIdScheme`, `directPostRedirectUri`, `responseMode`, `dcApiRequestType` and `expectedOrigins`. It ignores `version`, `trustAnchor`, `kid`, `scope`, `responseType` and `encryptedResponseEncValuesSupported`. To change one of the ignored properties, delete the presentation definition and create it again.

The server keeps the current `label` when you send no `label`, a label of one character, or a label of only spaces. Unlike create, update does not apply a 3-character minimum, so a 2-character label is accepted and stored.

Rules that the server applies:
- `label` must not be a label that an extension reserves, for example 'Age Verification', 'Document Signing' or 'Know-Your-Customer (KYC)'.
- You cannot update a presentation definition that an extension uses.
- `dcqlQuery` replaces the stored DCQL query. Send the full query, because the server does not merge it with the stored one.
- `directPostRedirectUri` is allowed only when the effective `responseMode` is `direct_post`. The server refuses it for `direct_post.jwt`.
- `dcApiRequestType` is allowed only when `responseMode` is `dc_api` or `dc_api.jwt`. If the body has no `responseMode`, the server uses the `responseMode` of the stored record.
- `expectedOrigins` is mandatory when the effective request type is `signed`. The server accepts the stored `expectedOrigins` when the body has none.

This endpoint cannot set `clientIdScheme` to `null`. Send no `clientIdScheme` to make the server use `redirect_uri`.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the presentation definition that specifies the credential and claims requirements for OpenID4VP verification.","in":"path","name":"presentationDefinitionId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Properties of the presentation definition to change. The server ignores every other property.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 100 characters`"} schema={{"type":"string","minLength":1,"maxLength":100,"description":"New human-readable label of the presentation definition. Update does not apply the 3-character minimum of the create endpoint, so a 2-character label is accepted and stored. The server keeps the stored label when you send a label of one character, or a label of only spaces. Labels that extensions reserve are refused."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

New Digital Credentials Query Language (DCQL) query. It holds a `credentials` array, and every entry needs an `id` and a `format`. The `format` controls which `meta` keys the server accepts: `mso_mdoc` takes `doctype_value` only, `dc+sd-jwt` takes `vct_values` or `type_values`, and `jwt_vc_json` takes `type_values` only. The `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc` formats take no `meta` key at all. Each entry of `credential_sets` needs a non-empty `options` array.

This query replaces the stored query. The server keeps the stored query when you send no `dcqlQuery`.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"New Digital Credentials Query Language (DCQL) query. It holds a `credentials` array, and every entry needs an `id` and a `format`. The `format` controls which `meta` keys the server accepts: `mso_mdoc` takes `doctype_value` only, `dc+sd-jwt` takes `vct_values` or `type_values`, and `jwt_vc_json` takes `type_values` only. The `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc` formats take no `meta` key at all. Each entry of `credential_sets` needs a non-empty `options` array.\n\nThis query replaces the stored query. The server keeps the stored query when you send no `dcqlQuery`.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDefinitionType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`payment_data`, `payment`, `login_risk_transaction`, `login_risk_transaction_non_ts12`, `account_access`, `emandate`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`]"} schema={{"type":"string","description":"New type of transaction data that the verification request binds. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.","enum":["payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"New client ID scheme of the Authorization Request. The scheme sets how the verifier identifies itself to the wallet of the holder. The server uses `redirect_uri` when you send no value.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"New URI that the wallet opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`]"} schema={{"type":"string","description":"New response mode. It sets how the wallet of the holder delivers the Authorization Response.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signed`, `unsigned`]"} schema={{"type":"string","description":"New DC API request signing type. `signed` makes the verifier sign the Authorization Request. `unsigned` gives no verifier authentication. Use `signed` in production.","enum":["signed","unsigned"]}}></SchemaItem><SchemaItem collapsible={false} name={"expectedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"New list of origins that the wallet accepts for a signed DC API request. The wallet compares these values with the actual origin to find a replay."}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","title":"Update presentation definition","additionalProperties":true,"properties":{"label":{"type":"string","minLength":1,"maxLength":100,"description":"New human-readable label of the presentation definition. Update does not apply the 3-character minimum of the create endpoint, so a 2-character label is accepted and stored. The server keeps the stored label when you send a label of one character, or a label of only spaces. Labels that extensions reserve are refused."},"dcqlQuery":{"type":"object","additionalProperties":true,"description":"New Digital Credentials Query Language (DCQL) query. It holds a `credentials` array, and every entry needs an `id` and a `format`. The `format` controls which `meta` keys the server accepts: `mso_mdoc` takes `doctype_value` only, `dc+sd-jwt` takes `vct_values` or `type_values`, and `jwt_vc_json` takes `type_values` only. The `vc+sd-jwt`, `vp+sd-jwt` and `jwt_vc` formats take no `meta` key at all. Each entry of `credential_sets` needs a non-empty `options` array.\n\nThis query replaces the stored query. The server keeps the stored query when you send no `dcqlQuery`.\n"},"transactionDataDefinitionType":{"type":"string","description":"New type of transaction data that the verification request binds. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.","enum":["payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]},"clientIdScheme":{"type":"string","description":"New client ID scheme of the Authorization Request. The scheme sets how the verifier identifies itself to the wallet of the holder. The server uses `redirect_uri` when you send no value.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]},"directPostRedirectUri":{"type":"string","description":"New URI that the wallet opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`."},"responseMode":{"type":"string","description":"New response mode. It sets how the wallet of the holder delivers the Authorization Response.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]},"dcApiRequestType":{"type":"string","description":"New DC API request signing type. `signed` makes the verifier sign the Authorization Request. `unsigned` gives no verifier authentication. Use `signed` in production.","enum":["signed","unsigned"]},"expectedOrigins":{"type":"array","items":{"type":"string"},"description":"New list of origins that the wallet accepts for a signed DC API request. The wallet compares these values with the actual origin to find a replay."}}}} collapsible={false} discriminator={false}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server updated the presentation definition.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinition</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internal record identifier of the presentation definition. The list endpoint returns the value of `presentationDefinitionId` here. The create, read and update endpoints return a different internal identifier. Always use `presentationDefinitionId` to address the presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the OpenID4VC deployment that owns this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"presentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier that the server gives to the presentation definition. Use this identifier in a verification request and in the path of the read, update and delete endpoints."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable label that gives the purpose of this presentation definition, for example 'Verify Portable Document A1'. The dashboard shows this label."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dcqlQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder.

The query holds a `credentials` array. Each entry has an `id`, a `format` and a format-specific `meta` object: `doctype_value` for `mso_mdoc`, `vct_values` or `type_values` for `dc+sd-jwt`, and `type_values` for `jwt_vc_json`. An entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.

The server leaves this property out when the presentation definition has no DCQL query.


</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Digital Credentials Query Language (DCQL) query that gives the credentials and the claims that the verifier asks from the holder.\n\nThe query holds a `credentials` array. Each entry has an `id`, a `format` and a format-specific `meta` object: `doctype_value` for `mso_mdoc`, `vct_values` or `type_values` for `dc+sd-jwt`, and `type_values` for `jwt_vc_json`. An entry can also hold `claims`, `claim_sets`, `require_cryptographic_holder_binding`, `multiple` and `trusted_authorities`. A top-level `credential_sets` array can group the credential queries.\n\nThe server leaves this property out when the presentation definition has no DCQL query.\n"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transactionDataDefinitionType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `payment_data`, `payment`, `login_risk_transaction`, `login_risk_transaction_non_ts12`, `account_access`, `emandate`, `data_agreement_record`, `data_disclosure_agreement_record`, `qes_data`]"} schema={{"type":"string","description":"Type of transaction data that the verification request binds. The holder must approve the transaction data before the wallet sends the presentation. The value selects the JSON Schema that the server uses to validate the `transactionData` of the verification request. Read `GET /v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions` for the schema of each type.\n\nThe value is an empty string when the presentation definition binds no transaction data.\n","enum":["","payment_data","payment","login_risk_transaction","login_risk_transaction_non_ts12","account_access","emandate","data_agreement_record","data_disclosure_agreement_record","qes_data"]}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server created this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp, in seconds, of the moment that the server last changed this presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`version_01`, `iso18013_7_annex_c`]"} schema={{"type":"string","description":"OpenID for Verifiable Presentations (OpenID4VP) version of the Authorization Request. `version_01` is OpenID4VP 1.0. `iso18013_7_annex_c` is the ISO 18013-7 Annex C profile, which asks for mDoc credentials over the Digital Credentials API.","enum":["version_01","iso18013_7_annex_c"]}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyIdentifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Key identifier of the key that is used to sign the Credential."}}></SchemaItem><SchemaItem collapsible={false} name={"cryptographicKeyFormat"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`did:key`, `x509`]"} schema={{"type":"string","description":"Format of the signing key, for example `did:key` or `x509`.It sets how the holder resolves the identity of the verifier. `iso18013_7_annex_c` needs `x509`.","enum":["did:key","x509"]}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"OAuth 2.0 scope value for a scope-based presentation request. The value is an empty string when the presentation definition holds no scope."}}></SchemaItem><SchemaItem collapsible={false} name={"responseType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`vp_token`, `id_token`, `device_response`]"} schema={{"type":"string","description":"OAuth 2.0 response type of the Authorization Request. `vp_token` asks for a Verifiable Presentation. `id_token` asks for an OpenID Connect ID Token. `device_response` asks for an ISO 18013-5 DeviceResponse and is only for `iso18013_7_annex_c`.","enum":["vp_token","id_token","device_response"]}}></SchemaItem><SchemaItem collapsible={false} name={"clientIdScheme"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`redirect_uri`, `did`, `verifier_attestation`, `x509_san_dns`, `x509_hash`]"} schema={{"type":"string","description":"Client ID scheme of the Authorization Request. It sets how the verifier identifies itself to the wallet of the holder. `redirect_uri` uses a redirect URI, `did` uses a DID, `verifier_attestation` uses a Verifier Attestation JWT, `x509_san_dns` uses the SAN DNS name of an X.509 certificate, and `x509_hash` uses the hash of an X.509 certificate. With the DC API response modes, `redirect_uri` is only a logical identifier and not a real redirect target. The server leaves this property out for `iso18013_7_annex_c`.","enum":["redirect_uri","did","verifier_attestation","x509_san_dns","x509_hash"]}}></SchemaItem><SchemaItem collapsible={false} name={"directPostRedirectUri"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URI that the wallet of the holder opens after it posts the Authorization Response. Only for the `direct_post` response mode. The server refuses this property for `direct_post.jwt`, and it has no meaning for the DC API response modes. The server leaves this property out when the presentation definition holds no URI."}}></SchemaItem><SchemaItem collapsible={false} name={"responseMode"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`direct_post`, `direct_post.jwt`, `dc_api`, `dc_api.jwt`]"} schema={{"type":"string","description":"Response mode that sets how the wallet of the holder delivers the Authorization Response. **Direct Post:** `direct_post` posts the response over HTTP. `direct_post.jwt` posts the response as an encrypted JWT. **DC API:** `dc_api` uses the W3C Digital Credentials API and returns the response without JWE encryption. `dc_api.jwt` uses the Digital Credentials API and returns the response as a JWE.","enum":["direct_post","direct_post.jwt","dc_api","dc_api.jwt"]}}></SchemaItem><SchemaItem collapsible={false} name={"dcApiRequestType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`signed`, `unsigned`]"} schema={{"type":"string","description":"Signing type of the DC API request. Only for the `dc_api` and `dc_api.jwt` response modes. `signed` means that the verifier signs the Authorization Request. `unsigned` means that the verifier sends the request unsigned. The server leaves this property out when the presentation definition holds no value.","enum":["signed","unsigned"]}}></SchemaItem><SchemaItem collapsible={false} name={"expectedOrigins"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Origins that the wallet accepts for a signed DC API request. The server leaves this property out when the presentation definition holds no origin.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"encryptedResponseEncValuesSupported"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`A128CBC-HS256`, `A128GCM`, `A256GCM`]"} schema={{"type":"array","description":"JWE content encryption algorithms that the verifier accepts for the Authorization Response. It applies to the `direct_post.jwt` response mode; the `dc_api.jwt` flow ignores it and always advertises `A128GCM` and `A256GCM`.\n\nThe server leaves this property out when the presentation definition holds no algorithm. The verification request then falls back to all three algorithms.\n","items":{"type":"string","enum":["A128CBC-HS256","A128GCM","A256GCM"]}}}></SchemaItem><SchemaItem collapsible={false} name={"systemManaged"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when the platform owns this presentation definition. You cannot delete a system managed presentation definition."}}></SchemaItem><SchemaItem collapsible={false} name={"extentionEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"`true` when an extension uses this presentation definition. You cannot update such a presentation definition, and you cannot delete most of them. Note the spelling of this property name."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Legacy credential requirements of a presentation definition that an older OpenID4VP version created. The value is `null` for every presentation definition that uses `dcqlQuery`. You cannot set this property.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Legacy credential requirements of a presentation definition that an older OpenID4VP version created. The value is `null` for every presentation definition that uses `dcqlQuery`. You cannot set this property."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"presentationDefinition\": {\n    \"id\": \"string\",\n    \"openIdOrganisationId\": \"string\",\n    \"presentationDefinitionId\": \"string\",\n    \"label\": \"string\",\n    \"dcqlQuery\": {},\n    \"transactionDataDefinitionType\": \"\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"version\": \"version_01\",\n    \"cryptographicKeyIdentifier\": \"string\",\n    \"cryptographicKeyFormat\": \"did:key\",\n    \"scope\": \"string\",\n    \"responseType\": \"vp_token\",\n    \"clientIdScheme\": \"redirect_uri\",\n    \"directPostRedirectUri\": \"string\",\n    \"responseMode\": \"direct_post\",\n    \"dcApiRequestType\": \"signed\",\n    \"expectedOrigins\": [\n      \"string\"\n    ],\n    \"encryptedResponseEncValuesSupported\": [\n      \"A128CBC-HS256\"\n    ],\n    \"systemManaged\": true,\n    \"extentionEnabled\": true,\n    \"presentationDefinition\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the digital wallet deployment is not resolved, no presentation definition has the supplied `presentationDefinitionId`, an extension uses the presentation definition, `label` is a label that an extension reserves, `dcApiRequestType` does not agree with `responseMode`, `expectedOrigins` is missing for a signed DC API request, `directPostRedirectUri` is set for `direct_post.jwt`, the DCQL query is not valid, or the digital wallet refused the update.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update sandbox organisation cover image
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-sandbox-org-cover

---
id: config-update-digital-wallet-open-id-sandbox-org-cover
title: "Update sandbox organisation cover image"
description: "Updates the cover image of one sandbox organisation. Give the sandbox organisation ID in the path and send the image as multipart form data in the `coverimage` form field."
sidebar_label: "Update sandbox organisation cover image"
hide_title: true
hide_table_of_contents: true
api: eJztWVtv20YW/isH82QD1CWOCyyEolhXyrZq08aIZQeL1IBGnCNyGnKGmRnK0Qr674szQ1GkREWuu2/ZPAQyOecy37kfbphAGxtZOKkVG7H7QnCHFlyKEOsVGpA5TxD0ErRCsFyJhf4C2iRcScuJqg8/yRV6iq7XMJ2AVP51wV0KXAmwqIR/EphzC3mZOVlw42CpTQ6CO76jmns9/Ml5eLuUmIn+H+oPNSOhaFYyRrBOm0pzfzgCiy78rfCpEjWdeAXaD+/fvwWtTt4gqnWucEm5ShCc9n898SxDRwCdROApRQXSgbQgsMj0GoP2/9YlxFwp7aD0uHsWOZdqx9WlRpdJCi6VFlCJQkvl+jANwhK5woCvPaSMgjYVNHTQws+z2S1cD4d9FjFdoPHKTQUbsVirpUyC7ScykY5nHzybdwWqqbgLl3pnkjGZgkWs4Ibn6NBYNvq4OfQhJT+XCFKgcnIp0XwNHFJGEhU5B4uY4jmyEbO1yKlgETP4uZQGBRs5U2LEbJxiztlow9y68OedkSph2+1jOIzW/ajFmk60lZsdOLbTwXH6HVJirRwqR0xq/xyQB/bIP+kxqlgLEjzabDu00os/MXYtzh/Z3p3ZY8QKQ6ZwEi3RNd4d3S1iJJo7NmILqbhZs+jM3ZYywz7b+n+kgy20skHQ1XDYjU0rmsRhHiCUGqjwoshk7O04+NMSj80zQdjb9xiExrsOLu2zUnQB9Tf8kW13PniO7UTaIuNroNPnOLYozzH+ucy5AoNc8EWG0Hh5Toz24TrxOSZH5abPQGd6BAu3VseSOxTg439SZS3iSFKs4660Dc5SOUx8XmizvvMHIdbiLEAZigRNS99TXL+qcOBDHKVaGm6dKWNXGrw1eiUFmvN4/N4wZ5sHFDsm24it0NhnWfMhHPxqgQj5tzQ1HEZnz/DA9zr7KrC7CoqxtmvrMCfWzpTW3ag41c8AY0aHgfvTrQAyMJlOPMw2VIoOgBdaZ8jVsQGVoKSBlgqjS9GE8tZ5Ax47S/0B31XEpg0sxqXBB15m7kV+U1CqNWsIfGDlGbX5Nt2cG8Mp6aoyyygyd2XilBhb26bBnyo1d6dNVlq0faBM7LscSHUmLMxJ5jw0EidJU25B6ZY0X10d5l3RSjUh04meUmJ/WaYg8qowNFSWFvjConLP07fBhMD31eZv6NSsVi9XqlXzmkDdm+y8VrflIpOx7yuX2hxA1b7kS/k1FPQMDVL+u3lOIMxkjtbxvDgDxRO3UPElEaFF/d+LyLjd9b8iZJTfuFQvzyPNZrhdZrbtHkSKXb/Z5txZR+uy16hVJ4vMvjxUqbyddjuyZjuZHfjbob80zd20S43dY1dn2J1flw6DQwU2IWTqJpAGqHkzIud+Fpq39JlXPWbEUuTCzwQb+us69JjP7hebtkFjtBlrQdD535PGfR6jM13hnrrLVfELzwtK39fD4baDfUc41iTsRy5AqqJ0UM9Au9sfQ352QKtGlV3WOTHqRlAF/c4usS4zATQ31pP0Xx1KqTIcmuvVN2yue8VLl2oj/4OiA5rrbxga8uTORqMzo0tXrSumk2Mf++6bTglT5dAonvk4RgNezAFGu/ZTurVfrdwU8lekn4+02nA8oY0Lq5Y0EKoIXIQ57fphfMkiVq1r0BIqObpU046nKD0otGUZscHqahCGjkFlxZ42yWDTXLtsB41tBGlFOnfteyaY6+pKVI6ooWGpc4UdDQYCc93jhezLxHDl+lKzbXTI4NZoUcbefU6wOcfhzvFEquQUuQ2vDxV53GN9Ry4XPGWH+L7vDw+qPVUw1n5TdVOlDV71Dm3Fbm6n8AnXQMmFOtW4WplSTK14Vtbz27zFZw5BDOQ0fy1oVMGl/IIixNc86AhzuFC6Whs6w2XmMSh4jJcRYD/pH7AdQUX4/VqXhuDofcL1D76A+2ZG76KTxz46MeeSgLRlUWjj/rkHr76//Gn/qI1602AHsNREu3mOJrxYU0A5Wt8WGVLfxZtLj2oXQQ3wAxq5lH47MjboRwCeWZhaW3IVI1y888EwvfTdSjfhrUFbi6gD6PaSNHI61pkfw6QFMiEqorFVqgtgWiq20toSIz+lhTUxRcxyDaIK0LihXmm9eRxXghthe/6+kisHy0w/2WDaCmmv7YfXY3gYw8UvH2aXEUzfzP4Fd5PeLx9m8DAO0qZ37+DVP4avXve+g3yi40E+eduQCWFjaCkRZzJGZX3623luweMU4ao/PDLd09NTn/vXfcoLFa0dvJ2O3/x+96ZHNLRLkC5r+YAHS+i4rK3X6IVH7Gp4dd1/3X9FtIW2LueqoU/YP5/akOzHnaN1Wl1O/v/54hv5fFFlZodf3KDIaOTZVi68qUrcR7a6CsvqpaRy3ShzLGKjg+8L7Z18qq0jDpvNgluacLZbevy5ROMrccRW3MiwAqJqKC39Fmy05Jk9XAg13fPifdXPXMJf/kjSeeVdhVJUnnw9YSPGIvaJClj7I8r2sR7QvNbhyDjo1psRoz2Lrs8dVHUD0U0cY+Eax4+auG2z87i9n7GILarPMbnvwfy3DM822v+kJidiVCrb1feTr77VD9K989qHhTjoSv+T5p0k31O6+hXXP9THw5uTBHXxD6fJCI/b7fa/5/1QkA==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update sandbox organisation cover image</h1>

<MethodEndpoint method={"put"} path={"/v2/config/sandbox-org/{sandboxOrgId}/coverimage"}></MethodEndpoint>



Updates the cover image of one sandbox organisation. Give the sandbox organisation ID in the path and send the image as multipart form data in the `coverimage` form field.

The service stores the image, sets the new image ID and the new image URL on the sandbox organisation, and sends the change to the wallet of the sandbox organisation when it is deployed.

You cannot update the main wallet through this endpoint. If the given ID is the main wallet, the service gives HTTP 400.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The cover image to store.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"coverimage"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","format":"binary","description":"The cover image file."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service stored the cover image.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The sandbox organisation after the update. The service sets `coverImageId` and `coverImageUrl`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human readable description of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdDeploymentId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the associated OpenID deployment"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Status code of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the associated ledger"}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the infrastructure provider"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the sandbox organisation configuration"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role of the sandbox organisation in the ecosystem"}}></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trust anchor identifier or DID"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this sandbox organisation acts as a wallet provider"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVault"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the primary secure vault"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVaults"} required={false} schemaName={"integer[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Identifiers of the secure vaults that the sandbox organisation uses. The field holds `null` when the sandbox organisation has no secure vault.","items":{"type":"integer"}}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the logo image. The field is absent when the sandbox organisation has no logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cover image. The field is absent when the sandbox organisation has no cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the logo image"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the cover image"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was created"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was last updated"}}></SchemaItem><SchemaItem collapsible={false} name={"isMain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this is the main organisation"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"openIdDeploymentId\": \"string\",\n    \"status\": 0,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"string\",\n    \"version\": \"string\",\n    \"role\": \"string\",\n    \"trustAnchor\": \"string\",\n    \"isWalletProvider\": true,\n    \"secureVault\": 0,\n    \"secureVaults\": [\n      0\n    ],\n    \"logoImageId\": \"string\",\n    \"coverImageId\": \"string\",\n    \"logoImageUrl\": \"string\",\n    \"coverImageUrl\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"isMain\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The given ID is the main wallet, the request has no `coverimage` form field, or the service could not send the change to the wallet of the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no sandbox organisation with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update sandbox organisation logo image
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-sandbox-org-logo

---
id: config-update-digital-wallet-open-id-sandbox-org-logo
title: "Update sandbox organisation logo image"
description: "Updates the logo image of one sandbox organisation. Give the sandbox organisation ID in the path and send the image as multipart form data in the `logoimage` form field."
sidebar_label: "Update sandbox organisation logo image"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v27YW/isH/JQA8kvTDBiMYVgWd5u3rg0aJ8XQBTAtHstcJVIlKae+hv77xSFlWbLlOGvvt958CGSR54XPOTxv2jCBNjYyd1IrNmJ3ueAOLbglQqoTDTLjCYJegFYIlisx159Bm4QraTkR9eFXuUJP0LUMkzFI5Zdz7pbAlQCLSvg3gTm3kBWpkzk3DhbaZCC441uqGanhN87C4kJiKvp/q7/VlGSiWckYwTptKr395ggsuvBb4WMlaTL28tsv7969Bq2OHiCqVQ7c4iVXCYLT/tcjT1N0hM9RAB6XqEA6kBYE5qleY9D+L11AzJXSDgqPumeRcam2XN3S6CJZgltKC6hErqVyfZgEYYlcYYDX7lNGQZsKGtpo4bfp9AYuh8M+i5jO0XjlJoKNWKzVQibB8mOZSMfT957N2xzVRNyGQ701yWudaBaxnBueoUNj2ejDZt+BlPxUIEiBysmFRPMUNqSLJCpyDRYxxTNkI2ZriRPBImbwUyENCjZypsCI2XiJGWejDXPr3O93RqqEleVD2IzW/azFmna0lZu2vdrp4Db9DiGxVg6VIx61cw7I/3rknPQaVawFyR1tyg6l9PwfjF2L8wdW+zJ7iFhuyA5OoiWy3dLBwSJGgrljIzaXips1i54+2EKm2Gel/yMFbK6VDWIuhsNuXFoXSewFAEKogQjP81TG3oSDfyyx2DwTgJ1pDxForHVwae+Vogumr3BFVm7d7xTbsbR5ytdAu09xbFGeYvxbkXEFBrng8xShsXhKjPYXdeyjS4bKTZ6BzuQAFm6tjiV3KMDf/HEVr4gjSbGOu8I2OEvlMEFzwPrWb4RYi5MApSgSNC19j3F9UuHAhzhKtTDcOlPErjB4Y/RKCjSn8XjTMGebB+RbJmXEVmjss6x5HzY+mRpC5C1MDYfR6TM88J1OnwR2mzox1nZtHWbE2pnCuisVL/UzwJjSZuB+d+sCGRhPxh5mG3JEB8BzrVPk6tCASlDQQEsp0S3RhMTWeQIeO0uFAd/mwqYNLMaFwXtepO6L/CY3MuNmDYEPrDyjNt+mm3NjOIVcVaQp3cxtijgmxta2afCnHM3dcZMVFm0fKBD7+gaWOhUWZiRzFkqIo6RLbkHpljSfWB1mXbeVUgJF9gkF9i+LFI3E0FBZWuBzi8o9T99mdikpvazQfIVOnv6rlWpyYU2g7kx6WqubYp7K2FeUC232oGof8kv5NRT0DA1S/Lt6zkWYygyt41l+AopHbqHiSyJCcfq/F5Fyu618RYgof3KpvjyONMvgdpop2zWIFNtSs825M4/Waa+Rq44mmV16qEJ5O+x2RM12MNvzt31/aZq7aZcau4euurA7vi4cBocKbMKVqWtAap1mjSAx803QrKndrCowI7ZELnwzsKFfl6HAfHa12LQMGqPNtRYEnH8eN07zEJ2oCXfUXY6Kn3mWU/C+HA7LDvYdl7EmYT9zAVLlhYO6+dme/hDwk41Z1aNsY053hxtBdeO3Rol1kQqgdrHun/9tL0ppYd9aL75ha90pXrilNvI/KDqgufyGoSFH7qwyOsO5dNWUYjI+9LHvvumIMFEOjeKpv8dowIvZw2hbe0q39iOVq1z+gfT4QCMNxxOatLBqNgMhhcBZaNIu76/PWcSqKQ1aQiVDt9Q02skLDwpNV0ZssLoYhI5jUFmxp00y2DTHLeVgN4cgpUjlrjHPGDNdnYhSERUzbOlcbkeDgcBM93gu+zIxXLm+1KyM9hncGC2K2HvPETanONw6nkiVHCO3YXlfkYcd1LfkccFRtoDvav7wohpPBVvtBlRXVdTgVd3QVuzqZgIfcQ0UW6hKjas5KV2pFU+LunebtfjMIIiBjHqvObUpuJCfUYTrNQs6wgzOlK6Ghc5wmXoMch7jeQTYT/p7bEdQEf6w1oUhOHofcf2jT9++kNHby8ljfzkx45KAtEWea+N+2oFXn1/+unvVRr1psD1YaqJtL0fdXazpPjka2uYpUs3FmwOPag5Bxe89GrmQfjJybdCX/zy1MLG24CpGOHvr78Lk3Jcq3YQ3Bm0tor4/N+ekkdOxTn0LJi2QCVERja0iXQDTUq6V1hYY+Q4tDIdXJGENorqfcUO9wnrzOK4EN8L2/HklVw4WqX60wbQV0l7b9y+v4f4azn5/Pz2PYPJq+gvcjnu/v5/C/XWQNrl9Cy++H7542fsOsrGOB9n4dUMmhFmhpTicyhiV9dFv67k5j5cIF/3hgekeHx/73C/3KSxUtHbwenL96s3tqx7R0BxBurTlAx4soeOitl6jDh6xi+HFZf9l/wXR5tq6jKuGPmHq3J1VGq3TwSStTib//2LxTXyxqMKyw89ukKfU65SV/26q9PaBrS7ClHohKVU3UhyL2Gjvm0JrEL/U1hGDzWbOLfU2ZUmvPxVofBKO2IobGUY/lAmlpWfBRgue2v1BUNM3z95Vpcw5/OvvIp0n3mYnRanJ5xI2YixiHyl5tb+blA91a+a1Dluug269KTHasej6xEEZNxBdxTHmrrH9oH4rm0XHzd2URWxefYHJfPnlv2B4ttHukeqbiFGabGfejz7zVg+ke+ex95Nw0JX+k+adJD9QqPoD1z/W28PKUYI68YfdZISHsiz/C8OcSbA=
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update sandbox organisation logo image</h1>

<MethodEndpoint method={"put"} path={"/v2/config/sandbox-org/{sandboxOrgId}/logoimage"}></MethodEndpoint>



Updates the logo image of one sandbox organisation. Give the sandbox organisation ID in the path and send the image as multipart form data in the `logoimage` form field.

The service stores the image, sets the new image ID and the new image URL on the sandbox organisation, and sends the change to the wallet of the sandbox organisation when it is deployed.

You cannot update the main wallet through this endpoint. If the given ID is the main wallet, the service gives HTTP 400.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The logo image to store.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"logoimage"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","format":"binary","description":"The logo image file."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service stored the logo image.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The sandbox organisation after the update. The service sets `logoImageId` and `logoImageUrl`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human readable description of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdDeploymentId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the associated OpenID deployment"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Status code of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the associated ledger"}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the infrastructure provider"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the sandbox organisation configuration"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role of the sandbox organisation in the ecosystem"}}></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trust anchor identifier or DID"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this sandbox organisation acts as a wallet provider"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVault"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the primary secure vault"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVaults"} required={false} schemaName={"integer[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Identifiers of the secure vaults that the sandbox organisation uses. The field holds `null` when the sandbox organisation has no secure vault.","items":{"type":"integer"}}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the logo image. The field is absent when the sandbox organisation has no logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cover image. The field is absent when the sandbox organisation has no cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the logo image"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the cover image"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was created"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was last updated"}}></SchemaItem><SchemaItem collapsible={false} name={"isMain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this is the main organisation"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"openIdDeploymentId\": \"string\",\n    \"status\": 0,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"string\",\n    \"version\": \"string\",\n    \"role\": \"string\",\n    \"trustAnchor\": \"string\",\n    \"isWalletProvider\": true,\n    \"secureVault\": 0,\n    \"secureVaults\": [\n      0\n    ],\n    \"logoImageId\": \"string\",\n    \"coverImageId\": \"string\",\n    \"logoImageUrl\": \"string\",\n    \"coverImageUrl\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"isMain\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The given ID is the main wallet, the request has no `logoimage` form field, or the service could not send the change to the wallet of the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no sandbox organisation with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update sandbox organisation name
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-sandbox-org-name

---
id: config-update-digital-wallet-open-id-sandbox-org-name
title: "Update sandbox organisation name"
description: "Updates the name of one sandbox organisation. Give the sandbox organisation ID in the path."
sidebar_label: "Update sandbox organisation name"
hide_title: true
hide_table_of_contents: true
api: eJztWV9v2zgS/yoDPjWAYqdpFjgYi8Vl496ud3tt0DgpDm2AMOJY4kYiVZKy6zP83Q9DyrIky7HbHnAPvT60rjQzHP7m/2jFBNrYyMJJrdiI3RaCO7TgUgTFcwQ9A60QLFfiUX8BbRKupOVEPoDf5Bw9ad9rmIxBKv+64C4dfFKf1HQjVlrIuRLcabMErgTkpXXwiFAq+bnEDWP7uFuVyadwYIIKDc+g9PqCLtB4ogi4AswLt6zPoQfGaAMpGoxAaUePpLLOlLFX1Gl4Qiy84Lg0BpXz3F7lf+kSYq6IrTqMyHIuFSx4lqEDlxpdJim4VFpAJQotlRvAZBY0lXMMWNguZxSwQzOXcSC08Pt0eg0XZ2c1fy+00oLAItNLFG0hPLMaLCpRmRAXAQenQTpbnTtgEasRmwg2YrFWM5kE449lIh3PPnjSdwWqibgJOrwzyVueI4tYwQ3P0aGxbPRx1fWhyoQClZMziYacaN9VSBdJXOQjLGKkLRsxW584ESxiBj+X0qBgI2dKjJiNU8w5G62YWxae3hmpErZe3wditO5XLZZE0VZu2kTlgF7dU2OtHCpHQnlRZDL2lMO/LEle7SqlH//C2LUEfWzcjN1HrDBkCCfRegnbdwekeJh2+AN4XVCiDgRvj7k+fFeosojhF54XGalxGecIU7QOJtaWaNia/jQouhevfGAfn0FbaGXDlc/PzvqNvImIELSildGeM/r/2MhtWikOm/Orwo2toyO9ZCxtkfHlQcxIYovzkODfy5wrMMgFf8wQGi8PHaN9Mhr7xJejcpMj0JnswMKt1bH0PuGz27hKpSSRTrGOu9I2JEvlMEGzI/rGE0KsxUGAMhQJmpa++6Q+q3CQQxKlmhkeSlhp8NrouRRojgj+hjnbMqDYCFlHbI7GHmXNu0D4HAAQqktpajiMzo7wwPc6exbYTebBWNuldZiTaGdK6y5VnOojwJgSMXBP3QogA+PJ2MNsQx3sAfhR6wy52jWgEpQ00MIiRZeiCY1B7w147CxwC3zTSzRtYDEuDd7xMnPf5DeFkTk3SwhyYO4FteU23Zwbw5dUgcsso8jcVL19x9jaNg351HZwt99kpUUbastMYiYg1Zmw8EBnPhBeaj9ryi0o3TrNNw8O875opUqR6URPcp7gt2UKYgdJ/E2VqaV8tNQjHqVvQwiBH+s5mu/QyfN/t1JNKawJ1K3JDmt1XT5mMobb929gpk0HqvYlv1VeQ0Ev0CDlv8tjAmEqc7SO58UBKBbcQiWXjqj6hP/6ERm3m8lBhIzyTy7Vt+eR5hjRLjPrdg8ixaadbkvuraN12WvUqr1FZlseqlTeTrs9WbOdzDr+1vWXprmbdqmxu9+xxz4D8JnD4FBBzGDTQ6bIhZ9eVvS/i9BEHt36NWH2s+WVFoSC/z1uqHYfHWjwttx9Xld3yBdnZ+se8T2RtW27f+UCpCpKB/W0trn9LnoHp9QH8qQHPwxIa6VKqEj6QTsCDkLOZujn5r1ZJwRJHprwCKo433TpsS4z4WdzGl5DCki5SvzkSv+r6uOB5r1r1pc/sFlvFS9dqo38N4oeaC5+YGimnXm17i16k7h01W5nMt71sZ9+6NQxUQ6N4pmPYzRh0dbBaNNxSrf0y6LLQv6J9POeljWOJ7RDYtXWCULhgBdhNLu4uzphEav2T2gJlRxdqmlpVZQeFNobjdhwfj4Mc8awsuKpNslw1VwkrYdVOQza9u2uxpjr6jJUe6h7YalzhR0NhwJzfcoLOZCJ4coNpGbrqCvg2mhRrRX3iDkk4cbxhPLrHnYbXncVud+ifEPOFnxkg/W2yQ8Pqp1bMNN263ZZJQxeNQptxS6vJ/CES6C0Qm1p3NgUzXlW1sPaQ0vOA4Rj6r1RYXAmv6AIkfUQdIQHeKF0tV11hsvMY1DwGE8iwEEy6IgdQcX481KXhuA4fcLlLw8D3whR4L3f7gFff/2qyXc/ehPbPPaxjTmXZAxbFoU27u9bA9QYyt+2j9qWaxq9A23NtBkAaSSMNensECT9S40ab25JquUFdcx3aORM+nXKlUE/M/DM+rtwFSO8eOdDaXLi93f9jNcGbX1EHX7XJ6SR07HO/NwmLZAboCIeWyXKYBDrl8wEX+THusgfNqcTliCq8I4b6pW+jbCOlotG2FN/X8mVg1mmFza4R4W01/bDqyu4u4IXf3yYnkQweT39B9yMT//4MIW7q3Da5OYdvPzb2ctXpz9BPtbxMB+/aZxJUnLuLKXxTMaoLDadoOBxinA+ONsx3WKxGHD/ekBZpeK1wzeTq9dvb16fEg8tH6TLWj7gwRI6LmvrNZrnETs/O78YvBq8JN5CW5dz1dAnrOP7i1JPX9+sQv//jvOjfMep8rrDL25YZDQdrSvnXVWl8SObn4e99kxSmW+URxaxUedLy+bDQqqtI97V6pFbGsvWa3r8uUTja3fE5tzIsCeiKiot/RZsNOOZ7W6Nmp754n3VAZ3AV38o6r3sprIpKmu+DrERYxF7osLX/pC0vq9HP691ILkKup1OSdBWxE4fR6U6cFzGMRbuWdpmo3J9O2URe6y+R+W+ZWOGL2h85gs2Yp/YJ+bncp9HfZtIz1cs4yopaQcyYkEs1SWqv+2S/uRLevWDLtaLSbe6h7vQ33SzXpafKX/9ictfavLwZi9D3VEEarLQ/Xq9/g8Av7aF
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update sandbox organisation name</h1>

<MethodEndpoint method={"put"} path={"/v2/config/sandbox-org/{sandboxOrgId}/name"}></MethodEndpoint>



Updates the name of one sandbox organisation. Give the sandbox organisation ID in the path.

The name is mandatory and must be unique in the organisation. Unlike the general update operation, an empty name is an error here, not an instruction to keep the current name.

You cannot update the main wallet through this endpoint. If the given ID is the main wallet, the service gives HTTP 400. If the sandbox organisation is deployed, the service also sends the new name to its wallet.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The new name of the sandbox organisation.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"New name of the sandbox organisation. The name is mandatory and must be unique in the organisation.","example":"Acme Test Issuer"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service updated the name of the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The sandbox organisation after the update.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human readable description of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdDeploymentId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the associated OpenID deployment"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Status code of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the associated ledger"}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the infrastructure provider"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the sandbox organisation configuration"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role of the sandbox organisation in the ecosystem"}}></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trust anchor identifier or DID"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this sandbox organisation acts as a wallet provider"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVault"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the primary secure vault"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVaults"} required={false} schemaName={"integer[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Identifiers of the secure vaults that the sandbox organisation uses. The field holds `null` when the sandbox organisation has no secure vault.","items":{"type":"integer"}}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the logo image. The field is absent when the sandbox organisation has no logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cover image. The field is absent when the sandbox organisation has no cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the logo image"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the cover image"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was created"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was last updated"}}></SchemaItem><SchemaItem collapsible={false} name={"isMain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this is the main organisation"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"openIdDeploymentId\": \"string\",\n    \"status\": 0,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"string\",\n    \"version\": \"string\",\n    \"role\": \"string\",\n    \"trustAnchor\": \"string\",\n    \"isWalletProvider\": true,\n    \"secureVault\": 0,\n    \"secureVaults\": [\n      0\n    ],\n    \"logoImageId\": \"string\",\n    \"coverImageId\": \"string\",\n    \"logoImageUrl\": \"string\",\n    \"coverImageUrl\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"isMain\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The given ID is the main wallet, the `name` is missing or empty, a different sandbox organisation has the same name, or the service could not send the change to the wallet of the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no sandbox organisation with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update trust authority
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-trust-authority

---
id: config-update-digital-wallet-open-id-trust-authority
title: "Update trust authority"
description: "Updates one trust authority of the organisation. Give the trust authority ID in the path. Send all three fields with valid values. The service forwards each field, and it rejects an empty field."
sidebar_label: "Update trust authority"
hide_title: true
hide_table_of_contents: true
api: eJzlWW1v4zYS/isDfkoA+S2b7ItRFE2TtOc21w02zqbANjjT4thiVyK1JGXHNfzfD0NKtiQ76e7d9dC7fvGLJA5nnpl5ZjhaM4E2NjJ3Uis2ZHe54A4taIXgTGEd8MIl2ki3Aj0DlyBoM+dKWk4ruvC9XKC/3H56dAlS+Ts5d0kXblEJ4GkKLjGIMJOYCgtL6RJY8FQK+izQdmGcIFg0CxkjzLRZciMsII+TsCYCrgRIBwZ/xdhZ4Aowy90q3O6yiOkcjVdvJNiQxVrN5DwYdinn0vH0nqcpurc5qpEYk97nldosYjk3PEOHxrLhh3UbHyU/FQhSoHJyJtEQKvzzoCLDvJGQ0dNTBA53d6PLCKz2j++kWpj0J97QyWBSSXNLDdNCpq5DwPodU2kJAYOgtCtxTNAgoSBJX8KeRUzxDNmQuYatI8EiZvBTIQ0KNnSmwIjZOMGMs+GauVVOa6wzUs1ZxGbaZNyxISsKKdgmYvjIszylZ6avxGB2yk86r+MX2DnlbwadN7Ozk05fvIhf4is+mJ6esc1D2A2t+1aLFW3RxJbwUbgsA2FrdRPa7gGdY60cKkcSeZ6nMvaA9361JHa9b5KeUuQ0BH0I9yLmN68Qe4hYbiianES7E7CPDaoiIyFX49vRP8bXtLBl2yrHpkXkumaw8zjG3FmYlFImoFW66tb+Sx/t9Bd82KKAa2kdJdrPf7+G4KGm0Djhao7WbxyCz2ko8hwNxNz6QNn5sVJ/U+FwwNRMqmtUc5ew4SBiGX+s/p30T1+3zb7WwReHTP9OG39tZx5tFcGcGIUr+Nt4fAPa+O9buHt3DS7hlPauMMruxKHwAkHouMhQuaZJiXO5HfZ6hi+7c+mSYlpYNGXEdGOd9a7uLzqxVlYbJ4ush8u44+V2SGrP4Mz2EuTC9jIulX96fN19zFJCKeTVl4B0dtbG6Cee4VPB3nClTfSS7JYWaN+KXgW3yVRzI7pwDjk3TvIUCk93FDBEDLm2Vk5T9EwT8A0iiCsAF6hgmWAQ568LjWFlCJ9WlNyF6POxxzabOhVsoahCaRtJf6QntgS3p9qGktzmWtmQwCf9/mHiqUAOwImnqOdfppoWjzSLzkGN2jWFzxyGjAk6kjrP7yLFodj8jIJ2qJ4bjDXF2Dv/bUMytoscxAY9fAlfVOUtBPGTxcs/+Uz1C/V+pQuIuaKQNMhFVGIQgdPzeUpKgMAUnReVhbbC9x5oOnXbqs7ANkP68wpY9N/m/6NA9bcwGLyBl4OTBuEdh/LwxQT+7zO0pyAZKHifpeuC/ozc/IXsG4qmrPWZQdKOMUPMEwgl65ZdDswptJX2lPoshUZMSMunKdYTdqp1ilztaXxP+06o85mUrminqrRQyfPJQ1lTWBTUIJC2Ph94Shov0ITMCDJ8B1lrV59uOdMlX9myGMNkxlOLk4aN/tImYiUjnLuaaarIpmgOcdEjOJmhdTzL4UgqsBhrJexxhfYBa5ec9JhL69Cg+DK9+02dB69OX/UHg5f9/iZiZSX4YxVPuXWQaUFO+I/pvml2tlJUlaLV3tadU7e3Fo4PbWGtyvXgSyzloD8vrenfaaixn10q6+LRGG0utCDl/O/LGtAPv1fwdqt3LpPK4dz7bAvVqffvnvhDvL7N2G+5AKnywsH2fOj7i80e07dLIh2E7e58FnnOWPoTaHXDoNXpAulsG06xdCOQjTb1pSUhN+QnnITsR1cogdLC6JICpe2jwV/YR3eqxOk3FHvQnP2lw3ekHBrFU9+VoAG/TQujTcQsxkVoXT+s2Xkuf0T6+UBnfMfnNDlh5awFwrAFjvy45fL0/cUxi1iofucqTrQhYDJ0iaZpTV54XGhsMWS9xUkvjG96IkjrhMTp6RyVFL3QDGyDvrduTzg2jHQlSw5Ncy4x06WhRIAmrTUlAjPd4bnsyrnhynWlZpuoLeDGaFHEPg2fEPN7Em4dn1M38cRyG263FXnYeeCWAjHET+WHbSDwcKGcBQUX7g5LJUy/+cDeq2nnNyP4iCvPKNQvxHtTrLJrmjTkTCBss51x5QZn8hFFIKRJ0BEmcKS0qyaHXKYeg5zHeBwBdufdltghlAu/WunCEBydj7j6etJlFI2UlO92o6WrP+dplNww0xW38NhzC2ZcksNtkefauG92Tt6Kkd/vLjWjox5YLfdtF0Fu9EIKtMAh1oQLzQXomxryRu8fMtR3ie99X0g9AFxsG0YLI2sLrmKEo7c+lUfHvsE8vPDGoN1usU3/m2PSyOlYp37YKy1QqKGiNbYsbcHplmZV0toCI0h0Nfr1LesKSkKo9bMWCuvDyHElaGrc8fZKrhzMUpqd+BAskfba3r+4gPcXcPTD/fg4gtHV+Du4vez8cD+G9xdht9HtWxi87g9edM4gu9RxL7u8rvfQYebmj5OpjFFZH3ZVhuU8ThBOuv091y2Xyy73t7vazHvlWtu7Hl1c/XR71aE1dOCULm3EgAerOk5VmUv0Ftx+0j857b7oDmhtrq3LuKrpE4bg7Vahnfq12vf/8T6gJAGHj66Xp1wqQse7Y11Wmg9scRKmOzPpz4iNahNeKajQRzcrDov8ELo5VX+IWKKtI7Hr9ZRbvDPpZkOXPxVofKEkIjI+TUJZ2h7//LHpGYccvSvbjWP4H3oXcdADVZFSqxovs4h9pBq2/65i87A9aXjMwmMXAZnOuH6+Ge63bFR5w4pzP2Z59tl6Q3JzN2YRm5ZvLDLfnTHDl/T6gC/ZkP3CfmE+Qjxl+Y6Qrq9ZytW84HN6PoilUkV+aVboj75Clz/IsIO4tIt1sIU+ybKDS74iqvgRV19vHw93nlywbRDC0+QlOt/9E4aJyD0=
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update trust authority</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/trust-authority/{trustAuthorityId}"}></MethodEndpoint>



Updates one trust authority of the organisation. Give the trust authority ID in the path. Send all three fields with valid values. The service forwards each field, and it rejects an empty field.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a trust authority of the organisation. The value must be a UUID, so the identifiers `0` and `1` of the two built-in trust lists are not valid here.","in":"path","name":"trustAuthorityId","required":true,"schema":{"type":"string","format":"uuid"},"example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The new values of the trust authority.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ETSI_TL`]"} schema={{"type":"string","enum":["ETSI_TL"],"description":"Type of the trust list. The service accepts `ETSI_TL` only. `ETSI_TL` is an ETSI Trusted List in XML format. The service changes the value to upper case.","example":"ETSI_TL"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 2048 characters`"} schema={{"type":"string","minLength":1,"maxLength":2048,"description":"Location of the trust list. For the `ETSI_TL` type, give an HTTP or HTTPS URL that returns the trusted list document.","example":"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 255 characters`"} schema={{"type":"string","minLength":1,"maxLength":255,"description":"Name of the trust authority. The service shows this name in the dashboard. A partial update is not possible, so give a name here even when the name does not change.","example":"EU Trust List"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service updated the trust authority.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trustAuthority</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The trust authority after the update.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the trust authority record. Records that the organisation created have a UUID. The two built-in trust lists have the identifiers `0` and `1`, and you cannot read, update, toggle or delete them with the per-identifier operations.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ETSI_TL`]"} schema={{"type":"string","enum":["ETSI_TL"],"description":"Type of the trust list. The service accepts `ETSI_TL` (ETSI TS 119 612 trusted list) only.","example":"ETSI_TL"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Location of the trust list. For the `ETSI_TL` type, this is the HTTP or HTTPS URL of the trusted list document.","example":"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the trust authority. The value is an empty string when the create or update request gave no name.","example":"EU Trust List"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this trust authority is disabled and not used for credential or verifier trust validation. The two built-in trust lists always return `false`.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was registered. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp (in seconds) when this trust authority was last modified. The two built-in trust lists always return `0`.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"trustAuthority\": {\n    \"id\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"type\": \"ETSI_TL\",\n    \"value\": \"https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml\",\n    \"name\": \"EU Trust List\",\n    \"disabled\": false,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation ID is not valid, the wallet is not resolved, a field is empty or not valid, or the organisation has no trust authority with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update verifier global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-verifier-global-configuration

---
id: config-update-digital-wallet-open-id-verifier-global-configuration
title: "Update verifier global configuration"
description: "Updates the global configuration of the OpenID4VP verifier. An organisation has one verifier"
sidebar_label: "Update verifier global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWdtuGzkS/ZUCn2KgdbOVmzAYjMf2ZjUTbIzYjh9iY1RqliTG3WSHZEvWGPr3RZEtqXWxPcHkYRbZF1vq5qXq1Kk6RepBSHKpVYVXRoueuCokenLgJwTjzAwxg9TokRqXFnkImFF496Eg3T/tfjqHKVk1UmSbcKzB2DFq5eLQCTowmlYjbvS+FRNwJixZoJ+EOdqAkqR9XPZG3+gL0hKMzuZh4EhRJtlE9DA3JcxQe/AG0gnqMTXhOI5YD8gIpwSm9HBHVDhQ3oHzxpKEKWYlNW/0qQFtPDjeaKDLLBvAyFgYuLIojPUnloJFmJ3p1M4DWoNesMaRnZIF1G5G1sG/Ly/PodtuN2+0SIQpKHrZl6Inot8R4lM1Vh6za8wy8gFN+anC6V1A6aQOkkiEpa8lOf+rkXPRewhflSUpet6WlGyF8TIY5r3SY/f3oBEJm+1Je94ViyJTaTCp9cXxVg/CpRPKkT/5eUGiJ8zwC6VeJKKw7L9X5MK4x6GsTR4akxGyw5seXVCI8YC9HcBsQjqgv+QWYJpS4R2gBorrkqyx9Lj0E2PVn5GZH8kVRjtKIhDKAYKtnkFuJDHNB1JZSv0fhXG++WXmB8CEkOkfWKjwnbGhe8yLjGIUFuwyOdI+bPMxRuzsvlCWXL/updKexmRFInKlVV7monf0qt3edvq9GpFXeTAH9Y4TYXlQGhylRkvXhMs1IWdWxURWLoaS4WPIBnRfDCDNUOXLbK64Vc3PmZPOV7OUAzZtw1l+sFgsak+eCW/k6NPgVIsumOoxFIE2h+02/9vH7+BnGdJJbrJhX6H5jlQe78nQPZM2bX73jeW072FiYqGrJzMTlqZk59XQ6MIyhMsFNwpx6cg1d5xQsmaz81bp8Y7NHyk1VtbK8XL9p5Gu8zDHu00ahtxVHhxOK6GxYZfoMVb+Yk7VeHQwmD5eGvtyMxHFq1cvR4fDN+lb7MgutdudQxwedVMpFol4cp3n4bjS6iunxLfC8Zwy7p22EkZLKAG1rKgOK1FxIKNslY5qCG/CMXwtO6MuHjbepEfU6OLbTuPt6OVhoy2P0lf0GjvD7kuGxgQN+lAz868g0t+BQkZhg1lQNpBUZGaeE0s0U3dJaeW2s3OR/E2JuGZiRYFI/pfFQZf5MGjDP1YMkkDHEG0aYZn5x1UiEaklLtDH/nkXr7S6B/bRecyLmjNrwV9VFUl7WVTbv/O6+7rd6UQrKpn4vlZk6HzVW8lvsGaR1Nq3z1yIn6tMj6Tn0xnzDOHqkanjc7tt3z61uw1CPSGUZFlN+Fs3KvVf1tj6HmStsSdGEkPGn09rIblNntHj9ex9LdYqBN3AhJ3l9xS5dfn8FSUoXZQeCrSYkycrFrFN2WTNk0cFzo94rEhg8FRUwsiYdJbrj67ybUfTlYNS32kz08kzZVe5oBGWnMmmJBOuVHtmWBqVruqjIhmYvtsR7vzAEb7SWNVcknug6f7A0OztbZl1I1NqGaWk4tmyH6St0cu2MDLX7TI+zq+6IuUguAKpycnFu4GqOqMH56mAEaqM4t6WYhZArHjrDqrHRnhMPVTZu8v5lz90VetrT1ZjtlS8sM0WRty4UVpa5eei9/lBHBfqd+KPtwv2EceOsaguPCDeeMCLZft1ciASsbz6YFBy8hPD1yVFGTBBPxE90ZoetiJhWlXhakRCtFgZlWwtBbQV5aqRbt2fRAdcsHDTx1PKTeUfC6HNRE9MvC9cr9WSlJsG93RqbFH7pjJikWwvcG6NLNNA0keWeW6FC49jpcePTXfx9bYht2vgL5h/kTZL+Ffxx/ggEYq3ipETidCY89uNPnKnFzo+78MdzYErH6taWjvgxZaw6hoHG+sMIG4Deek8DAkKSyN1TxJmyk9gEG2EAbzQxlNYwFtUWcCgwJQOEqDmuLm1bA+qiT/NTWkZjsYdzX8eNAWTkHPx4/qW7Ox7300wgCOzLAaYhmJAOSoOVbXFL+vwrBBW79aPNuNap8QW8KtJUFgzVZL4GJIa9sgTKP6fL+3dvEUIF5cxoXCYEay9dtB3rkSdErz4EHKvfxA6+f0Tz2uQrPP1/IAt8iY1WThjKAdMEtI8x1Ul+8/qfOoNKOdKSsK5Lx4bQqLOV+1HWjOvdIEAHrVEK10j+Kv4eneUmZmL5KmQDtZeH53ApxN48dv15UEC/bPLf8HFaeO360v4dBJ36198gM6bdueo8RLyU5O28tP3tT15lRx9uB7JVEraBcIsc6PAdEJw2GzvhG42mzUxvG4aO25Vc13rff/k7D8XZw2es0iEVz7b4EAAS5q0XEUvNv8uhv2wfdhtHjU7PJfPljnqmj3x6vjpa4PtFK5J1/9v97/v7X5VXz3d+1aRodIctUCTh0q2PovpYbx2HKlwebIhXdWxbuP8JxKxV8BuEzExzvOSDw9DdHRls8WCH38tyQa1TcQUbUjdoL1LkQ6Kd8eKIE4iExqXbDgPz8ooEFsNDQtUnHEcbk6eHFuX7POrS5GIYfUbRR56F2Fxxr9f4Ez0xI24EcHtUB9Cv8TPH0SGelzimMfHZbmis+psCtldELLqAzu2fKXnNSO3NS36wn/Zs71TfuK8/J3mP6+GxzePTljpaBzNwedD8X8BOqyrYA==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update verifier global configuration</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/verifier/global-configuration"}></MethodEndpoint>



Updates the global configuration of the OpenID4VP verifier. An organisation has one verifier
global configuration, so the path has no identifier.

Send only the fields that you want to change. A field that you leave out keeps its stored value.
Do not send `null` for `supportCredentialEncryption`: the server answers HTTP 400.


## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The settings to change. A field that you leave out keeps its stored value.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"supportCredentialEncryption"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` when the verifier accepts an encrypted OpenID4VP Authorization Response, that is a response mode of `direct_post.jwt` or `dc_api.jwt`.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"presentationRequestExpiresIn"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 3600`"} schema={{"type":"integer","minimum":3600,"description":"Lifetime of an Authorization Request in seconds. The server writes this value to the `exp` claim of the request. The smallest value is 3600.","example":3600}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server updated the verifier global configuration.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>globalConfiguration</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Global configuration of the OpenID4VP verifier. It holds the settings that every verification request of the organisation uses.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Record identifier of the verifier global configuration. The server makes this value when it saves the record. It has the same value as `verifierGlobalConfigurationId`.","example":"665f2b8c9a1d4e0012ab34cd"}}></SchemaItem><SchemaItem collapsible={false} name={"verifierGlobalConfigurationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the verifier global configuration. An organisation has one verifier global configuration, so the read and update operations do not use this value.","example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdOrganisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the digital wallet deployment that holds this configuration."}}></SchemaItem><SchemaItem collapsible={false} name={"supportCredentialEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the verifier accepts an encrypted OpenID4VP Authorization Response, that is a response mode of `direct_post.jwt` or `dc_api.jwt`.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"presentationRequestExpiresIn"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Lifetime of an Authorization Request in seconds. The server writes this value to the `exp` claim of the request. The smallest value is 3600, and the default is 3600.","example":3600}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the server made this configuration.","example":1747011600}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Unix timestamp in seconds when the server last changed this configuration.","example":1747011600}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"globalConfiguration\": {\n    \"id\": \"665f2b8c9a1d4e0012ab34cd\",\n    \"verifierGlobalConfigurationId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"openIdOrganisationId\": \"string\",\n    \"supportCredentialEncryption\": true,\n    \"presentationRequestExpiresIn\": 3600,\n    \"createdAt\": 1747011600,\n    \"updatedAt\": 1747011600\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

`supportCredentialEncryption` is `null`, `presentationRequestExpiresIn` is smaller than 3600, the organisation is unknown, the digital wallet deployment is not resolved, or the digital wallet refused the update.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Global configuration not found. The wallet makes the configuration when it deploys the organisation wallet, so this error comes only when that step failed. There is no create operation: contact support.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update wallet unit
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-wallet-unit

---
id: config-update-digital-wallet-open-id-wallet-unit
title: "Update wallet unit"
description: "Updates one wallet unit that the wallet provider manages. All fields in the body are optional, but `isAuthorised` behaves differently from the others: the service always forwards it, so if you do not give `isAuthorised`, the service sets it to `false` and the wallet unit loses its authorisation. Always send the value that you want to keep. If you leave out `clientId`, `clientUrl` or `clientPublicKey`, the service keeps the stored value. The organisation must have the wallet provider capability enabled."
sidebar_label: "Update wallet unit"
hide_title: true
hide_table_of_contents: true
api: eJztWWtv27gS/SsEv9wEUJx3H8ZicdM4bZ304W3iZNtuANPi2GYskQpJ2VEC//fFkLQsy04aLHovcNH7JbFlcjgzPHPmoQfKwcRaZFYoSZu0m3FmwRAlgUxZkoAluRSW2BHDP+XDTKuJ4KBJyiQbgmmQoyQhAwEJN0RIt7SveEGYBqKcdJZEpJ9b0hPmKLcjpYUB3iN9GLEJGMLFYAAapE0KMtAqdSKUHYE2TffZgJ6IGAhLpqwwZKD0lGk8zUbEKCIGpFA54YpIZclQTKB2UrQkxYDFrcQq0huwxECPMMmrJjq7E2UA1xnCgiSGtqC5TgsDYdOEJTl4N6EaUyad7DFA1iBtr1sCbAJEoQ/iRIC0bdQqfO7qpEeUnn/t5P1ExGdQ1PRGgcY/sUoD9wc3yAV6Sw+ZDBqSNDeWoGvXXlvMMtYXibAFAcn6CfAGjajKQLvdbU6bNFZyIIYeES0xFJYlV07M5wxkm/vPXSksjWjGNEvBgja0+f2hDiopbnMggoO0YiBAEzUgbMnPGobCWB1Ud5jipF843f1BpBN0R0UFis2YHdGISpYCbdJpqU6b04hquM2FBk6bVucQUROPIGW0+UBtkeF6Y7WQQzqbXfvFYOwbxQtcsaz9J5h6JzvM1RHSWHNWrKQFaVEUy7JExM6s7RuD8h5WVVH9G4idFzXegBVg8Nc5RlaVjmoqHruVNQdXFBXSWCZjBxNhiDCEkVa7hXBjpPvlg4dPHSO5hz7COEguqkJ5jrqQz+3WweVx20WPA0br4LJDBomaGi/2aeSS6Qikiw4XSkwSSDNbEG8pehfuWJolaD0XvDmGonm/x9P71qvdeNi5e3U5Fi9P+3n+MX37VV91hl9VYYtx99s+FLcju3vz+qxvTr5OuL65+3jzx4HN5A28ftN6c3Gff2p19sdSvrj98O1E3/OD/unhUO0dH49U54Yfvjt6v3+fvT3tHA7y6fn4xYvuYef2xcno7YE8k+/vW/JennReDf58/Vp+ezec9o9Gu+rlu5vdPw/3Lvho8LJ7cPb+zdtPn/6gs4iWMf7jy+x++UBA8kwJaR+7xyW3jKzNTHN72y9qhB8asUoXJ5d0sg52jHPhGbpTAaDH8rJuXgwZQ/GIZsj9p1dnGCkps0/gyiIQUY5VZAJ6jq0Q6xjG5MhaMNZTQkcrNcAzO8oYMAY5GK2rMnzFtL5SCTDpfDtgeWJp05F83Z5z8BkAbe3hpznLw0qckyO5+JUvkVfMJAkUQthjJiwHQ5m9nB9c3iRTYUcEJqALkjvSnQt1+Q2TB8absC6DrOavJVCgQbPZrPLkoYrBpzBTd2oQNUOeM5mSxrPT3s7OKleuvW5ny0pqRXV/ElEuqP9JjUKiiZXmhA0seC736qE29UOssC6+lhPd0sniGeS8mv3WpJGgV4N0HfSECezIPGP2qtmtRzDzkTLlNhZh/jOTRURskYmYJUmxSBcuWXQxAP5JVsi0sipWCRHSgmYxamQaP58fI+QY7vzMhYbYklilaS4DwBo/gRdlniRYN/2QJ5ENn9RyQYD/AfKrKnWFmdZTXeQxVgWgKEvc+3C74Y48L60pxP5l5nTm75AZgz5S8kKNQT4biOU2cnp1UXMVala5zM9oL9lr7JA47M3tCDEYlxRbRo5A7WINmIQ0MItkybDwiTU43LLEoTM0DFMtLARCTdRwnUUXzpofWYWr5lbEdQstyvHwQ52AH9mKRPT4EDSNqE+f/tGLg3WUckesSBEhaUY2hERbleRm09dTK7c7ZSbU2KCx1p9FNPDyf0uDQLyoSMKMJaniyD5elwW9tQAB1UmYRQ1+7G6/nmRhwxr8+MQ7lmoq53U8NqU9oQx2X0xyrQT37V+v2kL1llM2V2AcVOIRxONF07dcjAlllg1qo0u1sMUzoyIYJObbPGaIyTFBLpqiqmsD51Z7qMjFS1ALq+qjLAucgjTeSVhB2stH1C7iDIrnZJP2ShqJdZFZNdQsGwUKrA8PKh0fotGpyiqV0rIiH8EyzuzaOuCfM/RRuZOk4YD1epaOX+PlBvVl0bz9+44FQSUXV/PaasapEfgKga7lnypzVGP4iRh6Ao2rF77W89d1MysV17UrDUfAuGv+H/Dbga8Nn13eVUWD1kofK46mus+tyr1dr1ZpywXZYvc6UivD9GBnZ7ZG/Bq0LyL7DeNEyCy3i8qLznxhvFpyztsBNwMTnjcmLBE8Wo3eOa/AncBaPxSHS8OcIIHVi2vknrrrd39h13flooZZcc3hL41KjHyNdIf5DDRxx9R8NIuogThHfnBjvKNMuNL4+zVOySwb4nSPhlngvBzcmNf3x5s0orUaEX2Tgh0pHChmuR8V2hFt0u3J3rafMG5zL3DLg3tbZSAFD63p1hzq8+8YM9sP1X5oRlFtNGrd8LEFqQo2I2Eudb8cUrXFMtEQQ82kbQhFZ1FdQEcrnrtW5TExP5JwbtkQU8cj243/ua7I9eIyzhGTHkrzKykxwfyDMBP1t7mYiob8cu8wvpK8jzptl6BXy+j5QDvk9N6SnB7xx/gZcx9IpmEg7iCMMHpeR9IjG1JZP0mxmonE+SBjMWxGBBrDRk1sk4SNvxUq1+iOrTEUv/d8lsX4/LKY057U5xpuZP2/OiGMnj+cWe1bVzpBN7FBQAzUnPBY7AgPUibwBCxqlLb/XsCtRIx4t3i0jNMqxGtAKjfNM5NrtBSqjV0V/k9BhnY2YMrThiv+LrH/FViskeOyOzOkbUzuhoobYZywWZkn1Dd2NJjyiJKTOpvl0MGE9hBB7995mJBkPfyMa3qNySEiI5XwyB0WWvNAUZXm0ZDcOEBbJjmO8racvQJf/Ljptw+G4Gmn7dX+Mbk8JhunVxebEWmfXLwl560t7Hovj/1p7fPPZPfVzu7+1iFJWyreTlsfqg2r78oMpv1ExCCNC4B5rGcsHgG2xytXN51OG8z93FB6uB32mu0P7eOTT+cnW7hntph4La4TncVVnJe3RyOKROuvfW9n76Cx39jFvZkyNmWyoo9/c1StdeoEVEnG/3/z+Eu/eQzJzMKd3c4SJqSbUPhxoC8YvtPJnh8ZD4RrQ5eKBv/yUopFA1MWDosnAYLNpVeF1xEdKWPxgIeHPjPQ1clsho9vc9Cu+InohGnhe0msL4Rxeq9/p1DF9MaXUEJukp//DnSty+ZFgcSKwF0QbVIa0TFmiuV3pLPrsm9zZvklx175rdBszkWsVMpY5fgdR3EMmX1ybbUI7HQvaET74VVr6opiqtkU36OyKW3Sv+hf1F2nI2VXiOPzB5owOczZENd7sVgWYHAsV0NjVw2FD2jYWp/UCyNvC/5Fy9Zu+Q3J8AyK38vl/pdHN5TFmF+NN4Td8t+V2dM5
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update wallet unit</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/wallet-provider/wallet-unit/{walletUnitId}"}></MethodEndpoint>



Updates one wallet unit that the wallet provider manages. All fields in the body are optional, but `isAuthorised` behaves differently from the others: the service always forwards it, so if you do not give `isAuthorised`, the service sets it to `false` and the wallet unit loses its authorisation. Always send the value that you want to keep. If you leave out `clientId`, `clientUrl` or `clientPublicKey`, the service keeps the stored value. The organisation must have the wallet provider capability enabled.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of a wallet unit registration managed by the Wallet Provider.","in":"path","name":"walletUnitId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

New values for the wallet unit.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the wallet instance. This is a DID or a URL. The wallet provider uses it to identify the wallet during OID4VCI and OpenID4VP flows. The service keeps the stored value when you send an empty string.","example":"did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbsEYvdrjxMjQ4tpnje9BDBTzuNDP3knn6qLZErzd4bJ5go2CChoPjd5GAH3zpFJP5fuwSk66U5Pq6EhF4nKnHzDnznEP8fX99nZGgwbAh1o7Gj1X52Tdhf7U4KHBFNNQ"}}></SchemaItem><SchemaItem collapsible={false} name={"clientUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL endpoint of the wallet instance.","example":"https://wallet.example.com"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientPublicKey</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key of the wallet instance in JWK format. The wallet provider uses this key to verify the Wallet Unit Attestation Proof of Possession.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Public key of the wallet instance in JWK format. The wallet provider uses this key to verify the Wallet Unit Attestation Proof of Possession."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAuthorised"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Set to `true` to authorise the wallet unit. An authorised wallet unit can request a Wallet Unit Attestation. The service forwards this field with every update request, so leaving it out sets it to `false`.","example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet provider updated the wallet unit.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnit</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The wallet unit record after the update.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the wallet unit record. Use this value as the `walletUnitId` path parameter."}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client identifier of the wallet instance, typically a DID or URL. Used to identify the wallet during OID4VCI and OpenID4VP protocol interactions."}}></SchemaItem><SchemaItem collapsible={false} name={"clientUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL endpoint of the wallet instance, used for direct communication."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientPublicKey</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"isAuthorised"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, this wallet unit is authorized to interact with the Wallet Provider's services."}}></SchemaItem><SchemaItem collapsible={false} name={"assertionToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client assertion JWT of the wallet unit, used for OAuth 2.0 client authentication. This value is secret. Treat it as a credential and do not write it to logs."}}></SchemaItem><SchemaItem collapsible={false} name={"assertionTokenType"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the client assertion token."}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when this wallet unit was registered."}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when this wallet unit record was last modified."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitDevicePlatform"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device platform of the wallet unit. The known values are `ios`, `android` and `organisation`. The service does not check the value.","example":"ios"}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitIntegrityToken"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Device integrity token supplied by the wallet unit during registration, for example an App Attest or Play Integrity token."}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnitKeyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cryptographic key that the wallet unit registered for attestation."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>walletUnitMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Additional metadata that the wallet unit supplied during registration.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"nullable":true,"description":"Additional metadata that the wallet unit supplied during registration."}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"walletUnit\": {\n    \"id\": \"string\",\n    \"clientId\": \"string\",\n    \"clientUrl\": \"string\",\n    \"clientPublicKey\": {},\n    \"isAuthorised\": true,\n    \"assertionToken\": \"string\",\n    \"assertionTokenType\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"walletUnitDevicePlatform\": \"ios\",\n    \"walletUnitIntegrityToken\": \"string\",\n    \"walletUnitKeyId\": \"string\",\n    \"walletUnitMetadata\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request body is not valid, the wallet unit does not exist, or the organisation is not a wallet provider.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Enable wallet provider
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id

---
id: config-update-digital-wallet-open-id
title: "Enable wallet provider"
description: "Enables the wallet provider capability for the organisation. Send `isWalletProvider` with the value `true`. The service then registers the organisation as a wallet provider and the organisation can register wallet units and issue Wallet Unit Attestations. If you send `false`, the service keeps the current value and returns the deployment details."
sidebar_label: "Enable wallet provider"
hide_title: true
hide_table_of_contents: true
api: eJztWOtv2zYQ/1cIfmoAWZbddOiMYVhqZ4O3og3iPD50AUxLJ5mLTGrkya4X+H8fjtTLjzTdsH3avrQOxbv73fuOTzwBGxtZoNSKj/ilEoscLMMlsI3Ic0BWGL2WCRgWi0IsZC5xy1Jt3BVtMqGkFUQdshmohM2lvXeEVxXdnG0kLt31tchLYHM0JcxDdrMEZsGsZQz0VTEDmbQIxh7xZsIycQRIqOT4ZixaRjVFqSRad11aWwLzANmtksguEMGio7Uhm6Zsq0tmnSapyC3MAyejBvoIUHh8cWkMKKyUIuYGsDTKf02gyPV2RRcSQCFzG/KA6wKMEzVN+IjHWqUyuy0SgTCRmUSRe2QfC6AbATfwewkW3+lky0dPB766+bKPUDMLeNpVFWtpIOEjckdAYBAUkhhRFLmM3c3+b5ZkPXEbL2El6BduC+Ajrhe/QYw84IUhrVCCpa+H3u9QLLTOQSgeHOgxAySwPizoF7ggfCEG9+NHZkqbKm6rKPPec445dpoFRKkyMgR8FqsiB2+H3W7XOTmlTnVrRxa0hVbW6z2MotMeqhH64AAfsc7BE5Z4p9dano6Zf8gxIgOFMw/mUiWFlp5nRWXRSJUd+eadsMBur98znXrg08n53XjqrOqVOL+7anSsLh2GWmNPvkQs7KjfF4UMZWaEwlDq/nrY75L0vxkm30K0+BbeLAbibRRFgyRK3y4G/UoO3wU8NpCAQinyj2kK5us1OqHMuOHFHDMGFbd/A3y/Rd7TJI20WYOx0vvzy+hnOsWNMMAqiloVHzqQMOfmfdyDMAojkkJlrrQdIVIhZGCOpEzaQPQ0tRjPnc2jOZOWfdDIxq6GlQaSkM0H7vjaFy13MnQnkwqdw6XKFR99ioJBMHzowBw2AGdoXjbElyFSv0D4jB2BfB8tD3iDkwe8Rsi7kNrTXcBzSDIwH8QKXgZHtxrPSLq0KBES5nkwXArsYC0tWFemJ9NJ1brMidy5LCmfhWLvch0/xkshFavy2bKpSo2waMoYSwMt3tvr938pJY7Rns6BZbkIYWFlCGW/lTadfEVwTV30pxJMLbQyiwLcaPO4X9gTDZYp7So2w6W0LJWQJ64AiXwjtrZpu/Novgc22gVc7tnlRFN6xiT79mz7j3PdUlu0nXzYs5D8qaoMZJa2ol9D9lUJ/hPozIhiKWMXCm2G+1hpGZ4KjhH70Qj1mJYGSfrf6MX3NIf5Thwcz1byuSmMhq4XRqvjTtudQT6d7k/P1/m2ZjZ1rVs/9vK1mwydUH02Ok747YQxH9wQsASRgKGiSn+d+yngq1t21wBgjDZjnRBe93vS8cxD8EJ7b6lPZWBj+fOIsuKI/YmwbGPrnUiYVEWJrBBGrACpZ/kR6HjcOYqX3IBItsdxE7BqMK0zPRaK8tyA1fl6b/rbD/pDiw/+wxa/VaLEpTbyD9fF9k3z5j8djFOFYJTIXXzRTEdiDmxEIwfEpZG45aNPT/yikL8A/XzYkY4is2SLajWrS9ureu4dn/GAV4dtVQj4CnCpab8rSmcagUs+4jQo+oWvX439PR/efV2AkuQ+j9Q6KIfTzkpXivCAlybvtOIEVrq3N5PyXXDI4MropIxdUj7D5iUOMxSZVNlz5NZ/PgTy0Fp4RoHm46O2c+No4Q+oIhNP5yIecOWmLX5RxbgL3KOWdXE1ZY+wZZQJ1Cni6jXiplkFqw463+MzZ14MW5UW2YJ6PKTyMyT+uWLuMbI5e6U0+nKERsjc2aAQMZwFDMIsPGA7YhXhd1tdGjJH7xG2389DTtFGSXfd7vSXLy6arkfpOo1F7NIYVkKS7W1ZFNrgD629G5O1U8iho7o+PrBkQ1QXaWr3sSaICEzS/1SEfW2vdyi/ydL4egdGptKt7u1GZdnU2lKoGNirat8662yPh4RXBmwjosm0qzNChDrWuSXHSsvI61A9Vvme4+1v6QHBjSIBW+o8CZywNUnYNvt23IFXWudRFCoRJrE9p68UClma64310VBZ2qG9fz1md2P26uf7m7OATS9vfmSzSe/n+xt2N/bSprOPbPA2GrzuvWGriY77q8n7jkzishLoRqJcxqCsi4A62AsRL4ENw+jIdZvNJhTuc6hN1q9obf/9dHz5YXbZG/o1DyXuT6LOWImOy8Z7nfFpxIfR8Dx8HQ6IttAWV0J18PgXwcPufZiFnTbz/xviv/uGWJVMWm/7RS6kIr+5QHmqes0nvh76h6NUug1jr9/4Z0jqOA8Bp1WGCJ6eFsLCrcl3Ozr+vQTj+mDA18K41HRdsW6frkU9UgnnY+/33g3Bout56Sv6wahBHcVTXMQxFPjFu90uenV7wwO+qJ5AV26q4EZs6A1TbPiI/8p/5U4pZ383ydD5E8+FykqR0X3PlkowtYn9zvPoOk/1gxSrP6ltB+RhE/K60L+k2UmS7yjvfoHt9811/+VZgqbx+dvkWtoy/gR5L052
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Enable wallet provider</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid"}></MethodEndpoint>



Enables the wallet provider capability for the organisation. Send `isWalletProvider` with the value `true`. The service then registers the organisation as a wallet provider and the organisation can register wallet units and issue Wallet Unit Attestations. If you send `false`, the service keeps the current value and returns the deployment details.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The wallet provider capability to set for the organisation.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"isWalletProvider"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the wallet provider capability. The service ignores the value `false` and keeps the current setting.","example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned the OpenID digital wallet deployment details.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"agentServiceEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the OID4VCI and OpenID4VP service of the organisation.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialOfferEndpoint"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the OID4VCI Credential Offer endpoint.","example":"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/credential-offer"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Software version of the deployed agent.","example":"1.0.0"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** [`0`, `1`, `2`]"} schema={{"type":"integer","description":"Deployment status of the agent. `0` is Not Configured. `1` is Requested. `2` is Deployed.","enum":[0,1,2],"example":2}}></SchemaItem><SchemaItem collapsible={false} name={"statusStr"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`Not Configured`, `Requested`, `Deployed`]"} schema={{"type":"string","description":"Deployment status of the agent as text.","enum":["Not Configured","Requested","Deployed"],"example":"Deployed"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the distributed ledger that the agent uses for DID registration.","example":"European Blockchain Services Infrastructure"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerURL"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the distributed ledger.","example":"https://hub.ebsi.eu/"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerID"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the ledger network. The service does not set this field and always returns `0`.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Infrastructure provider that hosts the agent.","example":"iGrant.io"}}></SchemaItem><SchemaItem collapsible={false} name={"deploymentRegion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Geographic region of the agent deployment.","example":"Europe: Frankfurt"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the organisation is a wallet provider and can issue Wallet Unit Attestations.","example":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"agentServiceEndpoint\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service\",\n  \"credentialOfferEndpoint\": \"https://api.igrant.io/v2/organisation/62d9e0b9e5b1a80001d0f8b1/service/credential-offer\",\n  \"version\": \"1.0.0\",\n  \"status\": 2,\n  \"statusStr\": \"Deployed\",\n  \"ledgerName\": \"European Blockchain Services Infrastructure\",\n  \"ledgerURL\": \"https://hub.ebsi.eu/\",\n  \"ledgerID\": 0,\n  \"infrastructureProvider\": \"iGrant.io\",\n  \"deploymentRegion\": \"Europe: Frankfurt\",\n  \"isWalletProvider\": true\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is already a wallet provider, or the service cannot resolve the wallet deployment.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update sandbox organisation
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-sandbox-org

---
id: config-update-sandbox-org
title: "Update sandbox organisation"
description: "Updates the name and the description of one sandbox organisation. Give the sandbox organisation ID in the path."
sidebar_label: "Update sandbox organisation"
hide_title: true
hide_table_of_contents: true
api: eJztWWtv2zYX/isH/JQAii+5tJ0xDMvibvPWrUHjpBjaAKGlY5uLRKokZdev4f/+4pCyLMmy42bFvnT9kMoSz4XPOTw3LlmEJtQitUJJ1mO3acQtGrBTBMkTBC4j96O0DNQYlEQwXEYj9RmUnnApDKdvLfhFzNBRNH2GQR+EdJ9Tbqetj/KjHNJa1DMRIoRTLidoQMl44VaNBcYRqcMtLFQGBmUEc2GnwGHG4wz9J2FAKgtcAiapXYCxWshJC4YKHhFT4J5RADHyGYKwoDLbAhItce53mmTGwgghk+JThms1K5sjdf9SGYRckrjMgeWWJVxImPM4Rgt2qlU2mYKdCgMoo1QJaVswGLuVEzFDj4OpUwYetxwLWmjg1+HwGs47nYK+EVZhIMI0VguMqkx4bJQDLTfperNrs9KLsmmtAmFNrk+LBUylqJ2MQcR6LFRyLCbeSW68Im/1hAUs5ZonaFEb1vuwrDtVjmiE0oqxQE0etGsvJFQQFTkICxipy3rMFNIGEQuYxk+Z0BixntUZBsyEU0w46y2ZXaRuvfMAtlrd+8Vo7E8qWtCKqnLDjZft0YqA8c7ZapAeKmlRWmLO0zQWoaNp/21IwnJbOTX6G0NbYfShtEN2H7BUE/JWoHEcNt++ygbqelhhYyyO/8ayPyv9NkXpIK9q5M1Shzuo6fbn2t/2GdwfwwOPIB0DDpEYj1GjtM17nXKTi0s85/0n67IaNlzI8AzCTDspxINww888SR1Sl2GCMERjYWBMhpqtans/BJpaUN2N0NMallhVFb1pAmisNAhjMi5DBIvGGraifyXCutPl53Br3/V9faE8jSZV0ninOu10mv17bTkfcaO9weNfPox1LtW1InraE74oPJKfHXb2+sKkMV88ef6+2HN/zRIuQSOP+Cjeqgz2iVEulvRdpkpQ2sEB6Ay2YOHGqFA4P3DBqZ/nPuJIUozlNjMlzkJanDS5qlsIoYqeBCjGaIK6ou8urnsV9nyIo5BjzY3VWWgzjddazUSE+oC4UTJnlQekayargM1Qm4OseecX7s0dPu1nuoBDq/gAD3yn4r3ArgM8hsosjMWEWFudGXspw6k6AIwhLQbuVlcOkIb+oO9gNu9dLdMA8EipGLncNqCMKGiggfkU7RS1r+Qad8BDa4Ab4Ovir2wDg2Gm8Y5nsX2W36RaJFwvwPOBmWNU5Vt2c641X1DFlMUxncx1dbJLzKZeKPHPa+2dJssMGp+xXc0BU0WFxwPJfCC85G5SyspSVaS5Ys9i0nRaKTvEaqIGCZ/g8yIFkYMg+rLKwgAfGUqaB+lbYkLgh2qG+h/o5Oj/sVJlLqwM1K2On9bqOhvFIoTbd29cZq5CVd3kc/mVFHQMNVL8uzzkIAxFgsbyJH0Cijk3kPMlEXlt8NVFxNysW73IR5Q/uJDPjyPlvq+aZlbVGkRE6/anyrkxjxZpr5SrdiaZTXrIQ3k17DZEzWowq/lb3V/K5i7bpcDufsseuwzAxxa9Q3k2Lba/SqV6i7149eo77PLz8GJ0Oj7rdDpdfha97HY23eRXq2Kba5pdGnQ3ZuqdlouKzu56gIlfNJe2ZLMe67Y6rc7adj1WM597sZ33xjw2WEtKnXoyoTheC7vNm3kx7rB6MNy1slt3mB6bWpuaXrsdYaJOeCpaYkK7bAnVnp22lRwprqO2Cx/tXfLbcxxt+d5XYd1ds95Ere7Li/OX5xcvX5xXIo1//eq7TmcTGBzQvruZIo/cTGRJv859e3Nwg1IOBqi10lcqorPqnvslf73f7uirbciGuik2FqfpvNNZNbBviP+b/vInHoGQaWahmAGte7vtM753+PWctj7PNsX8UGVx5EaBblDoEpEbetD4g37lVdoT86e62brfsNluJc/sVGnxP4waoDn/hqEZ1oZTRYXbWErQ0NoVAIP+to9dfNOhYSAtasljd45RgxNTw2jd9wi7cCPmy1T8jvR4TyNeyyc0eWZ9MRGWx+CTHxz5AcH53dUxC9ZJHQ2hkqCdKkpaaeZAoWlzj1GK8N1uO7fiidKT9rI8fl65aogUbRp29zFR+T6o+HkiJbFVUGdwrVWUhc5ndrB5isON5ROaEu4gN/5zXZH7DcA35GfePdYwb7pM/yIf0nsLlQqrPFbwvFKtKnZ5PYBHXABFFOqLwtIA2N/m5IH5ocLnAbyYYj6cahyLz5jfBD14HeEBjqTK72Os5iJ2GKQ8xOMAsDVp1dj2ICf8fqEyTXCcPOLih4eWq8TpzL3bXBy8/vfmoq4WVOtwwEMXDjDhgoxosjRV2v64MVyBvS8U/auqxcvOUlOrIFpPLmiWESraq0UQ9D9Vtbw83sunbqT8HWoxFm4OeKXRNbs8Ng4Dt6ejt+70DY7djVMz4bVGU4goTuz1MWlkVahiN3AQBsh9UBKNyWH0hjTu2opgD9w8InDCZiRhAVEeEcKSeplxrmG5jLiOzInbr+DSwjhWc+PdKkfaafv+7AruruDot/fD4wAGr4c/w03/5Lf3Q7i78tIGN2+h+6rTPTu5gKSvwnbSf1OSSVwSbg1F/liEKA2WnSfl4RTh1BX1VdPN5/MWd59bFIhyWtN+M7h6/efN6xOiWW0ucDbmJLAiFWaF9SodxGnn9Lx11uoSbaqMTbgs6eOvgZqHoVvD4iJn/Xd5/N/lcfXyOE8ZFj/bdhpTc7TK/XuZJ9wPbHbq72zGgoqHUtJlAetVbn3vAzZVxhLRcjnihvq91Ypef8pQu1IgYDOuhR9+UmYWhp6jovnd6bpH7/KC6hi++La6cZfrbCkpVTpn8335IyXT6m326r7oFJ3WfsmV1+1kSIw2LLbKQkr/nuIyDDG1e9eW657r2yEL2Ci/FE9cBcg0n9Ncgc9Zj31kH5kbcLgY66pOer9kMZeTjAZ7PebZUs6inF4tEx5dmZA/0MYaMalXDH4v9Jd21kjyPcW233HxQ7Hcf9lJUFQpfjVZ6H61Wv0fBylCJQ==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update sandbox organisation</h1>

<MethodEndpoint method={"put"} path={"/v2/config/sandbox-org/{sandboxOrgId}"}></MethodEndpoint>



Updates the name and the description of one sandbox organisation. Give the sandbox organisation ID in the path.

The service changes only the fields that you send with a value that is not an empty string. To keep a field, leave it out. The new name must be unique in the organisation.

You cannot update the main wallet through this endpoint. If the given ID is the main wallet, the service gives HTTP 400. If the sandbox organisation is deployed, the service also sends the new name and the new description to its wallet.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique identifier of the sandbox organisation.","in":"path","name":"sandboxOrgId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The fields of the sandbox organisation to change.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The fields of the sandbox organisation to change.

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"New name of the sandbox organisation. The name must be unique in the organisation. If a different sandbox organisation has the same name, the service gives HTTP 400. An empty string keeps the current name.","example":"Acme Test Issuer"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"New description of the sandbox organisation. An empty string keeps the current description.","example":"Sandbox organisation for issuance tests"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service updated the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sandboxOrg</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The sandbox organisation after the update.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human readable description of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"openIdDeploymentId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the associated OpenID deployment"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Status code of the sandbox organisation"}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the associated ledger"}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the infrastructure provider"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the sandbox organisation configuration"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role of the sandbox organisation in the ecosystem"}}></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trust anchor identifier or DID"}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this sandbox organisation acts as a wallet provider"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVault"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Identifier of the primary secure vault"}}></SchemaItem><SchemaItem collapsible={false} name={"secureVaults"} required={false} schemaName={"integer[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"Identifiers of the secure vaults that the sandbox organisation uses. The field holds `null` when the sandbox organisation has no secure vault.","items":{"type":"integer"}}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the logo image. The field is absent when the sandbox organisation has no logo image."}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the cover image. The field is absent when the sandbox organisation has no cover image."}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the logo image"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Public URL for the cover image"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was created"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp when the sandbox organisation was last updated"}}></SchemaItem><SchemaItem collapsible={false} name={"isMain"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether this is the main organisation"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"openIdDeploymentId\": \"string\",\n    \"status\": 0,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"string\",\n    \"version\": \"string\",\n    \"role\": \"string\",\n    \"trustAnchor\": \"string\",\n    \"isWalletProvider\": true,\n    \"secureVault\": 0,\n    \"secureVaults\": [\n      0\n    ],\n    \"logoImageId\": \"string\",\n    \"coverImageId\": \"string\",\n    \"logoImageUrl\": \"string\",\n    \"coverImageUrl\": \"string\",\n    \"createdAt\": 0,\n    \"updatedAt\": 0,\n    \"isMain\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"sandboxOrg\": {\n    \"id\": \"6889e1a4c5b2f30001a3d710\",\n    \"name\": \"Acme Test Issuer\",\n    \"description\": \"Sandbox organisation for issuance tests\",\n    \"openIdDeploymentId\": \"6889e1a4c5b2f30001a3d711\",\n    \"status\": 2,\n    \"ledgerId\": 0,\n    \"infrastructureProvider\": \"iGrant\",\n    \"version\": \"1.0.0\",\n    \"role\": \"\",\n    \"trustAnchor\": \"\",\n    \"isWalletProvider\": false,\n    \"secureVault\": 0,\n    \"secureVaults\": null,\n    \"logoImageId\": \"6889e1a4c5b2f30001a3d6f0\",\n    \"coverImageId\": \"6889e1a4c5b2f30001a3d6f1\",\n    \"logoImageUrl\": \"https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f0/web\",\n    \"coverImageUrl\": \"https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f1/web\",\n    \"createdAt\": 1754745764,\n    \"updatedAt\": 1754748900,\n    \"isMain\": false\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The given ID is the main wallet, a different sandbox organisation has the same name, or the service could not send the change to the wallet of the sandbox organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation has no sandbox organisation with this ID.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# Update webhook
Source: https://docs.igrant.io/docs/openid4vc-api/config-update-webhook

---
id: config-update-webhook
title: "Update webhook"
description: "This endpoint updates a webhook. The request body replaces the payload URL, the content type, the subscribed events, the disabled flag, the secret key and the SSL verification flag of the webhook. The payload URL must start with `http://` or `https://`, and no other webhook of the organisation can use it. Subscribe to a minimum of 1 event type."
sidebar_label: "Update webhook"
hide_title: true
hide_table_of_contents: true
api: eJztW1lz27YW/isYPCUdSt6SNNXtdK5rpa3apM5EdnLTxGPB5KGEigRYALSsevTf75wDcNMSO2n7VL94TBDL2ZeP0C1PoDAQCwcJH6QisxDxBGxsZOGkVnzAz2bSMlBJoaVyrCwS4cAywRZwNdN63mdnM2AG/ijBOnalkyUzUGQiBsvcDFghlpkWCTt/8zKigVgrB8oxtyzAj9jyCg+8goTBNShn/XAirbjKIGFpJqZhJsQGHJvDkgmV0NB4/JJdg5GpjAVSTLOZTullh8YWJSwvrWPWCePYQroZm8ycKwZ7exOmjX+w+BTRMUoz7WZgqu2q3bWZCiWtPzYWipUWmHR9Nq4YYk4zwXKpZF7muOzAc0jM9z+qj4qkK1GeaZlllehyUC5iSjsmWCGMkyILku+zMSiSk1myVEKWMK3CYyyyLGyKojLXMgY2Byi8JiYymXgxTrSZjuoHK1RypW9OaayW68TJHKwTeTGp+LVOG0i6Qm1Ps04s/VGxAS8VfNv/qHjEdQGGxkYJH/BYq1ROz4mld34/HvFCGJGDA2P54MPthh0CGw3XNIsCDoLhEYcbkRcZ8AF/9lwcpIfxUfIEnqbPxNdXz+Nvkn044BGXuFkh3IxHXIkcZ4fNRgmPOFqyNOgNzpQQcRvPIBd8cMtRZ3zArTNSTfkq4tYt6TAr6dTVhV8N1n2vkyUuCbaO/4qiyIKJ7v1ukaPb1t6FQfk4CRafAj20LMtOU5JGQ9gHHkz53GQ8qg45Q/Ii3jjTC/IlHCKv+QWW/CKquNBXv0PseMSddMTECaoMTs26TjaVUIne67A0QdPaax3doqUV1rZFOVXagA2WWFvhFgtsm5VM2VKXzIK3zLzPRo45MQ8BpuOFqdF5beJCyT+DyU3YDEQCBq2kK+uWKDd0vI37n87OXo+RR/yHYombCccMxCCvA0mVhMLeXgjXIivhvoGHhEBzr4CVSv5RAktRsGsMd62+Wh5G+rHO95AQuyenRiiHRtu2lnsx3I7X695XM/gDUt828ZveYrHopdrkvdJkoGKdQBVxfh6f/lpHY2lRs45JxQSzUk0z4jQPwQ09NGGTMHtC/KoyRyfY8KiI30kBv1htcZFGDhtuscWdNkXUxHTrraEto8oyImTxiE2NLgvbZ8fdtBAEe8SEMRhFSfcznSWfyB8d3zKQlhYTs2pN8dRIS6lEKjoik9bhVtJZT0x3n0SDn24g19fAktKLNBiw3fSgWCvU4CuhxJQy17smfAWxElMbojvxC1ler2xLksiyQbiW6TguDVvMQCGLUiXyWialyNiU3E6bWgKBngjHhJ1bjEYJZOAgYoleKDI7bUKEQplIwxLhBLImHeT2bscYr5UsLbOknUL0k0o6SbVV1BmPhYohy2g8kNsXWaYXnREsgDYGRen0JdwU0iyrTT1zm4dVzG5541e0yeiuaN5crFYRT+RUOpG9E1kG91bv0C9iC1rVVe0LKlhOR8Mnb0/CG9Kdw3KIrPI/IYwXoGTS/2oSzI8JAz4KqmxZjZGVCxX2G6FyTwtQ+PSaSeVgGpKUAkhsKFwCT5661gFXkGk1RaOhY7IEDBuOhic6z1lhtNOxbqqsir7YQAIK6zTcKZhsqlF7tI20tgTDrEwohrZohZt4JtQ0eHO134zOvXNbP4227a4vDKC1+BzxVf/6aH01UlCLqKJhwCahgLnE1Ziaq+cQxar03N7/UsRzfBHrHJoE7GvyQFy0ZVUBKpFqeu8N27xSRfnXXXVTeTpNwRDzvmTd+rqSxdYpzb+XpPQ7ZxGzd0+KoXB3z/OOvX0akoNufZmAkjvmOD0HtUH4pjW2jgx6vOfsNW7vmLvOdMes26bavz66Y1altN0zN03wnnODBHC2j5bCiVfCzMFRM3fveCmcYHmz7n7J0LVyty/AbZPcsK9EarCXjjNtSwNMTA34ZGsg1ib5+7Jei/Y+Pl82p17Wp176U1FSPrP4Jr91+JXWGQi1cfo7ZHeCXVmoI6sKq1WykI6D4BLIJEYhlN4pbSKyPhtCKsrMUVUwIcCDisrEDwcMZNVumu4WS4NKlBYSaoV0XpS+uGCT//VGP2L53RvLqRKuNDBhP706PumNfzo+fPostCZU34OIZxXhywpaIaaMT5DS0fYziOe0uSjdDN0llm5ZFZF1VT7UJBaEJUToP3TKbEHgDCbQQcd8vL/RGVclFbGKui4ULrMV7XUnhUKay2Jss7ct/OVLFIkEgGn0SLljSa/OXo5ZjLVm6ovQLovYf32+clfYqW9W8QoW23vbPkdLbfffVYO+0U97m/6crdcRBzrJFljtkUce7u//k0iCpOiKjTfhL58DK9Su23aW7TaB/VTo5z+FQexCHY53YA5bcLhuM4Pl3dIGI+5gZqkvNT0JEVZAULg1JGKz1ZHJ3dHg3HfrkrIYVUBrYOT9gKpVpZYvP7CDjFCNrBfKdmlBJ27x/BdOC9t8QhteDST3CrnMlhT2RIPnIZm+BLcePa32TaDI9BJTCDbP692138vNmhTpO1y9UMzGugBi9XPAnvtBO/8s/nJyD+zlARF5QEQeEJEHROQBEXlARB4QkQdE5AEReUBE6pJV6S4YsvQV/xdhG3UdVwnX5yeN9w7iMhOfgjsCxKHTbQjHlv7AgxVSsTgDYZiDG6rWfAvXcOn75IhZTYkIYk9g9YIJS5+O2+/msPy7oYtOkfh52AVS0rTGd/ckZyd0pWKXoSdtK6DyevL+/fv3vVevesPh2Ww2yPOBtb9N6AurcDvqXJ/62orQVGJuu2hxuH/4rLf/vLf/zdnB/uDgYHBw+BvfhbBUihOpA/8tu9ryrwAsp7/wiHsDQ4/FCU8+EzRpHw3GaHOiE0Q96P9h67Qt4EW39G9WN8qkegtMW25P9vdXW7bfYgCNqL/Hr+WqKB2r78mgODYFghNDkG80jIVC4190Mt6swPiqEuF0DY1Iy3Jp8Ut8hBPWLLaxkvvcnqIDEok1AgahSv+hsEXMIF+7IVZd9mjfoKqDmL8yFgjvdHWEIXRuKoQW71pkkgL6uoEc/IsN5FwhbKyN/JNKiXXRPPkXi+YNWF2aGMh4Ul2qcHung6XNBGXWypzJB9CcsfFWbDQkG23nY2lDv73FFJ/+q2PVSDkwSmRVjKJj1mTkK5bSSLck/Pq4kFS7fLjANOPEFK8L1uDxRcRzcDON1wyLkrjGy34Dvnd9uOfx472gl73b+ubfilBsJGHb3cMh5DpQyCNeInxYg30J5LonCtn3GF9far6K1jd4bXRSxmQ8O7a5a4exE1OppruWW/96nZCLRnRjtCCv+EqATfntB8LlSC/75nrkcQgWFZa/Bs6/HvkLudWXqBbyW39zosKws09dE1a33AoDqbzB+6WUUjyNbMIeKR0qS2eEzEgG+AXrccSgP+2vbTtgYeG3S10aFEdvDsvvJr7EQG9601zRfFHZa+dDSRskvhvSXUN0t2Gw29DV3RDhLrzsYhfodEfXfrG7/fqiJqXdoYQL461+ogkGWwvs8AEODS3VVdgTMYU9yIXMCGAuCm3cfxszri1R/tgMde2/7TprBlovwj7gWibUA+IHWgzIjO7u5lXnWtmqR4Lo24RnABlmJ7WALRsF7IA9CrjVY4Jtti983WqO2aMaZnpcw2fUzkrL0JlA4RrL2jdYqc8iECIi2MfDR6HXCGbB4hZ5pSVHcVjcmcT2iF8plGNpphfWO1mQNFH77uiEvT1hj35+d/Y4YqMXZz+w8bD387sz9vbEnzYan7KD5/sHR72nLB/qeC8fvmydGXoKgsMzGYOy5FhVDClEPAN22N/fUN1isegLet3XZroX1tq9l6OTF7+OX/Rwzar5/tCoE4WV6ListccjjgHcq/1w//BJ/6hPX9IKbV0uVIsef825StDrQa2Vjh9+//Dw+4e/4/cPIdMikrFXZEIqtMvSf4j0BcoHfn3o00kqMYA2tjlofqBwEfGZtg5n395eCQvnJlutcPiPEgwVRRG/Fobijq9k1qP1Tkt/9CaUlo/ZPX5ssZWhqp5QWExQ9ucDziM+p9zQsLHCPBLqDCTSvw+fO3vhzkG1fiOlYnXkVxwTIPrJue168PX5GY/4Vfh1Rk6lLzdigbcwxIIP+Ef+kRPASUGXym0cv+WZUNNSTHG+3xaTGJY83SpqTlVU+AcZ2yqQ9YLK84J/kbOtS77FYPcLLL+rp/s3OxfURZyfjepBgPH/Ec0zyQ==
sidebar_class_name: "put api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update webhook</h1>

<MethodEndpoint method={"put"} path={"/v2/config/webhook/{webhookId}"}></MethodEndpoint>



This endpoint updates a webhook. The request body replaces the payload URL, the content type, the subscribed events, the disabled flag, the secret key and the SSL verification flag of the webhook. The payload URL must start with `http://` or `https://`, and no other webhook of the organisation can use it. Subscribe to a minimum of 1 event type.

This is a full replacement, not a partial update. Send every field on every call.

The service keeps the `id`, the `orgId`, the `sandboxOrgId` and the `timestamp` of the stored webhook. The `timestamp` stays the creation time.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the webhook to update.","example":"68a1f2c3d4e5f6a7b8c9d0e1","in":"path","name":"webhookId","required":true,"schema":{"type":"string"},"style":"simple"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

The new webhook configuration.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The webhook configuration to create or to update. The service ignores `id`, `orgId`, `sandboxOrgId` and `timestamp` if you send them. It takes the organisation from the `organizationId` header.

</div><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The HTTPS or HTTP URL that receives the webhook payload. The value must start with `http://` or `https://` and must be unique for the organisation.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"The content type of the webhook payload. For `application/x-www-form-urlencoded`, the JSON payload is sent in a single form field named `payload`.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook does not receive event deliveries. Optional. Defaults to `false`.","default":false}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key used to compute the `X-IGrant-Signature` HMAC-SHA256 header for each delivery. The receiver uses it to check the authenticity of the payload. Do not use a value of spaces only: the service accepts it but then sends no signature header."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the server does not verify the TLS certificate of the payload URL. Optional. Defaults to `false`.","default":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>webhook</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A webhook configuration of the organisation. The service always sends every field of this object, except `sandboxOrgId`.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the webhook.","example":"68a1f2c3d4e5f6a7b8c9d0e1"}}></SchemaItem><SchemaItem collapsible={false} name={"orgId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the organisation that owns the webhook."}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the sandbox organisation. The service sends this field only for a webhook that belongs to a sandbox deployment. A webhook receives only the events of its own scope."}}></SchemaItem><SchemaItem collapsible={false} name={"payloadUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL that receives the webhook payload.","example":"https://example.com/hooks/igrant"}}></SchemaItem><SchemaItem collapsible={false} name={"contentType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"type":"string","description":"Content type of the webhook payload.","enum":["application/json","application/x-www-form-urlencoded"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subscribedEvents</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The event types that the webhook receives, in 3 groups. A minimum of 1 of the 3 arrays must hold a minimum of 1 event type. The service refuses an event type that is not in the list of its group. The service does not remove duplicate values.

</div><SchemaItem collapsible={false} name={"consentManagementWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`data.update.initiated`, `data.update.cancelled`, `consent.allowed`, `consent.disallowed`, `consent.auto_expiry`, `data.delete.initiated`, `data.download.initiated`, `data.delete.cancelled`, `data.download.cancelled`]"} schema={{"type":"array","description":"Consent management event types. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.","items":{"type":"string","description":"Subscribed event","enum":["data.update.initiated","data.update.cancelled","consent.allowed","consent.disallowed","consent.auto_expiry","data.delete.initiated","data.download.initiated","data.delete.cancelled","data.download.cancelled"]}}}></SchemaItem><SchemaItem collapsible={false} name={"digitalWalletWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`openid.credential.offer_sent`, `openid.credential.offer_received`, `openid.credential.credential_issued`, `openid.credential.credential_acked`, `openid.credential.credential_accepted`, `openid.credential.credential_deleted`, `openid.credential.issuance_denied`, `openid.credential.token_issued`, `openid.holder.credential.credential_pending`, `openid.holder.credential.credential_acked`, `openid.holder.credential.credential_accepted`, `openid.presentation.request_sent.v3`, `openid.presentation.request_received.v3`, `openid.presentation.presentation_acked.v3`, `openid.presentation.presentation_pending.v3`]"} schema={{"type":"array","description":"Digital wallet event types. Every OID4VC event uses this group; the `openid.*` values are the only values that an OID4VCI or OpenID4VP integration needs. The `digitalwallet.*` values belong to the older DIDComm protocol.\n\nThe `openid.credential.*` events follow the issuer side of an OID4VCI exchange. The `openid.holder.credential.*` events follow the holder side. The `openid.presentation.*.v3` events follow an OpenID4VP exchange: `request_sent`, `request_received` and `presentation_acked` come from the verifier side, and `presentation_pending` and `presentation_acked` come from the holder side.\n","items":{"type":"string","description":"Subscribed event","enum":["openid.credential.offer_sent","openid.credential.offer_received","openid.credential.credential_issued","openid.credential.credential_acked","openid.credential.credential_accepted","openid.credential.credential_deleted","openid.credential.issuance_denied","openid.credential.token_issued","openid.holder.credential.credential_pending","openid.holder.credential.credential_acked","openid.holder.credential.credential_accepted","openid.presentation.request_sent.v3","openid.presentation.request_received.v3","openid.presentation.presentation_acked.v3","openid.presentation.presentation_pending.v3"]}}}></SchemaItem><SchemaItem collapsible={false} name={"dataMarketplaceWebhook"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`datamarketplace.data_disclosure_agreement_record`]"} schema={{"type":"array","description":"Data marketplace event types. These events occur when the service creates or updates a data disclosure agreement record.","items":{"type":"string","description":"Subscribed event","enum":["datamarketplace.data_disclosure_agreement_record"]}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the webhook receives no event delivery."}}></SchemaItem><SchemaItem collapsible={false} name={"secretKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Secret key that the service uses to calculate the `X-IGrant-Signature` header of each delivery. The service sends this value in clear text in every webhook response, so protect the response as you protect the key."}}></SchemaItem><SchemaItem collapsible={false} name={"skipSslVerification"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the service does not verify the TLS certificate of the payload URL."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UTC time when the service created the webhook, in `YYYY-MM-DDThh:mm:ssZ` format. The service does not change this value on an update.","example":"2026-08-09T10:11:12Z"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"webhook\": {\n    \"id\": \"68a1f2c3d4e5f6a7b8c9d0e1\",\n    \"orgId\": \"string\",\n    \"sandboxOrgId\": \"string\",\n    \"payloadUrl\": \"https://example.com/hooks/igrant\",\n    \"contentType\": \"application/json\",\n    \"subscribedEvents\": {\n      \"consentManagementWebhook\": [\n        \"data.update.initiated\"\n      ],\n      \"digitalWalletWebhook\": [\n        \"openid.credential.offer_sent\"\n      ],\n      \"dataMarketplaceWebhook\": [\n        \"datamarketplace.data_disclosure_agreement_record\"\n      ]\n    },\n    \"disabled\": true,\n    \"secretKey\": \"string\",\n    \"skipSslVerification\": true,\n    \"timestamp\": \"2026-08-09T10:11:12Z\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request. The server sends this error if a mandatory field is missing, if the payload URL does not start with `http://` or `https://`, if a different webhook uses the same payload URL, if you subscribe to no event type, or if an event type or a content type is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found. The organisation has no webhook with the given ID, or the webhook is deleted.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# List all webhook content types
Source: https://docs.igrant.io/docs/openid4vc-api/get-webhook-payload-content-types

---
id: get-webhook-payload-content-types
title: "List all webhook content types"
description: "This endpoint lists the payload content types that a webhook can use. Use one of these values in the `contentType` field when you create or update a webhook. The server posts the payload as a JSON body for `application/json`. For `application/x-www-form-urlencoded`, the server makes a string of the payload and posts it as a form under the `payload` key. Note the capital `C` in the `ContentTypes` response field. The order of the values changes between calls."
sidebar_label: "List all webhook content types"
hide_title: true
hide_table_of_contents: true
api: eJztVlFv2zgM/iuEnlrAcdKuBxyCYbhe0g3ZhrVAs/ahKGBFYmKttqRJctJc4P9+oOwkTtphGO5tuJfGlUTy40dKHzdMonUoeEDJhnNeeEyYRC+cskEZzYZsmisPqKU1SgcolA8eQo5g+bowXIIwOqAOENYWaYcH4LDCWW7MEwiuofKYwlePYDSCmZOxR1jyokIPSkdnWetluraYwVxhIWGVo4a1qUA45AHBOKispK+d/xSmOYJHt0QH1hxD4x44fLy9/gIzI9cwNw4ybm2hBKfk+t+80VkK74/Xn3ur1ao3N67sVa5ALYxEmSXRdxus5E9I3n1wSi/atPaBtWzhqNCgIGdQaYmuybc9mcETrlP4YgLGdcGtCryAbJTtqBntqfEZOPTWaI8NSQ0BxpHfFkNLrMi5XqCHGYYVogbBi8KnLGHGootpTiQbsgWG+4bLmwZRNxpL2DacZ8MNOx8M6KetFX0es0lrXuRYcvqyjoIF1VgfeB5uXrTZL7YUSxg+89IWyIYPL4Ek7KcVZY8JUwHLV9BcvoolxtRV+V8Ckh82ZE3fsHq3wJ3ja1bXRPn3Sjm6jw+HnO2tzewbisBqOn4I/PoTS1iOXKKjtOjAxeDsl6rWjY/OGTcyEilz+h53or3AkxxVfG893GyPKh1wga5bvYvBoH7F/d6mJatjwv7mEpS2VQDLHS8xoCM6XhLyVfMq5Mapf1C+oOaPX2zo34uaiQ7oNC+2b1oMc8RRnTCPonIqrNnwYcMurfqE9PlYU4584YmL9gmhtEsMuWlfFsqah5wNWX953hdGz9Wi395j329vWL9lvxfaJ6dB42O4Q8BjLE0LliWscgUbsjwE64f9vsTS9LhVqVo4rkOqDKuTYwc3zshK0D8/cvMzD7eBL+jB/4G5b7aPgTzuWbylZmp6YMvlrpi8WUiYolBNGVjCNC9p97Lt49ic7LiYlzcT0hKgbkcd2h5u9CFKwlYfsgM/GTRhoKx8gBmCdThXzyhhpUIOWYMRMjjRW40KjqsicmC5wNMEMF2kR26H0Bq+XZvKER29J1y/y9L4wik9N9t7x0W8d1hyRUT6ylrjwl978nb5qw/7pUPWuwU7omVnBNaZpZJRtIWhqxIQFP2WqEMEvWXo2qKejOO4cIdOzRWfFQgjh5KI5YWHifcV1wLh5HoyvrgbTU6j5L9ueOPQ70KcNGcu7m5OCVEwwhSeqqQ8UAlRk40H4xZct2R6CAaU9xUmkJtCJjHYkiKsQapFnBhEB17lY3kC15I76XsxX8V1gHlhVr4pbct0RHv/ZgR3Izj5eD89TWByNX0Pt+Pex/sp3I2aaJPbazj7c3D2pvcHlGMj+uX4cydmnG94iANGoQRqHx+2bedaLnKE83TwonSr1SrlcTs1btFvbX3/82R09eX2qkc2JJIqFAc9EMmSRlS76rGE0bPRlP18cH6RvknPyJYGsZLrDp7PygfgRbGfKboDx/HV6ujD/8PwbzYMtw9vwOfQtwVXmhomduimla4HtjxnCWvEiyVsK19R2yLsZrcjYY8Jy40PZLvZzLjHr66oa1r+XqGL4pmwJXfxeYhSutXcqHlPpAnsUgi0pKAxhSgOR5NJ3VXbD1dTmkArgtzVk6eoJ+0Hed9u6XXH97G0NBDoLyngqyZv6QJ+wvW73fFm54cGOzlrThPVj3Vd/wuqkRQ7
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List all webhook content types</h1>

<MethodEndpoint method={"get"} path={"/v2/config/webhooks/payload/content-types"}></MethodEndpoint>



This endpoint lists the payload content types that a webhook can use. Use one of these values in the `contentType` field when you create or update a webhook. The server posts the payload as a JSON body for `application/json`. For `application/x-www-form-urlencoded`, the server makes a string of the payload and posts it as a form under the `payload` key. Note the capital `C` in the `ContentTypes` response field. The order of the values changes between calls.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

OK

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ContentTypes"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`application/json`, `application/x-www-form-urlencoded`]"} schema={{"description":"The payload content types that a webhook can use.","example":["application/json","application/x-www-form-urlencoded"],"items":{"description":"A payload content type.","enum":["application/json","application/x-www-form-urlencoded"],"type":"string"},"type":"array"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"ContentTypes\": [\n    \"application/json\",\n    \"application/x-www-form-urlencoded\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
      

---

# iGrant.io API documentation
Source: https://docs.igrant.io/docs/openid4vc-api/igrant-io-api-documentation

---
id: igrant-io-api-documentation
title: "iGrant.io API documentation"
description: "iGrant.io provides a complete implementation of the OpenID for Verifiable Credentials Issuance (OID4VCI) and OpenID for Verifiable Presentation (OpenID4VP) protocols. This API enables organizations to issue, hold, and verify digital credentials using standards-compliant flows with support for W3C VC (JWT), IETF SD-JWT VC, and ISO 18013-5 mDoc/mDL credential formats."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 2024.3.1</span>

<h1 className={"openapi__heading"}>iGrant.io API documentation</h1>



iGrant.io provides a complete implementation of the OpenID for Verifiable Credentials Issuance (OID4VCI) and OpenID for Verifiable Presentation (OpenID4VP) protocols. This API enables organizations to issue, hold, and verify digital credentials using standards-compliant flows with support for W3C VC (JWT), IETF SD-JWT VC, and ISO 18013-5 mDoc/mDL credential formats.

<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}>

API key authentication. The value of the `Authorization` header must be prefixed with `ApiKey ` (note the trailing space), e.g. `Authorization: ApiKey <your-api-key>`.

<div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>Authorization</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>iGrant.io: <a href={"mailto:support@igrant.io"}>support@igrant.io</a></span><span>URL: <a href={"https://igrant.io"}>https://igrant.io</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3><a href={"https://www.apache.org/licenses/LICENSE-2.0"}>Apache 2.0</a></div>
      

---

# Quickstart
Source: https://docs.igrant.io/docs/get-started/

---
id: quickstart
title: Quickstart
sidebar_position: 1
description: "Get started with the Organisation Wallet Suite by iGrant.io"
hide_title: false
sidebar_label: Get Started
slug: /get-started/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import NoteBox from '@site/src/components/NoteBox';

# Get started

You're a developer with authentic source data (customer records, government registries, HR systems, academic transcripts, payment history) and you want to issue, hold, share, or verify it as verifiable credentials using OpenID4VC. **This page is the map.** It points you at the workflow you need and the docs that walk you through it.

<NoteBox title="Recommended starting point:" variant="tip">
New here? Start with <a href="/docs/openID4vci-issue-credential-intime/">Issue Credential (In-Time)</a>. It walks through your first issuance in three steps (get an API key, create a credential definition, then issue and receive) and ends with a working scannable QR code. Once that succeeds, branch out to whichever workflow below matches what you're building.
</NoteBox>

Want to understand what's happening under the hood before you write code? Read the [OpenID4VC credential issuance lifecycle](/concepts/credential-issuance-lifecycle/). It walks through every state from `offer_sent` to `accepted` and what each one means for your integration.

## Prerequisites

- An iGrant.io tenant account (contact [support@igrant.io](mailto:support@igrant.io) to request access)
- Your API key (provided with your tenant)
- <a href="https://www.igrant.io/datawallet-for-eudi-wallet.html" target="_blank">iGrant.io Data Wallet</a> installed on your phone (available on the <a href="https://apple.co/2Mz9nJp" target="_blank">App Store</a> and <a href="https://play.google.com/store/apps/details?id=io.igrant.mobileagent" target="_blank">Play Store</a>)

<NoteBox title="Self-hosting?" variant="info">
If you're deploying on-premise instead of using the hosted PaaS, complete the <a href="/docs/organisation-wallet-on-premise-deployment/">Deployment Guide</a> first. The API calls are the same once your instance is running.
</NoteBox>

## Issue credentials

Create credential definitions and issue verifiable credentials to holders using the OpenID4VCI protocol. Supports in-time issuance, deferred issuance, and dynamic credential requests.

- [Issue Credential (In-Time)](/docs/openID4vci-issue-credential-intime/) - issue credentials immediately using Pre-Authorised or Authorisation Code flow
- [Issue Credential (Deferred)](/docs/openID4vci-issue-credential-deferred/) - issue credentials asynchronously for batch or invitation-based workflows
- [Dynamic Credential Request](/docs/openID4vci-issue-dynamic-credential-request/) - request additional proof from the holder before issuing

## Hold and share credentials

Receive credentials from trusted issuers and store them securely in your organisation's wallet unit. Present held credentials to relying parties when requested, with selective disclosure of only the claims they need.

- [Receive and Store Credential](/docs/openID4vc-receive-and-store-credential/) - receive credentials from issuers and store them in your wallet
- [Receive and Present Credential](/docs/openID4vp-receive-and-present-credentials/) - respond to presentation requests with selective disclosure

## Verify credentials

Define verification requirements, send presentation requests, and validate credential proofs from holders.

- [Send and Verify Credential](/docs/openID4vc-send-verify-credentials/) - define presentation requirements, initiate verification, and validate responses

## Cross-cutting & next steps

- [Webhook Events](/docs/openid4vc-webhooks/) - receive real-time notifications at key stages of issuance and verification
- [Use Case Workflows](/docs/european-business-wallet-owner-id/) - worked examples for EBWOID, payments, and passwordless login
- [Sandbox Organisations](/docs/sandbox-organisations/) - create test environments to simulate multi-party credential ecosystems
- [Deployment Guide](/docs/organisation-wallet-on-premise-deployment/) - deploy on your own infrastructure via Helm chart
- [Developer APIs](/docs/developer-apis) - full API reference


---

# Technical references and resources | EUDI Wallet
Source: https://docs.igrant.io/docs/references/

---
id: references
title: Technical references and resources | EUDI Wallet
description: Access key technical references, standards, and resources supporting digital identity, verifiable credentials, and wallet implementations.
hide_title: true
sidebar_label: References
keywords: [references, technical standards, EUDI Wallet, eIDAS, OpenID4VC, verifiable credentials, digital identity, specifications, resources]
slug: /references/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


Some of the resources cited in our documentation are listed below.

## iGrant.io Publications

1. L. Chandran, L. Lundin, and G. Padayatti, "Transforming Personal Data Transactions with Auditable, Privacy-Preserving Data Exchange Agreements: Fostering Transparency and Trust in Digital Wallet Ecosystems," 2023 IEEE 28th International Conference on Emerging Technologies and Factory Automation (ETFA), Sinaia, Romania, 2023, pp. 1-9, doi: [10.1109/ETFA54631.2023.10275546](https://ieeexplore.ieee.org/document/10275546) [Accessed: 8 May 2024].

2. iGrant.io. (2018). Data Sharing and Consent Management: Making Consumer Choice a Business Opportunity. Available at: https://igrant.io/papers/iGrant.io_DataSharing_and_Consent_Management_v1.pdf [Accessed: 8 May 2023].

3. iGrant.io. (2019). Between the Business and the Customer: Managing Consent in a Data Sharing Economy. The Role and Influence of a DPO. Available at: https://igrant.io/papers/iGrant.io_Managing_Consent_in_a_Data_Sharing_Economy.pdf [Accessed: 8 May 2024].

4. MyData Global. (2020). Understanding MyData Operators (iGrant.io is a key contributor). Available at: https://igrant.io/papers/Understanding-Mydata-Operators.pdf [Accessed: 8 May 2023].

5. iGrant.io. (no date) Value of Trust Blog Site. Available at: https://medium.com/value-of-trust [Accessed: 8 May 2023].

6. iGrant.io. (2021) Data Agreement Specification, EU eSSIF-Lab Project Outcome, Available at: https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/data-agreement-specification.md [Accessed: 8 May 2024].

7. iGrant.io. (2021) Data Agreement DID Method Specification, EU eSSIF-Lab Project Outcome, Available at: https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md [Accessed: 18 Oct 2023].

8.  iGrant.io. (2021) Data Agreement Standards Development Repository, EU eSSIF-Lab Project Outcome, Available at: https://github.com/decentralised-dataexchange/automated-data-agreements [Accessed: 18 Oct 2023].

9.  iGrant.io. (2023) DEXA protocol demonstration, demonstrating data provenance and blockchain-enabled auditability of every personal data exchange transaction [Online video]. Posted on 8 May 2023. Available at: https://youtu.be/lATs3_ORZgk [Accessed: 8 May 2024].

10. DIDComm Messaging, 2023. [Data Disclosure Agreement 1.0](https://didcomm.org/data-disclosure-agreement/1.0/) [Accessed: 8 May 2024].

11. DIDComm Messaging, 2023. [Data Agreement Protocols](https://didcomm.org/search/?q=data%20agreement&page=1) (Search results for "data agreement").

12. L. Chandran and G. Padayatti, 2021. [DID Specification Registries: did:mydata](https://www.w3.org/TR/did-spec-registries/) (Accessed: 8 May 2024).

13. Govstack (2023), Consent BB Specification [online] Available at: https://govstack.gitbook.io/bb-consent [Accessed 11 May 2024] (Lal Chandran was a co-author of the specification)

14. Chandran, L., Lundin, L., Lindén, F., Page, P., Knowles, P., Martínez Jurado, V. & Slack, A. (2023) Linking Credentials with Data Exchange Agreements through Secured Inclusive Interfaces. Available at: https://github.com/WebOfTrustInfo/rwot11-the-hague/blob/master/final-documents/data-exchange-agreements-with-oca.pdf [Accessed 11 May 2024].


## OpenID Foundation Resources

1. OpenID Foundation (2023), 'OpenID for Verifiable Credential Issuance (OID4VCI)', Available at: https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-12.html (Accessed: 10 January, 2024).

2. OpenID Foundation (2023), OpenID 4 for Verifiable Presentations. [online] openid.net. Available at: https://openid.net/specs/openid-4-verifiable-presentations-1_0.html [Accessed 10 January, 2024].

3. OpenID Foundation (2023), 'Self-Issued OpenID Provider v2 (SIOP v2)', Available at: https://openid.net/specs/openid-connect-self-issued-v2-1_0.html [Accessed 10 January, 2024].

4. OpenID Foundation (2023), OpenID4VC High Assurance Interoperability Profile with SD-JWT VC - draft 00, Available at https://openid.net/specs/openid4vc-high-assurance-interoperability-profile-sd-jwt-vc-1_0.html (Accessed: 16 February, 2024)


## European Commission Resources

1. European Commission, 2020. A European Strategy for Data. Available at: https://ec.europa.eu/info/sites/info/files/communication-european-strategy-data-19feb2020_en.pdf [Accessed: 8 May 2024].

2. European Commission, 2020. European Data Governance Act 2020. Available at: https://ec.europa.eu/digital-single-market/en/news/data-governance-act [Accessed: 8 May 2024].

3. European Commission (2026) The European Digital Identity Wallet Architecture and Reference Framework (ARF), v2.9.0 [Online]. Available at: https://eudi.dev/2.9.0/architecture-and-reference-framework-main/ (Accessed: June 2026).

4. European Commission, 2020. Proposal for a Regulation on European data governance (Data Governance Act). Available at: https://ec.europa.eu/digital-single-market/en/news/proposal-regulation-european-data-governance-data-governance-act [Accessed: 8 May 2024]. 

5. European Commission, 2026. Architecture and Reference Framework (ARF). *GitHub repository: EU Digital Identity Wallet*. Available at: https://github.com/eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework [Accessed: June 2026].

6.  EWC Consortium. (2024) EUDI Wallet RFCs: Issue Verifiable Credential. Available at: https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc001-issue-verifiable-credential.md [Accessed: 8 May 2024].

7.  EWC Consortium. (No Date) EUDI Wallet RFCs: Present Verifiable Credentials. Available at: https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc002-present-verifiable-credentials.md [Accessed: 8 May 2024].


## Other Related Publications

1. W3C Credentials Community Group, no date. A Primer for Decentralized Identifiers. Available at: https://w3c-ccg.github.io/did-primer/ [Accessed: 8 May 2024].

2. W3C, 2022. Decentralized Identifiers (DIDs) v1.0. Available at: https://www.w3.org/TR/did-core/ [Accessed: 8 May 2024].

3. W3C, 2019. Verifiable Credentials Data Model 1.0. Available at: https://www.w3.org/TR/vc-data-model/ [Accessed: 8 May 2024].

4. gdpr-info.eu, no date. GDPR articles and resources. Available at: https://gdpr-info.eu/ [Accessed: 8 May 2024].

5. OAuth 2.0 Rich Authorization Requests, Available at: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-rar-11 (Accessed: February 01, 2024)

6.  Proof Key for Code Exchange by OAuth Public Clients, Available at: https://datatracker.ietf.org/doc/html/rfc7636 (Accessed: February 01, 2024)

7.  ISO 2023. ISO 18013-5:2021 Identification cards - Personal identification - Part 5: Mobile driver's license (mDL) application. Geneva: International Organization for Standardization, Avaialble at https://www.iso.org/standard/69084.html (Accessed: February 01, 2024)

8.  ISO (2023) ISO ISO/IEC TS 27560:2023 Privacy technologies - Consent record information structure, Geneva: International Organization for Standardization, Avaialble at https://www.iso.org/standard/80392.html (Accessed: May 01, 2024)

9.  ETSI (2022) ETSI TS 119 612 V2.1.1 Electronic Signatures and Infrastructures (ESI); Trusted Lists. Available at: https://www.etsi.org/deliver/etsi_ts/119600_119699/119612/02.01.01_60/ts_119612v020101p.pdf (Accessed: June 2026).

10. European Commission (no date) EU Trusted Lists and List of Trusted Lists (LOTL), Trusted List Browser. Available at: https://eidas.ec.europa.eu/efda/tl-browser/ (Accessed: June 2026).

---

# Template Example
Source: https://docs.igrant.io/docs/template

---
id: docx
title: Template Example
sidebar_label: Template example
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).

## Markdown Syntax

To serve as an example page when styling markdown based Docusaurus sites.

## Headers

# H1 - Create the best documentation

## H2 - Create the best documentation

### H3 - Create the best documentation

#### H4 - Create the best documentation

##### H5 - Create the best documentation

###### H6 - Create the best documentation

---

## Emphasis

Emphasis, aka italics, with *asterisks* or _underscores_.

Strong emphasis, aka bold, with **asterisks** or __underscores__.

Combined emphasis with **asterisks and _underscores_**.

Strikethrough uses two tildes. ~~Scratch this.~~

---

## Lists

1. First ordered list item
1. Another item
   - Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
   1. Ordered sub-list
1. And another item.

* Unordered list can use asterisks

- Or minuses

+ Or pluses

---

## Links

[I'm an inline-style link](https://www.google.com/)

[I'm an inline-style link with title](https://www.google.com/ "Google's Homepage")

[I'm a reference-style link][arbitrary case-insensitive reference text]

[You can use numbers for reference-style link definitions][1]

Or leave it empty and use the [link text itself].

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or <http://www.example.com/> and sometimes example.com (but not on GitHub, for example).

Some text to show that the reference links can follow later.

[arbitrary case-insensitive reference text]: https://www.mozilla.org/
[1]: http://slashdot.org/
[link text itself]: http://www.reddit.com/

---

## Images

Here's our logo (hover to see the title text):

Inline-style: ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 1')

Reference-style: ![alt text][logo]

[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2'

Images from any folder can be used by providing path to file. Path should be relative to markdown file.

![img](../static/img/logo.svg)

---

## Code

```javascript
var s = 'JavaScript syntax highlighting';
alert(s);
```

```python
s = "Python syntax highlighting"
print(s)
```

```
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
```

```js {2}
function highlightMe() {
  console.log('This line can be highlighted!');
}
```

---

## Tables

Colons can be used to align columns.

| Tables        |      Are      |   Cool |
| ------------- | :-----------: | -----: |
| col 3 is      | right-aligned | \$1600 |
| col 2 is      |   centered    |   \$12 |
| zebra stripes |   are neat    |    \$1 |

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.

| Markdown | Less      | Pretty     |
| -------- | --------- | ---------- |
| _Still_  | `renders` | **nicely** |
| 1        | 2         | 3          |

---

## Blockquotes

> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote.

---

## Inline HTML

<dl>
  <dt>Definition list</dt>
  <dd>Is something people use sometimes.</dd>

  <dt>Markdown in HTML</dt>
  <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>

---

## Line Breaks

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a _separate paragraph_.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_.

---

## Admonitions

:::note

This is a note

:::

:::tip

This is a tip

:::

:::important

This is important

:::

:::caution

This is a caution

:::

:::warning

This is a warning

:::


---

# Terminology
Source: https://docs.igrant.io/docs/terminology/

---
id: terminology
title: Terminology
description: Refer to our commonly used industry-related terminologies that will help the users understand concepts and find relevant links to dive deep into developer docs
hide_title: true
sidebar_label: Terminology
keywords: [terminology, digital identity, verifiable credentials, data source, consent, EUDI Wallet, glossary, definitions, reference]
slug: /terminology/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


## Data Source
**Description:** The role responsible for collecting, storing, and controlling personal data which persons, operators, and data using services may wish to access and use.
**Reference:** [Understanding MyData Operator](https://igrant.io/papers/Understanding-Mydata-Operators.pdf)

## Data Using Service
**Description:** The role responsible for processing personal data from one or more data sources to deliver a service.
**Reference:** [Understanding MyData Operator](https://igrant.io/papers/Understanding-Mydata-Operators.pdf)

## Decentralized Identifier (DID)
**Description:** A Decentralized Identifier (DID) is a type of identifier that is globally unique, resolvable with high availability, and cryptographically verifiable. DIDs are typically associated with cryptographic material, such as public keys and service endpoints, for establishing secure communication channels.
**Reference:** [DID Primer](https://w3c-ccg.github.io/did-primer/)

## Electronic Attestation of Attributes
**Description:** 'electronic attestation of attributes' means an attestation in electronic form that allows the authentication of attributes.
**Reference:** [eIDAS 2 Definitions](https://docs.igrant.io/regulations/reg-eu-digital-id-framework#article-3---definitions)

## European Business Wallet Owner Identification (EBWOID)
**Description:** An identification mechanism for the owner of a European Business Wallet, used during credential issuance to verify the legal identity of the issuing organisation. The EBWOID is checked as part of the issuer validation process before a credential is delivered to the holder's wallet.
**Reference:** [Credential Issuance Lifecycle](/concepts/credential-issuance-lifecycle/)

## Elliptic-curve Diffie–Hellman
**Description:** Elliptic-curve Diffie–Hellman (ECDH) is a key agreement protocol that allows two parties, each having an elliptic-curve public-private key pair, to establish a shared secret over an insecure channel. This shared secret may be directly used as a key, or to derive another key.
**Reference:** [RFC6090](https://datatracker.ietf.org/doc/html/rfc6090)

## European Digital Identity Wallet
**Description:** 'European Digital Identity Wallet' means an electronic identification, which allows the user to securely store, manage and validate identity data and electronic attestations of attributes, to provide them to relying parties and to other users of European Digital Identity Wallets, and to sign by means of qualified electronic signatures or to seal by means of qualified electronic seals.
**Reference:** [eIDAS 2 Definitions](https://docs.igrant.io/regulations/reg-eu-digital-id-framework#article-3---definitions)

## European Digital Identity Wallet Architecture and Reference Framework
**Description:** A toolbox including a technical Architecture and Reference Framework (ARF), a set of common standards and technical specifications, and a set of common guidelines and best practices.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## German eID system
**Description:** Architecture for the German electronic Identity Card and electronic Resident Permit is specified in the BSI Technical Guideline TR-03127.
**Reference:** BSI TR-03127

## GDPR
**Description:** The General Data Protection Regulation (GDPR) is a regulation in EU law on data protection and privacy in the European Union (EU) and the European Economic Area (EEA).
**Reference:** [GDPR as in EU Regulations](https://docs.igrant.io/regulations/reg-eu-gdpr)

## Individual
**Description:** A natural, living human being.
**Reference:** [Understanding MyData Operator](https://igrant.io/papers/Understanding-Mydata-Operators.pdf)

## JSON Web Token
**Description:** JSON Web Token (JWT) is a compact, URL-safe means of representing claims to be transferred between two parties. The claims in a JWT are encoded as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure or as the plaintext of a JSON Web Encryption (JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message Authentication Code (MAC) and/or encrypted.
**Reference:** [RFC7519](https://datatracker.ietf.org/doc/html/rfc7519)

## Hardware Security Module
**Description:** A HSM is a device for providing cryptographic functionalities whereas the life cycle of cryptographic keys and the performance of cryptographic functions is managed within a highly protected hardware environment.

## Identity Owner
**Description:** The entity, such as a natural person, a legal person, or a device, which is subject of verifiable credentials from credential issuers and being in control of the reception, storage, and sharing of such credentials with relying parties.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## Level of Assurance
**Description:** Degree of confidence in the claimed identity of a person – how certain a service provider can be that it is you, the one using your eID to authenticate to the service, not someone else pretending to be you. In other words, it refers to the difficulty of using someone else’s eID to access an online service.
**Reference:** [eIDAS Levels of Assurance](https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eIDAS+Levels+of+Assurance)

## Message Authentication Code
**Description:** The result of a HMAC performance
**Reference:** [RFC8446](https://datatracker.ietf.org/doc/html/rfc8446)

## OpenID for Verifiable Credential Issuance
**Description:** OAuth protected API for the issuance of Verifiable Credentials.
**Reference:** 
- [OpenID4VCI](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html)
- [Try out OpenID4VCI](/docs/openID4vci-issue-credential-intime/)
- [iGrant.io Organisation Wallet Suite Issuer Demo](https://www.youtube.com/watch?v=qtsyvw9alb4)

## OpenID for Verifiable Presentations
**Description:** A mechanism on top of OAuth 2.0 [RFC6749] that enables presentation of Verifiable Credentials as Verifiable Presentations.
**Reference:** 
- [OpenID4VP](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html)
- [Try out OpenID4VP](/docs/openID4vc-send-verify-credentials/)

## Organisation Wallet Suite
**Description:** An Organisation Wallet Suite is a digital tool for businesses to securely manage (issue, store, and verify) verifiable credentials. It ensures compliance with standards like OpenID4VC (eIDAS 2.0), JWT, SD-JWT credential formats etc, providing interoperability and robust security. The wallet automates credential management processes, enhancing efficiency and ensuring regulatory compliance with data protection laws like GDPR, eiDAS2.0 etc. Organisation Wallets can issue PID, LPID, (Q)EAAs etc depending on the organisation.
**Reference:** 
- [iGrant.io Organisation Wallet Suite Overview](https://docs.igrant.io/docs/organisation-wallet-overview/)
- [iGrant.io Organisation Wallet Suite Issuer Demo](https://www.youtube.com/watch?v=qtsyvw9alb4)
- [OpenID for Verifiable Credential Issuance](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html)

## Person Identification Data
**Description:** 'person identification data' means a set of data, issued in accordance with Union or national law, enabling the identity of a natural or legal person, or of a natural person representing a natural or legal person, to be established.
**Reference:** [eIDAS 2 Article 3 (45)](https://docs.igrant.io/regulations/reg-eu-digital-id-framework#article-3---definitions)

## Person Identification Data Provider
**Description:** A Member State or other legal entity providing Person Identification Data to Users.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)


## Proof of Possession
**Description:** Evidence provided by the Wallet regarding the possession of the respective key material.
**Reference:** [Wallet Unit Attestation (WUA)](/concepts/wallet-unit-attestation/)

## Qualified Electronic Attestation of Attributes
**Description:** 'qualified electronic attestation of attributes' means an electronic attestation of attributes, which is issued by a qualified trust service provider and meets the requirements laid down in Annex V.
**Reference:** [eIDAS 2 Article 3 (45)](https://docs.igrant.io/regulations/reg-eu-digital-id-framework#article-3---definitions)

## Qualified Electronic Signature
**Description:** 'qualified electronic signature' means an advanced electronic signature that is created by a qualified electronic signature creation device, and which is based on a qualified certificate for electronic signatures.
**Reference:** [eIDAS 2](https://docs.igrant.io/regulations/reg-eu-digital-id-framework)

## Qualified Trust Service Provider
**Description:** A Trust Service Provider who provides one or more Qualified Trust Services and is granted the qualified status by the supervisory body.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## Relying Party
**Description:** 'relying party' means a natural or legal person that relies upon an electronic identification, European Digital Identity Wallets or other electronic identification means, or a trust service.
**Reference:** [eIDAS 2 Article 3 (6)](https://docs.igrant.io/regulations/reg-eu-digital-id-framework#article-3---definitions)

## Selective Disclosure for JWT
**Description:** A composite structure, consisting of an Issuer-signed JWT (JWS, RFC7515), Disclosures and optionally a Key Binding JWT that supports selective disclosure.
**Reference:** [IETF Draft for Selective Disclosure JWT](https://datatracker.ietf.org/doc/draft-ietf-oauth-selective-disclosure-jwt/)

## SD-JWT-based Verifiable Credentials
**Description:** Verifiable Credentials with JSON payloads with and without selective disclosure based on the SD-JWT format.
**Reference:** [IETF Draft for Selective Disclosure JWT](https://datatracker.ietf.org/doc/draft-ietf-oauth-selective-disclosure-jwt/)

## Self-Sovereign Identity (SSI)
**Description:** A model for managing digital identities where individual identity holders can fully create and control their verifiable credentials without being forced to request permission from an intermediary or centralized authority and give control over how their personal data is shared and used.
**Reference:** [W3C DID Core](https://www.w3.org/TR/did-core/)

## Trusted List
**Description:** Repository of information about authoritative entities in a particular legal or contractual context which provides information about their current and historical status.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## TSP (Trust Service Provider)
**Description:** A natural or a legal person who provides one or more Trust Services, either as a qualified or as a non-qualified Trust Service Provider.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## EU Trust List
**Description:** The set of trusted lists published by EU member states under eIDAS, listing qualified and non-qualified trust service providers and aggregated through the European List of Trusted Lists (LoTL). Wallets use it to check whether a credential issuer or verifier is a recognised, accountable entity. When a party cannot be matched against it, the Data Wallet shows a "not verified" notice.
**Reference:** [ETSI TS 119 612](https://www.etsi.org/deliver/etsi_ts/119600_119699/119612/02.01.01_60/ts_119612v020101p.pdf)

## Trust Anchor
**Description:** An authoritative entity, or its cryptographic key, that serves as the root of trust for validating credential issuers and verifiers. In the EBSI model, trust anchors are onboarded through a trust chain of Root Trust Anchor Operator (Root TAO), Trust Anchor Operator (TAO) and Trusted Issuer (TI).
**Reference:** [Trust Overview](/docs/trust-overview/)

## Trusted Issuer (TI)
**Description:** An entity that has been onboarded into a trust framework and is therefore authorised to issue credentials that wallets can recognise as coming from a trusted source. In the EBSI model, a Trusted Issuer is onboarded under a Trust Anchor Operator.
**Reference:** [Trust Anchor APIs](/docs/category/openid4vc-api/trust-anchor)

## Untrusted Service Provider
**Description:** The former name of the wallet's trust-status notice. Current versions show **"Issuer not verified"** (during issuance) or **"Service provider not verified"** (during presentation) when a credential issuer or verifier cannot be matched against a recognised trust list, such as the EU Trust List. It is a trust indicator and not a validation failure: the credential signature may still be valid, but the wallet cannot independently confirm the party's identity.
**Reference:** [The "Issuer / service provider not verified" notice](/docs/trust-untrusted-service-provider/)

## User (Holder)
**Description:** A natural or legal person using a EUDI Wallet. Also referred to as Holder.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## Verifiable Credential
**Description:** A credential created by an Issuer in a way that the integrity and authenticity of the credential can be cryptographically verified.
**Reference:** [OpenID4VCI](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html)

## WSCD (Wallet Secure Cryptographic Device)
**Description:** Hardware-backed secure environment for creating, storing, and/or managing cryptographic keys and data. Examples include Secure Elements (SE), Trusted Execution Environments (TEEs), and (remote or local) Hardware Security Modules (HSM).
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## Secure Element
**Description:** Secure Elements are physical components in electronic devices that securely store and protect sensitive data and applications and may provide certain secure cryptographic operations.
**Reference:** [Secure Elements for mobile platforms](https://en.wikipedia.org/wiki/Secure_element)

## Zero Knowledge Proofs (ZKP)
**Description:** In cryptography, a zero-knowledge proof is a method by which an entity can prove that they know a certain value without disclosing the value itself.

## Wallet Provider
**Description:** A Wallet Provider makes a combination of products and Trust Services available to a User, giving the User sole control over the use of their Person Identification Data and attestations. The Wallet Provider issues and signs the Wallet Unit Attestation and is listed on a Trusted List.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## Wallet Unit
**Description:** A deployed instance of a Wallet Solution, belonging to and under the sole control of one User. A Wallet Unit comprises one or more Wallet Instances together with the Wallet Secure Cryptographic Application(s) and Device(s) it relies on.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## Wallet Unit Attestation (WUA)
**Description:** An attestation, issued and signed by the Wallet Provider, that lets an issuer (and where applicable a Relying Party) verify that a Wallet Unit is genuine and that the keys it will use are protected in a certified Wallet Secure Cryptographic Device. It combines the Wallet Instance Attestation (WIA) and the Key Attestation (KA).
**Reference:** 
- [Wallet Unit Attestation (WUA)](/concepts/wallet-unit-attestation/)
- [ARF 2.9.0 Topic C](https://eudi.dev/2.9.0/discussion-topics/c-rr-wallet-unit-attestations/)

## Wallet Instance Attestation (WIA)
**Description:** The part of the Wallet Unit Attestation that proves the Wallet Instance is a genuine, certified and currently trusted instance of a Wallet Solution from a known Wallet Provider. It is used as client authentication during credential issuance and is short-lived.
**Reference:** [Wallet Unit Attestation (WUA)](/concepts/wallet-unit-attestation/)

## Key Attestation (KA)
**Description:** The part of the Wallet Unit Attestation that attests that the cryptographic keys listed in its `attested_keys` claim were generated in, and are protected by, the same Wallet Secure Cryptographic Device, at a stated level of assurance.
**Reference:** [Wallet Unit Attestation (WUA)](/concepts/wallet-unit-attestation/)

## Wallet Secure Cryptographic Application (WSCA)
**Description:** Software that uses a Wallet Secure Cryptographic Device (WSCD) to protect critical assets and to securely execute cryptographic functions on behalf of a Wallet Unit.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## Electronic Attestation of Attributes issued by a Public Sector Body (PuB-EAA)
**Description:** An Electronic Attestation of Attributes issued by, or on behalf of, a public sector body responsible for an authentic source, meeting the requirements laid down in eIDAS.
**Reference:** [ARF 2.9.0](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)

## eIDAS
**Description:** electronic IDentification, Authentication and trust Services: the EU framework (Regulation (EU) No 910/2014, amended by Regulation (EU) 2024/1183, known as eIDAS 2) for electronic identification and trust services, which establishes the European Digital Identity Wallet.
**Reference:** [eIDAS 2](https://docs.igrant.io/regulations/reg-eu-digital-id-framework)
**Reference:** [AnonCreds Specification](https://hyperledger.github.io/anoncreds-spec/#term:zero-knowledge-proofs)

---

# Trust in the Wallet Ecosystem
Source: https://docs.igrant.io/docs/trust-overview/

---
id: trust-overview
title: Trust in the Wallet Ecosystem
description: Understand how the iGrant.io wallets establish trust in credential issuers and verifiers using the EU Trust List, EBSI, X.509 certificates and related trust frameworks.
hide_title: false
sidebar_label: Overview
keywords: [trust, trust list, EU Trust List, ETSI TS 119 612, trust anchor, trusted issuer, trusted authority, verifiable credentials, EUDI Wallet, Data Wallet, issuer trust, verifier trust]
slug: /trust-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Trust in the Wallet Ecosystem | iGrant.io DevDocs</title>
  <meta name="description" content="Understand how the iGrant.io wallets establish trust in credential issuers and verifiers using the EU Trust List, EBSI, X.509 certificates and related trust frameworks."/>
</head>

When a wallet receives a credential from an issuer, or responds to a request from a verifier, it needs a way to answer a simple question: can this party be trusted? Because you choose your wallet from any certified provider and a verifier may be an organisation you have never dealt with, that link cannot be assumed; it has to be proven. A valid cryptographic signature proves that a credential was not tampered with, but it does not, on its own, prove who the signer is or whether that signer is a recognised, accountable entity. Establishing that link between a key and a real, recognised organisation is the job of a trust framework.

This page explains how the iGrant.io Data Wallet and Organisation Wallet establish trust in the parties they interact with, the trust mechanisms they support, and how the result of that check is shown to the user.

## The bigger picture: Layers of trust

Trust in the EU Digital Identity ecosystem is not a single check but several layers, each resting on the one below. It helps to see where the checks on this page fit.

<div style={{maxWidth: '520px'}}>

![The five layers of trust in the EUDI Wallet ecosystem, from the legal foundation up to every transaction, each layer resting on the one below](/img/docs/trust-layers.webp)

</div>

1. **Legal foundation.** eIDAS 2.0 and its Implementing Acts define the roles, certification and supervision for everyone.
2. **Ecosystem trust (who is who).** Trusted Lists record which providers, issuers and relying parties are recognised, so parties that have never met can verify each other.
3. **Wallet and device trust.** The Wallet Unit Attestation proves a wallet is genuine and that its keys are in secure hardware. See [Wallet Unit Attestation (WUA)](https://docs.igrant.io/concepts/wallet-unit-attestation/).
4. **Credential trust.** Credentials are signed by trusted issuers and bound to the holder's keys, so they cannot be forged or copied.
5. **Transaction trust.** At each exchange, the parties prove themselves before any data is shared.

**This page focuses on Layer 2:** how the wallet checks that an issuer or verifier is a recognised entity (against the EU Trust List and related mechanisms), and how it surfaces the result (Layer 5).

## What is being checked

This page concentrates on the ecosystem-trust layer: confirming that an issuer or verifier is a recognised entity. The other layers are covered in separate articles, for example [Wallet Unit Attestation (WUA)](https://docs.igrant.io/concepts/wallet-unit-attestation/) for wallet and device trust and the [credential issuance lifecycle](/concepts/credential-issuance-lifecycle/) for how credentials are issued and bound to the holder.

Trust is evaluated for the two roles a wallet interacts with:

* **Issuers**, also called service providers in the wallet interface, who issue credentials into the wallet during an issuance (OpenID4VCI) flow.
* **Verifiers**, also called relying parties, who request credentials from the wallet during a presentation (OpenID4VP) flow.

In both cases the wallet attempts to match the party's identity (for example, its certificate, decentralised identifier, or registered entity details) against one or more trusted sources. If a match is found, the party is treated as trusted and its verified details can be shown to the user. If no match is found, the wallet displays a **"not verified"** notice. See [The "not verified" provider notice](/docs/trust-untrusted-service-provider/) for what that notice means and how to resolve it.

## Supported trust mechanisms

The wallet can validate issuers and verifiers against several trust mechanisms. The most relevant for European Digital Identity (EUDI) scenarios is the EU Trust List.

| Mechanism | Description |
| --------- | ----------- |
| **EU Trust List** (as per [ETSI TS 119 612](https://www.etsi.org/deliver/etsi_ts/119600_119699/119612/02.01.01_60/ts_119612v020101p.pdf)) | Each EU member state publishes a trusted list of qualified and non-qualified trust service providers. These national lists are aggregated through the European List of Trusted Lists (LoTL). The wallet checks whether the issuer or verifier appears on a list it validates against. Most established issuers in the EUDI framework are included. |
| **EBSI** | The European Blockchain Services Infrastructure trust model, where an issuer is onboarded through a trust chain (Root Trust Anchor Operator, Trust Anchor Operator, Trusted Issuer) and recorded in the EBSI Trust Registry. |
| **X.509 certificates** | Trust is anchored in a Public Key Infrastructure (PKI) certificate chain that terminates at a recognised root or intermediate certificate authority. |
| **Verifier knows Issuers** | A configured allow list of issuers that a given verifier deployment chooses to trust directly. |
| **OpenID Federation** | Trust established through an OpenID Federation trust chain. Support is on the roadmap (coming soon). |

The mechanisms available to a specific deployment depend on how its trust authorities are configured. See the [Trust Anchor APIs](/docs/category/openid4vc-api/trust-anchor) and the trust authority configuration endpoints for how these are managed.

## EU Trust List validation versus Trust Anchor onboarding

These two terms are easy to confuse, so it is worth being precise about the difference.

:::info Two related but distinct mechanisms

* **EU Trust List validation** answers "is this issuer or verifier on a recognised trusted list?". It is a lookup the wallet performs against published trusted lists (ETSI TS 119 612 and the LoTL). It is the mechanism most often behind the "not verified" notice.
* **Trust Anchor onboarding** is the process of registering an entity into a trust framework, so that it becomes trusted in the first place. The exact mechanism depends on the framework. In EBSI, for example, it is the trust chain of Root TAO, TAO and Trusted Issuer, exposed through the [Trust Anchor APIs](/docs/category/openid4vc-api/trust-anchor). Onboarding can also be established by other means, such as X.509 certificates: this is how a relying party is registered on the iGrant.io test network so the Data Wallet treats it as trusted, described in [Register as a Wallet-Relying Party](/docs/trust-relying-party-registration/).

In short: onboarding puts an entity into a trust framework, and trust list validation checks an entity against the trusted lists at the time of issuance or presentation. An issuer that has not been onboarded to any framework the wallet recognises, and that does not appear on a trusted list the wallet validates against, will be shown as an untrusted service provider.

:::

## How trust status is surfaced

After the wallet evaluates a party, the outcome is exposed both in the wallet interface and in the API. For a presentation flow, the verification response includes:

* `isVerifiedWithTrustList`: a boolean indicating whether the party was matched against a configured trust list.
* `trustServiceProvider`: an object carrying the verified trust service provider details when a match is found.

When `isVerifiedWithTrustList` is `false`, the wallet shows the **"not verified"** notice to the user.

## Related pages

* [The "not verified" provider notice](/docs/trust-untrusted-service-provider/)
* [Trust Anchor APIs](/docs/category/openid4vc-api/trust-anchor)
* [Data Wallet Features](/docs/data-wallet-features/)
* [DCQL query with a trusted authority](/docs/dcql-basic-credential-query-with-trusted-authority/)
* [Wallet Unit Attestation (WUA)](https://docs.igrant.io/concepts/wallet-unit-attestation/)
* [Credential issuance lifecycle (OpenID4VCI)](/concepts/credential-issuance-lifecycle/)


---

# Register as a Wallet-Relying Party
Source: https://docs.igrant.io/docs/trust-relying-party-registration/

---
id: trust-relying-party-registration
title: Register as a Wallet-Relying Party
description: Get your service listed on the iGrant.io recognised Trust List, operated as a test network, so the Data Wallet treats you as a trusted wallet-relying party.
hide_title: false
sidebar_label: Register as a Wallet-Relying Party
keywords: [wallet-relying party, relying party registration, trust list, Data Wallet, EUDI Wallet, eIDAS, Regulation 2025/848, registrar, wrpac, wrprc, verified badge, register your service]
slug: /trust-relying-party-registration/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Register as a Wallet-Relying Party (Test Network) | iGrant.io DevDocs</title>
  <meta name="description" content="Get your service listed on the iGrant.io recognised Trust List, operated as a test network, so the Data Wallet treats you as a trusted wallet-relying party."/>
</head>

import Link from "@docusaurus/Link";
import NoteBox from "@site/src/components/NoteBox";

Registering as a wallet-relying party gets your service onto the **iGrant.io recognised Trust List**, so the [Data Wallet](/docs/data-wallet-overview/) shows a verified badge for your organisation instead of the <Link to="/docs/trust-untrusted-service-provider/">"Service provider not verified"</Link> warning. This guide covers the **test network**, where the recognised Trust List is operated by iGrant.io for development and piloting.

<NoteBox title="Test network scope:" variant="info">
This is a <strong>test-network onboarding</strong> for developing and piloting against the Data Wallet. It mirrors the wallet-relying party registration pattern from eIDAS, but it is <strong>not</strong> the legal registration with a Member State national register. The recognised Trust List used here is operated as a test network by iGrant.io. Use it to make your service trusted during development, then follow your national register's process for production.
</NoteBox>

## Background: What a wallet-relying party is

Under eIDAS, a relying party that wants to request credentials from EU Digital Identity Wallets registers as a *wallet-relying party*. Commission Implementing Regulation (EU) 2025/848 defines it as:

> "'wallet-relying party' means a relying party that intends to rely upon wallet units for the provision of public or private services by means of digital interaction"

In production this registration is with a national register operated by a Member State registrar, providing the information in Annex I of the regulation. The test network mirrors that pattern so your service can be recognised during development.

## Step 1: Prepare your certificate

To register you need an X.509 certificate. Which certificate depends on the actor you register as:

| Actor | Certificate to provide |
|---|---|
| Wallet Provider | **Trust anchor (root CA)**: the CA certificate your wallet unit attestation signing certificates chain to |
| PID Issuer | **Trust anchor (root CA)**: the CA certificate your PID credential signing certificates chain to |
| EBWOID Issuer | **Trust anchor (root CA)**: the CA certificate your EBWOID credential signing certificates chain to |
| QEAA Issuer | **Trust anchor (root CA)**: the CA certificate your QEAA credential signing certificates chain to |
| EAA Issuer | **Trust anchor (root CA)**: the CA certificate your EAA credential signing certificates chain to |
| Relying Party | **Access certificate (WRPAC)**: the end-entity certificate you authenticate with when requesting credentials from wallets |

For issuers and wallet providers, the trust list carries your **root CA** as the trust anchor: wallets validate the credentials you issue by chaining the credential signing certificate up to it. For relying parties, the trust list carries your **access certificate**, so wallets can recognise you when you request credentials.

You can provide your own certificate, or generate a test one with the <Link to="/docs/devtools-certificate-generator/">Certificate Generator</Link>:

* Open the <Link to="/docs/devtools-certificate-generator/">Certificate Generator</Link>, fill in your organisation details, choose the service type, and provide your CSR.
* It generates the right certificate profile for your service type (root CA for issuers and wallet providers, access certificate for relying parties) and a **trust-list entry** in JSON with the certificate embedded. Copy the entry into the form in Step 2.

Using the Certificate Generator is optional. If you already have a suitable certificate, use that.

<NoteBox title="Subject to verification:" variant="note">
Everything you submit is reviewed and verified by iGrant.io before your service is added to the recognised Trust List. If you use the Certificate Generator, note that it produces a self-signed test certificate. Please ensure the data you enter is real and aligned with your official records.
</NoteBox>

## Step 2: Submit your registration request

Fill in the form below and choose **Submit registration request**. This opens your email client with the request, including your certificate and trust-list entry, pre-filled to [support@igrant.io](mailto:support@igrant.io); review it and send. After verification, the iGrant.io team adds your entry to the recognised Trust List for you.

import RelyingPartyRegistration from "@site/src/components/RelyingPartyRegistration";

<RelyingPartyRegistration />

<NoteBox title="Note:" variant="note">
For the test network, iGrant.io handles the trust-list update on your behalf, so there is no pull request for you to raise. Self-service submission is planned for a later release.
</NoteBox>

## Step 3: Confirm you are recognised

Once iGrant.io has added your entry and the Data Wallet has refreshed its trust lists, your organisation is matched against the recognised Trust List. Users then see the verified badge for your service instead of the <Link to="/docs/trust-untrusted-service-provider/">"Service provider not verified"</Link> popup.

## Related pages

* <Link to="/docs/devtools-certificate-generator/">Certificate Generator</Link>
* <Link to="/docs/trust-untrusted-service-provider/">The "Service provider not verified" notice</Link>
* <Link to="/docs/trust-overview/">Trust in the Wallet Ecosystem</Link>
* <Link to="/docs/data-wallet-overview/">Data Wallet</Link>


---

# The Issuer / service provider not verified notice
Source: https://docs.igrant.io/docs/trust-untrusted-service-provider/

---
id: trust-untrusted-service-provider
title: The "Issuer / service provider not verified" notice
description: Learn what the "Issuer not verified" / "Service provider not verified" notice (formerly "Untrusted Service Provider") in the iGrant.io Data Wallet means, why it appears, and how to make an issuer or verifier recognised.
hide_title: false
sidebar_label: '"Not verified" provider notice'
keywords: [Issuer not verified, Service provider not verified, Untrusted Service Provider, untrusted issuer, trust list, EU Trust List, ETSI TS 119 612, trust anchor, Data Wallet, EUDI Wallet, verifiable credentials, issuer trust, verifier trust, trust notice]
slug: /trust-untrusted-service-provider/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>The "Issuer / service provider not verified" notice explained | iGrant.io DevDocs</title>
  <meta name="description" content="Learn what the 'Issuer not verified' / 'Service provider not verified' notice (formerly 'Untrusted Service Provider') in the iGrant.io Data Wallet means, why it appears, and how to make an issuer or verifier recognised."/>
</head>

import NoteBox from '@site/src/components/NoteBox';

While using the iGrant.io Data Wallet you may see an **"Issuer not verified"** notice when receiving a credential from an issuer, or a **"Service provider not verified"** notice when responding to a verifier. This page explains what the notice means, when it appears, and what you can do about it.

<NoteBox title="How this appears now:" variant="info">
The Data Wallet proceeds only with <strong>trusted</strong> providers. When a provider cannot be matched against a recognised trust list, the wallet shows a <strong>warning popup</strong> rather than letting the interaction continue silently. The wording is context-aware: <strong>"Issuer not verified"</strong> during issuance and <strong>"Service provider not verified"</strong> during presentation. Earlier versions showed an inline <strong>"Untrusted Service Provider"</strong> chip or label. The meaning is the same: the party could not be matched against a recognised trust list.
</NoteBox>

## What it means

The notice is a trust status indicator. It means the credential's issuer (or, during a presentation, the verifier) could not be matched against a recognised trust list that the wallet validates against, primarily the [EU Trust List (ETSI TS 119 612)](https://www.etsi.org/deliver/etsi_ts/119600_119699/119612/02.01.01_60/ts_119612v020101p.pdf).

<NoteBox title="It is not a validation failure:" variant="note">
The credential may still be valid and correctly signed. The notice only means the wallet could not match the party against a recognised trust list, so it flags this for you to decide.
</NoteBox>

## When it appears

The notice can appear in either direction of a credential exchange, with wording matched to the context:

* **During issuance (OpenID4VCI), "Issuer not verified":** when a credential is offered by an issuer that the wallet cannot match to a trust list it validates against. This is common when evaluating credentials from an issuer other than iGrant.io's own issuer.
* **During presentation (OpenID4VP), "Service provider not verified":** when a verifier requesting credentials cannot be matched to a trust list.

## What you see in the wallet

**Trusted providers** are shown with a verified badge and their **trust service provider details**, the entry matched on the trust list.

**Providers that cannot be verified** trigger a **warning popup** (a bottom sheet) instead of continuing silently. It contains:

* a heading, **"Issuer not verified"** (issuance) or **"Service provider not verified"** (presentation), with the subtitle **"Not found on the Trust List"**;
* a warning that the party's identity could not be verified against the trust list, so the credential is not trustworthy, and that the details shown were supplied by the party and are unverified;
* the organisation name, marked **"Self-declared, not verified"**; and
* an **"Are you the operator of this service?"** prompt with a **"Register your service"** button for getting listed (see [How to resolve it](#how-to-resolve-it)).

<div style={{ display: 'flex', gap: '24px', flexWrap: 'wrap', justifyContent: 'flex-start', margin: '24px 0' }}>
  <figure style={{ margin: 0, flex: '0 0 260px', maxWidth: '260px' }}>
    <img
      src="/img/trust/issuer-not-verified.png"
      alt="Data Wallet showing the Issuer not verified popup during issuance"
      style={{ width: '100%', borderRadius: '14px', border: '1px solid var(--ifm-color-emphasis-300)' }}
    />
    <figcaption style={{ fontSize: '0.82em', color: 'var(--ifm-color-emphasis-700)', textAlign: 'left', marginTop: '8px', whiteSpace: 'nowrap' }}>
      Issuer not verified (issuance)
    </figcaption>
  </figure>
  <figure style={{ margin: 0, flex: '0 0 260px', maxWidth: '260px' }}>
    <img
      src="/img/trust/service-provider-not-verified.png"
      alt="Data Wallet showing the Service provider not verified popup during presentation"
      style={{ width: '100%', borderRadius: '14px', border: '1px solid var(--ifm-color-emphasis-300)' }}
    />
    <figcaption style={{ fontSize: '0.82em', color: 'var(--ifm-color-emphasis-700)', textAlign: 'left', marginTop: '8px', whiteSpace: 'nowrap' }}>
      Service provider not verified (presentation)
    </figcaption>
  </figure>
</div>

## Trusted versus untrusted

The wallet's trust check is reflected in the API response for a flow. The two key fields are `isVerifiedWithTrustList` and `trustServiceProvider`.

| Wallet display | API state | Meaning |
| -------------- | --------- | ------- |
| **Trusted Service Provider** (verified provider details shown) | `isVerifiedWithTrustList: true`, `trustServiceProvider` populated | The issuer or verifier was matched against a configured trust list, and its verified trust service provider details are available. |
| **Issuer not verified** / **Service provider not verified** | `isVerifiedWithTrustList: false`, `trustServiceProvider` empty | The issuer or verifier was not found on any trust list the wallet validates against. |

## How to resolve it

If you are an integrator and want an issuer or verifier to be recognised rather than flagged, the entity needs to become discoverable through a trust mechanism the wallet validates against.

For development and piloting, the quickest path is to get listed on the iGrant.io recognised Trust List, operated as a test network. See [Register as a Wallet-Relying Party](/docs/trust-relying-party-registration/). For production, the main options are:

1. **Be listed on an EU member state trusted list.** Qualified and non-qualified trust service providers are published on national trusted lists aggregated through the European List of Trusted Lists (LoTL), as per ETSI TS 119 612. This is the primary path for EUDI scenarios.
2. **Onboard through a trust anchor.** For the EBSI trust model, an entity is onboarded through the trust chain (Root Trust Anchor Operator, Trust Anchor Operator, Trusted Issuer). See the [Trust Anchor APIs](/docs/category/openid4vc-api/trust-anchor).
3. **Be added to a configured trust list.** A deployment can configure the trust authorities and trust lists it validates against using the trust authority configuration endpoints.

:::tip Register your service from the wallet

The warning popup includes a **"Register your service"** button for operators. It leads to [Register as a Wallet-Relying Party](/docs/trust-relying-party-registration/), where you generate your certificate and key id and submit your entry so users see a verified badge instead of the warning.

:::

## Is this the same as a missing Trust Anchor definition?

Not exactly, although the two are related. The Trust Anchor APIs cover onboarding an entity into a trust framework such as EBSI. The not-verified notice is driven specifically by trust list recognition at the time of issuance or presentation. An issuer that has not been onboarded to a framework the wallet recognises, and that is not present on a trusted list the wallet validates against, will surface this notice. For a full explanation of the difference, see [Trust in the Wallet Ecosystem](/docs/trust-overview/#eu-trust-list-validation-versus-trust-anchor-onboarding).

:::tip Wording may vary

The exact wording can differ across wallet versions and platforms. Current versions show **"Issuer not verified"** (issuance) or **"Service provider not verified"** (presentation); earlier versions showed **"Untrusted Service Provider"**. The underlying meaning, that the party was not matched against a recognised trust list, is the same.

:::

## Related pages

* [Register as a Wallet-Relying Party](/docs/trust-relying-party-registration/)
* [Trust in the Wallet Ecosystem](/docs/trust-overview/)
* [Trust Anchor APIs](/docs/category/openid4vc-api/trust-anchor)
* [OpenID4VP - Receive and Present Credential](/docs/openID4vp-receive-and-present-credentials/)
* [Data Wallet Features](/docs/data-wallet-features/)


---

# TS12: Account Information Access
Source: https://docs.igrant.io/docs/ts12-account-information-access/

---
id: ts12-account-information-access
title: "TS12: Account Information Access"
hide_title: false
sidebar_label: Account Information Access
description: TS12 SCA workflow for account information access using a Payment Account credential, including transaction data for AISP authorisation.
keywords: [TS12, SCA, account information, AISP, payment account, OpenID4VP, EUDI Wallet, verifiable credentials]
slug: /ts12-account-information-access/
last_update:
  date: 2026-08-20
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";
import { TS12_ACCOUNT_ACCESS_SCENARIOS } from "@site/src/data/ts12/accountAccessScenarios";

TS12 SCA account information access enables an Account Information Service Provider (AISP) to request authorisation to access a user's payment account information by requesting a Payment Account credential with transaction data that describes the AISP and the purpose of access.

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the interactive block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in Step 3 automatically (and updated whenever Step 2 is re-run).

<DcqlStepTemplate
  initialJsonData={{
    label: "Payment Account",
    cryptographicKeyFormat: "x509",
    version: "version_01",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    enforceWUA: false,
    supportInteractiveAuthorisationEndpoint: true,
    credentialDefinitions: [
      {
        label: "Payment Account Credential - TS12",
        expirationInDays: 60,
        supportRevocation: true,
        validationPath: "$",
        revocationMethod: "status_list",
        enforceCredentialUniqueness: false,
        supportCredentialReissuance: false,
        credentialBindingMethods: ["did:key", "jwk"],
        authorizationRequestType: "authorization_details",
        scope: "",
        display: {
          name: "Payment Account",
          description: "Payment Account credential for SCA",
        },
        credentialResponseInterval: 20,
        credentialFormat: "dc+sd-jwt",
        vct: "https://oid4vc.igrant.io/service/vct-metadata/payment_account",
        claims: {
          claims: [
            { limitDisclosure: true, mandatory: true, path: ["iban"] },
            { limitDisclosure: true, mandatory: true, path: ["bic"] },
            { limitDisclosure: true, mandatory: true, path: ["currency"] },
          ],
        },
      },
    ],
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  extractJsonResponse={(result) => result}
  emitCredentialDefinitionIdsEvent="ts12AccountInformationAccess:credentialDefinitionCreated"
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run Step 2 on this page, the `credentialDefinitionId` and `credentials[].id` fields below are autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained from Step 2. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, you can toggle the switch to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or by directly accessing the credential offer on their mobile device (e.g. via a browser).

<DcqlStepTemplate
  initialJsonData={{
    issuanceMode: "InTime",
    credentialDefinitionId: "<credentialDefinitionId>",
    urlScheme: "openid-credential-offer://",
    credentials: [
      {
        id: "<id>",
        claims: {
          iban: "SE4109645307235006470086",
          bic: "ALPKOMO3XXX",
          currency: "SEK",
        },
      },
    ],
    userPin: "",
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer}
  listenCredentialDefinitionIdsEvent="ts12AccountInformationAccess:credentialDefinitionCreated"
  useCredentialDefinitionQrLogo
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](https://docs.igrant.io/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

Once a presentation definition has been created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

<DcqlStepTemplate
  initialJsonData={{
    label: "Account Information Access",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    cryptographicKeyFormat: "x509",
    version: "version_01",
    scope: "",
    responseType: "vp_token",
    enforceWUA: false,
    transactionDataDefinitionType: "account_access",
    transactionDataDefinition: {
      $schema: "https://json-schema.org/draft/2020-12/schema",
      type: "object",
      properties: {
        transaction_id: {
          type: "string",
          maxLength: 36,
          minLength: 1,
          examples: ["8D8AC610-566D-4EF0-9C22-186B2A5ED793"],
        },
        date_time: {
          type: "string",
          format: "date-time",
          examples: ["2025-11-13T20:20:39+00:00"],
        },
        aisp: {
          type: "object",
          properties: {
            legal_name: { type: "string" },
            brand_name: { type: "string" },
            domain_name: { type: "string" },
          },
          required: ["legal_name", "brand_name", "domain_name"],
        },
        description: {
          type: "string",
          maxLength: 140,
          examples: ["Grant access to the account's data."],
        },
      },
      additionalProperties: false,
      required: ["transaction_id"],
    },
    clientIdScheme: "redirect_uri",
    responseMode: "direct_post",
    dcqlQuery: {
      credentials: [
        {
          id: "Payment-Account-Credential-TS12",
          format: "dc+sd-jwt",
          meta: {
            vct_values: [
              "https://oid4vc.igrant.io/service/vct-metadata/payment_account",
            ],
          },
          claims: [
            { path: ["iban"] },
            { path: ["bic"] },
            { path: ["currency"] },
          ],
          require_cryptographic_holder_binding: true,
          multiple: false,
        },
      ],
    },
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  extractJsonResponse={(result) => result}
  emitPresentationDefinitionIdEvent="ts12AccountInformationAccess:presentationDefinitionCreated"
/>

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3). This step includes `transactionData` in the verification request payload, which is specific to TS12 SCA workflows. The `transactionData.payload` contains the transaction details that are dynamically linked to the user's authentication.

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

Use the **Scenario** dropdown to swap between a third-party AISP access and the bank's own access. The line under the dropdown explains which fields make each scenario. The `transaction_id` and `date_time` values are generated fresh on every **Run**.

<DcqlStepTemplate
  jsonOptions={TS12_ACCOUNT_ACCESS_SCENARIOS}
  jsonOptionLabel="Scenario"
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode}
  listenPresentationDefinitionIdEvent="ts12AccountInformationAccess:presentationDefinitionCreated"
  useVerificationQrLogo
/>

Users can copy the `presentationExchangeId` from the JSON response to track verification history. The Verifier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).


---

# TS12 SCA Workflows
Source: https://docs.igrant.io/docs/ts12-overview/

---
id: ts12-overview
title: "TS12 SCA Workflows"
hide_title: false
description: Introduction to Strong Customer Authentication (SCA) workflows with the EUDI Wallet, covering payment confirmation, risk-based authentication, e-mandates, and account information access.
sidebar_label: Overview
keywords: [TS12, SCA, Strong Customer Authentication, PSD2, ETSI TS 119 462, payment confirmation, risk-based authentication, e-mandate, account access, EUDI Wallet, transaction data]
slug: /ts12-overview/
last_update:
  date: 2026-08-20
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


These workflows implement **TS12**, the payment Strong Customer Authentication (SCA) profile for the EUDI Wallet defined in **ETSI TS 119 462**. It lets the wallet act as an SCA element for payments.

SCA is mandated under PSD2 Article 97(1) for electronic payment initiation, for accessing a payment account online, and for other actions that carry a risk of fraud. The EUDI Wallet supports all three authentication factor categories (knowledge, possession, inherence) and Dynamic Linking.

TS12 defines four SCA workflows, each driven by an SCA Attestation that the user's Account Servicing Payment Service Provider (ASPSP) issues into their Wallet Unit.

## SCA Attestation Types

<div className="ref-table">

| Attestation Type | Claims | Purpose |
|---|---|---|
| Payment Service User | None | Login and risk-based step-up authentication |
| Payment Card | `pan_last_four`, `scheme`, `scheme_logo` | Payment Authorisation and Recurring Payment Mandate |
| Payment Account | `iban`, `bic`, `currency` | Payment Authorisation, Recurring Payment Mandate, and Account Information Access |

</div>

## Transaction Types

<div className="ref-table">

| Workflow | Type Identifier | Attestation Used | Description |
|---|---|---|---|
| [Login and Risk-based Authentication](/docs/ts12-risk-based-authentication/) | `urn:eudi:sca:login_risk_transaction:1` | Payment Service User | Step-up SCA for sensitive actions (e.g. login from a new device) |
| [Payment Authorisation](/docs/ts12-payment-authorisation/) | `urn:eudi:sca:payment:1` | Payment Account, Payment Card | Authorise a payment via a PISP or directly |
| [E-mandate](/docs/ts12-emandate/) | `urn:eudi:sca:emandate:1` | Payment Account, Payment Card | Authorise a payment mandate (single, open-ended, recurring or instalment) |
| [Account Information Access](/docs/ts12-account-information-access/) | `urn:eudi:sca:account_access:1` | Payment Account | Authorise an AISP to access account data |

</div>

Each workflow follows the same 5-step developer pattern: obtain an API key, create a credential definition, issue a credential, create a presentation definition, and send a verification request with transaction data.

## Learn more

- [Payment Authorisation in EUDI Wallets (iGrant.io paper, v2.3)](https://igrant.io/papers/payment-authorisation-in-eudi-wallets-igrantio-paper-v2.3.pdf): the detailed design, rationale and background behind these workflows.
- **ETSI TS 119 462**: the standard that defines the TS12 payment profile.
- Building blocks used across the workflows: [Payment Wallet Attestation](/docs/openID4vci-payment-wallet-attestation/) and [Payment Data Confirmation](/docs/openID4vci-payment-data-confirmation/).


---

# TS12: Payment Authorisation
Source: https://docs.igrant.io/docs/ts12-payment-authorisation/

---
id: ts12-payment-authorisation
title: "TS12: Payment Authorisation"
hide_title: false
sidebar_label: Payment Authorisation
description: TS12 SCA workflow for payment authorisation using a Payment Card or Payment Account credential, including transaction data with payee details, amount, and currency.
keywords: [TS12, SCA, payment confirmation, payment card, payment account, transaction data, OpenID4VP, EUDI Wallet, verifiable credentials]
slug: /ts12-payment-authorisation/
last_update:
  date: 2026-08-20
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";
import { TS12_PAYMENT_SCENARIOS } from "@site/src/data/ts12/paymentScenarios";
import {
  TS12_ATTESTATION_TYPE_OPTIONS,
  TS12_PAYMENT_ACCOUNT_CREDENTIAL_DEFINITION,
  TS12_PAYMENT_ACCOUNT_ISSUE_REQUEST,
  TS12_PAYMENT_AUTHORISATION_PRESENTATION_ACCOUNT,
  TS12_PAYMENT_AUTHORISATION_PRESENTATION_CARD,
  TS12_PAYMENT_CARD_CREDENTIAL_DEFINITION,
  TS12_PAYMENT_CARD_ISSUE_REQUEST,
  withAttestationJson,
} from "@site/src/data/ts12ScaPayloads";

TS12 SCA payment authorisation enables a relying party to authorise a payment by requesting a **Payment Card** or **Payment Account** credential with transaction data that captures the payee details, amount, and currency.

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the interactive block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in Step 3 automatically (and updated whenever Step 2 is re-run).

Use the **Attestation type** dropdown to choose **Payment Card** or **Payment Account**. The same selection is applied to credential issuance (Step 3) and the presentation definition (Step 4).

<DcqlStepTemplate
  jsonOptionLabel="Attestation type"
  jsonOptionEventName="setTs12PaymentAttestationType"
  jsonOptions={withAttestationJson(TS12_ATTESTATION_TYPE_OPTIONS.paymentCardFirst, {
    payment_card: TS12_PAYMENT_CARD_CREDENTIAL_DEFINITION,
    payment_account: TS12_PAYMENT_ACCOUNT_CREDENTIAL_DEFINITION,
  })}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  extractJsonResponse={(result) => result}
  emitCredentialDefinitionIdsEvent="ts12PaymentAuthorisation:credentialDefinitionCreated"
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run Step 2 on this page, the `credentialDefinitionId` and `credentials[].id` fields below are autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained from Step 2. The **Attestation type** here is shared with Step 2, so it always matches the definition you created. If you switch it, the autofilled `credentialDefinitionId` clears, re-run Step 2 to create a matching credential definition before you issue. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, you can toggle the switch to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or by directly accessing the credential offer on their mobile device (e.g. via a browser).

<DcqlStepTemplate
  jsonOptionLabel="Attestation type"
  jsonOptionEventName="setTs12PaymentAttestationType"
  jsonOptions={withAttestationJson(TS12_ATTESTATION_TYPE_OPTIONS.paymentCardFirst, {
    payment_card: TS12_PAYMENT_CARD_ISSUE_REQUEST,
    payment_account: TS12_PAYMENT_ACCOUNT_ISSUE_REQUEST,
  })}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer}
  listenCredentialDefinitionIdsEvent="ts12PaymentAuthorisation:credentialDefinitionCreated"
  useCredentialDefinitionQrLogo
  resetIdsOnOptionChange
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](https://docs.igrant.io/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

Once a presentation definition has been created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

Use the **Attestation type** dropdown to request proof of a **Payment Card** or **Payment Account** credential. Choose the same type you issued in Steps 2 and 3.

<DcqlStepTemplate
  jsonOptionLabel="Attestation type"
  jsonOptionEventName="setTs12PaymentAttestationType"
  jsonOptions={withAttestationJson(TS12_ATTESTATION_TYPE_OPTIONS.paymentCardFirst, {
    payment_card: TS12_PAYMENT_AUTHORISATION_PRESENTATION_CARD,
    payment_account: TS12_PAYMENT_AUTHORISATION_PRESENTATION_ACCOUNT,
  })}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  extractJsonResponse={(result) => result}
  emitPresentationDefinitionIdEvent="ts12PaymentAuthorisation:presentationDefinitionCreated"
/>

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3). This step includes `transactionData` in the verification request payload, which is specific to TS12 SCA workflows. The `transactionData.payload` contains the transaction details that are dynamically linked to the user's authentication.

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

Use the **Scenario** dropdown to swap between the payment variants (instant, scheduled, recurring, PISP-initiated, merchant-initiated and card). The line under the dropdown explains which fields make each scenario. Scenarios that do not match the attestation type chosen in Steps 2 to 4 are disabled. The `transaction_id` and `date_time` are generated fresh on every **Run**.

<DcqlStepTemplate
  jsonOptions={TS12_PAYMENT_SCENARIOS}
  jsonOptionLabel="Scenario"
  filterEventName="setTs12PaymentAttestationType"
  defaultFilterValue="payment_card"
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode}
  listenPresentationDefinitionIdEvent="ts12PaymentAuthorisation:presentationDefinitionCreated"
  useVerificationQrLogo
/>

Users can copy the `presentationExchangeId` from the JSON response to track verification history. The Verifier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).


---

# TS12: E-mandate
Source: https://docs.igrant.io/docs/ts12-emandate/

---
id: ts12-recurring-payment-mandate
title: "TS12: E-mandate"
hide_title: false
sidebar_label: E-mandate
description: TS12 SCA workflow for e-mandates (single, open-ended, recurring and instalment) using a Payment Account or Payment Card credential, with transaction data for the mandate.
keywords: [TS12, SCA, e-mandate, payment mandate, payment account, payment card, recurring payment, instalment, mandate authorisation, OpenID4VP, EUDI Wallet, verifiable credentials]
slug: /ts12-emandate/
last_update:
  date: 2026-08-20
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";
import { TS12_EMANDATE_SCENARIOS } from "@site/src/data/ts12/emandateScenarios";
import {
  TS12_ATTESTATION_TYPE_OPTIONS,
  TS12_EMANDATE_PRESENTATION_ACCOUNT,
  TS12_EMANDATE_PRESENTATION_CARD,
  TS12_PAYMENT_ACCOUNT_CREDENTIAL_DEFINITION,
  TS12_PAYMENT_ACCOUNT_ISSUE_REQUEST,
  TS12_PAYMENT_CARD_CREDENTIAL_DEFINITION,
  TS12_PAYMENT_CARD_ISSUE_REQUEST,
  withAttestationJson,
} from "@site/src/data/ts12ScaPayloads";

TS12 SCA e-mandate enables a relying party to authorise a payment mandate, whether single or deferred, open-ended, recurring, or instalment, by requesting a **Payment Account** or **Payment Card** credential with transaction data that captures the mandate details: purpose, dates, creditor and, where relevant, a payment schedule.

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the interactive block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in Step 3 automatically (and updated whenever Step 2 is re-run).

Use the **Attestation type** dropdown to choose **Payment Account** or **Payment Card**. The same selection is applied to credential issuance (Step 3) and the presentation definition (Step 4).

<DcqlStepTemplate
  jsonOptionLabel="Attestation type"
  jsonOptionEventName="setTs12EmandateAttestationType"
  jsonOptions={withAttestationJson(TS12_ATTESTATION_TYPE_OPTIONS.paymentAccountFirst, {
    payment_account: TS12_PAYMENT_ACCOUNT_CREDENTIAL_DEFINITION,
    payment_card: TS12_PAYMENT_CARD_CREDENTIAL_DEFINITION,
  })}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  extractJsonResponse={(result) => result}
  emitCredentialDefinitionIdsEvent="ts12RecurringPaymentMandate:credentialDefinitionCreated"
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run Step 2 on this page, the `credentialDefinitionId` and `credentials[].id` fields below are autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained from Step 2. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, you can toggle the switch to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or by directly accessing the credential offer on their mobile device (e.g. via a browser).

<DcqlStepTemplate
  jsonOptionLabel="Attestation type"
  jsonOptionEventName="setTs12EmandateAttestationType"
  jsonOptions={withAttestationJson(TS12_ATTESTATION_TYPE_OPTIONS.paymentAccountFirst, {
    payment_account: TS12_PAYMENT_ACCOUNT_ISSUE_REQUEST,
    payment_card: TS12_PAYMENT_CARD_ISSUE_REQUEST,
  })}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer}
  listenCredentialDefinitionIdsEvent="ts12RecurringPaymentMandate:credentialDefinitionCreated"
  useCredentialDefinitionQrLogo
  resetIdsOnOptionChange
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](https://docs.igrant.io/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

Once a presentation definition has been created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

Use the **Attestation type** dropdown to request proof of a **Payment Account** or **Payment Card** credential. Choose the same type you issued in Steps 2 and 3.

<DcqlStepTemplate
  jsonOptionLabel="Attestation type"
  jsonOptionEventName="setTs12EmandateAttestationType"
  jsonOptions={withAttestationJson(TS12_ATTESTATION_TYPE_OPTIONS.paymentAccountFirst, {
    payment_account: TS12_EMANDATE_PRESENTATION_ACCOUNT,
    payment_card: TS12_EMANDATE_PRESENTATION_CARD,
  })}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  extractJsonResponse={(result) => result}
  emitPresentationDefinitionIdEvent="ts12RecurringPaymentMandate:presentationDefinitionCreated"
/>

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3). This step includes `transactionData` in the verification request payload, which is specific to TS12 SCA workflows. The `transactionData.payload` contains the transaction details that are dynamically linked to the user's authentication.

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

Use the **Scenario** dropdown to swap between the mandate variants (single or deferred, open-ended, recurring, and instalment). The line under the dropdown explains which fields make each scenario. The `transaction_id` and `date_time` values are generated fresh on every **Run**.

<DcqlStepTemplate
  jsonOptions={TS12_EMANDATE_SCENARIOS}
  jsonOptionLabel="Scenario"
  filterEventName="setTs12EmandateAttestationType"
  defaultFilterValue="payment_account"
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode}
  listenPresentationDefinitionIdEvent="ts12RecurringPaymentMandate:presentationDefinitionCreated"
  useVerificationQrLogo
/>

Users can copy the `presentationExchangeId` from the JSON response to track verification history. The Verifier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).


---

# TS12: Login and Risk-based Authentication
Source: https://docs.igrant.io/docs/ts12-risk-based-authentication/

---
id: ts12-risk-based-authentication
title: "TS12: Login and Risk-based Authentication"
hide_title: false
sidebar_label: Login and Risk-based Authentication
description: TS12 SCA workflow for risk-based step-up authentication using a Payment Service User credential, including transaction data for login and risk actions.
keywords: [TS12, SCA, risk-based authentication, payment service user, step-up authentication, OpenID4VP, EUDI Wallet, verifiable credentials]
slug: /ts12-risk-based-authentication/
last_update:
  date: 2026-08-20
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import { ApiKeyManager } from "@site/src/components/ApiKeyManager";
import DcqlStepTemplate from "@site/src/components/DCQL/DcqlStepTemplate";
import { TS12_LOGIN_RISK_SCENARIOS } from "@site/src/data/ts12/loginRiskScenarios";

TS12 SCA login and risk-based authentication enables a relying party to perform step-up authentication by requesting a Payment Service User credential with transaction data that captures the login context or a risk action.

## Step 1: Get the API Key (Issuer Admin)

To obtain your API key, please contact [support@igrant.io](mailto:support@igrant.io?subject=Request%20API%20Key). Once you have received your API key, enter it in the field below and click the **Set API Key** button to save it for future use.

<ApiKeyManager />

import { SigningKeyNote } from '@site/src/components/SigningKeySelect';

<SigningKeyNote />

## Step 2: Create Credential Definition (Issuer Admin)

To create a credential definition, run the interactive block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-credential-definition).

From the API response, the `credentialDefinitionId` and `id` value from the `credentialDefinitions` array are autofilled in Step 3 automatically (and updated whenever Step 2 is re-run).

<DcqlStepTemplate
  initialJsonData={{
    label: "Payment Service User",
    cryptographicKeyFormat: "x509",
    version: "version_01",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    enforceWUA: false,
    supportInteractiveAuthorisationEndpoint: true,
    credentialDefinitions: [
      {
        label: "Payment Service User Credential - TS12",
        expirationInDays: 60,
        supportRevocation: true,
        validationPath: "$",
        revocationMethod: "status_list",
        enforceCredentialUniqueness: false,
        supportCredentialReissuance: false,
        credentialBindingMethods: ["did:key", "jwk"],
        authorizationRequestType: "authorization_details",
        scope: "",
        display: {
          name: "Payment Service User",
          description: "Payment Service User credential for SCA",
        },
        credentialResponseInterval: 20,
        credentialFormat: "dc+sd-jwt",
        vct: "https://oid4vc.igrant.io/service/vct-metadata/payment_service_user",
        claims: {
          claims: [],
        },
      },
    ],
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential-definition"
  method="POST"
  extractJsonResponse={(result) => result}
  emitCredentialDefinitionIdsEvent="ts12RiskBasedAuthentication:credentialDefinitionCreated"
/>

## Step 3: Issue and Receive Credential (Issuer/Holder)

When you run Step 2 on this page, the `credentialDefinitionId` and `credentials[].id` fields below are autofilled automatically (and updated whenever Step 2 is re-run). If you are executing the APIs yourself, replace `<credentialDefinitionId>` and `<id>` with the values obtained from Step 2. The holder of the wallet submits a request for the issuance of a credential by executing the JSON code block below using the **Run** button in `InTime` issuance mode. Alternatively, you may use the API available [here](/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential).

After receiving the response, you can toggle the switch to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the credential offer using the [Data Wallet](https://www.igrant.io/datawallet.html) (or any other EU Digital Identity Wallet) by either scanning the QR code or by directly accessing the credential offer on their mobile device (e.g. via a browser).

<DcqlStepTemplate
  initialJsonData={{
    issuanceMode: "InTime",
    credentialDefinitionId: "<credentialDefinitionId>",
    urlScheme: "openid-credential-offer://",
    credentials: [
      {
        id: "<id>",
        claims: {},
      },
    ],
    userPin: "",
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/credential/issue"
  method="POST"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.credentialHistory?.credentialOffer}
  listenCredentialDefinitionIdsEvent="ts12RiskBasedAuthentication:credentialDefinitionCreated"
  useCredentialDefinitionQrLogo
/>

To receive and accept the credential via API. First, use the `credentialOffer` to call the [Receive Credential API](https://docs.igrant.io/docs/openid4vc-api/config-receive-digital-wallet-open-id-credential/). Once you have the response, copy the `credentialId` and provide it at [Accept Credential API](https://docs.igrant.io/docs/openid4vc-api/config-accept-digital-wallet-open-id-credential/) to accept the credential.

## Step 4: Create Presentation Definition (Verifier Admin)

To create a presentation definition for requesting proof, you can run the code block below using the **Run** button. Alternatively, you can manually copy the code block and use it in the body of the API request provided [here](/docs/openid4vc-api/config-digital-wallet-open-id-presentation-definition).

Once a presentation definition has been created, the `presentationDefinitionId` is autofilled in Step 5 automatically (and updated whenever Step 4 is re-run). You can also reuse the same `presentationDefinitionId` to verify multiple credentials.

<DcqlStepTemplate
  initialJsonData={{
    label: "Risk-based Authentication",
    cryptographicKeyIdentifier: "<cryptographicKeyIdentifier>",
    cryptographicKeyFormat: "x509",
    version: "version_01",
    scope: "",
    responseType: "vp_token",
    enforceWUA: false,
    transactionDataDefinitionType: "login_risk_transaction",
    transactionDataDefinition: {
      $schema: "https://json-schema.org/draft/2020-12/schema",
      type: "object",
      properties: {
        transaction_id: {
          type: "string",
          maxLength: 36,
          minLength: 1,
          examples: ["8D8AC610-566D-4EF0-9C22-186B2A5ED793"],
        },
        date_time: {
          type: "string",
          format: "date-time",
          examples: ["2025-11-13T20:20:39+00:00"],
        },
        service: {
          type: "string",
          maxLength: 100,
          examples: ["Superbank Onlinebanking"],
        },
        action: {
          type: "string",
          maxLength: 140,
          examples: ["Login to your online account."],
        },
      },
      additionalProperties: false,
      required: ["transaction_id", "action"],
    },
    clientIdScheme: "redirect_uri",
    responseMode: "direct_post",
    dcqlQuery: {
      credentials: [
        {
          id: "Payment-Service-User-Credential-TS12",
          format: "dc+sd-jwt",
          meta: {
            vct_values: [
              "https://oid4vc.igrant.io/service/vct-metadata/payment_service_user",
            ],
          },
          require_cryptographic_holder_binding: true,
          multiple: false,
        },
      ],
    },
  }}
  endpointPath="/v2/config/digital-wallet/openid/sdjwt/presentation-definition"
  method="POST"
  extractJsonResponse={(result) => result}
  emitPresentationDefinitionIdEvent="ts12RiskBasedAuthentication:presentationDefinitionCreated"
/>

## Step 5: Create Verification Request (Verifier/Relying Party)

When you run Step 4 on this page, the `presentationDefinitionId` field below is autofilled automatically (and updated whenever Step 4 is re-run). If you are executing the APIs yourself, replace `<presentationDefinitionId>` with the ID obtained in Step 4. To create the verification request, execute the code block below using the **Run** button. Alternatively, you can manually copy the JSON and use it in the body of the API available [here](/docs/openid4vc-api/config-create-digital-wallet-open-id-verification-request-v-3). This step includes `transactionData` in the verification request payload, which is specific to TS12 SCA workflows. The `transactionData.payload` contains the transaction details that are dynamically linked to the user's authentication.

After receiving the response, toggle the button provided to dynamically generate a QR code. The EUDI Wallet/Holder can then accept the verification request using the Data Wallet (or any other EU Digital Identity Wallet) by either scanning the QR code or directly accessing the verification request on their mobile device, such as via a browser.

Use the **Scenario** dropdown to swap between a login, a risk action, and adding a new payee. The line under the dropdown explains which fields make each scenario. The `transaction_id` and `date_time` values are generated fresh on every **Run**.

<DcqlStepTemplate
  jsonOptions={TS12_LOGIN_RISK_SCENARIOS}
  jsonOptionLabel="Scenario"
  endpointPath="/v3/config/digital-wallet/openid/sdjwt/verification/send"
  method="POST"
  extractJsonResponse={(result) => result}
  extractQrValue={(result) => result?.verificationHistory?.vpTokenQrCode}
  listenPresentationDefinitionIdEvent="ts12RiskBasedAuthentication:presentationDefinitionCreated"
  useVerificationQrLogo
/>

Users can copy the `presentationExchangeId` from the JSON response to track verification history. The Verifier (Relying Party) receives the requested credentials and can verify it. They may read the received credential by executing the [Read Verification History API](/docs/openid4vc-api/config-read-digital-wallet-open-id-verification-history-v-3).


---

# Explore the IEEE Paper on data exchange agreements
Source: https://docs.igrant.io/concepts/dataexchange-agreements-ieee-paper/

---
id: dataexchange-agreements-ieee-paper
title: Explore the IEEE Paper on data exchange agreements
description: Review how auditable data exchange agreements enhance transparency and trust in digital wallet ecosystems, as detailed in the IEEE publication.
hide_title: true
sidebar_label: Data Exchange Agreements Framework (IEEE Paper)
keywords: [data exchange agreements, IEEE, digital wallet, data agreements, transparency, auditability, regulatory compliance, privacy, DEXA]
slug: /dataexchange-agreements-ieee-paper/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


*Originally published at IEEE Xplore and accessible [here](https://ieeexplore.ieee.org/document/10275546). The paper was presented at IEEE ETFA 2023 - IEEE International Conference on Emerging Technologies and Factory Automation (Design and Enforcement of Safety, Security, Privacy and Law in Society 5.0)*

**Title:** Transforming Personal Data Transactions with Auditable, Privacy-Preserving Data Exchange Agreements - Fostering Transparency and Trust in Digital Wallet Ecosystems

**Abstract:** This paper proposes a comprehensive data exchange framework that addresses key digitalisation challenges and integrates regulatory compliance, usability, auditability, and transparency. The human-centric approach enables auditable data sharing, enhances security and privacy, and applies to centralised and decentralised systems, as evaluated in a digital wallet-based dataspace ecosystem.

**Keywords:** _privacy; digital wallet; data agreements; transparency; auditability; regulatory compliance_

## 1.0   Introduction

In the age of digital transformation, data access has become crucial for individuals and organisations. However, ensuring data privacy, regulatory compliance, transparency, and auditability has become a major challenge. The GDPR [1] and other emerging regulations have attempted to address some of these challenges, but effectively implementing these measures while mobilising data remains an issue [2][3]. Some key challenges are as follows: 

Fear of non-compliance: The impact of GDPR on different business models and organisations has been explored in several studies [1][2], highlighting the challenges and opportunities in complying with the regulation.
The legal penalties imposed by GDPR and similar regulations have led organisations to adopt cautious approaches to digitalisation. This is particularly evident among small and medium-sized enterprises (SMEs) and government entities. The crucial challenge for these organisations is continuing their digitalisation efforts while providing valuable services to their customers, given the potential risk of non-compliance with GDPR and related regulations. The impact of GDPR on different business models and organisations has been explored in several studies [1][2], highlighting the challenges and opportunities in complying with the regulation. Lindgren [4], for example, discusses how different business models and businesses are impacted by GDPR, highlighting the need for organisations to balance compliance with digital innovation.

The difficulty of obtaining meaningly consent and agreements: Obtaining consent from individuals to use their personal data is a complex issue, often made difficult by long and complex privacy policies and terms of service agreements. This can leave individuals unsure about what they agree to and how their data will be used, with no auditable log of their agreements [3]. The consent fatigue and the non-transparent manner in which they are obtained result in individuals saying no to sharing their data unilaterally. This can lead to a lose-lose situation, where organisations cannot leverage data to provide advanced personalised services, and individuals miss out on the benefits of such services. 

Lack of trust and transparency deficit: Hinds et al. [2] found that the Cambridge Analytica scandal resulted in a significant lack of trust and transparency towards organisations collecting and using personal data. The scandal caused individuals to become more aware of the extent of personal data being collected, how it is being used, and who has access to it. This increased awareness led to concerns about data breaches, identity theft, and the misuse of personal information.

Furthermore, these studies found that individuals are often unaware of how their data is being collected or used due to lengthy and complicated privacy policies and terms of service agreements. This lack of transparency and the complexity of agreements makes it difficult for individuals to give meaningful consent. As a result, individuals are more likely to say no to sharing their data unilaterally due to the perceived lack of transparency and trustworthiness of organisations collecting personal data.

To address the identified challenges, this paper proposes a practical approach incorporating risk-based compliance with regulations and a human-centric and usable approach to obtaining consents or agreements. Furthermore, it employs cryptographic mechanisms to ensure transparency and auditability for every data exchange transaction through a data exchange protocol. This significantly differs from many existing proposals in that it provides a complete framework that can be applied across the industry sectors.  The protocol builds upon the concept of data disclosure agreements (DDAs). A DDA is a legally binding contract governing personal data sharing between individuals and organisations. DDAs provide a framework for the terms of data sharing between organisations, including the purpose, scope, and duration of the sharing and the security and privacy measures that must be implemented. The proposed protocol enhances the DDA framework by incorporating digital rights management in the data agreements, enabling individuals to control their data and facilitating secure and responsible data exchange.

The reference system for the protocol is a digital wallet-based decentralised dataspace ecosystem. Digital wallets are secure digital storage and exchange solutions that allow individuals to store and manage their personal data while maintaining control over who has access to what data and for what purpose. By incorporating the proposed protocol into digital wallets, individuals can control the data they share, and organisations can ensure compliance with regulatory requirements. Overall, the proposed protocol aims to provide a secure, auditable and transparent solution for data exchange while prioritising the privacy and rights of individuals.


## 2.0 Background

### A. GDPR and Emerging Data Regulations

GDPR, or the General Data Protection Regulation [1], is a set of regulations introduced in 2018 to govern how organisations in the European Union (EU) handle personal data. The GDPR is one of the world's most comprehensive data privacy laws. It applies to any organisation that collects, processes, or stores the personal data of individuals within the EU, regardless of where the organisation is based.

The GDPR aims to give individuals more control over their personal data and ensures that organisations responsibly handle it. The regulation requires organisations to obtain clear and explicit consent from individuals before collecting or processing their personal data and to provide individuals with access to their data upon request.

In addition to the GDPR, other data regulations are emerging globally, such as the California Consumer Privacy Act (CCPA), Canadian Consumer Privacy Protection Act (CPPA)  and the Brazilian General Data Protection Law (LGPD). These regulations further emphasise the need for organisations to protect individuals' personal data and to ensure transparency and accountability in data processing.

### B. Data Misuse

Digital transformation has led to the explosion of data collection and exchange, making it a valuable asset for businesses across industries. With increased data collected and processed, the risk of misuse has also increased [2]. This has prompted governments worldwide to enact stricter regulations to protect individuals' privacy and digital rights [5]. The impact of data misuse is not limited to the loss of privacy and the individual harm caused by it. It also has far-reaching consequences for businesses and society, resulting in a significant trust deficit. Consumers are increasingly becoming aware of the value of their personal data and are losing trust in businesses that fail to protect it or use it for other purposes than agreed. This trust deficit makes it difficult for businesses to build long-term customer relationships, hampering their ability to innovate and grow. In addition, the reputational damage resulting from data breaches can be severe, leading to significant financial and legal consequences for businesses. Therefore, businesses must adopt measures that safeguard personal data and build customer trust.

### C. Transparency Missing

The need for transparency in personal data processing in organisations is crucial for ensuring individuals' right to self-determination, privacy, and a democratic society [6]. Many companies collect, store and share data, often without the knowledge of the individuals concerned. Many have been criticised for lacking data collection, storage and sharing transparency. This lack of transparency is particularly prevalent in industries that rely heavily on data, such as social media and advertising. For example, Facebook, TikTok etc., has been embroiled in several scandals related to data privacy and has been accused of not being transparent enough about how it collects and uses data.

Other industries, such as healthcare and finance, face challenges in ensuring transparency. In healthcare, for example, patients may not know what data is being collected about them and who has access to it. This lack of transparency can lead to concerns about privacy and security. In healthcare, for example, patients may not know what data is being collected about them and who has access to it. This lack of transparency can lead to distrust, as people may not know what information is being collected about them or how it is being used. Hence, companies and industries must be transparent about how they collect, store, and use data to build trust with customers and the wider public and to ensure that individuals continue to say yes to sharing their data.
The various criteria for enabling transparency at scale in the processing of personal data can be summarised [7] as below: 
Availability: individuals should have access to their personal data and be able to verify its accuracy and completeness.

* Understandability: individuals should be able to understand how their personal data is processed, including the purposes for which it is used.

* Timeliness: individuals  should be informed about processing their personal data on time, particularly in cases where data is processed without their consent.

* Granularity: Individuals  should be able to choose which types of data they want to share and with whom.

* Traceability: individuals  should be able to track the processing of their personal data and identify any entities that may have accessed or used their data.

* Context-awareness: individuals should be informed about the context in which their personal data is processed, including any relevant legal or ethical considerations.

For example, the European Legal Data Protection Framework reinforces the above criteria by granting individuals information, access and control rights and enforcing transparency and intervenability [1]. These criteria have been used as the backbone to develop the proposed methodology in this paper. 


### D. Digital Identity Wallets and Verifiable Credentials

Digital Identity Wallets and Verifiable Credentials [8] technologies enable individuals to maintain control over their personal data and share it securely and selectively with other parties while providing enhanced privacy, security, and usability. Digital Identity Wallets are software applications that allow individuals to store and manage their personal information in a secure and decentralised manner. They enable users to manage their identities across multiple online platforms and services while providing high privacy and control. By storing personal information on a user's device rather than on a centralised server, Digital Identity Wallets eliminate the need for users to trust third-party service providers with their sensitive personal information.

Verifiable Credentials are a key component of Digital Identity Wallets, including EU Digital Identity (EUDI) Wallets [9]. They are digital representations of real-world credentials such as driver's licences, passports, and academic degrees. Verifiable Credentials enable individuals to prove their identity and qualifications without sharing their sensitive personal information with third parties. They are cryptographically secured, tamper-proof, and can be verified instantly by anyone with the appropriate access rights.

Digital Wallets (including EUDI Wallets) and Verifiable Credentials promise to enhance privacy, security, and usability in the digital world. They enable individuals to take control of their digital identities and personal information while also providing a more transparent and trustworthy ecosystem for data sharing and exchange.

## 3.0 Methodology

### E. The Data Exchange Agreement Landscape

A typical data exchange ecosystem requires several agreements to validate the data exchanges legally. Based on the roles and the relationship that exists between the parties in the data exchange ecosystem, these agreements can be classified into four categories: 

a. An individual and an organisation
b. Two organisations
c. An organisation and its supplier
d. Two individuals
e. The data exchange agreement (DEXA) landscape, based on the above roles, is illustrated below.

![Data Exchange Landscape](paper/fig-01-data-exchange-landscape.png)
_Figure 01: The Data Exchange Agreement Landscape_

#### a. Data Agreement (DA) or Personal Data Agreement

A personal data agreement, simply called a data agreement, is an agreement between an organisation and an individual for using and processing personal data. It records the conditions for an organisation to process personal data in accordance with data protection regulations. An organisation can be a DS or a DUS. A DA can have any lawful bases as outlined by the relevant data protection regulation (such as the GDPR) and can be used, for example, for third-party data exchange. Regulations could be laws, ​norms (such as the MyData principles ) or architectures inspired by Lessig’s modalities of regulation [10].

The key characteristics of a DA are as follows:

* is associated with any personal data usage, including data exchange towards any DUS
* it can rely on an individual’s consent or other lawful bases such as contract, legal obligation, vital interests, public task and legitimate interests by outlining the purpose for which personal data is to be processed
* is tied to a data protection impact assessment (DPIA) that further strengthens legal compliance for the organisation. iGrant.io automates the conversion of the results of a DPIA to a machine-readable DA
* is standardised (ISO/IEC DTS 27560) under technical committee ISO/IEC JTC 1/SC 27 Information security, cybersecurity and privacy protection WG5: 27560 [27]

#### b. Data Disclosure Agreement (DDA)

A Data Disclosure Agreement (DDA) exists between two organisations where one organisation is a DS (Data Source) and the other as a DUS (Data Using Service). The DDA captures how data is shared between the two organisations and each party's role and obligation as a data processor and controller. For any organisation involved in the data exchange, there is an associated DA that explains the purpose of processing personal data, what personal data is collected, what the data subject rights are, etc.

#### c. Data Processing Agreement (DPA)


The third form of an agreement exists between an organisation and its suppliers, as illustrated in Figure 1. Here, there is a relationship between Organisation A as a data controller and its supplier as a data processor or sub-processor. For a higher level of accountability between these organisations, a DPA is set up, which lays out what routines are required to be in place: for example, a data processor’s obligations in case of a data breach or how the rights of the individual, such as access rights, are supported, among other policies and routines. An auditor should also be able to inspect the organisation and use the DPA as reference material during the inspection. As depicted in Figure 2, the DPA is connected to the individual at the top of the hierarchy via the data controller organisation.

#### d. Delegation Agreement

The delegation agreement is included to complete the data exchange ecosystem. A delegate may act on behalf of an individual in signing off any data exchange. There are several scenarios where delegation is necessary, for example, in the case of guardianship when an individual is incapable of signing off or in case an individual is given temporary rights to sign off on behalf of the individual, for example purchasing medicine at a pharmacy.


### F. Actors involved in a Data Exchange Ecosystem

The key actors involved in the DA and DDA lifecycle are described below. 

*Data Source:* the organisation that collects personal data and stores it. They are also referred to as issuers or data producers.
Individual or the Data Subject: is the natural person who can manage their preferences and follow their data, should know who is consuming what, when and why. They are also referred to as holders.

*Data Using Service:* is the organisation processing personal data from one or more data sources to deliver a service.
Assessor: The individual who reviews the practices of an organisation (DS or DUS), conducts a DPIA and drafts data agreements and inter-company agreements for third parties

*Auditor:* The individual who may be called in to review the data agreements and ensure they are in place in case of data breaches or regular inspection handled

*Data marketplace:* in a dataspace is the platform where organisations (DUS) can discover the DS’, and get into a trust relationship. Here the DS offers its data to potential DUS’.

The table below summarises the involvement of the actors in the DA and DDA lifecycle. 

_Table 01: Key Actors_
![Key Actors](paper/table-01-key-actors.png)

### G. The Data Exchange Agreement Workflow

An organisation wishing to use the DEXA workflow first performs a Data Protection Impact Assessment (DPIA) or similar. The result of a DPIA outlines the various data processing activities, the associated risks and mitigations. The DPIA report is important for demonstrating compliance with data protection regulations, such as the GDPR. The proposed process flow converts the DPIA outcome to machine-readable data agreements.

![High-level Data Exchange Agreement Workflow ](paper/fig-02-high-level-dataexchange-agreement-workflow.png)
_Figure 02: High-level Data Exchange Agreement Workflow_

The data agreement has its own lifecycle, implemented by its CRUD operations.

In cases where the purpose of processing is towards third-party data exchange, a DDA is formulated and published, e.g. towards a dataspace ecosystem, to make endpoints and services discoverable. Once discovered, DS and DUS can dynamically enter into data-sharing agreements to share and reuse personal data across organisational boundaries.

Like DA, the DDA has its own lifecycle, implemented by CRUD operations. Both DA and DDA have a similar lifecycle, as illustrated in Fig. 3 below.

![Different phases of DA and DDA lifecycle](paper/fig-03-different-phases-of-da-and-dda-lifecycle.png)
_Figure 03: Different phases of DA and DDA lifecycle_

The different phases are explained below:

*Definition:* An existing agreement template is adopted as is, or new ones are formulated in this phase. The template could be based on a particular industry and sector-specific practice. This can then be used by any organisation (DS or DUS) for a particular data usage purpose, in our case, for enabling third-party data exchange.

*Preparation:* An organisation creates an agreement based on a DPIA or similar and shares it with relevant parties. The relevant counterparty for the DA is the individual, and it is a DUS for the DDA.

*Capture:* The counterparty signs the agreement in this phase. For a DDA, it is countersigned by the DUS, while for a DA, it’s the individual. The parties can also reject or revoke an agreement in this phase.

*Proof:* Any organisation or individual can demonstrate that an agreement exists between the parties. Independent auditors can also check that records are in place, proving that the individual's personal data may be processed (e.g. as per Article 30, GDPR Article 30 [8]).

### H. Key values of Data Exchange Agreements

The key values enabled by DEXA are as described below:

* *Data regulatory compliance:* A DA based on a DPIA, together with a DDA, provides reassurance that the organisation has the intent to exchange data in compliance with a jurisdiction appropriate data protection regulation. 

* *Transparency:* A DA provides the requisite transparency to an individual on how personal data is to be used by an organisation, especially if exchanged with third parties. DDA enables organisations to be transparent about their data usage towards individuals, auditors and other organisations. 

* *Auditability:* With a DA and DDA, a DS can prove it's legitimate right to collect and share data with a DUS via a digital token-based verification system. Similarly, an individual can dispute data usage for which no legitimacy can be proven using the signed DA. DS and DUS can comply with regulations, e.g. GDPR Article 30 [8]. 

* *Human-centricity:* The focus is empowering individuals to control their data and make informed decisions about its use. It provides mechanisms to opt-in and opt-out in case consent is used as a lawful basis. 

* *Clarity and simplicity:* Using clear and concise language to make data exchange agreements understandable for all parties involved.

* *Flexibility and scalability:* The ability to adapt to changing business needs and emerging technologies while ensuring compliance and security.

## 4.0 Implementation

### I. Implementation set up

Fig 4 provides the reference implementation used to evaluate the capabilities of data exchange agreements. It uses self-sovereign identity and verifiable credential technologies. 

![Reference implementation with data agreements](paper/fig-04-reference-implementation-with-data-agreements.png)
_Figure 04: Reference implementation with data agreements_

In this implementation setup, the personal data exchange occurs through a series of interactions between the DS (issuer), the holder, and the DUS (verifier). The exchange process involves the following steps:

1. The individual requests personal data from the DS.
2. The DS verifies the holder's identity and grants the requested personal data access. To keep the records of all processing, the issuer uses a data agreement, signs it and presents it to the individual.
3. The individual receives personal data, views the signed data agreement, and counter-signs it to accept and store it in their digital wallet. 
4. The DUS requiring data processing sends a request to an individual with a signed data agreement specifying the terms and conditions for sharing the data.
5. The individual views the request and the signed data agreement and counter-signs it to share the data. The DUS can now use the data for its intended purposes.

This implementation setup follows the principles of data minimisation and consent-based data sharing (if consent is used as the lawful basis), ensuring that personal data is only shared for specific, legitimate purposes and with the explicit agreement of the data holder. The DS/DUS and the individual retain a signed data agreement receipt which can be used towards audits. With the receipt, the DS/DUS can fulfil their obligations under Article 30 of the GDPR (Records of processing activities) [11].

The implementation uses the Decentralised Identifier Communication (DIDComm) messaging protocol [12] between issuers, holders, and verifiers in a personal data exchange setup. It allows for a secure exchange of verifiable credentials or proofs, which the DUS can verify cryptographically. This messaging protocol is privacy-preserving, as it does not require the exchange of personal data but only the exchange of verifiable credentials that attest to the authenticity and integrity of the data. Additionally, DIDComm messaging is decentralised and relies on a peer-to-peer network, adding an extra layer of security to exchanging sensitive personal data. This messaging protocol is beneficial in healthcare settings, where the exchange of sensitive personal data is frequent, and privacy concerns are paramount. The implementation of DA and DDA protocol [13] using DIDComm is open-sourced and is available for audit for anyone interested.

### J. Verifiable Presentations with DIDComm

A verifiable presentation is a subset of one or more verifiable credentials. Instead of sharing all the information in the verifiable credential, an individual (holder) can selectively disclose only the necessary information to a DUS (verifier). Verifiable presentations can be exchanged between a holder and a verifier using the DIDComm messaging protocol. The individual can review the presentation and approve or deny its release to the DUS through a secure Present-Proof DIDComm Protocol [14]. The DUS can then verify the authenticity of the presentation using the issuer's public Decentralised Identifier (DID) and the cryptographic proof embedded in the presentation. This process allows for secure and auditable data exchange while protecting the privacy of the individual's personal information.

### K. DEXA protocol implementation

All agreements in the DEXA landscape use JSON-LD serialisation format and conform to W3C Verifiable Credential Data Model [8]. Besides the metadata for data policy, the agreements also contain cryptographic proofs or signatures that ensure its integrity. The following design requirements are met to embed the signatures in the agreement:
1. Can embed multiple signatures so the signing and counter signing can happen during the prepare and capture phases of the data agreement life cycle. 
2. Preserve the order of the signatures by protecting the chronology or the chain of events during a signing process. This also ensures non-repudiation so neither of the parties cannot deny the validity of their signatures. 


*Signature Process:* Agreements rely on W3C Data Integrity [15] specifications to embed the signatures and satisfy the above design requirements.


![Workflow for embedding cryptographic proofs in the agreements](paper/fig-05-workflow-for-embedding-cryptographic-proofs.png)
_Figure 05: Workflow for embedding cryptographic proofs in the agreements_

To create a cryptographic proof of the agreements, the following steps are required:

1. Transform data: The agreement is converted to canonicalised n-quads statement using the URDNA2015 canonicalisation algorithm.
2. Hash data: The agreement is hashed using the SHA256 hashing algorithm
3. Generate proof: The proof is generated and serialised per the W3C LDS ED25519-2018 signature suite [16].

*Data Exchange Agreement Signature Data Model:* The data agreement schema is illustrated in Fig. 6. The agreement data model has two parts: 1) W3C Verifiable Credential Data Model, which encompasses the organisational data (Organisation name, location, industry sector etc.), the usage purposes (purpose, purpose description, lawful basis etc.), personal data attributes (name, age, pulse reading or any PII attribute) and the data policy (e.g. retention period, policy URL, storage location, jurisdiction etc.). The DA and DDA ontology or data vocabulary is published in references [17] and [18] and can be resolved dynamically online.

![Data agreement schema with cryptographic proofs](paper/fig-06-data-agreement-schema-with-cryptographic-proofs.png)
_Figure 06: Data agreement schema with cryptographic proofs_

### L. Embedding DEXA into Verifiable Presentation

Today, the DA is implemented via a W3C-specified Decentralised Identifier (DID) DID:mydata. Any DUS wishing to consume any personal data prepares a data agreement offer. This offer is embedded into the Verifiable Presentation request as an extension of the Decorator protocol [19]. Here, agents conform to Aries Interop Profile (AIP) 1.0 [20], cloud or mobile-based, and share a verifiable presentation with a DUS through the Present Proof protocol [21]. The data agreement offer is embedded into the presentation request message using a data agreement context decorator [22], as illustrated in Fig. 7.

![DIDComm protocol message with data agreement context decorator](paper/fig-07-didcomm-with-dataagreement-decorator.png)
_Figure 07: DIDComm protocol message with data agreement context decorator_

When Data Wallet (or any other digital wallet supporting AIP 1.0) receives the presentation request message, it first checks if there is a DA context decorator present. If the decorator is present, the Individual is notified, and they can inspect the DA. If the Individual accepts the DA, it is counter-signed and sent back with shared data to the Data Using Service organisation. However, the Individual also has the option to reject the DA during this process.
Overall, this approach provides a secure and transparent way for individuals to share their data with trusted Data Using Service organisations while ensuring that the terms of any data agreements are clear and verifiable.

## 5.0 Case Study and Evaluation

### M. Health data exchange for remote patient monitoring

In this case study, the DEXA protocol was utilised within a healthcare setting that provides remote patient monitoring for elderly patients. The patients could engage in a video conference call with their caregiver (doctor) and verify their identity online using secure authentication measures. To ensure regulatory compliance and private communication, DEXA was used to establish a secure data agreement between the patient and the caregiver.

Before the conference call, the patient and the caregiver verify their identity by providing proof of using a secure identity verification system, for example. The system utilised a ledger-based technology with verifiable credentials to ensure the authenticity of the identity credential. Both the patient and the caregivers could view the verified identity credentials. 
During the conference call, the caregiver requested access to the patient's medical records, including medication history, health data, and other relevant information. The patient responded to the caregiver's request by agreeing to a data agreement that specified the data to be shared, the purpose and the duration of the agreement. Once the data agreement was established, the patient's medical records were securely transmitted to the caregiver. The caregiver used the patient's medical records to provide personalised health and care advice and to make informed decisions about the patient's health.

The case study demonstrated the potential of DEXA to enable data exchange in healthcare, enabling remote patient monitoring systems designed for the elderly. By using DEXA, we can protect sensitive patient data while still providing access to relevant data for healthcare professionals to generate actionable insights and provide high-quality care. The patient can view the data exchanged clearly and transparently, and both parties have a copy of the data agreement receipt. The receipt also allows the caregiver organisations to comply with regulations while fulfilling their obligations [13].


### N. Passport data exchange

The Data Wallet developed by iGrant.io [23] offers a convenient and secure solution for exchanging passport data. With this tool, individuals can easily convert their NFC-enabled passports into verifiable credentials that can be shared  without compromising the integrity and security of their personal information. One significant use case for this functionality is age verification, which can be effectively performed using Zero Knowledge Proof (ZKP) techniques [24]. By using iGrant.io's Data Wallet, individuals can prove their age without revealing their actual date of birth. The verifiable credential contains only the necessary information to verify their age or prove they are above a certain age. The Data Wallet employs a self-sovereign identity approach, which gives individuals complete control over their data and enables them to share it only with trusted parties, thereby providing a secure, privacy-preserving way of sharing personal data.

In the case example, a DUS formulates the data agreement, e.g., checking an individual’s age based on one’s passport. The DUS signs the DA and presents it along with the data request, which is counter-signed by the individual while accepting to share data. The individual can view the data exchanged, and both parties have a signed copy of their data agreement receipt in their digital wallets.

### O. Limitations of Data Exchange Agreements

The proposed DEXA protocol suite  shows promising results in our evaluation. It provides a framework for  building trust in a scalable data exchange infrastructure, meeting all key values it enables. The use of DPIA as an input to the DEXA lifecycle is also coherent with existing industry practices. It is, however, important to acknowledge its limitations. These include the need for standardisation, wider protocol adoption, and potential challenges in implementation and integration with existing systems. However, the overall positive impact of DEXA on promoting transparency and accountability in personal data transactions cannot be denied.
A major drawback is that DEXA requires trust between parties and relies on their ability to enforce the terms of the agreement. If there is a lack of trust or enforcement mechanisms, the DEXA may not effectively achieve its goals.


## 6.0 Related Work

While some of the related work focuses on specific technologies, such as blockchain [25][26] or distributed ledger, the approach taken in the Data Exchange Agreement (DEXA) described is technology-agnostic. For example the paper by C. Choi, J. Lee, and H. Kim [25] proposes a blockchain-based secure data-sharing system for Industry 4.0 to ensure the integrity and confidentiality of data exchanged between devices and machines. The system is based on a private blockchain and uses smart contracts to enforce data access and sharing rules. The proposed system is evaluated using a use case of a smart factory, and the results show that it can provide secure and efficient data sharing among different parties in the ecosystem.

The paper by Gao et al. [26] proposes a blockchain-based system for patient information exchange that preserves privacy by allowing patients to control their data. The proposed system uses smart contracts to enforce privacy policies and allows patients to control access to their data through a consent management module. The system was designed to comply with relevant privacy regulations and was evaluated using simulated healthcare scenarios. The results showed that the proposed system effectively preserved patient privacy while enabling secure and efficient data exchange between healthcare providers.

DEXA can be applied to the ledger and non-ledger solutions and centralised and decentralised systems. This approach allows for greater flexibility and wider applicability, making the DEXA a valuable tool for data exchange and digital rights management across various industries and use cases. By focusing on the agreement rather than the underlying technology, the DEXA may be more easily adaptable to future data exchange and digital rights management developments. It is also worth noting that DEXA provides a standardised framework for data exchange between organisations, which can include healthcare organisations and be extended to other industries, mobilising the use of data across industry sectors. Most importantly, the DEXA data policy is aligned with the proposed ISO27560 standard [27] on data privacy.

## 7.0 Conclusion

In conclusion, in today's data-driven world, data exchange agreements are essential for ensuring auditable data exchange and responsible digital rights management. With the increasing demand for secure and trustworthy data exchange, implementing a data exchange protocol in digital wallet-based data ecosystems can provide a viable, transparency-centric solution [7] to some of the more pronounced digitalisation challenges outlined earlier in the introduction [2][3[4]. The DEXA framework proposed in this paper offers a comprehensive approach to data exchange agreements, enabling stakeholders to exchange data transparently, accountably, and securely.

By adopting the DEXA framework, organisations can minimise non-compliance with regulations such as GDPR, retain control over their data, and establish trust with their partners and customers. As the importance of data access and reuse continues to grow, adopting the DEXA framework can lead to a more transparent and trustworthy data exchange ecosystem, benefiting both organisations and individuals alike.

To summarise, the DEXA framework addresses the key challenges identified in the introduction related to data privacy, regulatory compliance, transparency, and auditability in data exchange. By providing a practical approach that incorporates risk-based compliance and a human-centric and usable approach to obtaining consents or agreements, combined with cryptographic mechanisms to ensure transparency and auditability, the DEXA framework offers a promising solution for responsible and secure data exchange.



## References

1. Regulation (EU) 2016/679 of the European Parliament and of the Council of 27 April 2016 on the protection of natural persons with regard to the processing of personal data and on the free movement of such data, and repealing Directive 95/46/EC (General Data Protection Regulation) (Text with EEA relevance), [2016] OJ L 119/1
2. Hinds, J., Williams, E. J., & Joinson, A. N. (2018). "It wouldn't happen to me": Privacy concerns and perspectives following the Cambridge Analytica scandal. International Journal of Human-Computer Studies, 118, 46-52
3. iGrant.io (2018), Whitepaper: “Data Sharing and Consent Management: Making consumer choice a business opportunity”, Accessed April 2003, https://igrant.io/papers/iGrant.io_DataSharing_and_Consent_Management_v1.pdf 
4. Lindgren, P. (2018). GDPR Regulation Impact on Different Business Models and Businesses.Journal of Multi Business Model Innovation and Technology, Vol 4(3), 41-56.
5. Kozlowska, I. (2018). Facebook, Data Privacy, and the Age of Cambridge Analytica. The University of Washington - Jackson School of International Studies
6. Schwartz, D.G., Weber, S., Weichert, T. et al. (2016) Transparency in Data Processing on the Internet. Joint Proceedings of Ongoing Research of IFIP EGOV and IFIP ePart 2016. IOS Press
7. Bonatti, P., Kirrane, S., Polleres, A., & Wenning, R. (2017). Transparent Personal Data Processing: The Road Ahead. In 3rd International Workshop on Technical and Legal Aspects of Data Privacy and Security
8. Verifiable Credentials Data Model v1.1. Sporny, M; Noble, G; Longley, D; Burnett, D; Zundel, B; Den Hartog, K. (2022), W3C Recommendation, Available at: https://www.w3.org/TR/vc-data-model
9. European Commission (2021), "European Digital Identity", Accessed April 23, 2023,  https://commission.europa.eu/strategy-and-policy/priorities-2019-2024/europe-fit-digital-age/european-digital-identity_en 
10. Lessig, L. (2006) "Code and Other Laws of Cyberspace, Version 2.0",  New York: Basic Books
11. GDPR. n.d. "Article 30: Records of processing activities." Accessed April 25, 2023, https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32016R0679&from=EN#d1e1682-1-1 
12. Decentralised Identity Foundation (2022), "DIDComm Messaging v2.0." Accessed April 30, 2023. https://identity.foundation/didcomm-messaging/spec/v2.0 
13. Data Exchange Agreements (2021), Decentralised Data Exchange GitHub Repository. Accessed 01-May-20023. https://github.com/decentralised-dataexchange/data-exchange-agreements 
14. Khateev, N. (2019) Aries RFC 0037: Present Proof Protocol 1.0, Accessed May 02, 2023,  https://github.com/hyperledger/aries-rfcs/tree/main/features/0037-present-proof 
15. Sporny, Manu and Longley, Dave. Credentials Community Group. n.d. "Data Integrity." CG-DRAFT. Accessed April 30, 2023. https://w3c-ccg.github.io/data-integrity-spec/ 
16. W3C Credentials Community Group (2018), "Ed25519 Signature 2018." Accessed April 30, 2023. https://w3c-ccg.github.io/lds-ed25519-2018 
17. iGrant.io. n.d. "Data Agreement Vocabulary." Accessed April 2023. https://docs.igrant.io/docs/data-agreements-versions 
18. iGrant.io. n.d. "Data Disclosure Vocabulary." Accessed April 2023. https://docs.igrant.io/docs/dta-disclosure-agreements-versions 
19. Hardman, D (2020), Aries RFC 0011: Decorators, Accessed April 30, 2023. https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0011-decorators 
20. Hyperledger Aries. (2022). Aries Interop Profile. Accessed April 2023 https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0302-aries-interop-profile  
21. Hyperledger Aries RFC 0037 (2019), "Present Proof Protocol 1.0", Accessed April 30, 2023. https://github.com/hyperledger/aries-rfcs/tree/main/features/0037-present-proof
22. Automated Data Exchange RFC-006 (2022), “Data Agreement Context Decorator”, Decentralised Data Exchange GitHub repository: https://github.com/decentralised-dataexchange/automated-data-agreements/tree/main/ada-rfcs/rfc-006
23. iGrant.io. n.d. "Data Wallets." Accessed April 30, 2023. Available for download at Playstore and Appstore via https://igrant.io/datawallet.html 
24. Goldreich, O., Micali, S., & Wigderson, A. (1986). Proofs that yield nothing but their validity and a methodology of cryptographic protocol design. In Proceedings of the 27th Annual Symposium on Foundations of Computer Science (SFCS 1986) (pp. 174-187). IEEE.
25. C. Choi, J. Lee, and H. Kim, "Blockchain-Based Secure Data Sharing System for Industry 4.0," in Proceedings of the 2018 International Conference on Information and Communication Technology Convergence (ICTC), Jeju Island, Korea (South), Oct. 2018, pp. 899-901
26. Gao J, Zhou H, Tang J, et al. Privacy Preservation in Patient Information Exchange Systems Based on Blockchain: System Design Study. Journal of Medical Internet Research 2022;24(3):e29108
27. International Organization for Standardization. (2019). Privacy technologies - Consent record information structure: Draft Technical Specification, ISO/IEC DTS 27560. Geneva, Switzerland.



---

# EUDI Wallet Business Use Cases & Benefits (eIDAS 2.0)
Source: https://docs.igrant.io/concepts/eu-digital-identity-eudi-wallet-business-benefits-use-cases-eidas/

---
id: eu-digital-identity-eudi-wallet-business-benefits-use-cases-eidas
title: "EUDI Wallet Business Use Cases & Benefits (eIDAS 2.0)"
hide_title: true
description: "How businesses use the EUDI Wallet under eIDAS 2.0: instant verified onboarding, qualified e-signatures, legal entity credentials, and fraud reduction, with ARF guidance."
sidebar_label: EU Digital Identity Wallet Business Guide
keywords: [EUDI Wallet, EU Digital Identity Wallet, W3C VC, ISO 18013-5, mDL, mDoc, OpenID4VC, Verifiable Credentials, Digital Identity. Business Wallet, Business Guide]
slug: /eu-digital-identity-eudi-wallet-business-benefits-use-cases-eidas/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import UseCaseVideoGrid from '@site/src/components/UseCaseVideoGrid';

<head>
  <title>EUDI Wallet Business Use Cases &amp; Benefits (eIDAS 2.0) | iGrant.io</title>
  <meta name="description" content="How businesses use the EUDI Wallet under eIDAS 2.0: instant verified onboarding, qualified e-signatures, legal entity credentials, and fraud reduction, with ARF guidance." />
  <meta property="og:image" content="https://docs.igrant.io/img/articles/eudi-wallet-for-business.webp" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/articles/eudi-wallet-for-business.webp" />
  <script type="application/ld+json">
    {JSON.stringify({
      "@context": "https://schema.org",
      "@graph": [
        {
          "@type": "Article",
          "headline": "EUDI Wallet Business Use Cases & Benefits (eIDAS 2.0)",
          "image": "https://docs.igrant.io/img/articles/eudi-wallet-for-business.webp",
          "author": { "@type": "Organization", "name": "iGrant.io", "url": "https://igrant.io" },
          "publisher": {
            "@type": "Organization",
            "name": "iGrant.io",
            "url": "https://igrant.io",
            "logo": { "@type": "ImageObject", "url": "https://igrant.io/assets/images/favicons/preview.png" }
          },
          "dateModified": "2026-07-23",
          "mainEntityOfPage": "https://docs.igrant.io/concepts/eu-digital-identity-eudi-wallet-business-benefits-use-cases-eidas/"
        },
        {
          "@type": "FAQPage",
          "mainEntity": [
            {
              "@type": "Question",
              "name": "What is the EU Digital Identity (EUDI) Wallet?",
              "acceptedAnswer": { "@type": "Answer", "text": "It is an EU-backed digital wallet that lets individuals and organisations prove their identity, store and share trusted credentials, and digitally sign documents under user control. By 2026 every EU Member State must offer at least one wallet built to common European standards." }
            },
            {
              "@type": "Question",
              "name": "Which business use cases does the EUDI Wallet support?",
              "acceptedAnswer": { "@type": "Answer", "text": "The guide describes six flagship use cases: Personal ID (PID) issuance, Legal Person ID (LPID) issuance, qualified electronic signatures, Portable Document A1 (PDA1) issuance, a digital driving licence or photo ID based on ISO 18013-7 (mDL), and passwordless wallet-based login." }
            },
            {
              "@type": "Question",
              "name": "What is eIDAS 2.0 and when does it take effect?",
              "acceptedAnswer": { "@type": "Answer", "text": "eIDAS 2.0 is the amended EU regulation on electronic identification, adopted in 2024 and in force since May 2024. It requires each EU Member State to offer at least one interoperable wallet by 2026, free of charge to citizens, residents and businesses." }
            },
            {
              "@type": "Question",
              "name": "What credential formats does the wallet use?",
              "acceptedAnswer": { "@type": "Answer", "text": "It uses Selective Disclosure JWT (SD-JWT) so users can share only the attributes they consent to, and ISO/IEC 18013-7 mobile documents (mdoc/mDL) for official IDs. The wallet also aligns with the W3C Verifiable Credentials data model and OpenID-based protocols." }
            }
          ]
        }
      ]
    })}
  </script>
</head>

# EUDI Wallet Business Use Cases and Benefits (eIDAS 2.0)

_Learn how the EU Digital Identity Wallet, under the eIDAS 2.0 regulation, Implementing Acts and ARF framework, is transforming digital identity in Europe. This article explores real-world business use cases - such as PID, LPID, PDA1, and PhotoID issuance - and highlights the benefits of integrating with digital wallets, including the Data Wallet and Organisation Wallet Suite by iGrant.io. A must-read for enterprises looking to streamline identity verification, boost customer trust, and future-proof their digital services._

## 1.0 Introduction

The European Union’s **Digital Identity Wallet** or **EUDI Wallet** is poised to transform how individuals and organisations verify identity and share documents online. Part of the amended **eIDAS framework** ([The European Digital Identity Framework](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/)), this initiative will provide every EU citizen, resident, and even business with a secure digital wallet for identification and credential storage [1].

Digital Identity Wallets can come in two primary forms: for individuals and organisations. **Individual wallets** are typically smartphone-based and available on Android and iOS platforms. The **[Data Wallet by iGrant.io](https://docs.igrant.io/docs/data-wallet-overview/)** allows users to receive, store, and share credentials securely.

**Organisation** or **Business Wallets** are cloud-based and tailored for legal entities, such as businesses, government agencies, and service providers. They enable organisations to issue, hold and verify credentials and interact with other wallets. The [Organisation Wallet Suite by iGrant.io](https://docs.igrant.io/docs/organisation-wallet-overview/) is designed to support scalable and secure credential workflows within enterprise ecosystems.

An EU Digital Identity Wallet is a digital tool that allows people and organisations to **prove who they are**, **store and share trusted data**, and even **digitally sign forms**, all under user control and with high security. By 2026, each EU Member State will offer at least one wallet to its people and companies, following standard EU specifications.

The EU Digital Identity Wallet isn’t just a new tech curiosity for businesses and enterprises; it’s a game-changer. It stands to streamline customer onboarding, enhance trust in online transactions, reduce fraud, and open the door to fully digital cross-border services. This article breaks down the EU Digital Identity Wallet, its regulatory and technical framework, key use cases (from personal ID to electronic signatures), and most importantly, the **benefits and value propositions for businesses** looking to integrate with this new digital ecosystem.

## 2.0 EU Digital Identity Wallet and the eIDAS Framework

The EU Digital Identity Wallet emerges from the amended **eIDAS** or (aka **eIDAS 2.0**) regulation, a major update to Europe’s electronic identification rules. The original eIDAS (Electronic Identification, Authentication and Trust Services) Regulation of 2014 enabled cross-border recognition of national eIDs, but the digital world has since evolved. The revised regulation (sometimes called the European Digital Identity Framework) was adopted in 2024 to keep pace with growing online service needs and to address privacy concerns. It introduces the concept of a unified European Digital Identity Wallet as a means for everyone to carry their digital identity in a user-controlled way and to access (public) services across the EU.

Under this framework, Member States are mandated to provide wallet apps in a **coordinated, interoperable manner**. The regulation entered into force in May 2024, and by 2026, every EU country must offer at least one wallet conforming to the common European standards. As an official, government-backed digital identity method, these wallets will be **available to citizens, residents, and businesses** at no cost. Crucially for businesses, the wallets are **not limited to public services** – private sector services (banks, fintech, e-commerce, employers, etc.) can rely on them for secure identification and data exchange.

### 2.1 Implementing Regulations and Common Standards (ARF)

The EU created a standard Toolbox of technical specifications to ensure all EU Digital Identity Wallets work seamlessly across borders. The cornerstone of this toolbox is the **[Architecture and Reference Framework (ARF)](https://eudi.dev/latest/architecture-and-reference-framework-main/)** – a comprehensive blueprint of the wallet ecosystem. The ARF lays out common standards, protocols, and security requirements that all compliant wallets must follow, acting as a “rulebook” for developers and providers. In essence, it guarantees that a wallet issued in one country will be recognised and trusted in another, much like how an EU passport is interoperable across member states.

The ARF covers everything from data models to trust infrastructure. It specifies how personal identity data (PID) and other credentials are issued to the wallet, how they’re stored securely, and how they can be presented to a service provider. It also enshrines key principles like **privacy-by-design** and **security-by-design**. For example, the framework ensures that the user has full control over which attributes to share and that no party can track the user across different transactions – an important consideration for compliance with the GDPR and building user trust.

The European Commission and Member States are also finalising **Implementing Acts** (detailed regulations) to turn the technical specifications into law. These include standards for certification of the wallets’ security, governance models, and guidelines for private-sector integration. In practice, businesses don’t need to know the nitty-gritty of the ARF, but they will benefit from the outcomes: a wallet system that is uniform, **interoperable**, **reliable**, and **easy to plug into**.

### 2.2  Key Standards and Credential Formats

One reason the EU Digital Identity Wallet stands out is its adoption of cutting-edge **credential formats and standards** that balance security with privacy. Two notable technologies in the wallet’s design are **Selective Disclosure JWT (SD-JWT)** [1] and **mobile documents (mdoc/mDL)** as per ISO 18013-7. Understanding these helps businesses see how the wallet will safely handle data.

* **Selective Disclosure JWT (SD-JWT):** Traditional JSON Web Tokens (JWTs) package identity information into a token that, when shared, reveals all contained data to the recipient. SD-JWT is an enhanced format that allows **selective disclosure** of attributes. In practice, a user’s wallet can prove a specific fact about them without revealing unnecessary details. For instance, an online service might only need to know that a customer is over 18 or has a valid business license, rather than seeing their full birthdate or company data. The SD-JWT standard, developed through the IETF, accomplishes this by cryptographically hashing claims and only revealing the ones the user consents to share. For businesses, this is a boon: you get the **assurance of verified data** you need (e.g. age, identity, qualifications) while **respecting customer privacy**, which builds trust and reduces your data liability as per the GDPR. It’s privacy-by-design in action and baked into the wallet’s architecture.

* **Mobile Document / Mobile Driver’s License (mdoc/mDL):** The wallet will support digital credentials compliant with **ISO/IEC 18013-7**, the international standard for mobile driving licenses and IDs. In essence, ISO 18013-7 defines how to **store, secure, and share an official ID (like a driver’s license)** on a mobile device in a universally accepted way. This goes beyond just an ID picture – it’s a **cryptographically signed, machine-verifiable credential**. The EU Wallet leverages this for any Photo ID needs. For example, a user could have their driver’s license or national ID card digitally issued into their wallet and present it when needed (to a police officer, to rent a car, to check into a hotel, etc.). For businesses, supporting ISO-compliant digital IDs means you can trust the credential as much as a physical ID – it’s standardised and difficult to forge. It can streamline KYC processes (no more manual ID checks) and even enable entirely automated workflows at airports or banks with electronic verification. Because the wallet adheres to this global standard, businesses also gain **interoperability** beyond the EU (many countries are adopting the mDL standard, so in the future, an EU wallet’s digital ID could be recognised internationally).

In addition to SD-JWT and mDL, the EU Digital Identity Wallet framework aligns with the **W3C Verifiable Credentials** data model and uses protocols like **OpenID Connect** for presentations. The takeaway for enterprise architects is that the wallet isn’t reinventing the wheel – it’s using robust, widely discussed standards. This makes integration easier (many businesses already use OIDC/OAuth flows, which can be extended for wallet authentication) and ensures the solution is future-proof. Embracing these standards, the wallet enables selective data sharing and strong authentication methods that **minimise data exposure while maximising trust**.

## 3.0 Use Cases of the EU Digital Identity Wallet (EUDI Wallet) for Businesses

What practical applications will the EU Digital Identity Wallet have? While the ultimate possibilities are broad, several **flagship use cases** have been identified in the EU’s pilots and documents. These use cases illustrate how the wallet will function and how businesses might engage with it via what is also called the European Business Wallets. Many of them have been demonstrated in real EUDI Wallet pilots and production deployments, with live demo videos in [EUDI Wallet Pilots and Production Deployments](/docs/ecosystem-engagements/eudi-wallet-pilots-and-deployments). Below are some of the key scenarios and digital credentials and why they matter:

* **Personal ID (PID) Issuance:** Each wallet holder can receive a verified **Person Identification Data (PID)** credential – essentially a digital ID card issued by a trusted authority (like a national government identity provider). This PID contains core personal attributes (name, date of birth, nationality, etc.) and is the **foundation of one’s digital identity**. For businesses, you can reliably **identify customers or users online** with high assurance. Instead of asking users to upload scans of IDs or fill out lengthy verification forms, you can prompt them to share their PID from their wallet. The PID is **government-backed** and can reach a high level of assurance (LoA “High” under eIDAS), which is suitable even for regulated sectors like banking. Onboarding a new user (for example, creating a bank account or signing up for a telecom service) can become as simple as a one-click verification via the wallet. This dramatically reduces Know-Your-Customer (KYC) friction while combating identity fraud.

* **Legal Person ID (LPID) Issuance:** It’s not just natural persons with identities – companies and other organisations do, too. The wallet framework allows issuance of **Legal Person Identification Data (LPID)**, which are credentials that represent a business’s identity details or a mandate of a person to act on behalf of a business. Imagine a digital version of a company registration extract or a power-of-attorney certificate delivered to an owner’s or executive’s wallet. With an LPID, a company representative can prove the legitimacy of their business (name, registration number, VAT, authorised representative status) in seconds. This is valuable in B2B transactions and supply chains. For instance, when onboarding a new supplier or signing a contract, your business could request the counterparty’s LPID via the wallet to instantly verify that they are a **registered, legitimate business**. It streamlines B2B due diligence and can facilitate faster trust in partnerships. A national business registry or a Chamber of Commerce authority might issue an LPID credential. All EU parties can trust its authenticity because it’s under the eIDAS wallet system.

* **Digital Signature Integration (Qualified Signing):** One of the wallet’s built-in superpowers is the ability to create **electronic signatures** and seals that are legally recognised. The eIDAS 2.0 framework envisions wallet users being able to apply **Qualified Electronic Signatures (QES)** – the highest legal grade of e-signature in the EU – using keys stored in or accessed by the wallet. For businesses, this is a huge opportunity to digitise paperwork fully. With customers and partners having wallets, you can collect signatures on contracts, consent forms, or transactions digitally without needing separate e-signature software or insecure email exchanges. For example, a bank could have a user sign a loan agreement through a wallet prompt, or an HR department could get a new hire’s signature on an employment contract via the wallet – the signature is **legally binding and secure** (protected by the wallet’s cryptographic device). Notably, the wallet will provide qualified signing **by default and free of charge to users **[1], lowering the barrier for individuals to sign electronically. This means the pool of people capable of high-assurance digital signing will dramatically increase, benefiting any enterprise that requires signed agreements or approvals. In short, the wallet turns every smartphone into a potential secure signing device, and businesses should be ready to leverage that for **faster, paperless transactions**.

* **Portable Document A1 (PDA1) Issuance:** Companies with employees working across EU borders are familiar with the paperwork required to prove social security arrangements – notably the **Portable Document A1**. The PDA1 is an EU form that confirms which country’s social security system an employee is under when they temporarily work in another country. Today, this is often a paper or PDF process, but the EU wallet will enable **digital PDA1 credentials**. Social security institutions can issue a PDA1 directly to an individual’s wallet, which the individual (or their employer) can then present to foreign authorities or clients as needed. For businesses, this simplifies HR compliance for postings abroad. If you send workers to multiple EU countries, you can more easily obtain and show their A1 certificates via the wallet, avoiding delays and **ensuring regulatory compliance**. No more chasing paper forms or worrying about lost documents – the wallet holds the proof of social contributions payment. This use case highlights how the wallet isn’t just about personal identity and **official documents that grease the wheels of European cross-border operations**. (Similarly, other social security and health documents like the European Health Insurance Card could be digitised in the wallet, reducing red tape for international businesses.)

* **Digital Driving License / Photo ID (ISO 18013-7 mDL):** A digital driver's license or other government-issued photo ID is one of the first credentials likely to populate the wallet. Many EU states plan mobile driving licences, and the wallet provides a common platform. A digital driving license in the wallet can also serve as a general photo ID based on the ISO 18013-7 standard for mDL [4]. This has several business applications. Consider the car rental industry: instead of checking a physical driver’s license at the counter, rental companies could accept a **wallet-presented mDL**, speeding up pickup processes. Or online age-restricted services – a streaming service or e-commerce site selling alcohol could verify a customer’s age via a one-time wallet credential share (e.g., confirming “18+” derived from the mDL) without ever seeing the person’s ID details. The ISO-standard photo ID in the wallet means **businesses can trust the credential’s validity** (it’s digitally signed by the issuing authority) and automate verification. It also opens up the possibility for new services – for example, a digital hotel check-in where a guest sends their ID info and signs a check-in form via wallet before arrival. Anywhere a photo ID is needed, the wallet can step in, **making verifying identity faster and more convenient while reducing forgery risks.**

* **Passwordless Login (Wallet-based Authentication):** The wallet does more than issue and verify documents; it can also replace passwords. A user signs in to a website or app by presenting a credential from their wallet over OpenID Connect, so there is nothing to type and no password to phish, reuse, or leak. For businesses, this strengthens account security and removes login friction, and it integrates with existing identity and access management (IAM) systems through standard OpenID Connect. For example, a customer could log in to their bank with a wallet approval instead of a password. See the [passwordless login guide](/docs/eudi-passwordless-login-flow/) and try the [live bank login demo](https://www.igrant.io/demo/log-into-bank-account.html).

These use cases scratch the surface of the EU Digital Identity Wallet’s potential. Other scenarios include electronic diplomas and professional certificates (for easier hiring across countries), payment account information, travel credentials (some pilots test digital travel documents), and more. The consistent theme is that the wallet can securely store **verified, trusted credentials issued by authoritative sources**, and users can share them with a tap on their device. For enterprises, if you need verified information from a user or partner, you can obtain it in seconds with the user’s consent – no more weeks of chasing documents or third-party verifications.

### See these use cases in action

These are real demonstrations from iGrant.io's [EUDI Wallet pilots and production deployments](/docs/ecosystem-engagements/eudi-wallet-pilots-and-deployments):

<UseCaseVideoGrid videos={[
  { videoId: '6GwCxyofSVE', useCase: 'Personal ID (PID):', caption: 'Prove your identity, apply discounts, pay, and receive a boarding pass and e-receipt in seconds.', title: 'EUDI Wallet in Action: Prove ID, Apply Discounts, Pay' },
  { videoId: 'XlzInUYijdI', start: 20, useCase: 'Legal Person ID (LPID):', caption: 'Legal Person Identification Data issued to a Business Wallet, demonstrated with Bolagsverket.', title: 'EU Business Owner ID (LPID) Issuance' },
  { videoId: 'xaYztdKB26g', useCase: 'Digital driving licence / photo ID (mDL):', caption: 'Guests check in to a hotel using verifiable credentials from their EUDI Wallet.', title: 'EUDI Wallet for Hotel Check-in' },
  { videoId: 'uKQo34vOIEo', useCase: 'Age verification (mDL):', caption: 'Age-based discounts using selective disclosure for ticketing at Buda Castle.', title: 'EUDI Wallet at Buda Castle' },
  { videoId: 'WysMxTDcPSc', useCase: 'Passwordless login:', caption: 'Sign in without a password by presenting a wallet credential over OpenID Connect.', title: 'Passwordless Login with EUDI Wallets' },
]} />

## 4.0 Benefits of the EU Digital Identity Wallet for Businesses

From the above, it’s clear the EU Digital Identity Wallet is not just a convenience for individuals – it offers tangible advantages to companies and service providers. Here are some of the key benefits and value propositions for businesses and enterprises:

* **Streamlined Customer Onboarding and KYC:** Say goodbye to cumbersome identity checks. With the wallet, businesses can instantly receive customers' verified identity data (personal or corporate). This streamlines processes like new account registration, SIM card purchase, or signing up for financial services. It **reduces manual paperwork and verification costs** as the credential issuer guarantees authenticity. A process that once took days (scanning IDs, manual review) can now be done in minutes, improving conversion rates and user satisfaction.
* **Cross-Border Reach and Interoperability:** The wallet is an EU-wide solution by design. A company in one member state can onboard or verify a user from any other EU country with equal ease and trust. This **opens new markets** – businesses can expand services across Europe without implementing country-specific ID solutions. As all wallets follow the common European standards, a relying party interface will work for all of them. In short, the wallet provides a **European trust infrastructure**, helping enterprises operate seamlessly across borders.
* **Enhanced Security and Fraud Reduction:** Credentials in the EU wallet are issued by official sources and are tamper-proof (digitally signed). This reduces the risk of fake identities or forged documents slipping through. Additionally, wallet authentication will use strong methods (biometrics/PIN and device cryptography), often with high assurance levels. Businesses can be more confident in **who they are dealing with online**, lowering fraud losses. For example, an online lender receiving a wallet ID and income certificate can trust the data instead of scanned documents that might be Photoshopped. This high level of assurance is especially critical in sensitive sectors like banking, insurance, and healthcare.
* **Cost Savings and Efficiency:** In the long run, implementing wallet-based identity verification can be cheaper than continual manual processing or relying on multiple third-party verification services. Authentications become easier and cheaper as the European Commission notes for private companies. Over time, as wallet usage grows, businesses will see savings in customer support (fewer ID issues), compliance overhead, and paper handling. Automating workflows (like contract signing or vetting a business partner’s credentials) translates to operational efficiency.
* **Conduct More Business 100% Online:** The wallet removes many reasons for physical presence or paper in transactions. As the Commission highlighted, companies can conduct more types of business **entirely online**. This means you can acquire customers, sign agreements, and deliver services without asking anyone to visit an office or mail documents. It boosts digital transformation strategies – even traditionally tricky processes like notarisations, certified mail, or in-person ID checks can be re-imagined through the wallet. Businesses that embrace the wallet will be well-positioned to offer seamless digital experiences end to end, which modern customers expect.
* **Legally Compliant Digital Signatures:** With the wallet’s qualified e-signature capability, obtaining signatures that meet legal requirements (like **qualified electronic signatures under eIDAS**) becomes straightforward. There’s no need for separate hardware tokens or proprietary signature platforms for your customers – they can use the wallet they already have. This lowers the barrier to getting necessary contracts signed quickly. For the business, it ensures the signatures are **legally defensible** (since EU trust services rules back them) and the signing process is user-friendly. It can significantly shorten sales cycles or procurement processes when documents can be signed and returned in minutes with a few taps by the signer.
* **Privacy Compliance and Customer Trust:** The selective disclosure features of the wallet mean that businesses can practice **data minimisation** easily – you request and receive only the data you truly need. This is great for GDPR compliance (collecting less personal data, reducing storage liabilities) and building user trust. Customers are more likely to sign up or share info if they know they won’t be over-sharing. The wallet’s design inherently supports this, allowing users to approve exactly what information a service gets. By integrating with the wallet, companies can advertise that they respect user privacy (since the user controls their data sharing), which can be a competitive advantage in a privacy-conscious market.
* **Neutral and Trusted Authentication Option:** The EU Digital Identity Wallet provides a neutral, public-sector-backed option for authentication. Unlike social logins (Google, Facebook) or private digital IDs, the wallet comes with the trust of government issuance and European-wide governance. For businesses, this means you are not dependent on any one big tech identity provider, and you avoid potential user concerns about commercial data tracking. It’s an **independent, standards-based infrastructure**. In the long term, this could foster a more diverse digital identity ecosystem where users can choose and businesses aren’t locked into proprietary systems. In essence, the wallet could become as ubiquitous as email – a common way for users to “log in” or share info, which any service can accept without special partnerships.

## 5.0 Conclusion

The EU Digital Identity Wallet represents a significant step forward in Europe’s digital economy, and its impact will be felt across both the public and private sectors. It offers a new **universal** **tool** **for** **trust** for businesses and enterprises -  a way to know your customers and partners with certainty, transact seamlessly across borders, and cut the friction out of administrative processes. By adhering to robust standards and the eIDAS 2.0 legal framework, the wallet ensures that security, privacy, and interoperability are not afterthoughts but core features.

Enterprises should start exploring how to integrate the EU Digital Identity Wallet into their digital services. Whether it’s updating your onboarding workflows to accept wallet credentials, training your compliance teams on the new digital documents like PDA1, or collaborating in pilots, preparing now will pay off soon. Early adopters can differentiate themselves by offering customers a cutting-edge, convenient experience – imagine being among the first to let users sign up with a single wallet click or sign a contract on their phone with an official eIDAS-compliant signature.

In summary, the EU Digital Identity Wallet is **coming fast** (Member States are gearing up for 2025 pilots and the 2026 rollout) and promises safer, simpler digital interactions. It embodies the principle that individuals should control their identity data while providing businesses with verified information. By embracing the wallet, companies can boost trust with their users, reduce costs, and unlock fully digital growth opportunities. The future of digital identity in Europe is a **wallet in everyone’s pocket**, and businesses that make space for it will reap the benefits of a more trusted and efficient digital marketplace.

## Frequently asked questions

### What is the EU Digital Identity (EUDI) Wallet?

It is an EU-backed digital wallet that lets individuals and organisations prove their identity, store and share trusted credentials, and digitally sign documents under user control. By 2026 every EU Member State must offer at least one wallet built to common European standards.

### Which business use cases does the EUDI Wallet support?

The guide describes six flagship use cases: Personal ID (PID) issuance, Legal Person ID (LPID) issuance, qualified electronic signatures, Portable Document A1 (PDA1) issuance, a digital driving licence or photo ID based on ISO 18013-7 (mDL), and passwordless wallet-based login.

### What is eIDAS 2.0 and when does it take effect?

eIDAS 2.0 is the amended EU regulation on electronic identification, adopted in 2024 and in force since May 2024. It requires each EU Member State to offer at least one interoperable wallet by 2026, free of charge to citizens, residents and businesses.

### What credential formats does the wallet use?

It uses Selective Disclosure JWT (SD-JWT) so users can share only the attributes they consent to, and ISO/IEC 18013-7 mobile documents (mdoc/mDL) for official IDs. The wallet also aligns with the W3C Verifiable Credentials data model and OpenID-based protocols.

## References

[1] European Digital Identity Framework / eIDAS 2.0. [Online]. Available:[ https://docs.igrant.io/regulations/reg-eu-digital-id-framework/](https://ec.europa.eu/digital-building-blocks/sites/display/EUDIGITALIDENTITYWALLET/EU+Digital+Identity+Wallet+Home) [Accessed: 12-Apr-2025].

[2]	European Digital Identity Wallet Architecture and Reference Framework (ARF). [Online]. Available:[ https://eudi.dev/latest/architecture-and-reference-framework-main/](https://eudi.dev/latest/architecture-and-reference-framework-main/) [Accessed: 12-Apr-2025].


[3]	IETF SD-JWT-based Verifiable Credentials (SD-JWT VC), Internet-Draft draft-ietf-oauth-sd-jwt-vc-08. [Online]. Available:[ https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-08.html](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-08.html) [Accessed: 12-Apr-2025].


[4]	International Organization for Standardization. ISO/IEC 18013-7:2023 - Personal identification - ISO-compliant driving license - Part 7: Mobile driving license (mDL) application. [Online]. Available:[ https://www.iso.org/standard/82772.html](https://www.iso.org/standard/82772.html) [Accessed: 12-Apr-2025].

[5]	EUDI Wallet Implementing Regulations [Online]. Available:[ https://docs.igrant.io/regulations/implementing-acts-integrity-and-core-functions/](https://ec.europa.eu/digital-building-blocks/sites/display/EUDIGITALIDENTITYWALLET/EU+Digital+Identity+Wallet+Home) [Accessed: 12-Apr-2025].


---

# Understanding Digital Credential Query Language (DCQL) in the EUDI Wallet Ecosystem
Source: https://docs.igrant.io/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/

---
id: eudi-wallet-dcql-openid4vp-business-wallet-payments
title: Understanding Digital Credential Query Language (DCQL) in the EUDI Wallet Ecosystem
description: Learn how the Digital Credentials Query Language (DCQL), introduced in OpenID4VP v1.0, enables precise, privacy-preserving credential sharing in EUDI Wallets, with a case study from the EWC Large Scale Pilot on merchant-led business wallet payments.
hide_title: true
sidebar_label: DCQL in the EUDI Wallets
keywords: [DCQL, Digital Credential Query Language, OpenID4VP, EUDI Wallet, European Business Wallet, credential query, payments, EWC, privacy]
slug: /eudi-wallet-dcql-openid4vp-business-wallet-payments/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import VideoPlayer from '@site/src/components/VideoPlayer';

<head>
  <title>Understanding Digital Credentials Query Language (DCQL) in the EUDI Wallet Ecosystem | iGrant.io DevDocs</title>
  <meta name="description" content="Learn how OpenID4VC standards enable secure issuance and presentation of verifiable credentials in digital identity ecosystems." />
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/eudi-wallets-with-dcql.webp" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/eudi-wallets-with-dcql.webp" />
</head>

*Originally published together with European Wallet Consortium (EWC) partners and is available as pdf [here](https://igrant.io/papers/eudi-wallets-business-wallets-with-dcql-v2.0.pdf).*

# Understanding Digital Credential Query Language (DCQL) in the EUDI Wallet Ecosystem - Unlocking seamless credential sharing for verifiers and relying parties using OpenID4VP

**Abstract:** The European Digital Identity (EUDI) Wallet ecosystem is transforming how identities and credentials are managed and verified across Europe. Central to this transformation is the Digital Credential Query Language (DCQL), a JSON-based language designed to standardise and streamline the querying of verifiable credentials. This article explores the role of DCQL in enhancing interoperability, privacy, and security within the EUDI Wallet framework. The admin of a Relying Party (RP) can construct queries based on one or more query objects, offering rich control over how credentials are selected and combined during a presentation request. By enabling verifiers to specify precise requirements for credential attributes, DCQL ensures that users share only the data they need to, thereby preserving privacy while facilitating efficient and secure transactions. Through real-world use cases, such as those from the Bank of Transilvania and Fast Ferries, the article demonstrates how DCQL simplifies the credential verification process, improving user experience and operational efficiency. As a key component of the EUDI Wallet ecosystem, DCQL is poised to become a critical enabler of cross-border, secure, and privacy-respecting digital identity management in Europe.

**Target Audience: **Professionals and stakeholders in the world of verifiable credentials and EUDI Wallets who are keen to develop and use solutions based on DCQL, with  real-world examples from payments

**Editors:** George Padayatti (iGrant.io, Sweden), Lal Chandran (iGrant.io, Sweden), Nikolaos Triantafyllou (University of Aegean, Greece)

## 1.0	Introduction

Digital Credential Query Language (DCQL, pronounced *“dak-l”*) is a core capability of the OpenID4VP (Verifiable Presentations) 1.0 specification. It provides a standardised, flexible, and privacy-preserving way to request verifiable credentials in digital identity systems. In the EUDI Wallet ecosystem, DCQL enables verifiers, such as businesses, government agencies, and service providers, to request only the precise information they need. This minimises data disclosure, improves security, and creates a consistent user experience across different use cases.

A key advantage is that the administrator of a Relying Party (RP) can build complex queries using one or more query objects, controlling how credentials are selected, combined, and presented. This is particularly valuable in regulated sectors like finance, healthcare, and transport, where proof of specific attributes must be provided without revealing unnecessary personal data.

This paper introduces DCQL, explains its key features, provides example scenarios, and demonstrates its application in real-world pilots such as payments and transport. It also highlights how DCQL benefits both individual and business wallet holders, ensuring interoperability and compliance across Europe.

### 1.1 Overview of Digital Credential Query Language (DCQL)

DCQL is a JSON-based query language used to specify the requirements for digital credentials that a verifier seeks from a wallet holder. A verifier (e.g., a service provider, government entity, or business) can send a DCQL query to the wallet holder to request specific claims or attributes within a credential, without requiring the wallet holder to share unnecessary data.

Unlike previous methods for presenting credentials (such as Presentation Exchange) [2], DCQL simplifies the query process, providing a standardised way to request and retrieve the exact data needed from a user’s digital wallet. It empowers the verifier to articulate the requirements of a given transaction clearly, and for the wallet to automatically present only the relevant information.

Key features of DCQL include:
* Simplified querying power: Instead of using complex filters or custom queries, DCQL enables the verifier to define the credential attributes needed clearly.
* Privacy preserving: Only the required data is shared, respecting the wallet holder’s privacy preferences.
* Interoperability: DCQL ensures that different wallets and service providers can interact with each other, as it is a standards-based solution within the OpenID4VP framework.

### 1.2	Business value and context

As the EUDI Wallet ecosystem expands across Europe, businesses will need to securely interact with **digital credentials** issued by governments, organisations, and other trusted parties. DCQL plays a critical role in this ecosystem by enabling businesses and service providers to efficiently **query and verify** credentials in a way that is both secure and privacy-respecting.

The business value of DCQL can be seen in several areas:

* **Seamless user experience:** DCQL streamlines the user experience by automating and standardising credential verification requests, reducing friction for both individuals and businesses.
* **Privacy control and data minimisation:** It enables individuals to share only the data required by a verifier, which is crucial for maintaining user trust and complying with privacy regulations such as the **GDPR**. From the Relying Party's perspective, this provides a tool for data minimisation, giving them the option to request only the data that is required.
* **Operational efficiency:** DCQL allows businesses to automate credential validation processes, saving time and resources by eliminating manual verification steps.
* **Cross-Border interoperability:** As part of the broader **EUDI Wallet** initiative, DCQL ensures that verifiers across different EU countries can request and accept credentials with confidence, enabling the smooth operation of cross-border services.

### 1.3	Glossary

To ensure clarity and understanding, here are some key terms used in this article:

* **DCQL (Digital Credential Query Language):** A JSON-based language used for querying and retrieving verifiable credentials in the **EUDI Wallet** ecosystem.
* **OpenID4VP (Verifiable Presentations):** A protocol that enables the sharing of verifiable credentials in a secure, privacy-preserving way.
* **Verifiable Credential:** A digital statement made by an issuer (e.g., a government or bank) that is cryptographically verifiable, such as an ID, diploma, or proof of payment.
* **Claim:** A statement made about an individual or entity, such as "age > 18" or "member of X organisation."
* **Credential Set:** A logical grouping of credential combinations (AND/OR), allowing the verifier to define acceptable combinations of credentials. 
* **Claim Set:** A grouping of specific claims from within credentials, allowing a verifier to define combinations of claims for the credentials that are requested. It enables selective disclosure by defining which claims, and in what combinations, the verifier prefers.
* **Verifier:** The party requesting or validating the credentials, such as a bank, employer, or service provider.
* **Wallet Holder:** The individual or entity who owns and controls a digital wallet containing verifiable credentials.
* **WU (Wallet Unit):** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;

## 2.0	Features of DCQL

The Digital Credentials Query Language (DCQL) is a JSON-encoded query language that enables a Verifier to request Verifiable Presentations from a Holder's Wallet (Wallet Unit). It allows the Verifier to specify detailed requirements for the credentials it needs, including constraints on how different credentials and their constituent claims can be combined. The Wallet evaluates the DCQL query against the credentials it manages and returns only the presentations that match the request.

A valid DCQL query is a JSON object with two primary top-level properties: credentials, which is a required array of individual credential requests, and **<code>credential_sets</code>**. This optional array defines logical groupings and requirements across the requested credentials.<sup> </sup>This structure provides a robust framework for moving beyond simple credential requests to expressing complex, real-world data requirements in a standardised, machine-readable format.

### 2.1 The Credential Query

The fundamental building block of DCQL is the Credential Query object. Each object in the top-level credentials array represents a Credential Query, which is a request for the presentation of one or more credentials that match the specified criteria.<sup> </sup>It contains all the necessary parameters to describe the desired credential, including its format, issuer, and specific claims.

<table>
  <tr>
   <td><strong>Field Name</strong>
   </td>
   <td><strong>Requirement</strong>
   </td>
   <td><strong>Description</strong>
   </td>
  </tr>
  <tr>
   <td><strong><code>id</code></strong>
   </td>
   <td>REQUIRED
   </td>
   <td>A unique string identifier for the query. This ID is used to reference the credential in the response and <strong><code>credential_sets</code></strong> definitions. The ID can contain only letters, numbers, hyphens (-) and underscores (_). Do not use spaces.
   </td>
  </tr>
  <tr>
   <td><strong><code>format</code></strong>
   </td>
   <td>REQUIRED
   </td>
   <td>A string specifying the required format of the credential (e.g., <strong><code>mso_mdoc</code></strong>, <strong><code>dc+sd-jwt</code></strong>). Valid identifiers are defined in the specification's appendix.
   </td>
  </tr>
  <tr>
   <td><strong><code>multiple</code></strong>
   </td>
   <td>OPTIONAL
   </td>
   <td>A boolean indicating if multiple credentials can be returned for this single query. Defaults to false.
   </td>
  </tr>
  <tr>
   <td><strong><code>meta</code></strong>
   </td>
   <td>REQUIRED
   </td>
   <td>An object for defining format-specific constraints on the credential's metadata and validity data. An empty object means no specific constraints are applied.
   </td>
  </tr>
  <tr>
   <td><strong><code>trusted_authorities</code></strong>
   </td>
   <td>OPTIONAL
   </td>
   <td>An array of objects specifying trusted issuers or trust frameworks. This helps the Wallet filter credentials from accepted authorities, enhancing privacy by preventing the disclosure of credentials that would likely be rejected.
   </td>
  </tr>
  <tr>
   <td><strong><code>require_cryptographic_holder_binding</code></strong>
   </td>
   <td>OPTIONAL
   </td>
   <td>A boolean indicating if the Verifier requires proof of cryptographic holder binding. Defaults to true.
   </td>
  </tr>
  <tr>
   <td><strong><code>claims</code></strong>
   </td>
   <td>OPTIONAL
   </td>
   <td>An array of Claim Query objects that specify the individual data claims requested from within the credential.
   </td>
  </tr>
  <tr>
   <td><strong><code>claim_sets</code></strong>
   </td>
   <td>OPTIONAL
   </td>
   <td>An array that specifies acceptable combinations of the claims defined in the claims array, allowing for alternatives.
   </td>
  </tr>
</table>

*Table 1: Credential Query Object Fields*

The **<code>trusted_authorities</code>** field provides a crucial mechanism for Verifiers to signal trust requirements upfront. Rather than receiving a credential and then checking its issuer against a trust list, the Verifier can guide the Wallet to select only those credentials certified by a recognised authority. This is achieved by specifying a type and a set of values for that type.


<table>
  <tr>
   <td><strong>Type Identifier</strong>
   </td>
   <td><strong>Description</strong>
   </td>
  </tr>
  <tr>
   <td><strong><code>aki</code></strong>
   </td>
   <td>Matches the Authority Key Identifier from an X.509 certificate in the credential's trust chain.
   </td>
  </tr>
  <tr>
   <td><strong><code>etsi_tl</code></strong>
   </td>
   <td>Matches an ETSI Trusted List that the credential's issuer is a member of.
   </td>
  </tr>
  <tr>
   <td><strong><code>openid_federation</code></strong>
   </td>
   <td>Matches the Entity Identifier of a trust anchor in an OpenID Federation that the issuer is part of.
   </td>
  </tr>
</table>

*Table 2: trusted_authorities Query Types*

### 2.2 Credential Set

While the credentials array defines the universe of credentials the Verifier is interested in, the optional top-level **<code>credential_sets</code>** array allows the Verifier to express logical rules about how those credentials should be combined to satisfy a use case.<sup>1</sup> This moves DCQL from a simple "shopping list" to a language capable of expressing complex business logic, such as "provide proof of identity AND (a utility bill OR a bank statement)."

A Credential Set Query is an object within the **<code>credential_sets</code>** array that defines one such logical requirement.

<table>
  <tr>
   <td><strong>Field Name</strong>
   </td>
   <td><strong>Requirement</strong>
   </td>
   <td><strong>Description</strong>
   </td>
  </tr>
  <tr>
   <td><strong><code>options</code></strong>
   </td>
   <td>REQUIRED
   </td>
   <td>A non-empty array where each element is a list of Credential Query IDs. Each list represents one valid combination of credentials that satisfies the set's requirement.
   </td>
  </tr>
  <tr>
   <td><strong><code>required</code></strong>
   </td>
   <td>OPTIONAL
   </td>
   <td>A boolean indicating if this credential set is mandatory. Defaults to true.
   </td>
  </tr>
</table>

*Table 3: Credential Set Query Object Fields*

The selection logic is straightforward but powerful. To fulfil the overall request, the Wallet MUST satisfy every Credential Set Query where required is true (or omitted). To satisfy a single Credential Set Query, the Wallet must be able to provide a set of credentials that matches at least one of the combinations listed in the options array. This enables Verifiers to define both mandatory requirements and acceptable alternatives in a single, structured query.

### 2.3 Claims Query

A "Claims Query" in DCQL refers to the specific data points, or claims, that a Verifier requests from within a particular credential. This is defined within a Credential Query object using the optional claims and claim sets properties. This mechanism is the engine of selective disclosure, allowing a Verifier to ask for just the information it needs, rather than the entire credential.

The **<code>claims</code>** property is an array of Claim Query objects, each pointing to a specific piece of data.

<table>
  <tr>
   <td><strong>Field Name</strong>
   </td>
   <td><strong>Requirement</strong>
   </td>
   <td><strong>Description</strong>
   </td>
  </tr>
  <tr>
   <td><strong><code>id</code></strong>
   </td>
   <td>REQUIRED (if claim_sets is used)
   </td>
   <td>A unique string identifier for the claim, used for referencing it in the claim_sets array.
   </td>
  </tr>
  <tr>
   <td><strong><code>path</code></strong>
   </td>
   <td>REQUIRED
   </td>
   <td>A non-empty array representing a path to the claim within the credential's data structure.
   </td>
  </tr>
  <tr>
   <td><strong><code>values</code></strong>
   </td>
   <td>OPTIONAL
   </td>
   <td>An array of acceptable values for the claim. If present, the Wallet should only return the claim if its value is an exact match for one of the listed values.
   </td>
  </tr>
</table>

*Table 4: Claim Query Object Fields*

In addition to the claims query, the verifier can also specify **<code>claim_sets</code>** property which enables the Verifier to express preferences and alternatives for the requested claims. It contains an array of arrays, where each inner array is a list of IDs from the claims array.

The logic for selecting claims is as follows:

* If **<code>claims</code>** are absent, the Verifier is not requesting any selectively disclosable claims.
* If **<code>claims</code>** are present but **<code>claim_sets</code>** is absent, the Verifier is requesting all claims listed in the claims array.
* If both **<code>claims</code>** and **<code>claim_sets</code>** are present, the Verifier is requesting one combination of claims from the **<code>claim_sets</code>** array. The order of the combinations expresses the Verifier's preference, from most preferred (first) to least preferred (last). The Wallet SHOULD return the first option it can satisfy.

This layered approach is fundamental to privacy preservation. A Verifier can ask for proof of age by creating a **<code>claim_sets</code>** array that prioritises a simple **<code>age_over_21</code>** boolean claim over the more sensitive **<code>birth_date</code>** claim. The Wallet, following this preference, will provide the minimum information necessary to satisfy the request, empowering users and minimising data exposure.

### 2.4 Example scenarios

The following example scenarios demonstrate how DCQL is used to construct queries for different real-world scenarios.

#### 2.4.1 Use case: Basic Credential Query with trusted authority

This query requests a single credential, a University Degree. It specifies that its issuer must be part of a known trusted authority, such as the EU Trust List, European Blockchain Service Infrastructure (EBSI), the OpenID Federation instance or similar, ensuring its authenticity.

![Fig 01: Require a University Degree credential, only if issued by an authority listed in the trusted list.](dcql-images/fig-01-dcql-eudi-wallet-university-degree-trusted-authority.png)

*Figure 01: Require a University Degree credential, only if issued by an authority listed in the EU Trust List or an OpenID Federation or a ledger (Mandatory) etc.*

The query contains a single Credential Query object. The **<code>trusted_authorities</code>** field is used to filter for credentials issued by an entity within the specified federation.


```
{
  "credentials": [
    {
      "id": "university_degree_credential",
      "format": "dc+sd-jwt",
      "multiple": false,
      "meta": {
        "vct_values": [
          "https://credentials.example.com/identity_credential"
        ]
      },
      "trusted_authorities": [
        {
          "type": "etsi_tl",
          "values": [
            "https://raw.githubusercontent.com/EWC-consortium/ewc-trust-list/refs/heads/main/EWC-TL.xml"
          ]
        }
      ]
    }
  ]
}
```

This video demonstrates how **EUDI Wallets** and **OpenID4VP** work with the **Digital Credential Query Language (DCQL)** to enable trusted, privacy-preserving data exchange between holders and relying parties.  

<VideoPlayer
  videoId="d2MOt01HKx4"
  title="EUDI Wallet and OpenID4VP | Digital Credential Query Language (DCQL) Scenario #1"
  description="See how the EUDI Wallet and OpenID4VP use the Digital Credential Query Language (DCQL) for a Basic Credential Query with a Trusted Authority, powered by iGrant.io Organisation Wallet Suite."
  uploadDate="2025-10-14"
  duration="PT3M"
/>

#### 2.4.2 Use case: Claim Set for age verification (Selective Disclosure)

This query asks for proof of age from a single credential, expressing a preference for a simple boolean claim over a full birthdate.

![Fig 02: Verify age with minimal disclosure (Mandatory), for example by sharing an age-over-18 claim instead of a full date of birth.](dcql-images/fig-02-dcql-eudi-wallet-age-verification-minimal-disclosure.png)
*Figure 02: Verify age with minimal disclosure (Mandatory), for example by sharing an “Over 21” boolean or the full birthdate*

Annotation: The claims array defines two possible claims: **<code>over_21</code>** and birthdate. The **<code>claim_sets</code>** array lists ["**<code>over_21</code>**"] as the first, most-preferred option, and ["**<code>birthdate</code>**"] as the second, less-preferred alternative. This guides the wallet to disclose the least amount of information possible.


```
{
  "credentials": [
    {
      "id": "pid",
      "format": "dc+sd-jwt",
      "meta": {
        "vct_values": [
          "eu.europa.ec.eudi:pid.1"
        ]
      },
      "claims": [
        {
          "id": "over_21",
          "path": [
            "is_over_21"
          ]
        },
        {
          "id": "birthdate",
          "path": [
            "birth_date"
          ]
        }
      ],
      "claim_sets": [
        [
          "over_21"
        ],
        [
          "birthdate"
        ]
      ]
    }
  ]
}
```

#### 2.4.3 Use case: Request and share alternative identities

This query asks the user to provide one form of identification, accepting a Passport, a Photo ID, or a PID.

![Fig 03: Accept any one identity document (Mandatory) – Passport, PhotoID or a PID.](dcql-images/fig-03-dcql-eudi-wallet-identity-document-options.png)
*Figure 03: Accept any one identity document (Mandatory), Passport, PhotoID or a PID to confirm identity*

Annotation: Three distinct Credential Query objects are defined. The top-level **<code>credential_sets</code>** object contains a single requirement with three options. Each option is a list containing a single credential id. This tells the wallet that providing any one of these three credentials will satisfy the request.

```
{
  "credentials": [
    {
      "format": "dc+sd-jwt",
      "id": "Passport",
      "meta": {
        "vct_values": [
          "Passport"
        ]
      },
      "require_cryptographic_holder_binding": true
    },
    {
      "format": "dc+sd-jwt",
      "id": "PID",
      "meta": {
        "vct_values": [
          "urn:eu.europa.ec.eudi:pid:1"
        ]
      },
      "require_cryptographic_holder_binding": true
    },
    {
      "format": "dc+sd-jwt",
      "id": "Photo-ID",
      "meta": {
        "vct_values": [
          "eu.europa.ec.eudi.photoid.1"
        ]
      },
      "require_cryptographic_holder_binding": true
    }
  ],
  "credential_sets": [
    {
      "options": [
        [
          "PID"
        ],
        [
          "Passport"
        ],
        [
          "Photo-ID"
        ]
      ],
      "required": true
    }
  ]
}
```

This video below demonstrates how **EUDI Wallets** and **OpenID4VP** work with the **Digital Credential Query Language (DCQL)** to request and share alternative identities between holders and relying parties. Here, the Relying Party requests any of the three alternative identity types (Passport, PhotoID or PID). The wallet shows only the matching credential, which the individual selects and shares securely, powered by the iGrant.io Data Wallet and Organisation Wallet Suite.

<VideoPlayer
  videoId="K0WuGRXAubE"
  title="EUDI Wallet and OpenID4VP | Digital Credential Query Language (DCQL) Scenario #3: Request and share alternative IDs"
  description="See how the EUDI Wallet and OpenID4VP use the Digital Credential Query Language (DCQL) to request and share alternative identities between holders and relying parties, powered by iGrant.io Organisation Wallet Suite."
  uploadDate="2025-11-06"
  duration="PT3M"
/>

#### 2.4.4 Use case: KYC request with Photo ID and address proof

This query illustrates a comprehensive Know Your Customer (KYC) verification process, which requires a photo ID for name verification and a separate proof of address. For this, either a utility bill or a bank statement is acceptable. 

![Fig 04: Require a Photo ID (Mandatory) plus proof of address via Utility Bill or Bank Statement.](dcql-images/fig-04-dcql-eudi-wallet-photo-id-proof-of-address.png)
*Figure 04: Require a Photo ID (Mandatory) plus proof of address via Utility Bill or Bank Statement (Mandatory)*

Annotation: This query combines multiple concepts. It defines three credentials. The **<code>credential_sets</code>** array has two required sets. The first set has one option: ["**<code>photo_id</code>**"], making it mandatory. The second set has two options: ["**<code>utility_bill</code>**"] or ["**<code>bank_statement</code>**"], allowing the user to provide either one to prove their address. \

```
{
  "credentials": [
    {
      "id": "photo_id",
      "format": "mso_mdoc",
      "claims": [
        {
          "path": [
            "family_name"
          ]
        }
      ]
    },
    {
      "id": "utility_bill",
      "format": "dc+sd-jwt",
      "claims": [
        {
          "path": [
            "address"
          ]
        }
      ]
    },
    {
      "id": "bank_statement",
      "format": "dc+sd-jwt",
      "claims": [
        {
          "path": [
            "address"
          ]
        }
      ]
    }
  ],
  "credential_sets": [
    {
      "options": [
        "photo_id"
      ],
      "required": true
    },
    {
      "options": [
        [
          "utility_bill"
        ],
        [
          "bank_statement"
        ]
      ],
      "required": true
    }
  ]
}
```

#### 2.4.5 Use case: Student transport pass with mandatory and optional credentials

This example demonstrates the full expressive power of DCQL by combining mandatory and optional credential sets with selective claim disclosure in a single, cohesive query.

Scenario: A city's public transport authority offers a discounted travel pass to students. To apply, a student must:

1. Prove their identity: This is a mandatory requirement. The authority needs their full name and date of birth.
2. Prove their student status: This is also mandatory. The authority will accept either a digital Student ID Card or an official Enrolment Letter. From this credential, they need to verify the university's name and confirm the student's enrolment status is "active".
3. Prove local residency (optional): Students who are also local residents may be eligible for an additional discount. This is an optional requirement. The authority will accept either a Utility Bill or a Rental Agreement as proof of address.

![Fig 05: Require a PID and proof of being a student via Student ID or Enrolment Letter, with optional address proof.](dcql-images/fig-05-dcql-eudi-wallet-student-proof-optional-address.png)
*Figure 05: Require a PID and a proof of being a student via Student ID or Enrolment Letter (Mandatory). Also, proof of local address via Utility Bill or Bank Statement for additional discount (Optional)*

DCQL Implementation: This scenario is translated into a DCQL query that defines five potential credentials and three credential sets to enforce the business logic.

* Credential Queries: Five Credential Query objects are defined in the credentials array: one for a national ID, one for a student ID, one for an enrolment letter, one for a utility bill, and one for a rental agreement.
* Claim Sets: Within each credential query, claims and claim_sets are used to specify exactly which data points are needed, such as **<code>full_name</code>** and **<code>date_of_birth</code>** from the national ID, or address from the proof of residency documents. This ensures minimal data disclosure.
* Credential Sets: Three Credential Set Query objects are defined in the **<code>credential_sets</code>** array:
    1. A mandatory set requiring the pid.
    2. A mandatory set requiring either the student ID card or the enrolment letter.
    3. An optional (required: false) set allowing the user to provide either a **<code>utility_bill_doc</code>** OR a **<code>rental_agreement_doc</code>**.

This structure provides an explicit, machine-readable request that gives the user flexibility while ensuring the transport authority receives all necessary information in a privacy-preserving manner.


```
{
  "credentials": [
    {
      "id": "pid",
      "format": "mso_mdoc",
      "meta": {
        "doctype_value": "urn:eu.europa.ec.eudi:pid:1"
      },
      "claims": [
        {
          "id": "full_name",
          "path": [
            "full_name"
          ]
        },
        {
          "id": "dob",
          "path": [
            "date_of_birth"
          ]
        }
      ],
      "claim_sets": [
        [
          "full_name"
        ],
        [
          "dob"
        ]
      ]
    },
    {
      "id": "student_id_card",
      "format": "dc+sd-jwt",
      "meta": {
        "vct_values": [
          "student_id"
        ]
      },
      "claims": [
        {
          "id": "student_id",
          "path": [
            "student_id"
          ]
        },
        {
          "id": "university_name",
          "path": [
            "university_name"
          ]
        }
      ],
      "claim_sets": [
        [
          "university_name",
          "student_id"
        ]
      ]
    },
    {
      "id": "enrolment_letter",
      "format": "dc+sd-jwt",
      "meta": {
        "vct_values": [
          "employment_letter"
        ]
      },
      "claims": [
        {
          "id": "status",
          "path": [
            "status"
          ]
        },
        {
          "id": "university_name",
          "path": [
            "university_name"
          ]
        }
      ],
      "claim_sets": [
        [
          "university_name",
          "status"
        ]
      ]
    },
    {
      "id": "utility_bill_doc",
      "format": "dc+sd-jwt",
      "meta": {
        "vct_values": [
          "utility_bill_doc"
        ]
      },
      "claims": [
        {
          "id": "address",
          "path": [
            "address"
          ]
        }
      ]
    },
    {
      "id": "rental_agreement_doc",
      "format": "dc+sd-jwt",
      "meta": {
        "vct_values": [
          "rental_agreement_doc"
        ]
      },
      "claims": [
        {
          "id": "address",
          "path": [
            "address"
          ]
        }
      ]
    }
  ],
  "credential_sets": [
    {
      "options": [
        "pid"
      ],
      "required": true
    },
    {
      "options": [
        [
          "student_id_card"
        ],
        [
          "enrolment_letter"
        ]
      ],
      "required": true
    },
    {
      "options": [
        [
          "utility_bill_doc"
        ],
        [
          "rental_agreement_doc"
        ]
      ],
      "required": false
    }
  ]
}
```

#### 2.4.6 Use case: Loan application with multiple recent bank statements

This example demonstrates how a loan provider (Relying Party/ Verifier) can request multiple instances of a single credential type.

Scenario: The Loan provider is assessing a loan application. As part of affordability and risk checks, the applicant must share the last 6 months of bank statements.

![Fig 06: Require six recent Bank Statements (Mandatory) to assess affordability as part of a loan application.](dcql-images/fig-06-dcql-eudi-wallet-multiple-bank-statements-loan.png)
*Figure 06: Require six recent Bank Statements (Mandatory) to assess affordability as part of a loan application*

The request allows multiple credentials of the same type (bank_statement) to be returned in a single query. This is achieved by setting **<code>"multiple": true</code>**. The format is **<code>dc+sd-jwt</code>**, and the **<code>meta.vct_values</code>** filter ensures only credentials explicitly identified as **<code>bank_statement</code>** are considered.

The **<code>multiple</code>** field enables the Wallet to provide more than one matching credential in response to a single credential query. This is particularly useful in scenarios like this, where each month’s statement is a separate credential issued by the same authority. The Verifier receives all 6 statements in one presentation, maintaining both efficiency and the structured verification flow.


```
{
  "credentials": [
    {
      "id": "bank_statement",
      "format": "dc+sd-jwt",
      "multiple": true,
      "meta": {
        "vct_values": [
          "https://credentials.bank.com/bank_statement"
        ]
      },
      "claims": [
        {
          "id": "statement_period",
          "path": [
            "period"
          ]
        },
        {
          "id": "account_number",
          "path": [
            "account_number"
          ]
        },
        {
          "id": "account_holder_name",
          "path": [
            "account_holder_name"
          ]
        }
      ],
      "claim_sets": [
        [
          "statement_period",
          "account_number",
          "account_holder_name"
        ]
      ]
    }
  ]
}
```

#### 2.4.7 Use case: Delivery service restricted to specific postal codes

This example demonstrates how a delivery service (Relying Party / Verifier) can request an address credential but only accept it if the postal code matches one of a predefined list of allowed areas.

Scenario: A grocery delivery company offers same-day delivery only to customers in certain postal code areas. When a customer signs up, the company must verify their address and confirm the postal code is in the allowed list before activating their account.

![Fig 07: Require a PID and an address credential with a postal code matching 43242 or 43243 for eligibility.](dcql-images/fig-07-dcql-eudi-wallet-address-postal-code-eligibility.png)
*Figure 07: Require a PID and an address credential with a postal code matching 43242 or 43243 for same-day delivery eligibility (Mandatory)*

The request targets an address credential (dc+sd-jwt format) and uses the **<code>values</code>** field to explicitly state the acceptable postal codes. This field contains an array of possible claim values, and the wallet must only return credentials where the claim’s value exactly matches one of the listed entries. This makes the eligibility check straightforward and ensures the verifier only receives relevant credentials.


```
{
  "credentials": [
    {
      "id": "residential_address",
      "format": "dc+sd-jwt",
      "meta": {
        "vct_values": [
          "https://credentials.gov.example/address_credential"
        ]
      },
      "claims": [
        {
          "id": "full_address",
          "path": ["street_address"]
        },
        {
          "id": "postal_code",
          "path": ["postal_code"],
          "values": ["43242", "234234"]
        },
        {
          "id": "city",
          "path": ["locality"]
        },
        {
          "id": "country",
          "path": ["country"]
        }
      ],
      "claim_sets": [
        [
          "full_address",
          "postal_code",
          "city",
          "country"
        ]
      ]
    }
  ]
}
```

## 3.0	EUDI Wallet - A unified experience for individuals and businesses

One of the primary objectives of the EUDI Wallet ecosystem is to provide a seamless and user-friendly experience for both natural persons (individuals) and businesses. For individuals, this means greater control and privacy when sharing only the necessary information. For businesses, it ensures streamlined verification workflows that are standards-based and interoperable. DCQL plays a central role in enabling this unified experience by providing a common, structured way for businesses to request and verify credentials consistently across a wide range of use cases, and for individuals to present credentials securely while preserving privacy.

### 3.1	Business Wallets - Powering flexible business requirements

Using DCQL, Business Wallet administrators can define precise and privacy-preserving credential requests by using one or more query objects. Although the specification only allows a flat list of query objects, this structure is highly versatile. It enables both OR and AND conditions through thoughtful configuration.

By including multiple query objects in a single request, a Business Wallet can offer alternative ways for the holder to fulfil the requirement. This effectively creates a logical OR. For example, it may accept any one of several valid credentials, such as different forms of address proof or registration documents.

To express a logical AND, where multiple credentials are required together, the administrator can include all necessary credential definitions within a single query object, grouped under the same `credential_sets`. This instructs the Wallet to present all listed credentials at once, simulating an AND condition.

<table>
  <tr>
   <td><strong>Business scenario</strong>
   </td>
   <td><strong>Credential combination example</strong>
   </td>
  </tr>
  <tr>
   <td>Accepting any one of several recognised identities
   </td>
   <td>The administrator can configure the request to accept any one of: PID, passport, driver's licence, or student ID. This provides flexibility for the holder to choose from several forms of recognised identity documents.
   </td>
  </tr>
  <tr>
   <td>Offering a choice of single credentials or a group of proofs
   </td>
   <td>The administrator can configure the query to accept any one of four individual credentials, or a combined proof of, for example, a VAT certificate and tax compliance document, enabling flexible options for the holder.
   </td>
  </tr>
  <tr>
   <td>Mixing single credentials and grouped combinations
   </td>
   <td>The administrator can set the configuration to accept one of the first two credentials (e.g., passport or driver's licence) or a combined set of three credentials from another category (e.g., proof of address + tax compliance + bank statement).
   </td>
  </tr>
  <tr>
   <td>Multiple instances of the same credential
   </td>
   <td>The administrator can allow the holder to choose one or more available instances of the same credential. For example, the holder can present multiple receipts for refunds from the employer, providing flexibility in proof of purchase or transaction.
   </td>
  </tr>
  <tr>
   <td>Request more data to provide additional services
   </td>
   <td>Administrators can configure optional data requests for additional services. For example, suppose the relying party offers extra services (e.g., discounts or loyalty benefits). In that case, they can request additional data from the holder, such as membership status or service preferences, allowing for more tailored user interactions.
   </td>
  </tr>
</table>

### 3.2	Natural Person Wallets - Enhancing user experience and control

For individuals, DCQL ensures that they share only the relevant credentials required for a specific interaction. Whether it’s verifying identity, age, membership, or other attributes, DCQL queries allow for clear and concise requests, enabling a smooth flow of information. 

One of the key advantages of DCQL is the flexibility it offers. Users can choose which credential(s) they wish to share, based on what is requested. For example, a service may request a Passport or a PhotoID as a form of identity verification, and the individual can choose which credential they are more comfortable sharing, as long as the requested attribute (e.g., identity, age) is included in both. This flexibility not only simplifies the process of data-sharing but also allows users to select the most appropriate credential to meet the requested requirements, enhancing both privacy and user autonomy.

Example use case scenarios for individuals are as follows:

<table>
  <tr>
   <td><strong>Scenario</strong>
   </td>
   <td><strong>Credential(s) presented</strong>
   </td>
  </tr>
  <tr>
   <td>Age verification for online purchases
   </td>
   <td>The user may share proof of age, without disclosing full birthdate or other personal details.
   </td>
  </tr>
  <tr>
   <td>Flexible identity verification
   </td>
   <td>The user can select a passport, photo ID, or driver's licence, depending on preference and availability.
   </td>
  </tr>
  <tr>
   <td>Accessing membership or discounts
   </td>
   <td>The user may share their membership validity or student status without revealing any other personal information.
   </td>
  </tr>
  <tr>
   <td>Decide to share optional data
   </td>
   <td>The user may share additional data for certain benefits with a clear lawful basis for use. 
   </td>
  </tr>
</table>

## 4.0	Case study from EWC LSP merchant-led payments

In this section, we examine how **DCQL** is utilised in real-world, **[merchant-led payment ](https://youtu.be/6GwCxyofSVE)systems** to enhance the customer experience while ensuring compliance with privacy and regulatory standards. 

### 4.1 Bank of Transilvania: Integrating EUDI Wallets with DCQL

The Bank of Transilvania, one of Romania’s leading banks, has integrated iGrant.io Business Wallet ([Organisation Wallet Suite](https://www.igrant.io/organisationwallet-for-eudi-wallet.html)) and demonstrated its integration in production, linking a user's bank account with their EUDI Wallet. This was the [first live demonstration of payments in production](https://www.igrant.io/news/press-releases/digital-id-gets-real-igrantio-powers-first-live-eudi-wallet-payment-in-production.html) with EUDI Wallets as part of the Payments Task Force efforts within the EU Digital Identity Wallet Consortium (EWC), in collaboration with UAegean, VISA, Worldline, Fast Ferries, BPC, and iGrant.io.

During the EWC pilots, the DIF Presentation Exchange [2] was used to facilitate credential exchanges, where the bank would request specific credentials, such as proof of identity through a passport, PID, PhotoID, or Driver's License, before linking the bank account. While this approach worked, there is room for improvement by shifting to DCQL, which enhances both user experience, privacy and efficiency in the verification and linking process.

Use of DCQL enables the Bank of Transilvania to provide alternative requests. For example, a Passport or Photo ID is used to verify the individual's identity before issuing the Payment Authenticator. The bank’s Business Wallet sends a DCQL query specifying that it requires proof of identity and income with specific attributes (e.g., personal number). The user’s EUDI Wallet presents only the personal number from among the available credentials. This is similar to the case example in Chapter [2.4.3 Use case: Credential Set for proof of identity (Alternatives)](#243-use-case-credential-set-for-proof-of-identity-alternatives).

### 4.2 Fast Ferries: Integrating EUDI Wallets with DCQL

Cyclades Fast Ferries, a dynamic Greek passenger ferry operator, integrated the EUDI Wallet into its online checkout to enable identity‑validated, card-based payments and student discounts. This cross-border, [merchant-led pilot](https://youtu.be/6GwCxyofSVE) was carried out within the EU Digital Identity Wallet Consortium (EWC) together with UAegean, Banca Transilvania (BTRL), Visa, Worldline, BPC and iGrant.io, and marked one of the first live demonstrations of using the EUDI Wallet in a real e-commerce flow.

Earlier EWC payment pilots relied on the DIF Presentation Exchange [2] to handle credential requests. In that setup, the merchant (and PSP) typically asks the user to present whole documents, e.g., a Passport/PID for identity, a student card for the discount, plus a loyalty credential. Although this worked, moving to DCQL streamlines the flow: verifiers can declare exactly which attributes they need, express alternatives, and thereby deliver a smoother experience with stronger privacy and greater operational efficiency.

With DCQL, Fast Ferries crafted minimal, choice-aware queries. To grant a student discount, it can accept either a Student ID or a European Student Card; it can optionally request a Loyalty Card credential; and combine these with the requirement for a payment authenticator, patterns that align with Chapters 2.4.3 (Alternatives) and 2.4.4 (Complex sets). The query can also mandate cryptographic holder binding and restrict issuers via trusted_authorities, ensuring only trusted sources qualify. The result is that the user’s EUDI Wallet shares only the necessary claims (e.g., status = "active", university name, loyalty card number, payment token reference) instead of the entire credentials, achieving the same business goals with tighter privacy controls and a faster checkout.

### 4.3 Benefits of DCQL in merchant-led payment scenarios

#### 4.3.1  Benefits for the end-user

The transition to DCQL provides the end-user with several advantages, improving their overall experience and privacy during the account linking process:

**Clearer Transparent Communication:** With DCQL queries, users understand exactly what data is being requested, providing clarity and transparency throughout the process and leading to a more positive user experience.

**Faster Verification:** By using DCQL, only the relevant claims are requested, speeding up the verification process and reducing unnecessary steps. This leads to a quicker and smoother user experience, making it easier to onboard and link accounts quickly.

**Greater Control for Users:** DCQL queries enable users to share specific claims selectively. For example, a bank may request proof of age, and the user can easily approve just that claim, without exposing any unnecessary information from the entire document.

**Enhanced Privacy:** With DCQL, users only share the necessary data, such as proof of age or nationality, rather than submitting entire documents like passports or driver’s licenses. This ensures that the user's sensitive information is protected, maintaining privacy. There is also an opportunity to learn more about the usage purpose, etc., as per the GDPR and ISO 27560 by taking this approach. 

#### 4.3.2  Benefits for the bank

For the Bank of Transilvania, adopting DCQL results in significant operational and compliance benefits:

**Increased Efficiency:** DCQL enables the bank to request only the necessary claims, such as age or nationality, rather than processing full documents. This reduces the complexity of verifying identities and streamlines the entire account linking process, enhancing operational efficiency.

**Simplified data regulatory compliance:** By using DCQL, the bank ensures that only the required data is shared with it, making it easier to comply with GDPR and other privacy regulations. With this privacy-first approach, the bank minimises the exposure of sensitive data and reduces the risk of privacy breaches.

**Cost efficiency:** By querying specific claims instead of handling full credentials, the bank can reduce costs related to data storage, processing, and security. This approach leads to cost savings and reduces the administrative burden associated with handling large sets of sensitive data.

**Building user trust:** By requesting only the essential claims from the user, the bank demonstrates transparency and a commitment to user privacy, fostering trust with customers. This can lead to increased adoption rates and a positive brand reputation.

#### 4.3.3  Benefits for the merchant

For Cyclades Fast Ferries (and, more broadly, any merchant integrating the EUDI Wallet), adopting DCQL yields concrete UX, compliance, and cost advantages:

**Faster checkout, higher conversion:** By expressing exactly which attributes are needed (e.g., status = "active" for a student discount) and supporting alternatives (Student ID or enrolment letter), DCQL minimises friction and abandonment at payment time.

**Privacy-by-design:** Selective disclosure means the merchant never sees (or stores) full documents when they’re not needed. A smaller PII footprint directly reduces GDPR exposure, breach impact, and the burden of data governance (retention, access control, deletion workflows).

**Flexible business logic**: Through credential_sets and claim_sets, the merchant can model rich eligibility rules (mandatory vs. optional credentials, acceptable alternatives, preferred claim combinations) as data, not bespoke code. This shortens change cycles (e.g., adding another accepted student credential) and simplifies A/B testing of business rules.

**Trust signalling and automated filtering:** Using trusted_authorities, the merchant can pre-filter acceptable issuers and schemes, reducing manual review and fraud risk while keeping the user journey smooth (the wallet hides ineligible credentials before the user even tries). Additionally, this can enable the merchants to enforce specific policy rules (e.g. student discounts only to Greek university students).

**Better auditability & policy alignment:** Each DCQL query is a machine-readable, auditable artefact that can be mapped to the merchant’s privacy notices, purpose limitation statements, and discount policies, simplifying audits and demonstrating accountability (e.g., compliant to GDPR, ISO 27560 standards).

**Lower integration and maintenance costs:** Encoding verification logic declaratively in DCQL reduces custom integration code for the merchant. Over time, this lowers maintenance costs and accelerates the rollout of new credential-based products (e.g., age-gated services, special citizen categories discounts, etc).

In essence, DCQL lets merchants like Fast Ferries prove eligibility, apply discounts, and complete payments with minimal data, improving conversion and trust while shrinking compliance and operational burdens.

## 5.0	Conclusions

The introduction of **Digital Credential Query Language (DCQL)** represents a significant advancement in establishing a **secure, user-friendly, and interoperable digital identity ecosystem**. By enabling businesses and organisations to request only the necessary data from digital wallets, DCQL provides a unified querying approach across various industries, enabling seamless integration with merchant systems. By adopting DCQL, banks, merchants and service providers can leverage the power of query languages for credential requests, reduce friction in user interactions, and ensure compliance with privacy regulations. DCQL also ensures that privacy is preserved, while also facilitating the seamless exchange of credentials across borders and industries.

As the EUDI Wallet ecosystem grows, the role of **DCQL** will become even more critical in harmonising user experiences and simplifying credential verification. By adopting DCQL, businesses can **streamline processes**, **enhance user experiences**, and ensure compliance with **EU regulations**. As this language becomes the standard for querying credentials, the opportunities for innovation within the digital identity landscape will expand, driving a more **interoperable**, **secure**, and **privacy-conscious future** for all EU citizens and businesses.

## References

[1]	OpenID Foundation (2025) OpenID for Verifiable Presentations 1.0, Available at: [https://openid.net/specs/openid-4-verifiable-presentations-1_0.html](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html) (Accessed: 22-July-2024) 

[2]	Decentralised Identity Foundation (DIF) (2025) Presentation Exchange 2.0, Available at: [https://identity.foundation/presentation-exchange/](https://identity.foundation/presentation-exchange/) (Accessed: 22-July-2024)

[3]	iGrant.io (2025) Business Wallets – Enabling Trust and Scale in the European Digital Identity (EUDI) Wallet Ecosystem. [Online], Available at: [https://www.igrant.io/articles/business-wallets-enabling-trust-and-scale-in-the-european-digital-identity-eudi-wallet-ecosystem.html](https://www.igrant.io/articles/business-wallets-enabling-trust-and-scale-in-the-european-digital-identity-eudi-wallet-ecosystem.html) (Accessed: 8 August 2025).


---

# Verifiable Credential Formats in the EUDI Wallet - SD-JWT VC and ISO/IEC-mdoc
Source: https://docs.igrant.io/concepts/eudi-wallet-verifiable-credential-formats/

---
id: eudi-wallet-verifiable-credential-formats
title: Verifiable Credential Formats in the EUDI Wallet - SD-JWT VC and ISO/IEC-mdoc
hide_title: false
description: Explore the credential formats in the EUDI Wallet under the amended Implementing Acts, including IETF SD-JWT VC and ISO/IEC-mdoc (ISO 18013-5)
sidebar_label: Credential Formats in EUDI Wallets
keywords: [EUDI Wallet, SD-JWT VC, ISO/IEC-mdoc, ISO 18013-5, mDL, mDoc, OpenID4VC, HAIP, Verifiable Credentials, Digital Identity]
slug: /eudi-wallet-verifiable-credential-formats/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Verifiable Credential formats in the EUDI Wallet | iGrant.io DevDocs</title>
  <meta name="description" content="Explore the credential formats in the EUDI Wallet under the amended Implementing Acts, including IETF SD-JWT VC and ISO/IEC-mdoc (ISO 18013-5)"/>
</head>

The **European Union Digital Identity Wallet (EUDI Wallet)** is a transformative initiative to enable secure and interoperable digital identity solutions across EU Member States. At its core are **two recognised verifiable credential formats**, detailed in the **EU Digital Identity Wallet Implementing Acts** as amended in July 2026 by Commission Implementing Regulation (EU) 2026/1731 [3], that ensure security, interoperability and privacy.

:::info July 2026 update
Commission Implementing Regulation (EU) 2026/1731 amends the four core EUDI Wallet acts, namely (EU) 2024/2977, (EU) 2024/2979, (EU) 2024/2980 and (EU) 2024/2982, to align them with updated standards and specifications. The recognised credential formats are now **IETF SD-JWT VC** and **ISO/IEC-mdoc**. The W3C Verifiable Credentials Data Model remains on the roadmap and is expected to follow once the new W3C VCDM profiles become available.
:::

## Recognised Credential Formats

Article 4(1) of Implementing Regulation (EU) 2024/2977 [4], as amended, requires that electronic attestations of attributes issued to wallet units comply with at least one of the standards set out in Annex II of Implementing Regulation (EU) 2024/2979 [5]. That annex, as replaced by Regulation (EU) 2026/1731, applies the technical specifications in clauses 2 to 6 of **ETSI TS 119 472-1 V1.2.1 (2026-02)** [7]. The same annex governs person identification data: the PID annex states that natural person identification data shall be issued in accordance with clauses 5 (SD-JWT VC format) and 6 (ISO/IEC-mdoc format) [3]. The annex also defines the person identification data sets for both natural and legal persons.

The two recognised formats are:

1. **IETF SD-JWT VC (SD-JWT-based Verifiable Credentials):** A token-based credential format developed at the IETF [1]. It builds on the JSON Web Token family and adds **selective disclosure**, which allows the wallet user to reveal individual claims without revealing the whole credential. ETSI TS 119 472-1, clause 5 profiles this format for electronic attestations of attributes and person identification data in the EUDI Wallet.
2. **ISO/IEC-mdoc:** The mobile document format specified in **ISO/IEC 18013-5** [2], best known from the mobile driving licence (mDL). It defines secure and interoperable methods for representing traditional documents in a digital format, with strong support for in-person verification. ETSI TS 119 472-1, clause 6 profiles this format for the EUDI Wallet.

### W3C Verifiable Credentials: on the roadmap

The W3C Verifiable Credentials Data Model (VC DM) [11] is no longer referenced as a recognised format in the operative text of the amended acts. Recital 1 of Regulation (EU) 2026/1731 explains the direction of travel: as the W3C VCDM format is used as the reference format for attestations in sectors such as education, the European Digital Identity Wallets should also support this format once the new profiles on the W3C VCDM format are available [3].

## Protocols and Interfaces for Presentation

Article 5 of Implementing Regulation (EU) 2024/2982 [6] requires wallet solutions to support protocols and interfaces for presenting attributes to wallet-relying parties, remotely and, where appropriate, in proximity. The technical specifications are set out in the new Annex II, added by Regulation (EU) 2026/1731. The annex applies Annex C of **ISO/IEC 18013-7:2025** [9] together with clauses 4.1, 4.2, 5 and 6 of **ETSI TS 119 472-2 V1.2.1 (2026-03)** [8], which define two presentation profiles:

| Profile | Built on | Transmission mechanisms |
|---|---|---|
| **ISO/IEC-mdoc profile** | ISO/IEC 18013-5 [2] and Annex C of ISO/IEC 18013-7:2025 [9] | ISO/IEC 18013-5 for proximity (non-API mediated); ISO/IEC 18013-7 Annex C for API-mediated presentation |
| **OpenID4VC-HAIP profile** | OpenID4VC High Assurance Interoperability Profile (HAIP) [10] | Redirect-based remote presentation and API-mediated presentation |

In practice:

* **ISO/IEC 18013-5** defines the interface specifications for mdocs used in **in-person** scenarios. It enables credential data to be securely retrieved, authenticated and verified during face-to-face interactions, such as border checks or licence verification by law enforcement.
* **ISO/IEC 18013-7:2025, Annex C** extends mdoc presentation to **API-mediated** flows, in which a mediating API on the user's device (for example, a browser or operating system credential API) carries the request and response between the wallet and the relying party.
* **OpenID4VC-HAIP** profiles OpenID4VP (OpenID for Verifiable Presentations) for high-assurance use. It carries **remote, internet-based** presentation through redirects and also supports API-mediated flows, for both SD-JWT VC and mdoc credentials.

## Demonstrating Credential Issuance in various formats with iGrant.io

At **iGrant.io**, we bring these regulations and standards to life with the **iGrant.io Organisation Wallet Suite**. The issuance and verification functions in the Organisation Wallet Suite support all three formats, namely IETF SD-JWT VC, ISO/IEC-mdoc and W3C Verifiable Credentials, in OpenID4VC protocol flows. The salient features of the iGrant.io documentation include:

* **Credential Issuance and Verification**: Practical examples of workflows for issuing and verifying credentials.

* **YouTube Tutorials**: Step-by-step guides to assist developers and organisations in issuing credentials
  * [Using W3C Verifiable Credentials (JWT) - Credential issuance (InTime)](https://youtu.be/EiMh7YZu1IQ?si=yf6cArOTAC7kYB-b)
  * [ISO/IEC TS 18013-5:2021 mdoc/mDL - Credential issuance (InTime)](https://youtu.be/Ri0YymoiVwk)

* **Interactive Developer Workflows**: Hands-on tools for integrating OpenID4VCI, OpenID4VP and related standards. You can try them out at:
  * Credential issuance (InTime): [https://docs.igrant.io/docs/openID4vci-issue-credential-intime/](https://docs.igrant.io/docs/openID4vci-issue-credential-intime/)
  * Credential Issuance (Deferred): [https://docs.igrant.io/docs/openID4vci-issue-credential-deferred/](https://docs.igrant.io/docs/openID4vci-issue-credential-deferred/)
  * Dynamic Credential Request: [https://docs.igrant.io/docs/openID4vci-issue-dynamic-credential-request/](https://docs.igrant.io/docs/openID4vci-issue-dynamic-credential-request/)

## Why These Standards Matter

The integration of credential formats and protocols ensures:

* **Interoperability**: Standardised formats and interfaces allow seamless digital interactions across EU Member States.
* **Security**: Robust mechanisms safeguard user data and build trust.
* **Flexibility**: Support for diverse credentials, from general-purpose to specialised documents.

## References

[1] IETF, 2026. *SD-JWT-based Verifiable Credentials (SD-JWT VC)*. [online] Available at: [https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/](https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/) [Accessed 11 August 2026].

[2] International Organization for Standardization, 2021. *ISO/IEC 18013-5:2021 Personal identification - ISO-compliant driving licence - Part 5: Mobile driving licence (mDL) application*. [online] Available at: [https://www.iso.org/standard/69084.html](https://www.iso.org/standard/69084.html) [Accessed 11 August 2026].

[3] European Union, 2026. *Commission Implementing Regulation (EU) 2026/1731 of 15 July 2026 amending Implementing Regulations (EU) 2024/2977, (EU) 2024/2979, (EU) 2024/2980 and (EU) 2024/2982 as regards applicable standards and specifications*. [online] Available at: [https://eur-lex.europa.eu/eli/reg_impl/2026/1731/oj](https://eur-lex.europa.eu/eli/reg_impl/2026/1731/oj) [Accessed 11 August 2026].

[4] European Union, 2024. *Commission Implementing Regulation (EU) 2024/2977 of 28 November 2024 laying down rules for the application of Regulation (EU) No 910/2014 as regards person identification data and electronic attestations of attributes issued to European Digital Identity Wallets*. [online] Available at: [https://eur-lex.europa.eu/eli/reg_impl/2024/2977/oj](https://eur-lex.europa.eu/eli/reg_impl/2024/2977/oj) [Accessed 11 August 2026].

[5] European Union, 2024. *Commission Implementing Regulation (EU) 2024/2979 of 28 November 2024 laying down technical specifications and procedures for the European Digital Identity Wallets - Integrity and core functionalities*. [online] Available at: [https://eur-lex.europa.eu/eli/reg_impl/2024/2979/oj](https://eur-lex.europa.eu/eli/reg_impl/2024/2979/oj) [Accessed 11 August 2026].

[6] European Union, 2024. *Commission Implementing Regulation (EU) 2024/2982 of 28 November 2024 laying down technical specifications and procedures for the European Digital Identity Wallets - Protocols and interfaces to be supported*. [online] Available at: [https://eur-lex.europa.eu/eli/reg_impl/2024/2982/oj](https://eur-lex.europa.eu/eli/reg_impl/2024/2982/oj) [Accessed 11 August 2026].

[7] ETSI, 2026. *ETSI TS 119 472-1 V1.2.1 (2026-02): Electronic Signatures and Trust Infrastructures (ESI); Profiles for Electronic Attestations of Attributes; Part 1: General requirements*. [online] Available at: [https://www.etsi.org/deliver/etsi_ts/119400_119499/11947201/](https://www.etsi.org/deliver/etsi_ts/119400_119499/11947201/) [Accessed 11 August 2026].

[8] ETSI, 2026. *ETSI TS 119 472-2 V1.2.1 (2026-03): Electronic Signatures and Trust Infrastructures (ESI); Profiles for Electronic Attestations of Attributes; Part 2: Presentation protocols*. [online] Available at: [https://www.etsi.org/deliver/etsi_ts/119400_119499/11947202/](https://www.etsi.org/deliver/etsi_ts/119400_119499/11947202/) [Accessed 11 August 2026].

[9] International Organization for Standardization, 2025. *ISO/IEC 18013-7:2025 Personal identification - ISO-compliant driving licence - Part 7: Mobile driving licence (mDL) add-on functions*. [online] Available at: [https://www.iso.org/standard/82772.html](https://www.iso.org/standard/82772.html) [Accessed 11 August 2026].

[10] OpenID Foundation, 2026. *OpenID4VC High Assurance Interoperability Profile (HAIP)*. [online] Available at: [https://openid.net/specs/openid4vc-high-assurance-interoperability-profile-1_0.html](https://openid.net/specs/openid4vc-high-assurance-interoperability-profile-1_0.html) [Accessed 11 August 2026].

[11] W3C, 2025. *Verifiable Credentials Data Model 2.0*. [online] Available at: [https://www.w3.org/TR/vc-data-model-2.0/](https://www.w3.org/TR/vc-data-model-2.0/) [Accessed 11 August 2026].


---

# OpenID4VC: OpenID4VCI, OpenID4VP & SIOPv2 Explained
Source: https://docs.igrant.io/concepts/openID4vc/

---
id: openID4vc
title: "OpenID4VC: OpenID4VCI, OpenID4VP & SIOPv2 Explained"
description: "Compare the three OpenID4VC protocols: OpenID4VCI for issuance, OpenID4VP for presentation, and SIOPv2 for authentication, with EUDI wallet workflows and real EU use cases."
hide_title: true
sidebar_label: EUDI Wallets with OpenID4VC
keywords: [OpenID4VC, OpenID4VCI, OpenID4VP, SIOPv2, verifiable credentials, EUDI Wallet, European Business Wallet, credential issuance, credential presentation, ARF]
slug: /openID4vc/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


<head>
  <title>OpenID4VC: OpenID4VCI, OpenID4VP &amp; SIOPv2 Explained | iGrant.io</title>
  <meta name="description" content="Compare the three OpenID4VC protocols: OpenID4VCI for issuance, OpenID4VP for presentation, and SIOPv2 for authentication, with EUDI wallet workflows and real EU use cases." />
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp" />
  <script type="application/ld+json">
    {JSON.stringify({
      "@context": "https://schema.org",
      "@graph": [
        {
          "@type": "Article",
          "headline": "OpenID4VC: OpenID4VCI, OpenID4VP & SIOPv2 Explained",
          "image": "https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp",
          "author": { "@type": "Organization", "name": "iGrant.io", "url": "https://igrant.io" },
          "publisher": {
            "@type": "Organization",
            "name": "iGrant.io",
            "url": "https://igrant.io",
            "logo": { "@type": "ImageObject", "url": "https://igrant.io/assets/images/favicons/preview.png" }
          },
          "dateModified": "2026-07-23",
          "mainEntityOfPage": "https://docs.igrant.io/concepts/openID4vc/"
        },
        {
          "@type": "FAQPage",
          "mainEntity": [
            {
              "@type": "Question",
              "name": "What is OpenID4VC?",
              "acceptedAnswer": { "@type": "Answer", "text": "OpenID for Verifiable Credentials (OpenID4VC) is a set of OpenID Foundation specifications that extend OpenID Connect to work with verifiable credentials. It consists of three specifications: SIOPv2, OpenID4VCI and OpenID4VP." }
            },
            {
              "@type": "Question",
              "name": "What is the difference between OpenID4VCI and OpenID4VP?",
              "acceptedAnswer": { "@type": "Answer", "text": "OpenID4VCI defines how an issuer issues verifiable credentials to a wallet, using an OAuth access token and endpoints such as the credential endpoint. OpenID4VP defines how a holder presents credentials directly to a verifier, returning a vp_token for verification." }
            },
            {
              "@type": "Question",
              "name": "What is SIOPv2?",
              "acceptedAnswer": { "@type": "Answer", "text": "Self-Issued OpenID Provider v2 (SIOPv2) lets an end user act as their own OpenID provider and authenticate with an identifier they control, such as a decentralised identifier (DID), without relying on a central identity provider." }
            },
            {
              "@type": "Question",
              "name": "How does a verifier check a presented credential in OpenID4VP?",
              "acceptedAnswer": { "@type": "Answer", "text": "The verifier sends a presentation request, often as a QR code, NFC tag or deeplink. The holder confirms the data exchange and returns a vp_token, which the verifier cryptographically verifies and can check for revocation against a revocation registry." }
            }
          ]
        }
      ]
    })}
  </script>
</head>

# OpenID4VC: OpenID4VCI, OpenID4VP and SIOPv2 Explained

*Originally published together with European Wallet Consortium (EWC) partners and is available [here](https://igrant.io/papers/EUDI-Wallets-with-OID4VCI_OID4VP_v1.0.pdf).*

**Title:** EUDI wallets with OpenID for verifiable credentials - Leveraging identity to securely and privately mobilise personal data with digital wallets

**Abstract:** This paper comprehensively overviews OpenID protocols leveraging verifiable credentials. We delve into the nuances of OpenID for verifiable credential (OpenID4VC) protocols like self-issued OpenID provider V2 (SIOPv2), verifiable credential issuance (OpenID4VCI) and OpenID for verifiable presentations (OpenID4VP), highlighting their pivotal roles in enhancing privacy and fortifying digital identity. Through real-world scenarios, the critical values of OpenID4VCI and OpenID4VP are illustrated, emphasising their transformative potential in shaping the landscape of digital wallets, with a focus on the innovative European Union Digital Identity (EUDI) Wallets.

**Target Audience:** Professionals and stakeholders in the world of verifiable credentials keen on understanding how they map to OpenID, OpenID4VC and OpenID4VP workflows.

## 1.0   Introduction

In the ever-changing landscape of digital identities and security, EUDI Wallets are at the forefront of a revolutionary shift towards enhanced security, privacy and user control. EUDI Wallets have seamlessly integrated a few pivotal protocols targeting better control of personal data. These include OID4VC (OpenID for verifiable credentials) [1], which in turn specifies OpenID4VCI (OpenID for verified credentials issuance) and OpenID4VP (OpenID for verifiable presentations) into their digital wallet ecosystem, alongside a robust suite of other cutting-edge privacy mechanisms and formats such as SD-JWT (selective disclosure JWTs) and those capable of ZKP (zero-knowledge proofs).

This article comprehensively overviews OpenID protocols leveraging verifiable credentials. We delve into the nuances of OpenID for verifiable credential (OpenID4VC) protocols like self-issued OpenID provider V2 (SIOPv2), verifiable credential issuance (OpenID4VCI) and OpenID for verifiable presentations (OpenID4VP), highlighting their pivotal roles in enhancing privacy and fortifying digital identity. Through real-world scenarios, the critical values of OpenID4VCI and OpenID4VP are illustrated, emphasising their transformative potential in shaping the landscape of digital wallets, with a focus on the innovative European Union Digital Identity (EUDI) Wallets, aligning with the requirements specified in the European Architecture and Reference Framework (ARF) [2].

## 2.0 OpenID protocols leveraging verifiable credentials

The OpenID Foundation and its communities have developed several protocols to facilitate and implement verifiable credentials (VC) in identity verification and authentication flows.

This section describes the three main protocols within the OpenID ecosystem: SIOPv2, OIDC4VCI, and OpenID4VP. These offer distinct approaches and advantages tailored to specific use cases and requirements. They signify the OpenID Foundation’s efforts to intertwine decentralised and verifiable data into user authentication while leveraging established principles and flows of OpenID Connect (OIDC). It is crucial to recognise that the technology and standards in this domain are progressively evolving. As such, the most recent advancements should be sourced directly from the OpenID Foundation's documentation and other pertinent authoritative sources (Examples include references [1][3][4][5] etc.).

### 2.1 OpenID for Verifiable Credentials (OID4VC)

OID4VC provides a set of specifications to help users have more control and privacy over their personal identity details. At its core, OID4VC leverages OIDC, letting users manage their IDs and share identity details directly with those checking it without needing a mediator. This reduces the need for central organisations to manage identities. It consists of three specifications:

* Self-issued OpenID Provider v2 (SIOPv2)
* OpenID4VCI
* OpenID4VP

Each of the above is explored further below.

### 2.2 Self-Issued OpenID Provider V2 (SIOPv2)

SIOPv2 is an OpenID protocol allowing an end-user to control an OpenID provider (OP) and is a fundamental OID4VC/OpenID4VP ecosystem building block. It enables users to issue VCs, giving them unprecedented control over their identity and personal data. In technical terms, users can self-issue VCs and use decentralised identifiers (DIDs) within the OpenID flow. The key aspects of SIOP v2 are:

**Decentralised authentication:**A user can authenticate using an identifier they control with a verifier using, for example, a DID. Such a DID can rely on decentralised trust anchors on a decentralised infrastructure.

**Standardised interaction flows:** By conceptualising user interaction flows, such as login and consent, SIOPv2 aspires to deliver a harmonious user experience across various platforms and applications.

**Enhanced DID Integration:** Surpassing its predecessors (SIOPv1 and the SIOP DID Profile [6]), SIOPv2 enhances the support and utilisation of DIDs.

### 2.3 OpenID for Verifiable Credential Issuance (OpenID4VCI)

For a step-by-step walkthrough of the issuer flow and grant types, see [OpenID4VCI credential issuance](/concepts/openid4vci-credential-issuance/).

OpenID4VCI sets guidelines for issuing VCs in various formats. As per OpenID4VCI, an individual's digital wallet requires a key, an OAuth access token, to retrieve a VC. This token is secured through the standard OAuth 2.0 procedure or the pre-authorised code flow (as detailed in Reference [5, Chapter 3.5]). OpenID4VCI mandates specific online access points (endpoints):

1. The credential endpoint is for VC issuance.
2. A mechanism for disseminating information about which VCs an issuer is authorised to issue.

Additionally, OpenID4VCI suggests some optional endpoints:

1. The batch credential endpoint is intended to request multiple VCs simultaneously.
2. The deferred credential endpoint facilitates delayed VC issuance.
3. A credential offer endpoint that allows an issuer to initiate the VC issuance to a known individual.

### 2.4 OpenID for Verifiable Presentations (OpenID4VP)

For a step-by-step walkthrough of the verifier flow, see [OpenID4VP credential verification](/concepts/openid4vp-credential-verification/).

OpenID4VP postulates a methodology focussed primarily on employing VCs for user authentication, enabling users to demonstrate control over a DID and authenticate with a service, negating the need for a centralised identity provider. The key aspects of OpenID4VP are:

**User-centric authentication:**OIDC4VP enables the direct use of VCs for authentication, embedding a user-centric paradigm.

**Privacy preservation:** The protocol is meticulously crafted to mitigate the unwarranted disclosure of personal information throughout the authentication trajectory.

**Direct VC presentation:**Facilitating users to directly present their VCs to the relying party (verifier) amplifies privacy and user autonomy in data sharing.

## 3.0 Why do we need OpenID4VCI and OpenID4VP?

OpenID4VCI and OpenID4VP are introduced to address two fundamental aspects of VCs compared to traditional identity assertions (for example, OpenID Connect). Firstly, they cater to the unique nature of VCs, where a predefined schema (the credential type) and cryptographic holder binding ensure secure, **direct** presentation from individuals to relying parties without the need for credential issuers or intermediaries. Secondly, OpenID is an open standard with a high level of maturity and proven OIDC and OAuth industry standards. Extending this with OpenID4VCI and OpenID4VP offers the invaluable ability to configure and adapt to any schema definition, bringing the power of VCs to industry-wide adopted OpenID protocols. This adaptability ensures VCs can represent various attributes and qualifications, meeting the demands of various use cases.

In summary, OpenID4VCI and OpenID4VP bridge the gap between traditional identity assertions and the modern, decentralised digital identity landscape by providing security, privacy, user control and the flexibility to define custom schema definitions.

## 4.0 How does it work?

### 4.1 OpenID Connect and Verifiable Credentials

To understand how it works, let's look at what a VCs and OpenID workflow look like. In the OIDC workflow illustrated in Figure 1, an individual seeking specific access (Step 1) to a resource is redirected to **authenticate** and **authorise** to the original issuer (Step 3). Here, every data using service or the verifier has a direct relationship with the issuer, where the verifier requests holder information from the issuer (Step 2) before granting access to the individual.

![OpenIDConnect Workflow](fig-01-oidc-workflow.png)

_Figure 01: OIDC workflow for providing access to holder data_

OIDC uses JSON web tokens (JWT) format for tokens exchanged between the relying party, authorisation server and resource server. JWTs are cryptographic tokens confirming the user's identity after successful authentication. These tokens include claims or assertions about the user, such as the user's identifier and the authentication timestamp, which relying parties can verify using digital signatures. Additionally, JWTs may be used in OIDC to send secure authentication requests and to obtain user information from the user info endpoint, ensuring that sensitive data is handled in a secure and verifiable manner.

![OpenID4VC Workflow](fig-02-oid4vc-workflow.png)

_Figure 02: VC workflow for providing access to holder data (with an individual involved in the data exchange transaction in real-time via a digital wallet)_

In a VC workflow, illustrated in Figure 02, the ability of the holder wallet to cryptographically bind a credential allows individuals to present their credentials to any verifier directly. Once the issuer registers to the trust registry, when an individual requests a credential (Step 01), the issuer can issue it directly to the individual (Step 02). This is how the physical world has worked for decades. For example, citizens receive their passport or ID card, which they can present to anyone, anywhere, without the need for the verified to have direct access to the original issuer.

When a verifier requests proof (Step 3), for example, proof of identity or proof of any data attribute, the individual concerned presents the credential from their holder wallet to the verifier (Step 4). The verifier can independently verify the proof via the trust anchor, which can be ledger-based or based on an existing PKI infrastructure.

The OpenID4VCI and OpenID4VP workflows combine the power of OIDC and leverage existing deployments while being able to adopt powerful, verifiable data exchange mechanisms using verifiable credentials.

### 4.2 OpenID4VCI: How does it work?

![OpenID4 Verifiable Credentials Issuance Workflow](fig-03-openid4vci-workflow.png)

_Figure 03: OpenID4VCI workflow for issuing and storing credentials_

The OpenID4VCI specification defines the APIs that issue verifiable credentials. The issuance involves the following steps. (In brackets, we have used the same term as in the OpenID4VCI spec chapters 4-7 [4]). These steps are agnostic to any authorisation flow chosen by the issuer (authorised or pre-authorised).

1. Discover VC Issuer capabilities (obtain Credential Issuer’s metadata): When an OpenID4VCI-supported digital wallet client wishes to engage with an issuer, it refers to a well-known configuration as a JSON document, typically hosted at <strong><code>/.well-known/openid-credential-issuer</code></strong> URI endpoint on the issuer’s domain. This JSON document defines credential issuer metadata, such as credential issuer endpoint, authorisation endpoint, methods, credential endpoint, credential deferred endpoint and other particulars necessary to enable secure, efficient communication and issuance processes between the client and the issuer. Through this standardised issuer discovery technique, the OpenID4VCI mechanism ensures seamless interoperability. It simplifies the establishment of trust among participants in decentralised identity systems, thereby enhancing user experience and fortifying security across transactions.

2. Credential offer (credential offer endpoint): The credential offer is a cryptographic invitation, typically embedded within a QR code (cross device), an NFC (cross device) or a deeplink (same device), designed to securely convey essential information and directives from the issuer to the holder. This encapsulated data usually includes details about the credential being offered, the issuer’s intention, and a callback to the issuer’s service endpoints, which will manage the subsequent phases of the credential issuance process.

3. Authenticate and authorise (authorisation endpoint, token endpoint): In OID4VC, the authentication request operates as a pivotal mechanism, anchoring the secure and seamless interaction between the holder, issuer and, potentially, the verifier. This step involves the following substeps:

    1. Authorisation request: This is orchestrated by the holder's digital wallet, which communicates with the issuer’s authorisation endpoint to initiate the issuance process. This involves initiating an OAuth authorisation request and obtaining an authorisation code from the identity provider (or authorisation server). The authenticate request encapsulates essential parameters such as <strong><code>client_id</code></strong>, <strong><code>response_type</code></strong>, and <strong><code>scope</code></strong>, alongside other parameters that might inform the issuer about the holder's desired credentials and claims. This step is skipped in the pre-authorisation flow as the digital wallet holder already has the authorisation token and may additionally use a user PIN.

    2. Token request and response: Once authorised, the digital wallet acquires a valid access token. In the authorisation code flow, the code is exchanged to obtain the access token refresh token pair (as in 3a). In the pre-authorised flow, the token request contains a pre-authorised code and user PIN, which are exchanged to obtain the token response containing the access token and refresh token pair.

4. Issue credential (credential endpoint): The credential endpoint issues a credential the individual/holder requests once a valid access token is presented. The digital wallet client can request the issuance of a credential of a certain type multiple times, e.g., to associate the credential with different public keys/DIDs or to refresh a certain credential. It is also possible to issue multiple credentials within the same request. In that case, it is at the digital wallet client's discretion to decide the order to request the issuance of multiple credentials requested in the authentication request. Credentials can be issued immediately, if available, or after some time using a deferred credential endpoint.
5. Store credential: After the credential has been issued, the individual can store it in their digital wallet client for future verifiable presentations.

### 4.3 OpenID4VP: How does it work?

The OpenID4VP specification [5] defines an extension of OIDC to allow the presentation of claims in various formats, such as W3C VCs.

![OpenID4VP Workflow](fig04-openid4vp-workflow.png)

_Figure 04: OpenID4VP workflow for presenting and verifying credentials_

The verifiable presentation (VP) involves the following steps:

1. Discover verifier capabilities: This allows for the streamlined discovery of verifier capabilities and configurations through a structured, machine-readable format. It essentially acts as a blueprint that details how digital wallet clients (e.g., holders) should interact with verifiers. Positioned at a well-defined URI endpoint on the verifier's domain, typically under <strong><code>/.well-known/openid-configuration</code></strong>, this configuration document is encoded in JSON format and reveals essential information about the verifier.

2. Request presentation: The presentation request, usually encapsulated within a QR code (cross device), NFC device (cross device) or deeplink (same device), is generated by the verifier and contains a structured set of requirements and instructions detailing the specific verifiable credentials or claims sought from the holder. The presentation request is extracted and processed once the individual scans the QR code (or blips the NFC device or clicks the deeplink). The presentation request contains the definition of the presentation by the verifier. For example, a verifier can specify an EU passport attribute as the credential type and a constraint to only select the name of the holder from the credential.

3. Authenticate and authorise: The authorisation request generally encapsulates essential parameters such as <strong><code>client_id</code></strong>, <strong><code>response_type</code></strong>, and <strong><code>scope</code></strong> alongside other parameters that inform the holder about the verifier's desired credentials and claims.

4. Present VCs: A VP is constructed based on the presentation definition shown to the individual for confirmation. Once the individual confirms the data exchange, a <strong><code>vp_token </code></strong>is returned to the verifier.

5. Verify credentials: After receiving the <strong><code>vp_token</code></strong>, the verifier can cryptographically verify the presentations' authenticity. If the information is present, they can also check a credential's revocation status against a revocation registry.

## 5.0 Key value of OpenID4VCI: The path to verified credentials

### 5.1 OpenID4VCI: Key values

OpenID4VCI merges secure, digital ID checks with user-friendly online processes. It brings several essential benefits to digital identity management and user verification in online systems, summarised below:

**Increased trust and security:** OpenID4VCI makes digital interactions more secure and trustworthy. Using special digital ID proofs (i.e., VCs), which are hard to fake or alter, ensures that online identity checks are robust and reliable.

**User control over identity:** It puts users in control of their own digital IDs. People can choose which bits of their identity information to share, ensuring they remain in charge of their personal data when using online services.

**Ease of use:** OpenID4VCI combines the safety of VCs with easy-to-use online checks, ensuring that while users enjoy strong and safe ID checks, the experience remains straightforward and friendly. This helps users to get on board easily and continue to use the system without hassle.

**High interoperability:** It helps different digital systems work together smoothly. Using well-known online check flows (OIDC flows) and combining them with the new technology of VCs ensures that new systems can work well with existing online services and technologies.

**Privacy and compliance adherence:** OpenID4VCI helps to protect user privacy and supports rules that let users control their own personal data. Allowing users to choose which identity information to share aligns with laws like the General Data Protection Regulation (GDPR), which focuses on securing data sharing and putting users in charge of their personal information.

### 5.2 Real-world reference scenario

In the following real-world reference scenario [7][8], illustrated in the figure, we explain the European Social Security Pass (ESSPASS), which aims to simplify how individuals use their social security benefits in EU countries. Here, the issuer is a national social security office that issues ESSPASS PDA1 verifiable credentials to the individual. The individual can present the credentials across the border in Sweden and prove their social status to an inspecting organisation in Sweden. _(**Disclaimer:** ESSPASS PDA1 is only an example of how the workflow could be. The same flow could be applied to any credentials or attestations)_

![EU ESSPASS Usecase Scenario](fig06-esspass-usecase.png)

_Figure 05: Real-life reference scenario with ESSPASS_

The initial stage of ESSPASS focuses on digitally issuing and verifying a portable document A1 (PDA1) [7] that certifies the applicable social security legislation for work in EU member states. Here is how it works:

* Request an ESSPASS - PDA1: An individual verifies their identity and requests the issuance of an ESSPASS - PDA1 as a VC.
* The back office processes the request and issues the individual ESSPASS [7]-PDA1 verifiable credentials, which are then stored in the data wallet.
* Verification: Any third-party organisation needing to confirm the validity of PDA1 credentials can request and verify them against the EBSI trust anchor.

### 5.3 Reference scenario interactions

Figure 6.0 illustrates the detailed workflow involved in the real-life reference scenario of the National Social Security Office issuing ESSPASS - PDA1 credentials to an individual.

The steps involved in this workflow are:

1. The individual visits the National Social Security Office's webpage and may or may not sign in to their service portal.
2. The individual scans a QR code to request the issuance of a PDA1 document using the digital wallet. Here, the OpenID4VCI flow is triggered. The issuer can also request additional VCs from the individual during the process. Once identified, a request for the credential issuance is placed with the issuer.
3. The issuer can immediately issue a credential or, after some time (called deferred issuance). Once the credential is received, it is securely stored in the digital wallet for future presentations. The issuer may seek additional verifications as part of an out-of-band KYC process.

![ESSPASS Issuance Workflow](fig07-esspass-issuance-sequence.png)
_Figure 06: National Social Security office issues ESSPASS - PDA1 credential to Individual_

## 6.0 Key value of OpenID4VP: The vanguard of privacy-enhanced digital wallets

### 6.1 OpenID4VP: Key values

OpenID4VP combines VP authenticity with OIDC's widely adopted authentication processes. It offers a suite of advantages quintessential for reinforcing digital identity management and user verification.

**Enhanced authentication credibility**: OpenID4VP amplifies the credibility of digital interactions by incorporating VPs, which serve as reliable and cryptographic confirmations of digital identity. This strengthens the authentication procedure and ensures the user verification process is secure and reliable.

**User-oriented identity management:** The protocol allows users to control their digital identity. By enabling users to present their VPs selectively, OpenID4VP ensures that users can govern the granularity and scope of their shared identity information during the authentication process.

**Smooth user interface:** Despite its sophisticated underpinning, OpenID4VP is crafted to offer a smooth and user-friendly interaction. By combining the security facets of VPs with a straightforward authentication process, OpenID4VP ensures a simplified user journey.

**Comprehensive interoperability:** OpenID4VP enables interoperability by combining traditional OIDC workflows with the innovative use of VPs. This combination ensures that OpenID4VP can be synergistically integrated into existing OIDC-compliant systems, bridging the gap between conventional and contemporary identity technologies.

**Privacy and compliance adherence:** Emphasising user privacy, OpenID4VP facilitates a model where users can directly present their VPs to a relying party, minimising unnecessary data disclosure and thereby complying with regulations like the GDPR.

### 6.2 Real-world reference scenario

In the following reference scenario [7][8][9], we explain that the inspecting organisation verifies the A1 certificate, a form used to confirm the country where an employee or visitor currently pays their social security contributions. Here is how it works:

* Request verification: An individual presents the ESSPASS/PDA1 VC to the verifier.
* The back office checks the VCs inside the presentation and confirms the validity against a trust anchor.

### 6.3 Reference scenario interactions

Figure 7.0 illustrates the detailed workflow involved in the real-life reference scenario of an inspecting organisation verifying an individual's ESSPASS-PDA1 credential.

The steps involved in this workflow are:

1. The individual visits the inspecting organisation's webpage and may or may not sign in to their service portal.
2. Scan a QR code or click a link to obtain the presentation request.
3. Once the presentation request is received, the individual can verify who they are to the verifier.
4. A digital wallet lets the individual see the credentials the verifier requests. They can then present the credentials of their choosing towards the verifier.

![ESSPASS Verification Workflow](fig08-esspass-verification.png)
_Figure 07: Inspecting organisation verifies ESSPASS - PDA1 credential from an individual_

## 7.0 Bridging to legacy eIDAS systems and SAML

The ARF [2] and new eIDAS regulation [10][14] leans on OpenID-based protocols. However, to ensure interoperability and compatibility of EUDI Wallets with older eIDAS systems, it is essential to map the concepts of SAML [5] to OpenID4VCI and OpenID4VP and vice versa. This is also in line with the eIDAS regulation that requires the creation of minimum technical specifications, standards and procedures for the interoperability framework. This chapter provides an introductory mapping of SAML to OpenID4VCI and OpenID4VP to SAML. Fortunately, translating between SAML and OIDC is straightforward in most areas. Below are some considerations.

### 7.1 Authentication workflow

The eIDAS specifications [12][13] discuss the use of specific authentication messages (the authorisation request and response). These messages are relayed primarily using the HTTP POST method. This setup is reminiscent of certain flows in OIDC and SIOPv2. While most of the mapping is straightforward, the latest OpenID4VCI version presents some complications.

For example, the authorisation request contains the following parameters:

* User authentication type, identification scheme, minimum level of assurance (LoA),
* Identifiers of requested attributes.

The authorisation response contains the following parameters:

* User authentication type

* Retrieved values for the requested attributes.

This ‘one-step’ request/response flow is similar to that described by OIDC or SIOPv2 (<strong><code>response_type=id_token</code></strong>). The OpenID4VP also supports implicit flow but requires an additional data structure (<strong><code>response_type=vp_token</code></strong>). The OpenID4VCI does not help implicit flow; it describes just authorisation code flow and pre-authorized code flow (<strong><code>response_type=code</code></strong>), but both are ‘two-step’ flows that differ from the ‘one-step’ flow of legacy eIDAS systems.

Mapping from SAML to OIDC, SIOPv2, or even OpenID4VP does not require modifications in the communication flow of legacy eIDAS systems, but supporting the current version of OpenID4VCI is a problem.

### 7.2 Security: Signatures and encryption

The eIDAS specifications emphasise the importance of security, requiring signatures for authentication requests and both signatures and encryption for responses. While XML-based messages were previously the norm, they are now transitioning to JSON-based ones.

However, the order in which encryption and signatures are applied differs between the old and new systems. For instance, the eIDAS-focused SAML encrypts data before signing the entire message. In contrast, OIDC signs first before encrypting. Both methods have merits, but harmonising them is crucial for maintaining security during the transition.

Mapping from SAML to OIDC, SIOPv2, OpenID4VP, or OpenID4VCI requires signature and encryption mechanism modifications. Legacy eIDAS systems and EUDI Wallet, as per eIDAS-2.0, shall have a common method for applying security layers such as sign-then-encrypt-then-sign.

### 7.3 Passing parameters

Legacy eIDAS details how parameters should be passed through HTTP Redirect or HTTP POST. The method used often depends on the message's size. However, newer systems like OpenID4VP and SIOPv2 have different size limits, especially when considering QR code uses, where size constraints are more pronounced. Transitioning might require using HTTP POST more extensively, especially when URLs become too lengthy.

## 8.0 EUDI Wallets: Pioneering the future of digital identity

As explored in this paper, the convergence of EUDI Wallets with OpenID4VCI and OpenID4VP represents a transformative leap forward in digital identity and personal data protection. Integrating advanced technologies like SD-JWT instead of simply JWTs in a typical OIDC flow and ZKPs could enhance these solutions towards enhanced end-user privacy and control.

EUDI Wallets, in collaboration with OpenID Foundation protocols (like OpenID4VCI, OpenID4VP), credential formats like JWT, SD-JWT with ZKP, herald a new era in digital identity management - one in which individuals are empowered, data is fortified and privacy is preserved. As these technologies become more integrated into our digital lives, we move closer to a future where the benefits of a connected world can be realised without compromising our personal information and digital sovereignty. The future of digital identity and personal data protection has arrived, and it is both promising and secure!

## Frequently asked questions

### What is OpenID4VC?

OpenID for Verifiable Credentials (OpenID4VC) is a set of OpenID Foundation specifications that extend OpenID Connect to work with verifiable credentials. It consists of three specifications: SIOPv2, OpenID4VCI and OpenID4VP.

### What is the difference between OpenID4VCI and OpenID4VP?

OpenID4VCI defines how an issuer issues verifiable credentials to a wallet, using an OAuth access token and endpoints such as the credential endpoint. OpenID4VP defines how a holder presents credentials directly to a verifier, returning a vp_token for verification.

### What is SIOPv2?

Self-Issued OpenID Provider v2 (SIOPv2) lets an end user act as their own OpenID provider and authenticate with an identifier they control, such as a decentralised identifier (DID), without relying on a central identity provider.

### How does a verifier check a presented credential in OpenID4VP?

The verifier sends a presentation request, often as a QR code, NFC tag or deeplink. The holder confirms the data exchange and returns a vp_token, which the verifier cryptographically verifies and can check for revocation against a revocation registry.

## References

1. OpenID Foundation (2022), ‘OpenID for Verifiable Credentials - Overview’, Available at: [https://openid.net/sg/openid4vc/](https://openid.net/sg/openid4vc/) (Accessed: October 01, 2023)
2. European Commission (2023) The European Digital Identity Wallet Architecture and Reference Framework (2023-04, v1.1.0)  [Online]. Available at: [https://github.com/eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework/releases](https://github.com/eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework/releases) (Accessed: October 16, 2023).
3. OpenID Foundation (2023), 'Self-Issued OpenID Provider v2 (SIOP v2)', Available at: [https://openid.net/specs/openid-connect-self-issued-v2-1_0.html](https://openid.net/specs/openid-connect-self-issued-v2-1_0.html) (Accessed: October 01, 2023)
4. OpenID Foundation (2023), 'OpenID for Verifiable Credential Issuance (OpenID4VCI)', Available at: [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-11.html](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-11.html) (Accessed: October 02, 2023).
5. OpenID Foundation (2023) 'OpenID for Verifiable Presentation (OIDC4VP)', Available at: [https://openid.net/specs/openid-4-verifiable-presentations-1_0.html](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html) (Accessed: 02 October 2023).
6. Decentralized Identity Foundation (2022), ‘Self-Issued OpenID Connect Provider DID Profile v0.1 (DEPRECATED)’, Available at [https://identity.foundation/did-siop/](https://identity.foundation/did-siop/) (Accessed: 21 October 2023)
7. European Commission (2022) 'European Social Security Pass', Available at: [https://ec.europa.eu/social/main.jsp?catId=1545&langId=en](https://ec.europa.eu/social/main.jsp?catId=1545&langId=en) (Accessed: 10 October 2023).
8. iGrant.io (2023) 'ESSPASS PDA1 reference scenario', Available at: [https://igrant.io/ebsi.html](https://igrant.io/ebsi.html) (Accessed: 02 October 2023).
9. iGrant.io (2023) 'ESSPASS: Transforming social security rights with OID4VC and OID4VP in digital wallets', YouTube video, Available at: [https://youtu.be/b-dTpMbxHPU](https://youtu.be/b-dTpMbxHPU) (Accessed: October 12, 2023).
10. European Commission (2014) Regulation (EU) No 910/2014 of the European Parliament and of the Council, Official Journal of the European Union, L 257/73. [online] Available at: [https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32014R0910](https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32014R0910)  (Accessed: 12 October 2023).
11. Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V2.0 (2005-03-15) [http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf](http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf) (Accessed: October 16, 2023).
12. European Commission (2016) eIDAS Technical Specifications, based on Opinion No. 1/2016 and CIR (EU) 2015/1501 (2016-01-26, v1.0) [https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/eIDAS+eID+Profile](https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/eIDAS+eID+Profile) (Accessed: October 16, 2023).
13. European Commission (2023) eIDAS Technical Specifications, based on Opinion No. 3/2023 and CIR (EU) 2015/1501 (2023-04-24, v1.3) [https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/eIDAS+eID+Profile](https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/eIDAS+eID+Profile) (Accessed: October 16, 2023).
14. European Commission, 2021. Proposal for a Regulation of the European Parliament and of the Council of amending Regulation (EU) No 910/2014 as regards establishing a framework for a European Digital Identity. [Online] Available at: [https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A52021PC0281](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A52021PC0281)  (Accessed on: 6 November 2023)


---

# Credential issuance lifecycle (OpenID4VCI): From offer to acceptance
Source: https://docs.igrant.io/concepts/credential-issuance-lifecycle/

---
id: openid4vci-credential-issuance-lifecycle
title: "Credential issuance lifecycle (OpenID4VCI): From offer to acceptance"
hide_title: false
description: "A comprehensive guide to the OpenID4VCI (OpenID for Verifiable Credential Issuance) credential issuance lifecycle for developers, solution architects, and product managers building on EUDI Wallets, European Business Wallets, and digital identity ecosystems."
sidebar_label: Credential issuance lifecycle (OpenID4VCI)
keywords: [credential issuance lifecycle, OpenID4VC, OpenID4VCI, OID4VCI, verifiable credentials, credential states, credential offer, credential issuance, EUDI Wallet, European Business Wallet, digital wallet, iGrant.io, Organisation Wallet Suite, deferred issuance, SD-JWT, mdoc, W3C VC, eIDAS 2.0, digital identity, banking, insurance, payments]
slug: /credential-issuance-lifecycle/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>OpenID4VCI credential issuance lifecycle in OpenID for Verifiable Credential Issuance | iGrant.io</title>
  <meta name="description" content="A comprehensive guide to the OpenID4VCI (OpenID for Verifiable Credential Issuance) credential issuance lifecycle, covering all states from offer sent to credential accepted, with real-world use cases for banking, insurance, payments, and digital identity."/>
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/credential-issuance-lifecycle.png" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/credential-issuance-lifecycle.png" />
</head>

This article explains the credential issuance lifecycle defined by the [OpenID for Verifiable Credential Issuance (OpenID4VCI)](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html) specification [1] (also written OID4VCI) as implemented in the [Organisation Wallet Suite by iGrant.io](https://docs.igrant.io/docs/organisation-wallet-overview/). Through six progressive stages and two terminal states, we trace the journey of a credential from the moment an issuer creates an offer to the point where a holder accepts it into their wallet, and explore what happens when the process encounters errors or is interrupted.


**Target audience:** Developers, solution architects, and product managers building credential issuance solutions using OpenID4VC with EUDI Wallets, European Business Wallets, or other digital wallets.

## 1.0 Introduction

The [OpenID for Verifiable Credential Issuance (OpenID4VCI)](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html) specification [1] defines a protocol for issuing verifiable credentials from an issuer to a holder's digital wallet. Built on the widely adopted OAuth 2.0 [2] and OpenID Connect (OIDC) [3] standards, it enables interoperable credential issuance across digital identity ecosystems, whether the credential is a national ID, a university degree, a bank account attestation, or an electronic receipt. Importantly, the OpenID4VCI lifecycle applies equally to personal EUDI Wallets and to European Business Wallets, making it a universal framework for credential issuance across both individual and enterprise identity use cases.

Credential issuance is not a single event but a multi-step process. Between the moment an issuer decides to offer a credential and the moment a holder accepts it, several things happen: the offer must be delivered and opened, the holder must be authorized, the credential must be cryptographically constructed and transferred, and the holder's wallet must confirm receipt. At any point along the way, the process can fail, the issuer might deny the request, or the holder might decide to delete the credential later.

Understanding this lifecycle is essential for building reliable integrations. It determines when to update a user interface, when to trigger a business workflow, when to retry an operation, and when to treat an exchange as failed. This article walks through each stage, explains what is happening at the protocol level, and shows how the lifecycle plays out in real-world scenarios.

## 2.0 The OpenID4VC credential issuance lifecycle

When an issuer initiates credential issuance using OpenID4VC, the process follows a well-defined lifecycle with **six progressive stages** and **two terminal states**.

<div style={{maxWidth: '600px', margin: '0 auto'}}>

![Credential Issuance Lifecycle](fig-credential-issuance-lifecycle.png)

</div>

_Figure 01: The credential issuance lifecycle: Six progressive stages - issuer validation decision checks (diamonds), successful completion, issuer denial and holder deletion.

The happy path flows top to bottom: the issuer creates an offer, the holder opens it, authorization succeeds, and a token is issued. The issuer then performs validation checks - verifying that a valid [Wallet Unit Attestation (WUA)](https://docs.igrant.io/concepts/wallet-unit-attestation/) is present and that the European Business Wallet Owner Identification (EBWOID) is in order. These two checks are defined within the European Digital Identity Wallet Architecture and Reference Framework (ARF) [5]. If either check fails, the issuance is denied. If both checks pass, the credential is delivered, the wallet confirms receipt, and the holder accepts it. After the credential is accepted, the holder can choose to delete it.

Each stage is tracked as a `status` value in the credential exchange record and fires a corresponding [webhook event](https://docs.igrant.io/docs/openid4vc-webhooks/), making the entire lifecycle observable and actionable for developers.

## 3.0 How the Lifecycle Works

### 3.1 Offer Sent

The lifecycle begins when the issuer creates and sends a credential offer to the holder. In the OpenID4VC specification, this corresponds to the Credential Offer described in Section 4 [1]. The issuer generates a credential offer containing the necessary metadata, including the credential configuration, issuer endpoint, and grant information, and makes it available to the holder, typically through a QR code or a credential offer URI.

At this point, the offer is waiting for the holder to open it. No authentication or authorization has occurred yet. The issuer triggers this stage by calling the [Issue credential](https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential) API, which returns a `credentialOffer` that can be encoded as a QR code.

**Example:** A bank wants to issue a KYC verification credential to a customer who has just [opened a new account](https://www.igrant.io/demo/open-bank-account.html). The bank's system calls the Issue credential API and displays the resulting QR code on the customer's screen. The credential's lifecycle has begun; the status is now `offer_sent`.

Credentials may be issued immediately (in-time) or on a deferred basis depending on business requirements. In-time issuance is used when credential data is already available - for example, issuing a [Photo ID credential](https://www.igrant.io/photoid.html) immediately after the holder's passport has been validated. Deferred issuance is used when back-office processing is required first, as explored in Section 4.0.

### 3.2 Offer Received

Once the holder opens the credential offer - for example, by scanning the QR code with the [Data Wallet](https://igrant.io/datawallet.html) or any other EU Digital Identity (EUDI) Wallet - the status transitions to Offer Received. The holder's wallet has retrieved the credential offer and resolved the issuer's metadata, but the holder has not yet proceeded to the authorization step.

This stage corresponds to the wallet resolving the Credential Issuer Metadata and Authorization Server Metadata as described in Sections 11.2 and 11.1 of the OpenID4VC specification [1].

For the bank issuing the KYC credential, this is the moment when the customer has scanned the QR code with their wallet. The bank's system, if it has registered a [webhook](https://docs.igrant.io/docs/openid4vc-api/config-create-webhook), receives an `openid.credential.offer_received` event, confirming that the customer has engaged with the offer.

### 3.3 Token Issued

This stage marks the point at which the holder has been successfully authorized. The authentication and authorization exchange between the holder's wallet and the issuer's authorization server has been completed, and the wallet has obtained an access token.

In OpenID4VC, this maps to the Token Endpoint interaction described in Section 6 [1]. The specification supports two authorization flows:

- **Authorization Code Flow:** The holder authenticates with the issuer's authorization server and exchanges the authorization code for an access token.
- **Pre-Authorized Code Flow:** The issuer provides a pre-authorized code (optionally with a transaction code) that the holder's wallet exchanges directly for an access token.

Once the token is issued, the holder's wallet is ready to request the credential from the Credential Endpoint.

In some scenarios, additional proof of identity may be required before issuance proceeds. When issuing a [Photo ID credential](https://www.igrant.io/photoid.html), for instance, the issuer - a Qualified Trust Service Provider (QTSP) - may require the holder to first present their passport credential for verification. This is handled through a [dynamic credential request](https://docs.igrant.io/docs/openID4vci-issue-dynamic-credential-request/) flow, in which issuance and presentation occur within a single transaction.

### 3.4 Credential Issued

With a valid access token, the holder's wallet requests the credential from the issuer's Credential Endpoint, as described in Section 7 of the OpenID4VC specification [1]. The issuer validates the request, including proof of key possession, and delivers the credential to the holder's wallet. Credentials can be issued in any of the standard formats: [W3C Verifiable Credentials (JWT)](https://www.w3.org/TR/vc-data-model/), [IETF SD-JWT VC](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-14.html), or [ISO/IEC 18013-5 mdoc/mDL](https://www.iso.org/standard/69084.html).

At this stage, the credential has been delivered to the wallet but the holder has not yet confirmed or accepted it. The credential exchange record status transitions to `credential_issued`, and the issuer receives the `openid.credential.credential_issued` webhook event. Integrations can poll the [Read issuance history](https://docs.igrant.io/docs/openid4vc-api/config-read-digital-wallet-open-id-credential-history) API or use the webhook to update dashboards in real time.

### 3.5 Credential Acknowledged

The holder's wallet confirms receipt of the credential using the Notification Endpoint described in Section 10 of the OpenID4VC specification [1]. This acknowledgement informs the issuer that the credential has been successfully received and stored in the wallet. The status transitions to `credential_acked`.

The distinction between acknowledgement and acceptance is intentional: it allows wallets to implement a review step in which the holder inspects the credential before choosing to keep it. Credentials in the `credential_acked` state are not yet available for presentation to verifiers - they must reach `credential_accepted` first.

### 3.6 Credential Accepted

The holder accepts and saves the credential, marking the issuance as complete. The credential is now fully available in the holder's wallet for future use - for example, presenting it to a verifier during an [insurance onboarding](https://www.igrant.io/demo/insurance.html) process, a [bank account login](https://www.igrant.io/demo/open-bank-account.html), or a [DCQL-based identity verification](https://www.igrant.io/demo/openid4vp-dcql-01.html).

This is the successful terminal state. The issuer receives the `openid.credential.credential_accepted` webhook, and the credential exchange record shows `credential_accepted` as its final status.

## 4.0 Deferred issuance in OpenID4VC

The OpenID4VC specification supports deferred credential issuance for scenarios in which the credential cannot be issued immediately. This is a common requirement in regulated industries where back-office processing - such as underwriting, risk assessment, or regulatory checks - must be completed before a credential can be generated.

In a deferred issuance flow, the issuer creates the credential offer with `issuanceMode: "Deferred"`. The holder scans the QR code and the lifecycle progresses to the Token Issued stage, where it pauses. When processing is complete, the issuer calls the [Issue deferred credential](https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history) API with the `credentialExchangeId` from the original offer. The holder's wallet automatically retrieves the credential, and the lifecycle resumes through to Credential Accepted. Follow the [deferred issuance workflow](https://docs.igrant.io/docs/openID4vci-issue-credential-deferred/) for step-by-step guidance.

**Example:** An insurance company cannot issue a policy credential immediately - it requires time for underwriting and regulatory review. The company creates a deferred offer, and the customer scans the QR code. Days later, once underwriting is complete, the issuer calls the deferred issuance API. The customer's wallet retrieves the policy credential automatically, completing the lifecycle.

Back-office systems can monitor pending deferred credentials by calling the [List issuance history](https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-credential-history) API and filtering for records in the `token_issued` state.

## 5.0 Exception handling and terminal failure states

Not every OpenID4VC credential issuance follows the happy path. The lifecycle includes two terminal states that handle failure and holder-initiated removal.

### 5.1 Issuance denied

Once the holder has been authorized and the token is issued, the issuer performs validation checks before delivering the credential. As shown in the diagram, the issuer verifies that a valid **Wallet Unit Attestation (WUA)** is present and that the **European Business Wallet Owner Identification (EBWOID)** is in order. If either check fails, the lifecycle moves to the **Issuance Denied** terminal state. Common reasons for denial include:

- **Missing or invalid Wallet Unit Attestation (WUA):** The holder's wallet does not present a valid attestation, meaning it does not meet the issuer's trust requirements.
- **Missing or invalid European Business Wallet Owner Identification (EBWOID):** The wallet owner identification associated with the credential request cannot be verified.
- **Invalid proof of key possession:** The cryptographic proof provided by the wallet is invalid or missing.
- **Credential uniqueness enforced:** A valid credential of the same type already exists for this holder.

The denial reason is included in the `openid.credential.issuance_denied` webhook payload, enabling developers to surface specific error messages rather than generic failures. The credential exchange record status is set to `issuance_denied`.

### 5.2 Credential deleted

After a credential has been successfully issued and accepted, the holder may choose to permanently remove it from their wallet. This is a holder-initiated action - the holder may no longer require the credential, or may wish to obtain a fresh one.

The issuer receives the `openid.credential.credential_deleted` webhook event, which allows it to update its records accordingly. This can be significant for compliance purposes: an insurance company, for example, may need to record that a policyholder no longer holds the digital policy attestation in their wallet.

## 6.0 OpenID4VC lifecycle in practice: al-world scenarios

The OpenID4VC lifecycle model has direct implications for how real-world applications behave. The following scenarios illustrate how different stages and issuance modes apply across digital identity use cases.

### 6.1 Digital bank account opening with EUDI Wallet

When a customer [opens a new bank account](https://www.igrant.io/demo/open-bank-account.html) using their EUDI Wallet, the bank needs to issue a KYC verification credential after confirming the customer's identity. This is a straightforward **in-time issuance** scenario: the bank has all the information it needs and can issue the credential immediately by calling the [Issue credential](https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-issue-credential) API with `issuanceMode: "InTime"`.

The lifecycle progresses through all six stages in a single flow. The bank's integration can use [webhooks](https://docs.igrant.io/docs/openid4vc-webhooks/) to track when the customer scans the QR code (`offer_received`), when the credential reaches their wallet (`credential_issued`), and when they accept it (`credential_accepted`), updating the onboarding interface at each step. Try the [in-time issuance workflow](https://docs.igrant.io/docs/openID4vci-issue-credential-intime/) to see this in action.

### 6.2 Insurance policy issuance with deferred OpenID4VC credential

When a customer applies for an [insurance policy](https://www.igrant.io/demo/insurance.html), the insurer typically cannot issue the policy credential immediately - it requires time for underwriting, risk assessment, and regulatory checks. This is where **deferred issuance** comes in. This scenario applies equally when the policyholder is an individual using a EUDI Wallet or an organisation using a European Business Wallet - for example, a company receiving a liability insurance credential into its organisational wallet.

The insurance company creates the credential offer with `issuanceMode: "Deferred"`. The customer scans the QR code and the lifecycle reaches the Token Issued stage, but pauses there. Once underwriting is complete, the insurance company calls the [Issue deferred credential](https://docs.igrant.io/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history) API with the `credentialExchangeId` from the original offer. The customer's wallet automatically retrieves the policy credential, and the lifecycle resumes through to Credential Accepted. Follow the [deferred issuance workflow](https://docs.igrant.io/docs/openID4vci-issue-credential-deferred/) for step-by-step guidance.

Meanwhile, the back-office system can track the status of every pending policy credential by calling the [List issuance history](https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-credential-history) API, filtering for records in the `token_issued` state.

### 6.3 Merchant payments with eReceipt and boarding pass credentials

In a [merchant-led payment scenario](https://www.igrant.io/demo/merchant-led-payments-with-receipts-boardingpass.html), a customer purchasing a ferry ticket receives multiple credentials in a single transaction: a payment confirmation, an eReceipt, and a boarding pass. Each credential follows its own lifecycle independently. This scenario is well-suited to European Business Wallets, where an organisation may need to receive and store transactional credentials such as eReceipts or travel documents on behalf of its employees or operations.

Webhook events are particularly valuable here. The merchant's system registers [webhooks](https://docs.igrant.io/docs/openid4vc-webhooks/) and uses the `credential_accepted` events to confirm that each credential has been successfully delivered to the customer's wallet. Only when all three credentials show `credential_accepted` does the merchant's system mark the transaction as fully complete. If any credential shows `issuance_denied`, the system can trigger a retry or alert the support team.

### 6.4 Photo ID issuance with dynamic credential request

When issuing a [Photo ID credential](https://www.igrant.io/photoid.html) - a digital identity based on an electronic Machine-Readable Travel Document (eMRTD) - the issuer, a Qualified Trust Service Provider (QTSP), needs to verify the holder's passport before issuing the Photo ID. This is a **dynamic credential request**: the issuance flow requires the holder to first present an existing credential as proof.

The issuer creates both a Presentation Definition (specifying the passport credential required) and a Credential Definition (specifying the Photo ID to be issued), then links them in a single credential offer. When the holder scans the QR code, their wallet presents the passport credential and receives the Photo ID in one seamless flow. The [dynamic credential request workflow](https://docs.igrant.io/docs/openID4vci-issue-dynamic-credential-request/) provides a detailed walkthrough of this process.

### 6.5 University degree verification for employment onboarding

An employment agency uses [DCQL (Digital Credentials Query Language)](https://www.igrant.io/demo/openid4vp-dcql-01.html) to request proof of university degrees from job applicants. For successful presentation, the applicant's wallet must contain degree credentials that have completed the full issuance lifecycle, reaching the `credential_accepted` state. Credentials still in an intermediate state (e.g. `credential_acked` but not yet accepted) are not available for presentation.

This illustrates an important principle: the issuance lifecycle directly governs the presentation lifecycle. Understanding when a credential becomes available for use - at the `credential_accepted` stage - is critical for designing end-to-end workflows that span both issuance and verification under OpenID4VC and OpenID for Verifiable Presentations (OpenID4VP) [4].

## 7.0 Conclusion

The OpenID4VC credential issuance lifecycle provides a well-defined, standards-based framework for tracking how credentials move from issuer to holder. The six progressive stages - **Offer Sent**, **Offer Received**, **Token Issued**, **Credential Issued**, **Credential Acknowledged**, and **Credential Accepted** - together with the two terminal states of **Issuance Denied** and **Credential Deleted**, give developers a clear model for building reliable, event-driven credential issuance systems.

Whether building a [banking onboarding system](https://www.igrant.io/demo/open-bank-account.html), an [insurance credentialing platform](https://www.igrant.io/demo/insurance.html), a [payment and receipts solution](https://www.igrant.io/demo/merchant-led-payments-with-receipts-boardingpass.html), or a [government identity programme](https://www.igrant.io/photoid.html), the lifecycle model ensures a consistent and interoperable approach aligned with the European Digital Identity Wallet Architecture and Reference Framework (ARF) [5]. The lifecycle is equally applicable to personal EUDI Wallets and to European Business Wallets, making it the common foundation for credential issuance across the full spectrum of digital identity use cases.

The Organisation Wallet Suite by iGrant.io implements this lifecycle with full support for [in-time](https://docs.igrant.io/docs/openID4vci-issue-credential-intime/), [deferred](https://docs.igrant.io/docs/openID4vci-issue-credential-deferred/), and [dynamic credential request](https://docs.igrant.io/docs/openID4vci-issue-dynamic-credential-request/) issuance modes, backed by comprehensive [APIs](https://docs.igrant.io/docs/developer-apis) and real-time [webhook notifications](https://docs.igrant.io/docs/openid4vc-webhooks/) at every stage of the OpenID4VC credential issuance process.

## References

1. OpenID Foundation (2024), 'OpenID for Verifiable Credential Issuance (OpenID4VCI)', Available at: [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html)
2. IETF (2012), 'RFC 6749 - The OAuth 2.0 Authorization Framework', Available at: [https://datatracker.ietf.org/doc/html/rfc6749](https://datatracker.ietf.org/doc/html/rfc6749)
3. OpenID Foundation (2014), 'OpenID Connect Core 1.0', Available at: [https://openid.net/specs/openid-connect-core-1_0.html](https://openid.net/specs/openid-connect-core-1_0.html)
4. OpenID Foundation (2024), 'OpenID for Verifiable Presentations (OpenID4VP)', Available at: [https://openid.net/specs/openid-4-verifiable-presentations-1_0.html](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html)
5. European Commission (2026), 'The European Digital Identity Wallet Architecture and Reference Framework (ARF) 2.9.0', Available at: [https://eudi.dev/2.9.0/architecture-and-reference-framework-main/](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)
6. iGrant.io (2025), 'Organisation Wallet Suite - OpenID4VC Implementation', Available at: [https://www.igrant.io/demo.html](https://www.igrant.io/demo.html)


---

# Credential Issuance for EUDI Wallets (OpenID4VCI)
Source: https://docs.igrant.io/concepts/openid4vci-credential-issuance/

---
id: openid4vci-credential-issuance
title: "Credential Issuance for EUDI Wallets (OpenID4VCI)"
hide_title: false
description: "OpenID4VCI (OID4VCI) is the protocol EUDI wallets use to receive verifiable credentials. Learn the credential offer, authorization and pre-authorized code flows, with examples."
sidebar_label: Credential Issuance (OpenID4VCI)
keywords: [OpenID4VCI, OID4VCI, oid4vc, OIDC4VCI, OpenID4VC, credential issuance, credential offer, pre-authorized code, authorization code, SD-JWT VC, ISO mdoc, EUDI Wallet, European Business Wallet, verifiable credentials, ARF, iGrant.io]
slug: /openid4vci-credential-issuance/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


<head>
  <title>How Credential Issuance Works in EUDI Wallets (OpenID4VCI)</title>
  <meta name="description" content="OpenID4VCI (OID4VCI) is the protocol EUDI wallets use to receive verifiable credentials. Learn the credential offer, authorization and pre-authorized code flows, with examples." />
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp" />
  <script type="application/ld+json">
    {JSON.stringify({
      "@context": "https://schema.org",
      "@graph": [
        {
          "@type": "Article",
          "headline": "How Credential Issuance Works in EUDI Wallets (OpenID4VCI)",
          "image": "https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp",
          "author": { "@type": "Organization", "name": "iGrant.io", "url": "https://igrant.io" },
          "publisher": {
            "@type": "Organization",
            "name": "iGrant.io",
            "url": "https://igrant.io",
            "logo": { "@type": "ImageObject", "url": "https://igrant.io/assets/images/favicons/preview.png" }
          },
          "dateModified": "2026-07-23",
          "mainEntityOfPage": "https://docs.igrant.io/concepts/openid4vci-credential-issuance/"
        },
        {
          "@type": "FAQPage",
          "mainEntity": [
            {
              "@type": "Question",
              "name": "What is OpenID4VCI?",
              "acceptedAnswer": { "@type": "Answer", "text": "OpenID for Verifiable Credential Issuance (OpenID4VCI, also written OID4VCI or OIDC4VCI) is the OpenID4VC protocol that defines how an issuer delivers a verifiable credential to a holder's wallet. It builds on OAuth 2.0 and is the issuance protocol referenced by the EUDI Wallet Architecture and Reference Framework (ARF)." }
            },
            {
              "@type": "Question",
              "name": "Is OID4VCI the same as OIDC4VCI?",
              "acceptedAnswer": { "@type": "Answer", "text": "Yes. OID4VCI, OIDC4VCI and oid4vc are informal spellings of the same OpenID for Verifiable Credential Issuance specification. The name used by the OpenID Foundation today is OpenID4VCI." }
            },
            {
              "@type": "Question",
              "name": "What is the difference between the authorization code and pre-authorized code flows?",
              "acceptedAnswer": { "@type": "Answer", "text": "In the authorization code flow the wallet sends the holder to the issuer to authenticate before a credential is issued. In the pre-authorized code flow the holder has already been identified out of band, so the wallet presents a pre-authorized code, optionally with a PIN, and receives the credential without a separate login step." }
            },
            {
              "@type": "Question",
              "name": "Which credential formats can OpenID4VCI issue?",
              "acceptedAnswer": { "@type": "Answer", "text": "OpenID4VCI is format agnostic. In EUDI wallet deployments it is commonly used to issue IETF SD-JWT VC and ISO/IEC 18013-5 mdoc credentials, and it also supports W3C Verifiable Credentials." }
            }
          ]
        }
      ]
    })}
  </script>
</head>

_OpenID4VCI (also written OID4VCI or OIDC4VCI) is the protocol an issuer uses to deliver a verifiable credential into an EUDI Wallet or European Business Wallet. This page explains where it sits in the OpenID4VC family, the five-step issuance flow, the authorization code and pre-authorized code grant types, and the credential formats it carries._

## What OpenID4VCI is

OpenID for Verifiable Credential Issuance (OpenID4VCI) is the protocol an issuer uses to deliver a verifiable credential into a holder's wallet. It is one of the three specifications in the [OpenID for Verifiable Credentials (OpenID4VC)](/concepts/openID4vc/) family, alongside OpenID4VP for presentation and SIOPv2 for self-issued authentication.

OpenID4VCI builds on OAuth 2.0, so issuers reuse familiar authorization and token endpoints rather than inventing new ones. The EUDI Wallet Architecture and Reference Framework (ARF) references OpenID4VCI as the issuance protocol for Person Identification Data (PID) and attestations, which makes it the default way credentials reach an EUDI Wallet or a European Business Wallet.

## The issuance flow

Issuance follows five steps. The iGrant.io Organisation Wallet Suite dashboard shows this same sequence as the issuance workflow status for each credential.

1. **Create credential offer.** The issuer creates a Credential Offer specifying the credential type, format, and grant type (Authorization Code or Pre-Authorized Code).
2. **Deliver offer to wallet.** The offer reaches the holder's wallet via a QR code, a deep link, or the Credential Offer endpoint. The wallet then resolves the issuer metadata from the issuer's `/.well-known/openid-credential-issuer` document.
3. **Authorize and issue token.** The wallet authenticates and exchanges the authorization grant for an access token at the issuer's token endpoint.
4. **Issue credential.** The wallet sends a Credential Request with proof of key possession. The issuer signs and returns the credential, or a transaction ID for deferred issuance.
5. **Acknowledgement.** The wallet confirms receipt through the Notification endpoint, and the issuance status moves to credential acknowledged.

## Authorization Code and Pre-Authorized Code flows

OpenID4VCI defines two grant types, chosen when the credential offer is created.

- **Authorization Code flow.** The wallet redirects the holder to the issuer to authenticate and consent before the credential is issued. Use it when the issuer needs to identify the holder at issuance time, for example a bank issuing an account credential.
- **Pre-Authorized Code flow.** The holder has already been identified out of band, so the offer carries a pre-authorized code. The wallet exchanges that code, optionally with a transaction PIN, for an access token and receives the credential without a separate login. Use it when identification already happened in another channel, for example a portal that has just verified the user.

Both grant types converge on the same credential request and delivery steps described above.

## Credential formats

OpenID4VCI is format agnostic; the format is named in the credential offer and in the issuer metadata. EUDI wallet deployments most often use:

- **IETF SD-JWT VC:** a selective-disclosure JSON credential, so the holder can later reveal only the claims a verifier needs.
- **ISO/IEC 18013-5 mdoc (mDL):** the mobile document format used for driving licences and government IDs.

W3C Verifiable Credentials are also supported. Once stored, the credential can be presented to a verifier using [OpenID4VP credential verification](/concepts/openid4vp-credential-verification/).

## Related

- [OpenID4VC: OpenID4VCI, OpenID4VP and SIOPv2 explained](/concepts/openID4vc/)
- [OpenID4VP credential verification](/concepts/openid4vp-credential-verification/)
- [Credential issuance lifecycle (OpenID4VCI)](/concepts/credential-issuance-lifecycle/)

## Frequently asked questions

### What is OpenID4VCI?

OpenID for Verifiable Credential Issuance (OpenID4VCI, also written OID4VCI or OIDC4VCI) is the OpenID4VC protocol that defines how an issuer delivers a verifiable credential to a holder's wallet. It builds on OAuth 2.0 and is the issuance protocol referenced by the EUDI Wallet Architecture and Reference Framework (ARF).

### Is OID4VCI the same as OIDC4VCI?

Yes. OID4VCI, OIDC4VCI and oid4vc are informal spellings of the same OpenID for Verifiable Credential Issuance specification. The name used by the OpenID Foundation today is OpenID4VCI.

### What is the difference between the authorization code and pre-authorized code flows?

In the authorization code flow the wallet sends the holder to the issuer to authenticate before a credential is issued. In the pre-authorized code flow the holder has already been identified out of band, so the wallet presents a pre-authorized code, optionally with a PIN, and receives the credential without a separate login step.

### Which credential formats can OpenID4VCI issue?

OpenID4VCI is format agnostic. In EUDI wallet deployments it is commonly used to issue IETF SD-JWT VC and ISO/IEC 18013-5 mdoc credentials, and it also supports W3C Verifiable Credentials.


---

# Credential Verification for EUDI Wallets (OpenID4VP)
Source: https://docs.igrant.io/concepts/openid4vp-credential-verification/

---
id: openid4vp-credential-verification
title: "Credential Verification for EUDI Wallets (OpenID4VP)"
hide_title: false
description: "OpenID4VP (OID4VP) is the protocol EUDI wallet verifiers use to request and validate verifiable presentations. Learn the presentation request, VP token response and verification flow, with examples."
sidebar_label: Credential Verification (OpenID4VP)
keywords: [OpenID4VP, OID4VP, OpenID4VC, verifiable presentation, VP token, presentation definition, DCQL, credential verification, verifier, relying party, EUDI Wallet, European Business Wallet, verifiable credentials, ARF, iGrant.io]
slug: /openid4vp-credential-verification/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


<head>
  <title>How Credential Verification Works in EUDI Wallets (OpenID4VP)</title>
  <meta name="description" content="OpenID4VP (OID4VP) is the protocol EUDI wallet verifiers use to request and validate verifiable presentations. Learn the presentation request, VP token response and verification flow, with examples." />
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp" />
  <script type="application/ld+json">
    {JSON.stringify({
      "@context": "https://schema.org",
      "@graph": [
        {
          "@type": "Article",
          "headline": "OpenID4VP: How Credential Verification Works in EUDI Wallets",
          "image": "https://docs.igrant.io/img/cDocs/eudi-wallet-with-openid4vc.webp",
          "author": { "@type": "Organization", "name": "iGrant.io", "url": "https://igrant.io" },
          "publisher": {
            "@type": "Organization",
            "name": "iGrant.io",
            "url": "https://igrant.io",
            "logo": { "@type": "ImageObject", "url": "https://igrant.io/assets/images/favicons/preview.png" }
          },
          "dateModified": "2026-07-23",
          "mainEntityOfPage": "https://docs.igrant.io/concepts/openid4vp-credential-verification/"
        },
        {
          "@type": "FAQPage",
          "mainEntity": [
            {
              "@type": "Question",
              "name": "What is OpenID4VP?",
              "acceptedAnswer": { "@type": "Answer", "text": "OpenID for Verifiable Presentations (OpenID4VP, also written OID4VP) is the OpenID4VC protocol a verifier uses to request verifiable credentials from a holder's wallet and validate the presentation that comes back. It is the presentation counterpart to OpenID4VCI and is referenced by the EUDI Wallet Architecture and Reference Framework (ARF)." }
            },
            {
              "@type": "Question",
              "name": "What is a VP token?",
              "acceptedAnswer": { "@type": "Answer", "text": "A VP token (vp_token) is the value the wallet returns in the Authorization Response. It carries one or more verifiable presentations that satisfy the verifier's request, which the verifier then checks cryptographically." }
            },
            {
              "@type": "Question",
              "name": "What is the difference between a Presentation Definition and a DCQL query?",
              "acceptedAnswer": { "@type": "Answer", "text": "Both let a verifier state which credentials and claims it needs. Presentation Exchange definitions were used in earlier drafts, while DCQL (Digital Credential Query Language) is the JSON query language introduced in OpenID4VP 1.0 and preferred for new EUDI wallet deployments." }
            },
            {
              "@type": "Question",
              "name": "What does the verifier check when validating a presentation?",
              "acceptedAnswer": { "@type": "Answer", "text": "The verifier validates the VP token by checking the issuer and holder signatures, the credential status such as revocation, and that the presentation conforms to the request it sent. It then acknowledges receipt." }
            }
          ]
        }
      ]
    })}
  </script>
</head>

_OpenID4VP (also written OID4VP) is the protocol a verifier uses to request verifiable credentials from an EUDI Wallet or European Business Wallet and validate what comes back. This page explains where it sits in the OpenID4VC family, the four-step verifier flow, how the verifier states its requirements with a Presentation Definition or DCQL query, and what it checks before trusting a presentation._

## What OpenID4VP is

OpenID for Verifiable Presentations (OpenID4VP) is the protocol a verifier, also called a Relying Party, uses to request credentials from a holder's wallet and validate the presentation returned. It is one of the three specifications in the [OpenID for Verifiable Credentials (OpenID4VC)](/concepts/openID4vc/) family, and it is the presentation counterpart to [OpenID4VCI credential issuance](/concepts/openid4vci-credential-issuance/).

Like the rest of the family, OpenID4VP builds on OAuth 2.0 and OpenID Connect patterns. The EUDI Wallet Architecture and Reference Framework (ARF) references OpenID4VP as the protocol for presenting Person Identification Data (PID) and attestations to verifiers.

## The verification flow

Verification follows four steps. The iGrant.io Organisation Wallet Suite dashboard shows this same sequence as the verification workflow status for each request.

1. **Create presentation request.** The verifier (Relying Party) creates an Authorization Request specifying the required credentials via a Presentation Definition or a DCQL query.
2. **Deliver request to wallet.** The request reaches the holder's wallet via a QR code, a deep link, or direct post. The wallet receives and parses the Authorization Request.
3. **Receive authorization response.** The wallet submits an Authorization Response containing the VP token, with the verifiable presentation or presentations, to the verifier's response endpoint.
4. **Verify and process presentation.** The verifier validates the VP token by checking signatures, credential status, and conformance to the presentation request, then acknowledges receipt.

## Presentation Definition and DCQL

The verifier states which credentials and claims it needs in the presentation request. There are two ways to express that requirement:

- **Presentation Definition:** the Presentation Exchange format used in earlier OpenID4VP drafts.
- **DCQL (Digital Credential Query Language):** the JSON query language introduced in OpenID4VP 1.0 and preferred for new EUDI wallet deployments. See the [DCQL overview](/docs/dcql-overview/) and the [DCQL concepts article](/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/), and try the [live DCQL demos](https://igrant.io/demo.html?filter=tech-dcql).

Either way, the wallet uses the requirement to select matching credentials and to drive selective disclosure, so the holder shares only the claims the verifier asked for.

## What the verifier checks

Before trusting a presentation, the verifier validates the VP token on three points:

- **Signatures:** the issuer signature on each credential and the holder's proof of possession.
- **Credential status:** whether the credential is still valid, for example checking revocation against a status list or registry.
- **Conformance:** that the returned presentation matches the credentials and claims the verifier requested.

Once these pass, the verifier accepts the presentation and acknowledges receipt.

## Related

- [OpenID4VC: OpenID4VCI, OpenID4VP and SIOPv2 explained](/concepts/openID4vc/)
- [OpenID4VCI credential issuance](/concepts/openid4vci-credential-issuance/)
- [DCQL overview](/docs/dcql-overview/)
- [Send and verify credentials with OpenID4VP (API guide)](/docs/openID4vc-send-verify-credentials/)

## Frequently asked questions

### What is OpenID4VP?

OpenID for Verifiable Presentations (OpenID4VP, also written OID4VP) is the OpenID4VC protocol a verifier uses to request verifiable credentials from a holder's wallet and validate the presentation that comes back. It is the presentation counterpart to OpenID4VCI and is referenced by the EUDI Wallet Architecture and Reference Framework (ARF).

### What is a VP token?

A VP token (vp_token) is the value the wallet returns in the Authorization Response. It carries one or more verifiable presentations that satisfy the verifier's request, which the verifier then checks cryptographically.

### What is the difference between a Presentation Definition and a DCQL query?

Both let a verifier state which credentials and claims it needs. Presentation Exchange definitions were used in earlier drafts, while DCQL (Digital Credential Query Language) is the JSON query language introduced in OpenID4VP 1.0 and preferred for new EUDI wallet deployments.

### What does the verifier check when validating a presentation?

The verifier validates the VP token by checking the issuer and holder signatures, the credential status such as revocation, and that the presentation conforms to the request it sent. It then acknowledges receipt.


---

# Revocation chaining in the EUDI Wallet: How revoking a Wallet Unit reaches the PID
Source: https://docs.igrant.io/concepts/revocation-chaining/

---
id: revocation-chaining
title: "Revocation chaining in the EUDI Wallet: How revoking a Wallet Unit reaches the PID"
hide_title: true
description: "How revocation reaches the PID in the EUDI Wallet: Token Status Lists, the 24-hour re-check, implicit verification, and the risk-analysed keystore case."
keywords: [revocation chaining, Wallet Unit revocation, PID revocation, Token Status List, OAuth status list, WIA, Wallet Instance Attestation, Key Attestation, KA, WUA, Wallet Unit Attestation, PID Provider, Relying Party, WSCD, keystore, maintenance period, 24 hour check, EUDI Wallet, European Business Wallet, eIDAS 2.0, EUDI ARF 2.9.0, TS3, CIR 2024/2977, OpenID4VCI, iGrant.io]
slug: /revocation-chaining/
image: /img/cDocs/revocation-chaining.jpg
sidebar_label: Revocation chaining
sidebar_position: 7
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Revocation chaining in the EUDI Wallet | iGrant.io</title>
  <meta name="description" content="How revocation reaches the PID in the EUDI Wallet: Token Status Lists, the 24-hour re-check, implicit verification, and the risk-analysed keystore case."/>
  <meta property="og:title" content="Revocation chaining in the EUDI Wallet: how revoking a Wallet Unit reaches the PID"/>
  <meta name="twitter:card" content="summary_large_image"/>
</head>

# Revocation chaining: How revoking a Wallet Unit reaches the PID and other EAAs

**For:** _Developers, solution architects, and product managers building or integrating EUDI Wallet issuance, PID provision, and verification flows, who need to understand what actually happens when a wallet is lost, stolen, or compromised._

Revoking a PID is not a single switch. When a Wallet Unit is lost or breached, the credentials already issued to it have to lose their validity too, but no single party can flip them all at once. Instead, revocation travels down a chain: the Wallet Provider revokes the Wallet Unit, the PID Provider notices and revokes the PID, and the Relying Party, checking only the PID, sees the result. This article explains that chain, why it is built the way it is, and how each link is held together by the specifications.

:::tip Try it, and read on
You can watch every step of it, and try each scenario yourself, in the [Revocation Chaining Simulator](https://eudi-wallet-wua-playground.igrant.io/revocation-chaining-simulator).

This article builds on two companions: the [Wallet Unit Attestation (WUA)](/concepts/wallet-unit-attestation/) and [WSCA and WSCD](/concepts/wallet-secure-cryptographic-application-device/).
:::

## 1.0 The problem: Revocation is not a single action

In the EUDI Wallet ecosystem no one party owns the whole picture `[1]`. The Wallet Provider makes the wallet, but it never sees the contents: it cannot read, let alone revoke, the PID stored inside. The PID Provider issued the PID, but it does not run the device and cannot tell, on its own, that the phone was stolen last night. The Relying Party trusts a PID at presentation time, but it has never met the wallet and is not allowed to see the wallet's own attestations.

So when a device is lost, three different actors each hold one piece of the answer, and the design has to make them act in the right order without any of them overstepping. That ordered propagation is what we call revocation chaining.

A useful way to hold it in mind: the Wallet Provider knows the wallet is gone, the PID Provider is the only one who can revoke the PID, and the Relying Party is the only one who needs the final answer. Chaining is how a fact known at the top reaches the party at the bottom.

## 2.0 The chain in one picture

<div style={{maxWidth: '760px', margin: '0'}}>

![The revocation chain in six steps: a cause is raised, the Wallet Provider revokes the Wallet Unit by setting the WIA and KA status-list indices, the WIA and KA status flip, the PID Provider polls those indices every 24 hours and revokes the PID, the PID status flips, and the Relying Party sees a revoked PID.](./revocation-chaining-01-chain.png)

</div>

*Figure 01: Revocation propagates in six steps. A cause is raised, the Wallet Provider revokes the Wallet Unit by setting the WIA and, where relevant, KA status-list indices, the PID Provider polls those indices every 24 hours and revokes the PID, and the Relying Party, checking only the PID status, sees a revoked credential. Two links hold the chain together, marked A and B.*

The chain has six steps and, crucially, two links where responsibility passes from one party to the next. Everything else is plumbing. Get the two links right and the rest follows.

**Try it:** open the simulator in [Single](https://eudi-wallet-wua-playground.igrant.io/revocation-chaining-simulator) mode, pick a cause, and press *Revoke the Wallet Unit*. Watch the outcome propagate down the six stages, and click any WIA, KA, or PID to read the real, signed token that carries its status reference.

## 3.0 The two links that hold the chain together

### 3.1 Link A: From Wallet Unit status to the PID Provider's decision

The first link is a legal obligation made technical. A PID Provider must check the revocation status of both the WIA and the KA it received during issuance, at least once every 24 hours, for the entire validity period of the PID; if either has been revoked, it must revoke the PID `[2]` `[3]`. This is what turns "the Wallet Provider revoked the wallet" into "the PID is now revoked". The Wallet Provider never touches the PID; it only changes the status of the Wallet Unit, and the PID Provider does the rest.

### 3.2 Link B: From PID status to the Relying Party

The second link is what makes the whole scheme usable at presentation time. A Relying Party checks only the PID's own status; it never sees the WIA or the KA. The ARF is explicit that this is enough: by verifying the revocation status of the PID, the Relying Party implicitly verifies the revocation status of the Wallet Unit `[1]`. The chain collapses a multi-party trust question into a single status check that any Relying Party already knows how to make.

## 4.0 What makes the chain possible: status lists and the maintenance period

### 4.1 Three Token Status Lists, two owners

Every WIA, KA, and PID carries a reference to an entry in a Token Status List `[4]`: a published, indexed array where each position records whether one attestation is valid or revoked. Revoking something does not change the token in the holder's wallet; it flips the bit at that token's index in the list the issuer publishes.

There are three lists, owned by two parties.

<div style={{maxWidth: '760px', margin: '0'}}>

![Two owners and three status lists: the Wallet Provider maintains the WIA status list and the KA status list and revokes a Wallet Unit by setting the relevant indices; the PID Provider maintains the PID status list and, during its 24-hour check, reads the Wallet Provider lists and sets the PID index if it sees a revocation; a Relying Party reads only the PID list.](./revocation-chaining-02-status-lists.png)

</div>

*Figure 02: The Wallet Provider maintains the WIA status list and the KA status list, and revokes a Wallet Unit by setting the relevant indices. The PID Provider maintains the PID status list; during its 24-hour check it reads the Wallet Provider's lists and, if it sees a revocation, sets the PID's own index. A Relying Party only ever reads the PID list.*

The KA list is worth a closer look. A Wallet Provider can use a type-shared index, where all Key Attestations describing the same [WSCD or keystore](/concepts/wallet-secure-cryptographic-application-device/) category share one index, or a per-KA index, where each Key Attestation has its own `[2]`. The choice matters at scale: with a type-shared index, a single flip revokes every wallet of that type at once.

**Try it:** switch the simulator to [Population](https://eudi-wallet-wua-playground.igrant.io/revocation-chaining-simulator) mode to see all three status lists at once across a fleet of citizens, grouped by key storage (WSCD A, WSCD B, or a device Keystore). Toggle between the type-shared and per-KA index models and revoke a WSCD type to watch one index flip take out an entire group.

### 4.2 The maintenance period

Link A only works if the WIA and KA are still checkable for as long as the PID lives. That is guaranteed by a commitment separate from the token's own short lifetime: the WIA and KA each carry a maintenance period during which the Wallet Provider promises to keep the status entry up to date `[1]` `[2]`. The rule that ties it together is that the PID's technical validity must end before both the WIA maintenance period and the KA maintenance period. A WIA can therefore be valid for only a few hours as a freshness check while its status remains maintainable for the whole life of any PID issued against it.

## 5.0 How the Wallet Provider revokes: causes and granularity

### 5.1 The causes

The Wallet Provider revokes a Wallet Unit at least in these circumstances `[1]`:

- The user asks for it, typically after losing the device or having it stolen.
- The security of the Wallet Unit is breached or compromised, detected through the Wallet Provider's own monitoring.
- A PID Provider requests it because the person using the wallet has died.
- The Wallet Solution is suspended (optionally) or withdrawn (mandatorily).

### 5.2 What gets set, and how widely

Revocation is not all-or-nothing. Depending on the cause, the Wallet Provider sets different indices `[1]`:

- To revoke the whole Wallet Unit, it revokes the Wallet Instance by setting its WIA index.
- If a single Wallet Secure Cryptographic Device is breached, it revokes that device and the Wallet Instance using it.
- If a whole type of device is breached, it revokes every Wallet Instance using a device of that type. With a type-shared KA index this is a single flip.
- If a keystore is breached, it revokes that keystore, and normally the Wallet Instances using it as well.

### 5.3 Revoking narrowly: The keystore case

There is one important exception, and it is the clearest illustration of why the chain is more subtle than "revoke everything". If a keystore is breached, the Wallet Provider may, on the basis of a documented risk analysis, decide not to revoke the Wallet Instance. In that case only the attestations bound to that keystore are impacted, and the presentation of the PID remains available to the user `[1]`.

<div style={{maxWidth: '760px', margin: '0'}}>

![Two outcomes side by side. On the left, a lost device or instance breach: the WIA is revoked, the KA is valid, and the PID is revoked. On the right, a keystore breach with a risk analysis: the WIA is valid, the KA for that keystore is revoked, and the PID stays valid because only keystore-bound attestations are affected.](./revocation-chaining-03-narrow-revocation.png)

</div>

*Figure 03: Two outcomes. On the left, a lost device: the WIA is revoked, so the PID Provider revokes the PID. On the right, a risk-analysed keystore breach: the KA for that keystore is revoked but the WIA stays valid, the PID Provider sees nothing to act on, and the PID keeps working.*

**Try it:** in the simulator, choose the cause *Keystore breach, risk analysis keeps the PID usable* and revoke. The KA index flips red, but the WIA and PID stay green, and the Issuer summary reports zero PIDs revoked. Compare it with *User reports a lost or stolen device* to see the whole chain go red instead.

## 6.0 How the PID Provider keeps the PID in step

Link A is a loop the PID Provider runs for the life of every PID `[2]` `[3]`:

1. At issuance, keep the WIA and KA the wallet presented, along with their status references.
2. At least every 24 hours, fetch each Token Status List and read the bit at the recorded index.
3. Also check that the Wallet Provider has not been suspended or cancelled on its Trusted List.
4. If the WIA is revoked, or the KA is revoked, or the Wallet Provider is suspended or cancelled, revoke the PID.

Because the maintenance period (Section 4.2) guarantees the lists stay answerable for the whole life of the PID, this loop cannot be starved of information. And because the PID Provider writes to its own status list, the revocation it makes is immediately visible to every Relying Party through Link B.

## 7.0 The chain runs one way

Chaining flows downward only. Revoking, expiring, or deleting a PID does not revoke the Wallet Unit; it simply moves the Wallet Unit from the Valid state back to Operational, and expiration and revocation are independent transitions `[1]`. Nor is the obligation universal: only the PID Provider is required to chain revocation from the Wallet Unit. Other Attestation Providers may apply the same 24-hour discipline to give Relying Parties the same assurance, but they are not obliged to.

## 8.0 Try it: The Revocation Chaining Simulator

The [Revocation Chaining Simulator](https://eudi-wallet-wua-playground.igrant.io/revocation-chaining-simulator) turns everything above into something you can operate. It builds real, signed tokens in the browser, so the WIA, KA, and PID you click into genuinely decode and verify.

- **Single** mode traces one citizen through the six-stage chain, showing the result of each step and its exact specification citation.
- **Population** mode applies the same cause to a fleet of citizens over the three Token Status Lists, so you can see a WSCD type breach revoke a whole cohort while a single loss revokes just one, and watch the Issuer's behaviour summarised as "revoked N of M".

Suggested experiments:

- Revoke with *lost or stolen device* and follow the red result down the chain.
- Switch to *Keystore breach, risk analysis keeps the PID usable* and confirm the PID survives.
- In Population mode, flip between type-shared and per-KA KA indices and revoke a WSCD type to feel the difference in blast radius.
- Click a PID to see its own `status` claim, the index the PID Provider flips in Link A.

## 9.0 Conclusion

Revocation chaining is the mechanism that lets a decentralised ecosystem behave coherently when a wallet is lost. No single party revokes everything; instead, the Wallet Provider changes the Wallet Unit's status, an obligation (Link A) turns that into a PID revocation, and a single status check (Link B) delivers the result to the Relying Party. Token Status Lists and the maintenance-period commitment are what make the links reliable, and the granularity rules, including the risk-analysed keystore case, are what keep revocation proportionate. If you remember one sentence: revoking a Wallet Unit does not revoke a PID directly, it obliges the PID Provider to, and the Relying Party only ever needs to ask about the PID.

## References

1. European Digital Identity Wallet Architecture and Reference Framework (ARF) 2.9.0. See in particular Sections 4.6.4, 4.6.6, 6.5.3.4, 6.5.3.5, 6.5.4.2, and 6.6.2.4.
2. Technical Specification 3: Wallet Unit Attestation (TS3), v1.5. See Sections 2.4.2, 2.4.3, 2.5.1, and 2.5.2.
3. Commission Implementing Regulation (EU) 2024/2977, Article 5(4)(b): a PID Provider must revoke a PID when the Wallet Unit to which it was issued is revoked.
4. IETF Token Status List (OAuth Status List), the status mechanism referenced by TS3 for WIAs, KAs, and issued credentials.
5. OpenID for Verifiable Credential Issuance (OpenID4VCI) v1.0, the issuance protocol that TS3 profiles.
6. Regulation (EU) 2024/1183 (eIDAS 2.0), the regulatory basis for the EUDI Wallet.


---

# WSCD and WSCA in the EUDI Wallet: where the keys live and how they are protected
Source: https://docs.igrant.io/concepts/wallet-secure-cryptographic-application-device/

---
id: wallet-secure-cryptographic-application-device
title: "WSCD and WSCA in the EUDI Wallet: where the keys live and how they are protected"
hide_title: true
description: "What the Wallet Secure Cryptographic Device (WSCD) and Application (WSCA) are in the EUDI Wallet: the Secure Cryptographic Interface, the four WSCD architectures, ISO/IEC 18045 levels, and how they underpin the Wallet Unit Attestation (WUA)."
keywords: [Wallet Secure Cryptographic Application, WSCA, Wallet Secure Cryptographic Device, WSCD, Secure Cryptographic Interface, SCI, secure element, HSM, eSIM, eSE, JavaCard applet, key attestation, Wallet Unit Attestation, WUA, EUDI Wallet, European Business Wallet, eIDAS 2.0, EUDI ARF, ISO 18045, level of assurance high, iGrant.io, WSCD architectures, remote WSCD, local native WSCD, keystore, QSCD, Key Attestation, OpenID4VCI, ISO/IEC 18045, Level of Assurance High, PID, QEAA, EUDI ARF 2.9.0]
slug: /wallet-secure-cryptographic-application-device/
image: /img/cDocs/wallet-secure-cryptographic-application-device.jpg
sidebar_label: WSCA and WSCD
sidebar_position: 6
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>WSCD and WSCA in the EUDI Wallet | iGrant.io</title>
  <meta name="description" content="What the Wallet Secure Cryptographic Device (WSCD) and Application (WSCA) are in the EUDI Wallet: the Secure Cryptographic Interface, the four WSCD architectures, ISO/IEC 18045 levels, and how they underpin the Wallet Unit Attestation (WUA)."/>
  <meta property="og:title" content="WSCD and WSCA in the EUDI Wallet: where the keys live and how they are protected"/>
  <meta name="twitter:card" content="summary_large_image"/>
</head>

# WSCA and WSCD: where the EUDI Wallet's keys actually live and how they are protected

This article explains the **Wallet Secure Cryptographic Device (WSCD)** and the **Wallet Secure Cryptographic Application (WSCA)**, the secure hardware and software layer in which an EUDI Wallet generates and protects the cryptographic keys that bind its credentials. It is grounded in the European Digital Identity Wallet Architecture and Reference Framework (ARF) [1], the ARF discussion on the secure cryptographic interface between the Wallet Instance and the WSCA [2], and the EUDI Technical Specification 3 (TS3) for Wallet Unit Attestation [3].

It is a companion to our [Wallet Unit Attestation (WUA)](https://docs.igrant.io/concepts/wallet-unit-attestation/) article. The WUA's Key Attestation asserts that a wallet's keys live in a certified WSCD at a stated level of assurance. This page explains what that device and its application actually are, so that the attestation has something concrete to point at.

**Target audience:** Developers, solution architects, and product managers building or integrating EUDI Wallet and European Business Wallet issuance and signing flows.

## 1.0 Where the keys actually live[​](#10-where-the-keys-actually-live "Direct link to 1.0 Where the keys actually live")

Every credential an EUDI Wallet holds is only as trustworthy as the private key it is bound to. A Person Identification Data (PID) credential, a Qualified Electronic Attestation of Attributes (QEAA), or an organisational attestation in a [European Business Wallet](https://docs.igrant.io/concepts/european-business-wallets/) is presented by proving control of a key. If that key could be copied, extracted, or used by software the user never authorised, the credential would be worthless, no matter how carefully it was issued.

So the ARF does not leave key protection to the wallet app. It places keys inside a dedicated, certified, tamper-resistant component and keeps the app at arm's length from them. That component is the **Wallet Secure Cryptographic Device (WSCD)**, and the secure application that runs on it is the **Wallet Secure Cryptographic Application (WSCA)**. Together, they are the parts of the wallet that the ordinary user never sees and that an issuer cares about most.

<div style={{maxWidth: '760px', margin: '0'}}>

![The secure cryptographic stack inside an EUDI Wallet: the Wallet Instance talks through the Secure Cryptographic Interface to the WSCA, which runs on the tamper-proof WSCD where keys are generated and stored. The Wallet Provider issues a Key Attestation vouching for these keys, which an issuer checks before binding a credential.](./wsca-wscd-architecture.png)

</div>

*Figure 01: The secure cryptographic stack. The Wallet Instance reaches keys only through the Secure Cryptographic Interface, the WSCA performs the operations, and the WSCD holds the key material.*

The principle is simple to state and important to keep in mind throughout: **the keys are generated inside the WSCD and never leave it**. The Wallet Instance requests that operations be performed; it does not hold the private key itself.

## 2.0 What problem do the WSCD and WSCA solve?[​](#20-what-problem-do-the-wscd-and-wsca-solve "Direct link to 2.0 What problem do the WSCD and WSCA solve?")

The WUA article frames an issuer's central worry as a single question: *are the keys safe?* The WSCD and WSCA are the components that let the honest answer be "yes". They address three concerns.

- **Isolation.** The private keys must be generated in and remain within a protected environment that the wider operating system, the wallet app, and any malware on the device cannot access. Reading or exporting a key must be infeasible even for a sophisticated attacker with the device in hand.
- **Controlled use.** Keys may only be used for sanctioned operations, typically after the user has authenticated with a gesture such as a PIN or biometric. The WSCA mediates this so that signing occurs based on the user's intent rather than silently in the background.
- **Provable protection.** It is not enough for keys to be safe; an issuer with no prior relationship to the wallet must be able to *verify* that they are safe. The protection level of the WSCD has to be certified and then asserted in a way the issuer can check. This is exactly what the Key Attestation does, in addition to the WSCD described here.

In a closed system, a provider could simply trust its own hardware. The EUDI ecosystem is open by design, as the [WUA article](https://docs.igrant.io/concepts/wallet-unit-attestation/) explains, so the protection has to be both real and demonstrable to strangers.

## 3.0 The two components and the interface between them[​](#30-the-two-components-and-the-interface-between-them "Direct link to 3.0 The two components and the interface between them")

The secure layer is not one thing. It is a device, an application that runs on that device, and a carefully guarded interface that connects it to the rest of the wallet.

### 3.1 Wallet Secure Cryptographic Device (WSCD)[​](#31-wallet-secure-cryptographic-device-wscd "Direct link to 3.1 Wallet Secure Cryptographic Device (WSCD)")

The **WSCD** is trusted hardware that provides a secure environment and storage for cryptographic assets such as keys and runs the WSCA [1]. It is tamper-proof and duplication-proof: the design goal is that key material cannot be extracted or cloned, even by an attacker with physical possession of the device.

The ARF describes the WSCD in two parts [1]:

- the **WSCD hardware**, the physical component issued by the WSCD vendor, such as a secure element or a hardware security module; and
- the **WSCD firmware**, the security-related software supplied by the vendor, such as the operating system and cryptographic libraries that run on that hardware.

The WSCD is the *root of the assurance* the rest of the system relies on. When the Key Attestation states that keys are at the `iso_18045_high` level, it is making a claim about this device and its certification.

### 3.2 Wallet Secure Cryptographic Application (WSCA)[​](#32-wallet-secure-cryptographic-application-wsca "Direct link to 3.2 Wallet Secure Cryptographic Application (WSCA)")

The **WSCA** is the secure application that runs on and uses the functions of the WSCD [1]. It manages the critical assets, generating keys, performing signatures, and enforcing that keys are only used as permitted. One WSCA is associated with **at most one Wallet Instance**, and it manages the keys for that specific instance [1]. This one-to-one binding matters: it is what lets the ecosystem reason about "this wallet's keys" rather than a shared pool.

What form the WSCA takes depends entirely on the kind of WSCD it runs on, which is the subject of Section 5.

### 3.3 The Secure Cryptographic Interface (SCI)[​](#33-the-secure-cryptographic-interface-sci "Direct link to 3.3 The Secure Cryptographic Interface (SCI)")

The Wallet Instance does not reach into the WSCD directly. It communicates with the WSCA across the **Secure Cryptographic Interface (SCI)**, the channel over which sensitive operations such as key generation and signing are requested, and results returned [1][2]. Keeping this boundary explicit is what allows the same Wallet Instance to work with very different WSCDs, from a chip inside the phone to a remote hardware security module, without the app ever handling raw key material. The ARF considers the security of this interface significant enough to warrant a dedicated discussion [2].

## 4.0 Where they sit in the wallet architecture[​](#40-where-they-sit-in-the-wallet-architecture "Direct link to 4.0 Where they sit in the wallet architecture")

Placing the components in the ARF's architecture makes the relationships concrete. The Wallet Instance is the app the user interacts with, holding the user interface and the issued credentials. Beneath it, across the SCI, sits the WSCA, and beneath that the WSCD with its hardware and firmware. To the side, the Wallet Provider backend issues the Wallet Unit Attestation and provides support and maintenance, while issuers and relying parties connect over the standardised OpenID4VC interfaces.

Two related components are worth distinguishing from the WSCD, because they often appear alongside it in ARF diagrams:

- a **keystore**, the more general store the wallet uses for keys that do not require the full assurance of a WSCD; and
- a **QSCD** (Qualified Signature Creation Device), the device used specifically for qualified electronic signatures, which is a related but distinct certified component.

For the high-assurance binding keys that hold a PID or a (Q)EAA, it is the WSCD and WSCA that carry the weight, and that the WUA attests.

## 5.0 The four deployment options[​](#50-the-four-deployment-options "Direct link to 5.0 The four deployment options")

The ARF does not mandate a single piece of hardware. It allows four implementation options for the WSCD, and a wallet may combine them (a hybrid WSCD) [1]. The WSCA changes shape to match.

<div style={{maxWidth: '760px', margin: '0'}}>

![Four deployment options for the WSCD and its WSCA: Remote (a remote HSM offered as a service), Local external (a smartcard such as an NFC eID card), Local internal (an eSIM or embedded secure element in the device), and Local native (the device maker's built-in secure hardware exposed through the OS). Each requires a different WSCA implementation, and all must be certified to the required level.](./wsca-wscd-deployment-options.png)

</div>

*Figure 02: The four WSCD deployment options, with the form the WSCA takes in each.*

- **Remote.** The WSCD is a remote device, such as a Hardware Security Module (HSM), reached over the network, often offered as a Hardware-Security-Module-as-a-Service. Cryptographic operations and key storage happen in a highly secured data centre, and the WSCA is the server-side application running there.
- **Local external.** The WSCD is a separate secure chip outside the phone, such as a chip-based, NFC-enabled national identity card that the user taps. Here, the WSCA typically takes the form of a dedicated JavaCard applet running on the card.
- **Local internal.** The WSCD is an embedded secure element accessible from inside the device, such as an eSIM or an embedded Secure Element (eSE). The WSCA is again usually a JavaCard applet, this time on the embedded element.
- **Local native.** The WSCD is the device manufacturer's own built-in secure hardware, exposed through the operating system's keystore. The WSCA takes the form of a trusted service application or the platform keystore itself.

Each option trades reach, cost, and assurance differently. A remote HSM can serve devices without secure hardware of their own; a smartcard adds a tangible token but requires the user to carry it; native hardware is the most seamless but depends on what the manufacturer ships. What they share is the requirement to be **certified** to the level the use case demands.

## 6.0 Levels of assurance and certification[​](#60-levels-of-assurance-and-certification "Direct link to 6.0 Levels of assurance and certification")

Not all secure hardware is equal, so the ARF ties key protection to measurable, certified levels rather than vendor claims. The relevant scale is the attack-potential resistance defined in ISO/IEC 18045, and for the highest-value credentials, the requirement is the **high** level [1][3].

This is where the WSCD meets the WUA in practice. TS3 requires that, for a PID, the keys report `iso_18045_high` and that the attestation carries a mandatory `certification` claim describing the scheme, the evaluated requirements, and the level [3]. In other words, the abstract promise "these keys are safe" is reduced to a checkable statement about *which certified WSCD* the keys live in and *to what level* it was evaluated. An issuer that needs the high level will refuse keys that can only demonstrate a lower one.

Certification also explains why the WSCD is a standing concern rather than a one-off. If a vulnerability is later found in a particular WSCD model, the affected Key Attestations must be revoked, and because issuers recheck revocation status regularly, the credentials bound to that hardware are no longer trusted [3]. The security of the device is therefore tracked across the credential's whole life, not just at issuance.

## 7.0 How this connects to the Wallet Unit Attestation[​](#70-how-this-connects-to-the-wallet-unit-attestation "Direct link to 7.0 How this connects to the Wallet Unit Attestation")

This page describes the components; the [WUA](https://docs.igrant.io/concepts/wallet-unit-attestation/) is how their trustworthiness travels to an issuer. The two fit together as a single chain.

<div style={{maxWidth: '760px', margin: '0'}}>

![The trust chain from secure hardware to an issuer decision: keys are generated inside the certified WSCD and WSCA; the Wallet Provider issues a Key Attestation stating that those keys live in that certified WSCD; the Key Attestation, together with the Wallet Instance Attestation, forms the WUA presented at issuance; and the issuer verifies the chain to the Trusted List and the assurance level before binding the credential.](./wsca-wscd-wua-trust-chain.png)

</div>
*Figure 03: The WSCD is the physical root of the assurance of the Key Attestation claims. Without a certified WSCD, there is nothing for the WUA to vouch for.*

Reading the chain from the bottom up:

1. **The WSCD and WSCA** generate and hold the keys in certified hardware so that the keys cannot leave the device.
2. **The Key Attestation** (the WUA's [Key Attestation](https://docs.igrant.io/concepts/wallet-unit-attestation/#32-key-attestation-ka)) is a signed statement from the Wallet Provider that the listed keys were generated in, and are bound to, the same certified WSCD at a stated level.
3. **The WUA** combines that Key Attestation with the [Wallet Instance Attestation](https://docs.igrant.io/concepts/wallet-unit-attestation/#31-wallet-instance-attestation-wia) and is presented during [OpenID4VCI issuance](https://docs.igrant.io/concepts/credential-issuance-lifecycle/).
4. **The issuer** verifies the chain up to the Wallet Provider Trusted List and checks that the assurance signals meet the use case, as set out in the WUA article's [verification steps](https://docs.igrant.io/concepts/wallet-unit-attestation/#60-how-an-issuer-verifies-a-wua), before binding a credential.

The short version: the WSCD is the thing that is true, and the WUA is how that truth is proven to someone who has never met your wallet.

## 8.0 In practice: what changes with the WSCD[​](#80-in-practice-what-changes-with-the-wscd "Direct link to 8.0 In practice: what changes with the WSCD")

The deployment choice has real consequences for builders and for users.

### 8.1 Issuing a PID at the high level of assurance[​](#81-issuing-a-pid-at-the-high-level-of-assurance "Direct link to 8.1 Issuing a PID at the high level of assurance")

A government PID Provider needs keys at `iso_18045_high`. Only a WSCD certified to that level, whether a native secure element, an embedded element, a smartcard, or a remote HSM, can satisfy it. If the device a user holds cannot reach the high level natively, the wallet must fall back to another option, for example, a remote HSM or an external smartcard, before a PID can be bound. The WSCD choice is therefore not just an implementation detail; it gates which credentials a given device can hold.

### 8.2 A device with no secure hardware of its own[​](#82-a-device-with-no-secure-hardware-of-its-own "Direct link to 8.2 A device with no secure hardware of its own")

An older or lower-cost phone may lack a secure element that the wallet can use. The remote WSCD option allows such a device to retain high-assurance credentials by performing key operations in a certified HSM accessible over the network, with the WSCA running server-side. The user experience stays the same; the assurance comes from the data centre rather than the handset.

### 8.3 An organisational key in a European Business Wallet[​](#83-an-organisational-key-in-a-european-business-wallet "Direct link to 8.3 An organisational key in a European Business Wallet")

The same components serve organisations. When a [European Business Wallet](https://docs.igrant.io/concepts/european-business-wallets/) holds an organisational attestation, the binding keys still live in a WSCD and are operated by a WSCA, and the same Key Attestation vouches for them. A remote HSM is a common choice here, since business processes often run on servers rather than a single handset.

### 8.4 Recovering from a hardware vulnerability[​](#84-recovering-from-a-hardware-vulnerability "Direct link to 8.4 Recovering from a hardware vulnerability")

If a flaw is found in a WSCD model, the protection asserted by Key Attestation is no longer warranted. The Wallet Provider revokes the affected Key Attestations, and issuers stop trusting the credentials bound to that hardware at the next revocation check. The WSCD's certification status is, in effect, a live input to every trust decision.

## 9.0 Conclusion[​](#90-conclusion "Direct link to 9.0 Conclusion")

The WSCD and WSCA are the EUDI Wallet's foundation of trust in hardware. The **WSCD** is the certified, tamper-proof device where keys are generated and stored; the **WSCA** is the secure application that runs on it and performs the cryptographic operations for exactly one Wallet Instance; and the **Secure Cryptographic Interface** is the guarded boundary that lets the wallet app use those keys without ever holding them. The ARF allows four ways to deploy this layer, remote, local external, local internal, and local native, each certified to a measurable level of assurance. Everything the [Wallet Unit Attestation](https://docs.igrant.io/concepts/wallet-unit-attestation/) claims about key protection ultimately rests on this layer: the WSCD is the fact, and the WUA is the proof.

## References[​](#references "Direct link to References")

1. European Commission, 'The European Digital Identity Wallet Architecture and Reference Framework (ARF)', Available at: <https://eudi.dev/latest/architecture-and-reference-framework-main/>
2. European Commission (2026), 'ARF Discussion Topic P: Secure Cryptographic Interface between the Wallet Instance and the WSCA', Available at: <https://eudi.dev/latest/discussion-topics/p-secure-cryptographic-interface-between-the-Wallet-Instance-and-WSCA/>
3. EU Digital Identity Wallet (2026), 'Technical Specification 3 (TS3): Wallet Unit Attestation', Available at: <https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts3-wallet-unit-attestation.md>
4. European Parliament and Council (2024), 'Regulation (EU) 2024/1183 (eIDAS 2.0)', Available at: <https://eur-lex.europa.eu/eli/reg/2024/1183/oj>
5. iGrant.io (2026), 'Wallet Unit Attestation (WUA)', Available at: <https://docs.igrant.io/concepts/wallet-unit-attestation/>


---

# Wallet Unit Attestation (WUA): How the EUDI Wallet proves it is genuine and its keys are protected
Source: https://docs.igrant.io/concepts/wallet-unit-attestation/

---
id: wallet-unit-attestation
title: "Wallet Unit Attestation (WUA): How the EUDI Wallet proves it is genuine and its keys are protected"
hide_title: false
description: "A developer and architect's guide to the Wallet Unit Attestation (WUA) in the EUDI Wallet: what it is, how the Wallet Instance Attestation and Key Attestation work, how they are used during OpenID4VCI issuance, and how the TS3 profile tightens the rules."
sidebar_label: Wallet Unit Attestation (WUA)
keywords: [Wallet Unit Attestation, WUA, Wallet Instance Attestation, WIA, Key Attestation, KA, OpenID4VCI, OpenID4VC, key attestation jwt, attested_keys, batch_size, WSCD, EUDI Wallet, European Business Wallet, eIDAS 2.0, ARF 2.9.0, TS3, ETSI TS 119 472-3, PID, proof of possession, iGrant.io]
slug: /wallet-unit-attestation/
image: /img/cDocs/wallet-unit-attestation.png
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Wallet Unit Attestation (WUA) in the EUDI Wallet | iGrant.io</title>
  <meta name="description" content="A clear guide to the Wallet Unit Attestation (WUA) in the EUDI Wallet: the Wallet Instance Attestation (WIA) and Key Attestation (KA), how they are carried during OpenID4VCI issuance, the TS3 profile, verification, and lifecycle."/>
</head>

This article explains the **Wallet Unit Attestation (WUA)**, the mechanism by which an EUDI Wallet proves to an issuer that it is a genuine, certified wallet and that the keys about to hold a credential are protected to the required level of assurance. It is grounded in the European Digital Identity Wallet Architecture and Reference Framework (ARF) 2.9.0 [1], the ARF discussion on re-issuance and revocation of Wallet Unit Attestations [2], the EUDI Technical Specification 3 (TS3) for Wallet Unit Attestation [3], and the [OpenID for Verifiable Credential Issuance (OpenID4VC)](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html) specification [4]. It is a companion to our [credential issuance lifecycle (OpenID4VCI)](https://docs.igrant.io/concepts/credential-issuance-lifecycle/) article, where the WUA appears as one of the issuer's validation checks.

To make the concepts tangible, every section links to the live, hands-on **[EUDI Wallet WUA Playground](https://eudi-wallet-wua-playground.igrant.io/)**, where you can generate and inspect the actual payloads.

**Target audience:** Developers, solution architects, and product managers building or integrating EUDI Wallet and European Business Wallet issuance flows.

## 1.0 An ecosystem with no single owner

Europe's digital identity is built, on purpose, as an open and shared ecosystem. You choose your wallet from any certified provider. An issuer places a credential into whatever wallet you happen to use. A verifier later accepts it, anywhere across the member states. No single organisation owns the chain from end to end.

<div style={{maxWidth: '480px', margin: '0'}}>

![The EU Digital Identity Wallet ecosystem: a citizen or wallet user at the centre, connected to the Member State, the Wallet Provider, issuer organisations, and service providers (relying parties or verifiers)](wallet-unit-attestation-ecosystem.png)

</div>

_Figure 01: The EU Digital Identity Wallet ecosystem._

That openness is both the value and the challenge. The issuer almost never built the wallet. It is being asked to place a credential into software made by a different organisation, running on a device it does not control, possibly in another country.

In a closed system this barely arises: if the same company makes the app and runs the service, it trusts its own software and the question never comes up. EUDI is the opposite by design, so trust has to cross organisational and national borders. What is needed is a portable, standard way for any wallet to prove itself to any issuer, with no prior relationship between them.

When a Person Identification Data (PID) Provider or a Qualified Electronic Attestation of Attributes (QEAA) issuer is about to release a high-value credential, it faces a simple but critical question: *is the thing asking for this credential a genuine, certified wallet, and will the credential be bound to keys that live in secure hardware?* A username and password cannot answer that. Neither can a TLS connection on its own. The answer is the **Wallet Unit Attestation (WUA)**.

The WUA is a signed statement, ultimately rooted in the Wallet Provider, that vouches for two things at once: the **authenticity of the wallet instance**, and the **protection level of the cryptographic keys** that will hold the credential. The ARF defines it as the wallet's trust anchor towards issuers and, where required, relying parties [1]. Without it, an issuer cannot distinguish a certified Wallet Unit from a convincing but rogue application.

This article unpacks the WUA into its two building blocks, shows how each is carried during OpenID4VCI issuance, explains how the EUDI TS3 profile tightens the generic OpenID4VCI rules, and walks through how an issuer verifies a WUA and how it behaves over its lifecycle.

This article focuses on the WUA at credential issuance, where it is defined and most visibly used. Wallet authentication towards a relying party at presentation time relies on a separate mechanism and is out of scope here.

## 2.0 What problem does a WUA solve?

Issuing a credential is an act of trust extended by the issuer to the wallet. Three concerns have to be settled before that trust is warranted:

- **Is the wallet genuine?** The issuer needs assurance that the requesting software is an instance of a Wallet Solution that has been certified and is operated by a known Wallet Provider, not a clone or a tampered build.
- **Are the keys safe?** A credential is only as trustworthy as the protection of the private key it is bound to. The issuer needs assurance that the binding keys were generated in, and cannot leave, a suitably certified Wallet Secure Cryptographic Device (WSCD) or key storage component, at the level of assurance the use case demands (for PID, the high level).
- **Can trust be withdrawn?** If a wallet instance or a key store is later found to be compromised, there has to be a way to revoke the attestations so that issuers stop trusting it. This is the subject of ARF discussion Topic C [2].

The WUA answers all three. It lets an issuer make a risk decision on solid, cryptographically verifiable grounds rather than on assumptions. Conceptually, you can explore the "why" behind these requirements on the playground's [Get started](https://eudi-wallet-wua-playground.igrant.io/docs) page.

## 3.0 The two building blocks of a WUA

A WUA is not a single token. It is composed of two attestations, both originating from the Wallet Provider but answering different questions.

<div style={{maxWidth: '760px', margin: '0'}}>

![Wallet Unit Attestation composition: a WUA contains the Wallet Instance Attestation (WIA) and the Key Attestation (KA), both issued and signed by the Wallet Provider, and presented at issuance to the PID or (Q)EAA Issuer](wallet-unit-attestation-fig01.png)

</div>

_Figure 02: The WUA is the combination of a Wallet Instance Attestation and a Key Attestation, both rooted in the Wallet Provider._

### 3.1 Wallet Instance Attestation (WIA)

The **Wallet Instance Attestation** answers *"is this wallet instance genuine and healthy right now?"*. It is issued and signed by the Wallet Provider to a specific wallet instance after the instance has passed the provider's integrity checks. The wallet then proves it controls that instance with a separate proof of possession (the client attestation PoP), signed by the instance's own key [5]. During issuance it is used as **client authentication** at the OAuth 2.0 token endpoint, following the OAuth 2.0 Attestation-Based Client Authentication mechanism (media type `oauth-client-attestation+jwt`) [5]. OpenID4VCI v1.0 normatively references draft 07 of that mechanism [4][5].

Because the property it asserts ("this app is genuine and healthy") can change quickly, the WIA is deliberately **short-lived**: TS3 requires its time-to-live to be under 24 hours (TS3 §2.2.1.1) [3], so the wallet obtains a fresh WIA frequently. You can inspect a decoded WIA on the playground's [Wallet Instance Attestation](https://eudi-wallet-wua-playground.igrant.io/wallet-instance-attestation) page.

### 3.2 Key Attestation (KA)

The **Key Attestation** answers *"are the keys that will hold this credential in certified secure hardware?"*. It is a JWT, signed by the Wallet Provider, that lists one or more public keys in an `attested_keys` array and asserts that they were generated in, and are bound to, the **same** WSCD or key storage component, at a stated attack-potential-resistance level. In generic OpenID4VCI this is the `key-attestation+jwt` structure defined in Appendix D [4].

Crucially, the KA is the part that scales: a single KA can attest **many** keys at once, which is what makes batch issuance possible (Section 4.2). You can decode a KA, and toggle the TS3 profile, on the playground's [Key Attestation](https://eudi-wallet-wua-playground.igrant.io/key-attestation) page.

## 4.0 How a WUA is used during credential issuance

The two building blocks enter the OpenID4VCI flow at two different points.

```mermaid
sequenceDiagram
  participant WU as Wallet Unit
  participant AS as Authorization Server
  participant CI as Credential Issuer
  rect rgb(227, 242, 253)
  Note over WU,AS: Stage A: authenticate the wallet (WIA)
  WU->>AS: 1. Token request, client authentication with the WIA<br/>(client attestation JWT + PoP)
  AS-->>WU: 2. Access token (+ c_nonce)
  end
  rect rgb(232, 245, 233)
  Note over WU,CI: Stage B: bind the credential to an attested key (KA)
  WU->>CI: 3. Credential Request: jwt proof signed with attested_keys[0],<br/>carrying the KA in its key_attestation header
  CI->>CI: 4. Verify WIA, KA and x5c to the Trusted List,<br/>freshness, key_storage_status
  CI-->>WU: 5. One credential per attested key, up to batch_size
  end
```

_Figure 03: Issuance in two stages. Stage A authenticates the wallet with the WIA at the Authorization Server; Stage B binds one credential per attested key using the KA carried in the Credential Request._

### 4.1 Proof of possession and the jwt proof

In OpenID4VCI, the KA is carried inside the Credential Request. The recommended transport is the **`jwt` proof type**: the wallet creates a proof of possession (PoP) for **one** of the attested keys and places the KA in that proof's `key_attestation` JOSE header [4]. The proof JWT is signed by a key identified in its header (via `kid`, `jwk`, or `x5c`), and the issuer validates that signature. This gives the issuer a live demonstration that the wallet actually controls the key material the KA describes.

There is also a standalone `attestation` proof type that conveys a KA **without** any proof of possession. It exists to avoid unnecessary user interaction, but it is the weaker option because it proves no live control of a key. For high-assurance use cases the `jwt` proof with a PoP is preferred. Compare both on the playground's [Proof of possession](https://eudi-wallet-wua-playground.igrant.io/proof-of-possession) page.

### 4.2 Batch and multi-key issuance

This is the part most often misunderstood, so it is worth stating precisely.

A single `jwt` proof carrying a KA with several `attested_keys` is enough to obtain several credentials in one step. OpenID4VCI Appendix F.1 says the issuer "SHOULD issue a Credential for each cryptographic public key specified in the `attested_keys` claim" [4], and Section 14.6 confirms the issuer "determines the number of the Credentials issued ... regardless of number of proofs/keys" [4]. In other words, the batch is driven by the **`attested_keys` array**, not by sending one proof per key.

Two numbers govern the outcome:

- **N**, the number of keys the KA attests.
- **`batch_size`**, the cap the issuer applies. This comes from the issuer's credential metadata, specifically the `credential_reuse_policy.options.batch_size` parameter defined in ETSI TS 119 472-3 [6].

The issuer binds **min(N, `batch_size`)** keys, issuing one copy of the credential per bound key so the wallet can present a fresh key per transaction for better unlinkability. Because the KA is single-use, any attested keys beyond the cap are wasted. Drag N and `batch_size` and watch the counters move on the playground's [Batch issuance](https://eudi-wallet-wua-playground.igrant.io/batch-issuance) page.

## 5.0 OpenID4VCI v1.0 and the TS3 profile

TS3 v1.5 is the EUDI profile of how OpenID4VCI carries a Key Attestation and a proof of possession [3]. The two agree on the big picture (the proof carries the KA in its `key_attestation` header, and a single proof drives the batch), but TS3 tightens several details for the EUDI trust model. The differences that matter in practice:

| Aspect | OpenID4VCI v1.0 [4] | TS3 v1.5 profile [3] |
| --- | --- | --- |
| KA media type (`typ`) | `key-attestation+jwt` (hyphenated) | `keyattestation+jwt` (no hyphen). A known divergence to watch for interoperability. |
| Which key signs the proof | Any attested key, identified by the proof header (`kid` / `jwk`). No fixed position. | MUST be `attested_keys` index 0; the `kid` requirement was removed (TS3 §2.2.2.1). |
| Issuer identity on the KA | `iss` present (the Wallet Provider). | `iss` removed; identity is taken from the `x5c` signing certificate, which chains to the Wallet Provider Trusted List. |
| Key security level | `key_storage` / `user_authentication` on the ISO 18045 scale. | `iso_18045_high` required for a WSCD (for example, for PID). |
| Certification | `certification` is an OPTIONAL URL. | Mandatory; carries the scheme, evaluated requirements, and level. |
| Revocation and maintenance | Optional status reference. | Adds `key_storage_status`, with a status reference and an `exp` maintenance commitment. |

The single most common interoperability snag is the media-type hyphen: a verifier that matches `typ` exactly will reject the other form. See the full rule-by-rule view, side by side with the payloads, on the playground's [OpenID4VCI vs TS3](https://eudi-wallet-wua-playground.igrant.io/openid4vci-vs-ts03) page.

TS3 also explains *why* it asks for only one signature (by `attested_keys[0]`) rather than a per-key proof. Requiring a single signature improves the user experience, since some WSCDs require a user gesture to sign, and it does not weaken security, because the Wallet Provider's signature on the KA already binds every attested key to the same WSCD or keystore (TS3 §2.2.2.1) [3].

## 6.0 How an issuer verifies a WUA

When a Credential Request arrives, the issuer runs a sequence of checks before binding anything:

1. **Authenticate the client with the WIA** at the token endpoint, and confirm it is current and not revoked.
2. **Verify the KA signature**, and validate the `x5c` certificate chain up to the **Wallet Provider Trusted List**. Under TS3 the issuer identity comes from that certificate, not from an `iss` claim [3].
3. **Verify the proof of possession** carried in the `jwt` proof, confirming the wallet controls the signing key (under TS3, `attested_keys[0]`).
4. **Check freshness.** If the issuer provided a `c_nonce`, it must appear in the attestation, which prevents replay [4].
5. **Check the assurance signals**: that `key_storage` and `user_authentication` meet the level the use case requires (for PID, `iso_18045_high`), that `certification` is acceptable, and that `key_storage_status` is satisfactory.

Only when these pass does the issuer issue one credential per bound key, up to `batch_size`. Step through these checks interactively on the playground's [How the issuer verifies](https://eudi-wallet-wua-playground.igrant.io/verification) page.

## 7.0 Lifecycle and maintenance

A WUA is not a one-off artefact; its two parts age differently, and TS3 sets out how trust is kept current [3].

<div style={{maxWidth: '520px', margin: '0'}}>

![WUA lifecycle state diagram: keys are created in the WSCD and the first WIA and KA are issued, reaching the Issued state; from there the revocation status is re-checked at least every 24 hours and re-issuance uses a fresh single-use WIA and KA, until the WUA moves to Revoked when its status is set to revoked, or to Expired when the WIA time-to-live elapses](wallet-unit-attestation-fig03.png)

</div>

_Figure 04: The WUA lifecycle. From the Issued state the attestation is kept current (revocation re-checked at least every 24 hours; re-issuance with a fresh single-use WIA and KA), until it becomes Revoked (status set to revoked) or Expired (WIA time-to-live elapsed)._

- **The WIA is short-lived.** Its time-to-live is under 24 hours (TS3 §2.2.1.1), so the wallet refreshes it frequently. This is appropriate because "the app is genuine and healthy" is a fast-changing claim.
- **The KA is single-use and describes a fixed fact.** "These keys are in this kind of certified secure hardware" does not change day to day, so the KA is not given a short expiry. Instead, a new, previously unused KA is sent on each re-issuance (TS3 §2.4.2).
- **Revocation is the safety net.** A PID Provider must re-check the revocation status of both the WIA and the KA at least once every 24 hours for the credential's validity period (TS3 §2.4.3). A KA must be revoked if a security vulnerability affecting the WSCD or key storage is identified (TS3 §2.5.2), and a Wallet Provider can revoke a wallet instance's attestations when it is no longer trusted [2].
- **Device and app updates.** TS3 does not define triggers specific to an operating-system update or a Wallet App update or reinstall. In practice, change is governed by the mechanisms above: the sub-24-hour WIA means a fresh WIA is obtained soon after any change, and whether a new KA or re-attestation is needed depends on whether the update alters the instance identity or the WSCD keys, which is implementation-specific.

The playground's [FAQ](https://eudi-wallet-wua-playground.igrant.io/faq) collects these lifecycle questions with their exact TS3 section references.

## 8.0 WUA in practice: real-world scenarios

The mechanics above play out in a handful of recurring patterns.

### 8.1 Issuing a PID at the high level of assurance

A government PID Provider receives a Credential Request from a wallet. Before it releases the PID, it authenticates the client with the WIA, validates the KA and its `x5c` chain to the Wallet Provider Trusted List, and confirms that `key_storage` and `user_authentication` report `iso_18045_high`. Only if the keys are shown to live in a high-assurance WSCD does it bind and issue the PID. If the assurance signals fall short, the issuer denies the request. Here the WUA is acting as the issuer's risk gate.

### 8.2 Batch issuance for unlinkable presentations

A wallet wants several copies of the same PID so it can present a different key to each relying party and avoid being tracked. It attests five keys in one KA and sends a single `jwt` proof. The issuer reads `attested_keys`, applies its `batch_size`, and returns one PID bound to each key, up to the cap. One user gesture, one proof, several single-use credentials.

### 8.3 A Wallet Unit Attestation in a European Business Wallet

WUAs are not limited to personal wallets. When a [European Business Wallet](https://docs.igrant.io/concepts/european-business-wallets/) requests an organisational attestation, the same two building blocks apply: a WIA authenticates the business wallet instance, and a KA attests the keys that will hold the organisational credential. The issuer's checks are identical in shape, which is why the lifecycle generalises across individual and business identity.

### 8.4 Withdrawing trust after a key-store vulnerability

A vulnerability is found in a particular WSCD model. Under TS3, the Wallet Provider must revoke the affected Key Attestations (TS3 §2.5.2), and because a PID Provider re-checks the revocation status of the WIA and KA at least every 24 hours (TS3 §2.4.3), the issued credentials stop being trusted without anyone having to reach into each wallet. This is why the WUA is not only an issuance-time check but a standing trust relationship.

## 9.0 Try it: the interactive WUA Playground

Reading about a WUA only takes you so far. The **[EUDI Wallet WUA Playground](https://eudi-wallet-wua-playground.igrant.io/)** lets you generate and inspect the real payloads in the browser, with nothing to install:

- Open the **[WUA Playground](https://eudi-wallet-wua-playground.igrant.io/home)** to set the number of keys and the `batch_size`, then click any **KA**, **proof**, **credential**, or **Credential Request** to read its JSON.
- Toggle "Show the TS3 profile" to diff the generic OpenID4VCI Key Attestation against the EUDI-profiled one, field by field.
- Watch the counters for credentials, WSCD signatures, and bound keys respond as you change the inputs.

It is an illustrative teaching aid: every payload is generated and signed client-side, and every detail links back to the source specification.

## 10.0 Conclusion

The Wallet Unit Attestation is what turns "trust me, I am a wallet" into something an issuer can verify. Its two parts answer two questions: the **WIA** proves the wallet instance is genuine and healthy, and the **KA** proves the binding keys live in certified secure hardware. Together they let an issuer release a PID or a (Q)EAA on solid, cryptographic grounds, support batch issuance from a single proof, and be withdrawn through revocation if trust is lost. TS3 sharpens the generic OpenID4VCI rules for the EUDI ecosystem, most notably by anchoring identity in the Trusted List via `x5c`, mandating high-assurance signals, and standardising on a single proof signed by the first attested key. The interactive playground is the fastest way to build intuition for how all of this looks on the wire.

## References

1. European Commission (2026), 'The European Digital Identity Wallet Architecture and Reference Framework (ARF) 2.9.0', Available at: [https://eudi.dev/2.9.0/architecture-and-reference-framework-main/](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)
2. European Commission (2026), 'ARF Discussion Topic C: Re-issuance and Revocation of Wallet Unit Attestations', Available at: [https://eudi.dev/2.9.0/discussion-topics/c-rr-wallet-unit-attestations/](https://eudi.dev/2.9.0/discussion-topics/c-rr-wallet-unit-attestations/)
3. EU Digital Identity Wallet (2026), 'Technical Specification 3 (TS3): Wallet Unit Attestation', Available at: [https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts3-wallet-unit-attestation.md](https://github.com/eu-digital-identity-wallet/eudi-doc-standards-and-technical-specifications/blob/main/docs/technical-specifications/ts3-wallet-unit-attestation.md)
4. OpenID Foundation (2025), 'OpenID for Verifiable Credential Issuance (OpenID4VC) 1.0', Available at: [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html)
5. IETF (2025), 'OAuth 2.0 Attestation-Based Client Authentication (draft-ietf-oauth-attestation-based-client-auth-07)', Available at: [https://datatracker.ietf.org/doc/html/draft-ietf-oauth-attestation-based-client-auth-07](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-attestation-based-client-auth-07)
6. ETSI (2026), 'ETSI TS 119 472-3 V1.1.1: Electronic Signatures and Trust Infrastructures (ESI); Profiles for Electronic Attestation of Attributes; Part 3: Profiles for issuance of EAA or PID', European Telecommunications Standards Institute.
7. European Parliament and Council (2024), 'Regulation (EU) 2024/1183 (eIDAS 2.0)', Available at: [https://eur-lex.europa.eu/eli/reg/2024/1183/oj](https://eur-lex.europa.eu/eli/reg/2024/1183/oj)
8. iGrant.io (2026), 'EUDI Wallet WUA Playground', Available at: [https://eudi-wallet-wua-playground.igrant.io/](https://eudi-wallet-wua-playground.igrant.io/)


---

# What are EU Digital Identity (EUDI) Wallets
Source: https://docs.igrant.io/concepts/what-is-the-eu-digital-identity-wallet/

---
id: what-is-eudi-wallet
title: "What are EU Digital Identity (EUDI) Wallets"
hide_title: false
description: "Learn what EU Digital Identity (EUDI) Wallets are, what they store, who runs them, and when certified national wallets arrive under eIDAS 2.0 rules."
sidebar_label: What are EUDI Wallets?
keywords: [EU Digital Identity Wallet, EUDI Wallet, what is the EUDI Wallet, EUDI Wallet explained, eIDAS 2.0, Regulation 2024/1183, EU Digital Identity Regulation, implementing acts, PID, Person Identification Data, QEAA, PuB-EAA, EAA, public sector EAA, electronic attestation of attributes, wallet provider, relying party, digital identity wallet, European Business Wallet, selective disclosure, is the EUDI Wallet free, when is the EUDI Wallet available, iGrant.io]
slug: /what-is-the-eu-digital-identity-wallet/
image: /img/cDocs/what-is-eudi-wallet.png
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>What are EU Digital Identity (EUDI) Wallets? | iGrant.io DevDocs</title>
  <meta name="description" content="Learn what EU Digital Identity (EUDI) Wallets are, what they store, who runs them, and when certified national wallets arrive under eIDAS 2.0 rules."/>
  <link rel="canonical" href="https://docs.igrant.io/concepts/what-is-the-eu-digital-identity-wallet/" />
  <meta property="og:type" content="article" />
  <meta property="og:title" content="What are EU Digital Identity (EUDI) Wallets" />
  <meta property="og:description" content="Learn what EU Digital Identity (EUDI) Wallets are, what they store, who runs them, and when certified national wallets arrive under eIDAS 2.0 rules." />
  <meta property="og:url" content="https://docs.igrant.io/concepts/what-is-the-eu-digital-identity-wallet/" />
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/what-is-eudi-wallet.png" />
  <meta property="og:image:width" content="1200" />
  <meta property="og:image:height" content="630" />
  <meta name="twitter:card" content="summary_large_image" />
  <meta name="twitter:title" content="What are EU Digital Identity (EUDI) Wallets" />
  <meta name="twitter:description" content="Learn what EU Digital Identity (EUDI) Wallets are, what they store, who runs them, and when certified national wallets arrive under eIDAS 2.0 rules." />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/what-is-eudi-wallet.png" />
</head>

This article is a plain-language introduction to the **EU Digital Identity Wallet (EUDI Wallet)**: a wallet that EU Member States must make available, free of charge to natural persons, so you can prove who you are online, carry your important digital documents, share only the details a service actually needs, and sign with legal effect. It addresses a familiar problem: managing many logins and re-proving your identity to each new service. It is built on the revised eIDAS Regulation, known as **eIDAS 2.0** [1][3], and the technical rules behind it live in the European Digital Identity Wallet Architecture and Reference Framework (ARF) [2].

**Target audience:** Business leaders, product managers, and developers who are new to the EUDI Wallet and want a clear, no-jargon orientation before going deeper.

## 1.0 What is the EU Digital Identity Wallet?

The **EUDI Wallet** is a mobile app that holds your digital identity and your digital documents, and lets you use them, under your control, with online and in-person services across Europe.

Three things make it different from the identity apps you may already use:

- **It is made available through Member States, to a common European standard.** Each Member State must provide at least one certified wallet, directly, under a mandate, or by recognising one provided independently. The common specifications are what make a wallet issued in one country work in another [1][3].
- **It is yours to control.** You decide what to share, with whom, and when. Nothing leaves the wallet without your action.
- **It works across borders.** A credential placed in your wallet by an issuer in one country can be presented to a service provider in another, because the trust rules are agreed at EU level [1].

In short, the EUDI Wallet turns *"trust me, this is who I am"* into something a service can verify on solid, standardised, cryptographic grounds.

## 2.0 Why it exists

Today, digital identity in Europe is fragmented. Each service runs its own login. Each country has its own national eID scheme, and those schemes rarely work smoothly across borders. The result is password fatigue for citizens and a costly, repeated identity-checking burden for businesses.

**eIDAS 2.0** (Regulation (EU) 2024/1183), which entered into force on 20 May 2024, was created to fix this [3]. It updates the original 2014 eIDAS Regulation and introduces the EUDI Wallet as a portable, interoperable, privacy-preserving way for people and businesses in Europe to identify themselves and share trusted information, the same way everywhere.

For the regulatory background, including how eIDAS 2.0 differs from eIDAS 1.0, see our companion guide [Introduction to eIDAS 2.0 and Digital Wallets](https://docs.igrant.io/concepts/eidas2-and-digital-wallets/).

## 3.0 What the wallet can do: the four functions

At its simplest, the EUDI Wallet does four things [1].

- **Authenticate.** Prove who you are to a public or private service with a few taps, no username or password required.
- **Store.** Keep the digital documents you need, your identity data and attestations, in one place.
- **Share.** Present just the information a service asks for, and no more. To prove you are over 18, the wallet can confirm exactly that without revealing your date of birth.
- **Sign.** Create legally binding electronic signatures straight from the wallet, for example to sign a contract.

## 4.0 What the wallet holds

The wallet carries your core identity (`PID`) and several legal categories of "attestations of attributes", the digital equivalents of the documents in your physical wallet [1][2].

| Type | What it is | Who issues it | Assurance or legal effect | Example |
| --- | --- | --- | --- | --- |
| **`PID`** | **Person Identification Data**, the core data used to establish a person's identity | A `PID` Provider under the Member State's eID scheme | Bound to a high-assurance wallet and eID scheme | Name, date of birth, national identifier |
| **`QEAA`** | **Qualified Electronic Attestation of Attributes** | A qualified trust service provider | Same legal effect as a lawfully issued paper attestation | Diploma or professional licence |
| **`PuB-EAA`** | **Public-sector Electronic Attestation of Attributes** | A public sector body responsible for an authentic source (or one acting on its behalf) | Same legal effect as a lawfully issued paper attestation | Civil-register or social-security attribute |
| **`EAA`** | **(non-qualified) Electronic Attestation of Attributes** | A non-qualified attestation provider | Not denied legal effect or admissibility just for being electronic, but no automatic paper-equivalence | Gym membership, event ticket, loyalty card |

These legal categories are separate from the technical format. The documents can be carried as W3C Verifiable Credentials, IETF SD-JWT, or ISO 18013-5 mDoc/mDL. For when to choose each, see [Credential Formats in EUDI Wallets](https://docs.igrant.io/concepts/eudi-wallet-verifiable-credential-formats/).

## 5.0 Who is involved: the ecosystem

The EUDI Wallet is, by design, an open ecosystem with no single owner. Several roles work together, and the trust between them is what makes a credential issued by a stranger acceptable to another stranger [1][2].

- **Member State:** legally responsible for providing at least one wallet and for the wallet certification framework.
- **Wallet Provider:** a Member State, or an organisation mandated or recognised by one, responsible for making a certified wallet available.
- **Wallet User:** the citizen, resident, or business that uses the wallet.
- **Issuers:** organisations that put data into your wallet, including the **`PID` Provider** for core identity and attestation providers for **`QEAA`**, **`PuB-EAA`**, and non-qualified **`EAA`** documents.
- **Relying Party (Service Provider / Verifier):** any organisation that asks for, and relies on, information from your wallet.
- **Trust System:** the trusted lists, certificates, and rules that let any party check that the others are genuine and registered or certified where required.

This is the same ecosystem framing we use in our deep dive on how a wallet *proves* it is genuine to an issuer; see [Wallet Unit Attestation (WUA)](https://docs.igrant.io/concepts/wallet-unit-attestation/). In practice, iGrant.io implements these roles with two products: the [Data Wallet for EUDI Wallet](https://www.igrant.io/datawallet-for-eudi-wallet.html) for individuals (the holder), and the [Organisation Wallet for EUDI Wallet](https://www.igrant.io/organisationwallet-for-eudi-wallet.html) for issuers and relying parties. Section 9.0 shows how to build with them.

## 6.0 The principles that make it trustworthy

The EUDI Wallet is built around a small set of principles that recur throughout the regulation and the technical framework [1][3]:

- **User control and data minimisation.** You decide what to share, and the wallet shares only what is necessary for the transaction.
- **Privacy by design.** The wallet is designed so that providers cannot track where and how you use your credentials.
- **Security.** Strong cryptography, certified wallet components, and protected cryptographic keys keep wallet data and operations trustworthy.
- **Interoperability.** Common EU specifications mean a wallet works the same way, and across borders, everywhere in the Union.
- **Voluntary and free.** Use of the wallet is voluntary, and its issuance, use, and revocation are free of charge for natural persons.

## 7.0 Availability and timeline

eIDAS 2.0 obliges every Member State to provide at least one EUDI Wallet to its citizens, residents, and businesses **within 24 months of the entry into force of the implementing acts on wallet implementation and certification**. The European Commission summarises the rollout as national wallets reaching citizens **by the end of 2026** [3][4]. A Member State can provide the wallet itself, mandate another party to provide it, or recognise one provided independently.

For individuals the wallet is voluntary and free to use; you choose whether to adopt it. Because all national wallets are built to the same specifications, one issued in your country is designed to be accepted across the EU.

## 8.0 Where to go next

This primer is the on-ramp. To go deeper, continue through the **[EUDI Wallet Insights](https://docs.igrant.io/concepts/)** series:

- **The business case:** [The EUDI Wallet (eIDAS 2.0): A Business Guide to Use Cases](https://docs.igrant.io/concepts/eu-digital-identity-eudi-wallet-business-benefits-use-cases-eidas/)
- **The regulation:** [Introduction to eIDAS 2.0 and Digital Wallets](https://docs.igrant.io/concepts/eidas2-and-digital-wallets/)
- **For organisations:** [European Business Wallets](https://docs.igrant.io/concepts/european-business-wallets/)
- **How credentials are issued:** [Credential Issuance Lifecycle (OpenID4VCI)](https://docs.igrant.io/concepts/credential-issuance-lifecycle/)
- **How documents are formatted:** [Credential Formats in EUDI Wallets](https://docs.igrant.io/concepts/eudi-wallet-verifiable-credential-formats/)
- **How a wallet proves it is genuine:** [Wallet Unit Attestation (WUA)](https://docs.igrant.io/concepts/wallet-unit-attestation/)

## 9.0 Build it with iGrant.io

At iGrant.io, the concepts above map to building blocks for both sides of the EUDI Wallet ecosystem, aligned with eIDAS 2.0 and OpenID4VC.

### 9.1 The products

- **For individuals:** the [iGrant.io Data Wallet for EUDI Wallet](https://www.igrant.io/datawallet-for-eudi-wallet.html) is a mobile app, also available as a white-label SDK, that lets a person store, manage, and present their `PID` and other credentials with full user control.
- **For organisations:** the [iGrant.io Organisation Wallet for EUDI Wallet](https://www.igrant.io/organisationwallet-for-eudi-wallet.html) lets a legal entity act as issuer, holder, and verifier at once: issuing (Q)EAAs over OpenID4VCI and verifying presentations over OpenID4VP, with revocation and webhook support. It is the practical foundation for a [European Business Wallet](https://docs.igrant.io/concepts/european-business-wallets/).

### 9.2 See it in action

The four functions from Section 3.0 are easiest to grasp by trying them. These live scenarios run on the products above:

- [Issue a test PID](https://www.igrant.io/demo/pid.html) to your wallet.
- [KYC with a Photo ID and address proof](https://www.igrant.io/demo/openid4vp-dcql-04.html), requested over OpenID4VP.
- [Open a bank account](https://www.igrant.io/demo/open-bank-account.html) using your PID and a Qualified Electronic Signature Access Credential.
- [Log in to a bank, passwordless](https://www.igrant.io/demo/log-into-bank-account.html), with wallet authentication.
- Browse [all demo scenarios](https://www.igrant.io/demo.html).

### 9.3 Start building

When you are ready to write code, the [developer Get Started guide](https://docs.igrant.io/docs/get-started/) is the map for issuing, holding, and verifying credentials with OpenID4VC. A good first step is [Issue Credential (In-Time)](https://docs.igrant.io/docs/openID4vci-issue-credential-intime/), which ends with a working, scannable QR code; the verifier side is covered by [Send and Verify Credential](https://docs.igrant.io/docs/openID4vc-send-verify-credentials/).

## 10.0 Frequently asked questions

### Is the EUDI Wallet free?

Yes. eIDAS 2.0 requires the issuance, use, and revocation of EUDI Wallets to be free of charge to all natural persons [3]. You do not pay to obtain or use your national wallet.

### Is it mandatory to use the EUDI Wallet?

No. Use of the EUDI Wallet is voluntary. Member States are obliged to *provide* at least one wallet, but you choose whether to adopt it [1][3].

### When will the EUDI Wallet be available?

Every Member State must provide at least one wallet within 24 months of the entry into force of the implementing acts on wallet implementation and certification. The European Commission summarises the rollout as national wallets reaching citizens by the end of 2026 [3][4].

### What is the difference between PID, QEAA, PuB-EAA, and EAA?

`PID` is the core data used to establish your identity. A `QEAA` is issued by a qualified trust service provider and has the same legal effect as a lawfully issued paper attestation. A `PuB-EAA` is issued by, or on behalf of, a public sector body responsible for an authentic source and carries the same paper-equivalent effect. A non-qualified `EAA` is still legally usable and admissible as evidence, but does not get automatic paper-equivalence. See [Section 4.0](#40-what-the-wallet-holds).

### Will my EUDI Wallet work in other EU countries?

Yes. All national wallets are built to the same EU specifications, so a credential issued in one country is designed to be accepted by services across the EU [1].

### Is the EUDI Wallet secure and private?

Yes. The framework is designed for security and privacy: it uses certified wallet components, protected cryptographic keys, user control, and selective disclosure, so the wallet shares only the data a service actually needs (data minimisation) [1][2].

## References

1. European Commission (2026), 'What is the Wallet', EU Digital Identity Wallet, Available at: [https://ec.europa.eu/digital-building-blocks/sites/spaces/EUDIGITALIDENTITYWALLET/pages/791609471/What+is+the+Wallet](https://ec.europa.eu/digital-building-blocks/sites/spaces/EUDIGITALIDENTITYWALLET/pages/791609471/What+is+the+Wallet)
2. European Commission (2026), 'The European Digital Identity Wallet Architecture and Reference Framework (ARF) 2.9.0', Available at: [https://eudi.dev/2.9.0/architecture-and-reference-framework-main/](https://eudi.dev/2.9.0/architecture-and-reference-framework-main/)
3. European Parliament and Council (2024), 'Regulation (EU) 2024/1183 (eIDAS 2.0)', Available at: [https://eur-lex.europa.eu/eli/reg/2024/1183/oj](https://eur-lex.europa.eu/eli/reg/2024/1183/oj)
4. European Commission (2026), 'European Digital Identity (EUDI) Regulation', Shaping Europe's digital future, Available at: [https://digital-strategy.ec.europa.eu/en/policies/eudi-regulation](https://digital-strategy.ec.europa.eu/en/policies/eudi-regulation)


---

# EUDI Wallet Insights
Source: https://docs.igrant.io/concepts/

---
id: concepts-overview
title: EUDI Wallet Insights
description: Technical deep dives, business guides, and specifications for building on the European Digital Identity Wallet ecosystem.
hide_title: true
sidebar_label: EUDI Wallet Insights
keywords: [EUDI Wallet, European Business Wallet, OpenID4VC, OpenID4VCI, OpenID4VP, DCQL, credential formats, eIDAS 2.0, data agreements, data disclosure agreements, data intermediation service]
slug: /
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import { LandingCardGrid, LandingCard } from '@site/src/components/LandingCardGrid';

# EUDI Wallet Insights

Whether you're integrating the EUDI Wallet, designing systems around it, or evaluating its business case, this section is the technical reference. Published by iGrant.io in collaboration with EU Digital Identity Wallet Consortium (EWC) partners.

## Protocol Deep Dives

<LandingCardGrid columns={2}>
  <LandingCard
    title="EUDI Wallets with OpenID4VC"
    description="How OpenID4VCI and OpenID4VP work together to issue and present verifiable credentials in the EUDI Wallet ecosystem."
    to="/concepts/openID4vc/"
  />
  <LandingCard
    title="DCQL in the EUDI Wallets"
    description="Granular, multi-credential queries for OpenID4VP presentation requests, illustrated with payment-flow examples from the European Business Wallet."
    to="/concepts/eudi-wallet-dcql-openid4vp-business-wallet-payments/"
  />
  <LandingCard
    title="Credential Formats in EUDI Wallets"
    description="A comparison of W3C VC, IETF SD-JWT, and ISO 18013-5 mDoc/mDL formats and when to choose each."
    to="/concepts/eudi-wallet-verifiable-credential-formats/"
  />
  <LandingCard
    title="Credential Issuance Lifecycle (OpenID4VCI)"
    description="Six progressive stages from offer-sent to credential-accepted, with state diagrams and webhook events."
    to="/concepts/credential-issuance-lifecycle/"
  />
  <LandingCard
    title="Wallet Unit Attestation (WUA)"
    description="How the EUDI Wallet proves it is genuine and its keys are protected, via the Wallet Instance Attestation and Key Attestation, during OpenID4VCI issuance and under the TS3 profile."
    to="/concepts/wallet-unit-attestation/"
  />
  <LandingCard
    title="WSCA and WSCD"
    description="The Wallet Secure Cryptographic Device and Application: the certified hardware and secure app where the EUDI Wallet's keys are generated and protected, and how they underpin the Key Attestation in the WUA."
    to="/concepts/wallet-secure-cryptographic-application-device/"
  />
</LandingCardGrid>

## Business Guides

<LandingCardGrid columns={2}>
  <LandingCard
    title="What are EUDI Wallets?"
    description="What EU Digital Identity (EUDI) Wallets are: why they exist under eIDAS 2.0, what they can do and hold, who is involved, and when they arrive."
    to="/concepts/what-is-the-eu-digital-identity-wallet/"
  />
  <LandingCard
    title="The EUDI Wallet (eIDAS 2.0): A Business Guide to Use Cases"
    description="Sector-by-sector business benefits and use cases for the European Digital Identity Wallet under eIDAS 2.0."
    to="/concepts/eu-digital-identity-eudi-wallet-business-benefits-use-cases-eidas/"
  />
  <LandingCard
    title="Introduction to eIDAS 2.0 and Digital Wallets"
    description="The regulatory foundation of the European Digital Identity Wallet and how it differs from eIDAS 1.0."
    to="/concepts/eidas2-and-digital-wallets/"
  />
  <LandingCard
    title="European Business Wallets"
    description="How the Business Wallet enables trust and scale across regulated organisations within the EUDI Wallet ecosystem."
    to="/concepts/european-business-wallets/"
  />
</LandingCardGrid>

## Specifications

<LandingCardGrid columns={2}>
  <LandingCard
    title="Data Agreements (DA)"
    description="The conceptual model for data agreements in the digital identity ecosystem."
    to="/concepts/data-agreements/"
  />
  <LandingCard
    title="DA Vocabulary versions"
    description="Version history of the Data Agreement vocabulary."
    to="/concepts/data-agreements-versions"
  />
  <LandingCard
    title="Data Disclosure Agreements (DDA)"
    description="Specification for selective disclosure of data attributes between organisations."
    to="/concepts/data-disclosure-agreements/"
  />
  <LandingCard
    title="DDA Vocabulary versions"
    description="Version history of the Data Disclosure Agreement vocabulary."
    to="/concepts/data-disclosure-agreements-versions"
  />
  <LandingCard
    title="Data Intermediation Service Provider (DISP)"
    description="The role of intermediation services under the EU Data Governance Act."
    to="/concepts/disp-overview/"
  />
  <LandingCard
    title="Reference Model"
    description="The Minimum Disclosure Option (MDO) reference model for selective data sharing."
    to="/concepts/mdoDocs/mdo-ref-model"
  />
  <LandingCard
    title="Data Exchange Landscape"
    description="An overview of the European data exchange landscape and how the specifications fit together."
    to="/concepts/data-exchange-landscape"
  />
</LandingCardGrid>

## Research

<LandingCardGrid columns={2}>
  <LandingCard
    title="Data Exchange Agreements Framework (IEEE Paper)"
    description="Peer-reviewed IEEE paper on the conceptual framework for data exchange agreements."
    to="/concepts/dataexchange-agreements-ieee-paper/"
  />
</LandingCardGrid>


---

# Understanding eIDAS2.0: The Future of Digital Identity
Source: https://docs.igrant.io/concepts/eidas/eidas-main

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

# Understanding eIDAS2.0: The Future of Digital Identity

## Introduction
eIDAS2.0 is the updated European Union regulation for electronic identification and trust services, aimed at enhancing security and interoperability for digital transactions across member states.

## History of eIDAS
The original eIDAS regulation was adopted in 2014 to create a secure framework for electronic interactions in the EU. eIDAS2.0 builds on this by addressing technological advancements and the growing need for digital transformation.

## Why is eIDAS2.0 Relevant Now?
As digital interactions become increasingly prevalent, eIDAS2.0 addresses challenges in cross-border digital transactions, improves cybersecurity, and supports the EU's digital strategy.

### Key Articles
- [Article 1: Subject Matter](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/#1-subject-matter)
  - Defines the regulation's purpose and establishes the foundation for secure and interoperable electronic identification and trust services across the EU.
- [Article 2: Scope](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/#2-scope)
  - Outlines the regulation's applicability, including entities and sectors covered, ensuring comprehensive coverage of digital transactions.
- [Article 3: Definitions](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/#3-definitions)
  - Provides specific definitions for terms used within the regulation, ensuring clarity and consistency in its application.
- [Article 6: Mutual Recognition](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/#6-mutual-recognition)
  - Mandates that member states must recognize electronic identification means under certain assurance levels, promoting cross-border interoperability.
- [Article 7: Eligibility for Notification](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/#7-eligibility-for-notification)
  - Establishes criteria for member states to notify electronic identification schemes to the European Commission.
- [Article 10: Security Breach](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/#10-security-breach)
  - Specifies requirements for reporting and managing security breaches to protect the integrity of electronic identification and trust services.
- [Article 11: Liability](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/#11-liability)
  - Sets liability rules for misuse and failure of electronic identification, ensuring accountability and protection for users.

## OpenID4 Verifiable Credentials

### Introduction

OpenID4 Verifiable Credentials (VCs) are standards designed to enable secure and verifiable digital credentials. They provide a way to issue, present, and verify credentials across different systems and platforms.

### Benefits
- Enhanced privacy and security
- Interoperability across services and platforms
- Simplified verification processes

### Implementation
iGrant.io supports the implementation of OpenID4 VCs by providing compliant solutions that ensure secure and reliable credential management.

## European Architecture and Reference Framework

### Overview
The European Architecture and Reference Framework provides guidelines for developing interoperable and secure digital services across the EU. It aligns with eIDAS2.0 to ensure consistency and reliability in digital transactions.

### Key Components
- Standards and protocols for digital identities
- Guidelines for trust services
- Framework for cross-border interoperability

## Why Should You Care About eIDAS2.0?

eIDAS2.0 impacts businesses, government entities, and individuals by facilitating secure digital interactions and fostering trust in the digital economy. It ensures easier access to cross-border markets, improves security, and enhances user control over digital identities.

## What Does iGrant.io Do with eIDAS2.0?

iGrant.io leverages eIDAS2.0 to provide advanced digital identity solutions and trust services. By adhering to eIDAS2.0 standards, iGrant.io ensures secure, interoperable, and reliable digital transactions for its clients.

### Digital Wallet Solutions

iGrant.io offers both individual and organisational digital wallets, focusing on interoperability through European projects like the European Wallet Consortium (EWC), European Blockchain Service Infrastructure (EBSI), Vector, and Govstack.

- [Individual Wallet Overview](https://docs.igrant.io/docs/eo-dw-overview/)
- [Organisational Wallet Overview](https://docs.igrant.io/docs/organisation-wallet-overview/)

These digital wallets provide secure storage and management of verifiable credentials, enhancing privacy and user control while ensuring compliance with eIDAS2.0 standards.

## Additional Resources
- [Full Legal Text of eIDAS2.0 Regulation](https://docs.igrant.io/regulations/reg-eu-digital-id-framework/)
- [iGrant.io Documentation](https://docs.igrant.io/)
- [European eIDAS2.0](https://ec.europa.eu/digital-strategy/our-policies/eidas-regulation_en)
- [Digital Wallet Pages](https://ec.europa.eu/digital-strategy/digital-wallet_en)

## Contact Information
### Support Channels
For support and assistance with eIDAS2.0 and related services, contact our team through the provided channels on our [website](https://docs.igrant.io/).

### Feedback Form
Provide feedback on our documentation and suggest improvements through our [feedback form](https://docs.igrant.io/contact/).

---

This structure provides comprehensive information on eIDAS2.0, OpenID4 Verifiable Credentials, and the European Architecture and Reference Framework, making your page a valuable resource for users seeking detailed and reliable information. For further details and references, visit the specific sections of your existing documentation on [iGrant.io](https://docs.igrant.io/).


---

# Introduction to eIDAS2.0 and Digital Wallets
Source: https://docs.igrant.io/concepts/eidas2-and-digital-wallets/

---
id: eidas2-and-digital-wallets 
title: Introduction to eIDAS2.0 and Digital Wallets
description: eIDAS 2.0 enhances digital identity across EU member states with secure, interoperable digital wallets, improving user control and cross-border trust services.
hide_title: false
sidebar_label: eIDAS2.0 and Digital Wallets
keywords: [eIDAS 2.0, digital wallets, EUDI Wallet, European Business Wallet, electronic signatures, cross-border, trust services, digital identity, EU regulation]
slug: /eidas2-and-digital-wallets/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


<head>
  <title>Introduction to eIDAS2.0 and Digital Wallets with iGrant.io | iGrant.io DevDocs</title>
  <meta name="description" content="eIDAS 2.0 enhances digital identity across EU member states with secure, interoperable digital wallets, improving user control and cross-border trust services." />
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/eidas-eudi-wallet-intro.webp" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/eidas-eudi-wallet-intro.webp" />
</head>

The European Union has been at the forefront of digital transformation, and eIDAS 2.0 is a significant step in enhancing digital identity frameworks. This article explores its history, key features, implications for developers, and key dates.

# Understanding eIDAS - What is it?

eIDAS stands for Electronic Identification, Authentication, and Trust Services. Established in 2014, it provides a regulatory framework to increase trust and security in European electronic transactions. The services covered under this regulation include:

* **Electronic signatures** (via Trust Service Providers)
* **Online authentication processes**
* **Cross-border data exchange**
* **Digital transactions across member states**

Recognising the need for a more integrated and comprehensive approach, the proposal for eIDAS 2.0 was introduced in 2021. The new framework, set for adoption in 2024, aims to enhance security, user control, and interoperability across Europe. A significant addition is the introduction of the European Digital Identity Wallet, which broadens the application of digital identity services.

## The Need for Evolution - Towards eIDAS 2.0

The initial eIDAS framework, established in 2014, focused on creating a baseline for electronic identification and trust services across Europe. However, it had a limited scope and siloed implementation. The proposal for eIDAS 2.0 in 2021 aimed to address these limitations by introducing the European Digital Identity Wallet and enhancing the security, interoperability, and user control aspects. The new framework is set for adoption and implementation in 2024.

![The Need for Evolution - From eIDAS to eIDAS 2.0](eidas-to-eidas2.0.png)
_Figure 01: The Need for Evolution - From eIDAS to eIDAS 2.0_

## Differences Between eIDAS and eIDAS 2.0

The original eIDAS regulation provided a foundational framework for electronic identification and trust services but needed to be expanded in scope. Here are the key differences between eIDAS and eIDAS 2.0 -

1. **Scope and Implementation**:
    * **eIDAS (2014)**: Focused on a limited scope with basic electronic identification and trust services. Implementation was often siloed within individual member states.
    * **eIDAS 2.0 (2024)**: Broadens the scope to include the European Digital Identity Wallet, promoting a more integrated approach with enhanced security, user control, and interoperability across the EU.
2. **Digital Wallets**:
    * **eIDAS (2014)**: Did not include a digital wallet concept.
    * **eIDAS 2.0 (2024)**: Introduces digital wallets for natural and legal persons, allowing secure storage and management of personal and organisational identification data.
3. **Interoperability**:
    * **eIDAS (2014)**: Limited interoperability between national systems, leading to fragmented digital identity solutions.
    * **eIDAS 2.0 (2024)**: Emphasises interoperability through a defined framework, ensuring compatibility across national systems.
4. **Security and User Control**:
    * **eIDAS (2014)**: Provided basic security measures but lacked comprehensive user control over personal data.
    * **eIDAS 2.0 (2024)**: Enhances security protocols and aligns with GDPR to ensure stringent data protection and greater user control over personal information.
5. **Trust Services**:
    * **eIDAS (2014)**: Established standards for electronic signatures, seals, and timestamps, but with limited enhancements over time.
    * **eIDAS 2.0 (2024)**: Strengthens these standards further, ensuring that digital interactions are legally binding and secure across the EU.

## Key Features of eIDAS 2.0

1. **Enhanced Electronic Identification (eID)**:
    * **Reference**: [Chapter II](/regulations/reg-eu-digital-id-framework/#chapter-ii---electronic-identification), [Section 2](/regulations/reg-eu-digital-id-framework/#section-2---electronic-identification-schemes), Articles [6](/regulations/reg-eu-digital-id-framework/#article-6---mutual-recognition), [7](/regulations/reg-eu-digital-id-framework/#article-7---eligibility-for-notification), [8](/regulations/reg-eu-digital-id-framework/#article-8---assurance-levels), [9](/regulations/reg-eu-digital-id-framework/#article-9---notification), [10](/regulations/reg-eu-digital-id-framework/#article-10---security-breach-of-electronic-identification-schemes), [11](/regulations/reg-eu-digital-id-framework/#article-11---liability),[12](/regulations/reg-eu-digital-id-framework/#article-12---interoperability)
    * **Purpose**: Establishes a unified approach for electronic identification across EU member states.
    * **Impact**: Ensures mutual recognition of eID schemes, simplifying cross-border digital transactions and reducing barriers. This promotes smoother, more secure interactions between individuals and organisations across member states, enhancing trust and efficiency in digital services.

2. **European Digital Identity Wallet**:
    * **Reference**: [Chapter I](/regulations/reg-eu-digital-id-framework/#chapter-i---general-provisions), [Section 1](/regulations/reg-eu-digital-id-framework/#section-1---european-digital-identity-wallet), Articles [5a](/regulations/reg-eu-digital-id-framework/#article-5a---european-digital-identity-wallets), [5b](/regulations/reg-eu-digital-id-framework/#article-5b---european-digital-identity-wallet-relying-parties), [5c](/regulations/reg-eu-digital-id-framework/#article-5c---certification-of-european-digital-identity-wallets), [5d](/regulations/reg-eu-digital-id-framework/#article-5d---publication-of-a-list-of-certified-european-digital-identity-wallets), [5e](/regulations/reg-eu-digital-id-framework/#article-5e---security-breach-of-european-digital-identity-wallets), [5f](/regulations/reg-eu-digital-id-framework/#article-5f---cross-border-reliance-on-european-digital-identity-wallets)
    * **Purpose**: Introduces secure digital wallets for storing personal identification data.
    * **Impact**: Facilitates seamless online authentication, verification of various attributes (such as age and qualifications), secure document sharing, digital signatures, and other transactions requiring verified identity information. Enhances user control, privacy, and security, ensuring users have sovereignty over their personal data and can confidently perform various activities.

3. **Trust Services**:
    * **Reference**: [Chapter III](/regulations/reg-eu-digital-id-framework/#chapter-iii---trust-services), [Section III](/regulations/reg-eu-digital-id-framework/#chapter-iii---trust-services),  Articles [20](/regulations/reg-eu-digital-id-framework/#article-20---supervision-of-qualified-trust-service-providers) -[45](/regulations/reg-eu-digital-id-framework/#article-45---requirements-for-qualified-certificates-for-website-authentication), and Articles [46a](/regulations/reg-eu-digital-id-framework/#article-46a---supervision-of-the-european-digital-identity-wallet-framework)-[46e](/regulations/reg-eu-digital-id-framework/#article-46e--the-european-digital-identity-cooperation-group)
    * **Purpose**: Strengthens standards for electronic signatures, seals, timestamps, and website authentication.
    * **Impact**: Enhances the legal standing and security of digital interactions across the EU, providing a robust foundation for trust in electronic transactions. This enables safer, more reliable online services, supporting legal and commercial activities.

4. **Interoperability and Security**:
   * **Reference**:
     * Interoperability: Article [12](/regulations/reg-eu-digital-id-framework/#article-12---interoperability)
     * Security: Articles [5e](/regulations/reg-eu-digital-id-framework/#article-5e---security-breach-of-european-digital-identity-wallets), [10](/regulations/reg-eu-digital-id-framework/#article-10---security-breach-of-electronic-identification-schemes), [19](/regulations/reg-eu-digital-id-framework/#article-19---security-requirements-applicable-to-trust-service-providers), [45a](/regulations/reg-eu-digital-id-framework/#article-45a---cybersecurity-precautionary-measures)
    * **Purpose**: Promotes interoperability between national systems through a defined framework.
    * **Impact**: Ensures compatibility and enforces robust security measures to protect personal data. This fosters a more connected and secure digital single market, making it easier for businesses and individuals to interact across borders, enhancing market efficiency and user convenience.

5. **Data Protection and User Control**:
    * **Reference**: Various references across the eIDAS2.0 articles
    * **Purpose**: Aligns with GDPR to prioritise data protection and user control over personal information.
    * **Impact**: Guarantees that personal data is handled with high privacy standards, allowing users to decide what information to share. This reinforces trust in digital services by ensuring that user data is protected and controlled by the users, promoting confidence and compliance with privacy regulations.

## Key Dates in the Regulation

* **July 2014**: eIDAS Regulation (EU) No 910/2014 established.
* **June 2021**: Proposal for eIDAS 2.0 to include the European Digital Identity Wallet.
* **February 2022:** Framework development for EUDI digital identity architecture.
* **October 2022:**Official publication of new trust services and technical architecture.
* **June 2023:**Implementation guide published by the European Commission.
* **February 2024:** Formal vote and approval of the eIDAS 2.0 regulation.
* **May 20, 2024:** eIDAS 2.0 enters into force.
* **September 2024:** Deadline for Member States to transpose eIDAS 2.0 into national legislation. Member states are expected to notify the Commission of their eID schemes.
* **1 September 2025**: European Digital Identity Wallets must be issued to citizens and businesses.
* **2025 - 2026:** Initial development and monitoring period for EUDI Wallet.
* **September 2026:** Deadline for delivering EUDI Wallets to citizens and adapting to new eIDAS 2.0 requirements.
* **2030:**Target for 80% of EU citizens and companies to actively use the EUDI Wallet.

# European Digital Identity Wallet

The European Digital Identity Wallet is a cornerstone of the eIDAS 2.0 framework. It allows EU citizens and residents to securely store and manage their personal identification data. This wallet, which is detailed in [Chapter I, Section 1, Articles 5a-5f](/regulations/reg-eu-digital-id-framework/#section-1---european-digital-identity-wallet), includes the following key features:

* **Provision**: Each Member State must provide at least one wallet within 24 months of the implementing acts.
* **Flexibility**: Wallets can be provided directly by a Member State, under a mandate from a Member State, or independently but recognised by the Member State.
* **Open-Source**: The source code of the application software components must be open-source licensed.
* **User Control**: Users can securely request, obtain, select, combine, store, delete, share, and present personal identification data.
* **Security**: High-security standards must be met, including encryption and secure authentication mechanisms.
* **Additional Functionalities**: Member States may provide additional functionalities to ensure they comply with this regulation.
* **Comprehensive Use**: Wallets can be used for various applications such as e-government, healthcare, finance, and more, ensuring broad utility and accessibility for users across different sectors.

# Implications for Organisations

* **Regulatory Compliance**: Simplifies adherence to regulations across the EU, enabling the development of cross-border digital services.
* **Enhanced Security**: Offers developers robust tools to ensure electronic transactions' security and legal validity.
* **Interoperability**: Provides a framework for creating compatible applications across national systems, enhancing user experience.
* **User Trust**: Developers can build applications that foster greater user trust by adhering to stringent data protection and trust service standards.

# Conclusion

eIDAS 2.0 is a transformative regulation that enhances the digital identity landscape in the EU. By fostering a secure, interoperable, and user-friendly environment for electronic identification and trust services, it paves the way for a truly integrated digital single market. Developers are crucial in implementing these standards, ensuring a safer and more efficient digital future for all.

For more detailed information, visit the[European Digital ID Framework](/regulations/reg-eu-digital-id-framework/).


---

# Business Wallets - Enabling Trust and Scale in the European Digital Identity (EUDI) Wallet Ecosystem
Source: https://docs.igrant.io/concepts/european-business-wallets/

---
id: european-business-wallets 
title: Business Wallets - Enabling Trust and Scale in the European Digital Identity (EUDI) Wallet Ecosystem
description: Explore how European Business Wallets enable legal entities to hold and present verifiable credentials for secure, cross-border digital transactions.
hide_title: false
sidebar_label: European Business Wallets
keywords: [European Business Wallet, EUDI Wallet, legal entity credentials, cross-border transactions, verifiable credentials, EWC, digital identity, trust]
slug: /european-business-wallets/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

import Link from '@docusaurus/Link';
import VideoPlayer from '@site/src/components/VideoPlayer';

<head>
  <title>Learn About European Business Wallets with iGrant.io | iGrant.io DevDocs</title>
  <meta name="description" content="Explore how European Business Wallets enable legal entities to hold and present verifiable credentials for secure, cross-border digital transactions." />
  <meta property="og:image" content="https://docs.igrant.io/img/cDocs/european-business-wallet-article.webp" />
  <meta name="twitter:image" content="https://docs.igrant.io/img/cDocs/european-business-wallet-article.webp" />
</head>

This article is based on the presentation by iGrant.io CTO Lal Chandran at the [Global Digital Collaboration (GDC) 2025 event in Geneva](https://www.slideshare.net/slideshow/the-european-business-wallet-why-it-matters-and-how-it-powers-the-eudi-ecosystem-2eed/281365630), where the spotlight was on innovations shaping the future of digital identity. Among these, the European Business Wallet stood out as a foundational element for building a trusted, decentralised ecosystem around the European Digital Identity Wallet (EUDI Wallet).

This article presents key insights from the EU Digital Wallet Consortium (EWC) Large-Scale Pilots (LSPs), where Business Wallets were piloted in live scenarios, particularly in the area of bank and merchant led payments. It demonstrates how Business Wallets empower banks, merchants, and service providers to seamlessly engage as issuers, verifiers, and relying parties within the EUDI framework.

## A wallet is only as useful as the ecosystem around it

To understand the importance of Business Wallets, it is helpful to examine today’s familiar digital wallets. Apple Wallet and Google Wallet are examples that most users recognise. These wallets are effective because a well-integrated ecosystem supports them: airlines, banks, ticketing platforms, and payment networks all play a crucial role.

The same principle applies to the EUDI Wallet. An individual wallet is only helpful if it can connect with a broader ecosystem of trustworthy, credential-enabled organisations. That ecosystem must not only be connected but also decentralised and interoperable across Member States. This is where Business Wallets come in.

Business Wallets enable organisations to issue and verify credentials, manage trust, and perform complex workflows, all while the individual enjoys a seamless experience. Without them, the vision of a functional, cross-border EUDI Wallet ecosystem remains incomplete. Like every Wallet Unit, a Business Wallet proves that it is genuine and that its keys are protected through a [Wallet Unit Attestation (WUA)](https://docs.igrant.io/concepts/wallet-unit-attestation/).

## The EWC LSP approach: Grounded in real-World workflows

In the EWC pilot, the focus was not just on compliance with standards, but on enabling actual adoption. The pilots tested:

* Business-to-consumer workflows
* Delegated authority for payments
* Issuance of boarding passes and receipts
* Trust verification across multiple actors

The goal was to make the wallet usable in production contexts where speed, trust, and user experience matter. By focusing on business processes rather than just wallet features, the EWC pilot demonstrated how Business Wallets bridge the gap between technical frameworks and operational needs.

## Challenges unique to business adoption

The pilot revealed several business-specific challenges that must be addressed to enable large-scale adoption:

<table>
  <tr>
   <td><strong>Natural Person Wallet</strong>
   </td>
   <td><strong>Business Wallet and Ecosystem</strong>
   </td>
  </tr>
  <tr>
   <td>Focus on user experience
   </td>
   <td>Integration into business workflows and systems
   </td>
  </tr>
  <tr>
   <td>Individual compliance with regulations
   </td>
   <td>Organisational-level regulatory and audit requirements
   </td>
  </tr>
  <tr>
   <td>Basic trust setup for relying parties
   </td>
   <td>Full lifecycle trust and identity management across entities
   </td>
  </tr>
  <tr>
   <td>Interoperability of wallet apps
   </td>
   <td>Interoperability across industries and Member States
   </td>
  </tr>
  <tr>
   <td>Limited credential handling
   </td>
   <td>Handling of advanced credentials like LPID, QEAAs, and delegation
   </td>
  </tr>
</table>

These complexities reinforced the need for a dedicated Business Wallet infrastructure that is interoperable, standards-aligned, and aligned with EU trust frameworks.

## Demo: Linking a bank ccount to the EUDI Wallet

To illustrate how these roles come together in practice, here is a live demo (This was trialed production during EWC pilots) where a user links their bank account to the EUDI Wallet via a trusted business process:

<VideoPlayer
  videoId="gfb9cL2ulso"
  title="Issue Payment Authenticator | EUDI Wallet Integration for Secure Payments"
  description="Experience linking EUDI Wallets with bank accounts"
  uploadDate="2025-07-01"
  duration="PT10M"
/>

The wallet demonstrates that the organisation is trustworthy, verified through the EU Trust List, and adheres to standards such as ETSI TS 119 612 and the EWC RFC-012 trust mechanism. The Business Wallet issues a credential that authorises access, linking both the individual and the legal entity.

## Demo: Payments with delegated access with SCA

Here is a live demo (This was trialed production during EWC pilots) of a real-world payment flow in production:

<VideoPlayer
  videoId="6GwCxyofSVE"
  title="Experience Payments with EUDI Wallets – Student Concession Ferry Ticket Demo"
  description="Learn the interplay of EUDI wallets for individuals and the European Business Wallets"
  uploadDate="2025-07-01"
  duration="PT10M"
/>

An individual pays for a ferry ticket using an EUDI Wallet:

* The wallet includes a bank-issued payment authenticator.
* The payment authenticator is used to authorise payment on behalf of an organisation.
* A boarding pass and digital receipt are issued as verifiable credentials.

The experience is fast and simple for the user, while the Business Wallet manages credentials and trust validations in the background.

## Embedding trust in real transactions

Trust is central to the EUDI Wallet model. The demos demonstrate that:

* The individual sees verified organisations.
* Trust is based on compliance with ETSI TS 119 612 and [EWC RFC-012](https://github.com/EWC-consortium/eudi-wallet-rfcs/blob/main/ewc-rfc012-trust-mechanism.md).
* All interactions are traceable and auditable.

## Why Business Wallets matter

Business Wallets are not an add-on to the EUDI ecosystem. They are essential for enabling adoption at scale. They:

* Allow banks, governments, and enterprises to act as credential issuers and verifiers
* Manage complex, cross-border business logic
* Enable delegated authority, such as employer-backed transactions
* Ensure legal compliance and trust alignment

Without Business Wallets, the EUDI Wallet is limited in its ability to serve real-world needs.

## Call to action: Enable the future

The infrastructure and standards are ready. The EWC production pilots with payments have demonstrated that Business Wallets are effective in live settings. Now is the time for organisations across Europe to engage:

* If you are a bank, explore issuing payment authenticators and role‑based credentials
* If you are a merchant or service provider, prepare to accept and verify EUDI credentials
* If you are a public authority, support the establishment of trusted organisational credentials

EUDI Wallet adoption depends not only on individuals downloading apps but also on a thriving, trusted, and standards-based business ecosystem.

Contact us at [support@igrant.io](mailto:support@igrant.io) to get started.

---

# What are data agreements in the digital identity ecosystem
Source: https://docs.igrant.io/concepts/data-agreements/

---
id: mdo-data-agreement
title: What are data agreements in the digital identity ecosystem
description: Learn how data agreements define consent, purpose, and usage terms for secure and transparent data sharing in digital wallet ecosystems.
hide_title: true
sidebar_label: DA Overview
keywords: [data agreements, consent, personal data, GDPR, data processing, privacy, digital identity, data protection, DPIA]
slug: /data-agreements/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


A Data Agreement records the conditions for an organisation to process personal data by privacy regulations (e.g. GDPR) captured in a signed receipt given to the individual. A Data Protection Impact Assessment (DPIA) may be used to populate the record to automate the record creation, increase accountability, and reduce regulatory compliance risks. 

In iGrant.io, personal data exchanges from a Data Source to a Data Using Service are endorsed via Data Agreements. Data Agreements can be based on any lawful basis (e.g. consent, lawful purpose, contract, legal obligation, vital interests, public task and legitimate interests, etc.). For those data agreements without consent, individuals will only have limited or no rights to withdraw the consent; however, the individual can still follow what data is processed and why transparently.

Several steps are required from different actors to create the Data Agreement and the resulting receipt as proof. The receipt itself is signed (as a verifiable credential) and acts as evidence, demonstrates a higher level of accountability, and is based on standard schemas. This documentation describes the steps involved and is described as part of a Data Agreement lifecycle. 
## Data Agreement Lifecycle

The Data Agreement Lifecycle has 4 main phases as described below:

![Data Agreement workflow](data-agreement-workflow.png)

1. **Definition**: An authority adapts the data agreement schema to a particular industry and/or sector-specific data usage as a template in this phase. This can then be used by any organisation (Data source or Data Using Service) for a particular data usage purpose.

2. **Preparation**: In this phase, an organisation uses an existing data usage template and prepares it to be published towards the individuals. This could be based on a DPIA and could be for internal use of data or for data exchange to a Data Using Service. Once the Data Agreement is prepared, any changes identified from a subsequent DPIA shall update the Data Agreement and go through a new preparation process. When an agreement is updated or terminated, the individuals are notified, and a record is created.

3. **Negotiation/Capture**: In this phase, an individual reviews the Data Agreement and,  once agreed, it is captured in a Data Agreement *record* by the organisation and the individual is given a Data Agreement *receipt* as evidence of the agreement. The Data Agreement *receipt* can be used as proof of the data transaction that occurred. This allows an auditor to check and ensure records are in place to process the individual's personal data. When the agreement is terminated and no longer applies to an individual, a new record is created. The termination can be due to the completed service period or an individual requests to revoke the agreement. The record of the termination allows an auditor to inspect personal data that is not used. If an individual requests to be forgotten when terminating a service, it shall be clearly indicated.

4. **Proof**: An organisation can demonstrate a valid Data Agreement *record* for performing a data exchange with an individual. This allows an auditor to check and ensure records are in place to process the individual's personal data.

:::note

A Data Protection Impact Assessment (DPIA) is a structured process where  an organisation can identify and minimise the data protection risks involved in using personal data. It ensures that an organisation is compliant to data regulations, such as the GDPR. Article 35 of the GDPR requires organisations to conduct DPIAs, especially when the processing is likely to result in high risk to the rights and freedoms of natural persons in the case of extensive use of new technologies and when sensitive personal data is being processed (e.g. health-related data). Organisations can also conduct DPIAs voluntarily, even if the processing does not meet the requirement criteria set out in the GDPR. 

Some EU Member State data protection authorities, such as the Finnish data protection ombudsman, have recommended using dataflow maps when conducting DPIAs. Dataflow maps visualize the flows of personal data across systems, organisations, and jurisdictions, and provide a good overview of the nature and scope of the processing and identify risks.

The outcome of a DPIA is mapped to a machine-readable Data Agreement. By integrating the DPIA into the lifecycle of the Data Agreement, an organisation can demonstrate how the privacy requirements of accountability, transparency, data sharing and retention procedures are fulfilled. If the DPIA report is part of an online tool, it is possible to continuously monitor an organisation's data flows and ensure any internal changes are reflected in the Data Agreement.

:::
## Data Agreement Lifecycle mapped to Enterprise Dashboard

These are the use cases covered by this specification. A mapping between the use cases and lifecycle phase can help map the involved actors described in the previous section.

<table>
   <tr>
      <td><strong>#</strong>
      </td>
      <td><strong>Lifecycle Phase</strong>
      </td>
      <td><strong>Use Case</strong>
      </td>
   </tr>
   <tr>
      <td>1
      </td>
      <td>Definition
      </td>
      <td>Import machine-readable DPIA to pre-populate Data Agreement template.
      </td>
   </tr>
   <tr>
      <td>2
      </td>
      <td>Preparation
      </td>
      <td>
         Prepare Data Agreement and issue it towards individuals (Organisational users). <br /><br />
         The individuals are informed about the validity of the data agreement (E.g. revocation, expiry etc.)
      </td>
   </tr>
   <tr>
      <td>3
      </td>
      <td>Capture
      </td>
      <td>
         The individual countersigns a Data Agreement and captures the Data Agreement receipt. E.g. via a digital rights management portal or using a digital wallet.
         <br /><br />Individuals are also able to download the signed data agreement record and share it with an external auditor via an out-of-band process. This could be during a dispute, for e.g.
         <br /><br />
         Individuals can also delegate the signing to another individual.
      </td>
   </tr>
   <tr>
      <td>4
      </td>
      <td>Proof
      </td>
      <td>Audit of mutually signed data agreement by an external auditor.
      </td>
   </tr>
</table>

## Data Agreement Demonstration

Data Agreements are supported in all iGrant.io digital wallets (enterprise and individual wallets, including the SDKs), supporting the SSI workflows. The demo below showcases the iGrant.io Data Wallet capabilities using data agreements. Here, we combine our data exchange solution with permissions and consents - to ensure auditable and immutable personal data transactions. It shows how data agreements remove the barriers to consent-based, auditable and immutable data transactions. 

[![Video](https://img.youtube.com/vi/lx8F5D9qPQI/0.jpg)](https://www.youtube.com/watch?v=lx8F5D9qPQI "Data wallet with data agreements for consent-based auditable and immutable data transactions")

## Resources

* Read more in [our whitepaper on data exchange agreements](https://igrant.io/papers/iGrant.io_DataExchangeAgreements_v2.0.pdf) (Executive level)
* Check out the [IEEE whitepaper](https://igrant.io/papers/iGrant.io_IEEE-Paper-DataExchangeAgreements-v3.1.pdf) for more information on how the data exchange agreement (DEXA) protocols are defined and used.



---

# See versions of data agreements explained
Source: https://docs.igrant.io/concepts/data-agreements-versions

---
id: mdo-da-vocab-versions
title: See versions of data agreements explained
description: Explore different versions of data agreements, their evolution, and how they enable structured, transparent consent in digital identity solutions.
hide_title: true
sidebar_label: DA Vocabulary
keywords: [data agreements, vocabulary, GDPR, schema, consent, personal data processing, data agreement versions]
slug: /data-agreements-versions
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

The Data Agreement Vocabulary provides terms to describe and represent information related to processing of personal data based on established requirements such as for the EU General Data Protection Regulation (GDPR).

The table below provides different versions of the data agreement vocabulary.

* [Data agreement vocabulary - version 1.0](/schema/data-agreements/v1.0/)
* [Data agreement vocabulary - version 1.1](/schema/data-agreements/v1.1/)

---

# Understand the data exchange landscape
Source: https://docs.igrant.io/concepts/data-exchange-landscape

---
id: mdo-data-exchange-landscape
title: Understand the data exchange landscape
description: Explore the evolving data exchange landscape, including standards, protocols, and frameworks driving trusted digital identity ecosystems.
hide_title: true
sidebar_label: Data Exchange Landscape
keywords: [data exchange landscape, DEXA, data agreements, W3C DID, DPIA, ISO 27560, data exchange, digital trust, consent]
slug: /data-exchange-landscape
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

In a typical data exchange ecosystem, there are a number of agreements that are required to legally validate data exchanges. This documentation introduces various Data Exchange Agreements (DEXA) and the relationships that exist between organisations and individuals, depending on their roles in different personal data usage scenarios. The various agreements involved can be classified into four broad categories as shown in Figure 2 below. These are agreements between:

1. An individual and an organisation
2. Two organisations (DS and DUS)
3. An organisation and its supplier
4. Two individuals

![Data agreement landscape - for data exchange](https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/docs/images/data-exchange-landscape.svg)
*Figure 2. Data exchange agreement landscape*

### Data Agreement (DA) or Personal Data Agreement

This is an agreement between an organisation and an individual when it comes to the use and processing of personal data. A data agreement (DA) can have any lawful bases as outlined by the relevant data protection regulation (such as the GDPR). The agreement can be with a DS (issuer) or a DUS (verifier) and can also be used for personal data exchange with third parties.

Today, the DA is implemented via a W3C specified Decentralised Identifier (DID) `DID:mydata`. It records the conditions for an organisation to process personal data in accordance with data protection regulations. Regulations could be data laws or they could be norms such as the MyData principles. The key characteristics of a DA are as follows:

* It is associated with any personal data usage including data exchange
* It has the ability to rely on an individual’s consent or other lawful basis such as contract, legal obligation, vital interests, public task and legitimate interests by outlining the purpose for which personal data is to be processed
* It is tied to a data protection impact assessment (DPIA) that further strengthens legal compliance for the organisation. iGrant.io automates the conversion of the results of a DPIA to a machine-readable DA
* It is standardised via ISO/IEC JTC 1/SC 27 Information security, cybersecurity and privacy protection WG5: 27560

The key commercial values enabled by a DA are described below:

**Data regulatory compliance**: A DA based on a DPIA provides reassurance that the organisation has the intent to exchange data in compliance with a jurisdiction appropriate data protection regulation.

**Transparency**: A DA provides the requisite transparency to a data subject on how personal data is to be used by an organisation, especially if exchanged with third parties.

**Auditability**: With a DA, a DS can prove its legitimate right to collect and share data with a DUS via digital token-based verification system. Similarly, an individual can dispute data usage for which no legitimacy can be proven using the signed DA.

### Data Disclosure Agreement (DDA)

A Data Disclosure Agreement (DDA) exists between two organisations where one organisation acts as a DS and the other as a DUS. The DDA captures how data is shared between the two organisations and what role and obligation each party has, as either a data processor and/or a data controller. For any organisation involved in the data exchange, there is an associated DA that explains the purpose of processing personal data, what personal data is collected, what the data subject rights are, etc. Where both organisations are data controllers, the individual (data subject) has a signed DA with both.

### Data Processing Agreement (DPA)

The third form of an agreement exists between an organisation and its suppliers, as illustrated in Figure 2. Here, there is a vertical relationship between Organisation A as a data controller and its supplier as a data processor or sub-processor. For a higher level of accountability between these organisations, a DPA is set up, which lays out what routines are required to be in place: for example, a data processor’s obligations in case of a data breach or how the rights of the individual, such as access rights, are supported, among other policies and routines. An auditor should also be able to inspect the organisation and use the DPA as reference material during the inspection. As depicted in Figure 2, the DPA  is connected  to the individual at the top of the hierarchy via the data controller organisation.

### Delegation Agreement

The delegation agreement is included to complete the data exchange ecosystem. A delegate may act on behalf of an individual in signing off any data exchange. There are several scenarios where delegation is necessary for example in the case of guardianship when an individual is not capable of signing off or in case an individual is given temporary rights to sign off on behalf of the individual for example purchasing medicine at a pharmacy.

## Data Exchange Agreement overview

Figure 4 below illustrates a typical scenario where an organisation, Org. A, uses a DA to share data externally to Org B and Org C. Individual instances of the DA are signed by individuals X and Y. A DDA is used to govern the data exchange between Org A and Orgs B and C.

![](https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/docs/images/data-exchange-provenance-scenarios.svg)
*Figure 3. Data exchange and provenance scenarios*



---

# Learn Data Disclosure Agreements (DDA) with iGrant.io
Source: https://docs.igrant.io/concepts/data-disclosure-agreements/

---
id: mdo-data-disclosure-agreement
title: Learn Data Disclosure Agreements (DDA) with iGrant.io
description: Understand how data disclosure agreements govern what data is shared, with whom, and under what terms in digital identity ecosystems.
hide_title: true
sidebar_label: DDA Overview
keywords: [data disclosure agreements, DDA, data exchange, data sharing, data governance, digital trust, transparency, data source]
slug: /data-disclosure-agreements/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

A Data Disclosure Agreement (DDA) enables automated agreement handling for data exchange between a Data Source (DS) and Data Using Service (DUS). It helps organisations to continue leveraging their data assets while being transparent and legitimate in their data usage. Automated agreement handling is a requisite for a scalable and regulatory-compliant data marketplace… It also provides individuals control over how their data is used and exchanged.

It aims to enhance data governance to ​increase transparency and authenticity as ​critical elements for digital trust. This documentation describes the overall process how organisations can dynamically build trust in a dataspace or a data ecosystem, including the key actors involved.

## Data Disclosure Agreement lifecycle actors

These actors are involved in the Data Disclosure Agreement lifecycle.

| Actor              | Description                                                                                              | SSI Role / Other names                     |
| ------------------ | -------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| Data Source        | The organisation collecting personal data and storing it                                                 | Issuer or Data producer                    |
| Data Subject       | who can manage their preferences and follow their data, should know who is consuming what, when and why. | Holder                                     |
| Data Using Service | The organisation processing personal data from one or more data sources to deliver a service.            | Verifier or Relying party or Data consumer |

Additionally, there are two more actors participating in the data agreement lifecycle.

| Actor            | Description                                                                                                                                                                                          |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Assessor         | The individual who reviews the practices of an **organisation** (data source or a data using service), **conducts** a DPIA and drafts data agreements and inter-company agreements for third parties |
| Auditor          | The individual who may be called in to review the data agreements and ensure they are in place in case of data breaches or regular inspection handled                                                |
| Data marketplace | The platform in a dataspace where organisations (DUS) can discover the data sources, and get into a trust relationship. Here the DS offers their data to potential DUS’.                                                                                             |

## Data Exchange Agreement overview

Figure 1 below illustrates a typical scenario where an organisation, Org. A, uses a DA to share data externally to Org B and Org C. Individual instances of the DA are signed by individuals X and Y. A DDA is used to govern the data exchange between Org A and Orgs B and C.

![](https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/docs/images/data-exchange-provenance-scenarios.svg)
*Figure 1. Data exchange and provenance scenarios*

## Data Exchange Agreement (DEXA) high-level workflow

As described in the background section, iGrant.io provides a decentralised data exchange service based on self-sovereign identity (SSI), OpenID Connect and OAuth protocols. The service enables organisations to exchange data in a transparent, secure and privacy-centric manner using verifiable data exchange agreements. The received data can be verified using SSI and X.509-based signatures. A DEXA workflow involves the following phases as illustrated below:

![](https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/docs/images/data-agreement-workflow.png)
*Figure 2. Different phases of DA and DDA lifecycle*

These different phases are explained below:

1. **Definition**: An existing agreement template is adopted as is or new ones are formulated in this phase. The template could be based on a particular industry and/or sector-specific practice. This can then be used by any organisation (DS or DUS) for a particular data usage purpose, in our case for enabling third party data exchange.

2. **Preparation**: An organisation creates an agreement based on a DPIA or similar and shares it with relevant parties . For a DA, the relevant counterparty is the individual while for the DDA, it is a DUS.

3. **Capture**: The counterparty signs the agreement in this phase. For a DDA, it is countersigned by the DUS while for a DA it’s the individual.

4. **Proof**: Any organisation or individual is able to demonstrate that an agreement exists between the parties. Independent auditors can also  check that  records  are in place proving that the individual's personal data may be processed (e.g. as per [GDPR Article 30](https://docs.igrant.io/regulations/reg-eu-gdpr#article-30-records-of-processing-activities)).

## DEXA workflow enabling data provenance

The four phases described above are further elaborated in Figure 3 and explains how the DAs and DDAs are interlinked in the DEXA workflow. To ensure their compliance with data regulations, each organisation is encouraged to perform a privacy risk assessment or DPIA and ensure that risk mitigation measures are in place before collecting and processing personal data.

![](https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/docs/images/da-dda-interlink-with-dxa-workflow.svg)
*Figure 3: DA and DDA interlink within DEXA workflow*

When a DDA is signed and personal data has been exchanged, the DS is not liable for the DUS's use of personal data. However, the obligation to monitor the individual’s consent to share data with a third party, in this case, the DUS, remains with the DS. The DUS is obliged to adhere to the terms laid out in the DDA. If the DUS does not adhere to the DDA, the DS can, upon finding out about the infringement, withdraw the DDA and consequently revoke all the DAs associated with the DDA.

Throughout the DA lifecycle, cryptographic proofs are generated detailing who created the DA during the preparation phase and who signed it during the capture phase [2]. This is based on a W3C (DID:mydata) specification [4] and realised via a Data Agreement DIDComm protocol [5] implementation.

The key activities and actors involved in each phase are summarised in the table below:

<table>
   <tr>
      <td><strong>#</strong>
      </td>
      <td><strong>Activity</strong>
      </td>
      <td><strong>Phase</strong>
      </td>
      <td><strong>Actors</strong>
      </td>
   </tr>
   <tr>
      <td colspan="4" >Assessment
      </td>
   </tr>
   <tr>
      <td>1.0
      </td>
      <td>
         Perform DPIA or similar privacy assessment (external or self-assessment)
         <p>
            <em>Output: DA template consisting of usage purpose, data attribute etc as per the DA schema</em>
         </p>
      </td>
      <td>Definition and preparation
      </td>
      <td>Assessor, DS, DUS
      </td>
   </tr>
   <tr>
      <td colspan="4" >For DS: Lawfully expose data and demonstrate provenance
      </td>
   </tr>
   <tr>
      <td>2.1
      </td>
      <td>
         If the organisation wishes to expose personal data to a third party, it creates the DDA offer, If required, publishes to a data marketplace
         <p>
            <em>Output: DDA is available and is ready for any DUS to sign. </em>
         </p>
         <p>
            <em>Provenance: action to create an entity (DDA) by an actor (DS).</em>
         </p>
      </td>
      <td>Definition and preparation
      </td>
      <td>DS
      </td>
   </tr>
   <tr>
      <td>2.2
      </td>
      <td>
         Add DUS when they sign up
         <p>
            <em>Output: DDA is updated with the DUS signatory info (during the DDA capture phase)</em>
         </p>
         <p>
            <em>Provenance: action to update and sign off entity (DDA) by an actor (DUS)</em>
         </p>
      </td>
      <td>Capture
      </td>
      <td>DUS
      </td>
   </tr>
   <tr>
      <td>2.3
      </td>
      <td>
         Any interested party can check the signed DDA <em>proof of compliant data usage.</em>
         <p>
            <em>Provenance: Query to view provenance metadata</em>
         </p>
      </td>
      <td>Proof
      </td>
      <td>Auditor, Individual, DS or DUS or any 3PP
      </td>
   </tr>
   <tr>
      <td>2.4
      </td>
      <td>
         Automated enforcement of DDA
         <p>
            <em>Provenance: query provenance metadata to ensure the signing of DDA is permitted</em>
         </p>
      </td>
      <td>
         Proof,
         <p>
            Capture
         </p>
      </td>
      <td>DS, DUS
      </td>
   </tr>
   <tr>
      <td colspan="4" >For DUS: Lawfully consume data and demonstrate provenance
      </td>
   </tr>
   <tr>
      <td>3.1
      </td>
      <td>If the organisation (DUS) wishes to consume data, it checks the available DDA offers in the marketplace.
      </td>
      <td>Definition and Preparation
      </td>
      <td>DUS
      </td>
   </tr>
   <tr>
      <td>3.2
      </td>
      <td>Organisation (DUS) signs up (Same as step 2.2)
      </td>
      <td>Capture
      </td>
      <td>DUS
      </td>
   </tr>
   <tr>
      <td>3.3
      </td>
      <td>DUS updates and register the DA based on the DDA
      </td>
      <td>Definition and Preparation
      </td>
      <td>DUS
      </td>
   </tr>
   <tr>
      <td>3.4
      </td>
      <td>Any interested party can check the signed DA proof of compliant data usage
      </td>
      <td>Proof
      </td>
      <td>Auditor, Individual, DS or DUS or any 3PP
      </td>
   </tr>
</table>


---

# Explore the concepts of Data Disclosure Agreements
Source: https://docs.igrant.io/concepts/data-disclosure-agreements-versions

---
id: mdo-dda-vocab-versions
title: Explore the concepts of Data Disclosure Agreements
description: See how data disclosure agreement versions evolve to support transparent, auditable data sharing between individuals and organisations.
hide_title: true
sidebar_label: DDA Vocabulary
keywords: [data disclosure agreements, DDA vocabulary, schema, data sharing, data governance, transparency, auditability]
slug: /data-disclosure-agreements-versions
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


The Data Agreement Vocabulary provides terms to describe and represent information related to processing of personal data based on established requirements such as for the EU General Data Protection Regulation (GDPR).

The table below provides different versions of the data agreement vocabulary.

* [Data Disclosure Agreement vocabulary - version 1.0](/schema/data-disclosure-agreements/v1.0/)

---

# Overview of Data Intermediation Service Provider
Source: https://docs.igrant.io/concepts/disp-overview/

---
id: disp-overview
title: Overview of Data Intermediation Service Provider
description: Learn how a Data Intermediation Service Provider facilitates secure, consent‑based data exchange between individuals and organisations.
hide_title: true
sidebar_label: Overview
keywords: [Data Intermediation Service, DISP, data exchange, MyData, data operator, EU Data Governance Act, consent, data sharing]
slug: /disp-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

A data intermediation service provider (DISP) is a key entity under EU regulations designed to facilitate the structured sharing and accessing of data between various parties. DISPs offer platforms, databases, or other infrastructures enabling data exchanges between data holders and potential users. These services may include the creation of bilateral or multilateral data exchange environments, platforms for joint data use, and specific setups to connect data holders with users. Additionally, DISPs play a crucial role in assisting data subjects - individuals whose personal data is handled - by providing the technical means necessary to make their data available while ensuring the exercise of their rights under EU data protection laws. DISPs must notify the competent authority before offering their services, ensuring adherence to regulatory standards and conditions, which include maintaining separate operations for their data intermediation activities and upholding non-discriminatory access to their services.

## What is a MyData Operator

MyData operators, as described in the [MyData Global Operator whitepaper](https://igrant.io/papers/Understanding-Mydata-Operators.pdf), are a specialised type of Data Intermediation Service Provider (DISP) centred on human-centric personal data management. They provide an 'infrastructure' that ensures interoperability at the technical, informational, and governance levels, thus facilitating the seamless flow of personal data across services. This approach is in alignment with the EU data strategy's emphasis on creating "data spaces," where data can be securely and efficiently shared under a framework that prioritises individual data rights and governance. As outlined in the EU Data Governance Act (Article 12), MyData operators play a pivotal role in realising the human-centric approach to data intermediation, essential for implementing the broader vision of the EU's data strategy. Their role underscores the importance of developing systems that support data exchange and enhance individuals' control over their personal information.

## MyData Operator ecosystem

A MyData Operator ecosystem realised by iGrant.io is as illustrated below. 

![](iGrant.io_mdo-ecosystem.svg)


A typical MyData Operator ecosystem is composed of actors holding one or more of the roles described below:

* **Individual**: This is the role of **data subject** as represented digitally in the ecosystem. In a MyData Operator model, the individual manages the use of personal data about themselves, for their own purposes, and maintain relationships with other persons, services, or organisations.

* **Data Operator**: The role responsible for operating the 'infrastructure' and providing tools for individuals in a human-centric system of personal data exchange. Operators enable people securely to access, manage, and use personal data about themselves as well as to control the flow of personal data within and between data sources and data using services. 

* **Data Source**: The role responsible for collecting, storing, and controlling personal data which persons, operators, and data using services may wish to access and use. 

* **Data Using Service**: The role responsible for processing personal data from one or more data sources to deliver a service

:::note
iGrant.io does **not** hold any data from the Data Source but provides the ability to verify the authenticity to any Data Using Service
:::

## Data sharing and data exchange

In iGrant.io MyData Operator, personal data flows from a Data Source to a Data Using Service based on the data agreements. The data agreements can be, for e.g., based on consent. 

In an **Active Data Exchange** (also referred to as **data sharing**), the user is actively involved in the exchange of data in real-time. E.g. data exchange using the data wallet functions. 

In **Passive Data Exchange**, the data is exchanged between the Data Source and Data Consumption Service based on a data agreement that was mutually endorsed  between the Individial and the organisations involved. 

## Data operator value proposition

Today, a typical organisation is forced to make a choice between digitalisation and data compliance. In a MyData Operator model, such as with iGrant.io, an organisation can continue to digitalise whilst being compliant to respective data regulations. It creates a WIN-WIN scenario between the individuals and organisations. This is further illustrated below.  
![](iGrant.io_mdo-valueprop.svg)
iGrant.io key value propositions as are as summarised below:

### Organisations

It helps organisations, both private and public, **unlock the value of personal data** in a regulatory compliant manner. The key enablers include:

> * Reduces risk of non-compliance with data regulation frameworks like for example, Europe’s General Data Protection Regulation (GDPR)
> * Provides API-centric tooling that can easily be integrated to existing IT systems
> * Empowers consumers to exercise their data subject rights thereby establishing and mantaining trust
> * Get access to higher quality personal data and larger data sets
> * Monetise their personal data assets apart from being able to leverage data as part of a personal data ecosystem

### Individuals

For individuals, it enables them to take control over their data via easy to use interfaces to exercise their data rights. Using a data wallet function, individuals are able to carry their data and reuse them where ever needed. E.g. Identity data or health certificates etc.  


---

# High-level Architecture
Source: https://docs.igrant.io/concepts/mdoDocs/mdo-main

---
id: mdo-main
title: High-level Architecture
hide_title: true
sidebar_label: Architecture
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


The iGrant.io MyData Operator (Also known as the Data Intermediation service provider as per the [EU Data Governance Act](https://docs.igrant.io/regulations/reg-eu-data-governance-act)) user guide primarily describes the platform functions for organisations and individuals. The purpose of this is to help any organisation admins with the on-boarding proces onto the iGrant.io platform and use the various services offered as a MyData Operator. 

## Architectural overview

The overall iGrant.io platform with software components delivering iGrant.io services are as illustrated below. 
![](mdo-platform-overview.webp)

### User interfaces
iGrant.io supports Operator admins, Organisations admins (Data Source and Data Using Service admins) as well as individuals. The supported user interfaces are as given:

#### Operator interface
This is towards operator admins and super admins to allow infratructure owner roles. 

#### Enterprise dashboard
The platform provides a SaaS admin portal for all Data Sources and Data Using Services to self-onboard to iGrant.io. Here, the administrator is able to perform admin functions that include:

* Self-onboarding and configuring the look and feel of organisational page for individuals
* Viewing/modifying/deleting data agreements and publish them to individuals
* Viewing/modifying/deleting data exchange agreements and compliance to the GDPR, and facilitating integrations between Data Sources and Data Using Services
* Simplifying admin queries for consents, with view/download options etc.
* Sending notifications to individuals (e.g., data breaches as per GDPR requirements)
* Configuring webhooks for a number of event types (e.g., GDPR data subject requests)
* Automated deployment of iGrant.io Cloudagents with trust anchor configured.

#### User preference center
Apart from providing all services as RESTful APIs, the platform also provides out-of-the-box mobile SDKs  (iOS and Android) and ReactJS portals that can be automatically deployed once the data agreement models are defined in the Enterprise Dashboard. 

##### Web portal
All functions with the mobile SDK are also available via a web portal (with multiple language support) and include a user preference centre, data rights management and the ability to view the data agreement logs.

### MyData Operator layer

#### RESTful APIs
All iGrant.io services are available as RESTful APIs that can be integrated to existing IT systems. The APIs are published at https://docs.igrant.io/docs/developer-apis/ and are segregated according to MyData Operator functional elements. 

#### Core backend components
As a certified MyData Operator, iGrant.io platform components are mapped to the MyData Operator reference model as laid out in the MyData Global Operator whitepaper [[3](https://igrant.io/papers/Understanding-Mydata-Operators.pdf)]. iGrant.io is committed to adhering to the MyData principles of ensuring human-centricity in digitalisation and continues to drive a fully interoperable, decentralised network of data operators that enables consented data sharing and exchange within a personal data ecosystem. 

### External systems

Apart from connecting to different Data Source (s) and Data Using Service (s), the platform provides integrations to external identity providers as well enable connections to third party ledgers (e.g. an organisations own ledger or nation wide or global ledgers).


## Onboarding

### For organisations
Once registered with iGrant.io,the MyData Operator platform, the admin user can self-define the organisation profle (logo, cover image, description etc.), and follows the steps as illustrated below. 

![](mdo-org-onboarding.svg)

All APIs are defined at [iGrant.io Developer page](https://docs.igrant.io/docs/developer-apis/). 

The webhook based notification services allow organisations to monitor and take actions for various events it is subscribed to.

### For individuals

The User of an organisation can access their personal data dashboard and data wallets via the organisations mobile app or webportal. 


---

# Mobile SDKs and Data Wallet
Source: https://docs.igrant.io/concepts/mdoDocs/mdo-mobagents

---
id: mdo-mobagents
title: Mobile SDKs and Data Wallet
sidebar_label: Mobile SDKs and Data Wallet
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


Apart from providing all services as RESTful APIs, the platform also provides out-of-the-box mobile SDKs  (iOS and Android). This consists of personal data dashboard features and data wallets as described below. It comes with multiple language support as well. 

## Architectural overview

The overall architecture of iGrant.io Data Wallet with software components is illustrated below. 
![](mdo-mobagents-overview.webp)

## Data Wallet Communication and Storage Stack

The overall architecture of iGrant.io Data Wallet communication and storage stack is illustrated below.
![](mdo-mobagents-storage-communication-stack.webp)

- Interaction between agents is using DIF DIDComm protocols which provides an end-to-end encrypted channel for - secure communication.
- Agents are connected to trust anchors for e.g. Indy to resolve and verify credential schemas and decentralised identifiers
- Every data exchange transaction is mutually signed cryptographically between the parties ensuring full auditability.


## Personal data dashboard

### User preference center

This provides individuals total transparency on what data is being used by the organisation down to the attribute level. Here, individuals can mark their preferences and choices concerning the sharing and controlling of their data down to the level of attributes and how they are used. The mobile app allows users to exercise their data subject rights in accordance with the GDPR.

### Data subject rights 

The user app provides an individual user to make specific personal data requests towards organisations and providing a way for follow up, for example based on GDPR **Data Subject Requests** as per [GDPR Chaper 3 Articles](https://gdpr-info.eu/chapter-3/). 

The specific web-based requests that needs workflow integrations are as given:
> * Data Download Requests ([Article 15](https://gdpr-info.eu/art-15-gdpr/), [Article 21](https://gdpr-info.eu/art-20-gdpr/))
> * Data Correction Requests ([Article 16](https://gdpr-info.eu/art-16-gdpr/))
> * Data Forget/Delete Requests ([Article 17](https://gdpr-info.eu/art-17-gdpr/))

### Data agreement logs

Here, all consents and data exchange transaction logs can be accessed by the user at any point of time. 


## Data wallet

iGrant.io provides a digital wallet (as a mobile agent) implemented using self-sovereign identity technology. It allows to stores credentials, keys, and other secrets necessary for self-sovereign identity. 

Data wallets enable entities to own their data. It facilitates portability and reusability of the data. Data wallets are digital containers for data that's required to control self-sovereign identity (SSI) and consents. Data wallets are based on Indy’s wallet implementation. The picture below shows the architecture for Indy based data wallet implementation.

![](mdo-data-wallet.png)

Data wallets will reside in a location that is owned or controlled by the entity. For example, on an individual's mobile device. iGrant.io offers the capability of cloud backup in external servers or in an organisation’s server. The platform provides entities with the necessary interfaces to interact with their data wallet: for example, a mobile application or a web application. Contents of the data wallet are encrypted using a master secret and stored to a pluggable storage for e.g. an SQLite database.

**SSI user agents:** A user agent provides individuals or organisations with a software component, that can act on their behalf and interact with others. An individual is provided with a mobile agent and an organisation with a cloud agent. Agent-to-agent communication is performed using interoperable DIDComm protocols: for example, issuing data based on schema, exchanging data with consent metadata etc.

:::note
iGrant.io data wallets are not limited to smartphones. The architecture allows the agents to be integrated on to any hardware, e.g. wearables. 
:::

The key functions enabled via the data wallet are:

> * Add certificates (credentials)
> * Exchange data (credentials)

### Add certificates

Provides ability for users to add data to the data wallet as per Self-Sovereign Identity mechanisms. 

### Data exchange

Provides ability for users to add data to the data wallet as per Self-Sovereign Identity mechanisms using a QR code or any HW device. 


---

# Personal Data Portal
Source: https://docs.igrant.io/concepts/mdoDocs/mdo-pdd

---
id: mdo-pdd
title: Personal Data Portal
sidebar_label: Personal Data Portal
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


Apart from providing all services as RESTful APIs, the platform also provides  ReactJS portals that can be automatically deployed once the data agreement models are defined in the Enterprise Dashboard. This comes with multiple language support and include a user preference centre, data rights management and the ability to view the data agreement logs.

## User preference center

This provides individuals total transparency on what data is being used by the organisation down to the attribute level. Here, individuals can mark their preferences and choices concerning the sharing and controlling of their data down to the level of attributes and how they are used. The portal allows users to exercise their data subject rights in accordance with the GDPR (General Data Protection Regulation).

## Data subject rights

The user portal provides the individual user to make specific personal data requests towards organisations and providing a way for follow up, for example based on GDPR **Data Subject Requests** as per [GDPR Chaper 3 Articles](https://gdpr-info.eu/chapter-3/). 

The specific web-based requests that needs workflow integrations are as given:
> * Data Download Requests ([Article 15](https://gdpr-info.eu/art-15-gdpr/), [Article 21](https://gdpr-info.eu/art-20-gdpr/))
> * Data Correction Requests ([Article 16](https://gdpr-info.eu/art-16-gdpr/))
> * Data Forget/Delete Requests ([Article 17](https://gdpr-info.eu/art-17-gdpr/))


## Data agreement logs

Here, all consents and data exchange transaction logs can be accessed by the user at any point of time. 


---

# Explore the Minimum Disclosure Option (MDO) Model
Source: https://docs.igrant.io/concepts/mdoDocs/mdo-ref-model

---
id: mdo-ref-model
title: Explore the Minimum Disclosure Option (MDO) Model
description: Understand the MDO reference model, which enables privacy‑preserving sharing of only essential data in digital identity transactions.
hide_title: true
sidebar_label: Reference Model
keywords: [MDO reference model, MyData operator, identity management, OpenID Connect, data agreements, ISO 27560, privacy, consent]
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


In relation to Data Intermediation Service Providers (DISPs), the MyData operator (also known as a **Data Intermediation Service Provider** per EU DGA Article 10/12) presents a refined model encompassing nine core functional elements crucial for the management of personal data. The reference model, illustrated below from the MyData Operator paper, facilitates the use of personal data in a transparent and human-centric manner and supports interoperability among data operators through open and standardised interfaces.
![MyData Operator Reference Model](iGrant.io_mdo_referencemodel.svg)
:::note
The functional elements depicted in the reference model are specifically selected for their relevance to the MyData framework and their direct value to individuals. It is crucial to note that not all operators will incorporate every functional element as the model is not intended as a template for a single, comprehensive implementation.
:::

## Identity management

The iGrant.io identity management handles authentication and authorisation of individuals and organisations using the data exchange and verification services. The supported user roles are owners, admins, developers, auditors, verifiers and DPOs.

iGrant.io IDM is implemented using the Keycloak open-source IAM platform - see https://www.keycloak.org/) which offers OpenID connect / OAuth 2.0 protocols and end-points. It provides functions to federate different identity solutions compliant with OpenID Connect/OAuth2.0 and SAML, compliant with Web 2.0 standards. For example, the Data Source and Data Using service could be using different national identity solutions. In Sweden, the solution already integrates with BankID and the intention is to integrate with other national ID systems including eIDAS.

The solution also enables self-sovereign identity via the use of decentralised identifiers (DIDs) with a DID Registry and Verified Credentials (VC), all as per the Web 3.0 (W3C specification).
## Permissions and consents

Permission management enables human-centric control of personal data where  individuals can view, grant, revoke, and modify different kinds of permissions related to data flows. It enables individuals to manage and have an overview of data transactions, interactions and to execute their legal rights  (e.g. as per GDPR).

Being a consented data exchange platform, permission management is a foundational component in iGrant.io. This is released via the concept of "Data Agreements" (DA) that records the conditions for an organization to process personal data in accordance with privacy regulation (e.g. GDPR) captured in a signed receipt given to the individual. 

Using iGrant.io services, organisations can manage DAs and its lifecycle. With a DA, an organisation can be transparent about what data is being used and based on what lawful basis the data is processed, e.g. contract, legal obligation, vital interests, public task, legitimate interests and consents as per Article 6 in the GDPR. Using the DA, the individual is able to transparently view all different usage purposes for which their personal data is used. For data exchange with consents, the individual can opt-in/opt-out to any purpose, down to the attribute level. The Data Agreement is based on standards like Kantara. It's being enhanced to cater towards granular consents and is being standardised via ISO27560 and via DIF (Decentralised Identity).

The typical end to end use case for enabling permissions and consents in iGrant.io is described below:
> 1. Organisation (admin) registers their data model and configures the data agreement that consists of the usage purpose, the data attributes used by the ageement, lawful basis, data policy configurations etc. In this case, the lawful basis for the data agreement is "Consent".
> 
> 2. The org publishes the purpose to its individual users. 
> 
> 3. The individuals are able view at the relevant granularity levels (aka attribute level e.g. name, phone number) respective data. It allows individuals to exercise their rights (their data subject rights as per GDPR Article 12-23) and they can opt-in and opt-out of any data usage at various granularity levels, where consent is used as a lawful basis. This can be done in real-time.

In the use of Data Agreement with consent as the lawful basis, iGrant.io complies to **Kantara** and emerging **ISO** standards for Data Agreement (or consent) receipts. 

With iGrant.io, an organisation can be transparent about what data is being used and based on what lawful basis the data is processed, e.g. contract, legal obligation, vital interests, public task, legitimate interests and consents as per Article 6 in the GDPR. The individual is then able to transparently view all different usage purposes for which their personal data is used. For data exchange with consents, the individual is able to opt-in/opt-out to any purpose, at the attribute levels. 

## Service management

iGrant.io, as a MyData Operator or Data Intermediary, operates in an ecosystem with Individuals, Data Sources and Data Using Services. In order to navigate this ecosystem, the various actors are linked through the iGrant.io service registry. Service management onboards the various actors within the ecosystem. The human-centric manifestation of service management is the possibility for individuals to manage the relationships and connections to different data sources and data using services in the ecosystem.

iGrant.io enables a multi-operator environment via a distributed service registry at two levels: one at the individual level, the other at the organisational level. 

![](iGrant.io_svm.svg)

In figure above, A, B and C are organisations (**Data Sources** and **Data Using Services**) while the dotted circle represents the ecosystem and the governance framework facilitating data exchange via the use of data agreements. iGrant.io has filed an international patent on facilitating a consented data exchange. 

### Organisation level
For organisations, it involves the controller and processor agreement handling as part of a data ecosystem. This includes functions like organisation onboarding/provisioning, managing organisation users, adding end users or consumers to organisation, data agreement handling between organisations and individuals for data exchange, data regulation and compliance management etc.

### Individual level 
For individuals, the service management function lies in enabling a decentralised application (dApp). This includes functions like registrations, user profile management, subscription to a specific organisation etc. Every use of personal data is handled via a Data Agreement.

## Value exchange

A sustainable business model is a requisite for any ecosystem. In a MyData Operator ecosystem, this means that all of the actors in the ecosystem need to have more benefits than mere costs. Both benefits and costs can be also non-monetary in nature. 

The current iGrant.io value exchange features focus on an end-user based licensing model helping organisations to be compliant with regulations while enabling data exchange. Enhanced value exchange offering is driven by specific customer cases and their business models. In our current offering, the platform has a fully auditable transaction model that builds the ecosystem for deriving value from a personal data exchange scenario in a lawful manner. 

For individuals, time and effort spent can be a big cost and benefits often come in the form of services that makes their lives easier, for e.g. providing better convenience. As data operators provide technical infrastructure for making multi-party data transactions possible, they are in a natural position to keep track of such transactions for the purposes of payments and billing or creating other forms of rewards, such as loyalty and bonus points. Operators may provide a standard ‘accounting’ mechanism which transparently keeps a log of the data transactions so that the different parties in the ecosystem may use it as the base for payments between the parties. Using data as the means of payment and paying individuals for their data are contentious issues. 
 
iGrant.io platform keeps track of all data agreement transactions and data exchange. This can be accessed via respective APIs and the current model is to let organisations decide the value exchange model. The “monetisation” is dependent on the customer scenarios, for example, discounts for providing a consented sharing of personal data.

## Data model management

Data model management, as an operator functionality facilitates translation of one data model to another with the target to enable scalability, interoperability, and re-usability.

In iGrant.io data exchange services, organisations define their data models via Data Agreements implemented via standardised protocols such as DIDComm and SSI Agents (E.g. Aries protocols stacks). Every data transaction has an associated auditable and verifiable Data Agreement that records conditions for an organization to process personal data in accordance with data regulations and are often formulated automatically following a Data Protection Impact Assessment (DPIA). It is captured as a signed receipt given to the individual.

iGrant.io supports all CRUD operations on Data Agreements to enable services for managing data models for any organisation. It also supports the translation of one data model to another with the target to enable scalability, interoperability, and re-usability. The services are used for transparency, compliance, facilitating agreement handling between ecosystem players and exercising personal data rights in a standardised manner.

For more information on data agreements and related W3C standards, refer the [Data Exchange open specs](https://github.com/decentralised-dataexchange/automated-data-agreements), contributed as part of European Union [NGI-Trust eSSIF-Lab infrastructure project engagement](https://essif-lab.eu/automated-data-agreements-to-simplify-ssi-work-flows-by-igrant-io/).

## Personal data exchange

Personal data exchange, facilitated by a MyData Operator, is key to data portability, as well as the access and re-use of personal data. This functionality realises the interfaces that allow data exchange between **Data Sources** and **Data Using Services **in a standardised and secure manner. 

In the iGrant.io model, personal data transfers from a Data Source to a Data Using Service are endorsed via **Data Agreements**. Data agreements are based on different legal bases, (e.g. consent, lawful purpose, contract, legal obligation, vital interests, public task and legitimate interests etc). If they’re without consent, individuals will only have limited or no rights to withdraw the consent, however, the individual can still follow what data is processed and why. For more information on data agreements and related W3C standards, refer to the Decentralised [Data Exchange open specs](https://github.com/decentralised-dataexchange/automated-data-agreements), contributed as part of European Union NGI-Trust eSSIF-Lab ADA project.

Data exchange can be of two types active and passive, depending on the individual’s involvement in real-time, 1) Active Data Exchange and 2) Passive Data Exchange:

![](mdo-dataexchange.svg)

### Active Data Exchange

In an **Active Data Exchange**, the individual is actively involved in the exchange of data in real-time, for example via a Data Wallet. A Data Agreement is signed during any data exchange. This can further be of two types:
 
1. Active Data Exchange using a Data Wallet: In this form of Active Data Exchange, the individual holds the data and uses the data to any Data Using Service.

2. Active Data Exchange using notifications: In this form of Active Data Exchange, the individual is notified of a request to use their data by the Data Using Service and the individual agrees to a data exchange from a given Data Source. 

The picture below illustrates the active data exchange with the use of a data wallet.

![](ddx-active-dataexchange.svg)

The complete scenario of an active data exchange with an interoperable iGrant.io Data Wallet is described in the following demonstration video.

[![Video](https://img.youtube.com/vi/NF81dlISBeA/0.jpg)](https://www.youtube.com/watch?v=NF81dlISBeA "iGrant.io Data Wallet")

### Passive data exchange

In **Passive Data Exchange**, the data is exchanged between the Data Source and Data Using Service based on a Data Agreement that was mutually endorsed between the Individual and the organisations (Data Source or Data Using Service) involved.Here, iGrant.io facilitates the direct transfer based on a individual’s valid permission or consent (If consent is the lawful basis for such transfer). 

The picture below illustrates the active data exchange with the use of a data wallet.

![](ddx-passive-dataexchange.svg)

:::note
With iGrant.io, a Data Using Service can engage in agreements with various Data Sources, facilitating the relationship between a data controller or data processor (as defined in the GDPR). iGrant.io takes a data minimisation approach to personal data transfer where only the consent and transaction logs are stored as well as identity data. iGrant.io does not store the actual data that is being exchanged.
:::

## Personal data storage

A Personal Data Store (PDS) helps individuals to gather, store, manage, use and share information needed to manage and organize one’s life better. It provides the individual tools to control what information is shared with whom and when. This data is originally issued by a Data Souces and iGrant.io helps data to be integrated from multiple sources in the individuals device – harmonising, using and re-sharing it under the individual’s control.

iGrant.io platform client SDKs and a decentralised PDS (dPDS) Data Wallet that acts as data source for individuals. In the dPDS models, the individual aggregates and holds personal data from multiple Data Sources without storing it in the iGrant.io cloud. Using iGrant.io services, individuals can grant permission and transfer that data to any Data Using Service in real-time or otherwise. An individual's personal data can be exchanged between different organisations based on the individual’s preference and all transactions are fully auditable. 

Although iGrant.io provides any data that can be added to a personal data wallet by the individual, as a platform, iGrant.io has a data minimalistic posture and stores only data relevant to identify a person (e.g., email ID and mobile number) and to federate that identity within an ecosystem. iGrant.io also stores an individual’s consent and various transaction logs which can also be reused as a data source if the individual so desires.

Using this model, Data Sources and Data Using Services are connected via the individual. This configuration reduces legal liabilities whilst enabling greater control to individuals. As the person with the PDS is technically in the centre of the data transactions, it can be considered also a highly human-centric approach for data transactions.

## Governance support 

A governance support framework helps mediate the relationships between people and organisations. The iGrant.io framework builds on the MyData principles, facilitates compliance with regulations and honours individual rights, supporting individuals, organisations as well as ecosystem partners. In iGrant.io, Data Agreements records conditions for an organization to process personal data. 

The key governance aspects are:

* Data Agreement between Data Sources and the individual with a set of governance mechanisms to ensure sustainable data usage and data exchange

* Data is cryptographically signed and can be verified for its authenticity and origin

* Every data transaction is associated with a cryptographically signed Data Agreement that can be traced, is tamper-proof and can be audited by independent third parties

* Tamper-proof logging of all data agreements and data exchange enables multi-party trust handling via decentralised identifiers (DID) and verified credentials (VC)

### Webhooks-based event dispatchers

iGrant.io uses event-based dispatchers where organisations can configure their receiving payload URLs. Any user or other events will result in notification to the organisation that can be integrated as part of the IT workflow. 

### Event notifications

iGrant.io provides organisations to issue notifications for specific events. This could be used to comply to GDPR during data breaches. These APIs can be integrated to an organisations to enable self governing notifications towards users as part of automating compliance.  

## Accountability and logging

Transparency and accountability are important principles and prerequisites in many legislations. Accountability can enhance assurance and logging can mitigate risks of misuse or unintended use. Logging is not the sole responsibility of the operators and has counterparts in data sources and data using services.

Accountability arrangements may flow from the rules and regulations in the underlying governance framework, but many proto-operators work without an explicit governance framework. Even in those cases, operators have to comply with the relevant legislation that often includes logging and accountability obligations. In general, governance implies some accounting obligations; but if no explicit governance applies, logging and accountability are still needed for auditability and transparency.

iGrant.io provides logging of all data transactions in the form of signed data agreements. Organisations can opt to choose a DLT-based or non-DLT based immutable logging. Access logging, security logs and various other types of logs are stored and made available only for organisations. These logs are available in a decentralised manner (implemented via user and organisation agents) for both individuals and organisations. 

---

# EU Implementing Regulations Overview
Source: https://docs.igrant.io/regulations/implementing-acts-overview/

---
id: implementing-acts-overview
title: EU Implementing Regulations Overview
description: Browse all EU Implementing Regulations for the European Digital Identity Framework, covering EUDI Wallet certification, protocols, trust frameworks, and more.
keywords: [EU Implementing Regulations, eIDAS 2.0, EUDI Wallet, Implementing Acts, certification, trust framework, digital identity, European Digital Identity]
hide_title: true
sidebar_label: Overview
slug: /implementing-acts-overview/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import RegulationOverview from '@site/src/components/RegulationCard';

<RegulationOverview />


---

# European Business Wallets
Source: https://docs.igrant.io/regulations/reg-eu-business-wallets/

---
id: reg-eu-business-wallets
title: European Business Wallets
description: The full text of the proposed EU Regulation on the establishment of European Business Wallets (COM(2025) 838 final), a Commission proposal not yet adopted.
sidebar_label: European Business Wallets (proposed)
keywords: [European Business Wallet, EBW, COM(2025) 838, 2025/0358(COD), eIDAS, digital identity, legislative proposal, ordinary legislative procedure]
slug: /reg-eu-business-wallets/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>European Business Wallets: proposed EU Regulation | iGrant.io DevDocs</title>
   <meta name="description" content="The full text of the proposed EU Regulation on the establishment of European Business Wallets (COM(2025) 838 final), a Commission proposal not yet adopted."/>
</head>

<span className="status-chip status-chip--proposed">Proposed</span>

:::caution Not yet adopted: this is a proposal
This page reproduces the text of a **Commission legislative proposal**, not an act that is in force. On 19 November 2025 the European Commission tabled the **Proposal for a Regulation of the European Parliament and of the Council on the establishment of European Business Wallets** (**COM(2025) 838 final**), under the ordinary legislative procedure (procedure reference **2025/0358(COD)**).

As a proposal it has **no legal effect**, and its content, article numbering and timelines **may change** during negotiation between the European Parliament and the Council before any adoption. The articles below are reproduced from the Commission's proposed text; treat them as indicative, not as settled law.
:::

The proposed Regulation would establish **European Business Wallets (EBWs)**, a digital solution allowing an EBW owner (an economic operator or a public sector body) to securely store, manage and present owner identification data and electronic attestations of attributes, to sign and seal, to exchange documents and legally valid notifications, and to manage mandates given to authorised representatives. It builds on the European Digital Identity framework (see the <a href="/regulations/reg-eu-digital-id-framework/">European Digital ID Framework</a>) and extends the wallet concept from natural persons to organisations.

### At a glance

| | |
| --- | --- |
| **Document** | COM(2025) 838 final |
| **Type** | Proposal for a Regulation of the European Parliament and of the Council |
| **Procedure** | 2025/0358(COD), ordinary legislative procedure |
| **Proposed on** | 19 November 2025, by the European Commission (Brussels) |
| **Legal basis** | Article 114 of the Treaty on the Functioning of the European Union (TFEU) |
| **Status** | Proposed, not yet adopted |

The full text of the proposal, including its recitals, is available on EUR-Lex [here](https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:52025PC0838). The enacting terms and the Annex are reproduced below.


## Chapter I - Subject matter, scope and definitions

### Article 1: Subject matter

This Regulation enables secure digital identification and authentication, data sharing and legally valid notifications, reduces administrative burdens and compliance costs, and supports cross-border business and competitiveness. In particular, it:

- (1) establishes a framework for the provision of European Business Wallets;
- (2) establishes the principle of equivalence, giving equivalent legal effect to actions and transactions carried out through a European Business Wallet as to actions and transactions lawfully carried out in person, in paper form, or via any other means or processes that would be deemed compliant with applicable legal, administrative, or procedural requirements;
- (3) establishes rules for the issuance of European Business Wallet owner identification data for the identification of economic operators and public sector bodies;
- (4) establishes the European Digital Directory;
- (5) designates the European unique identifier (EUID), as established and governed by Directive (EU) 2017/1132, as the unique identifier for European Business Wallet owners, and establishes a similar unique identifier for European Business Wallets owners to whom the European Unique Identifier is not available;
- (6) lays down the notification mechanism under which providers of European Business Wallets shall be established;
- (7) lays down obligations for public sector bodies concerning European Business Wallets;
- (8) provides a framework for the supervision of Union entities, where such public sector bodies provide European Business Wallets;
- (9) provides a framework for the recognition of third-country systems similar to the European Business Wallets and the issuance of European Business Wallets to third country economic operators.

### Article 2: Scope

**1.** This Regulation applies to the provision and acceptance of European Business Wallets and the issuance and acceptance of European Business Wallet owner identification data, and to the use of European Business Wallets by economic operators and public sector bodies.

**2.** This Regulation is without prejudice to the existing systems and procedures mandated by Union law governing the exchange of documents and data between competent authorities.

### Article 3: Definitions

For the purposes of this Regulation, the following definitions apply:

  - (1) ‘European Business Wallet’ means a digital solution that allows European Business Wallet owners to securely store, manage, and present European Business Wallet owner identification data and electronic attestations of attributes to Business Wallet-relying parties and other entities using European Business Wallets and European Digital Identity Wallets for the following purposes:
    - (a) to authenticate and provide the verified proofs required by a relying party;
    - (b) to access and use electronic attestations of attributes, electronic signatures, electronic seals, electronic registered delivery services, and electronic time stamps;
    - (c) to enable the creation, management and delegation of mandates to authorised representatives;

and that may support additional functionalities in accordance with this Regulation;

  - (2) ‘European Business Wallet owner identification data’ means a set of data that enables the establishment of the identity of a European Business Wallet owner and that is issued by a provider of European Business Wallet owner identification data;
  - (3) ‘provider of European Business Wallet owner identification data’ means a qualified trust service provider or public sector body or the Commission issuing European Business Wallet owner identification data;
  - (4) ‘economic operator’ means any natural or legal person, or a group of such persons, including temporary associations of undertakings, acting in a commercial or professional capacity for purposes related to their trade, business, craft or profession;
  - (5) ‘public sector body’ means a Union entity, a national, state, regional or local authority, a body governed by public law or an association formed by one or several such entities or bodies, or a private entity mandated by at least one such entities, authorities, bodies or associations to provide public services, when acting under such a mandate;
  - (6) ‘Union entity’ means a Union institution, body, office and agency set up by or pursuant to the Treaty on European Union, the Treaty on the Functioning of European Union or the Treaty establishing the European Atomic Energy Community;
  - (7) ‘European Business Wallet owner’ means an economic operator or public sector body that owns or has a right of use of a European Business Wallet;
  - (8) ‘trust service’ means trust service as defined in Article 3, point (16) of Regulation (EU) 910/2014;
  - (9) ‘attribute’ means attribute as defined in Article 3, point (43) of Regulation (EU) 910/2014;
  - (10) ‘electronic attestations of attributes’ means electronic attestations of attributes as defined in Article 3, point (44) of Regulation (EU) No 910/2014;
  - (11) ‘qualified attestation of attributes’ means qualified attestation of attributes as defined in Article 3, point (45) of Regulation (EU) No 910/2014;
  - (12) ‘European Digital Identity Wallet’ means European Digital Identity Wallet as defined in Article 3, point (42) of Regulation (EU) No 910/2014;
  - (13) ‘electronic signature’ means an electronic signature as defined in Article 3, point (10) of Regulation (EU) No 910/2014;
  - (14) ‘qualified electronic signature’ means a qualified electronic signature as defined in Article 3, point (12) of Regulation (EU) No 910/2014;
  - (15) ‘electronic seal’ means an electronic seal as defined in Article 3, point (25) of Regulation (EU) No 910/2014;
  - (16) ‘qualified electronic seal’ means qualified electronic seal as defined in Article 3, point (27) of Regulation (EU) No 910/2014;
  - (17) ‘qualified electronic stamp’ means a qualified electronic stamp as defined in Article 3, point (34) of Regulation (EU) No 910/2014;
  - (18) ‘authorised representative’ means a natural or legal person acting on behalf of the European Business Wallet owner in executing and operating functions of a designated European Business Wallet on the basis of an authorisation granted by a European Business Wallet owner;
  - (19) ‘mandate’ means the authorisation granted by a European Business Wallet owner to an authorised representative, enabling that representative to act on behalf of the owner in executing and operating functions of a designated European Business Wallet;
  - (20) ‘electronic document’ means an electronic document as defined in Article 3, point (35) of Regulation (EU) No 910/2014;
  - (21) ‘qualified electronic registered delivery service’ means a qualified electronic registered delivery service as defined in Article 3, point (37) of Regulation (EU) No 910/2014;
  - (22) ‘user’ means a natural or legal person, or a natural person representing another natural person or a legal person, that uses European Business Wallets or European Business Wallet electronic identification means provided in accordance with this Regulation;
  - (23) ‘European Business Wallet-relying party’ means a natural person, an economic operator or public sector body that relies upon European Business Wallets;
  - (24) ‘wallet unit attestation’ means a data object that describes the components of the European Business Wallet unit or allows authentication and validation of those components;
  - (25) ‘European Business Wallet unit’ means a unique configuration of a European Business Wallet solution that includes European Business Wallet front-end and European Business Wallet back-end, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a provider to a European Business Wallet to a specific European Business Wallet owner;
  - (26) ‘European Business Wallet solution’ means a combination of software, hardware, services, settings, and configurations, including European Business Wallet front-end and back-end, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;
  - (27) ‘critical assets’ means assets within or in relation to a European Business Wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, that would have a very serious, debilitating effect on the ability to rely on the European Business Wallet unit;
  - (28) ‘wallet secure cryptographic application’ means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;
  - (29) ‘wallet secure cryptographic device’ means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;
  - (30) ‘trust service provider’ means a trust service provider as defined in Article 3, point (19) of Regulation (EU) No 910/2014;
  - (31) ‘qualified trust service provider’ means qualified trust service provider as defined in Article 3, point (20) of Regulation (EU) No 910/2014;
  - (32) ‘electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source’; means a electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source as defined in Article 3, point (46) of Regulation (EU) No 910/2014;
  - (33) ‘authentic source’ means authentic source as defined in Article 3, point (47) of Regulation (EU) No 910/2014;
  - (34) ‘attestation scheme’ means a set of rules applicable to one or more types of electronic attestation of attributes;
  - (35) ‘catalogue of schemes means a digital repository listing schemes for the attestation of attributes registered in accordance with this Regulation and that is maintained and published online by the Commission;
  - (36) ‘European unique identifier’ means the European Unique Identifier referred to in Directive (EU) 2017/1132;
  - (37) ‘national register’ means an official database or system established and maintained by or on behalf of a national government or its designated authority, which records, stores, and manages information pertaining to legal entities, including but not limited to companies, partnerships, foundations, associations as well as businesses as natural persons such as sole-traders and self-employed persons or other registrable persons or organisations;
  - (38) ‘API’ or ‘Application Programming Interface’ means a set of definitions and protocols for building and integrating application software to share data;
  - (39) ‘submission’ or ‘submit 'means any transmission of structured or unstructured data, files, forms, or records by between a public sector body and an economic operator or between economic operators or between public sector bodies, where such transmission is required, requested, or permitted under Union or national law, and is intended to support a legal, administrative, or procedural purpose;
  - (40) ‘notification’ means any transmission of information, decisions, requests, or acknowledgements between a public sector body and an economic operator or between economic operators or between public sector bodies, which is required, requested, or permitted under Union or national law, and which is intended to produce legal effects or inform the recipient of rights, obligations, or procedural developments;
  - (41) ‘administrative procedure’ means a sequence of actions, defined by Union or national law, that must be taken by economic operators or public sector bodies to comply with obligations, provide information, or obtain a decision, authorisation, or benefit from a public sector body in the exercise of administrative functions;
  - (42) 'European Business Wallet front-end' means the user interface component, regardless of platform or form factor, that interacts with users acting on behalf of the owner, and is part of the European Business Wallet unit;
  - (43) 'European Business Wallet back-end' means the server-side components, including software, services, and infrastructure, that provide the necessary functionality and support for the European Business Wallet Frontend, and form part of the European Business Wallet unit.

## Chapter II – European Business Wallets

### Article 4: Principle of equivalence

Where a European Business Wallet owner makes use of any of the core functionalities of a European Business Wallet referred to in Article 5(1), the resulting action shall have the same legal effect as if the action had been lawfully carried out in person, in paper form, or via any other means or processes that would be deemed compliant with applicable legal, administrative, or procedural requirements.

Where a self-employed person or a sole trader makes use of the qualified electronic registered delivery service in the circumstances set out in Article 5(3), the resulting action shall have the same legal effect as if the action had been lawfully carried out in person, in paper form, or via any other means or processes that would be deemed compliant with applicable legal, administrative, or procedural requirements.

### Article 5: Core functionalities of European Business Wallets

**1.** Providers of European Business Wallets shall ensure that the European Business Wallets they provide enable European Business Wallet owners to make use of the following core functionalities:

  - (a) securely issue, request, obtain, select, combine, store, delete, share and present electronic attestations of attributes;
  - (b) selectively disclose European Business Wallet owner identification data and attributes contained in electronic attestations of attributes, in the context of the functionalities listed in point a;
  - (c) request and share European Business Wallet owner identification data and electronic attestations of attributes in a secured way between European Business Wallets and European Digital Identity Wallets and with European Business Wallet-relying parties;
  - (d) sign by means of qualified electronic signatures and seal by means of qualified electronic seals, as applicable;
  - (e) bind data in electronic form to a particular time by means of qualified electronic time stamps;
  - (f) issue electronic attestations of attributes to European Business Wallets and European Digital Identity Wallets;
  - (g) issue electronic attestations of attributes through the European Business Wallet of the owner, allowing the issued attestation to be linked to other relevant attestations forming part of a chain;
  - (h) enable the use of qualified and non-qualified electronic attestations of attributes to allow European Business Wallet owners and their authorised representatives to authenticate themselves;
  - (i) transmit and receive electronic documents and data by means of a qualified electronic registered delivery service capable of supporting confidentiality and integrity;
  - (j) authorise multiple users to access and operate the European Business Wallet of the owner, and for the European Business Wallet owner to manage and revoke such authorisations;
  - (k) authorise European Business Wallet-relying parties to request electronic attestations of attributes issued to the European Business Wallet owner, and for the European Business Wallet owner to manage and revoke such authorisations;
  - (l) export their data, including issued European Business Wallet owner identification data, electronic attestations of attributes, communication logs, and interaction records, in a structured, commonly used and machine-readable format, at the request of the owner or in the event of termination of service or revocation of the notification of the provider of the European Business Wallet;
  - (m) access a log of all transactions;
  - (n) access a common dashboard for accessing, storing and verifying communications exchanged through the qualified electronic registered delivery service referred to in point (i).

**2.** Providers of European Business Wallets may offer additional functionalities beyond those listed in paragraph 1 provided that such functionalities do not interfere with or compromise the confidentiality, availability, or integrity of the minimum core functionalities, and the reliability and interoperability of the European Business Wallets they provide.

**3.** Providers of European Business Wallets shall enable the provision of the qualified electronic registered delivery service referred to in paragraph 1, point (i) as a standalone service to users of European Digital Identity Wallets.

**4.** Providers of European Business Wallets shall implement the functionalities referred to in paragraph 1 in accordance with requirements set out in the Annex.

**5.** The Commission shall, by means of implementing acts, establish a list of reference standards and where necessary, establish specifications and procedures for the core functionalities of European Business Wallets referred to in paragraph 1 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 19.

### Article 6: Technical features for European Business Wallets

**1.** Providers of European Business Wallets shall ensure that the European Business Wallets they provide support common protocols and interfaces:

  - (a) for the issuance of European Business Wallet owner identification data, qualified and non-qualified electronic attestations of attributes and qualified and non-qualified certificates to European Business Wallets;
  - (b) for European Business Wallet-relying parties to request and validate European Business Wallet owner identification data and electronic attestations of attributes;
  - (c) for the sharing and presenting to European Business Wallet-relying parties of European Business Wallet owner identification data, electronic attestation of attributes and of selectively disclosed data;
  - (d) to allow interaction with the European Business Wallets automatically without manual intervention or through direct user action;
  - (e) to securely onboard the European Business Wallet owner remotely via an authorised representative with an electronic identification means of that authorised representative which meets the requirements of Regulation (EU) No 910/2014 with regard to the assurance levels ‘substantial’ or ‘high’;
  - (f) for interaction between European Business Wallets, and between European Business Wallets and European Digital Identity Wallets for the purpose of receiving, validating and sharing European Business Wallet owner identification data and electronic attestations of attributes in a secure manner;
  - (g) for authenticating European Business Wallet-relying parties by implementing authentication mechanisms, where authentication is required;
  - (h) for European Business Wallet-relying parties to verify the authenticity and validity of European Business Wallets, where the verification of the authenticity and validity is required;
  - (i) for the provision of the qualified electronic registered delivery service referred to in Article 5(1), point (i), including an interface to the European Digital Directory established pursuant to Article 10;
  - (j) for the assigning to each European Business Wallet owner, for the purposes of the qualified electronic registered delivery service referred to in Article 5(1), point (i) and the European Digital Directory referred to in Article 10, at least one unique digital address;
  - (k) for the provision of wallet unit attestations to all European Business Wallet units, containing public keys and corresponding private keys protected by a wallet secure cryptographic device;
  - (l) for the management of critical assets, for the use of at least one wallet secure cryptographic application and wallet secure cryptographic device and, where critical assets relate to performing electronic identification at assurance level substantial, for ensuring that such cryptographic operators or other operations processing critical assets are performed in accordance with the requirements for the characteristics and design of electronic identification means at assurance level substantial as set out in Commission Implementing Regulation (EU) 2015/1502.

**2.** Providers of European Business Wallets shall also:

  - (a) ensure that the European Business Wallet owner identification data is digitally associated with the European Business Wallet of the owner;
  - (b) ensure that, for the purposes of the functionality referred to in Article 5(1), point (j):
    - mappings between roles and attributes are verifiable, auditable, revocable and traceable to their legitimate issuers;
    - conflicts of roles, over-delegation, or expired authorisations are automatically detected and prevented in real time;
    - all authorisation logic is interoperable across Member States.
  - (c) ensure security-by-design;
  - (d) provide validation mechanisms, in order to ensure that the authenticity and validity of European Business Wallets can be verified;
  - (e) provide a mechanism enabling European Business Wallet owners to easily request technical support and report technical problems or any other incidents having a negative impact on the use of European Business Wallets;
  - (f) ensure that the validity of the European Business Wallets can be revoked in the following circumstances:
    - upon the explicit request of the European Business Wallet owner;
    - where the security of the European Business Wallet has been compromised;
    - upon the permanent or temporary cessation of activity of the European Business Wallet owner;
    - where the provider of the European Business Wallet is not included in the list referred to in Article 12(5).
  - (g) without undue delay, notify to the Commission:
    - the mechanism allowing for the validation of the European Business Wallet owner identification data;
    - the mechanism by which to validate the authenticity and validity of European Business Wallets.

**3.** The Commission shall make available the information notified pursuant to paragraph 2, point (g) of this Article to the public through a secure channel, in electronically signed or sealed form suitable for automated processing.

**4.** Providers of European Business Wallets shall implement the technical features provided for in paragraphs 1 and 2 in accordance with the requirements set out in the Annex.

**5.** The Commission shall, by means of implementing acts, establish a list of reference standards and where necessary, establish specifications and procedures for the technical features of European Business Wallets provided for in paragraphs 1, 2 and 3 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 19.

### Article 7: Requirements and obligations for providers of European Business Wallets

**1.** European Business Wallets shall be provided by providers of European Business Wallets that are included in the list established pursuant to Article 12(5).

**2.** Given the role of European Business Wallets in the Unions digital infrastructure, providers of European Business Wallets shall be established in the Union, have their principal place of business and main operations in the Union and not present a risk to the security of the Union. In particular they shall not be subject to control by a third country or by a third-country entity.

**3.** Providers of European Business Wallets shall comply with the requirements set out in Article 19a of Regulation (EU) 910/2014. That obligation shall not apply to providers of European Business Wallets that are qualified trust service providers.

**4.** Providers of European Business Wallets shall comply with the requirements set out in Directive (EU) 2022/2555 of the European Parliament and of the Council on measures for a high common level of cybersecurity across the Union.

**5.** Providers of European Business Wallets shall comply with applicable cybersecurity requirements laid down in Union and national law, including those relating to the identification of high-risk suppliers. Providers shall also ensure that their suppliers of software and security solutions comply with these requirements and conform to the relevant security standards and requirements.

**6.** Providers of European Business Wallets shall:

  - (a) implement appropriate technical and organisational measures to ensure the confidentiality, integrity, authenticity, interoperability, and availability of the European Business Wallets they provide with other European Business Wallets and European Digital Identity Wallets;
  - (b) ensure that European Business Wallet owners are clearly informed, in a user-friendly, concise and accessible manner, about the terms and conditions of use of the European Business Wallet, including the scope and limitations of core and additional functionalities, cybersecurity standards, and the European Business Wallet owner’s rights with regard to data portability, redress, and termination of service;
  - (c) ensure that authorised representatives of European Business Wallet owners are clearly informed, in a user-friendly, concise and accessible manner, about their rights and obligations in relation to their European Business Wallet unit, in particular, the right to request revocation of their wallet unit attestation, using the authentication mechanism provided in point 1 of the Annex;
  - (d) cooperate with the competent supervisory bodies referred to in Article 13(1), or with the Commission in the cases referred to in Article 13(10) and 14(1) and respond without undue delay to any request for information or documentation necessary to verify compliance with this Regulation;
  - (e) notify the relevant national supervisory bodies, or the Commission in the cases referred to in Article 14(1), of any substantive changes to their services or overall structure which may impact the compliance of the provider with this Regulation;
  - (f) notify European Business Wallet owners in the event of suspension, revocation or voluntary termination of the providers of European Business Wallet`s services and of the removal of the provider of European Business Wallet from the list established pursuant to Article 12(5) and ensure the transfer or deletion of the European Business Wallet owner data in accordance with the European Business Wallet owners instructions, including European Business Wallet owner identification data;
  - (g) ensure that the information on European Business Wallet owners, pursuant to Article 10(2), is notified to the Commission and that the information initially submitted to the Commission is kept up to date and corroborated using the providers of the European Business Wallet owner identification data issuing the unique identifiers referred to in Article 8(5), point (b).

### Article 8: European Business Wallet owner identification data

**1.** Providers of European Business Wallet owner identification data shall issue European Business Wallet owner identification data to European Business Wallets of European Business Wallet owners. Where European Business Wallet owners are Union entities, the Commission shall issue European Business Wallet owner identification data to the European Business Wallets of those Union entities.

**2.** Member States shall notify to the Commission the relevant authentic sources for the verification of the required attributes for the issuance of the European Business Wallet owner identification data. On the basis of the information received pursuant to this paragraph, the Commission shall make available on the Commission’s website, in a machine-readable format, a list of the notified relevant authentic sources.

**3.** European Business Wallet owner identification data shall be issued in a format compliant with one of the standards listed in Annex II of Commission Implementing Regulation (EU) 2024/2979 and as:

  - (a) qualified electronic attestations of attributes, when provided by qualified trust service providers;
  - (b) electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source, when provided by a public sector body so responsible;
  - (c) electronic attestations of attributes, when provided by the Commission.

**4.** European Business Wallet owner identification data issued by the Commission shall have the same legal effect as qualified electronic attestations of attributes and attestations of attributes issued by, or on behalf of, a public sector body responsible for an authentic source.

**5.** European Business Wallet owner identification data shall contain at least the following attributes:

  - (a) the official name of the economic operator or public sector body, as recorded in the relevant register or official record;
  - (b) the relevant unique identifier attributed in accordance with Article 9.

**6.** The Commission shall establish and maintain an attestation scheme for European Business Wallet owner identification data. That scheme shall be listed in the catalogue of schemes for the attestation of attributes referred to in Article 8 of Implementing Regulation (EU) 2025/1569.

**7.** The Commission may, by means of implementing acts, set out requirements for European Business Wallet owner identification data issued pursuant to this Article, including procedures for Member States to notify to the Commission the relevant authentic sources. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 19.

### Article 9: Unique identifiers

**1.** Where an economic operator has been attributed a European Unique Identifier, that identifier shall be used as the unique identifier referred to in Article 8(4), point (b) of this Regulation.

**2.** Where an economic operator or public sector body has not been attributed a European Unique Identifier, a unique identifier shall be created in accordance with the implementing act referred to in paragraph 4.

**3.** Where a public sector body is a Union entity, the Commission shall create and attribute a unique identifier to that Union entity in accordance with paragraph 4 of this Article.

**4.** The Commission shall, by means of implementing acts, establish specifications, requirements and procedures relating to the unique identifier referred to in paragraph 2 of this Article, including measures to ensure that European Business Wallet owners are not attributed more than one unique identifier. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 19.

### Article 10: European Digital Directory

**1.** The Commission shall establish, operate and maintain a European Digital Directory which shall act as the trusted source of information for European Business Wallet owners and shall take the form of a web application comprising of two interfaces:

    - (a) a machine-readable interface exposed through an API for automated system-to-system communication;
    - (b) a secure, web-based platform that provides access to authenticated and authorised users and system online portal for European Business Wallet users.

**2.** For the purpose of maintaining the European Digital Directory, providers of European Business Wallets shall, upon the provision of a European Business Wallet, provide to the Commission the categories of information set out in the implementing act referred to in paragraph 6

**3.** The Commission shall ensure that the relevant information shall be included in the European Digital Directory.

**4.** The Commission shall make the European Digital Directory only accessible to European Business Wallet owners and their authorised representatives and providers of European Business Wallets.

**5.** Any modification or revocation concerning the information referred to in paragraph 2 shall, without undue delay and in any event within one working day, be communicated by the providers of European Business Wallet directly to the Commission for the purpose of maintaining the European Digital Directory.

**6.** The Commission shall, by means of implementing acts, establish standards and technical specifications for the unique digital addresses and the categories of information to be communicated to the Commission for the purpose of the European Digital Directory. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 19.

### Article 11: Notification of providers of European Business Wallets

**1.** Entities that intend to provide European Business Wallets shall notify that intention together with the information listed in paragraph 2 to the competent supervisory body.

**2.** The notification referred to in paragraph 1 shall include the following information:

    - (a) the entity’s legal name, any commercial names used, website URL, contact email, telephone number, and physical address;
    - (b) the entity’s register number issued by a national register, where available
    - (c) a description of how the core functionalities, set out in Article 5(1) shall be offered by the European Business Wallets the entity intends to provide;
    - (d) a description of any additional functionalities supported by the European Business Wallets the entity intends to provide;
    - (e) a declaration of conformity with the requirements of this Regulation.

**3.** Qualified trust service providers shall not be subject to the review and verification procedure set out in paragraphs 4 to 6. Upon submitting the information listed in paragraph 2, the competent supervisory body shall inform the Commission within two working days with a view to the addition of that provider to the list referred to in Article 12(5) and it may immediately offer European Business Wallets.

**4.** Upon receipt of a notification, the supervisory body shall have 30 days to review the information submitted.

When that review leads the supervisory body to conclude that the information is complete and the description referred to in paragraph 2 point (c) appears to correspond to the requirements laid down in Article 5(1), it shall inform the Commission within two working days with a view to the addition of that provider to the list referred to in Article 12(5).

**5.** When that review leads the supervisory body to conclude that the information is not complete or the description referred to in paragraph 2 point (c) appears not to correspond to the requirements laid down in Article 5(1), it shall request additional information or explanations from the notifying entity and set a reasonable deadline, not exceeding 15 calendar days, for response. If that information or those explanations allow the supervisory body to conclude that the information is complete and the description referred to in paragraph 2 point (c) appears to correspond to the requirements laid down in Article 5(1), it shall inform the Commission within two working days with a view to the addition of that provider to the list referred to in Article 12(5). If not, or no response is received, the supervisory body shall inform the notifying entity that it will not be added to the list referred to in Article 12(5).

**6.** Where the supervisory body has not provided the notifying entity with a substantive response on the outcome of the review referred to in paragraph 4 within 30 calendar days of receiving the notification, the information shall be considered as complete and the description referred to in paragraph 2 point (c) shall be considered as appearing to correspond to the requirements laid down in Article 5(1), and the supervisory body shall inform the Commission within two working days with a view to the addition of that provider to the list referred to in Article 12(5)

**7.** Member States shall ensure that notifying entities have the right to an effective judicial remedy against a decision of the supervisory authority, without prejudice to any other administrative or non-judicial remedy, in cases where the supervisory authority refuses to list them as a provider of European Business Wallets or takes no decision within a reasonable timeframe.

### Article 12: List of notified providers of European Business Wallets

**1.** Supervisory bodies shall inform the Commission of any changes to the information provided pursuant to Article 11, within 24 hours of having become aware of any changes.

**2.** The information provided by the supervisory bodies referred to in Article 11 and Article 12(1) shall include the following:

    - (a) the purpose of the submission, which may be one of the following:
    - the registration of a notified provider of European Business Wallets not previously present on the list referred to in paragraph 5;
    - a change to previously submitted information regarding providers of European Business Wallets currently present on the list referred to in paragraph 5;
    - a request to remove a provider of European Business Wallets from the list referred to in paragraph 5;
    - (b) name and, where applicable, the commercial name of the provider of European Business Wallets;
    - (c) the Member State in which the provider of European Business Wallets has its principal place of establishment;
    - (d) the name of the competent supervisory body;
    - (e) an indication whether the provider of European Business Wallets is a qualified trust service provider.

**3.** On the basis of the information received pursuant to this Article, the Commission shall establish and maintain on the Commission’s website, in a machine-readable format, a list of providers of European Business Wallets.

### Article 13: Governance and supervision

**1.** In each Member State, the supervisory bodies designated pursuant to Article 46a of Regulation (EU) No 910/2014 shall also be the supervisory bodies for the purposes of this Regulation.

**2.** Those supervisory bodies shall be responsible for supervisory tasks as regards providers of European Business Wallets having their principal place of establishment in that Member State.

**3.** Member States shall ensure that the supervisory bodies referred to in paragraph 1 have the necessary powers and adequate resources for the exercise of their tasks in an effective, efficient and independent manner.

**4.** The role of national supervisory bodies referred to in paragraph 1 shall be to:

  - (a) monitor compliance with the requirements laid down in this Regulation and take action, if necessary, in relation to providers of European Business Wallets, by means of ex post supervisory activities;
  - (b) act as the main liaison office for providers of European Business Wallet owner identification data, facilitating access to information from relevant national authorities and registries, where necessary, for the issuance of European Business Wallet owner identification data and unique identifiers.

**5.** The tasks of the supervisory bodies referred to in paragraph 1 shall include the following:

  - (a) review and assess the notifications submitted in accordance with Article 11;
  - (b) investigate substantiated claims, particularly those made by European Business Wallets owners, that a provider of European Business Wallets fails to comply with any of its obligations under this Regulation and to take action if necessary;
  - (c) verify the existence and correct application of termination plans where a provider of European Business Wallets ceases its activities, including how information is kept accessible;
  - (d) ensure that providers of European Business Wallets remedy any failure to fulfil the requirements laid down in this Regulation;
  - (e) impose penalties in accordance with paragraphs 6 to 9;
  - (f) inform the relevant competent authorities designated or established pursuant to Article 8(1) of Directive (EU) 2022/2555 of the Member States concerned of any significant security breach or loss of integrity of which it becomes aware in the performance of its tasks and, in the case of a significant security breach or loss of integrity which concerns other Member States, to inform the single point of contact designated or established pursuant to Article 8(3) Directive (EU) 2022/2555 of the Member State concerned and the single points of contact designated pursuant to Article 46c(1) of Regulation (EU) No 910/2014 in the other Member States concerned, and to inform the public or require the provider of European Business Wallets to do so where the supervisory body determines that disclosure of the breach of security or loss of integrity would be in the public interest;
  - (g) cooperate with supervisory authorities established pursuant to Article 51 of Regulation (EU) 2016/679, in particular, by informing them, without undue delay, where personal data protection rules appear to have been breached and about security breaches which appear to constitute personal data breaches;
  - (h) cooperate, as appropriate, with other national supervisory bodies;
  - (i) set up and ensure clear publicity of a complaint mechanism whereby complaints can be filed by providers of European Business Wallets in accordance with Article 11(7);
  - (j) report to the Commission on its main activities;
  - (k) revoke the inclusion in the list established pursuant to Article 12(5) of a provider of European Business Wallets if the supervisory body determines that the provider no longer meets the requirements laid down in this Regulation or that the provider has failed to comply with the obligations imposed by this Regulation;
  - (l) cooperate with the supervisory authorities designated pursuant to Article 46b of Regulation (EU) No 910/2014 by the Member States, in particular, to ensure that economic operators established outside the Union are issued only one set of European Business Wallet owner identification data and European business Wallet unique identifier.

**6.** Member States shall lay down the rules allowing the supervisory body referred to in paragraph 1 of this Article to impose penalties applicable to infringements of this Regulation and shall take all measures necessary to ensure that they are implemented. Those penalties shall be effective, proportionate and dissuasive. Those rules shall not affect Article 31 of Directive (EU) 2022/2555 and Article 83 of Regulation (EU) 2016/679.

**7.** By [Publications Office, insert the date 12 months after the entry into force of this Regulation] Member States shall notify the Commission of the rules laid down by Member States in accordance with paragraph 6 and shall notify the Commission without delay of any subsequent amendments to the rules. The Commission shall regularly update and maintain an easily accessible public register of those rules.

**8.** Member States shall take into account the following non-exhaustive and indicative criteria for the imposition of penalties in accordance with paragraph 6:

  - (a) the nature, gravity, scale and duration of the infringement;
  - (b) any action taken by the infringing party to mitigate or remedy the damage caused by the infringement;
  - (c) any previous infringements by the infringing party;
  - (d) the financial benefits gained or losses avoided by the infringing party due to the infringement, insofar as such benefits or losses can be reliably established;
  - (e) any other aggravating or mitigating factor applicable to the circumstances of the case;
  - (f) the infringing party’s total annual turnover in the preceding financial year in the Union.

Member States shall ensure that infringements of this Regulation committed by providers of European Business Wallets be subject to administrative fines of a maximum of 2% of the total worldwide annual turnover in the preceding financial year.

**9.** Where the legal system of a Member State does not provide for administrative fines being imposed by administrative authorities, fines initiated by the supervisory body and imposed by competent national courts, which have an equivalent effect to the administrative fines imposed by supervisory bodies, shall be considered to comply with the requirements laid down in paragraph 6. In any event, the fines imposed shall be effective, proportionate and dissuasive. That Member State shall notify to the Commission the provisions of the laws which it adopts pursuant to this paragraph by [Publications Office, insert the date 12 months after the entry into force of this Regulation] and, without delay, any subsequent amendment law or amendment affecting them.

**10.** In circumstances which justify an immediate intervention to preserve the proper functioning of the internal market and where the Commission has sufficient reason to consider that the European Business Wallets provided by a provider are non-compliant with the requirements laid down in this Regulation and no effective measures have been taken by the competent supervisory authority, the Commission shall carry out an evaluation of compliance. The Commission shall inform the relevant authorities accordingly and the provider shall cooperate as necessary.

**11.** Based on the evaluation, the Commission may decide that a corrective or restrictive measure is necessary, and after consulting the Member States concerned and the provider, the Commission may determine the appropriate course of action. The Commission shall take into account the nature and severity of the non-compliance, as well as the potential impact on the internal market and the rights of economic operators.

**12.** On the basis of the consultation, the Commission may adopt implementing acts to provide for corrective or restrictive measures, including temporarily suspending the provider from the list of notified providers or requiring the provider to take specific actions to bring the European Business Wallets into compliance with the Regulation. Those implementing acts shall be adopted in accordance with the examination procedure.

**13.** The Commission shall immediately communicate the implementing acts to the provider and Member States shall implement those implementing acts without delay and inform the Commission accordingly. These measures shall be applicable for the duration of the exceptional situation that justified the Commission’s intervention, provided that the European Business Wallets concerned are not brought into compliance with this Regulation.

### Article 14: European Digital Identity Cooperation Group

The European Digital Identity Cooperation Group established pursuant to Article 46e of Regulation (EU) No 910/2014 shall be responsible for facilitating cooperation and information sharing among Member States and the Commission on matters related to the European Business Wallets. This shall include sharing best practices, discussing technical and operational issues, and coordinating efforts to ensure the proper implementation and functioning of the European Business Wallets.

### Article 15: Governance and supervision of Union entities that are providers of European Business Wallets

**1.** Where a Union entity is a provider of European Business Wallets the Commission shall be its supervisory body.

**2.** The role of the Commission acting as a supervisory body in accordance with paragraph 1 shall be to monitor compliance with the requirements laid down in this Regulation and take action, if necessary, in relation to providers of European Business Wallets, by means of ex post supervisory activities.

**3.** When acting as a supervisory body in accordance with paragraph 1, the Commission shall perform the tasks referred to in Article 13(5) points a, b, c, d, h and k.

The Commission shall prepare a report on its main activities in this respect.

## Chapter III – Acceptance of the European Business Wallets

### Article 16: Obligations on public sector bodies

**4.** By [Publications Office, please insert the date 24 months after the entry into force of this Regulation] public sector bodies shall enable economic operators to take the following actions by using the core functionalities of European Business Wallets as set out in Article 5(1):

  - (a) identify and authenticate;
  - (b) sign or seal;
  - (c) submit documents;
  - (d) send or receive notifications.

The actions listed in points (a) to (d) of the first subparagraph shall take place for the purpose of meeting a reporting obligation or fulfilling an administrative procedure.

**5.** For the purposes of paragraph 1, points (c) and (d), public sector bodies shall have European Business Wallets, including the qualified electronic registered delivery service referred to in Article 5(1), point (i).

**6.** By way of derogation from paragraph 2 and until [Publications Office, insert the date 36 months after entry into force of this Regulation], public sector bodies may choose not to offer the qualified electronic registered delivery service referred to in Article 5(1), point (i), and support instead other existing alternative solutions which enable economic operators to take the actions listed in paragraph 1, points (c) and (d), provided those solutions:

    - (a) comply with the requirements applicable to qualified electronic registered delivery services set out in Regulation (EU) No 910/2014;
    - (b) offer a gateway that enables European Business Wallet owners to submit documents and send and receive notifications using the qualified electronic registered delivery service referred to in Article 5(1), point (i).

After the expiry of the derogation period laid down in this paragraph, public sector bodies may continue to support the alternative solutions referred to in that subparagraph but shall, in accordance with paragraph 2, have European Business Wallets, including the qualified electronic registered delivery service referred to in paragraph 1 of Article 5(1), point (i).

## Chapter IV - International aspects

### Article 17: Business wallets and other similar instruments and frameworks offered in third countries

**1.** The Commission may adopt implementing acts establishing that business wallets or systems offering similar functions that are issued by providers established in third countries are to be considered as offering assurances that are equivalent to European Business Wallets issued in accordance with this Regulation, provided that such business wallets or systems are interoperable with the trust framework laid down in Regulation (EU) 910/2014 and allow for the support of at least an identification and authentication functionality and the exchange of electronic attestations of attributes. Such implementing acts shall be adopted in accordance with the examination procedure referred to in Article 19.

**2.** The Commission may adopt implementing acts establishing that third country frameworks for systems offering similar functions as the European Business Wallets are to be considered as offering assurances that are equivalent to European Business Wallets issued in accordance with this Regulation, provided that the systems provided under that framework are interoperable with the trust framework laid down in Regulation (EU) 910/2014 and allow for the support of at least an identification and authentication functionality and the exchange of electronic attestations of attributes. Such implementing acts shall be adopted in accordance with the examination procedure referred to in Article 19.

**3.** Prior to the adoption of the implementing acts referred to in paragraphs 1 and 2, the Commission shall assess whether the assurances can be considered as equivalent to the requirements under this Regulation.

**4.** The Commission shall, where available information reveals that those assurances can no longer be considered as equivalent to the requirements under this Regulation, to the extent necessary, repeal, amend or suspend the act referred to in paragraphs 1 and 2 by means of an implementing act.

**5.** The Commission shall publish on its website a list of frameworks, business wallets or systems offering similar functions that are issued by providers established in third countries in relation to which the Commission has adopted an implementing act pursuant to this Article.

### Article 18: Issuing of European Business Wallets to economic operators established outside the Union

**1.** Providers of European Business Wallets may provide European Business Wallets to economic operators established in a third country under the condition that such economic operators have been issued European Business Wallet owner identification data and a unique identifier in accordance with this Article.

**2.** For the purposes of this Article, economic operators shall request only one set of European Business Wallet owner identification data from one provider of European Business Wallet owner identification data.

**3.** Where an economic operator established outside the Union requests a European Business Wallet, the provider of European Business Wallets shall notify this request to the supervisory body of the Member State in which the provider is notified.

**4.** Providers of European Business Wallets shall request European Business Wallet owner identification data from a provider of European Business Wallet owner identification data on behalf of the economic operator established in a third country.

**5.** Providers of European Business Wallet owner identification data may issue European Business Wallet owner identification data and unique identifiers pursuant to Articles 8 and 9 to economic operators established outside the Union, provided that:

  - (a) the identity proofing and verification of those economic operators fulfils one or, when needed, a combination, of the methods for verification of identity set out in Article 24 (1a) of Regulation (EU) No 910/2014;
  - (b) the economic operator has not been issued another set of European Business Wallet owner identification data.

**6.** Member States shall cooperate to ensure that providers of European Business Wallet owner identification data can verify that an economic operator established outside the Union has not yet been issued European Business Wallet owner identification data.

## Chapter V – Final provisions

### Article 19: Committee procedure

The Commission shall be assisted by the committee established by Article 48 of Regulation (EU) No 910/2014. That committee shall be a committee within the meaning of Regulation (EU) No 182/2011.

### Article 20: Amendment to Regulation (EU) No 910/2014

In Regulation (EU) No 910/2014, Article 5a is amended as follows:

(1) paragraph 1 is replaced by the following:

‘1. For the purpose of ensuring that all natural persons in the Union have secure, trusted and seamless cross-border access to public and private services, while having full control over their data, each Member State shall provide at least one European Digital Identity Wallet within 24 months of the date of entry into force of the implementing acts referred to in paragraph 23 of this Article and in Article 5c(6).’

(2) in paragraph 5 point (f) is replaced by the following:

‘(f) ensure that the person identification data, which is available from the electronic identification scheme under which the European Digital Identity Wallet is provided, uniquely represents the natural person or the natural person representing the natural or legal person, and is associated with that European Digital Identity Wallet;’;

(3) in paragraph 9 point c) is replaced by the following:

‘(c) upon the death of the user.’;

(4) Paragraph 15 is replaced by the following:

’15. The use of European Digital Identity Wallets shall be voluntary. Access to public and private services, access to the labour market and freedom to conduct business shall not in any way be restricted or made disadvantageous to natural persons that do not use European Digital Identity Wallets. It shall remain possible to access public and private services by other existing identification and authentication means.’.

### Article 21: Evaluation and review

**7.** The Commission shall review the application of this Regulation and shall, by [Publications Office, insert the date – 3 years after entry into force], submit a report to the European Parliament and to the Council. The report shall evaluate the effectiveness of the provisions of this Regulation with regard to facilitating the submission of electronic documents and electronic attestations to public sector bodies, by the usage of the European Business Wallets, as well as technological, market, and legal developments. The report shall also assess whether it is necessary to modify the scope of this Regulation or its specific provisions to set out an obligation for the use of the European Business Wallets to address the risks of legal fragmentation.

**8.** The report referred to in paragraph 1 shall include the following aspects:

    - (a) the minimum core functionalities of European Business Wallets;
    - (b) the level of compliance of providers of European Business Wallets and the notification procedure and criteria established in Article 11;
    - (c) the application and functioning of the rules on penalties laid down by the Member States pursuant to Article 13;
    - (d) the detailed requirements and technical specifications for the qualified electronic registered delivery service referred to in Article 5(1) point I;

No later than one year before the report referred to in paragraph 1 is due, Member States shall provide the Commission with the information necessary for the preparation of the reports.

### Article 22: Entry into force and application

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

It shall apply from [Publications Office, insert the date – 1 year after entry into force].

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels,

For the European Parliament For the Council

The President The President

## Annex: Requirements for minimum functionalities and technical requirements of European Business Wallets

### 1.  European Business Wallets Unit Authentication

Access to the European Business Wallets Unit shall be granted only after the European Business Wallets user has been successfully authenticated by means of either:

- (1) a notified electronic identification (eID) means in accordance with Article 6 of Regulation (EU) No 910/2014, fulfilling at least the requirements for a substantial level of assurance as defined in Article 8 of that Regulation and further specified in Commission Implementing Regulation (EU) 2015/1502; or
- (2) an alternative authentication mechanism recognised as equivalent and fulfilling at least the requirements for a substantial level of assurance as defined in Article 8 of Regulation (EU) No 910/2014 and further specified in Commission Implementing Regulation (EU) 2015/1502.

Until such authentication has been completed, no functionality of the European Business Wallets Unit or of any other functionalities shall be made accessible to the Wallets user.

### 2.  European Business Wallets Unit integrity

Providers of European Business Wallets shall, for each European Business Wallet unit, generate and sign a European Business Wallet unit attestation in accordance with the requirements laid down in point 5. The certificate used to sign or seal the Business Wallet unit attestation shall be issued under a certificate listed in the trusted list referred to in Commission Implementing Regulation (EU) 2024/2980.

### 3.  European Business Wallets secure communication and critical asset management

- (1) European Business Wallet back-end shall use at least one Wallet secure cryptographic application and Wallets secure cryptographic device to manage critical assets.
- (2) Providers of the European Business Wallets shall ensure integrity, authenticity and confidentiality of the communication between the Business Wallet’s back-end, front-end and secure cryptographic applications and device.
- (3) Where critical assets relate to performing electronic identification at assurance level substantial, the European Business Wallets cryptographic operations or other operations processing critical assets shall be performed in accordance with the requirements for the characteristics and design of electronic identification means at assurance level substantial, as set out in Commission Implementing Regulation (EU) 2015/1502.

### 4.  Wallets secure cryptographic applications

- (1) Providers of European Business Wallets shall ensure that European Business Wallets secure cryptographic applications and devices:
  - (a) perform the wallet’s cryptographic operations involving critical assets other than those needed for the Wallets unit to authenticate the Wallets owner only in cases where those applications have successfully authenticated Wallets users;
  - (b) where they authenticate the European Business Wallet owner in the context of performing electronic identification at assurance level substantial as set out in Implementing Regulation (EU) 2015/1502;
  - (c) are able to securely generate new cryptographic keys;
  - (d) are able to perform secure erasure of critical assets;
  - (e) are able to generate a proof of possession of private keys;
  - (f) protect the private keys generated by these Wallets secure cryptographic applications and devices during the existence of the keys;
  - (g) comply with the requirements for the characteristics and design of electronic identification means at assurance level substantial, as set out in Implementing Regulation (EU) 2015/1502.

### 5.  Wallets unit authenticity and validity

- (1) Providers of European Business Wallets shall ensure that the European Business Wallets unit attestations referred to in point 1 contain public keys and that the corresponding private keys are protected by a Wallets secure cryptographic device.
- (2) Providers of European Business Wallets shall provide mechanisms, independent of Wallets units, for the secure identification and authentication of Wallets users.

### 6.  Revocation of Wallets unit attestations

- (1) Providers of European Business Wallets shall establish a publicly available policy specifying the conditions and the timeframe for the revocation of Wallets unit attestations.
- (2) In line with Article 6, where the providers of European Business Wallets revoke European Business Wallets unit attestations, they shall inform the affected European Business Wallets users without undue delay and no later than 24 hours from the revocation of their European Business Wallets units, including the reason for the revocation and the consequences for the European Business Wallets user. This information shall be provided in a manner that is concise, easily accessible and using clear and plain language.
- (3) Where European Business Wallets providers have revoked a European Business Wallet’s unit attestation, they shall make publicly available the validity status of the European Business Wallet unit attestation and describe the location of that information in the Business Wallet’s unit attestation.

### 7.  Transaction logs

- (1) The providers of European Business Wallets shall provide an appropriate logging policy that shall include, at a minimum, electronic signing, electronic sealing, and notifications of all transactions with Business-Wallet-relying parties, other European Business Wallets units, and European Digital Identity Wallets units, irrespective of whether the transaction is successfully completed.
- (2) The logged information shall at least contain:
  - (a) the time and date of the transaction;
  - (b) the name, contact details, and unique identifier of the corresponding Business-Wallet-relying party and the Member State in which that Business-Wallet-relying party is established, or in case of other Wallets units, relevant information from the Wallets unit attestation;
  - (c) the type or types of data requested and presented in the transaction;
  - (d) in the case of non-completed transactions, the reason for such non-completion.
- (3) Providers of European Business Wallets shall ensure integrity, authenticity and confidentiality of the logged information.
- (4) European Business Wallets back-end shall log reports sent by the Wallets user to the competent authorities via the Wallets unit, including interactions related to notifications, regulatory compliance, data sharing, or audit requests.
- (5) The logs referred to in subpoints 1 and 2 shall be accessible to the European Business Wallets provider, where it is necessary for the provision of Wallets services.
- (6) The logs referred to in subpoints 1 and 2 shall remain accessible for as long as required to be accessible by Union law or national law.

### 8.  Qualified electronic signatures and seals

- (1) In line with Article 6, providers of European Business Wallets shall ensure that Wallets users are able to receive qualified certificates for qualified electronic signatures or seals which are linked to qualified signature or seal creation devices that are either local, external, or remote in relation to the Wallet’s unit.
- (2) Providers of European Business Wallets shall ensure that European Business Wallets solutions can securely interface with one of the following types of qualified signature or seal creation devices: local, external, or remotely managed qualified signature or seal creation devices for the purposes of using the qualified certificates referred to in subpoint 1.

### 9.  Signature creation applications

- (1) The signature creation applications used by European Business Wallets units may be provided either by European Business Wallets providers, by providers of trust services or by Business-Wallet-relying parties.
- (2) Signature creation applications shall have the following functions:
  - (a) signing or sealing data provided by European Business Wallets users;
  - (b) signing or sealing data provided by relying parties;
  - (c) creating signatures or seals in accordance with at least the mandatory format;
    - creating signatures or seals in accordance with the optional format;
    - informing Wallets users about the result of the signature or seal creation process.

To ensure uniform conditions for the implementation of this Regulation, the Commission is empowered to adopt implementing acts in accordance with Article 6 that specify the technical standards referred to in subpoint 2, letters (c) and (c)(ii).

- (3) The signature creation applications may either be integrated into or be external to European Business Wallets back-end. Where signature creation applications rely on remote qualified signature creation devices and where they are integrated into European Business Wallets back-end, they shall support the application programming interface set out in the implementing acts, which the Commission is empowered to adopt in accordance with Article 5 in order to ensure uniform conditions for the implementation of this Regulation.

### 10.  Data export and portability

Business Wallets shall support the secure export and portability of an owner’s European Business Wallet data in at least an open format. This shall enable the owner to migrate their data to another Business Wallets solution while ensuring a level of assurance of at least "substantial", as defined in Implementing Regulation (EU) 2015/1502.

### 11.  Secure Legal Communication Channel for the Business Wallet

- (1) In line with Article 5 of this Regulation, Business Wallets shall integrate and support the use of a specific qualified electronic registered delivery service in accordance with Articles 43 and 44 of Regulation (EU) No 910/2014.
- (2) The Commission shall, by means of implementing acts:
  - (a) designate one qualified electronic registered delivery service that shall serve as the mandatory secure legal communication channel for European Business Wallets;
  - (b) define the minimum technical and interoperability requirements that such qualified electronic registered delivery service must fulfil, including alignment with the reference standards, specifications and procedures established under Articles 43 and 44 of Regulation (EU) No 910/2014;
  - (c) ensure that the chosen qualified electronic registered delivery service is based on open, publicly available and royalty-free standards to guarantee interoperability and prevent vendor lock-in;
  - (d) ensure that the chosen qualified electronic registered delivery service provides end-to-end encryption to guarantee confidentiality;
  - (e) establish procedures for ensuring continuous availability, redundancy and fallback mechanisms in case of service failure.
- (3) Interoperability between Business Wallets and the designated qualified electronic registered delivery service shall be mandatory. Providers of Business Wallets shall ensure technical integration in accordance with the implementing acts referred to in subpoint 2.

### 12.  European Business Wallets Access Control Mechanism

- (1) Providers of European Business Wallets shall ensure that authorisation decisions under the access control mechanism are based on one or more of the following criteria, as appropriate to the specific access request:
  - (a) the electronic attestation of attributes of the acting subject;
  - (b) the formal role of the acting subjects within a recognised organisational structure or economic operator;
  - (c) the scope, validity and constraints of any mandate, delegation, or power of attorney;
  - (d) contextual information or policies and rules adopted at Union or national level for sector-specific compliance.
- (2) Providers of European Business Wallets shall ensure the access control mechanism nables fine-grained and auditable authorisation outcomes, ensuring that:
  - (a) visibility of credentials and attestations is selective and conditioned on access rights;
  - (b) access to business processes, digital procedures or submission interfaces is controlled by real-time validation of roles and mandates;
  - (c) all access and execution events are logged, timestamped, and bound to cryptographically verifiable proofs of authorisation, suitable for audit and legal proceedings.
- (3) Providers of the European Business Wallets shall ensure that:
  - (a) mappings between roles and attributes are verifiable, auditable, revocable and traceable to their legitimate issuers;
  - (b) conflicts of roles, over-delegation, or expired authorisations are automatically detected and prevented in real time;
  - (c) all authorisation logic is interoperable across Member States.
- (4) The list of reference standards, technical specifications and procedures to be applied for the implementation of the access control mechanism shall be defined in the implementing acts, which the Commission is empowered to adopt in accordance with Article 5 in order to ensure uniform conditions for the implementation of this Regulation. These shall cover in particular:
  - (a) the formats for the representation of roles and attributes;
  - (b) interoperability mechanisms for mandates and delegations across wallets;
  - (c) protocols, policy language and constraint enforcement;
  - (d) requirements for secure logging, timestamping and auditability of authorisation events.
- (5) Compliance with the requirements laid down in this Article shall be presumed where the standards, specifications and procedures referred to in subpoint 1 are met.

### 13.  General provisions for protocols and interfaces

In line with Article 6 of this Regulation, providers of European Business Wallets shall ensure that European Business Wallets units:

- (1) authorise requests and, where applicable, authenticate those made through relying-party access certificates or Wallet unit attestations. Authentication of the relying party shall be required where attestations are intended for a restricted audience; in all other cases, attestations may be presented by any requesting party;
- (2) display to Wallet users’ information contained in the Business-Wallet-relying party access certificates or in the Wallets unit attestations where applicable;
- (3) display to Wallets users, where applicable, the attributes that Wallets users are requested to present;
- (4) present Wallet unit attestations of the Wallet unit to Business-Wallet-relying parties or Wallets units that request it.

### 14.  Issuance of electronic attestations of attributes to Wallets units

- (1) In line with Article 5 of this Regulation, providers of European Business Wallets shall ensure that Business Wallet units requesting issuance of, electronic attestations of attributes are able to authenticate relying parties.
- (2) In relation to the issuance of electronic attestations of attributes to a Wallet unit, Wallet providers shall ensure that the following requirements are complied with:
  - (a) where European Business Wallets owners, through their Business Wallet unit, request from the provider of the European Business Wallet the issuance of Business Wallets owner identification data or of electronic attestations of attributes from providers of Business Wallets owner identification data or providers of electronic attestations of attributes that enable issuance of Business Wallets owner identification data or electronic attestations in more than one format, the Wallets unit shall request it in all formats referred to in Article 8 to this Regulation laying down rules for the application of the Business Wallets Regulation as regards the integrity and core functionalities of Business Wallets;
  - (b) where Business Wallet owners use their Business Wallets unit to interact with competent national authorities and providers of electronic attestations of attributes, Wallet units shall enable authentication and validation of the Wallet unit components by presenting the Wallet unit attestations to those competent national authorities and providers upon their request;
  - (c) Wallet solutions shall support mechanisms that enable providers of Business Wallets Owner Identification Data to verify issuance, delivery and activation in compliance with assurance level substantial requirements set out in Commission Implementing Regulation (EU) 2015/1502 (11);
  - (d) Wallet units shall verify the authenticity and validity of Business Wallets owner identification data and electronic attestations of attributes.

### 15.  Presentation of attributes to European Business Wallet relying parties

In line with point (d) and (k) of paragraph 1 of Article 5, European Business Wallet providers shall ensure that:

- (1) European Business Wallet solutions support protocols and interfaces for the presentation of attributes to Business-Wallet-relying parties in accordance with the standards defined in the implementing acts;
- (2) At the request of users, European Business Wallet units respond to successfully authenticated and validated requests from Business-Wallet-relying parties in accordance with the standards defined in the implementing acts;
- (3) European Business Wallet units support proving the possession of private keys corresponding to public keys used in cryptographic bindings.

### 16.  Issuance of European Business Wallet Owner Identification Data to Wallets units

- (1) Competent authorities shall ensure that Business Wallets owner identification data issued to Business Wallets units comply with the technical specifications set out in the implementing acts, in line with Article 8 of this Regulation.
- (2) Competent national authorities shall ensure that Business Wallets owner identification data that they issue is cryptographically bound to the Wallets unit to which it is issued.

### 17.  Issuance of electronic attestations of attributes to Wallets units

- (1) Electronic attestations of attributes issued to European Business Wallets units shall comply with at least one of the standards in the list set out in the implementing acts, in line with Article 5 of this Regulation.
- (2) Providers of electronic attestations of attributes shall identify themselves to European Business Wallets units using their wallet-relying party access certificate.
- (3) Providers of electronic attestations of attributes shall ensure that electronic attestations of attributes issued to European Business Wallets units contain the information necessary for authentication and validation of those electronic attestations of attributes.

---

# European Data Act
Source: https://docs.igrant.io/regulations/reg-eu-data-act/

---
id: reg-eu-data-act
title: European Data Act
description: Learn how the EU Data Act governs data access and sharing between businesses and individuals, fostering fairness and innovation in digital ecosystems.
sidebar_label: European Data Act
keywords: [Data Act, data access, data sharing, EU regulation, IoT data, fairness, innovation, digital ecosystems]
slug: /reg-eu-data-act/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
  <title>Understand the European Data Act | iGrant.io DevDocs</title>
  <meta name="description" content="Learn how the EU Data Act governs data access and sharing between businesses and individuals, fostering fairness and innovation in digital ecosystems."/>
</head>

The Data Act is a key pillar of the European strategy for data. It will make an important contribution to the digital transformation objective of the Digital Decade. The new measures complement the Data Governance Regulation proposed in November 2020, the first deliverable of the European strategy for data. While the Data Governance Regulation creates the processes and structures to facilitate data, the Data Act clarifies who can create value from data and under which conditions. 

This section reproduces the European Data Act to make it easier for our readers. This is published by EU Commission on 23-February-2022. The original pdf can be found [here](https://igrant.io/papers/European_DataAct_23-Feb-2022.pdf).

## CHAPTER I: GENERAL PROVISIONS 

### Article 1: Subject matter and scope

1. This Regulation lays down harmonised rules on making data generated by the use of a product or related service available to the user of that product or service, on the making data available by data holders to data recipients, and on the making data available by data holders to public sector bodies or Union institutions, agencies or bodies, where there is an exceptional need, for the performance of a task carried out in the public interest:

2. This Regulation applies to:
 
   a) manufacturers of products and suppliers of related services placed on the market in the Union and the users of such products or services;

   b) data holders that make data available to data recipients in the Union;

   c) data recipients in the Union to whom data are made available;

   d) public sector bodies and Union institutions, agencies or bodies that request data holders to make data available where there is an exceptional need to that data for the performance of a task carried out in the public interest and the data holders that provide those data in response to such request;

   e) providers of data processing services offering such services to customers in the Union.

3. Union law on the protection of personal data, privacy and confidentiality of communications and integrity of terminal equipment shall apply to personal data processed in connection with the rights and obligations laid down in this Regulation. This Regulation shall not affect the applicability of Union law on the protection of personal data, in particular Regulation (EU) 2016/679 and Directive 2002/58/EC, including the powers and competences of supervisory authorities. Insofar as the rights laid down in Chapter II of this Regulation are concerned, and where users are the data subjects of personal data subject to the rights and obligations under that Chapter, the provisions of this Regulation shall complement the right of data portability under Article 20 of Regulation (EU) 2016/679.   
 
4. This Regulation shall not affect Union and national legal acts providing for the sharing, access and use of data for the purpose of the prevention, investigation, detection or prosecution of criminal offences or the execution of criminal penalties, including Regulation (EU) 2021/784 of the European Parliament and of the Council72 and the [e-evidence proposals [COM(2018) 225 and 226] once adopted, and international cooperation in that area. This Regulation shall not affect the collection, sharing, access to and use of data under Directive (EU) 2015/849 of the European Parliament and of the Council on the prevention of the use of the financial system for the purposes of money laundering and terrorist financing and Regulation (EU) 2015/847 of the European Parliament and of the Council on information accompanying the transfer of funds. This Regulation shall not affect the competences of the Member States regarding activities concerning public security, defence, national security, customs and tax administration and the health and safety of citizens in accordance with Union law.

### Article 2: Definitions

For the purposes of this Regulation, the following definitions apply:

(1.) **‘data’** means any digital representation of acts, facts or information and any compilation of such acts, facts or information, including in the form of sound, visual or audio-visual recording;

(2.) **‘product’** means a tangible, movable item, including where incorporated in an immovable item, that obtains, generates or collects, data concerning its use or environment, and that is able to communicate data via a publicly available electronic communications service and whose primary function is not the storing and processing of data;

(3.) **‘related service’** means a digital service, including software, which is incorporated in or inter-connected with a product in such a way that its absence would prevent the product from performing one of its functions;

(4.) **‘virtual assistants’** means software that can process demands, tasks or questions including based on audio, written input, gestures or motions, and based on those demands, tasks or questions provides access their own and third party services or control their own and third party devices;

(5.) **‘user’** means a natural or legal person that owns, rents or leases a product or receives a services;

(6.) **‘data holder’** means a legal or natural person who has the right or obligation, in accordance with this Regulation, applicable Union law or national legislation implementing Union law, or in the case of non-personal data and through control of the technical design of the product and related services, the ability, to make available certain data;

(7.) **‘data recipient’** means a legal or natural person, acting for purposes which are related to that person’s trade, business, craft or profession, other than the user of a product or related service, to whom the data holder makes data available, including a third party following a request by the user to the data holder or in accordance with a legal obligation under Union law or national legislation implementing Union law;

(8.) **‘enterprise’** means a natural or legal person which in relation to contracts and practices covered by this Regulation is acting for purposes which are related to that person’s trade, business, craft or profession;

(9.) **‘public sector body’** means national, regional or local authorities of the Member States and bodies governed by public law of the Member States, or associations formed by one or more such authorities or one or more such bodies;

(10.) **‘public emergency’** means an exceptional situation negatively affecting the population of the Union, a Member State or part of it, with a risk of serious and lasting repercussions on living conditions or economic stability, or the substantial degradation of economic assets in the Union or the relevant Member State(s);

(11.) **‘processing’** means any operation or set of operations which is performed on data or on sets of data in electronic format, whether or not by automated means, such as collection, recording, organisation, structuring, storage, adaptation or alteration, retrieval, consultation, use, disclosure by transmission, dissemination or otherwise making available, alignment or combination, restriction, erasure or destruction;

(12.) **‘data processing service’** means a digital service other than an online content service as defined in Article 2(5) of Regulation (EU) 2017/1128, provided to a customer, which enables on-demand administration and broad remote access to a scalable and elastic pool of shareable computing resources of a centralised, distributed or highly distributed nature;

(13.) **‘service type’** means a set of data processing services that share the same primary objective and basic data processing service model;

(14.) **‘functional equivalence’** means the maintenance of a minimum level of functionality in the environment of a new data processing service after the switching process, to such an extent that, in response to an input action by the user on core elements of the service, the destination service will deliver the same output at the same performance and with the same level of security, operational resilience and quality of service as the originating service at the time of termination of the contract;

(15.) **‘open interoperability specifications’** mean ICT technical specifications, as defined in Regulation (EU) No 1025/2012, which are performance oriented towards achieving interoperability between data processing services;

(16.) **‘smart contract’** means a computer program stored in an electronic ledger system wherein the outcome of the execution of the program is recorded on the electronic ledger;

(17.) **‘electronic ledger’** means an electronic ledger within the meaning of Article 3, point (53), of Regulation (EU) No 910/2014;

(18.) **‘common specifications’** means a document, other than a standard, containing technical solutions providing a means to comply with certain requirements and obligations established under this Regulation;

(19.) **‘interoperability’** means the ability of two or more data spaces or communication networks, systems, products, applications or components to exchange and use data in order to perform their functions;

(20.) **‘harmonised standard’** means a harmonised standard as defined in Article 2, point (1)(c), of Regulation (EU) No 1025/2012.

## CHAPTER II: BUSINESS TO CONSUMER AND BUSINESS TO BUSINESS DATA SHARING

### Article 3: Obligation to make data generated by the use of products or related services accessible

1. Products shall be designed and manufactured, and related services shall be provided, in such a manner that data generated by their use are, by default, easily, securely and, where relevant and appropriate, directly accessible to the user.

2. Before concluding a contract for the purchase, rent or lease of a product or a related service, at least the following information shall be provided to the user, in a clear and comprehensible format:

   (a) the nature and volume of the data likely to be generated by the use of the product or related service;

   (b) whether the data is likely to be generated continuously and in real-time;

   (c) how the user may access those data;

   (d) whether the manufacturer supplying the product or the service provider providing the related service intends to use the data itself or allow a third party to use the data and, if so, the purposes for which those data will be used;

   (e) whether the seller, renter or lessor is the data holder and, if not, the identity of the data holder, such as its trading name and the geographical address at which it is established;

   (f) the means of communication which enable the user to contact the data holder quickly and communicate with that data holder efficiently;

   (g) how the user may request that the data are shared with a third-party;

   (h) the user’s right to lodge a complaint alleging a violation of the provisions of this Chapter with the competent authority referred to in Article 31.

### Article 4: The right of users to access and use data generated by the use of products or related services

1. Where data cannot be directly accessed by the user from the product, the data holder shall make available to the user the data generated by its use of a product or related service without undue delay, free of charge and, where applicable, continuously and in real-time. This shall be done on the basis of a simple request through electronic means where technically feasible.

2. The data holder shall not require the user to provide any information beyond what is necessary to verify the quality as a user pursuant to paragraph 1. The data holder shall not keep any information on the user’s access to the data requested beyond what is necessary for the sound execution of the user’s access request and for the security and the maintenance of the data infrastructure.

3. Trade secrets shall only be disclosed provided that all specific necessary measures are taken to preserve the confidentiality of trade secrets in particular with respect to third parties. The data holder and the user can agree measures to preserve the confidentiality of the shared data, in particular in relation to third parties.

4. The user shall not use the data obtained pursuant to a request referred to in paragraph 1 to develop a product that competes with the product from which the data originate.   

5. Where the user is not a data subject, any personal data generated by the use of a product or related service shall only be made available by the data holder to the user where there is a valid legal basis under Article 6(1) of Regulation (EU) 2016/679 and, where relevant, the conditions of Article 9 of Regulation (EU) 2016/679 are fulfilled.

6. The data holder shall only use any non-personal data generated by the use of a product or related service on the basis of a contractual agreement with the user. The data holder shall not use such data generated by the use of the product or related service to derive insights about the economic situation, assets and production methods of or the use by the user that could undermine the commercial position of the user in the markets in which the user is active.

### Article 5: Right to share data with third parties

1. Upon request by a user, or by a party acting on behalf of a user, the data holder shall make available the data generated by the use of a product or related service to a third party, without undue delay, free of charge to the user, of the same quality as is available to the data holder and, where applicable, continuously and in real-time.

2. Any undertaking providing core platform services for which one or more of such services have been designated as a gatekeeper, pursuant to         Article [...] of [Regulation XXX on contestable and fair markets in the digital sector (Digital Markets Act)73], shall not be an eligible third party under this Article and therefore shall not:

   (a) solicit or commercially incentivise a user in any manner, including by providing monetary or any other compensation, to make data available to one of its services that the user has obtained pursuant to a request under Article 4(1);

   (b) solicit or commercially incentivise a user to request the data holder to make data available to one of its services pursuant to paragraph 1 of this Article;

   (c) receive data from a user that the user has obtained pursuant to a request under Article 4(1).

3. The user or third party shall not be required to provide any information beyond what is necessary to verify the quality as user or as third party pursuant to paragraph 1. The data holder shall not keep any information on the third party’s access to the data requested beyond what is necessary for the sound execution of the third party’s access request and for the security and the maintenance of the data infrastructure.

4. The third party shall not deploy coercive means or abuse evident gaps in the technical infrastructure of the data holder designed to protect the data in order to obtain access to data.

5. The data holder shall not use any non-personal data generated by the use of the product or related service to derive insights about the economic situation, assets and production methods of or use by the third party that could undermine the commercial position of the third party on the markets in which the third party is active, unless the third party has consented to such use and has the technical possibility to withdraw that consent at any time.

6. Where the user is not a data subject, any personal data generated by the use of a product or related service shall only be made available where there is a valid legal basis under Article 6(1) of Regulation (EU) 2016/679 and where relevant, the conditions of Article 9 of Regulation (EU) 2016/679 are fulfilled.

7. Any failure on the part of the data holder and the third party to agree on arrangements for transmitting the data shall not hinder, prevent or interfere with the exercise of the rights of the data subject under Regulation (EU) 2016/679 and, in particular, with the right to data portability under Article 20 of that Regulation.

8. Trade secrets shall only be disclosed to third parties to the extent that they are strictly necessary to fulfil the purpose agreed between the user and the third party and all specific necessary measures agreed between the data holder and the third party are taken by the third party to preserve the confidentiality of the trade secret. In such a case, the nature of the data as trade secrets and the measures for preserving the confidentiality shall be specified in the agreement between the data holder and the third party.

9. The right referred to in paragraph 1 shall not adversely affect data protection rights of others.

### Article 6: Obligations of third parties receiving data at the request of the user

1. A third party shall process the data made available to it pursuant to Article 5 only for the purposes and under the conditions agreed with the user, and subject to the rights of the data subject insofar as personal data are concerned, and shall delete the data when they are no longer necessary for the agreed purpose.

2. The third party shall not:

   (a) coerce, deceive or manipulate the user in any way, by subverting or impairing the autonomy, decision-making or choices of the user, including by means of a digital interface with the user;

   (b) use the data it receives for the profiling of natural persons within the meaning of Article 4(4) of Regulation (EU) 2016/679, unless it is necessary to provide the service requested by the user;

   (c) make the data available it receives to another third party, in raw, aggregated or derived form, unless this is necessary to provide the service requested by the user;

   (d) make the data available it receives to an undertaking providing core platform services for which one or more of such services have been designated as a gatekeeper pursuant to Article [...] of [Regulation on contestable and fair markets in the digital sector (Digital Markets Act)];

   (e) use the data it receives to develop a product that competes with the product from which the accessed data originate or share the data with another third party for that purpose;

   (f) prevent the user, including through contractual commitments, from making the data it receives available to other parties.

### Article 7: Scope of business to consumer and business to business data sharing obligations   

1. The obligations of this Chapter shall not apply to data generated by the use of products manufactured or related services provided by enterprises that qualify as micro or small enterprises, as defined in Article 2 of the Annex to Recommendation 2003/361/EC, provided those enterprises do not have partner enterprises or linked enterprises as defined in Article 3 of the Annex to Recommendation 2003/361/EC which do not qualify as a micro or small enterprise.

2. Where this Regulation refers to products or related services, such reference shall also be understood to include virtual assistants, insofar as they are used to access or control a product or related service.

## CHAPTER III: OBLIGATIONS FOR DATA HOLDERS LEGALLY OBLIGED TO MAKE DATA AVAILABLE

### Article 8: Conditions under which data holders make data available to data recipients

1. Where a data holder is obliged to make data available to a data recipient under Article 5 or under other Union law or national legislation implementing Union law, it shall do so under fair, reasonable and non-discriminatory terms and in a transparent manner in accordance with the provisions of this Chapter and Chapter IV.

2. A data holder shall agree with a data recipient the terms for making the data available. A contractual term concerning the access to and use of the data or the liability and remedies for the breach or the termination of data related obligations shall not be binding if it fulfils the conditions of Article 13 or if it excludes the application of, derogates from or varies the effect of the user’s rights under Chapter II.

3. A data holder shall not discriminate between comparable categories of data recipients, including partner enterprises or linked enterprises, as defined in Article 3 of the Annex to Recommendation 2003/361/EC, of the data holder, when making data available. Where a data recipient considers the conditions under which data has been made available to it to be discriminatory, it shall be for the data holder to demonstrate that there has been no discrimination.

4. A data holder shall not make data available to a data recipient on an exclusive basis unless requested by the user under Chapter II.

5. Data holders and data recipients shall not be required to provide any information beyond what is necessary to verify compliance with the contractual terms agreed for making data available or their obligations under this Regulation or other applicable Union law or national legislation implementing Union law.

6. Unless otherwise provided by Union law, including Article 6 of this Regulation, or by national legislation implementing Union law, an obligation to make data available to a data recipient shall not oblige the disclosure of trade secrets within the meaning of Directive (EU) 2016/943.

### Article 9: Compensation for making data available

1. Any compensation agreed between a data holder and a data recipient for making data available shall be reasonable.

2. Where the data recipient is a micro, small or medium enterprise, as defined in Article 2 of the Annex to Recommendation 2003/361/EC, any compensation agreed shall not exceed the costs directly related to making the data available to the data recipient and which are attributable to the request. Article 8(3) shall apply accordingly.

3. This Article shall not preclude other Union law or national legislation implementing Union law from excluding compensation for making data available or providing for lower compensation.

4. The data holder shall provide the data recipient with information setting out the basis for the calculation of the compensation in sufficient detail so that the data recipient can verify that the requirements of paragraph 1 and, where applicable, paragraph 2 are met.

### Article 10: Dispute settlement

1. Data holders and data recipients shall have access to dispute settlement bodies, certified in accordance with paragraph 2 of this Article, to settle disputes in relation to the determination of fair, reasonable and non-discriminatory terms for and the transparent manner of making data available in accordance with Articles 8 and 9.

2. The Member State where the dispute settlement body is established shall, at the request of that body, certify the body, where the body has demonstrated that it meets all of the following conditions:

   (a) it is impartial and independent, and it will issue its decisions in accordance with clear and fair rules of procedure;

   (b) it has the necessary expertise in relation to the determination of fair, reasonable and non-discriminatory terms for and the transparent manner of making data available, allowing the body to effectively determine those terms;

   (c) it is easily accessible through electronic communication technology;

   (d) it is capable of issuing its decisions in a swift, efficient and cost-effective manner and in at least one official language of the Union.

   If no dispute settlement body is certified in a Member State by [date of application of the Regulation], that Member State shall establish and certify a dispute settlement body that fulfils the conditions set out in points (a) to (d) of this paragraph.

3. Member States shall notify to the Commission the dispute settlement bodies certified in accordance with paragraph 2. The Commission shall publish a list of those bodies on a dedicated website and keep it updated.

4. Dispute settlement bodies shall make the fees, or the mechanisms used to determine the fees, known to the parties concerned before those parties request a decision.

5. Dispute settlement bodies shall refuse to deal with a request to resolve a dispute that has already been brought before another dispute settlement body or before a court or a tribunal of a Member State.

6. Dispute settlement bodies shall grant the parties the possibility, within a reasonable period of time, to express their point of view on matters those parties have brought before those bodies. In that context, dispute settlement bodies shall provide those parties with the submissions of the other party and any statements made by experts. Those bodies shall grant the parties the possibility to comment on those submissions and statements.

7. Dispute settlement bodies shall issue their decision on matters referred to them no later than 90 days after the request for a decision has been made. Those decisions shall be in writing or on a durable medium and shall be supported by a statement of reasons supporting the decision.

8. The decision of the dispute settlement body shall only be binding on the parties if the parties have explicitly consented to its binding nature prior to the start of the dispute settlement proceedings.

9. This Article does not affect the right of the parties to seek an effective remedy before a court or tribunal of a Member State.

### Article 11: Technical protection measures and provisions on unauthorised use or disclosure of data

1. The data holder may apply appropriate technical protection measures, including smart contracts, to prevent unauthorised access to the data and to ensure compliance with Articles 5, 6, 9 and 10, as well as with the agreed contractual terms for making data available. Such technical protection measures shall not be used as a means to hinder the user’s right to effectively provide data to third parties pursuant to Article 5 or any right of a third party under Union law or national legislation implementing Union law as referred to in Article 8(1).

2. A data recipient that has, for the purposes of obtaining data, provided inaccurate or false information to the data holder, deployed deceptive or coercive means or abused evident gaps in the technical infrastructure of the data holder designed to protect the data, has used the data made available for unauthorised purposes or has disclosed those data to another party without the data holder’s authorisation, shall without undue delay, unless the data holder or the user instruct otherwise:

   (a) destroy the data made available by the data holder and any copies thereof;

   (b) end the production, offering, placing on the market or use of goods, derivative data or services produced on the basis of knowledge obtained  through such data, or the importation, export or storage of infringing goods for those purposes, and destroy any infringing goods.

3. Paragraph 2, point (b), shall not apply in either of the following cases:

   (a) use of the data has not caused significant harm to the data holder;

   (b) it would be disproportionate in light of the interests of the data holder.

### Article 12: Scope of obligations for data holders legally obliged to make data available

1. This Chapter shall apply where a data holder is obliged under Article 5, or under Union law or national legislation implementing Union law, to make data available to a data recipient.

2. Any contractual term in a data sharing agreement which, to the detriment of one party, or, where applicable, to the detriment of the user, excludes the application of this Chapter, derogates from it, or varies its effect, shall not be binding on that party.

3. This Chapter shall only apply in relation to obligations to make data available under Union law or national legislation implementing Union law, which enter into force after [date of application of the Regulation].

## CHAPTER IV: UNFAIR TERMS RELATED TO DATA ACCESS AND USE BETWEEN ENTERPRISES

### Article 13: Unfair contractual terms unilaterally imposed on a micro, small or medium-sized enterprise

1. A contractual term, concerning the access to and use of data or the liability and remedies for the breach or the termination of data related obligations which has been unilaterally imposed by an enterprise on a micro, small or medium-sized enterprise as defined in Article 2 of the Annex to Recommendation 2003/361/EC shall not be binding on the latter enterprise if it is unfair.

2. A contractual term is unfair if it is of such a nature that its use grossly deviates from good commercial practice in data access and use, contrary to good faith and fair dealing.

3. A contractual term is unfair for the purposes of this Article if its object or effect is to:

   (a) exclude or limit the liability of the party that unilaterally imposed the term for intentional acts or gross negligence;

   (b) exclude the remedies available to the party upon whom the term has been unilaterally imposed in case of non-performance of contractual obligations or the liability of the party that unilaterally imposed the term in case of breach of those obligations;

   (c) give the party that unilaterally imposed the term the exclusive right to determine whether the data supplied are in conformity with the contract or to interpret any term of the contract.

4. A contractual term is presumed unfair for the purposes of this Article if its object or effect is to:

   (a) inappropriately limit the remedies in case of non-performance of contractual obligations or the liability in case of breach of those obligations;

   (b) allow the party that unilaterally imposed the term to access and use data of the other contracting party in a manner that is significantly detrimental to the legitimate interests of the other contracting party;

   (c) prevent the party upon whom the term has been unilaterally imposed from using the data contributed or generated by that party during the period of the contract, or to limit the use of such data to the extent that that party is not entitled to use, capture, access or control such data or exploit the value of such data in a proportionate manner;

   (d) prevent the party upon whom the term has been unilaterally imposed from obtaining a copy of the data contributed or generated by that party during the period of the contract or within a reasonable period after the termination thereof;

   (e) enable the party that unilaterally imposed the term to terminate the contract with an unreasonably short notice, taking into consideration the reasonable possibilities of the other contracting party to switch to an alternative and comparable service and the financial detriment caused by such termination, except where there are serious grounds for doing so.

5. A contractual term shall be considered to be unilaterally imposed within the meaning of this Article if it has been supplied by one contracting party and the other contracting party has not been able to influence its content despite an attempt to negotiate it. The contracting party that supplied a contractual term bears the burden of proving that that term has not been unilaterally imposed.

6. Where the unfair contractual term is severable from the remaining terms of the contract, those remaining terms shall remain binding.

7. This Article does not apply to contractual terms defining the main subject matter of the contract or to contractual terms determining the price to be paid.

8. The parties to a contract covered by paragraph 1 may not exclude the application of this Article, derogate from it, or vary its effects.     

## CHAPTER V: MAKING DATA AVAILABLE TO PUBLIC SECTOR BODIES AND UNION INSTITUTIONS, AGENCIES OR BODIES BASED ON EXCEPTIONAL NEED

### Article 14: Obligation to make data available based on exceptional need

1. Upon request, a data holder shall make data available to a public sector body or to a Union institution, agency or body demonstrating an exceptional need to use the data requested.

2. This Chapter shall not apply to small and micro enterprises as defined in Article 2 of the Annex to Recommendation 2003/361/EC.

### Article 15: Exceptional need to use data

An exceptional need to use data within the meaning of this Chapter shall be deemed to exist in any of the following circumstances:

   (a) where the data requested is necessary to respond to a public emergency;

   (b) where the data request is limited in time and scope and necessary to prevent a public emergency or to assist the recovery from a public emergency;

   (c) where the lack of available data prevents the public sector body or Union institution, agency or body from fulfilling a specific task in the public interest that has been explicitly provided by law; and

- (1) the public sector body or Union institution, agency or body has been unable to obtain such data by alternative means, including by purchasing the data on the market at market rates or by relying on existing obligations to make data available, and the adoption of new legislative measures cannot ensure the timely availability of the data; or

- (2) obtaining the data in line with the procedure laid down in this Chapter would substantively reduce the administrative burden for data holders or other enterprises.

### Article 16: Relationship with other obligations to make data available to public sector bodies and Union institutions, agencies and bodies

1. This Chapter shall not affect obligations laid down in Union or national law for the purposes of reporting, complying with information requests or demonstrating or verifying compliance with legal obligations.

2. The rights from this Chapter shall not be exercised by public sector bodies and Union institutions, agencies and bodies in order to carry out activities for the prevention, investigation, detection or prosecution of criminal or administrative offences or the execution of criminal penalties, or for customs or taxation administration. This Chapter does not affect the applicable Union and national law on the prevention, investigation, detection or prosecution of criminal or administrative offences or the execution of criminal or administrative penalties, or for customs or taxation administration.

### Article 17: Requests for data to be made available

1. Where requesting data pursuant to Article 14(1), a public sector body or a Union institution, agency or body shall:

   (a) specify what data are required;

   (b) demonstrate the exceptional need for which the data are requested;

   (c) explain the purpose of the request, the intended use of the data requested, and the duration of that use;

   (d) state the legal basis for requesting the data;

   (e) specify the deadline by which the data are to be made available or within which the data holder may request the public sector body, Union institution, agency or body to modify or withdraw the request.

2. A request for data made pursuant to paragraph 1 of this Article shall:

   (a) be expressed in clear, concise and plain language understandable to the data holder;

   (b) be proportionate to the exceptional need, in terms of the granularity and volume of the data requested and frequency of access of the data requested;

   (c) respect the legitimate aims of the data holder, taking into account the protection of trade secrets and the cost and effort required to make the data available;

   (d) concern, insofar as possible, non-personal data;

   (e) inform the data holder of the penalties that shall be imposed pursuant to Article 33 by a competent authority referred to in Article 31 in the event of non- compliance with the request;

   (f) be made publicly available online without undue delay.

3. A public sector body or a Union institution, agency or body shall not make data obtained pursuant to this Chapter available for reuse within the meaning of Directive (EU) 2019/1024. Directive (EU) 2019/1024 shall not apply to the data held by public sector bodies obtained pursuant to this Chapter.

4. Paragraph 3 does not preclude a public sector body or a Union institution, agency or body to exchange data obtained pursuant to this Chapter with another public sector body, Union institution, agency or body, in view of completing the tasks in Article 15 or to make the data available to a third party in cases where it has outsourced, by means of a publicly available agreement, technical inspections or other functions to this third party. The obligations on public sector bodies, Union institutions, agencies or bodies pursuant to Article 19 apply.

Where a public sector body or a Union institution, agency or body transmits or makes data available under this paragraph, it shall notify the data holder from whom the data was received.

### Article 18: Compliance with requests for data

1. A data holder receiving a request for access to data under this Chapter shall make the data available to the requesting public sector body or a Union institution, agency or body without undue delay.

2. Without prejudice to specific needs regarding the availability of data defined in sectoral legislation, the data holder may decline or seek the modification of the request within 5 working days following the receipt of a request for the data necessary to respond to a public emergency and within 15 working days in other cases of exceptional need, on either of the following grounds:

   (a) the data is unavailable;

   (b) the request does not meet the conditions laid down in Article 17(1) and (2).

3. In case of a request for data necessary to respond to a public emergency, the data holder may also decline or seek modification of the request if the data holder already provided the requested data in response to previously submitted request for the same purpose by another public sector body or Union institution agency or body and the data holder has not been notified of the destruction of the data pursuant to Article 19(1), point (c).

4. If the data holder decides to decline the request or to seek its modification in accordance with paragraph 3, it shall indicate the identity of the public sector body or Union institution agency or body that previously submitted a request for the same purpose.

5. Where compliance with the request to make data available to a public sector body or a Union institution, agency or body requires the disclosure of personal data, the data holder shall take reasonable efforts to pseudonymise the data, insofar as the request can be fulfilled with pseudonymised data.

6. Where the public sector body or the Union institution, agency or body wishes to challenge a data holder’s refusal to provide the data requested, or to seek modification of the request, or where the data holder wishes to challenge the request, the matter shall be brought to the competent authority referred to in Article 31.

### Article 19: Obligations of public sector bodies and Union institutions, agencies and bodies

1. A public sector body or a Union institution, agency or body having received data pursuant to a request made under Article 14 shall:

   (a) not use the data in a manner incompatible with the purpose for which they were requested;

   (b) implement, insofar as the processing of personal data is necessary, technical and organisational measures that safeguard the rights and freedoms of data subjects;

   (c) destroy the data as soon as they are no longer necessary for the stated purpose and inform the data holder that the data have been destroyed.

2. Disclosure of trade secrets or alleged trade secrets to a public sector body or to a Union institution, agency or body shall only be required to the extent that it is strictly necessary to achieve the purpose of the request. In such a case, the public sector body or the Union institution, agency or body shall take appropriate measures to preserve the confidentiality of those trade secrets.

### Article 20: Compensation in cases of exceptional need

1. Data made available to respond to a public emergency pursuant to Article 15, point (a), shall be provided free of charge.

2. Where the data holder claims compensation for making data available in compliance with a request made pursuant to Article 15, points (b) or (c), such compensation shall not exceed the technical and organisational costs incurred to comply with the request including, where necessary, the costs of anonymisation and of technical adaptation, plus a reasonable margin. Upon request of the public sector body or the Union institution, agency or body requesting the data, the data holder shall provide information on the basis for the calculation of the costs and the reasonable margin.

### Article 21: Contribution of research organisations or statistical bodies in the context of exceptional needs

1. A public sector body or a Union institution, agency or body shall be entitled to share data received under this Chapter with individuals or organisations in view of carrying out scientific research or analytics compatible with the purpose for which the data was requested, or to national statistical institutes and Eurostat for the compilation of official statistics.

2. Individuals or organisations receiving the data pursuant to paragraph 1 shall act on a not-for-profit basis or in the context of a public-interest mission recognised in Union or Member State law. They shall not include organisations upon which commercial undertakings have a decisive influence or which could result in preferential access to the results of the research.

3. Individuals or organisations receiving the data pursuant to paragraph 1 shall comply with the provisions of Article 17(3) and Article 19.

4. Where a public sector body or a Union institution, agency or body transmits or makes data available under paragraph 1, it shall notify the data holder from whom the data was received.

### Article 22: Mutual assistance and cross-border cooperation

1. Public sector bodies and Union institutions, agencies and bodies shall cooperate and assist one another, to implement this Chapter in a consistent manner.

2. Any data exchanged in the context of assistance requested and provided pursuant to paragraph 1 shall not be used in a manner incompatible with the purpose for which they were requested.

3. Where a public sector body intends to request data from a data holder established in another Member State, it shall first notify the competent authority of that Member State as referred to in Article 31, of that intention. This requirement shall also apply to requests by Union institutions, agencies and bodies.

4. After having been notified in accordance with paragraph 3, the relevant competent authority shall advise the requesting public sector body of the need, if any, to cooperate with public sector bodies of the Member State in which the data holder is established, with the aim of reducing the administrative burden on the data holder in complying with the request. The requesting public sector body shall take the advice of the relevant competent authority into account.

## CHAPTER VI: SWITCHING BETWEEN DATA PROCESSING SERVICES

### Article 23: Removing obstacles to effective switching between providers of data processing services

1. Providers of a data processing service shall take the measures provided for in Articles 24, 25 and 26 to ensure that customers of their service can switch to another data processing service, covering the same service type, which is provided by a different service provider. In particular, providers of data processing service shall remove commercial, technical, contractual and organisational obstacles, which inhibit customers from:

   (a) terminating, after a maximum notice period of 30 calendar days, the contractual agreement of the service;

   (b) concluding new contractual agreements with a different provider of data processing services covering the same service type;

   (c) porting its data, applications and other digital assets to another provider of data processing services;

   (d) maintaining functional equivalence of the service in the IT-environment of the different provider or providers of data processing services covering the same service type, in accordance with Article 26.

2. Paragraph 1 shall only apply to obstacles that are related to the services, contractual agreements or commercial practices provided by the original provider.

### Article 24: Contractual terms concerning switching between providers of data processing services

1. The rights of the customer and the obligations of the provider of a data processing service in relation to switching between providers of such services shall be clearly set out in a written contract. Without prejudice to Directive (EU) 2019/770, that contract shall include at least the following:

   (a) clauses allowing the customer, upon request, to switch to a data processing service offered by another provider of data processing service or to port all data, applications and digital assets generated directly or indirectly by the customer to an on-premise system, in particular the establishment of a mandatory maximum transition period of 30 calendar days, during which the data processing service provider shall:

      (1) assist and, where technically feasible, complete the switching process;

      (2) ensure full continuity in the provision of the respective functions or services.

   (b) an exhaustive specification of all data and application categories exportable during the switching process, including, at minimum, all data imported by the customer at the inception of the service agreement and all data and metadata created by the customer and by the use of the service during the period the service was provided, including, but not limited to, configuration parameters, security settings, access rights and access logs to the service;

   (c) a minimum period for data retrieval of at least 30 calendar days, starting after the termination of the transition period that was agreed between the customer and the service provider, in accordance with paragraph 1, point (a) and paragraph 2.

 2. Where the mandatory transition period as defined in paragraph 1, points (a) and (c) of this Article is technically unfeasible, the provider of data processing services shall notify the customer within 7 working days after the switching request has been made, duly motivating the technical unfeasibility with a detailed report and indicating an alternative transition period, which may not exceed 6 months. In accordance with paragraph 1 of this Article, full service continuity shall be ensured throughout the alternative transition period against reduced charges, referred to in Article 25(2).

### Article 25: Gradual withdrawal of switching charges

1. From [date X+3yrs] onwards, providers of data processing services shall not impose any charges on the customer for the switching process.

2. From [date X, the date of entry into force of the Data Act] until [date X+3yrs], providers of data processing services may impose reduced charges on the customer for the switching process.

3. The charges referred to in paragraph 2 shall not exceed the costs incurred by the provider of data processing services that are directly linked to the switching process concerned.

4. The Commission is empowered to adopt delegated acts in accordance with Article 38 to supplement this Regulation in order to introduce a monitoring mechanism for the Commission to monitor switching charges imposed by data processing service providers on the market to ensure that the withdrawal of switching charges as described in paragraph 1 of this Article will be attained in accordance with the deadline provided in the same paragraph.

### Article 26: Technical aspects of switching

1. Providers of data processing services that concern scalable and elastic computing resources limited to infrastructural elements such as servers, networks and the virtual resources necessary for operating the infrastructure, but that do not provide access to the operating services, software and applications that are stored, otherwise processed, or deployed on those infrastructural elements, shall ensure that the customer, after switching to a service covering the same service type offered by a different provider of data processing services, enjoys functional equivalence in the use of the new service.

2. For data processing services other than those covered by paragraph 1, providers of data processing services shall make open interfaces publicly available and free of charge.

3. For data processing services other than those covered by paragraph 1, providers of data processing services shall ensure compatibility with open interoperability specifications or European standards for interoperability that are identified in accordance with Article 29(5) of this Regulation.

4. Where the open interoperability specifications or European standards referred to in paragraph 3 do not exist for the service type concerned, the provider of data processing services shall, at the request of the customer, export all data generated or co-generated, including the relevant data formats and data structures, in a structured, commonly used and machine-readable format.

## CHAPTER VII: INTERNATIONAL CONTEXTS NON-PERSONAL DATA SAFEGUARDS

### Article 27: International access and transfer

1. Providers of data processing services shall take all reasonable technical, legal and organisational measures, including contractual arrangements, in order to prevent international transfer or governmental access to non-personal data held in the Union where such transfer or access would create a conflict with Union law or the national law of the relevant Member State, without prejudice to paragraph 2 or 3.

2. Any decision or judgment of a court or tribunal and any decision of an administrative authority of a third country requiring a provider of data processing services to transfer from or give access to non-personal data within the scope of this Regulation held in the Union may only be recognised or enforceable in any manner if based on an international agreement, such as a mutual legal assistance treaty, in force between the requesting third country and the Union or any such agreement between the requesting third country and a Member State.

3. In the absence of such an international agreement, where a provider of data processing services is the addressee of a decision of a court or a tribunal or a decision of an administrative authority of a third country to transfer from or give access to non-personal data within the scope of this Regulation held in the Union and compliance with such a decision would risk putting the addressee in conflict with Union law or with the national law of the relevant Member State, transfer to or access to such data by that third-country authority shall take place only:

   (a) where the third-country system requires the reasons and proportionality of the decision or judgement to be set out, and it requires such decision or judgement, as the case may be, to be specific in character, for instance by establishing a sufficient link to certain suspected persons, or infringements;

   (b) the reasoned objection of the addressee is subject to a review by a competent court or tribunal in the third-country; and

   (c) the competent court or tribunal issuing the decision or judgement or reviewing the decision of an administrative authority is empowered under the law of that country to take duly into account the relevant legal interests of the provider of the data protected by Union law or national law of the relevant Member State.

The addressee of the decision may ask the opinion of the relevant competent bodies or authorities, pursuant to this Regulation, in order to determine  whether these conditions are met, notably when it considers that the decision may relate to commercially sensitive data, or may impinge on national  security or defence interests of the Union or its Member States.

The European Data Innovation Board established under Regulation [xxx – DGA] shall advise and assist the Commission in developing guidelines on the assessment of whether these conditions are met.  

4. If the conditions in paragraph 2 or 3 are met, the provider of data processing services shall provide the minimum amount of data permissible in response to a request, based on a reasonable interpretation thereof.

5. The provider of data processing services shall inform the data holder about the existence of a request of an administrative authority in a third-country to access its data before complying with its request, except in cases where the request serves law enforcement purposes and for as long as this is necessary to preserve the effectiveness of the law enforcement activity. 

## CHAPTER VIII: INTEROPERABILITY

### Article 28: Essential requirements regarding interoperability

1. Operators of data spaces shall comply with, the following essential requirements to facilitate interoperability of data, data sharing mechanisms and services:

   (a) the dataset content, use restrictions, licences, data collection methodology, data quality and uncertainty shall be sufficiently described to allow the recipient to find, access and use the data;

   (b) the data structures, data formats, vocabularies, classification schemes, taxonomies and code lists shall be described in a publicly available and consistent manner;

   (c) the technical means to access the data, such as application programming interfaces, and their terms of use and quality of service shall be sufficiently described to enable automatic access and transmission of data between parties, including continuously or in real-time in a machine-readable format;

   (d) the means to enable the interoperability of smart contracts within their services and activities shall be provided.

These requirements can have a generic nature or concern specific sectors, while taking fully into account the interrelation with requirements coming from other Union or national sectoral legislation.

2. The Commission is empowered to adopt delegated acts, in accordance with Article 38 to supplement this Regulation by further specifying the essential requirements referred to in paragraph 1.

3. Operators of data spaces that meet the harmonised standards or parts thereof published by reference in the Official Journal of the European Union shall be presumed to be in conformity with the essential requirements referred to in paragraph 1 of this Article, to the extent those standards cover those requirements.

4. The Commission may, in accordance with Article 10 of Regulation (EU) No 1025/2012, request one or more European standardisation organisations to draft harmonised standards that satisfy the essential requirements under paragraph 1 of this Article

5. The Commission shall, by way of implementing acts, adopt common specifications, where harmonised standards referred to in paragraph 4 of this Article do not exist or in case it considers that the relevant harmonised standards are insufficient to ensure conformity with the essential requirements in paragraph 1 of this Article, where necessary, with respect to any or all of the requirements laid down in paragraph 1 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 39(2).

6. The Commission may adopt guidelines laying down interoperability specifications for the functioning of common European data spaces, such as architectural models and technical standards implementing legal rules and arrangements between parties that foster data sharing, such as regarding rights to access and technical translation of consent or permission.

### Article 29: Interoperability for data processing services

1. Open interoperability specifications and European standards for the interoperability of data processing services shall:

   (a) be performance oriented towards achieving interoperability between different data processing services that cover the same service type;

   (b) enhance portability of digital assets between different data processing services that cover the same service type;

   (c) guarantee, where technically feasible, functional equivalence between different data processing services that cover the same service type.

2. Open interoperability specifications and European standards for the interoperability of data processing services shall address:

   (a) the cloud interoperability aspects of transport interoperability, syntactic interoperability, semantic data interoperability, behavioural interoperability and policy interoperability;

   (b) the cloud data portability aspects of data syntactic portability, data semantic portability and data policy portability;

   (c) the cloud application aspects of application syntactic portability, application instruction portability, application metadata portability, application behaviour portability and application policy portability.

3. Open interoperability specifications shall comply with paragraph 3 and 4 of Annex II of Regulation (EU) No 1025/2012.

4. The Commission may, in accordance with Article 10 of Regulation (EU) No 1025/2012, request one or more European standardisation organisations to draft European standards applicable to specific service types of data processing services.

5. For the purposes of Article 26(3) of this Regulation, the Commission shall be empowered to adopt delegated acts, in accordance with Article 38, to publish the reference of open interoperability specifications and European standards for the interoperability of data processing services in central Union standards repository for the interoperability of data processing services, where these satisfy the criteria specified in paragraph 1 and 2 of this Article.

### Article 30: Essential requirements regarding smart contracts for data sharing

1. The vendor of an application using smart contracts or, in the absence thereof, the person whose trade, business or profession involves the deployment of smart contracts for others in the context of an agreement to make data available shall comply with the following essential requirements:

   (a) robustness: ensure that the smart contract has been designed to offer a very high degree of robustness to avoid functional errors and to withstand manipulation by third parties;

   (b) safe termination and interruption: ensure that a mechanism exists to terminate the continued execution of transactions: the smart contract shall include internal functions which can reset or instruct the contract to stop or interrupt the operation to avoid future (accidental) executions;

   (c) data archiving and continuity: foresee, if a smart contract must be terminated or deactivated, a possibility to archive transactional data, the smart contract logic and code to keep the record of the operations performed on the data in the past (auditability); and

   (d) access control: a smart contract shall be protected through rigorous access control mechanisms at the governance and smart contract layers.

2. The vendor of a smart contract or, in the absence thereof, the person whose trade, business or profession involves the deployment of smart contracts for others in the context of an agreement to make data available shall perform a conformity assessment with a view to fulfilling the essential requirements under paragraph 1 and, on the fulfilment of the requirements, issue an EU declaration of conformity.

3. By drawing up the EU declaration of conformity, the vendor of an application using smart contracts or, in the absence thereof, the person whose trade, business or profession involves the deployment of smart contracts for others in the context of an agreement to make data available shall be responsible for compliance with the requirements under paragraph 1.

4. A smart contract that meets the harmonised standards or the relevant parts thereof drawn up and published in the Official Journal of the European Union shall be presumed to be in conformity with the essential requirements under paragraph 1 of this Article to the extent those standards cover those requirements.

5. The Commission may, in accordance with Article 10 of Regulation (EU) No 1025/2012, request one or more European standardisation organisations to draft harmonised standards that satisfy the essential the requirements under paragraph 1 of this Article.

6. Where harmonised standards referred to in paragraph 4 of this Article do not exist or where the Commission considers that the relevant harmonised standards are insufficient to ensure conformity with the essential requirements in paragraph 1 of this Article in a cross-border context, the Commission may, by way of implementing acts, adopt common specifications in respect of the essential requirements set out in paragraph 1 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 39(2).

## CHAPTER IX: IMPLEMENTATION AND ENFORCEMENT   

### Article 31: Competent authorities

1. Each Member State shall designate one or more competent authorities as responsible for the application and enforcement of this Regulation. Member States may establish one or more new authorities or rely on existing authorities.

2. Without prejudice to paragraph 1 of this Article:

   (a) the independent supervisory authorities responsible for monitoring the application of Regulation (EU) 2016/679 shall be responsible for monitoring the application of this Regulation insofar as the protection of personal data is concerned. Chapters VI and VII of Regulation (EU) 2016/679 shall apply mutatis mutandis. The tasks and powers of the supervisory authorities shall be exercised with regard to the processing of personal data;

   (b) for specific sectoral data exchange issues related to the implementation of this Regulation, the competence of sectoral authorities shall be respected;

   (c) the national competent authority responsible for the application and enforcement of Chapter VI of this Regulation shall have experience in the field of data and electronic communications services.

3. Member States shall ensure that the respective tasks and powers of the competent authorities designated pursuant to paragraph 1 of this Article are clearly defined and include:

   (a) promoting awareness among users and entities falling within scope of this Regulation of the rights and obligations under this Regulation;

   (b) handling complaints arising from alleged violations of this Regulation, and investigating, to the extent appropriate, the subject matter of the complaint and informing the complainant of the progress and the outcome of the investigation within a reasonable period, in particular if further investigation or coordination with another competent authority is necessary;

   (c) conducting investigations into matters that concern the application of this Regulation, including on the basis of information received from another competent authority or other public authority;

   (d) imposing, through administrative procedures, dissuasive financial penalties which may include periodic penalties and penalties with retroactive effect, or initiating legal proceedings for the imposition of fines;

   (e) monitoring technological developments of relevance for the making available and use of data;

   (f) cooperating with competent authorities of other Member States to ensure the consistent application of this Regulation, including the exchange of all relevant information by electronic means, without undue delay;

   (g) ensuring the online public availability of requests for access to data made by public sector bodies in the case of public emergencies under Chapter V;  

   (h) cooperating with all relevant competent authorities to ensure that the obligations of Chapter VI are enforced consistently with other Union legislation and self-regulation applicable to providers of data processing service;

   (i) ensuring that charges for the switching between providers of data processing services are withdrawn in accordance with Article 25. 

4. Where a Member State designates more than one competent authority, the competent authorities shall, in the exercise of the tasks and powers assigned to them under paragraph 3 of this Article, cooperate with each other, including, as appropriate, with the supervisory authority responsible for monitoring the application of Regulation (EU) 2016/679, to ensure the consistent application of this Regulation. In such cases, relevant Member States shall designate a coordinating competent authority.

5. Member States shall communicate the name of the designated competent authorities and their respective tasks and powers and, where applicable, the name of the coordinating competent authority to the Commission. The Commission shall maintain a public register of those authorities.

6. When carrying out their tasks and exercising their powers in accordance with this Regulation, the competent authorities shall remain free from any external influence, whether direct or indirect, and shall neither seek nor take instructions from any other public authority or any private party. 

7. Member States shall ensure that the designated competent authorities are provided with the necessary resources to adequately carry out their tasks in accordance with this Regulation.

### Article 32: Right to lodge a complaint with a competent authority  

1. Without prejudice to any other administrative or judicial remedy, natural and legal persons shall have the right to lodge a complaint, individually or, where relevant, collectively, with the relevant competent authority in the Member State of their habitual residence, place of work or establishment if they consider that their rights under this Regulation have been infringed.

2. The competent authority with which the complaint has been lodged shall inform the complainant of the progress of the proceedings and of the decision taken.

3. Competent authorities shall cooperate to handle and resolve complaints, including by exchanging all relevant information by electronic means, without undue delay. This cooperation shall not affect the specific cooperation mechanism provided for by Chapters VI and VII of Regulation (EU) 2016/679.

### Article 33: Penalties

1. Member States shall lay down the rules on penalties applicable to infringements of this Regulation and shall take all measures necessary to ensure that they are implemented. The penalties provided for shall be effective, proportionate and dissuasive.

2. Member States shall by [date of application of the Regulation] notify the Commission of those rules and measures and shall notify it without delay of any subsequent amendment affecting them.

3. For infringements of the obligations laid down in Chapter II, III and V of this Regulation, the supervisory authorities referred to in Article 51 of the Regulation (EU) 2016/679 may within their scope of competence impose administrative fines in line with Article 83 of Regulation (EU) 2016/679 and up to the amount referred to in Article 83(5) of that Regulation.

4. For infringements of the obligations laid down in Chapter V of this Regulation, the supervisory authority referred to in Article 52 of Regulation (EU) 2018/1725 may impose within its scope of competence administrative fines in accordance with Article 66 of Regulation (EU) 2018/1725 up to the amount referred to in Article 66(3) of that Regulation.

### Article 34: Model contractual terms

The Commission shall develop and recommend non-binding model contractual terms on data access and use to assist parties in drafting and negotiating contracts with balanced contractual rights and obligations.

## CHAPTER X: SUI GENERIS RIGHT UNDER DIRECTIVE 1996/9/EC

### Article 35: Databases containing certain data

In order not to hinder the exercise of the right of users to access and use such data in accordance with Article 4 of this Regulation or of the right to share such data with third parties in accordance with Article 5 of this Regulation, the sui generis right provided for in Article 7 of Directive 96/9/EC does not apply to databases containing data obtained from or generated by the use of a product or a related service.

## CHAPTER XI: FINAL PROVISIONS

### Article 36: Amendment to Regulation (EU) No 2017/2394

In the Annex to Regulation (EU) No 2017/2394 the following point is added:

‘29. [Regulation (EU) XXX of the European Parliament and of the Council [Data Act]].’

### Article 37: Amendment to Directive (EU) 2020/1828

In the Annex to Directive (EU) 2020/1828 the following point is added:

‘67. [Regulation (EU) XXX of the European Parliament and of the Council [Data Act]]’

### Article 38: Exercise of the delegation

1. The power to adopt delegated acts is conferred on the Commission subject to the conditions laid down in this Article.

2. The power to adopt delegated acts referred to in Articles 25(4), 28(2) and 29(5) shall be conferred on the Commission for an indeterminate period of time from [...].

3. The delegation of power referred to in Articles 25(4), 28(2) and 29(5) may be revoked at any time by the European Parliament or by the Council. A decision to revoke shall put an end to the delegation of the power specified in that decision. It shall take effect the day following the publication of the decision in the Official Journal of the European Union or at a later date specified therein. It shall not affect the validity of any delegated acts already in force.

4. Before adopting a delegated act, the Commission shall consult experts designated by each Member State in accordance with the principles laid down in the Interinstitutional Agreement on Better Law-Making of 13 April 2016.

5. As soon as it adopts a delegated act, the Commission shall notify it simultaneously to the European Parliament and to the Council.

6. A delegated act adopted pursuant to Articles 25(4), 28(2) and 29(5) shall enter into force only if no objection has been expressed either by the European Parliament or by the Council within a period of three months of notification of that act to the European Parliament and to the Council or if, before the expiry of that period, the European Parliament and the Council have both informed the Commission that they will not object. That period shall be extended by three months at the initiative of the European Parliament or of the Council.

### Article 39: Committee procedure

1. The Commission shall be assisted by a committee. That committee shall be a committee within the meaning of Regulation (EU) No 182/2011.

2. Where reference is made to this paragraph, Article 5 of Regulation (EU) No 182/2011 shall apply.

### Article 40: Other Union legal acts governing rights and obligations on data access and use

1. The specific obligations for the making available of data between businesses, between businesses and consumers, and on exceptional basis between businesses and public bodies, in Union legal acts that entered into force on or before [xx XXX xxx], and delegated or implementing acts based thereupon, shall remain unaffected.

2. This Regulation is without prejudice to Union legislation specifying, in light of the needs of a sector, a common European data space, or an area of public interest, further requirements, in particular in relation to:

   (a) technical aspects of data access;

   (b) limits on the rights of data holders to access or use certain data provided by users;

   (c) aspects going beyond data access and use.

### Article 41: Evaluation and review

By [two years after the date of application of this Regulation], the Commission shall carry out an evaluation of this Regulation and submit a report on its main findings to the European Parliament and to the Council as well as to the European Economic and Social Committee. That evaluation shall assess, in particular:

(a) other categories or types of data to be made accessible;

(b) the exclusion of certain categories of enterprises as beneficiaries under Article 5;

(c) other situations to be deemed as exceptional needs for the purpose of Article 15;

(d) changes in contractual practices of data processing service providers and whether this results in sufficient compliance with Article 24;

(e) diminution of charges imposed by data processing service providers for the switching process, in line with the gradual withdrawal of switching charges pursuant to Article 25.

### Article 42: Entry into force and application

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

It shall apply from [12 months after the date of entry into force of this Regulation].


 












---

# European Data Governance Act
Source: https://docs.igrant.io/regulations/reg-eu-data-governance-act/

---
id: reg-eu-data-governance-act
title: European Data Governance Act
description: Learn how the EU Data Governance Act enables secure data sharing and consent frameworks to build trust in digital identity ecosystems.
sidebar_label: European Data Governance Act
keywords: [Data Governance Act, DGA, data sharing, consent frameworks, EU regulation, digital identity, trust, data intermediation]
slug: /reg-eu-data-governance-act/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Explore the European Data Governance Act | iGrant.io DevDocs</title>
   <meta name="description" content="Learn how the EU Data Governance Act enables secure data sharing and consent frameworks to build trust in digital identity ecosystems."/>
</head>

The Data Governance Act (DGA) is a legislative proposal of the European Commission that aims to create a framework which will facilitate data-sharing. The proposal was first announced within the 2020 European strategy for data on **25 November 2020**. The DGA covers the data of public bodies, private companies, and citizens. Its main aims are to safely enable the sharing of sensitive data held by public bodies, to regulate data sharing by private actors. On 30 November 2021, the EU Parliament and Council reached an agreement on the wording of the DGA. Formal approval by those bodies is still required but that should be procedural.

This section reproduces the European Governance Act to make it easier for our readers. This is published by EU Commission on 25-November-2020. The original pdf can be found [here](https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32022R0868&from=EN#d1e881-1-1).

## CHAPTER I: GENERAL PROVISIONS

### Article 1: Subject matter and scope

1.    This Regulation lays down:

   (a) conditions for the re-use, within the Union, of certain categories of data held by public sector bodies;

   (b) a notification and supervisory framework for the provision of data intermediation services;

   (c) a framework for voluntary registration of entities which collect and process data made available for altruistic purposes; and

   (d) a framework for the establishment of a European Data Innovation Board.

2.    This Regulation does not create any obligation on public sector bodies to allow the re-use of data, nor does it release public sector bodies from their confidentiality obligations under Union or national law.

   This Regulation is without prejudice to:

   (a)  specific provisions in Union or national law regarding the access to or re-use of certain categories of data, in particular with regard to the granting of access to and disclosure of official documents; and

   (b)  the obligations of public sector bodies under Union or national law to allow the re-use of data or to requirements related to processing of non-personal data.

      Where sector-specific Union or national law requires public sector bodies, data intermediation services providers or recognised data altruism organisations to comply with specific additional technical, administrative or organisational requirements, including through an authorisation or certification regime, those provisions of that sector-specific Union or national law shall also apply. Any such specific additional requirements shall be non-discriminatory, proportionate and objectively justified.

3.    Union and national law on the protection of personal data shall apply to any personal data processed in connection with this Regulation. In particular, this Regulation is without prejudice to Regulations (EU) 2016/679 and (EU) 2018/1725 and Directives 2002/58/EC and (EU) 2016/680, including with regard to the powers and competences of supervisory authorities. In the event of a conflict between this Regulation and Union law on the protection of personal data or national law adopted in accordance with such Union law, the relevant Union or national law on the protection of personal data shall prevail. This Regulation does not create a legal basis for the processing of personal data, nor does it affect any of the rights and obligations set out in Regulations (EU) 2016/679 or (EU) 2018/1725 or Directives 2002/58/EC or (EU) 2016/680.

4.    This Regulation is without prejudice to the application of competition law.

5.   This Regulation is without prejudice to the competences of the Member States with regard to their activities concerning public security, defence and national security.

### Article 2: Definitions

For the purposes of this Regulation, the following definitions apply:

(1) ‘data’ means any digital representation of acts, facts or information and any compilation of such acts, facts or information, including in the form of sound, visual or audiovisual recording;

(2) ‘re-use’ means the use by natural or legal persons of data held by public sector bodies, for commercial or non-commercial purposes other than the initial purpose within the public task for which the data were produced, except for the exchange of data between public sector bodies purely in pursuit of their public tasks;

(3) ‘personal data’ means personal data as defined in Article 4, point (1), of Regulation (EU) 2016/679;

(4) ‘non-personal data’ means data other than personal data;

(5) ‘consent’ means consent as defined in Article 4, point (11), of Regulation (EU) 2016/679;

(6) ‘permission’ means giving data users the right to the processing of non-personal data;

(7) ‘data subject’ means data subject as referred to in Article 4, point (1), of Regulation (EU) 2016/679;

(8) ‘data holder’ means a legal person, including public sector bodies and international organisations, or a natural person who is not a data subject with respect to the specific data in question, which, in accordance with applicable Union or national law, has the right to grant access to or to share certain personal data or non-personal data;

(9) ‘data user’ means a natural or legal person who has lawful access to certain personal or non-personal data and has the right, including under Regulation (EU) 2016/679 in the case of personal data, to use that data for commercial or non-commercial purposes;

(10) ‘data sharing’ means the provision of data by a data subject or a data holder to a data user for the purpose of the joint or individual use of such data, based on voluntary agreements or Union or national law, directly or through an intermediary, for example under open or commercial licences subject to a fee or free of charge;

(11) ‘data intermediation service’ means a service which aims to establish commercial relationships for the purposes of data sharing between an undetermined number of data subjects and data holders on the one hand and data users on the other, through technical, legal or other means, including for the purpose of exercising the rights of data subjects in relation to personal data, excluding at least the following:

   * (a) services that obtain data from data holders and aggregate, enrich or transform the data for the purpose of adding substantial value to it and license the use of the resulting data to data users, without establishing a commercial relationship between data holders and data users;

   *  (b) services that focus on the intermediation of copyright-protected content;

   *  (c) services that are exclusively used by one data holder in order to enable the use of the data held by that data holder, or that are used by multiple legal persons in a closed group, including supplier or customer relationships or collaborations established by contract, in particular those that have as a main objective to ensure the functionalities of objects and devices connected to the Internet of Things;

   *  (d) data sharing services offered by public sector bodies that do not aim to establish commercial relationships;

(12) ‘processing’ means processing as defined in Article 4, point (2), of Regulation (EU) 2016/679 with regard to personal data or Article 3, point (2), of Regulation (EU) 2018/1807 with regard to non-personal data;

(13) ‘access’ means data use, in accordance with specific technical, legal or organisational requirements, without necessarily implying the transmission or downloading of data;

(14) ‘main establishment’ of a legal person means the place of its central administration in the Union;

(15) ‘services of data cooperatives’ means data intermediation services offered by an organisational structure constituted by data subjects, one-person undertakings or SMEs who are members of that structure, having as its main objectives to support its members in the exercise of their rights with respect to certain data, including with regard to making informed choices before they consent to data processing, to exchange views on data processing purposes and conditions that would best represent the interests of its members in relation to their data, and to negotiate terms and conditions for data processing on behalf of its members before giving permission to the processing of non-personal data or before they consent to the processing of personal data;

(16) ‘data altruism’ means the voluntary sharing of data on the basis of the consent of data subjects to process personal data pertaining to them, or permissions of data holders to allow the use of their non-personal data without seeking or receiving a reward that goes beyond compensation related to the costs that they incur where they make their data available for objectives of general interest as provided for in national law, where applicable, such as healthcare, combating climate change, improving mobility, facilitating the development, production and dissemination of official statistics, improving the provision of public services, public policy making or scientific research purposes in the general interest;

(17) ‘public sector body’ means the State, regional or local authorities, bodies governed by public law or associations formed by one or more such authorities, or one or more such bodies governed by public law;

(18) ‘bodies governed by public law’ means bodies that have the following characteristics:

* (a) they are established for the specific purpose of meeting needs in the general interest, and do not have an industrial or commercial character;

* (b) they have legal personality;

* (c) they are financed, for the most part, by the State, regional or local authorities, or other bodies governed by public law, are subject to management supervision by those authorities or bodies, or have an administrative, managerial or supervisory board, more than half of whose members are appointed by the State, regional or local authorities, or by other bodies governed by public law;

(19) ‘public undertaking’ means any undertaking over which the public sector bodies may exercise directly or indirectly a dominant influence by virtue of their ownership of it, their financial participation therein, or the rules which govern it; for the purposes of this definition, a dominant influence on the part of the public sector bodies shall be presumed in any of the following cases in which those bodies, directly or indirectly:

* (a) hold the majority of the undertaking’s subscribed capital;

* (b) control the majority of the votes attaching to shares issued by the undertaking;

* (c) can appoint more than half of the undertaking’s administrative, management or supervisory body;

(20) ‘secure processing environment’ means the physical or virtual environment and organisational means to ensure compliance with Union law, such as Regulation (EU) 2016/679, in particular with regard to data subjects’ rights, intellectual property rights, and commercial and statistical confidentiality, integrity and accessibility, as well as with applicable national law, and to allow the entity providing the secure processing environment to determine and supervise all data processing actions, including the display, storage, download and export of data and the calculation of derivative data through computational algorithms;

(21) ‘legal representative’ means a natural or legal person established in the Union explicitly designated to act on behalf of a data intermediation services provider or an entity that collects data for objectives of general interest made available by natural or legal persons on the basis of data altruism not established in the Union, which may be addressed by the competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations in addition to or instead of the data intermediation services provider or entity with regard to the obligations under this Regulation, including with regard to initiating enforcement proceedings against a non-compliant data intermediation services provider or entity not established in the Union.

## CHAPTER II: RE-USE OF CERTAIN CATEGORIES OF PROTECTED DATA HELD BY PUBLIC BODIES 

### Article 3: Categories of data

1. This Chapter applies to data held by public sector bodies which are protected on grounds of:

   (a) commercial confidentiality, including business, professional and company secrets;

   (b) statistical confidentiality;

   (c) the protection of intellectual property rights of third parties; or

   (d) the protection of personal data, insofar as such data fall outside the scope of Directive (EU) 2019/1024.

2.   This Chapter does not apply to:

   (a) data held by public undertakings;

   (b) data held by public service broadcasters and their subsidiaries, and by other bodies or their subsidiaries for the fulfilment of a public service broadcasting remit;

   (c) data held by cultural establishments and educational establishments;

   (d) data held by public sector bodies which are protected for reasons of public security, defence or national security; or

   (e) data the supply of which is an activity falling outside the scope of the public task of the public sector bodies concerned as defined by law or by other binding rules in the Member State concerned, or, in the absence of such rules, as defined in accordance with common administrative practice in that Member State, provided that the scope of the public tasks is transparent and subject to review.

3.   This Chapter is without prejudice to:

(a) Union and national law and international agreements to which the Union or Member States are party on the protection of categories of data referred to in paragraph 1; and

(b) Union and national law on access to documents.

### Article 4: Prohibition of exclusive arrangements

1.   Agreements or other practices pertaining to the re-use of data held by public sector bodies containing categories of data referred to in Article 3(1) which grant exclusive rights or which have as their objective or effect to grant such exclusive rights or to restrict the availability of data for re-use by entities other than the parties to such agreements or other practices shall be prohibited.

2.   By way of derogation from paragraph 1, an exclusive right to re-use data referred to in that paragraph may be granted to the extent necessary for the provision of a service or the supply of a product in the general interest that would not otherwise be possible.

3.   An exclusive right as referred to in paragraph 2 shall be granted through an administrative act or contractual arrangement in accordance with applicable Union or national law and in compliance with the principles of transparency, equal treatment and non-discrimination.

4.   The duration of an exclusive right to re-use data shall not exceed 12 months. Where a contract is concluded, the duration of the contract shall be the same as the duration of the exclusive right.

5.   The grant of an exclusive right pursuant to paragraphs 2, 3 and 4, including the reasons as to why it is necessary to grant such a right, shall be transparent and be made publicly available online, in a form that complies with relevant Union law on public procurement.

6.   Agreements or other practices falling within the scope of the prohibition referred to in paragraph 1 which do not meet the conditions laid down in paragraphs 2 and 3 and which were concluded before 23 June 2022 shall be terminated at the end of the applicable contract and in any event by 24 December 2024.

### Article 5: Conditions for re-use

1.   Public sector bodies which are competent under national law to grant or refuse access for the re-use of one or more of the categories of data referred to in Article 3(1) shall make publicly available the conditions for allowing such re-use and the procedure to request the re-use via the single information point referred to in Article 8. Where they grant or refuse access for re-use, they may be assisted by the competent bodies referred to in Article 7(1).

      Member States shall ensure that public sector bodies are equipped with the necessary resources to comply with this Article.

2.   Conditions for re-use shall be non-discriminatory, transparent, proportionate and objectively justified with regard to the categories of data and the purposes of re-use and the nature of the data for which re-use is allowed. Those conditions shall not be used to restrict competition.

3.   Public sector bodies shall, in accordance with Union and national law, ensure that the protected nature of data is preserved. They may provide for the following requirements:

   (a) to grant access for the re-use of data only where the public sector body or the competent body, following the request for re-use, has ensured that data has been:
   
      * (i) anonymised, in the case of personal data; and

      * (ii) modified, aggregated or treated by any other method of disclosure control, in the case of commercially confidential information, including trade secrets or content protected by intellectual property rights;

   (b) to access and re-use the data remotely within a secure processing environment that is provided or controlled by the public sector body;

   (c) to access and re-use the data within the physical premises in which the secure processing environment is located in accordance with high security standards, provided that remote access cannot be allowed without jeopardising the rights and interests of third parties.

4.   In the case of re-use allowed in accordance with paragraph 3, points (b) and (c), the public sector bodies shall impose conditions that preserve the integrity of the functioning of the technical systems of the secure processing environment used. The public sector body shall reserve the right to verify the process, the means and any results of processing of data undertaken by the re-user to preserve the integrity of the protection of the data and reserve the right to prohibit the use of results that contain information jeopardising the rights and interests of third parties. The decision to prohibit the use of the results shall be comprehensible and transparent to the re-user.

5.   Unless national law provides for specific safeguards on applicable confidentiality obligations relating to the re-use of data referred to in Article 3(1), the public sector body shall make the re-use of data provided in accordance with paragraph 3 of this Article conditional on the adherence by the re-user to a confidentiality obligation that prohibits the disclosure of any information that jeopardises the rights and interests of third parties that the re-user may have acquired despite the safeguards put in place. Re-users shall be prohibited from re-identifying any data subject to whom the data relates and shall take technical and operational measures to prevent re-identification and to notify any data breach resulting in the re-identification of the data subjects concerned to the public sector body. In the event of the unauthorised re-use of non-personal data, the re-user shall, without delay, where appropriate with the assistance of the public sector body, inform the legal persons whose rights and interests may be affected.

6.   Where the re-use of data cannot be allowed in accordance with the obligations laid down in paragraphs 3 and 4 of this Article and there is no legal basis for transmitting the data under Regulation (EU) 2016/679, the public sector body shall make best efforts, in accordance with Union and national law, to provide assistance to potential re-users in seeking consent of the data subjects or permission from the data holders whose rights and interests may be affected by such re-use, where it is feasible without a disproportionate burden on the public sector body. Where it provides such assistance, the public sector body may be assisted by the competent bodies referred to in Article 7(1).

7.   Re-use of data shall be allowed only in compliance with intellectual property rights. The right of the maker of a database as provided for in Article 7(1) of Directive 96/9/EC shall not be exercised by public sector bodies in order to prevent the re-use of data or to restrict re-use beyond the limits set by this Regulation.

8.   Where data requested is considered to be confidential, in accordance with Union or national law on commercial or statistical confidentiality, the public sector bodies shall ensure that the confidential data is not disclosed as a result of allowing re-use, unless such re-use is allowed in accordance with paragraph 6.

9.   Where a re-user intends to transfer non-personal data protected on the grounds set out in Article 3(1) to a third country, it shall inform the public sector body of its intention to transfer such data and the purpose of such transfer at the time of requesting the re-use of such data. In the case of re-use in accordance with paragraph 6 of this Article, the re-user shall, where appropriate with the assistance of the public sector body, inform the legal person whose rights and interests may be affected of that intention, purpose and the appropriate safeguards. The public sector body shall not allow the re-use unless the legal person gives permission for the transfer.

10.   Public sector bodies shall transmit non-personal confidential data or data protected by intellectual property rights to a re-user which intends to transfer those data to a third country other than a country designated in accordance with paragraph 12 only if the re-user contractually commits to:

   (a) complying with the obligations imposed in accordance with paragraphs 7 and 8 even after the data is transferred to the third country; and

   (b) accepting the jurisdiction of the courts or tribunals of the Member State of the transmitting public sector body with regard to any dispute related to compliance with paragraphs 7 and 8.

11.    Public sector bodies shall, where relevant and to the extent of their capabilities, provide guidance and assistance to re-users in complying with the obligations referred to in paragraph 10 of this Article.

   In order to assist public sector bodies and re-users, the Commission may adopt implementing acts establishing model contractual clauses for complying with the obligations referred to in paragraph 10 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 33(3).

12.   Where justified because of the substantial number of requests across the Union concerning the re-use of non-personal data in specific third countries, the Commission may adopt implementing acts declaring that the legal, supervisory and enforcement arrangements of a third country:

   (a) ensure protection of intellectual property and trade secrets in a way that is essentially equivalent to the protection ensured under Union law;

   (b) are being effectively applied and enforced; and

   (c) provide effective judicial redress.

   Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 33(3).

13.   Specific Union legislative acts may deem certain non-personal data categories held by public sector bodies to be highly sensitive for the purposes of this Article where their transfer to third countries may put at risk Union public policy objectives, such as safety and public health or may lead to the risk of re-identification of non-personal, anonymised data. Where such an act is adopted, the Commission shall adopt delegated acts in accordance with Article 32 supplementing this Regulation by laying down special conditions applicable to the transfers of such data to third countries.

   Those special conditions shall be based on the nature of the non-personal data categories identified in the specific Union legislative act and on the grounds for deeming those categories to be highly sensitive, taking into account the risks of re-identification of non-personal, anonymised data. They shall be non-discriminatory and limited to what is necessary to achieve the Union public policy objectives identified in that act, in accordance with the Union’s international obligations.

   If required by specific Union legislative acts as referred to in the first subparagraph, such special conditions may include terms applicable for the transfer or technical arrangements in this regard, limitations with regard to the re-use of data in third countries or categories of persons entitled to transfer such data to third countries or, in exceptional cases, restrictions with regard to transfers to third countries.

14.   The natural or legal person to which the right to re-use non-personal data was granted may transfer the data only to those third countries for which the requirements in paragraphs 10, 12 and 13 are met.

### Article 6: Fees

1.   Public sector bodies which allow re-use of the categories of data referred to in Article 3(1) may charge fees for allowing the re-use of such data.

2.   Any fees charged pursuant to paragraph 1 shall be transparent, non-discriminatory, proportionate and objectively justified and shall not restrict competition.

3.   Public sector bodies shall ensure that any fees can also be paid online through widely available cross-border payment services, without discrimination based on the place of establishment of the payment service provider, the place of issue of the payment instrument or the location of the payment account within the Union.

4.   Where public sector bodies charge fees, they shall take measures to provide incentives for the re-use of the categories of data referred to in Article 3(1) for non-commercial purposes, such as scientific research purposes, and by SMEs and start-ups in accordance with State aid rules. In that regard, public sector bodies may also make the data available at a discounted fee or free of charge, in particular to SMEs and start-ups, civil society and educational establishments. To that end, public sector bodies may establish a list of categories of re-users to which data for re-use is made available at a discounted fee or free of charge. That list, together with the criteria used to establish it, shall be made public.

5.   Any fees shall be derived from the costs related to conducting the procedure for requests for the re-use of the categories of data referred to in Article 3(1) and limited to the necessary costs in relation to:

   (a) the reproduction, provision and dissemination of data;

   (b) the clearance of rights;

   (c) anonymisation or other forms of preparation of personal data and commercially confidential data as provided for in Article 5(3);

   (d) the maintenance of the secure processing environment;

   (e) the acquisition of the right to allow re-use in accordance with this Chapter by third parties outside the public sector; and

   (f) assisting re-users in seeking consent from data subjects and permission from data holders whose rights and interests may be affected by such re-use.

6.   The criteria and methodology for calculating fees shall be laid down by the Member States and published. The public sector body shall publish a description of the main categories of costs and the rules used for the allocation of costs.

### Article 7: Competent bodies

1.   For the purpose of carrying out the tasks referred to in this Article, each Member State shall designate one or more competent bodies, which may be competent for particular sectors, to assist the public sector bodies which grant or refuse access for the re-use of the categories of data referred to in Article 3(1). Member States may either establish one or more new competent bodies or rely on existing public sector bodies or on internal services of public sector bodies that fulfil the conditions laid down in this Regulation.

2.   The competent bodies may be empowered to grant access for the re-use of the categories of data referred to in Article 3(1) pursuant to Union or national law which provides for such access to be granted. Where they grant or refuse access for the re-use, Articles 4, 5, 6 and 9 shall apply to those competent bodies.

3.   The competent bodies shall have adequate legal, financial, technical and human resources to carry out the tasks assigned to them, including the necessary technical knowledge to be able to comply with relevant Union or national law concerning the access regimes for the categories of data referred to in Article 3(1).

4.   The assistance provided for in paragraph 1 shall include, where necessary:

   (a) providing technical support by making available a secure processing environment for providing access for the re-use of data;

   (b) providing guidance and technical support on how to best structure and store data to make that data easily accessible;

   (c) providing technical support for pseudonymisation and ensuring data processing in a manner that effectively preserves the privacy, confidentiality, integrity and accessibility of the information contained in the data for which re-use is allowed, including techniques for the anonymisation, generalisation, suppression and randomisation of personal data or other state-of-the-art privacy-preserving methods, and the deletion of commercially confidential information, including trade secrets or content protected by intellectual property rights;

   (d) assisting the public sector bodies, where relevant, to provide support to re-users in requesting consent for re-use from data subjects or permission from data holders in line with their specific decisions, including on the jurisdiction in which the data processing is intended to take place and assisting the public sector bodies in establishing technical mechanisms that allow the transmission of requests for consent or permission from re-users, where practically feasible;

   (e) providing public sector bodies with assistance in assessing the adequacy of contractual commitments made by a re-user pursuant to Article 5(10).

5.   Each Member State shall notify the Commission of the identity of the competent bodies designated pursuant to paragraph 1 by 24 September 2023. Each Member State shall also notify the Commission of any subsequent change to the identity of those competent bodies.

### Article 8: Single information point

1.   Member States shall ensure that all relevant information concerning the application of Articles 5 and 6 is available and easily accessible through a single information point. Member States shall establish a new body or designate an existing body or structure as the single information point. The single information point may be linked to sectoral, regional or local information points. The functions of the single information point may be automated provided that the public sector body ensures adequate support.

2.   The single information point shall be competent to receive enquiries or requests for the re-use of the categories of data referred to in Article 3(1) and shall transmit them, where possible and appropriate by automated means, to the competent public sector bodies, or the competent bodies referred to in Article 7(1), where relevant. The single information point shall make available by electronic means a searchable asset list containing an overview of all available data resources including, where relevant, those data resources that are available at sectoral, regional or local information points, with relevant information describing the available data, including at least the data format and size and the conditions for their re-use.

3.   The single information point may establish a separate, simplified and well-documented information channel for SMEs and start-ups, addressing their needs and capabilities in requesting the re-use of the categories of data referred to in Article 3(1).

4.   The Commission shall establish a European single access point offering a searchable electronic register of data available in the national single information points and further information on how to request data via those national single information points.

### Article 9: Procedure for requests for re-use

1.   Unless shorter time limits have been established in accordance with national law, the competent public sector bodies or the competent bodies referred to in Article 7(1) shall adopt a decision on the request for the re-use of the categories of data referred to in Article 3(1) within two months of the date of receipt of the request.

In the case of exceptionally extensive and complex requests for re-use, that two-month period may be extended by up to 30 days. In such cases the competent public sector bodies or the competent bodies referred to in Article 7(1) shall notify the applicant as soon as possible that more time is needed for conducting the procedure, together with the reasons for the delay.

2.   Any natural or legal person directly affected by a decision as referred to in paragraph 1 shall have an effective right of redress in the Member State where the relevant body is located. Such a right of redress shall be laid down in national law and shall include the possibility of review by an impartial body with the appropriate expertise, such as the national competition authority, the relevant access-to-documents authority, the supervisory authority established in accordance with Regulation (EU) 2016/679 or a national judicial authority, whose decisions are binding upon the public sector body or the competent body concerned.

## CHAPTER III: REQUIREMENTS APPLICABLE TO DATA INTERMDIATION SERVICES
### Article 10: Data intermediation services

The provision of the following data intermediation services shall comply with Article 12 and shall be subject to a notification procedure:

(a) intermediation services between data holders and potential data users, including making available the technical or other means to enable such services; those services may include bilateral or multilateral exchanges of data or the creation of platforms or databases enabling the exchange or joint use of data, as well as the establishment of other specific infrastructure for the interconnection of data holders with data users;

(b) intermediation services between data subjects that seek to make their personal data available or natural persons that seek to make non-personal data available, and potential data users, including making available the technical or other means to enable such services, and in particular enabling the exercise of the data subjects’ rights provided in Regulation (EU) 2016/679;

(c) services of data cooperatives.

### Article 11: Notification by data intermediation services providers

1.   Any data intermediation services provider who intends to provide the data intermediation services referred to in Article 10 shall submit a notification to the competent authority for data intermediation services.

2.   For the purposes of this Regulation, a data intermediation services provider with establishments in more than one Member State shall be deemed to be under the jurisdiction of the Member State in which it has its main establishment, without prejudice to Union law regulating cross-border actions for damages and related proceedings.

3.   A data intermediation services provider that is not established in the Union, but which offers the data intermediation services referred to in Article 10 within the Union, shall designate a legal representative in one of the Member States in which those services are offered.

   For the purpose of ensuring compliance with this Regulation, the legal representative shall be mandated by the data intermediation services provider to be addressed in addition to or instead of it by competent authorities for data intermediation services or data subjects and data holders, with regard to all issues related to the data intermediation services provided. The legal representative shall cooperate with and comprehensively demonstrate to the competent authorities for data intermediation services, upon request, the actions taken and provisions put in place by the data intermediation services provider to ensure compliance with this Regulation.

   The data intermediation services provider shall be deemed to be under the jurisdiction of the Member State in which the legal representative is located. The designation of a legal representative by the data intermediation services provider shall be without prejudice to any legal actions which could be initiated against the data intermediation services provider.

4.   After having submitted a notification in accordance with paragraph 1, the data intermediation services provider may start the activity subject to the conditions laid down in this Chapter.

5.   The notification referred to in paragraph 1 shall entitle the data intermediation services provider to provide data intermediation services in all Member States.

6.   The notification referred to in paragraph 1 shall include the following information:

   (a) the name of the data intermediation services provider;

   (b) the data intermediation services provider’s legal status, form, ownership structure, relevant subsidiaries and, where the data intermediation services provider is registered in a trade or other similar public national register, registration number;

   (c)  the address of the data intermediation services provider’s main establishment in the Union, if any, and, where applicable, of any secondary branch in another Member State or that of the legal representative;

   (d) a public website where complete and up-to-date information on the data intermediation services provider and the activities can be found, including as a minimum the information referred to in points (a), (b), (c) and (f);

   (e) the data intermediation services provider’s contact persons and contact details;

   (f) a description of the data intermediation service the data intermediation services provider intends to provide, and an indication of the categories listed in Article 10 under which such data intermediation service falls;

   (g) the estimated date for starting the activity, if different from the date of the notification.

7.   The competent authority for data intermediation services shall ensure that the notification procedure is non-discriminatory and does not distort the competition.

8.   At the request of the data intermediation services provider, the competent authority for data intermediation services shall, within one week of a duly and fully completed notification, issue a standardised declaration, confirming that the data intermediation services provider has submitted the notification referred to in paragraph 1 and that the notification contains the information referred to in paragraph 6.

9.   At the request of the data intermediation services provider, the competent authority for data intermediation services shall confirm that the data intermediation services provider complies with this Article and Article 12. Upon receipt of such a confirmation, that data intermediation services provider may use the label ‘data intermediation services provider recognised in the Union’ in its written and spoken communication, as well as a common logo.

   In order to ensure that data intermediation services providers recognised in the Union are easily identifiable throughout the Union, the Commission shall, by means of implementing acts, establish a design for the common logo. Data intermediation services providers recognised in the Union shall display the common logo clearly on every online and offline publication that relates to their data intermediation activities.

   Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 33(2).

10.   The competent authority for data intermediation services shall notify the Commission of each new notification by electronic means without delay. The Commission shall keep and regularly update a public register of all data intermediation services providers providing their services in the Union. The information referred to in paragraph 6, points (a), (b), (c), (d), (f) and (g), shall be published in the public register.

11.   The competent authority for data intermediation services may charge fees for the notification in accordance with national law. Such fees shall be proportionate and objective and be based on the administrative costs related to the monitoring of compliance and other market control activities of the competent authority for data intermediation services in relation to notifications of data intermediation services providers. In the case of SMEs and start-ups, the competent authority for data intermediation services may charge a discounted fee or waive the fee.

12.   Data intermediation services providers shall notify the competent authority for data intermediation services of any changes to the information provided pursuant to paragraph 6 within 14 days of the date of the change.

13.   Where a data intermediation services provider ceases its activities, it shall notify the relevant competent authority for data intermediation services determined pursuant to paragraphs 1, 2 and 3 within 15 days.

14.   The competent authority for data intermediation services shall notify the Commission of each notification referred to in paragraphs 12 and 13 by electronic means without delay. The Commission shall update the public register of the data intermediation services providers in the Union accordingly.

### Article 12: Conditions for providing data intermediation services

The provision of data intermediation services referred in Article 10 shall be subject to the following conditions:

(a) the data intermediation services provider shall not use the data for which it provides data intermediation services for purposes other than to put them at the disposal of data users and shall provide data intermediation services through a separate legal person;

(b) the commercial terms, including pricing, for the provision of data intermediation services to a data holder or data user shall not be dependent upon whether the data holder or data user uses other services provided by the same data intermediation services provider or by a related entity, and if so to what degree the data holder or data user uses such other services;

(c) the data collected with respect to any activity of a natural or legal person for the purpose of the provision of the data intermediation service, including the date, time and geolocation data, duration of activity and connections to other natural or legal persons established by the person who uses the data intermediation service, shall be used only for the development of that data intermediation service, which may entail the use of data for the detection of fraud or cybersecurity, and shall be made available to the data holders upon request;

(d) the data intermediation services provider shall facilitate the exchange of the data in the format in which it receives it from a data subject or a data holder, shall convert the data into specific formats only to enhance interoperability within and across sectors or if requested by the data user or where mandated by Union law or to ensure harmonisation with international or European data standards and shall offer an opt-out possibility regarding those conversions to data subjects or data holders, unless the conversion is mandated by Union law;

(e) data intermediation services may include offering additional specific tools and services to data holders or data subjects for the specific purpose of facilitating the exchange of data, such as temporary storage, curation, conversion, anonymisation and pseudonymisation, such tools being used only at the explicit request or approval of the data holder or data subject and third-party tools offered in that context not being used for other purposes;

(f) the data intermediation services provider shall ensure that the procedure for access to its service is fair, transparent and non-discriminatory for both data subjects and data holders, as well as for data users, including with regard to prices and terms of service;

(g) the data intermediation services provider shall have procedures in place to prevent fraudulent or abusive practices in relation to parties seeking access through its data intermediation services;

(h) the data intermediation services provider shall, in the event of its insolvency, ensure a reasonable continuity of the provision of its data intermediation services and, where such data intermediation services ensure the storage of data, shall have mechanisms in place to allow data holders and data users to obtain access to, to transfer or to retrieve their data and, where such data intermediation services are provided between data subjects and data users, to allow data subjects to exercise their rights;

(i) the data intermediation services provider shall take appropriate measures to ensure interoperability with other data intermediation services, inter alia, by means of commonly used open standards in the sector in which the data intermediation services provider operates;

(j) the data intermediation services provider shall put in place adequate technical, legal and organisational measures in order to prevent the transfer of or access to non-personal data that is unlawful under Union law or the national law of the relevant Member State;

(k) the data intermediation services provider shall without delay inform data holders in the event of an unauthorised transfer, access or use of the non-personal data that it has shared;

(l) the data intermediation services provider shall take necessary measures to ensure an appropriate level of security for the storage, processing and transmission of non-personal data, and the data intermediation services provider shall further ensure the highest level of security for the storage and transmission of competitively sensitive information;

(m) the data intermediation services provider offering services to data subjects shall act in the data subjects’ best interest where it facilitates the exercise of their rights, in particular by informing and, where appropriate, advising data subjects in a concise, transparent, intelligible and easily accessible manner about intended data uses by data users and standard terms and conditions attached to such uses before data subjects give consent;

(n) where a data intermediation services provider provides tools for obtaining consent from data subjects or permissions to process data made available by data holders, it shall, where relevant, specify the third-country jurisdiction in which the data use is intended to take place and provide data subjects with tools to both give and withdraw consent and data holders with tools to both give and withdraw permissions to process data;

(o) the data intermediation services provider shall maintain a log record of the data intermediation activity.
### Article 13: Competent authorities for data intermediation services

1.   Each Member State shall designate one or more competent authorities to carry out the tasks related to the notification procedure for data intermediation services and shall notify the Commission of the identity of those competent authorities by 24 September 2023. Each Member State shall also notify the Commission of any subsequent change to the identity of those competent authorities.

2.   The competent authorities for data intermediation services shall comply with the requirements set out in Article 26.

3.   The powers of the competent authorities for data intermediation services are without prejudice to the powers of the data protection authorities, national competition authorities, authorities in charge of cybersecurity and other relevant sectoral authorities. In accordance with their respective competences under Union and national law, those authorities shall establish strong cooperation and exchange information as is necessary for the exercise of their tasks in relation to data intermediation services providers, and shall aim to achieve consistency in the decisions taken in applying this Regulation.

### Article 14: Monitoring of compliance

1.   The competent authorities for data intermediation services shall monitor and supervise compliance of data intermediation services providers with the requirements of this Chapter. The competent authorities for data intermediation services may also monitor and supervise the compliance of data intermediation services providers, on the basis of a request by a natural or legal person.

2.   The competent authorities for data intermediation services shall have the power to request from data intermediation services providers or their legal representatives all the information that is necessary to verify compliance with the requirements of this Chapter. Any request for information shall be proportionate to the performance of the task and shall be reasoned.

3.   Where the competent authority for data intermediation services finds that a data intermediation services provider does not comply with one or more of the requirements of this Chapter, it shall notify that data intermediation services provider of those findings and give it the opportunity to state its views, within 30 days of the receipt of the notification.

4.   The competent authority for data intermediation services shall have the power to require the cessation of the infringement referred to in paragraph 3 within a reasonable time limit or immediately in the case of a serious infringement and shall take appropriate and proportionate measures with the aim of ensuring compliance. In that regard, the competent authority for data intermediation services shall have the power, where appropriate:

   (a) to impose, through administrative procedures, dissuasive financial penalties, which may include periodic penalties and penalties with retroactive effect, to initiate legal proceedings for the imposition of fines, or both;

   (b) to require a postponement of the commencement or a suspension of the provision of the data intermediation service until any changes to the conditions requested by the competent authority for data intermediation services have been made; or

   (c) to require the cessation of the provision of the data intermediation service in the event that serious or repeated infringements have not been remedied despite prior notification in accordance with paragraph 3.

   The competent authority for data intermediation services shall request the Commission to remove the data intermediation services provider from the register of data intermediation services providers once it has ordered the cessation of the provision of the data intermediation service in accordance with the first subparagraph, point (c).

   If a data intermediation services provider remedies infringements, that data intermediation services provider shall re-notify the competent authority for data intermediation services. The competent authority for data intermediation services shall notify the Commission of each new re-notification.

5.   Where a data intermediation services provider that is not established in the Union fails to designate a legal representative or the legal representative fails, upon request of the competent authority for data intermediation services, to provide the necessary information that comprehensively demonstrates compliance with this Regulation, the competent authority for data intermediation services shall have the power to postpone the commencement of or to suspend the provision of the data intermediation service until the legal representative is designated or the necessary information is provided.

6.   The competent authorities for data intermediation services shall notify the data intermediation services provider concerned of the measures imposed pursuant to paragraphs 4 and 5 and the reasons on which they are based, as well as the necessary steps to be taken to rectify the relevant shortcomings, without delay, and shall stipulate a reasonable period, which shall not be longer than 30 days, for the data intermediation services provider to comply with those measures.

7.   If a data intermediation services provider has its main establishment or its legal representative in a Member State but provides services in other Member States, the competent authority for data intermediation services of the Member State of the main establishment or where the legal representative is located and the competent authorities for data intermediation services of those other Member States shall cooperate and assist each other. Such assistance and cooperation may cover information exchanges between the competent authorities for data intermediation services concerned for the purposes of their tasks under this Regulation and reasoned requests to take the measures referred to in this Article.

   Where a competent authority for data intermediation services in one Member State requests assistance from a competent authority for data intermediation services in another Member State, it shall submit a reasoned request. The competent authority for data intermediation services shall, upon such a request, provide a response without delay and within a timeframe proportionate to the urgency of the request.

   Any information exchanged in the context of assistance requested and provided under this paragraph shall be used only in respect of the matter for which it was requested.

### Article 15: Exceptions

This Chapter shall not apply to recognised data altruism organisations or other not-for-profit entities insofar as their activities consist of seeking to collect data for objectives of general interest, made available by natural or legal persons on the basis of data altruism, unless those organisations and entities aim to establish commercial relationships between an undetermined number of data subjects and data holders on the one hand and data users on the other.

## CHAPTER IV: DATA ALTRUISM

### Article 16: National arrangements for data altruism

Member States may have in place organisational or technical arrangements, or both, to facilitate data altruism. To that end, Member States may establish national policies for data altruism. Those national policies may, in particular, assist data subjects in making personal data related to them held by public sector bodies available voluntarily for data altruism, and set out the necessary information that is required to be provided to data subjects concerning the re-use of their data in the general interest.

If a Member State develops such national policies, it shall notify the Commission thereof.

### Article 17: Public registers of recognised data altruism organisations

1.   Each competent authority for the registration of data altruism organisations shall keep and regularly update a public national register of recognised data altruism organisations.

2.   The Commission shall maintain a public Union register of recognised data altruism organisations for information purposes. Provided that an entity is registered in the public national register of recognised data altruism organisations in accordance with Article 18, it may use the label ‘data altruism organisation recognised in the Union’ in its written and spoken communication, as well as a common logo.

   In order to ensure that recognised data altruism organisations are easily identifiable throughout the Union, the Commission shall, by means of implementing acts, establish a design for the common logo. Recognised data altruism organisations shall display the common logo clearly on every online and offline publication that relates to their data altruism activities. The common logo shall be accompanied by a QR code with a link to the public Union register of recognised data altruism organisations.

   Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 33(2).

### Article 18: General requirements for registration

In order to qualify for registration in a public national register of recognised data altruism organisations, an entity shall:

   (a) carry out data altruism activities;

   (b) be a legal person established pursuant to national law to meet objectives of general interest as provided for in national law, where applicable;

   (c) operate on a not-for-profit basis and be legally independent from any entity that operates on a for-profit basis;

   (d) carry out its data altruism activities through a structure that is functionally separate from its other activities;

   (e) comply with the rulebook referred to Article 22(1), at the latest 18 months after the date of entry into force of the delegated acts referred to in that paragraph.
### Article 19: Registration of recognised data altruism organisations

1.   An entity which meets the requirements of Article 18 may submit an application for registration in the public national register of recognised data altruism organisations in the Member State in which it is established.

2.   An entity which meets the requirements of Article 18 and has establishments in more than one Member State may submit an application for registration in the public national register of recognised data altruism organisations in the Member State in which it has its main establishment.

3.   An entity which meets the requirements of Article 18 but which is not established in the Union shall designate a legal representative in one of the Member States in which the data altruism services are offered.

   For the purpose of ensuring compliance with this Regulation, the legal representative shall be mandated by the entity to be addressed in addition to or instead of it by competent authorities for the registration of data altruism organisations or data subjects and data holders, with regard to all issues related to that entity. The legal representative shall cooperate with and comprehensively demonstrate to the competent authorities for the registration of data altruism organisations, upon request, the actions taken and provisions put in place by the entity to ensure compliance with this Regulation.

   The entity shall be deemed to be under the jurisdiction of the Member State in which the legal representative is located. Such an entity may submit an application for registration in the public national register of recognised data altruism organisations in that Member State. The designation of a legal representative by the entity shall be without prejudice to any legal actions which could be initiated against the entity.

4.   Applications for registration referred to in paragraphs 1, 2 and 3 shall contain the following information:

   (a) the name of the entity;

   (b) the entity’s legal status, form and, where the entity is registered in a public national register, registration number;

   (c) the statutes of the entity, where appropriate;

   (d) the entity’s sources of income;

   (e) the address of the entity’s main establishment in the Union, if any, and, where applicable, any secondary branch in another Member State or that of the legal representative;

   (f) a public website where complete and up-to-date information on the entity and the activities can be found, including as a minimum the information referred to in points (a), (b), (d), (e) and (h);

   (g) the entity’s contact persons and contact details;

   (h) the objectives of general interest it intends to promote when collecting data;

   (i) the nature of the data that the entity intends to control or process, and, in the case of personal data, an indication of the categories of personal data;

   (j) any other documents which demonstrate that the requirements of Article 18 are met.

5.   Where the entity has submitted all necessary information pursuant to paragraph 4 and after the competent authority for the registration of data altruism organisations has evaluated the application for registration and found that the entity complies with the requirements of Article 18, it shall register the entity in the public national register of recognised data altruism organisations within 12 weeks after the receipt of the application for registration. The registration shall be valid in all Member States.

   The competent authority for the registration of data altruism organisations shall notify the Commission of any registration. The Commission shall include that registration in the public Union register of recognised data altruism organisations.

6.   The information referred to in paragraph 4, points (a), (b), (f), (g) and (h), shall be published in the relevant public national register of recognised data altruism organisations.

7.   A recognised data altruism organisation shall notify the relevant competent authority for the registration of data altruism organisations of any changes to the information provided pursuant to paragraph 4 within 14 days of the date of the change.

   The competent authority for the registration of data altruism organisations shall notify the Commission of each such notification by electronic means without delay. Based on such a notification, the Commission shall update the public Union register of recognised data altruism organisations without delay.

### Article 20: Transparency requirements

1.   A recognised data altruism organisation shall keep full and accurate records concerning:

   (a) all natural or legal persons that were given the possibility to process data held by that recognised data altruism organisation, and their contact details;

   (b) the date or duration of the processing of personal data or use of non-personal data;

   (c) the purpose of the processing as declared by the natural or legal person that was given the possibility of processing;

   (d) the fees paid by natural or legal persons processing the data, if any.

2.   A recognised data altruism organisation shall draw up and transmit to the relevant competent authority for the registration of data altruism organisations an annual activity report which shall contain at least the following:

   (a) information on the activities of the recognised data altruism organisation;

   (b) a description of the way in which the objectives of general interest for which data was collected have been promoted during the given financial year;

   (c) a list of all natural and legal persons that were allowed to process data it holds, including a summary description of the objectives of general interest pursued by such data processing and the description of the technical means used for it, including a description of the techniques used to preserve privacy and data protection;

   (d) a summary of the results of the data processing allowed by the recognised data altruism organisation, where applicable;

   (e) information on sources of revenue of the recognised data altruism organisation, in particular all revenue from allowing access to the data, and on expenditure.

### Article 21: Specific requirements to safeguard rights and interests of data subjects and data holders with regard to their data

1.   A recognised data altruism organisation shall inform data subjects or data holders prior to any processing of their data in a clear and easily comprehensible manner of:

   (a) the objectives of general interest and, if applicable, the specified, explicit and legitimate purpose for which personal data is to be processed, and for which it permits the processing of their data by a data user;

   (b) the location of and the objectives of general interest for which it permits any processing carried out in a third country, where the processing is carried out by the recognised data altruism organisation.

2.   The recognised data altruism organisation shall not use the data for other objectives than those of general interest for which the data subject or data holder allows the processing. The recognised data altruism organisation shall not use misleading marketing practices to solicit the provision of data.

3.   The recognised data altruism organisation shall provide tools for obtaining consent from data subjects or permissions to process data made available by data holders. The recognised data altruism organisation shall also provide tools for easy withdrawal of such consent or permission.

4.   The recognised data altruism organisation shall take measures to ensure an appropriate level of security for the storage and processing of non-personal data that it has collected based on data altruism.

5.   The recognised data altruism organisation shall, without delay, inform data holders in the event of any unauthorised transfer, access or use of the non-personal data that it has shared.

6.   Where the recognised data altruism organisation facilitates data processing by third parties, including by providing tools for obtaining consent from data subjects or permissions to process data made available by data holders, it shall, where relevant, specify the third-country jurisdiction in which the data use is intended to take place.

### Article 22: Rulebook

1.   The Commission shall adopt delegated acts in accordance with Article 32, supplementing this Regulation by establishing a rulebook laying down:

   (a) appropriate information requirements to ensure that data subjects and data holders are provided, before a consent or permission for data altruism is given, with sufficiently detailed, clear and transparent information regarding the use of data, the tools for giving and withdrawing consent or permission, and the measures taken to avoid misuse of the data shared with the data altruism organisation;

   (b) appropriate technical and security requirements to ensure the appropriate level of security for the storage and processing of data, as well as for the tools for giving and withdrawing consent or permission;

   (c) communication roadmaps taking a multi-disciplinary approach to raise awareness of data altruism, of the designation as a ‘data altruism organisation recognised in the Union’ and of the rulebook among relevant stakeholders, in particular data holders and data subjects that would potentially share their data;

   (d) recommendations on relevant interoperability standards.

2.   The rulebook referred to in paragraph 1 shall be prepared in close cooperation with data altruism organisations and relevant stakeholders.

### Article 23: Competent authorities for the registration of data altruism organisations

1.   Each Member State shall designate one or more competent authorities responsible for its public national register of recognised data altruism organisations.

The competent authorities for the registration of data altruism organisations shall comply with the requirements set out in Article 26.

2.   Each Member State shall notify the Commission of the identity of their competent authorities for the registration of data altruism organisations by 24 September 2023. Each Member State shall also notify the Commission of any subsequent change to the identity of those competent authorities.

3.   The competent authority for the registration of data altruism organisations of a Member State shall undertake its tasks in cooperation with the relevant data protection authority, where such tasks are related to processing of personal data, and with relevant sectoral authorities of that Member State.

### Article 24: Monitoring of compliance

1.   The competent authorities for the registration of data altruism organisations shall monitor and supervise compliance of recognised data altruism organisations with the requirements laid down in this Chapter. The competent authority for the registration of data altruism organisations may also monitor and supervise the compliance of such recognised data altruism organisations, on the basis of a request by a natural or legal person.

2.   The competent authorities for the registration of data altruism organisations shall have the power to request information from recognised data altruism organisations that is necessary to verify compliance with the requirements of this Chapter. Any request for information shall be proportionate to the performance of the task and shall be reasoned.

3.   Where the competent authority for the registration of data altruism organisations finds that a recognised data altruism organisation does not comply with one or more of the requirements of this Chapter, it shall notify the recognised data altruism organisation of those findings and give it the opportunity to state its views within 30 days of the receipt of the notification.

4.   The competent authority for the registration of data altruism organisations shall have the power to require the cessation of the infringement referred to in paragraph 3 either immediately or within a reasonable time limit and shall take appropriate and proportionate measures with the aim of ensuring compliance.

5.   If a recognised data altruism organisation does not comply with one or more of the requirements of this Chapter even after having been notified in accordance with paragraph 3 by the competent authority for the registration of data altruism organisations, that recognised data altruism organisation shall:

   (a) lose its right to use the label ‘data altruism organisation recognised in the Union’ in any written and spoken communication;

   (b) be removed from the relevant public national register of recognised data altruism organisations and the public Union register of recognised data altruism organisations.

   Any decision revoking the right to use the label ‘data altruism organisation recognised in the Union’ under the first subparagraph, point (a), shall be made public by the competent authority for the registration of data altruism organisations.

6.   If a recognised data altruism organisation has its main establishment or its legal representative in a Member State but is active in other Member States, the competent authority for the registration of data altruism organisations of the Member State of the main establishment or where the legal representative is located and the competent authorities for the registration of data altruism organisations of those other Member States shall cooperate and assist each other. Such assistance and cooperation may cover information exchanges between the competent authorities for the registration of data altruism organisations concerned for the purposes of their tasks under this Regulation and reasoned requests to take the measures referred to in this Article.

   Where a competent authority for the registration of data altruism organisations in one Member State requests assistance from a competent authority for the registration of data altruism organisations in another Member State, it shall submit a reasoned request. The competent authority for the registration of data altruism organisations shall, upon such a request, provide a response without delay and within a timeframe proportionate to the urgency of the request.

   Any information exchanged in the context of assistance requested and provided under this paragraph shall be used only in respect of the matter for which it was requested.

### Article 25: European data altruism consent form

1.   In order to facilitate the collection of data based on data altruism, the Commission shall adopt implementing acts establishing and developing a European data altruism consent form, after consulting the European Data Protection Board, taking into account the advice of the European Data Innovation Board and duly involving relevant stakeholders. The form shall allow the collection of consent or permission across Member States in a uniform format. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 33(2).

2.   The European data altruism consent form shall use a modular approach allowing customisation for specific sectors and for different purposes.

3.   Where personal data are provided, the European data altruism consent form shall ensure that data subjects are able to give consent to and withdraw consent from a specific data processing operation in compliance with the requirements of Regulation (EU) 2016/679.

4.   The form shall be available in a manner that can be printed on paper and is easily understandable as well as in an electronic, machine-readable form.
## CHAPTER V: COMPETENT AUTHORITIES AND PROCEDURAL PROVISIONS 
### Article 26: Requirements relating to competent authorities

1.   The competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations shall be legally distinct from, and functionally independent of, any data intermediation services provider or recognised data altruism organisation. The functions of the competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations may be carried out by the same authority. Member States may either establish one or more new authorities for those purposes or rely on existing ones.

2.   Competent authorities for data intermediation services and competent authorities for the registration of data altruism organisations shall exercise their tasks in an impartial, transparent, consistent, reliable and timely manner. Where they exercise their tasks, they shall safeguard fair competition and non-discrimination.

3.   The top-level management and personnel responsible for carrying out the relevant tasks of the competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations shall not be the designer, manufacturer, supplier, installer, purchaser, owner, user or maintainer of the services which they evaluate, nor the authorised representative of any of those parties. This shall not preclude the use of evaluated services that are necessary for the operations of the competent authority for data intermediation services and the competent authority for the registration of data altruism organisations or the use of such services for personal purposes.

4.   The top-level management and personnel of the competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations shall not engage in any activity that may conflict with their independence of judgment or integrity in relation to evaluation activities assigned to them.

5.   The competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations shall have at their disposal the adequate financial and human resources to carry out the tasks assigned to them, including the necessary technical knowledge and resources.

6.   The competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations of a Member State shall provide the Commission and competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations from other Member States, on reasoned request and without delay, with the information necessary to carry out their tasks under this Regulation. Where a competent authority for data intermediation services or a competent authority for the registration of data altruism organisations considers the information requested to be confidential in accordance with Union and national law on commercial and professional confidentiality, the Commission and any other competent authorities for data intermediation services or competent authorities for the registration of data altruism organisations concerned shall ensure such confidentiality.

### Article 27: Right to lodge a complaint

1.   Natural and legal persons shall have the right to lodge a complaint in relation to any matter falling within the scope of this Regulation, individually or, where relevant, collectively, with the relevant competent authority for data intermediation services against a data intermediation services provider or with the relevant competent authority for the registration of data altruism organisations against a recognised data altruism organisation.

2.   The competent authority for data intermediation services or the competent authority for the registration of data altruism organisations with which the complaint has been lodged shall inform the complainant of:

   (a) the progress of the proceedings and of the decision taken; and

   (b) the judicial remedies provided for in Article 28.
### Article 28: Right to an effective judicial remedy

1.   Notwithstanding any administrative or other non-judicial remedies, any affected natural and legal persons shall have the right to an effective judicial remedy with regard to legally binding decisions referred to in Article 14 taken by the competent authorities for data intermediation services in the management, control and enforcement of the notification regime for data intermediation services providers and legally binding decisions referred to in Articles 19 and 24 taken by the competent authorities for the registration of data altruism organisations in the monitoring of recognised data altruism organisations.

2.   Proceedings pursuant to this Article shall be brought before the courts or tribunals of the Member State of the competent authority for data intermediation services or the competent authority for the registration of data altruism organisations against which the judicial remedy is sought individually or, where relevant, collectively by the representatives of one or more natural or legal persons.

3.   Where a competent authority for data intermediation services or a competent authority for the registration of data altruism organisations fails to act on a complaint, any affected natural and legal persons shall, in accordance with national law, either have the right to an effective judicial remedy or access to review by an impartial body with the appropriate expertise.

## CHAPTER VI: EUROPEAN DATA INNOVATION BOARD

### Article 29: European Data Innovation Board

1.   The Commission shall establish a European Data Innovation Board in the form of an expert group, consisting of representatives of the competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations of all Member States, the European Data Protection Board, the European Data Protection Supervisor, ENISA, the Commission, the EU SME Envoy or a representative appointed by the network of SME envoys, and other representatives of relevant bodies in specific sectors as well as bodies with specific expertise. In its appointments of individual experts, the Commission shall aim to achieve gender and geographical balance among the members of the expert group.

2.   The European Data Innovation Board shall consist of at least the following three subgroups:

   (a) a subgroup composed of the competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations, with a view to carrying out the tasks pursuant to Article 30, points (a), (c), (j) and (k);

   (b) a subgroup for technical discussions on standardisation, portability and interoperability pursuant to Article 30, points (f) and (g);

   (c) a subgroup for stakeholder involvement composed of relevant representatives from industry, research, academia, civil society, standardisation organisations, relevant common European data spaces and other relevant stakeholders and third parties advising the European Data Innovation Board on tasks pursuant to Article 30, points (d), (e), (f), (g) and (h).

3.   The Commission shall chair the meetings of the European Data Innovation Board.

4.   The European Data Innovation Board shall be assisted by a secretariat provided by the Commission.

### Article 30: Tasks of the European Data Innovation Board

The European Data Innovation Board shall have the following tasks:

   (a) to advise and assist the Commission with regard to developing a consistent practice of public sector bodies and competent bodies referred to in Article 7(1) in handling requests for the re-use of the categories of data referred to in Article 3(1);

   (b) to advise and assist the Commission with regard to developing a consistent practice for data altruism across the Union;

   (c) to advise and assist the Commission with regard to developing a consistent practice of the competent authorities for data intermediation services and the competent authorities for the registration of data altruism organisations in the application of requirements applicable to data intermediation services providers and recognised data altruism organisations;

   (d) to advise and assist the Commission with regard to developing consistent guidelines on how to best protect, in the context of this Regulation, commercially sensitive non-personal data, in particular trade secrets, but also non-personal data representing content protected by intellectual property rights from unlawful access that risks intellectual property theft or industrial espionage;

   (e) to advise and assist the Commission with regard to developing consistent guidelines for cybersecurity requirements for the exchange and storage of data;

   (f) to advise the Commission, in particular taking into account the input from standardisation organisations, on the prioritisation of cross-sector standards to be used and developed for data use and cross-sector data sharing between emerging common European data spaces, cross-sectoral comparison and exchange of best practices with regard to sectoral requirements for security and access procedures, taking into account sector-specific standardisation activities, in particular clarifying and distinguishing which standards and practices are cross-sectoral and which are sectoral;

   (g) to assist the Commission, in particular taking into account the input from standardisation organisations, in addressing fragmentation of the internal market and the data economy in the internal market by enhancing cross-border, cross-sector interoperability of data as well as data sharing services between different sectors and domains, building on existing European, international or national standards, inter alia with the aim of encouraging the creation of common European data spaces;

   (h) to propose guidelines for common European data spaces, namely purpose- or sector-specific or cross-sectoral interoperable frameworks of common standards and practices to share or jointly process data for, inter alia, the development of new products and services, scientific research or civil society initiatives, such common standards and practices taking into account existing standards, complying with the competition rules and ensuring non-discriminatory access to all participants, for the purpose of facilitating data sharing in the Union and reaping the potential of existing and future data spaces, addressing, inter alia:

   * (i) cross-sectoral standards to be used and developed for data use and cross-sector data sharing, cross-sectoral comparison and exchange of best practices with regard to sectoral requirements for security and access procedures, taking into account sector-specific standardisation activities, in particular clarifying and distinguishing which standards and practices are cross-sectoral and which are sectoral;

   * (ii) requirements to counter barriers to market entry and to avoid lock-in effects, for the purpose of ensuring fair competition and interoperability;

   * (iii) adequate protection for lawful data transfers to third countries, including safeguards against any transfers prohibited by Union law;

   * (iv) adequate and non-discriminatory representation of relevant stakeholders in the governance of common European data spaces;

   * (v) adherence to cybersecurity requirements in accordance with Union law;


   (i) to facilitate cooperation between Member States with regard to setting harmonised conditions allowing for the re-use of the categories of data referred to in Article 3(1) held by public sector bodies across the internal market;

   (j) to facilitate cooperation between competent authorities for data intermediation services and competent authorities for the registration of data altruism organisations through capacity-building and the exchange of information, in particular by establishing methods for the efficient exchange of information relating to the notification procedure for data intermediation services providers and the registration and monitoring of recognised data altruism organisations, including coordination with regard to the setting of fees or penalties, as well as facilitate cooperation between competent authorities for data intermediation services and competent authorities for the registration of data altruism organisations with regard to international access and transfer of data;

   (k) to advise and assist the Commission with regard to evaluating whether the implementing acts referred to in Article 5(11) and (12) are to be adopted;

   (l) to advise and assist the Commission with regard to developing the European data altruism consent form in accordance with Article 25(1);

   (m) to advise the Commission on improving the international regulatory environment for non-personal data, including standardisation.


## CHAPTER VII: INTERNATIONAL ACCESS AND TRANSFER
### Article 31: International access and transfer

1.   The public sector body, the natural or legal person to which the right to re-use data was granted under Chapter II, the data intermediation services provider or the recognised data altruism organisation shall take all reasonable technical, legal and organisational measures, including contractual arrangements, in order to prevent international transfer or governmental access to non-personal data held in the Union where such transfer or access would create a conflict with Union law or the national law of the relevant Member State, without prejudice to paragraph 2 or 3.

2.   Any decision or judgment of a third-country court or tribunal and any decision of a third-country administrative authority requiring a public sector body, a natural or legal person to which the right to re-use data was granted under Chapter II, a data intermediation services provider or recognised data altruism organisation to transfer or give access to non-personal data within the scope of this Regulation held in the Union shall be recognised or enforceable in any manner only if based on an international agreement, such as a mutual legal assistance treaty, in force between the requesting third country and the Union or any such agreement between the requesting third country and a Member State.

3.   In the absence of an international agreement as referred to in paragraph 2 of this Article, where a public sector body, a natural or legal person to which the right to re-use data was granted under Chapter II, a data intermediation services provider or recognised data altruism organisation is the addressee of a decision or judgment of a third-country court or tribunal or a decision of a third-country administrative authority to transfer or give access to non-personal data within the scope of this Regulation held in the Union and compliance with such a decision would risk putting the addressee in conflict with Union law or with the national law of the relevant Member State, transfer to or access to such data by that third-country authority shall take place only where:

   (a) the third-country system requires the reasons and proportionality of such a decision or judgment to be set out and requires such a decision or judgment to be specific in character, for instance by establishing a sufficient link to certain suspected persons or infringements;

   (b) the reasoned objection of the addressee is subject to a review by a competent third-country court or tribunal; and

   (c) the competent third-country court or tribunal issuing the decision or judgment or reviewing the decision of an administrative authority is empowered under the law of that third country to take duly into account the relevant legal interests of the provider of the data protected under Union law or the national law of the relevant Member State.

4.   If the conditions laid down in paragraph 2 or 3 are met, the public sector body, the natural or legal person to which the right to re-use data was granted under Chapter II, the data intermediation services provider or the recognised data altruism organisation shall provide the minimum amount of data permissible in response to a request, based on a reasonable interpretation of the request.

5.   The public sector body, the natural or legal person to which the right to re-use data was granted under Chapter II, the data intermediation services provider and the recognised data altruism organisation shall inform the data holder about the existence of a request of a third-country administrative authority to access its data before complying with that request, except where the request serves law enforcement purposes and for as long as this is necessary to preserve the effectiveness of the law enforcement activity.

## CHAPTER VII: DELEGATION AND COMMITTEE PROCEDURE

### Article 32: Exercise of the delegation

1.   The power to adopt delegated acts is conferred on the Commission subject to the conditions laid down in this Article.

2.   The power to adopt delegated acts referred to in Article 5(13) and Article 22(1) shall be conferred on the Commission for an indeterminate period of time from 23 June 2022.

3.   The delegation of power referred to in Article 5(13) and Article 22(1) may be revoked at any time by the European Parliament or by the Council. A decision to revoke shall put an end to the delegation of the power specified in that decision. It shall take effect the day following the publication of the decision in the Official Journal of the European Union or at a later date specified therein. It shall not affect the validity of any delegated acts already in force.

4.   Before adopting a delegated act, the Commission shall consult experts designated by each Member State in accordance with the principles laid down in the Interinstitutional Agreement of 13 April 2016 on Better Law-Making.

5.   As soon as it adopts a delegated act, the Commission shall notify it simultaneously to the European Parliament and to the Council.

6.   A delegated act adopted pursuant to Article 5(13) or Article 22(1) shall enter into force only if no objection has been expressed either by the European Parliament or by the Council within a period of three months of notification of that act to the European Parliament and to the Council or if, before the expiry of that period, the European Parliament and the Council have both informed the Commission that they will not object. That period shall be extended by three months at the initiative of the European Parliament or of the Council.

### Article 33: Committee procedure

1.   The Commission shall be assisted by a committee. That committee shall be a committee within the meaning of Regulation (EU) No 182/2011.

2.   Where reference is made to this paragraph, Article 4 of Regulation (EU) No 182/2011 shall apply.

3.   Where reference is made to this paragraph, Article 5 of Regulation (EU) No 182/2011 shall apply.

## CHAPTER IX: Final and transitional provisions
### Article 34: Penalties

1.   Member States shall lay down the rules on penalties applicable to infringements of the obligations regarding transfers of non-personal data to third countries pursuant to Article 5(14) and Article 31, the notification obligation of data intermediation services providers pursuant to Article 11, the conditions for providing data intermediation services pursuant to Article 12 and the conditions for the registration as a recognised data altruism organisation pursuant to Articles 18, 20, 21 and 22, and shall take all measures necessary to ensure that they are implemented. The penalties provided for shall be effective, proportionate and dissuasive. In their rules on penalties, Member States shall take into account the recommendations of the European Data Innovation Board. Member States shall, by 24 September 2023, notify the Commission of those rules and of those measures and shall notify it, without delay, of any subsequent amendment affecting them.

2.   Member States shall take into account the following non-exhaustive and indicative criteria for the imposition of penalties on data intermediation services providers and recognised data altruism organisations for infringements of this Regulation, where appropriate:

   (a) the nature, gravity, scale and duration of the infringement;

   (b) any action taken by the data intermediation services provider or recognised data altruism organisation to mitigate or remedy the damage caused by the infringement;

   (c) any previous infringements by the data intermediation services provider or recognised data altruism organisation;

   (d) the financial benefits gained or losses avoided by the data intermediation services provider or recognised data altruism organisation due to the infringement, insofar as such benefits or losses can be reliably established;

   (e) any other aggravating or mitigating factors applicable to the circumstances of the case.

### Article 35: Evaluation and review

By 24 September 2025, the Commission shall carry out an evaluation of this Regulation and submit a report on its main findings to the European Parliament and to the Council as well as to the European Economic and Social Committee. The report shall be accompanied, where necessary, by legislative proposals.

   The report shall assess, in particular:

   (a) the application and functioning of the rules on penalties laid down by the Member States pursuant to Article 34;

   (b) the level of compliance of the legal representatives of data intermediation services providers and recognised data altruism organisations that are not established in the Union with this Regulation and the level of enforceability of penalties imposed on those providers and organisations;

   (c) the type of data altruism organisations registered under Chapter IV and an overview of the objectives of general interests for which data are shared in view of establishing clear criteria in that respect.

   Member States shall provide the Commission with the information necessary for the preparation of that report.

### Article 36: Amendment to Regulation (EU) 2018/1724

In the table in Annex II to Regulation (EU) 2018/1724, the entry ‘Starting, running and closing a business’ is replaced by the following:
![](reg-eu-dga-article-36.png)

### Article 37: Transitional arrangements

Entities providing the data intermediation services referred to in Article 10 on 23 June 2022 shall comply with the obligations set out in Chapter III by 24 September 2025.

### Article 38: Entry into force and application

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

It shall apply from 24 September 2023.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels,
For the European Parliament For the Council

---

# European Digital ID Framework
Source: https://docs.igrant.io/regulations/reg-eu-digital-id-framework/

---
id: reg-eu-digital-id-framework
title: European Digital ID Framework
description: Explore how the EU Digital ID Framework supports trusted digital identities and wallets, enabling secure cross‑border online services in Europe.
sidebar_label: European Digital ID Framework (eIDAS)
keywords: [European Digital Identity, eIDAS 2.0, EUDI Wallet, digital identity framework, cross-border, trust services, EU regulation]
slug: /reg-eu-digital-id-framework/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
    <title>Dive into the EU Digital ID Framework with iGrant.io | iGrant.io DevDocs</title>
    <meta name="description" content="Explore how the EU Digital ID Framework supports trusted digital identities and wallets, enabling secure cross‑border online services in Europe."/>
</head>

REGULATION (EU) No 910/2014 OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL on electronic identification and trust services for electronic transactions in the internal market and repealing Directive 1999/93/EC. For direct access to the published legal document of the amendments, [visit here](https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=OJ:L_202401183#d1e739-1-1).

REGULATION (EU) 2024/1183 amends the existing [REGULATION (EU) No 910/2014](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A32014R0910) of the European Parliament and of the Council, dated 23 July 2014, which focuses on electronic identification and trust services for electronic transactions in the internal market and repeals Directive 1999/93/EC. This resource offers a selection of indexed articles that analyse and explain the amendments, linking each to the original regulatory texts for detailed understanding.

The below articles include the amended version, i.e. eIDAS 2.0.

## CHAPTER I - GENERAL PROVISIONS

### Article 1 - Subject matter

This Regulation aims to ensure the proper functioning of the internal market and the provision of an adequate level of security of electronic identification means and trust services used across the Union, in order to enable and facilitate the exercise by natural and legal persons of the right to participate in digital society safely and to access online public and private services throughout the Union. For those purposes, this Regulation:

(a) lays down the conditions under which Member States are to recognise natural and legal persons’ electronic identification means falling under a notified electronic identification scheme of another Member State and provide and recognise European Digital Identity Wallets;

(b) lays down rules for trust services, in particular for electronic transactions;

(c) establishes a legal framework for electronic signatures, electronic seals, electronic time stamps, electronic documents, electronic registered delivery services, certificate services for website authentication, electronic archiving, electronic attestation of attributes, electronic signature creation devices, electronic seal creation devices, and electronic ledgers.’;


### Article 2 - Scope

1.   This Regulation applies to electronic identification schemes notified by a Member State, to European Digital Identity Wallets provided by a Member State and to trust service providers established in the Union.’;

2.   This Regulation does not apply to the provision of trust services that are used exclusively within closed systems resulting from national law or from agreements between a defined set of participants.

3.   This Regulation does not affect Union or national law related to the conclusion and validity of contracts, other legal or procedural obligations relating to form, or sector-specific requirements relating to form.

4.   This Regulation is without prejudice to Regulation (EU) 2016/679 of the European Parliament and of the Council (see note below).

:::note

_Regulation (EU) 2016/679 of the European Parliament and of the Council of 27 April 2016on the protection of natural persons with regard to the processing of personal data and on the free movement of such data, and repealing Directive 95/46/EC (General Data Protection Regulation) (OJ L 119, 4.5.2016, p. 1)_

:::

### Article 3 - Definitions

For the purposes of this Regulation, the following definitions apply:

(1) “electronic identification” means the process of using person identification data in electronic form uniquely representing either a natural or legal person, or a natural person representing another natural person or a legal person;

(2) “electronic identification means” means a material and/or immaterial unit containing person identification data and which is used for authentication for an online service or, where appropriate, for an offline service;

(3) “person identification data” means a set of data that is issued in accordance with Union or national law and that enables the establishment of the identity of a natural or legal person, or of a natural person representing another natural person or a legal person.

(4) “electronic identification scheme” means a system for electronic identification under which electronic identification means are issued to natural or legal persons or natural persons representing other natural persons or legal persons;

(5) “authentication” means an electronic process that enables the confirmation of the electronic identification of a natural or legal person or the confirmation of the origin and integrity of data in electronic form;
	
(5a) “user” means a natural or legal person, or a natural person representing another natural person or a legal person, that uses trust services or electronic identification means provided in accordance with this Regulation;

(6) “relying party” means a natural or legal person that relies upon electronic identification, European Digital Identity Wallets or other electronic identification means, or upon a trust service;’;

(7) ‘public sector body’ means a state, regional or local authority, a body governed by public law or an association formed by one or several such authorities or one or several such bodies governed by public law, or a private entity mandated by at least one of those authorities, bodies or associations to provide public services, when acting under such a mandate;

(8) ‘body governed by public law’ means a body defined in point (4) of Article 2(1) of Directive 2014/24/EU of the European Parliament and of the Council (15);

(9) ‘signatory’ means a natural person who creates an electronic signature;

(10) ‘electronic signature’ means data in electronic form which is attached to or logically associated with other data in electronic form and which is used by the signatory to sign;

(11) ‘advanced electronic signature’ means an electronic signature which meets the requirements set out in Article 26;

(12) ‘qualified electronic signature’ means an advanced electronic signature that is created by a qualified electronic signature creation device, and which is based on a qualified certificate for electronic signatures;

(13) ‘electronic signature creation data’ means unique data which is used by the signatory to create an electronic signature;

(14) ‘certificate for electronic signature’ means an electronic attestation which links electronic signature validation data to a natural person and confirms at least the name or the pseudonym of that person;

(15) ‘qualified certificate for electronic signature’ means a certificate for electronic signatures, that is issued by a qualified trust service provider and meets the requirements laid down in Annex I;

(16)    “trust service” means an electronic service normally provided for remuneration which consists of any of the following:

   (16a) the issuance of certificates for electronic signatures, certificates for electronic seals, certificates for website authentication or certificates for the provision of other trust services;

   (16b) the validation of certificates for electronic signatures, certificates for electronic seals, certificates for website authentication or certificates for the provision of other trust services;

   (16c) the creation of electronic signatures or electronic seals;

   (16d) the validation of electronic signatures or electronic seals;

   (16e) the preservation of electronic signatures, electronic seals, certificates for electronic signatures or certificates for electronic seals;

   (16f) the management of remote electronic signature creation devices or remote electronic seal creation devices;

   (16g) the issuance of electronic attestations of attributes;

   (16h) the validation of electronic attestation of attributes;

   (16i) the creation of electronic timestamps;

   (16j) the validation of electronic timestamps;

   (16k) the provision of electronic registered delivery services;

   (16l) the validation of data transmitted through electronic registered delivery services and related evidence;

   (16m) the electronic archiving of electronic data and electronic documents;

   (16n) the recording of electronic data in an electronic ledger;’

(17) ‘qualified trust service’ means a trust service that meets the applicable requirements laid down in this Regulation;

(18) “conformity assessment body” means a conformity assessment body as defined in Article 2, point 13, of Regulation (EC) No 765/2008, which is accredited in accordance with that Regulation as competent to carry out conformity assessment of a qualified trust service provider and the qualified trust services it provides, or as competent to carry out certification of European Digital Identity Wallets or electronic identification means;

(19) ‘trust service provider’ means a natural or a legal person who provides one or more trust services either as a qualified or as a non-qualified trust service provider;

(20) ‘qualified trust service provider’ means a trust service provider who provides one or more qualified trust services and is granted the qualified status by the supervisory body;

(21) “product” means hardware or software, or relevant components of hardware or software, which are intended to be used for the provision of electronic identification and trust services;

(22) ‘electronic signature creation device’ means configured software or hardware used to create an electronic signature;

(23) ‘qualified electronic signature creation device’ means an electronic signature creation device that meets the requirements laid down in Annex II;

(23a) “remote qualified electronic signature creation device” means a qualified electronic signature creation device that is managed by a qualified trust service provider in accordance with Article 29a on behalf of a signatory;

(23b) “remote qualified electronic seal creation device” means a qualified electronic seal creation device that is managed by a qualified trust service provider in accordance with Article 39a on behalf of a seal creator;

(24) ‘creator of a seal’ means a legal person who creates an electronic seal;

(25) ‘electronic seal’ means data in electronic form, which is attached to or logically associated with other data in electronic form to ensure the latter’s origin and integrity;

(26) ‘advanced electronic seal’ means an electronic seal, which meets the requirements set out in Article 36;

(27) ‘qualified electronic seal’ means an advanced electronic seal, which is created by a qualified electronic seal creation device, and that is based on a qualified certificate for electronic seal;

(28) ‘electronic seal creation data’ means unique data, which is used by the creator of the electronic seal to create an electronic seal;

(29) ‘certificate for electronic seal’ means an electronic attestation that links electronic seal validation data to a legal person and confirms the name of that person;

(30) ‘qualified certificate for electronic seal’ means a certificate for an electronic seal, that is issued by a qualified trust service provider and meets the requirements laid down in Annex III;

(31) ‘electronic seal creation device’ means configured software or hardware used to create an electronic seal;

(32) ‘qualified electronic seal creation device’ means an electronic seal creation device that meets mutatis mutandis the requirements laid down in Annex II;

(33) ‘electronic time stamp’ means data in electronic form which binds other data in electronic form to a particular time establishing evidence that the latter data existed at that time;

(34) ‘qualified electronic time stamp’ means an electronic time stamp which meets the requirements laid down in Article 42;

(35) ‘electronic document’ means any content stored in electronic form, in particular text or sound, visual or audiovisual recording;

(36) ‘electronic registered delivery service’ means a service that makes it possible to transmit data between third parties by electronic means and provides evidence relating to the handling of the transmitted data, including proof of sending and receiving the data, and that protects transmitted data against the risk of loss, theft, damage or any unauthorised alterations;

(37) ‘qualified electronic registered delivery service’ means an electronic registered delivery service which meets the requirements laid down in Article 44;

(38) “certificate for website authentication” means an electronic attestation that makes it possible to authenticate a website and links the website to the natural or legal person to whom the certificate is issued;

(39) ‘qualified certificate for website authentication’ means a certificate for website authentication, which is issued by a qualified trust service provider and meets the requirements laid down in Annex IV;

(40) ‘validation data’ means data that is used to validate an electronic signature or an electronic seal;

(41) “validation” means the process of verifying and confirming that data in electronic form are valid in accordance with this Regulation;

(42) “European Digital Identity Wallet” means an electronic identification means which allows the user to securely store, manage and validate person identification data and electronic attestations of attributes for the purpose of providing them to relying parties and other users of European Digital Identity Wallets, and to sign by means of qualified electronic signatures or to seal by means of qualified electronic seals;

(43) “attribute” means a characteristic, quality, right or permission of a natural or legal person or of an object;

(44) “electronic attestation of attributes” means an attestation in electronic form that allows attributes to be authenticated;

(45) “qualified electronic attestation of attributes” means an electronic attestation of attributes which is issued by a qualified trust service provider and meets the requirements laid down in Annex V;

(46) “electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source” means an electronic attestation of attributes issued by a public sector body that is responsible for an authentic source or by a public sector body that is designated by the Member State to issue such attestations of attributes on behalf of the public sector bodies responsible for authentic sources in accordance with Article 45f and with Annex VII;

(47) “authentic source” means a repository or system, held under the responsibility of a public sector body or private entity, that contains and provides attributes about a natural or legal person or object and that is considered to be a primary source of that information or recognised as authentic in accordance with Union or national law, including administrative practice;

(48) “electronic archiving” means a service ensuring the receipt, storage, retrieval and deletion of electronic data and electronic documents in order to ensure their durability and legibility as well as to preserve their integrity, confidentiality and proof of origin throughout the preservation period;

(49) “qualified electronic archiving service” means an electronic archiving service which is provided by a qualified trust service provider and which meets the requirements laid down in Article 45j;

(50) “EU Digital Identity Wallet Trust Mark” means a verifiable, simple and recognisable indication which is communicated in a clear manner that a European Digital Identity Wallet has been provided in accordance with this Regulation;

(51) “strong user authentication” means an authentication based on the use of at least two authentication factors from different categories of either knowledge, something only the user knows, possession, something only the user possesses or inherence, something the user is, that are independent, in that the breach of one does not compromise the reliability of the others, and is designed in such a way as to protect the confidentiality of the authentication data;

(52) “electronic ledger” means a sequence of electronic data records, ensuring the integrity of those records and the accuracy of the chronological ordering of those records;

(53) “qualified electronic ledger” means an electronic ledger which is provided by a qualified trust service provider and which meets the requirements laid down in Article 45l;

(54) “personal data” means any information as defined in Article 4, point (1), of Regulation (EU) 2016/679;

(55) “identity matching” means a process where person identification data, or electronic identification means are matched with or linked to an existing account belonging to the same person;

(56) “data record” means electronic data recorded with related meta-data supporting the processing of the data;

(57) “offline mode” means, as regards the use of European Digital Identity Wallets, an interaction between a user and a third party at a physical location using close proximity technologies, whereby the European Digital Identity Wallet is not required to access remote systems via electronic communication networks for the purpose of the interaction.

### Article 4 - Internal market principle

1.   There shall be no restriction on the provision of trust services in the territory of a Member State by a trust service provider established in another Member State for reasons that fall within the fields covered by this Regulation.

2.   Products and trust services that comply with this Regulation shall be permitted to circulate freely in the internal market.

### Article 5 - Pseudonyms in electronic transaction

Without prejudice to specific rules of Union or national law requiring users to identify themselves or to the legal effect given to pseudonyms under national law, the use of pseudonyms that are chosen by the user shall not be prohibited.

## CHAPTER II - ELECTRONIC IDENTIFICATION

## SECTION 1 - EUROPEAN DIGITAL IDENTITY WALLET

### Article 5a - European Digital Identity Wallets

1.   For the purpose of ensuring that all natural and legal persons in the Union have secure, trusted and seamless cross-border access to public and private services, while having full control over their data, each Member State shall provide at least one European Digital Identity Wallet within 24 months of the date of entry into force of the implementing acts referred to in paragraph 23 of this Article and in Article 5c(6).

2.   European Digital Identity Wallets shall be provided in one or more of the following ways:

    (a) directly by a Member State;

    (b) under a mandate from a Member State;

    (c) independently of a Member State but recognised by that Member State.

3.   The source code of the application software components of European Digital Identity Wallets shall be open-source licensed. Member States may provide that, for duly justified reasons, the source code of specific components other than those installed on user devices shall not be disclosed.

4.   European Digital Identity Wallets shall enable the user, in a manner that is user-friendly, transparent, and traceable by the user, to:

    (a) securely request, obtain, select, combine, store, delete, share and present, under the sole control of the user, person identification data and, where applicable, in combination with electronic attestations of attributes, to authenticate to relying parties online and, where appropriate, in offline mode, in order to access public and private services, while ensuring that selective disclosure of data is possible;

    (b) generate pseudonyms and store them encrypted and locally within the European Digital Identity Wallet;

    (c) securely authenticate another person’s European Digital Identity Wallet, and receive and share person identification data and electronic attestations of attributes in a secured way between the two European Digital Identity Wallets;

    (d) access a log of all transactions carried out through the European Digital Identity Wallet via a common dashboard enabling the user to:
 
    ** (i)** view an up-to-date list of relying parties with which the user has established a connection and, where applicable, all data exchanged; 

    ** (ii)** easily request the erasure by a relying party of personal data pursuant to Article 17 of the Regulation (EU) 2016/679;

    **(iii)** easily report a relying party to the competent national data protection authority, where an allegedly unlawful or suspicious request for data is received;

    (e) sign by means of qualified electronic signatures or seal by means of qualified electronic seals;

    (f) download, to the extent technically feasible, the user’s data, electronic attestation of attributes and configurations;

    (g) exercise the user’s rights to data portability.

5.  European Digital Identity Wallets shall, in particular:

    (a) support common protocols and interfaces:

    (i) for issuance of person identification data, qualified and non-qualified electronic attestations of attributes or qualified and non-qualified certificates to the European Digital Identity Wallet;

    (ii) for relying parties to request and validate person identification data and electronic attestations of attributes;

    (iii) for the sharing and presentation to relying parties of person identification data, electronic attestation of attributes or of selectively disclosed related data online and, where appropriate, in offline mode;

    (iv) for the user to allow interaction with the European Digital Identity Wallet and display an EU Digital Identity Wallet Trust Mark;

    (v) to securely onboard the user by using an electronic identification means in accordance with Article 5a(24);

    (vi) for interaction between two persons’ European Digital Identity Wallets for the purpose of receiving, validating and sharing person identification data and electronic attestations of attributes in a secure manner;

    (vii) for authenticating and identifying relying parties by implementing authentication mechanisms in accordance with Article 5b;

    (viii) for relying parties to verify the authenticity and validity of European Digital Identity Wallets;

    (ix) for requesting a relying party the erasure of personal data pursuant to Article 17 of Regulation (EU) 2016/679;

    (x) for reporting a relying party to the competent national data protection authority where an allegedly unlawful or suspicious request for data is received;

    (xi) for the creation of qualified electronic signatures or electronic seals by means of qualified electronic signature or electronic seal creation devices;

    (b) not provide any information to trust service providers of electronic attestations of attributes about the use of those electronic attestations;

    (c) ensure that the relying parties can be authenticated and identified by implementing authentication mechanisms in accordance with Article 5b;

    (d) meet the requirements set out in Article 8 with regard to assurance level high, in particular as applied to the requirements for identity proofing and verification, and electronic identification means management and authentication;

    (e) in the case of the electronic attestation of attributes with embedded disclosure policies, implement the appropriate mechanism to inform the user that the relying party or the user of the European Digital Identity Wallet requesting that electronic attestation of attributes has the permission to access such attestation;

    (f) ensure that the person identification data, which is available from the electronic identification scheme under which the European Digital Identity Wallet is provided, uniquely represents the natural person, legal person or the natural person representing the natural or legal person, and is associated with that European Digital Identity Wallet;

    (g) offer all natural persons the ability to sign by means of qualified electronic signatures by default and free of charge.

    Notwithstanding point (g) of the first subparagraph, Member States may provide for proportionate measures to ensure that the use of qualified electronic signatures free-of-charge by natural persons is limited to non-professional purposes.

6.  Member State shall inform users, without delay, of any security breach that could have entirely or partially compromised their European Digital Identity Wallet or its contents, in particular if their European Digital Identity Wallet has been suspended or revoked pursuant to Article 5e.

7.  Without prejudice to Article 5f, Member States may provide, in accordance with national law, for additional functionalities of European Digital Identity Wallets, including interoperability with existing national electronic identification means. Those additional functionalities shall comply with this Article.

8.   Member States shall provide validation mechanisms free-of-charge, in order to:

    (a) ensure that the authenticity and validity of European Digital Identity Wallets can be verified;

    (b) allow users to verify the authenticity and validity of the identity of relying parties registered in accordance with Article 5b.

9.   Member States shall ensure that the validity of the European Digital Identity Wallet can be revoked in the following circumstances:

    (a) upon the explicit request of the user;

    (b) where the security of the European Digital Identity Wallet has been compromised;

    (c) upon the death of the user or cease of activity of the legal person.

10.   Providers of European Digital Identity Wallets shall ensure that users can easily request technical support and report technical problems or any other incidents having a negative impact on the use of European Digital Identity Wallets.

11.   European Digital Identity Wallets shall be provided under an electronic identification scheme with assurance level high.

12.   European Digital Identity Wallets shall ensure security-by-design.

13.   The issuance, use and revocation of the European Digital Identity Wallets shall be free of charge to all natural persons.

14.   Users shall have full control of the use of and of the data in their European Digital Identity Wallet. The provider of the European Digital Identity Wallet shall neither collect information about the use of the European Digital Identity Wallet which is not necessary for the provision of European Digital Identity Wallet services, nor combine person identification data or any other personal data stored or relating to the use of the European Digital Identity Wallet with personal data from any other services offered by that provider or from third-party services which are not necessary for the provision of European Digital Identity Wallet services, unless the user has expressly requested otherwise. Personal data relating to the provision of the European Digital Identity Wallet shall be kept logically separate from any other data held by the provider of the European Digital Identity Wallet. If the European Digital Identity Wallet is provided by private parties in accordance with paragraph 2, points (b) and (c), of this Article, the provisions of Article 45h(3) shall apply mutatis mutandis.

15.   The use of European Digital Identity Wallets shall be voluntary. Access to public and private services, access to the labour market and freedom to conduct business shall not in any way be restricted or made disadvantageous to natural or legal persons that do not use European Digital Identity Wallets. It shall remain possible to access public and private services by other existing identification and authentication means.

16.   The technical framework of the European Digital Identity Wallet shall:

    (a) not allow providers of electronic attestations of attributes or any other party, after the issuance of the attestation of attributes, to obtain data that allows transactions or user behaviour to be tracked, linked or correlated, or knowledge of transactions or user behaviour to be otherwise obtained, unless explicitly authorised by the user;

    (b) enable privacy preserving techniques which ensure unlikeability, where the attestation of attributes does not require the identification of the user.

17.   Any processing of personal data carried out by the Member States or on their behalf by bodies or parties responsible for the provision of European Digital Identity Wallets as electronic identification means shall be carried out in accordance with appropriate and effective data protection measures. Compliance of such processing with Regulation (EU) 2016/679 shall be demonstrated. Member States may introduce national provisions to further specify the application of such measures.

18.   Member States shall, without undue delay, notify the Commission of information about:

    (a) the body responsible for establishing and maintaining the list of registered relying parties that rely on European Digital Identity Wallets in accordance with Article 5b(5) and the location of that list;

    (b) the bodies responsible for the provision of European Digital Identity Wallets in accordance with Article 5a(1);

    (c) the bodies responsible for ensuring that the person identification data is associated with the European Digital Identity Wallet in accordance with Article 5a(5), point (f);

    (d) the mechanism allowing for the validation of the person identification data referred to in Article 5a(5), point (f), and of the identity of the relying parties;

    (e) the mechanism by which to validate the authenticity and validity of European Digital Identity Wallets.

The Commission shall make available the information notified pursuant to the first subparagraph to the public through a secure channel, in electronically signed or sealed form suitable for automated processing.

19.   Without prejudice to paragraph 22 of this Article, Article 11 shall apply mutatis mutandis to the European Digital Identity Wallet.

20.   Article 24(2), points (b), and (d) to (h), shall apply mutatis mutandis to providers of European Digital Identity Wallets.

21.   European Digital Identity Wallets shall be made accessible for use, by persons with disabilities, on an equal basis with other users, in accordance with Directive (EU) 2019/882 of the European Parliament and of the Council (See note below).  

:::note
_Directive (EU) 2019/882 of the European Parliament and of the Council of 17 April 2019on the accessibility requirements for products and services (OJ L 151, 7.6.2019, p. 70)._
:::

1.    For the purposes of the provision of European Digital Identity Wallets, European Digital Identity Wallets and the electronic identification schemes under which they are provided shall not be subject to the requirements laid down in Articles 7, 9, 10, 12 and 12a.

2.    By 21 November 2024, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the requirements referred to in paragraphs 4, 5, 8 and 18 of this Article on the implementation of the European Digital Identity Wallet. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

3.    The Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures in order to facilitate the onboarding of users to the European Digital Identity Wallet either by electronic identification means conforming to assurance level high or by electronic identification means conforming to assurance level substantial in conjunction with additional remote onboarding procedures that together meet the requirements of assurance level high. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).


### Article 5b - European Digital Identity Wallet-Relying Parties

1.   Where a relying party intends to rely upon European Digital Identity Wallets for the provision of public or private services by means of digital interaction, the relying party shall register in the Member State where it is established.

2.   The registration process shall be cost-effective and proportionate-to-risk. The relying party shall provide at least:

    (a) the information necessary to authenticate to European Digital Identity Wallets, which as a minimum includes:

    **(i)** the Member State in which the relying party is established; and

    **(ii)** the name of the relying party and, where applicable, its registration number as stated in an official record together with identification data of that official record;

    (b) the contact details of the relying party;

    (c) the intended use of European Digital Identity Wallets, including an indication of the data to be requested by the relying party from users.

3.   Relying parties shall not request users to provide any data other than that indicated pursuant to paragraph 2, point (c).

4.   Paragraphs 1 and 2 shall be without prejudice to Union or national law that is applicable to the provision of specific services.

5.   Member States shall make the information referred to in paragraph 2 publicly available online in electronically signed or sealed form suitable for automated processing.

6.   Relying parties registered in accordance with this Article shall inform Member States without delay about any changes to the information provided in the registration pursuant to paragraph 2.

7.   Member States shall provide a common mechanism for allowing the identification and authentication of relying parties, as referred to in Article 5a(5), point (c).

8.   Where relying parties intend to rely upon European Digital Identity Wallets, they shall identify themselves to the user.

9.   Relying parties shall be responsible for carrying out the procedure for authenticating and validating person identification data and electronic attestation of attributes requested from European Digital Identity Wallets. Relying parties shall not refuse the use of pseudonyms, where the identification of the user is not required by Union or national law.

10.   Intermediaries acting on behalf of relying parties shall be deemed to be relying parties and shall not store data about the content of the transaction.

11.   By 21 November 2024, the Commission shall establish technical specifications and procedures for the requirements referred to in paragraphs 2, 5 and 6 to 9 of this Article by means of implementing acts on the implementation of European Digital Identity Wallets as referred to in Article 5a(23). Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 5c - Certification of European Digital Identity Wallets

1.   The conformity of European Digital Identity Wallets and the electronic identification scheme under which they are provided with the requirements laid down in Article 5a(4), (5), (8), the requirement for logical separation laid down in Article 5a(14) and, where applicable, with the standards and technical specifications referred to in Article 5a(24), shall be certified by conformity assessment bodies designated by Member States.

2.   Certification of the conformity of European Digital Identity Wallets with requirements referred to in paragraph 1 of this Article, or parts thereof, that are relevant for cybersecurity shall be carried out in accordance with European cybersecurity certification schemes adopted pursuant to Regulation (EU) 2019/881 of the European Parliament and of the Council (See note below) and referred to in the implementing acts referred to in paragraph 6 of this Article.

:::note
_Regulation (EU) 2019/881 of the European Parliament and of the Council of 17 April 2019on ENISA (the European Union Agency for Cybersecurity) and on information and communications technology cybersecurity certification and repealing Regulation (EU) No 526/2013 (Cybersecurity Act) (OJ L 151, 7.6.2019, p. 15)._
:::

3.   For requirements referred to in paragraph 1 of this Article that are not relevant for cybersecurity, and, for requirements referred to in paragraph 1 of this Article that are relevant for cybersecurity, to the extent that cybersecurity certification schemes as referred to in paragraph 2 of this Article do not, or only partially, cover those cybersecurity requirements, also for those requirements, Member States shall establish national certification schemes following the requirements set out in the implementing acts referred to in paragraph 6 of this Article. Member States shall transmit their draft national certification schemes to the European Digital Identity Cooperation Group established pursuant to Article 46e(1) (the “Cooperation Group”). The Cooperation Group may issue opinions and recommendations.

4.   Certification pursuant to paragraph 1 shall be valid for up to five years, provided that a vulnerability assessment is carried out every two years. Where a vulnerability is identified and not remedied in a timely manner, certification shall be cancelled.

5.   Compliance with the requirements set out in Article 5a of this Regulation related to the personal data processing operations may be certified pursuant to Regulation(EU) 2016/679.

6.   By 21 November 2024, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the certification of European Digital Identity Wallets referred to in paragraph 1, 2 and 3 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

7.   Member States shall communicate to the Commission the names and addresses of the conformity assessment bodies referred to in paragraph 1. The Commission shall make that information available to all Member States.

8.   The Commission shall be empowered to adopt delegated acts in accordance with Article 47 establishing specific criteria to be met by the designated conformity assessment bodies referred to in paragraph 1 of this Article.

### Article 5d - Publication of a list of certified European Digital Identity Wallets

1.   Member States shall inform the Commission and the Cooperation Group established pursuant to Article 46e(1) without undue delay of European Digital Identity Wallets that have been provided pursuant to Article 5a and certified by the conformity assessment bodies referred to in Article 5c(1). They shall inform the Commission and the Cooperation Group established pursuant to Article 46e(1), without undue delay if a certification is cancelled and shall state the reasons for the cancellation.

2.   Without prejudice to Article 5a(18), the information provided by Member States referred to in paragraph 1 of this Article shall include at least:

    (a) the certificate and certification assessment report of the certified European Digital Identity Wallet;

    (b) a description of the electronic identification scheme under which the European Digital Identity Wallet is provided;

    (c) the applicable supervisory regime and information on the liability regime with respect to the party providing the European Digital Identity Wallet;

    (d) the authority or authorities responsible for the electronic identification scheme;
    
    (e) arrangements for suspension or revocation of the electronic identification scheme or authentication or of the compromised parts concerned.

3.   On the basis of the information received pursuant to paragraph 1, the Commission shall establish, publish in the Official Journal of the European Union and maintain in a machine-readable form a list of certified European Digital Identity Wallets.

4.   A Member State may submit a request to the Commission to remove a European Digital Identity Wallet and the electronic identification scheme under which it is provided from the list referred to in paragraph 3.

5.   Where there are changes to the information provided pursuant to paragraph 1, the Member State shall provide the Commission with updated information.

6.   The Commission shall keep the list referred to in paragraph 3 updated by publishing in the Official Journal of the European Union the corresponding amendments to the list within one month of receipt of a request pursuant to paragraph 4 or of updated information pursuant to paragraph 5.

7.   By 21 November 2024, the Commission shall establish the formats and procedures applicable for the purposes of paragraphs 1, 4 and 5 of this Article by means of implementing acts on the implementation of European Digital Identity Wallets as referred to in Article 5a(23). Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 5e - Security breach of European Digital Identity Wallets

1.   Where European Digital Identity Wallets provided pursuant to Article 5a, the validation mechanisms referred to in Article 5a(8) or the electronic identification scheme under which the European Digital Identity Wallets are provided are breached or partly compromised in a manner that affects their reliability or the reliability of other European Digital Identity Wallets, the Member State that provided the European Digital Identity Wallets shall, without undue delay, suspend the provision and the use of European Digital Identity Wallets.

Where justified by the severity of the security breach or compromise referred to in the first subparagraph, the Member State shall withdraw European Digital Identity Wallets without undue delay.

The Member State shall inform the users affected, the single points of contact designated pursuant to Article 46c(1), the relying parties and the Commission accordingly.

2.   If the security breach or compromise referred to in paragraph 1, first subparagraph, of this Article is not remedied within three months of the suspension, the Member State that provided the European Digital Identity Wallets shall withdraw European Digital Identity Wallets and revoke their validity. The Member State shall inform the users affected, the single points of contact designated pursuant to Article 46c(1), the relying parties and the Commission of the withdrawal accordingly.

3.   Where the security breach or compromise referred to in paragraph 1, first subparagraph, of this Article is remedied, the providing Member State shall re-establish the provision and the use of European Digital Identity Wallets and inform the affected users and relying parties, the single points of contact designated pursuant to Article 46c(1) and the Commission without undue delay.

4.   The Commission shall publish in the Official Journal of the European Union the corresponding amendments to the list referred to in Article 5d without undue delay.

5.   By 21 November 2024, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the measures referred to in paragraphs 1, 2 and 3 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 5f - Cross-border reliance on European Digital Identity Wallets

1.   Where Member States require electronic identification and authentication to access an online service provided by a public sector body, they shall also accept European Digital Identity Wallets that are provided in accordance with this Regulation.

2.   Where private relying parties that provide services, with the exception of microenterprises and small enterprises as defined in Article 2 of the Annex to Commission Recommendation 2003/361/EC (See note below), are required by Union or national law to use strong user authentication for online identification or where strong user authentication for online identification is required by contractual obligation, including in the areas of transport, energy, banking, financial services, social security, health, drinking water, postal services, digital infrastructure, education or telecommunications, those private relying parties shall, no later than 36 months from the date of entry into force of the implementing acts referred to in Article 5a(23) and Article 5c(6) and only upon the voluntary request of the user, also accept European Digital Identity Wallets that are provided in accordance with this Regulation.

:::note
_Commission Recommendation 2003/361/EC of 6 May 2003concerning the definition of micro, small and medium-sized enterprises (OJ L 124, 20.5.2003, p. 36)._
:::

3.   Where providers of very large online platforms as referred to in Article 33 of Regulation (EU) 2022/2065 of the European Parliament and of the Council (*5) require user authentication for access to online services, they shall also accept and facilitate the use of European Digital Identity Wallets that are provided in accordance with this Regulation for user authentication only upon the voluntary request of the user and in respect of the minimum data necessary for the specific online service for which authentication is requested.

:::note
_Regulation (EU) 2022/2065 of the European Parliament and of the Council of 19 October 2022on a Single Market For Digital Services and amending Directive 2000/31/EC (Digital Services Act) (OJ L 277, 27.10.2022, p. 1)._
:::

4.   In cooperation with Member States, the Commission shall facilitate the development of codes of conduct in close collaboration with all relevant stakeholders, including civil society, in order to contribute to the wide availability and usability of European Digital Identity Wallets within the scope of this Regulation, and to encourage service providers to complete the development of codes of conduct.

5.   Within 24 months after deployment of the European Digital Identity Wallets, the Commission shall assess the demand for, and the availability and usability of, European Digital Identity Wallets, taking into account criteria such as user take-up, cross-border presence of service providers, technological developments, evolution in usage patterns and consumer demand.

(*2)  Directive (EU) 2019/882 of the European Parliament and of the Council of 17 April 2019on the accessibility requirements for products and services (OJ L 151, 7.6.2019, p. 70)."

(*3)  Regulation (EU) 2019/881 of the European Parliament and of the Council of 17 April 2019on ENISA (the European Union Agency for Cybersecurity) and on information and communications technology cybersecurity certification and repealing Regulation (EU) No 526/2013 (Cybersecurity Act) (OJ L 151, 7.6.2019, p. 15)."

(*4)  Commission Recommendation 2003/361/EC of 6 May 2003concerning the definition of micro, small and medium-sized enterprises (OJ L 124, 20.5.2003, p. 36)."

(*5)  Regulation (EU) 2022/2065 of the European Parliament and of the Council of 19 October 2022on a Single Market For Digital Services and amending Directive 2000/31/EC (Digital Services Act) (OJ L 277, 27.10.2022, p. 1).’;"


## SECTION 2 - ELECTRONIC IDENTIFICATION SCHEMES

### Article 6 - Mutual recognition

1. When an electronic identification using an electronic identification means and authentication is required under national law or by administrative practice to access a service provided by a public sector body online in one Member State, the electronic identification means issued in another Member State shall be recognised in the first Member State for the purposes of cross-border authentication for that service online, provided that the following conditions are met:

    (a) the electronic identification means is issued under an electronic identification scheme that is included in the list published by the Commission pursuant to Article 9;

    (b) the assurance level of the electronic identification means corresponds to an assurance level equal to or higher than the assurance level required by the relevant public sector body to access that service online in the first Member State, provided that the assurance level of that electronic identification means corresponds to the assurance level substantial or high;

    (c) the relevant public sector body uses the assurance level substantial or high in relation to accessing that service online.

    Such recognition shall take place no later than 12 months after the Commission publishes the list referred to in point (a) of the first subparagraph.

2.   An electronic identification means which is issued under an electronic identification scheme included in the list published by the Commission pursuant to Article 9 and which corresponds to the assurance level low may be recognised by public sector bodies for the purposes of cross-border authentication for the service provided online by those bodies.

### Article 7 - Eligibility for notification of electronic identification schemes

An electronic identification scheme shall be eligible for notification pursuant to Article 9(1) provided that all of the following conditions are met:

(a) the electronic identification means under the electronic identification scheme are issued:

(i) by the notifying Member State;

(ii) under a mandate from the notifying Member State; or

(iii) independently of the notifying Member State and are recognised by that Member State;

(b) the electronic identification means under the electronic identification scheme can be used to access at least one service which is provided by a public sector body and which requires electronic identification in the notifying Member State;

(c) the electronic identification scheme and the electronic identification means issued thereunder meet the requirements of at least one of the assurance levels set out in the implementing act referred to in Article 8(3);

(d) the notifying Member State ensures that the person identification data uniquely representing the person in question is attributed, in accordance with the technical specifications, standards and procedures for the relevant assurance level set out in the implementing act referred to in Article 8(3), to the natural or legal person referred to in point 1 of Article 3 at the time the electronic identification means under that scheme is issued;

(e) the party issuing the electronic identification means under that scheme ensures that the electronic identification means is attributed to the person referred to in point (d) of this Article in accordance with the technical specifications, standards and procedures for the relevant assurance level set out in the implementing act referred to in Article 8(3);

(f) the notifying Member State ensures the availability of authentication online, so that any relying party established in the territory of another Member State is able to confirm the person identification data received in electronic form.

For relying parties other than public sector bodies the notifying Member State may define terms of access to that authentication. The cross-border authentication shall be provided free of charge when it is carried out in relation to a service online provided by a public sector body.

Member States shall not impose any specific disproportionate technical requirements on relying parties intending to carry out such authentication, where such requirements prevent or significantly impede the interoperability of the notified electronic identification schemes;

(g) at least six months prior to notification pursuant to Article 9(1), the notifying Member State provides the other Member States, for the purposes of Article 12(5), with a description of that scheme in accordance with the procedural arrangements established by the implementing acts adopted pursuant to Article 12(6);

(h) the electronic identification scheme meets the requirements set out in the implementing act referred to in Article 12(8).

### Article 8 - Assurance levels of electronic identification schemes

1.   An electronic identification scheme notified pursuant to Article 9(1) shall specify assurance levels low, substantial and/or high for electronic identification means issued under that scheme.

2.   The assurance levels low, substantial and high shall meet respectively the following criteria:

    (a) assurance level low shall refer to an electronic identification means in the context of an electronic identification scheme, which provides a limited degree of confidence in the claimed or asserted identity of a person, and is characterised with reference to technical specifications, standards and procedures related thereto, including technical controls, the purpose of which is to decrease the risk of misuse or alteration of the identity;

    (b) assurance level substantial shall refer to an electronic identification means in the context of an electronic identification scheme, which provides a substantial degree of confidence in the claimed or asserted identity of a person, and is characterised with reference to technical specifications, standards and procedures related thereto, including technical controls, the purpose of which is to decrease substantially the risk of misuse or alteration of the identity;

    (c) assurance level high shall refer to an electronic identification means in the context of an electronic identification scheme, which provides a higher degree of confidence in the claimed or asserted identity of a person than electronic identification means with the assurance level substantial, and is characterised with reference to technical specifications, standards and procedures related thereto, including technical controls, the purpose of which is to prevent misuse or alteration of the identity.

3.   By 18 September 2015, taking into account relevant international standards and subject to paragraph 2, the Commission shall, by means of implementing acts, set out minimum technical specifications, standards and procedures with reference to which assurance levels low, substantial and high are specified for electronic identification means.

Those minimum technical specifications, standards and procedures shall be set out by reference to the reliability and quality of the following elements:

    (a) the procedure to prove and verify the identity of natural or legal persons applying for the issuance of electronic identification means;

    (b) the procedure for the issuance of the requested electronic identification means;

    (c) the authentication mechanism, through which the natural or legal person uses the electronic identification means to confirm its identity to a relying party;

    (d) the entity issuing the electronic identification means;

    (e) any other body involved in the application for the issuance of the electronic identification means; and

    (f) the technical and security specifications of the issued electronic identification means.

Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 9 - Notification

1.   The notifying Member State shall notify to the Commission the following information and, without undue delay, any subsequent changes thereto:

    (a) a description of the electronic identification scheme, including its assurance levels and the issuer or issuers of electronic identification means under the scheme;

    (b) the applicable supervisory regime and information on the liability regime with respect to the following:

    **(i)** the party issuing the electronic identification means; and

    **(ii)** the party operating the authentication procedure;

    (c) the authority or authorities responsible for the electronic identification scheme;

    (d) information on the entity or entities which manage the registration of the unique person identification data;

    (e) a description of how the requirements set out in the implementing acts referred to in Article 12(8) are met;

    (f) a description of the authentication referred to in point (f) of Article 7;

    (g) arrangements for suspension or revocation of either the notified electronic identification scheme or authentication or the compromised parts concerned.

2.   The Commission shall, without undue delay, publish in the Official Journal of the European Union a list of the electronic identification schemes which were notified pursuant to paragraph 1 together with basic information about those schemes.

3.   The Commission shall publish in the Official Journal of the European Union the amendments to the list referred to in paragraph 2 within one month of the date of receipt of that notification.

4.   A Member State may submit to the Commission a request to remove an electronic identification scheme notified by that Member State from the list referred to in paragraph 2. The Commission shall publish in the Official Journal of the European Union the corresponding amendments to the list within one month from the date of receipt of the Member State’s request.

5.   The Commission may, by means of implementing acts, define the circumstances, formats and procedures of notifications under paragraph 1. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 10 - Security breach of electronic identification schemes

1.   Where either the electronic identification scheme notified pursuant to Article 9(1) or the authentication referred to in point (f) of Article 7 is breached or partly compromised in a manner that affects the reliability of the cross-border authentication of that scheme, the notifying Member State shall, without delay, suspend or revoke that cross-border authentication or the compromised parts concerned, and shall inform other Member States and the Commission.

2.   When the breach or compromise referred to in paragraph 1 is remedied, the notifying Member State shall re-establish the cross-border authentication and shall inform other Member States and the Commission without undue delay.

3.   If the breach or compromise referred to in paragraph 1 is not remedied within three months of the suspension or revocation, the notifying Member State shall notify other Member States and the Commission of the withdrawal of the electronic identification scheme.

The Commission shall publish in the Official Journal of the European Union the corresponding amendments to the list referred to in Article 9(2) without undue delay.

### Article 11 - Liability

1.   The notifying Member State shall be liable for damage caused intentionally or negligently to any natural or legal person due to a failure to comply with its obligations under points (d) and (f) of Article 7 in a cross-border transaction.

2.   The party issuing the electronic identification means shall be liable for damage caused intentionally or negligently to any natural or legal person due to a failure to comply with the obligation referred to in point (e) of Article 7 in a cross-border transaction.

3.   The party operating the authentication procedure shall be liable for damage caused intentionally or negligently to any natural or legal person due to a failure to ensure the correct operation of the authentication referred to in point (f) of Article 7 in a cross-border transaction.

4.   Paragraphs 1, 2 and 3 shall be applied in accordance with national rules on liability.

5.   Paragraphs 1, 2 and 3 are without prejudice to the liability under national law of parties to a transaction in which electronic identification means falling under the electronic identification scheme notified pursuant to Article 9(1) are used.

### Article 11a - Cross-border identity matching

1.   When acting as relying parties for cross-border services, Member States shall ensure unequivocal identity matching for natural persons using notified electronic identification means or European Digital Identity Wallets.

2.   Member States shall provide for technical and organisational measures to ensure a high level of protection of personal data used for identity matching and to prevent the profiling of users.

3.   By 21 November 2024, the Commission shall establish a list of reference standards and, where necessary, establish specifications and procedures for the requirements referred to in paragraph 1 of this Article by means of implementing acts. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 12 - Interoperability

1.   The national electronic identification schemes notified pursuant to Article 9(1) shall be interoperable.

2.   For the purposes of paragraph 1, an interoperability framework shall be established.

3.   The interoperability framework shall meet the following criteria:

    (a) it aims to be technology neutral and does not discriminate between any specific national technical solutions for electronic identification within a Member State;

    (b) it follows European and international standards, where possible;

    (c) it facilitates the implementation of privacy and security by design;

4.   The interoperability framework shall consist of:

    (a) a reference to minimum technical requirements related to the assurance levels under Article 8;

    (b) a mapping of national assurance levels of notified electronic identification schemes to the assurance levels under Article 8;

    (c) a reference to minimum technical requirements for interoperability;

    (d) a reference to a minimum set of person identification data necessary to uniquely represent a natural or legal person, or a natural person representing another natural person or a legal person, which is available from electronic identification schemes;

    (e) rules of procedure;

    (f) arrangements for dispute resolution; and

    (g) common operational security standards.


5.   Member States shall carry out peer reviews of the electronic identification schemes that fall within the scope of this Regulation and that are to be notified pursuant to Article 9(1), point (a).

6.   By 18 March 2025, the Commission shall, by means of implementing acts, establish the necessary procedural arrangements for the peer reviews referred to in paragraph 5 of this Article with a view to fostering a high level of trust and security appropriate to the degree of risk. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

**DELETED in eIDAS 2 amendment** 7.   By 18 September 2015, for the purpose of setting uniform conditions for the implementation of the requirement under paragraph 1, the Commission shall, subject to the criteria set out in paragraph 3 and taking into account the results of the cooperation between Member States, adopt implementing acts on the interoperability framework as set out in paragraph 4.

8.  By 18 September 2025, for the purpose of setting uniform conditions for the implementation of the requirement under paragraph 1 of this Article, the Commission shall, subject to the criteria set out in paragraph 3 of this Article and taking into account the results of the cooperation between Member States, adopt implementing acts on the interoperability framework as set out in paragraph 4 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 12a - Certification of electronic identification schemes

1.   The conformity of electronic identification schemes to be notified with the cybersecurity requirements laid down in this Regulation, including conformity with the cybersecurity relevant requirements set out in Article 8(2) regarding the assurance levels of electronic identification schemes, shall be certified by conformity assessment bodies designated by Member States.

2.   Certification pursuant to paragraph 1 of this Article shall be carried out under a relevant cybersecurity certification scheme pursuant to Regulation (EU) 2019/881 or parts thereof, insofar as the cybersecurity certificate or parts thereof cover those cybersecurity requirements.

3.   Certification pursuant to paragraph 1 shall be valid for up to five years, provided that a vulnerability assessment is carried out every two years. Where a vulnerability is identified and not remedied within three months of such identification, certification shall be cancelled.

4.   Notwithstanding paragraph 2, Member States may request, in accordance with that paragraph, additional information from a notifying Member State about electronic identification schemes or part thereof certified.

5.   The peer review of electronic identification schemes referred to in Article 12(5) shall not apply to electronic identification schemes or parts of such schemes certified in accordance with paragraph 1 of this Article. Member States may use a certificate or a statement of conformity, issued in accordance with a relevant certification scheme or parts of such schemes, with the non-cybersecurity-related requirements set out in Article 8(2) regarding the assurance level of electronic identification schemes.

6.   Member States shall communicate to the Commission the names and addresses of the conformity assessment bodies referred to in paragraph 1. The Commission shall make that information available to all Member States.

### Article 12b - Access to hardware and software features

Where providers of European Digital Identity Wallets and issuers of notified electronic identification means that act in a commercial or professional capacity and use core platform services as defined in Article 2, point (2), of Regulation (EU) 2022/1925 of the European Parliament and of the Council (See note below) for the purpose or in the course of providing European Digital Identity Wallet services and electronic identification means to end-users are business users as defined in Article 2, point (21), of that Regulation, gatekeepers shall in particular allow them effective interoperability with, and, for the purposes of interoperability, access to, the same operating system, hardware or software features. Such effective interoperability and access shall be allowed free of charge and regardless of whether the hardware or software features are part of the operating system, are available to, or are used by, that gatekeeper when providing such services, within the meaning of Article 6(7) of Regulation (EU) 2022/1925. This Article is without prejudice to Article 5a(14) of this Regulation.

:::note
_ Regulation (EU) 2022/1925 of the European Parliament and of the Council of 14 September 2022on contestable and fair markets in the digital sector and amending Directives (EU) 2019/1937 and (EU) 2020/1828 (Digital Markets Act) (OJ L 265, 12.10.2022, p. 1)._
:::

## CHAPTER III - TRUST SERVICES 

## SECTION 1 - General provisions

### Article 13 - Liability and burden of proof

1.  Notwithstanding paragraph 2 of this Article and without prejudice to Regulation (EU) 2016/679, trust service providers shall be liable for damage caused intentionally or negligently to any natural or legal person due to a failure to comply with the obligations under this Regulation. Any natural or legal person who has suffered material or non-material damage as a result of an infringement of this Regulation by a trust service provider shall have the right to seek compensation in accordance with Union and national law.

The burden of proving the intention or negligence of a non-qualified trust service provider shall lie with the natural or legal person claiming the damage referred to in the first subparagraph.

The intention or negligence of a qualified trust service provider shall be presumed unless that qualified trust service provider proves that the damage referred to in the first subparagraph occurred without the intention or negligence of that qualified trust service provider.

2.  Where trust service providers duly inform their customers in advance of the limitations on the use of the services they provide and where those limitations are recognisable to third parties, trust service providers shall not be liable for damages arising from the use of services exceeding the indicated limitations.

3.  Paragraphs 1 and 2 shall be applied in accordance with national rules on liability.

### Article 14 - International aspects

1.   Trust services provided by trust service providers established in a third country or by an international organisation shall be recognised as legally equivalent to qualified trust services provided by qualified trust service providers established in the Union, where the trust services originating from the third country or from the international organisation are recognised by means of implementing acts or an agreement concluded between the Union and the third country or the international organisation pursuant to Article 218 TFEU.

The implementing acts referred to in the first subparagraph shall be adopted in accordance with the examination procedure referred to in Article 48(2).

2.   The implementing acts and the agreement referred to in paragraph 1 shall ensure that the requirements applicable to qualified trust service providers established in the Union and the qualified trust services they provide are met by the trust service providers in the third country concerned or by the international organisation and by the trust services they provide. Third countries and international organisations shall in particular establish, maintain and publish a trusted list of recognised trust service providers.

3.   The agreement referred to in paragraph 1 shall ensure that the qualified trust services provided by qualified trust service providers established in the Union are recognised as legally equivalent to trust services provided by trust service providers in the third country or by the international organisation with which the agreement is concluded.

### Article 15 - Accessibility for persons with disabilities and special needs

The provision of electronic identification means, trust services and end-user products that are used in the provision of those services shall be made available in plain and intelligible language, in accordance with the United Nations Convention on the Rights of Persons with Disabilities and with the accessibility requirements of Directive (EU) 2019/882, thus also benefiting persons who experience functional limitations, such as elderly people, and persons with limited access to digital technologies.

### Article 16 - Penalties

1.   Without prejudice to Article 31 of Directive (EU) 2022/2555 of the European Parliament and of the Council (See note below), Member States shall lay down the rules on penalties applicable to infringements of this Regulation. Those penalties shall be effective, proportionate and dissuasive.

:::note 
Directive (EU) 2022/2555 of the European Parliament and of the Council of 14 December 2022on measures for a high common level of cybersecurity across the Union, amending Regulation (EU) No 910/2014 and Directive (EU) 2018/1972, and repealing Directive (EU) 2016/1148 (NIS 2 Directive) (OJ L 333, 27.12.2022, p. 80)._
:::

2.   Member States shall ensure that infringements of this Regulation by qualified and non-qualified trust service providers be subject to administrative fines of a maximum of at least:

(a) EUR 5 000 000 where the trust service provider is a natural person; or

(b) where the trust service provider is a legal person, EUR 5 000 000 or 1 % of the total worldwide annual turnover of the undertaking to which the trust service provider belonged in the financial year preceding the year in which the infringement occurred, whichever is higher.

3.   Depending on the legal system of the Member States, the rules on administrative fines may be applied in such a manner that the fine is initiated by the competent supervisory body and imposed by competent national courts. The application of such rules in those Member States shall ensure that those legal remedies are effective and have an equivalent effect to administrative fines imposed directly by supervisory authorities.

## SECTION 2 - Non-qualified trust services

### Article 19 - Security requirements applicable to trust service providers

1.   Qualified and non-qualified trust service providers shall take appropriate technical and organisational measures to manage the risks posed to the security of the trust services they provide. Having regard to the latest technological developments, those measures shall ensure that the level of security is commensurate to the degree of risk. In particular, measures shall be taken to prevent and minimise the impact of security incidents and inform stakeholders of the adverse effects of any such incidents.

2.   Qualified and non-qualified trust service providers shall, without undue delay but in any event within 24 hours after having become aware of it, notify the supervisory body and, where applicable, other relevant bodies, such as the competent national body for information security or the data protection authority, of any breach of security or loss of integrity that has a significant impact on the trust service provided or on the personal data maintained therein.

Where the breach of security or loss of integrity is likely to adversely affect a natural or legal person to whom the trusted service has been provided, the trust service provider shall also notify the natural or legal person of the breach of security or loss of integrity without undue delay.

Where appropriate, in particular if a breach of security or loss of integrity concerns two or more Member States, the notified supervisory body shall inform the supervisory bodies in other Member States concerned and ENISA.

The notified supervisory body shall inform the public or require the trust service provider to do so, where it determines that disclosure of the breach of security or loss of integrity is in the public interest.

3.   The supervisory body shall provide ENISA once a year with a summary of notifications of breach of security and loss of integrity received from trust service providers.

4.   The Commission may, by means of implementing acts,:

    (a) further specify the measures referred to in paragraph 1; and

    (b) define the formats and procedures, including deadlines, applicable for the purpose of paragraph 2.

Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 19a - Requirements for non-qualified trust service providers

1.   A non-qualified trust service provider providing non-qualified trust services shall:

    (a) have appropriate policies and take corresponding measures to manage legal, business, operational and other direct or indirect risks to the provision of the non-qualified trust service, which shall, notwithstanding Article 21 of Directive (EU) 2022/2555, include at least measures relating to:

    **(i)** registration and onboarding procedures for a trust service;

    **(ii)**procedural or administrative checks needed to provide trust services;

    **(iii)** the management and implementation of trust services;

    (b) notifying the supervisory body, the identifiable affected individuals, the public if it is of public interest and, where applicable, other relevant competent authorities, of any security breaches or disruptions in the provision of the service or the implementation of the measures referred to in point (a) (i), (ii) or (iii), that have a significant impact on the trust service provided or on the personal data maintained therein, without undue delay and in any case no later than 24 hours of having become aware of any security breaches or disruptions.

2.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for paragraph 1, point (a), of this Article. Compliance with the requirements laid down in this Article shall be presumed where those standards, specifications and procedures are met. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

## SECTION 3 - Qualified trust services

### Article 20 - Supervision of qualified trust service providers

1.   Qualified trust service providers shall be audited at their own expense at least every 24 months by a conformity assessment body. The audit shall confirm that the qualified trust service providers and the qualified trust services provided by them fulfil the requirements laid down in this Regulation and in Article 21 of Directive (EU) 2022/2555. Qualified trust service providers shall submit the resulting conformity assessment report to the supervisory body within three working days of receipt.

    1a.   Qualified trust service providers shall inform the supervisory body at the latest one month before any planned audits and shall allow the supervisory body to participate as an observer upon request.

    1b.   Member States shall, without undue delay, notify to the Commission the names, addresses and accreditation details of the conformity assessment bodies referred to in paragraph 1 and any subsequent changes thereto. The Commission shall make that information available to all Member States.

2. Without prejudice to paragraph 1, the supervisory body may at any time audit or request a conformity assessment body to perform a conformity assessment of the qualified trust service providers, at the expense of those trust service providers, to confirm that they and the qualified trust services provided by them fulfil the requirements laid down in this Regulation. Where personal data protection rules appear to have been breached, the supervisory body shall, without undue delay, inform the competent supervisory authorities established pursuant to Article 51 of Regulation (EU) 2016/679.

3. Where the qualified trust service provider fails to fulfil any of the requirements set out by this Regulation, the supervisory body shall require it to provide a remedy within a set time limit, if applicable.

Where that provider does not provide a remedy and, where applicable within the time limit set by the supervisory body, the supervisory body, where justified in particular by the extent, duration and consequences of that failure, shall withdraw the qualified status of that provider or of the affected service it provides.

    3a.   Where the competent authorities designated or established pursuant to Article 8(1) of Directive (EU) 2022/2555 informs the supervisory body that the qualified trust service provider fails to fulfil any of the requirements set out in Article 21 of that Directive, the supervisory body, where justified in particular by the extent, duration and consequences of that failure, shall withdraw the qualified status of that provider or of the affected service that it provides.

    3b.   Where the supervisory authorities established pursuant to Article 51 of Regulation (EU) 2016/679 informs the supervisory body that the qualified trust service provider fails to fulfil any of the requirements set out in that Regulation, the supervisory body, where justified in particular by the extent, duration and consequences of that failure, shall withdraw the qualified status of that provider or of the affected service it provides.

    3c.   The supervisory body shall inform the qualified trust service provider of the withdrawal of its qualified status or of the qualified status of the service concerned. The supervisory body shall inform the body notified pursuant to Article 22(3) of this Regulation for the purposes of updating the trusted lists referred to in paragraph 1 of that Article and the competent authority designated or established pursuant to Article 8(1) of Directive (EU) 2022/2555.

4.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the following:

    (a) the accreditation of the conformity assessment bodies and for the conformity assessment report referred to in paragraph 1;

    (b) the auditing requirements for the conformity assessment bodies to carry out their conformity assessment, including composite assessment, of the qualified trust service providers as referred to in paragraph 1;

    (c) the conformity assessment schemes for carrying out the conformity assessment of the qualified trust service providers by the conformity assessment bodies and for the provision of the report referred to in paragraph 1.

Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 21 - Initiation of a qualified trust service

1.   Where trust service providers intend to start providing a qualified trust service, they shall notify the supervisory body of their intention together with a conformity assessment report issued by a conformity assessment body confirming the fulfilment of the requirements laid down in this Regulation and in Article 21 of Directive (EU) 2022/2555.

2.   The supervisory body shall verify whether the trust service provider and the trust services provided by it comply with the requirements laid down in this Regulation and, in particular, with the requirements for qualified trust service providers and for the qualified trust services they provide.

In order to verify the compliance of the trust service provider with the requirements laid down in Article 21 of Directive (EU) 2022/2555, the supervisory body shall request the competent authorities designated or established pursuant to Article 8(1) of that Directive to carry out supervisory actions in that regard and to provide information about the outcome without undue delay and in any event within two months of receipt of that request. If the verification is not concluded within two months of the notification, those competent authorities shall inform the supervisory body specifying the reasons for the delay and the period within which the verification is to be concluded.

Where the supervisory body concludes that the trust service provider and the trust services provided by it comply with the requirements laid down in this Regulation, the supervisory body shall grant qualified status to the trust service provider and the trust services it provides and inform the body referred to in Article 22(3) for the purposes of updating the trusted lists referred to in Article 22(1), not later than three months after notification in accordance with paragraph 1 of this Article.

Where the verification is not concluded within three months of notification, the supervisory body shall inform the trust service provider specifying the reasons for the delay and the period within which the verification is to be concluded.

3.   Qualified trust service providers may begin to provide the qualified trust service after the qualified status has been indicated in the trusted lists referred to in Article 22(1).

4.   By 21 May 2025, the Commission shall, by means of implementing acts, establish the formats and procedures of the notification and verification for the purposes of paragraphs 1 and 2 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 22 - Trusted lists

1.   Each Member State shall establish, maintain and publish trusted lists, including information related to the qualified trust service providers for which it is responsible, together with information related to the qualified trust services provided by them.

2.   Member States shall establish, maintain and publish, in a secured manner, the electronically signed or sealed trusted lists referred to in paragraph 1 in a form suitable for automated processing.

3.   Member States shall notify to the Commission, without undue delay, information on the body responsible for establishing, maintaining and publishing national trusted lists, and details of where such lists are published, the certificates used to sign or seal the trusted lists and any changes thereto.

4.   The Commission shall make available to the public, through a secure channel, the information referred to in paragraph 3 in electronically signed or sealed form suitable for automated processing.

5.   By 18 September 2015 the Commission shall, by means of implementing acts, specify the information referred to in paragraph 1 and define the technical specifications and formats for trusted lists applicable for the purposes of paragraphs 1 to 4. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 23 - EU trust mark for qualified trust services

1.   After the qualified status referred to in the second subparagraph of Article 21(2) has been indicated in the trusted list referred to in Article 22(1), qualified trust service providers may use the EU trust mark to indicate in a simple, recognisable and clear manner the qualified trust services they provide.

2.   When using the EU trust mark for the qualified trust services referred to in paragraph 1, qualified trust service providers shall ensure that a link to the relevant trusted list is made available on their website.

3.   By 1 July 2015 the Commission shall, by means of implementing acts, provide for specifications with regard to the form, and in particular the presentation, composition, size and design of the EU trust mark for qualified trust services. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 24 - Requirements for qualified trust service providers

1.   When issuing a qualified certificate or a qualified electronic attestation of attributes, a qualified trust service provider shall verify the identity and, if applicable, any specific attributes of the natural or legal person to whom the qualified certificate or the qualified electronic attestation of attributes is to be issued.

    1a.   The verification of the identity referred to in paragraph 1 shall be performed, by appropriate means, by the qualified trust service provider, either directly or by means of a third party, on the basis of one of the following methods or, when needed, on a combination thereof in accordance with the implementing acts referred to in paragraph 1c:

    (a) by means of the European Digital Identity Wallet or a notified electronic identification means which meets the requirements set out in Article 8 with regard to assurance level high;

    (b) by means of a certificate of a qualified electronic signature or of a qualified electronic seal, issued in compliance with point (a), (c) or (d);

    (c) by using other identification methods which ensure the identification of the person with a high level of confidence, the conformity of which shall be confirmed by a conformity assessment body;

    (d) through the physical presence of the natural person or of an authorised representative of the legal person, by means of appropriate evidence and procedures, in accordance with national law.

    1b.   The verification of the attributes referred to in paragraph 1 shall be performed, by appropriate means, by the qualified trust service provider, either directly or by means of a third party, on the basis of one of the following methods or, where necessary, on a combination thereof, in accordance with the implementing acts referred to in paragraph 1c:

    (a) by means of the European Digital Identity Wallet or a notified electronic identification means which meets the requirements set out in Article 8 with regard to assurance level high;

    (b) by means of a certificate of a qualified electronic signature or of a qualified electronic seal, issued in accordance with paragraph 1a, point (a), (c) or (d);

    (c) by means of a qualified electronic attestation of attributes;

    (d) by using other methods, which ensure the verification of the attributes with a high level of confidence, the conformity of which shall be confirmed by a conformity assessment body;

    (e) by means of the physical presence of the natural person or of an authorised representative of the legal person, by means of appropriate evidence and procedures, in accordance with national law.

    1c.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the verification of identity and attributes in accordance with paragraphs 1, 1a and 1b of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

2.   A qualified trust service provider providing qualified trust services shall:

    (a) inform the supervisory body at least one month before implementing any change in the provision of its qualified trust services or at least three months in case of an intention to cease those activities;

    (b) employ staff and, if applicable, subcontractors who possess the necessary expertise, reliability, experience, and qualifications and who have received appropriate training regarding security and personal data protection rules and shall apply administrative and management procedures which correspond to European or international standards;

    (c) with regard to the risk of liability for damages in accordance with Article 13, maintain sufficient financial resources and/or obtain appropriate liability insurance, in accordance with national law;

    (d) before entering into a contractual relationship, inform, in a clear, comprehensive and easily accessible manner, in a publicly accessible space and individually any person seeking to use a qualified trust service of the precise terms and conditions regarding the use of that service, including any limitations on its use;

    (e) use trustworthy systems and products that are protected against modification and ensure the technical security and reliability of the processes supported by them, including using suitable cryptographic techniques;

    (f) use trustworthy systems to store data provided to it, in a verifiable form so that:

    **(i)** they are publicly available for retrieval only where the consent of the person to whom the data relates has been obtained,

    **(ii)** only authorised persons can make entries and changes to the stored data,

    **(iii)** the data can be checked for authenticity;

    (fa) notwithstanding Article 21 of Directive (EU) 2022/2555, have appropriate policies and take corresponding measures to manage legal, business, operational and other direct or indirect risks to the provision of the qualified trust service, including at least measures related to the following:

    **(i)** registration and onboarding procedures for a service;

    **(ii)** procedural or administrative checks;

    **(iii)** the management and implementation of services;

    (fb) notify the supervisory body, the identifiable affected individuals, other relevant competent bodies where applicable and, at the request of the supervisory body, the public if it is of public interest, of any security breaches or disruptions in the provision of the service or the implementation of the measures referred to in point (fa)(i), (ii) or (iii) that have a significant impact on the trust service provided or on the personal data maintained therein, without undue delay and in any event within 24 hours of the incident;

    (g) take appropriate measures against forgery, theft or misappropriation of data or, without right, deleting, altering or rendering data inaccessible;

    (h) record and keep accessible for as long as necessary after the activities of the qualified trust service provider have ceased, all relevant information concerning data issued and received by the qualified trust service provider, for the purpose of providing evidence in legal proceedings and for the purpose of ensuring continuity of the service. Such recording may be done electronically;

    **(i)**have an up-to-date termination plan to ensure the continuity of service in accordance with provisions that are verified by the supervisory body pursuant to Article 46b(4), point (i);

    **DELETED in eIDAS 2** (j) ensure lawful processing of personal data in accordance with Directive 95/46/EC;

    (k) in case of qualified trust service providers issuing qualified certificates, establish and keep updated a certificate database.

The supervisory body may request information in addition to the information notified pursuant to point (a) of the first subparagraph or the result of a conformity assessment and may condition the granting of the permission to implement the intended changes to the qualified trust services. If the verification is not concluded within three months of notification, the supervisory body shall inform the trust service provider, specifying the reasons for the delay and the period within which the verification is to be concluded.

3. If a qualified trust service provider issuing qualified certificates decides to revoke a certificate, it shall register such revocation in its certificate database and publish the revocation status of the certificate in a timely manner, and in any event within 24 hours after the receipt of the request. The revocation shall become effective immediately upon its publication.

4. With regard to paragraph 3, qualified trust service providers issuing qualified certificates shall provide to any relying party information on the validity or revocation status of qualified certificates issued by them. This information shall be made available at least on a per certificate basis at any time and beyond the validity period of the certificate in an automated manner that is reliable, free of charge and efficient.

    4a.   Paragraphs 3 and 4 shall apply accordingly to the revocation of qualified electronic attestations of attributes.

    4b.   The Commission shall be empowered to adopt delegated acts in accordance with Article 47, establishing additional measures referred to in paragraph 2, point (fa), of this Article.

5.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the requirements referred to in paragraph 2 of this Article. Compliance with the requirements laid down in this paragraph shall be presumed where those standards, specifications and procedures are met. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 24a - Recognition of qualified trust services

1.   Qualified electronic signatures based on a qualified certificate issued in one Member State and qualified electronic seals based on a qualified certificate issued in one Member State shall be recognised, respectively, as qualified electronic signatures and qualified electronic seals in all other Member States.

2.   Qualified electronic signature creation devices and qualified electronic seal creation devices certified in one Member State shall be recognised, respectively, as qualified electronic signature creation devices and qualified electronic seal creation devices in all other Member States.

3.   A qualified certificate for electronic signatures, a qualified certificate for electronic seals, a qualified trust service for the management of remote qualified electronic signature creation devices and a qualified trust service for the management of remote qualified electronic seal creation devices provided in one Member State shall be recognised, respectively, as a qualified certificate for electronic signatures, a qualified certificate for electronic seals, a qualified trust service for the management of remote qualified electronic signature creation devices and a qualified trust service for the management of remote qualified electronic seal creation devices in all other Member States.

4.   A qualified validation service for qualified electronic signatures and a qualified validation service for qualified electronic seals provided in one Member State shall be recognised, respectively, as a qualified validation service for qualified electronic signatures and a qualified validation service for qualified electronic seals in all other Member States.

5.   A qualified preservation service for qualified electronic signatures and a qualified preservation service for qualified electronic seals provided in one Member State shall be recognised, respectively, as a qualified preservation service for qualified electronic signatures and a qualified preservation service for qualified electronic seals in all other Member States.

6.   A qualified electronic time stamp provided in one Member State shall be recognised as a qualified electronic time stamp in all other Member States.

7.   A qualified certificate for website authentication issued in one Member State shall be recognised as a qualified certificate for website authentication in all other Member States.

8.   A qualified electronic registered delivery service provided in one Member State shall be recognised as a qualified electronic registered delivery service in all other Member States.

9.   A qualified electronic attestation of attributes issued in one Member State shall be recognised as a qualified electronic attestation of attributes in all other Member States.

10.   A qualified electronic archiving service provided in one Member State shall be recognised as a qualified electronic archiving service in all other Member States.

11.   A qualified electronic ledger provided in one Member State shall be recognised as a qualified electronic ledger in all other Member States.’;

## SECTION 4 - Electronic signatures

### Article 25 - Legal effects of electronic signatures

1.   An electronic signature shall not be denied legal effect and admissibility as evidence in legal proceedings solely on the grounds that it is in an electronic form or that it does not meet the requirements for qualified electronic signatures.

2.   A qualified electronic signature shall have the equivalent legal effect of a handwritten signature.

**DELETED in eIDAS 2**: 3.   A qualified electronic signature based on a qualified certificate issued in one Member State shall be recognised as a qualified electronic signature in all other Member States.

### Article 26 - Requirements for advanced electronic signatures

1. An advanced electronic signature shall meet the following requirements:

(a) it is uniquely linked to the signatory;

(b) it is capable of identifying the signatory;

(c) it is created using electronic signature creation data that the signatory can, with a high level of confidence, use under his sole control; and

(d) it is linked to the data signed therewith in such a way that any subsequent change in the data is detectable.

2.   By 21 May 2026, the Commission shall assess whether it is necessary to adopt implementing acts to establish a list of reference standards and, where necessary, establish specifications and procedures for advanced electronic signatures. On the basis of that assessment, the Commission may adopt such implementing acts. Compliance with the requirements for advanced electronic signatures shall be presumed where an advanced electronic signature complies with the standards, specifications and procedures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 27 Electronic signatures in public services

1.   If a Member State requires an advanced electronic signature to use an online service offered by, or on behalf of, a public sector body, that Member State shall recognise advanced electronic signatures, advanced electronic signatures based on a qualified certificate for electronic signatures, and qualified electronic signatures in at least the formats or using methods defined in the implementing acts referred to in paragraph 5.

2.   If a Member State requires an advanced electronic signature based on a qualified certificate to use an online service offered by, or on behalf of, a public sector body, that Member State shall recognise advanced electronic signatures based on a qualified certificate and qualified electronic signatures in at least the formats or using methods defined in the implementing acts referred to in paragraph 5.

3.   Member States shall not request for cross-border use in an online service offered by a public sector body an electronic signature at a higher security level than the qualified electronic signature.

**DELETED in eIDAS 2**: 4.   The Commission may, by means of implementing acts, establish reference numbers of standards for advanced electronic signatures. Compliance with the requirements for advanced electronic signatures referred to in paragraphs 1 and 2 of this Article and in Article 26 shall be presumed when an advanced electronic signature meets those standards. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

5.   By 18 September 2015, and taking into account existing practices, standards and Union legal acts, the Commission shall, by means of implementing acts, define reference formats of advanced electronic signatures or reference methods where alternative formats are used. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 28 - Qualified certificates for electronic signatures

1.   Qualified certificates for electronic signatures shall meet the requirements laid down in Annex I.

2.   Qualified certificates for electronic signatures shall not be subject to any mandatory requirement exceeding the requirements laid down in Annex I.

3.   Qualified certificates for electronic signatures may include non-mandatory additional specific attributes. Those attributes shall not affect the interoperability and recognition of qualified electronic signatures.

4.   If a qualified certificate for electronic signatures has been revoked after initial activation, it shall lose its validity from the moment of its revocation, and its status shall not in any circumstances be reverted.

5.   Subject to the following conditions, Member States may lay down national rules on temporary suspension of a qualified certificate for electronic signature:

(a) if a qualified certificate for electronic signature has been temporarily suspended that certificate shall lose its validity for the period of suspension;

(b) the period of suspension shall be clearly indicated in the certificate database and the suspension status shall be visible, during the period of suspension, from the service providing information on the status of the certificate.

6.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for qualified certificates for electronic signature. Compliance with the requirements laid down in Annex I shall be presumed where a qualified certificate for electronic signature complies with those standards, specifications and procedures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 29 - Requirements for qualified electronic signature creation devices

1.   Qualified electronic signature creation devices shall meet the requirements laid down in Annex II.

    1a.   Generating or managing electronic signature creation data or duplicating such signature creation data for back-up purposes shall be carried out only on behalf of the signatory, at the request of the signatory, and by a qualified trust service provider providing a qualified trust service for the management of a remote qualified electronic signature creation device.

2.   The Commission may, by means of implementing acts, establish reference numbers of standards for qualified electronic signature creation devices. Compliance with the requirements laid down in Annex II shall be presumed where a qualified electronic signature creation device meets those standards. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 29a - Requirements for a qualified service for the management of remote qualified electronic signature creation devices

1.   The management of remote qualified electronic signature creation devices as a qualified service shall be carried out only by a qualified trust service provider that:

(a) generates or manages electronic signature creation data on behalf of the signatory;

(b) notwithstanding point (1)(d) of Annex II, duplicates the electronic signature creation data for back-up purposes only, provided that the following requirements are met:

(i) the security of the duplicated datasets must be at the same level as for the original datasets;

(ii) the number of duplicated datasets must not exceed the minimum needed to ensure continuity of the service;

(c) complies with any requirements identified in the certification report of the specific remote qualified electronic signature creation device issued pursuant to Article 30.

2.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, specifications and procedures for the purposes of paragraph 1 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 30 - Certification of qualified electronic signature creation devices

1.   Conformity of qualified electronic signature creation devices with the requirements laid down in Annex II shall be certified by appropriate public or private bodies designated by Member States.

2.   Member States shall notify to the Commission the names and addresses of the public or private body referred to in paragraph 1. The Commission shall make that information available to Member States.

3.   The certification referred to in paragraph 1 shall be based on one of the following:

    (a) a security evaluation process carried out in accordance with one of the standards for the security assessment of information technology products included in the list established in accordance with the second subparagraph; or

    (b) a process other than the process referred to in point (a), provided that it uses comparable security levels and provided that the public or private body referred to in paragraph 1 notifies that process to the Commission. That process may be used only in the absence of standards referred to in point (a) or when a security evaluation process referred to in point (a) is ongoing.

    The Commission shall, by means of implementing acts, establish a list of standards for the security assessment of information technology products referred to in point (a). Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

3a. The validity of a certification referred to in paragraph 1 shall not exceed five years, provided that vulnerabilities assessments are carried out every two years. Where vulnerabilities are identified and not remedied, the certification shall be cancelled.

4.   The Commission shall be empowered to adopt delegated acts in accordance with Article 47 concerning the establishment of specific criteria to be met by the designated bodies referred to in paragraph 1 of this Article.

### Article 31 - Publication of a list of certified qualified electronic signature creation devices

1.   Member States shall notify to the Commission without undue delay and no later than one month after the certification is concluded, information on qualified electronic signature creation devices that have been certified by the bodies referred to in Article 30(1). They shall also notify to the Commission, without undue delay and no later than one month after the certification is cancelled, information on electronic signature creation devices that are no longer certified.

2.   On the basis of the information received, the Commission shall establish, publish and maintain a list of certified qualified electronic signature creation devices.

3.   By 21 May 2025, the Commission shall, by means of implementing acts, establish the formats and procedures applicable for the purpose of paragraph 1 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 32 - Requirements for the validation of qualified electronic signatures

1.   The process for the validation of a qualified electronic signature shall confirm the validity of a qualified electronic signature provided that:

(a) the certificate that supports the signature was, at the time of signing, a qualified certificate for electronic signature complying with Annex I;

(b) the qualified certificate was issued by a qualified trust service provider and was valid at the time of signing;

(c) the signature validation data corresponds to the data provided to the relying party;

(d) the unique set of data representing the signatory in the certificate is correctly provided to the relying party;

(e) the use of any pseudonym is clearly indicated to the relying party if a pseudonym was used at the time of signing;

(f) the electronic signature was created by a qualified electronic signature creation device;

(g) the integrity of the signed data has not been compromised;

(h) the requirements provided for in Article 26 were met at the time of signing.

Compliance with the requirements laid down in the first subparagraph of this paragraph shall be presumed where the validation of qualified electronic signatures complies with the standards, specifications and procedures referred to in paragraph 3.

2.   The system used for validating the qualified electronic signature shall provide to the relying party the correct result of the validation process and shall allow the relying party to detect any security relevant issues.

3.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the validation of qualified electronic signatures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 32a - Requirements for the validation of advanced electronic signatures based on qualified certificates

1.   The process for the validation of an advanced electronic signature based on a qualified certificate shall confirm the validity of an advanced electronic signature based on a qualified certificate, provided that:

    (a) the certificate that supports the signature was, at the time of signing, a qualified certificate for electronic signature complying with Annex I;

    (b) the qualified certificate was issued by a qualified trust service provider and was valid at the time of signing;

    (c) the signature validation data corresponds to the data provided to the relying party;

    (d) the unique set of data representing the signatory in the certificate is correctly provided to the relying party;

    (e) the use of any pseudonym is clearly indicated to the relying party if a pseudonym was used at the time of signing;

    (f) the integrity of the signed data has not been compromised;

    (g) the requirements provided for in Article 26 were met at the time of signing.

2.   The system used for validating the advanced electronic signature based on qualified certificate shall provide to the relying party the correct result of the validation process and shall allow the relying party to detect any security relevant issues.

3.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the validation of advanced electronic signatures based on qualified certificates. Compliance with the requirements laid down in paragraph 1 of this Article shall be presumed where the validation of advanced electronic signature based on qualified certificates complies with those standards, specifications and procedures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 33 - Qualified validation service for qualified electronic signatures

1.   A qualified validation service for qualified electronic signatures may only be provided by a qualified trust service provider who:

(a) provides validation in compliance with Article 32(1); and

(b) allows relying parties to receive the result of the validation process in an automated manner, which is reliable, efficient and bears the advanced electronic signature or advanced electronic seal of the provider of the qualified validation service.

2.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for qualified validation service referred to in paragraph 1 of this Article. Compliance with the requirements laid down in paragraph 1 of this Article shall be presumed where the qualified validation service for qualified electronic signatures complies with those standards, specifications and procedures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 34 - Qualified preservation service for qualified electronic signatures

1.   A qualified preservation service for qualified electronic signatures may only be provided by a qualified trust service provider that uses procedures and technologies capable of extending the trustworthiness of the qualified electronic signature beyond the technological validity period.

1a.   Compliance with the requirements laid down in paragraph 1 shall be presumed where the arrangements for the qualified preservation service for qualified electronic signatures complies with the standards, specifications and procedures referred to in paragraph 2.

2.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the qualified preservation service for qualified electronic signatures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

## SECTION 5 - Electronic seals

### Article 35 - Legal effects of electronic seals

1.   An electronic seal shall not be denied legal effect and admissibility as evidence in legal proceedings solely on the grounds that it is in an electronic form or that it does not meet the requirements for qualified electronic seals.

2.   A qualified electronic seal shall enjoy the presumption of integrity of the data and of correctness of the origin of that data to which the qualified electronic seal is linked.

**DELETED in eiDAS 2**: 3.   A qualified electronic seal based on a qualified certificate issued in one Member State shall be recognised as a qualified electronic seal in all other Member States.

### Article 36 - Requirements for advanced electronic seals

1. An advanced electronic seal shall meet the following requirements:

    (a) it is uniquely linked to the creator of the seal;

    (b) it is capable of identifying the creator of the seal;

    (c) it is created using electronic seal creation data that the creator of the seal can, with a high level of confidence under its control, use for electronic seal creation; and

    (d) it is linked to the data to which it relates in such a way that any subsequent change in the data is detectable.

2. By 21 May 2026, the Commission shall assess whether it is necessary to adopt implementing acts to establish a list of reference standards and, where necessary, establish specifications and procedures for advanced electronic seals. On the basis of that assessment, the Commission may adopt such implementing acts. Compliance with the requirements for advanced electronic seals shall be presumed where an advanced electronic seal complies with those standards, specifications and procedures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 37 - Electronic seals in public services

1.   If a Member State requires an advanced electronic seal in order to use an online service offered by, or on behalf of, a public sector body, that Member State shall recognise advanced electronic seals, advanced electronic seals based on a qualified certificate for electronic seals and qualified electronic seals at least in the formats or using methods defined in the implementing acts referred to in paragraph 5.

2.   If a Member State requires an advanced electronic seal based on a qualified certificate in order to use an online service offered by, or on behalf of, a public sector body, that Member State shall recognise advanced electronic seals based on a qualified certificate and qualified electronic seal at least in the formats or using methods defined in the implementing acts referred to in paragraph 5.

3.   Member States shall not request for the cross-border use in an online service offered by a public sector body an electronic seal at a higher security level than the qualified electronic seal.

**DELETED in eiDAS 2**:4.   The Commission may, by means of implementing acts, establish reference numbers of standards for advanced electronic seals. Compliance with the requirements for advanced electronic seals referred to in paragraphs 1 and 2 of this Article and Article 36 shall be presumed when an advanced electronic seal meets those standards. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

5.   By 18 September 2015, and taking into account existing practices, standards and legal acts of the Union, the Commission shall, by means of implementing acts, define reference formats of advanced electronic seals or reference methods where alternative formats are used. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 38 - Qualified certificates for electronic seals

1.   Qualified certificates for electronic seals shall meet the requirements laid down in Annex III.

2.   Qualified certificates for electronic seals shall not be subject to any mandatory requirements exceeding the requirements laid down in Annex III.

3.   Qualified certificates for electronic seals may include non-mandatory additional specific attributes. Those attributes shall not affect the interoperability and recognition of qualified electronic seals.

4.   If a qualified certificate for an electronic seal has been revoked after initial activation, it shall lose its validity from the moment of its revocation, and its status shall not in any circumstances be reverted.

5.   Subject to the following conditions, Member States may lay down national rules on temporary suspension of qualified certificates for electronic seals:

    (a) if a qualified certificate for electronic seal has been temporarily suspended, that certificate shall lose its validity for the period of suspension;

    (b) the period of suspension shall be clearly indicated in the certificate database and the suspension status shall be visible, during the period of suspension, from the service providing information on the status of the certificate.

6.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for qualified certificates for electronic seals. Compliance with the requirements laid down in Annex III shall be presumed where a qualified certificate for electronic seal complies with those standards, specifications and procedures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 39 - Qualified electronic seal creation devices

1.   Article 29 shall apply mutatis mutandis to requirements for qualified electronic seal creation devices.

2.   Article 30 shall apply mutatis mutandis to the certification of qualified electronic seal creation devices.

3.   Article 31 shall apply mutatis mutandis to the publication of a list of certified qualified electronic seal creation devices.


### Article 39a - Requirements for a qualified service for the management of remote qualified electronic seal creation devices

Article 29a shall apply mutatis mutandis to a qualified service for the management of remote qualified electronic seal creation devices.

### Article 40 - Validation and preservation of qualified electronic seals

Articles 32, 33 and 34 shall apply mutatis mutandis to the validation and preservation of qualified electronic seals.

### Article 40a - Requirements for the validation of advanced electronic seals based on qualified certificates

Article 32a shall apply mutatis mutandis to the validation of advanced electronic seals based on qualified certificates.

## SECTION 6 - Electronic time stamps

### Article 41 - Legal effect of electronic time stamps

1.   An electronic time stamp shall not be denied legal effect and admissibility as evidence in legal proceedings solely on the grounds that it is in an electronic form or that it does not meet the requirements of the qualified electronic time stamp.

2.   A qualified electronic time stamp shall enjoy the presumption of the accuracy of the date and the time it indicates and the integrity of the data to which the date and time are bound.

**DELETED in eiDAS 2**:3.   A qualified electronic time stamp issued in one Member State shall be recognised as a qualified electronic time stamp in all Member States.

### Article 42 - Requirements for qualified electronic time stamps

1.   A qualified electronic time stamp shall meet the following requirements:

(a) it binds the date and time to data in such a manner as to reasonably preclude the possibility of the data being changed undetectably;

(b) it is based on an accurate time source linked to Coordinated Universal Time; and

(c) it is signed using an advanced electronic signature or sealed with an advanced electronic seal of the qualified trust service provider, or by some equivalent method.

1a.   Compliance with the requirements laid down in paragraph 1 shall be presumed where the binding of date and time to data and the accuracy of the time source comply with the standards, specifications and procedures referred to in paragraph 2.

2.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the binding of date and time to data and for establishing the accuracy of time sources. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

## SECTION 7 - Electronic registered delivery services

### Article 43 - Legal effect of an electronic registered delivery service

1.   Data sent and received using an electronic registered delivery service shall not be denied legal effect and admissibility as evidence in legal proceedings solely on the grounds that it is in an electronic form or that it does not meet the requirements of the qualified electronic registered delivery service.

2.   Data sent and received using a qualified electronic registered delivery service shall enjoy the presumption of the integrity of the data, the sending of that data by the identified sender, its receipt by the identified addressee and the accuracy of the date and time of sending and receipt indicated by the qualified electronic registered delivery service.

### Article 44 - Requirements for qualified electronic registered delivery services

1.   Qualified electronic registered delivery services shall meet the following requirements:

    (a) they are provided by one or more qualified trust service provider(s);

    (b) they ensure with a high level of confidence the identification of the sender;

    (c) they ensure the identification of the addressee before the delivery of the data;

    (d) the sending and receiving of data is secured by an advanced electronic signature or an advanced electronic seal of a qualified trust service provider in such a manner as to preclude the possibility of the data being changed undetectably;

    (e) any change of the data needed for the purpose of sending or receiving the data is clearly indicated to the sender and addressee of the data;

    (f) the date and time of sending, receiving and any change of data are indicated by a qualified electronic time stamp.

In the event of the data being transferred between two or more qualified trust service providers, the requirements in points (a) to (f) shall apply to all the qualified trust service providers.

1a.   Compliance with the requirements laid down in paragraph 1 shall be presumed where the process for sending and receiving data complies with the standards, specifications and procedures referred to in paragraph 2.

2.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for processes for sending and receiving data. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

2a.   Providers of qualified electronic registered delivery services may agree on interoperability between qualified electronic registered delivery services which they provide. Such interoperability framework shall comply with the requirements laid down in paragraph 1 and such compliance shall be confirmed by a conformity assessment body.

2b.   The Commission may, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the interoperability framework referred to in paragraph 2a of this Article. The technical specifications and content of standards shall be cost-effective and proportionate. The implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

## SECTION 8 - Website authentication

### Article 45 - Requirements for qualified certificates for website authentication

1.   Qualified certificates for website authentication shall meet the requirements laid down in Annex IV. The evaluation of compliance with those requirements shall be carried out in accordance with the standards, specifications and procedures referred to in paragraph 2 of this Article.

1a.   Qualified certificates for website authentication issued in accordance with paragraph 1 of this Article shall be recognised by providers of web-browsers. Providers of web-browsers shall ensure that the identity data attested in the certificate and additional attested attributes are displayed in a user-friendly manner. Providers of web-browsers shall ensure support and interoperability with qualified certificates for website authentication referred to in paragraph 1 of this Article, with the exception of microenterprises or small enterprises as defined in Article 2 of the Annex to Recommendation 2003/361/EC during the first five years of operating as providers of web-browsing services.

1b.   Qualified certificates for website authentication shall not be subject to any mandatory requirements other than the requirements laid down in paragraph 1.

2.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for qualified certificates for website authentication, referred to in paragraph 1 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 45a - Cybersecurity precautionary measures

1.   Providers of web-browsers shall not take any measures contrary to their obligations set out in Article 45, in particular the requirements to recognise qualified certificates for website authentication and to display the identity data provided in a user-friendly manner.

2.   By way of derogation from paragraph 1 and only in the event of substantiated concerns related to security breaches or the loss of integrity of an identified certificate or set of certificates, providers of web-browsers may take precautionary measures in relation to that certificate or set of certificates.

3.   Where a provider of a web-browser takes precautionary measures pursuant to paragraph 2, the provider of the web-browser shall notify its concerns in writing, without undue delay, together with a description of the measures taken to mitigate those concerns, to the Commission, the competent supervisory body, the entity to whom the certificate was issued and to the qualified trust service provider that issued that certificate or set of certificates. Upon receipt of such a notification, the competent supervisory body shall issue an acknowledgement of receipt to the provider of the web-browser in question.

4.   The competent supervisory body shall investigate the issues raised in the notification in accordance with Article 46b(4), point (k). Where the outcome of that investigation does not result in the withdrawal of the qualified status of the certificate, the supervisory body shall inform the provider of the web-browser accordingly and shall request that provider to put an end to the precautionary measures referred to in paragraph 2 of this Article.

## SECTION 9 - ELECTRONIC ATTESTATION OF ATTRIBUTES

### Article 45b - Legal effects of electronic attestation of attributes

1.   An electronic attestation of attributes shall not be denied legal effect or admissibility as evidence in legal proceedings on the sole ground that it is in electronic form or that it does not meet the requirements for qualified electronic attestations of attributes.

2.   A qualified electronic attestation of attributes and attestations of attributes issued by, or on behalf of, a public sector body responsible for an authentic source shall have the same legal effect as lawfully issued attestations in paper form.

3.   An attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source in one Member State shall be recognised as an attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source in all Member States.

### Article 45c - Electronic attestation of attributes in public services

Where an electronic identification using an electronic identification means and authentication is required under national law to access an online service provided by a public sector body, person identification data in the electronic attestation of attributes shall not substitute electronic identification using an electronic identification means and authentication for electronic identification unless specifically allowed by the Member State. In such a case, qualified electronic attestation of attributes from other Member States shall also be accepted.

### Article 45d - Requirements for qualified electronic attestation of attributes

1.   Qualified electronic attestation of attributes shall meet the requirements laid down in Annex V.

2.   The evaluation of compliance with the requirements laid down in Annex V shall be carried out in accordance with the standards, specifications and procedures referred to in paragraph 5 of this Article.

3.   Qualified electronic attestations of attributes shall not be subject to any mandatory requirement in addition to the requirements laid down in Annex V.

4.   Where a qualified electronic attestation of attributes has been revoked after initial issuance, it shall lose its validity from the moment of its revocation and its status shall not in any circumstances be reverted.

5.   By 21 November 2024, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for qualified electronic attestations of attributes. Those implementing acts shall be consistent with the implementing acts referred to in Article 5a(23) on the implementation of the European Digital Identity Wallet. They shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 45e - Verification of attributes against authentic sources

1.   Member States shall ensure, within 24 months of the date of entry into force of the implementing acts referred to in Articles 5a(23) and 5c(6), that, at least for the attributes listed in Annex VI, wherever those attributes rely on authentic sources within the public sector, measures are taken to allow qualified trust service providers of electronic attestations of attributes to verify those attributes by electronic means at the request of the user, in accordance with Union or national law.

2.   By 21 November 2024, the Commission shall, taking into account relevant international standards, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the catalogue of attributes, as well as schemes for the attestation of attributes and verification procedures for qualified electronic attestations of attributes for the purposes of paragraph 1 of this Article. Those implementing acts shall be consistent with the implementing acts referred to in Article 5a(23) on the implementation of the European Digital Identity Wallet. They shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 45f - Requirements for electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source

1.   An electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source shall meet the following requirements:

    (a) those set out in Annex VII;

    (b) the qualified certificate supporting the qualified electronic signature or qualified electronic seal of the public sector body referred to in Article 3, point (46), identified as the issuer referred to in point (b), of Annex VII, containing a specific set of certified attributes in a form suitable for automated processing and:

    **(i)** indicating that the issuing body is established in accordance with Union or national law as the responsible for the authentic source on the basis of which the electronic attestation of attributes is issued or as the body designated to act on its behalf;

    **(ii)** providing a set of data unambiguously representing the authentic source referred to in point (i); and

    **(iii)** identifying the Union or national law referred to in point (i).

2.   The Member State where public sector bodies referred to in Article 3, point (46), are established shall ensure that the public sector bodies that issue electronic attestations of attributes meet a level of reliability and trustworthiness equivalent to qualified trust service providers in accordance with Article 24.

3.   Member States shall notify public sector bodies referred to in Article 3, point (46), to the Commission. That notification shall include a conformity assessment report issued by a conformity assessment body confirming that the requirements set out in paragraphs 1, 2 and 6 of this Article are met. The Commission shall make available to the public, through a secure channel, the list of public sector bodies referred to in Article 3, point (46), in electronically signed or sealed form suitable for automated processing.

4.   Where an electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source has been revoked after initial issuance, it shall lose its validity from the moment of its revocation and its status shall not be reverted.

5.   An electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source shall be deemed to be compliant with the requirements laid down in paragraph 1, where it complies with the standards, specifications and procedures referred to in paragraph 6.

6.   By 21 November 2024, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source. Those implementing acts shall be consistent with the implementing acts referred to in Article 5a(23) on the implementation of the European Digital Identity Wallet. They shall be adopted in accordance with the examination procedure referred to in Article 48(2).

7.   By 21 November 2024, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the purposes of paragraph 3 of this Article. Those implementing acts shall be consistent with the implementing acts referred to in Article 5a(23) on the implementation of the European Digital Identity Wallet. They shall be adopted in accordance with the examination procedure referred to in Article 48(2).

8.   Public sector bodies referred to in Article 3, point (46), issuing electronic attestation of attributes shall provide an interface with European Digital Identity Wallets that are provided in accordance with Article 5a.

### Article 45g - Issuing of electronic attestation of attributes to European Digital Identity Wallets

1.   Providers of electronic attestations of attributes shall provide European Digital Identity Wallet users with the possibility to request, obtain, store and manage the electronic attestation of attributes irrespective of the Member State where the European Digital Identity Wallet is provided.

2.   Providers of qualified electronic attestations of attributes shall provide an interface with European Digital Identity Wallets that are provided in accordance in Article 5a.

### Article 45h - Additional rules for the provision of electronic attestation of attributes services

1.   Providers of qualified and non-qualified electronic attestation of attributes services shall not combine personal data relating to the provision of those services with personal data from any other services offered by them or their commercial partners.

2.   Personal data relating to the provision of electronic attestation of attributes services shall be kept logically separate from other data held by the provider of electronic attestation of attributes.

3.   Providers of qualified electronic attestation of attributes’ services shall implement the provision of such qualified trust services in a manner that is functionally separate from other services provided by them.

## SECTION 10 - ELECTRONIC ARCHIVING SERVICES

### Article 45i - Legal effect of electronic archiving services

1.   Electronic data and electronic documents preserved using an electronic archiving service shall not be denied legal effect or admissibility as evidence in legal proceedings on the sole ground that they are in electronic form or that they are not preserved using a qualified electronic archiving service.

2.   Electronic data and electronic documents preserved using a qualified electronic archiving service shall enjoy the presumption of their integrity and of their origin for the duration of the preservation period by the qualified trust service provider.

### Article 45j - Requirements for qualified electronic archiving services

1.   Qualified electronic archive services shall meet the following requirements:

    (a) they are provided by qualified trust service providers;

    (b) they use procedures and technologies capable of ensuring the durability and legibility of electronic data and electronic documents beyond the technological validity period and at least throughout the legal or contractual preservation period, while maintaining their integrity and the accuracy of their origin;

    (c) they ensure that those electronic data and those electronic documents are preserved in such a way that they are safeguarded against loss and alteration, except for changes concerning their medium or electronic format;

    (d) they shall allow authorised relying parties to receive a report in an automated manner that confirms that electronic data and electronic documents retrieved from a qualified electronic archive enjoy the presumption of integrity of the data from the beginning of the preservation period to the moment of retrieval.

The report referred to in point (d) of the first subparagraph shall be provided in a reliable and efficient way and shall bear the qualified electronic signature or qualified electronic seal of the provider of the qualified electronic archiving service.

2.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for qualified electronic archiving services. Compliance with the requirements for qualified electronic archive services shall be presumed where a qualified electronic archive service complies with those standards, specifications and procedures. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

## SECTION 11 - ELECTRONIC LEDGERS

### Article 45k - Legal effects of electronic ledgers

1.   An electronic ledger shall not be denied legal effect or admissibility as evidence in legal proceedings solely on the grounds that it is in an electronic form or that it does not meet the requirements for qualified electronic ledgers.

2.   Data records contained in a qualified electronic ledger shall enjoy the presumption of their unique and accurate sequential chronological ordering and of their integrity.

### Article 45l - Requirements for qualified electronic ledgers

1.   Qualified electronic ledgers shall meet the following requirements:

    (a) they are created and managed by one or more qualified trust service providers;

    (b) they establish the origin of data records in the ledger;

    (c) they ensure the unique sequential chronological ordering of data records in the ledger;

    (d) they record data in such a way that any subsequent change to the data is immediately detectable, ensuring their integrity over time.

2.   Compliance with the requirements laid down in paragraph 1 shall be presumed where an electronic ledger complies with the standards, specifications and procedures referred to in paragraph 3.

3.   By 21 May 2025, the Commission shall, by means of implementing acts, establish a list of reference standards and, where necessary, establish specifications and procedures for the requirements laid down in paragraph 1 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

## CHAPTER IV - ELECTRONIC DOCUMENTS

### Article 46 - Legal effects of electronic documents

An electronic document shall not be denied legal effect and admissibility as evidence in legal proceedings solely on the grounds that it is in electronic form.

## CHAPTER IVa - GOVERNANCE FRAMEWORK

### Article 46a - Supervision of the European Digital Identity Wallet Framework

1.   Member States shall designate one or more supervisory bodies established in their territory.

The supervisory bodies designated pursuant to the first subparagraph shall be given the necessary powers and adequate resources for the exercise of their tasks in an effective, efficient and independent manner.

2.   Member States shall notify to the Commission the names and the addresses of their supervisory bodies designated pursuant to paragraph 1 and any subsequent changes thereto. The Commission shall publish a list of the notified supervisory bodies.

3.   The role of the supervisory bodies designated pursuant to paragraph 1 shall be:

    (a) to supervise providers of European Digital Identity Wallets established in the designating Member State and to ensure, by means of ex ante and ex post supervisory activities, that those providers and European Digital Identity Wallets they provide meet the requirements laid down in this Regulation;

    (b) to take action, if necessary, in relation to providers of European Digital Identity Wallets established in the territory of the designating Member State, by means of ex post supervisory activities, when informed that providers or European Digital Identity Wallets that they provide infringe this Regulation.

4.   The tasks of the supervisory bodies designated pursuant to paragraph 1 shall include, in particular, the following:

    (a) to cooperate with other supervisory bodies and to provide them with assistance in accordance with Articles 46c and 46e;

    (b) to request information necessary to monitor compliance with this Regulation;

    (c) to inform the relevant competent authorities designated or established pursuant to Article 8(1) of Directive (EU) 2022/2555 of the Member States concerned of any significant security breaches or loss of integrity of which they become aware in the performance of their tasks and, in the case of a significant security breach or loss of integrity which concerns other Member States, to inform the single point of contact designated or established pursuant to Article 8(3) of Directive (EU) 2022/2555 of the Member State concerned and the single points of contact designated pursuant to Article 46c(1) of this Regulation in the other Member States concerned, and to inform the public or require providers of European Digital Identity Wallet to do so where the supervisory body determines that disclosure of the security breach or of the loss of integrity would be in the public interest;

    (d) to carry out on-site inspections and off-site supervision;

    (e) to require that providers of European Digital Identity Wallets remedy any failure to fulfil the requirements laid down in this Regulation;

    (f) to suspend or cancel the registration and inclusion of relying parties in the mechanism referred to in Article 5b(7) in the case of illegal or fraudulent use of the European Digital Identity Wallet;

    (g) to cooperate with competent supervisory authorities established pursuant to Article 51 of Regulation (EU) 2016/679, in particular, by informing them without undue delay, where personal data protection rules appear to have been infringed and about security breaches which appear to constitute personal data breaches.

5.   Where the supervisory body designated pursuant to paragraph 1 requires the provider of a European Digital Identity Wallet to remedy any failure to fulfil requirements under this Regulation pursuant to paragraph 4, point (e), and that provider does not act accordingly and, if applicable, within a time limit set by that supervisory body, the supervisory body designated pursuant to paragraph 1 may, taking into account, in particular, the extent, duration and consequences of that failure, order the provider to suspend or to cease the provision of the European Digital Identity Wallet. The supervisory body shall inform the supervisory bodies of other Member States, the Commission, relying parties and users of the European Digital Identity Wallet without undue delay of the decision to require the suspension or cessation of the provision of the European Digital Identity Wallet.

6.   By 31 March each year, each supervisory body designated pursuant to paragraph 1 shall submit to the Commission a report on its main activities in the previous calendar year. The Commission shall make those annual reports available to the European Parliament and the Council.

7.   By 21 May 2025, the Commission shall, by means of implementing acts, establish the formats and procedures for the report referred to in paragraph 6 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 46b - Supervision of trust services

1.   Member States shall designate a supervisory body established in their territory or designate, upon mutual agreement with another Member State, a supervisory body established in that other Member State. That supervisory body shall be responsible for supervisory tasks in the designating Member State as regards trust services.

The supervisory bodies designated pursuant to the first subparagraph shall be given the necessary powers and adequate resources for the exercise of their tasks.

2.   Member States shall notify to the Commission the names and addresses of their supervisory bodies designated pursuant to paragraph 1 and any subsequent changes thereto. The Commission shall publish a list of the notified supervisory bodies.

3.   The role of the supervisory bodies designated pursuant to paragraph 1 shall be:

    (a) to supervise qualified trust service providers established in the territory of the designating Member State and to ensure, by means of ex ante and ex post supervisory activities, that those qualified trust service providers and the qualified trust services that they provide meet the requirements laid down in this Regulation;

    (b) to take action, if necessary, in relation to non-qualified trust service providers established in the territory of the designating Member State, by means of ex post supervisory activities, when informed that those non-qualified trust service providers or the trust services they provide allegedly do not meet the requirements laid down in this Regulation.

4.   The tasks of the supervisory body designated pursuant to paragraph 1 shall include in particular the following:

    (a) to inform the relevant competent authorities designated or established pursuant to Article 8(1) of Directive (EU) 2022/2555 of the Member States concerned of any significant security breach or loss of integrity of which it becomes aware in the performance of its tasks and, in the case of a significant security breach or loss of integrity which concerns other Member States, to inform the single point of contact designated or established pursuant to Article 8(3) Directive (EU) 2022/2555 of the Member State concerned and the single points of contact designated pursuant to Article 46c(1) of this Regulation in the other Member States concerned, and to inform the public or require the trust service provider to do so where the supervisory body determines that disclosure of the breach of security or loss of integrity would be in the public interest;

    (b) to cooperate with other supervisory bodies and to provide them with assistance in accordance with Articles 46c and 46e;

    (c) to analyse the conformity assessment reports referred to in Article 20(1) and Article 21(1);

    (d) to report to the Commission about its main activities in accordance with paragraph 6 of this Article;

    (e) to carry out audits or request a conformity assessment body to perform a conformity assessment of the qualified trust service providers in accordance with Article 20(2);

    (f) to cooperate with competent supervisory authorities established pursuant to Article 51 of Regulation (EU) 2016/679, in particular, by informing them, without undue delay, where personal data protection rules appear to have been breached and about security breaches which appear to constitute personal data breaches;

    (g) to grant qualified status to trust service providers and to the services they provide, and to withdraw that status in accordance with Articles 20 and 21;

    (h) to inform the body responsible for the national trusted list referred to in Article 22(3) of its decisions to grant or withdraw qualified status, unless that body is also the supervisory body designated pursuant to paragraph 1 of this Article;

    (i) to verify the existence and correct application of provisions on termination plans where the qualified trust service provider ceases its activities, including how information is kept accessible in accordance with Article 24(2), point (h);

    (j) to require that trust service providers remedy any failure to fulfil the requirements laid down in this Regulation;

    (k) to investigate claims made by providers of web-browsers pursuant to Article 45a and to take action if necessary.

5.   Member States may require the supervisory body designated pursuant to paragraph 1 to establish, maintain and update a trust infrastructure in accordance with national law.

6.   By 31 March each year, each supervisory body designated pursuant to paragraph 1 shall submit to the Commission a report on its main activities in the previous calendar year. The Commission shall make those annual reports available to the European Parliament and the Council.

7.   By 21 May 2025, the Commission shall adopt guidelines on the exercise by the supervisory bodies designated pursuant to paragraph 1 of this Article of the tasks referred to in paragraph 4 of this Article, and, by means of implementing acts, establish the formats and procedures for the report referred to in paragraph 6 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

### Article 46c - Single points of contact

1.   Each Member State shall designate a single point of contact for trust services, European Digital Identity Wallets and notified electronic identification schemes.

2.   Each single point of contact shall exercise a liaison function to facilitate cross-border cooperation between the supervisory bodies for trust service providers and between the supervisory bodies for the providers of European Digital Identity Wallets and, where appropriate, with the Commission and European Union Agency for Cybersecurity (ENISA) and with other competent authorities within its Member State.

3.   Each Member State shall make public and, without undue delay, notify to the Commission the names and the addresses of the single point of contact designated pursuant to paragraph 1 and any subsequent change thereto.

4.   The Commission shall publish a list of the single points of contact notified pursuant to paragraph 3.

### Article 46d - Mutual assistance

1.   In order to facilitate the supervision and enforcement of obligations under this Regulation, the supervisory bodies designated pursuant to Article 46a(1) and Article 46b(1) may seek, including through the Cooperation Group established pursuant to Article 46e(1), mutual assistance from the supervisory bodies of another Member State where the provider of the European Digital Identity Wallet or the trust service provider is established, or where its network and information systems are located or its services are provided.

2.   The mutual assistance shall at least entail that:

    (a) the supervisory body applying supervisory and enforcement measures in one Member State shall inform and consult the supervisory body from the other Member State concerned;

    (b) a supervisory body may request the supervisory body of another Member State concerned to take supervisory or enforcement measures, including, for instance, requests to carry out inspections related to the conformity assessment reports as referred to in Articles 20 and 21 regarding the provision of trust services;

    (c) where appropriate, supervisory bodies may carry out joint investigations with the supervisory bodies of other Member States.

    The arrangements and procedures for joint actions under the first subparagraph shall be agreed upon and established by the Member States concerned in accordance with their national law.

3.   A supervisory body to which a request for assistance is addressed may refuse that request on any of the following grounds:

    (a) the assistance requested is not proportionate to the supervisory activities of the supervisory body carried out in accordance with Articles 46a and 46b;

    (b) the supervisory body is not competent to provide the requested assistance;

    (c) providing the requested assistance would be incompatible with this Regulation.

4.   By 21 May 2025 and every two years thereafter, the Cooperation Group established pursuant to Article 46e(1) shall issue guidance on the organisational aspects and procedures for the mutual assistance referred to in paragraphs 1 and 2 of this Article.

### Article 46e- The European Digital Identity Cooperation Group

1.   In order to support and facilitate Member States’ cross-border cooperation and exchange of information on trust services, European Digital Identity Wallets and notified electronic identification schemes, the Commission shall establish a European Digital Identity Cooperation Group (the “Cooperation Group”).

2.   The Cooperation Group shall be composed of representatives appointed by the Member States and of the Commission. The Cooperation Group shall be chaired by the Commission. The Commission shall provide the Cooperation Group’s Secretariat.

3.   Representatives of relevant stakeholders may, on an ad hoc basis, be invited to attend meetings of the Cooperation Group and to participate in its work as observers.

4.   ENISA shall be invited to participate as observer in the workings of the Cooperation Group when it exchanges views, best practices and information on relevant cybersecurity aspects such as notification of security breaches, and when the use of cybersecurity certificates or standards are addressed.

5.   The Cooperation Group shall have the following tasks:

    (a) exchange advice and cooperate with the Commission on emerging policy initiatives in the field of digital identity wallets, electronic identification means and trust services;

    (b) advise the Commission, as appropriate, in the early preparation of draft implementing and delegated acts to be adopted pursuant to this Regulation;

    (c) in order to support the supervisory bodies in the implementation of the provisions of this Regulation:

    **(i)** exchange best practices and information regarding the implementation of the provisions of this Regulation;

    **(ii)** assess the relevant developments in the digital identity wallet, electronic identification and trust services sectors;

    **(iii)** organise joint meetings with relevant interested parties from across the Union to discuss activities carried out by the cooperation group and gather input on emerging policy challenges;

    **(iv)** with the support of ENISA, exchange views, best practices and information on relevant cybersecurity aspects concerning European Digital Identity Wallets, electronic identification schemes and trust services;

    **(v)** exchange best practices in relation to the development and implementation of policies on the notification of security breaches, and common measures as referred to in Articles 5e and 10;

    **(vi)** organise joint meetings with the NIS Cooperation Group established pursuant to Article 14(1) of Directive (EU) 2022/2555 to exchange relevant information in relation to trust services and electronic identification related cyber threats, incidents, vulnerabilities, awareness raising initiatives, trainings, exercises and skills, capacity building, standards and technical specifications capacity as well as standards and technical specifications;

    **(vii)** discuss, upon a request of a supervisory body, specific requests for mutual assistance as referred to in Article 46d;

    **(viii)** facilitate the exchange of information between the supervisory bodies by providing guidance on the organisational aspects and procedures for the mutual assistance referred to in Article 46d;

    (d) organise peer reviews of electronic identification schemes to be notified under this Regulation.

6.   Member States shall ensure effective and efficient cooperation of their designated representatives in the Cooperation Group.

7.   By 21 May 2025, the Commission shall, by means of implementing acts, establish the necessary procedural arrangements to facilitate the cooperation between the Member States referred to in paragraph 5, point (d), of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 48(2).

## CHAPTER V - DELEGATIONS OF POWER AND IMPLEMENTING PROVISIONS

### Article 47 - Exercise of the delegation

1.   The power to adopt delegated acts is conferred on the Commission subject to the conditions laid down in this Article.

2.   The power to adopt delegated acts referred to in Article 5c(7), Article 24(4b) and Article 30(4) shall be conferred on the Commission for an indeterminate period of time from 17 September 2014.

3.   The delegation of power referred to in Article 5c(7), Article 24(4b) and Article 30(4) may be revoked at any time by the European Parliament or by the Council. A decision to revoke shall put an end to the delegation of the power specified in that decision. It shall take effect the day following the publication of the decision in the Official Journal of the European Union or at a later date specified therein. It shall not affect the validity of any delegated acts already in force.

4.   As soon as it adopts a delegated act, the Commission shall notify it simultaneously to the European Parliament and to the Council.

5.   A delegated act adopted pursuant to Article 5c(7), Article 24(4b) or Article 30(4) shall enter into force only if no objection has been expressed either by the European Parliament or the Council within a period of two months of notification of that act to the European Parliament and the Council or if, before the expiry of that period, the European Parliament and the Council have both informed the Commission that they will not object. That period shall be extended by two months at the initiative of the European Parliament or of the Council.

### Article 48 - Committee procedure

1.   The Commission shall be assisted by a committee. That committee shall be a committee within the meaning of Regulation (EU) No 182/2011.

2.   Where reference is made to this paragraph, Article 5 of Regulation (EU) No 182/2011 shall apply.

### Article 48a - Reporting requirements

1.   Member States shall ensure the collection of statistics in relation to the functioning of European Digital Identity Wallets and the qualified trust services provided on their territory.

2.   The statistics collected in accordance with paragraph 1 shall include the following:

    (a) the number of natural and legal persons having a valid European Digital Identity Wallet;

    (b) the type and number of services accepting the use of the European Digital Identity Wallet;

    (c) the number of user complaints and consumer protection or data protection incidents relating to relying parties and qualified trust services;

    (d) a summary report including data on incidents preventing the use of the European Digital Identity Wallet;

    (e) a summary of significant security incidents, data breaches and affected users of European Digital Identity Wallets or of qualified trust services.

3.   The statistics referred to in paragraph 2 shall be made available to the public in an open and commonly used, machine-readable format.

4.   By 31 March each year, Member States shall submit to the Commission a report on the statistics collected in accordance with paragraph 2.

## CHAPTER VI - FINAL PROVISIONS

### Article 49 - Review

1.   The Commission shall review the application of this Regulation and shall, by 21 May 2026, submit a report to the European Parliament and to the Council. In that report, the Commission shall, in particular, evaluate whether it is appropriate to modify the scope of this Regulation or its specific provisions including, in particular, the provisions included in Article 5c(5), taking into account the experience gained in the application of this Regulation, as well as technological, market and legal developments. Where necessary, that report shall be accompanied by a proposal to amend this Regulation.

2.   The report referred to in paragraph 1 shall include an assessment of the availability, security and usability of the notified electronic identification means and European Digital Identity Wallets that fall within the scope of this Regulation and assess whether all online private service providers relying on third-party electronic identification services for users authentication, shall be required to accept the use of notified electronic identification means and European Digital Identity Wallet.

3.   By 21 May 2030 and every four years thereafter, the Commission shall submit a report to the European Parliament and the Council on progress made towards achieving the objectives of this Regulation.

## Article 50 - Repeal

1.   Directive 1999/93/EC is repealed with effect from 1 July 2016.

2.   References to the repealed Directive shall be construed as references to this Regulation.

## Article 51 - Transitional measures

1.   Secure signature creation devices of which the conformity has been determined in accordance with Article 3(4) of Directive 1999/93/EC shall continue to be considered to be qualified electronic signature creation devices under this Regulation until 21 May 2027.

2.   Qualified certificates issued to natural persons under Directive 1999/93/EC shall continue to be considered as qualified certificates for electronic signatures under this Regulation until 21 May 2026.

3.   The management of remote qualified electronic signature and seal creation devices by qualified trust service providers other than qualified trust service providers providing qualified trust services for the management of remote qualified electronic signature and seal creation devices in accordance with Articles 29a and 39a may be carried out without the need to obtain the qualified status for the provision of these management services until 21 May 2026.

4.   Qualified trust service providers that have been granted their qualified status under this Regulation before 20 May 2024 shall submit a conformity assessment report to the supervisory body proving compliance with Article 24(1), (1a) and (1b) as soon as possible and in any event by 21 May 2026.’;

## Article 52 - Entry into force

1.   This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

2.   This Regulation shall apply from 1 July 2016, except for the following:

(a) Articles 8(3), 9(5), 12(2) to (9), 17(8), 19(4), 20(4), 21(4), 22(5), 23(3), 24(5), 27(4) and (5), 28(6), 29(2), 30(3) and (4), 31(3), 32(3), 33(2), 34(2), 37(4) and (5), 38(6), 42(2), 44(2), 45(2), and Articles 47 and 48 shall apply from 17 September 2014;

(b) Article 7, Article 8(1) and (2), Articles 9, 10, 11 and Article 12(1) shall apply from the date of application of the implementing acts referred to in Articles 8(3) and 12(8);

(c) Article 6 shall apply from three years as from the date of application of the implementing acts referred to in Articles 8(3) and 12(8).

3.   Where the notified electronic identification scheme is included in the list published by the Commission pursuant to Article 9 before the date referred to in point (c) of paragraph 2 of this Article, the recognition of the electronic identification means under that scheme pursuant to Article 6 shall take place no later than 12 months after the publication of that scheme but not before the date referred to in point (c) of paragraph 2 of this Article.

4.   Notwithstanding point (c) of paragraph 2 of this Article, a Member State may decide that electronic identification means under electronic identification scheme notified pursuant to Article 9(1) by another Member State are recognised in the first Member State as from the date of application of the implementing acts referred to in Articles 8(3) and 12(8). Member States concerned shall inform the Commission. The Commission shall make this information public.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 23 July 2014.

(1)   OJ C 351, 15.11.2012, p. 73.

(2)  Position of the European Parliament of 3 April 2014 (not yet published in the Official Journal) and decision of the Council of 23 July 2014.

(3)  Directive 1999/93/EC of the European Parliament and of the Council of 13 December 1999 on a Community framework for electronic signatures (OJ L 13, 19.1.2000, p. 12).

(4)   OJ C 50 E, 21.2.2012, p. 1.

(5)  Directive 2006/123/EC of the European Parliament and of the Council of 12 December 2006 on services in the internal market (OJ L 376, 27.12.2006, p. 36).

(6)  Directive 2011/24/EU of the European Parliament and of the Council of 9 March 2011 on the application of patients’ rights in cross-border healthcare (OJ L 88, 4.4.2011, p. 45).

(7)  Directive 95/46/EC of the European Parliament and of the Council of 24 October 1995 on the protection of individuals with regard to the processing of personal data and on the free movement of such data (OJ L 281, 23.11.1995, p. 31).

(8)  Council Decision 2010/48/EC of 26 November 2009 concerning the conclusion, by the European Community, of the United Nations Convention on the Rights of Persons with Disabilities (OJ L 23, 27.1.2010, p. 35).

(9)  Regulation (EC) No 765/2008 of the European Parliament and of the Council of 9 July 2008 setting out the requirements for accreditation and market surveillance relating to the marketing of products and repealing Regulation (EEC) No 339/93 (OJ L 218, 13.8.2008, p. 30).

(10)  Commission Decision 2009/767/EC of 16 October 2009 setting out measures facilitating the use of procedures by electronic means through the ‘points of single contact’ under Directive 2006/123/EC of the European Parliament and of the Council on services in the internal market (OJ L 274, 20.10.2009, p. 36).

(11)  Commission Decision 2011/130/EU of 25 February 2011 establishing minimum requirements for the cross-border processing of documents signed electronically by competent authorities under Directive 2006/123/EC of the European Parliament and of the Council on services in the internal market (OJ L 53, 26.2.2011, p. 66).

(12)  Regulation (EU) No 182/2011 of the European Parliament and of the Council of 16 February 2011 laying down the rules and general principles concerning mechanisms for control by the Member States of the Commission’s exercise of implementing powers (OJ L 55, 28.2.2011, p. 13).

(13)  Regulation (EC) No 45/2001 of the European Parliament and of the Council of 18 December 2000 on the protection of individuals with regard to the processing of personal data by the Community institutions and bodies and on the free movement of such data (OJ L 8, 12.1.2001, p. 1).

(14)   OJ C 28, 30.1.2013, p. 6.

(15)  Directive 2014/24/EU of the European Parliament and of the Council of 26 February 2014 on public procurement and repealing Directive 2004/18/EC (OJ L 94, 28.3.2014, p. 65).

## ANNEX I - REQUIREMENTS FOR QUALIFIED CERTIFICATES FOR ELECTRONIC SIGNATURES

Qualified certificates for electronic signatures shall contain:

(a) an indication, at least in a form suitable for automated processing, that the certificate has been issued as a qualified certificate for electronic signature;

(b) a set of data unambiguously representing the qualified trust service provider issuing the qualified certificates including at least, the Member State in which that provider is established and:

- for a legal person: the name and, where applicable, registration number as stated in the official records,

- for a natural person: the person’s name;

(c) at least the name of the signatory, or a pseudonym; if a pseudonym is used, it shall be clearly indicated;

(d) electronic signature validation data that corresponds to the electronic signature creation data;

(e) details of the beginning and end of the certificate’s period of validity;

(f) the certificate identity code, which must be unique for the qualified trust service provider;

(g) the advanced electronic signature or advanced electronic seal of the issuing qualified trust service provider;

(h) the location where the certificate supporting the advanced electronic signature or advanced electronic seal referred to in point (g) is available free of charge;

(i) the location of the services that can be used to enquire about the validity status of the qualified certificate;

(j) where the electronic signature creation data related to the electronic signature validation data is located in a qualified electronic signature creation device, an appropriate indication of this, at least in a form suitable for automated processing.

## ANNEX II - REQUIREMENTS FOR QUALIFIED ELECTRONIC SIGNATURE CREATION DEVICES

1. Qualified electronic signature creation devices shall ensure, by appropriate technical and procedural means, that at least:

(a) the confidentiality of the electronic signature creation data used for electronic signature creation is reasonably assured;

(b) the electronic signature creation data used for electronic signature creation can practically occur only once;

(c) the electronic signature creation data used for electronic signature creation cannot, with reasonable assurance, be derived and the electronic signature is reliably protected against forgery using currently available technology;

(d) the electronic signature creation data used for electronic signature creation can be reliably protected by the legitimate signatory against use by others.

2. Qualified electronic signature creation devices shall not alter the data to be signed or prevent such data from being presented to the signatory prior to signing.

3. Generating or managing electronic signature creation data on behalf of the signatory may only be done by a qualified trust service provider.

4. Without prejudice to point (d) of point 1, qualified trust service providers managing electronic signature creation data on behalf of the signatory may duplicate the electronic signature creation data only for back-up purposes provided the following requirements are met:

(a) the security of the duplicated datasets must be at the same level as for the original datasets;

(b) the number of duplicated datasets shall not exceed the minimum needed to ensure continuity of the service.

## ANNEX III - REQUIREMENTS FOR QUALIFIED CERTIFICATES FOR ELECTRONIC SEALS

Qualified certificates for electronic seals shall contain:

(a) an indication, at least in a form suitable for automated processing, that the certificate has been issued as a qualified certificate for electronic seal;

(b) a set of data unambiguously representing the qualified trust service provider issuing the qualified certificates including at least the Member State in which that provider is established and:

- for a legal person: the name and, where applicable, registration number as stated in the official records,

- for a natural person: the person’s name;

(c) at least the name of the creator of the seal and, where applicable, registration number as stated in the official records;

(d) electronic seal validation data, which corresponds to the electronic seal creation data;

(e) details of the beginning and end of the certificate’s period of validity;

(f) the certificate identity code, which must be unique for the qualified trust service provider;

(g) the advanced electronic signature or advanced electronic seal of the issuing qualified trust service provider;

(h) the location where the certificate supporting the advanced electronic signature or advanced electronic seal referred to in point (g) is available free of charge;

(i) the location of the services that can be used to enquire as to the validity status of the qualified certificate;

(j) where the electronic seal creation data related to the electronic seal validation data is located in a qualified electronic seal creation device, an appropriate indication of this, at least in a form suitable for automated processing.

## ANNEX IV - REQUIREMENTS FOR QUALIFIED CERTIFICATES FOR WEBSITE AUTHENTICATION

Qualified certificates for website authentication shall contain:

(a) an indication, at least in a form suitable for automated processing, that the certificate has been issued as a qualified certificate for website authentication;

(b) a set of data unambiguously representing the qualified trust service provider issuing the qualified certificates including at least the Member State in which that provider is established and:

- for a legal person: the name and, where applicable, registration number as stated in the official records,

- for a natural person: the person’s name;

(c) for natural persons: at least the name of the person to whom the certificate has been issued, or a pseudonym. If a pseudonym is used, it shall be clearly indicated;

for legal persons: at least the name of the legal person to whom the certificate is issued and, where applicable, registration number as stated in the official records;

(d) elements of the address, including at least city and State, of the natural or legal person to whom the certificate is issued and, where applicable, as stated in the official records;

(e) the domain name(s) operated by the natural or legal person to whom the certificate is issued;

(f) details of the beginning and end of the certificate’s period of validity;

(g) the certificate identity code, which must be unique for the qualified trust service provider;

(h) the advanced electronic signature or advanced electronic seal of the issuing qualified trust service provider;

(i) the location where the certificate supporting the advanced electronic signature or advanced electronic seal referred to in point (h) is available free of charge;

(j) the location of the certificate validity status services that can be used to enquire as to the validity status of the qualified certificate.

---

# General Data Protection Regulation
Source: https://docs.igrant.io/regulations/reg-eu-gdpr/

---
id: reg-eu-gdpr
title: General Data Protection Regulation
description: Understand the key GDPR principles that guide personal data protection, consent, and compliance in digital identity ecosystems.
sidebar_label: European GDPR
keywords: [GDPR, General Data Protection Regulation, data protection, privacy, consent, EU regulation, personal data, digital identity, eIDAS]
slug: /reg-eu-gdpr/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Learn About the EU GDPR Regulations | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the key GDPR principles that guide personal data protection, consent, and compliance in digital identity ecosystems."/>
</head>

The General Data Protection Regulation (EU) 2016/679 (GDPR) is a regulation in EU law on data protection and privacy in the European Union (EU) and the European Economic Area (EEA). GDPR allows European Union (EU) citizens to better control their personal data. It also modernises and unifies rules allowing businesses to reduce red tape and to benefit from greater consumer trust.The general data protection regulation (GDPR) is part of the EU data protection reform package, along with the data protection directive for police and criminal justice authorities.

You can find the office page of the Regulation at [(EU) 2016/679](https://eur-lex.europa.eu/eli/reg/2016/679/oj) (General Data Protection Regulation). All Articles of the GDPR are linked with suitable recitals. The European Data Protection Regulation is applicable as of May 25th, 2018 in all member states to harmonize data privacy laws across Europe. 

A recommended, [easy to use page is provided by Intersoft consulting](https://gdpr-info.eu/). The latest GDPR articles are documented as is below.

## CHAPTER I: General provisions

### Article 1: Subject-matter and objectives

1. This Regulation lays down rules relating to the protection of natural persons with regard to the processing of personal data and rules relating to the free movement of personal data.

2. This Regulation protects fundamental rights and freedoms of natural persons and in particular their right to the protection of personal data.

3. The free movement of personal data within the Union shall be neither restricted nor prohibited for reasons connected with the protection of natural persons with regard to the processing of personal data.

### Article 2: Material scope

1. This Regulation applies to the processing of personal data wholly or partly by automated means and to the processing other than by automated means of personal data which form part of a filing system or are intended to form part of a filing system.

2. This Regulation does not apply to the processing of personal data:

   (a) in the course of an activity which falls outside the scope of Union law;

   (b) by the Member States when carrying out activities which fall within the scope of Chapter 2 of Title V of the TEU;

   (c) by a natural person in the course of a purely personal or household activity;

   (d) by competent authorities for the purposes of the prevention, investigation, detection or prosecution of criminal offences or the execution of criminal penalties, including the safeguarding against and the prevention of threats to public security.

3. For the processing of personal data by the Union institutions, bodies, offices and agencies, Regulation (EC) No 45/2001 applies. Regulation (EC) No 45/2001 and other Union legal acts applicable to such processing of personal data shall be adapted to the principles and rules of this Regulation in accordance with Article 98.

4. This Regulation shall be without prejudice to the application of Directive 2000/31/EC, in particular of the liability rules of intermediary service providers in Articles 12 to 15 of that Directive.

### Article 3: Territorial scope

1. This Regulation applies to the processing of personal data in the context of the activities of an establishment of a controller or a processor in the Union, regardless of whether the processing takes place in the Union or not.

2. This Regulation applies to the processing of personal data of data subjects who are in the Union by a controller or processor not established in the Union, where the processing activities are related to:

   (a) the offering of goods or services, irrespective of whether a payment of the data subject is required, to such data subjects in the Union; or

   (b) the monitoring of their behaviour as far as their behaviour takes place within the Union.

3. This Regulation applies to the processing of personal data by a controller not established in the Union, but in a place where Member State law applies by virtue of public international law.

### Article 4: Definitions

For the purposes of this Regulation:

(1) **‘personal data’** means any information relating to an identified or identifiable natural person (‘data subject’); an identifiable natural person is one who can be identified, directly or indirectly, in particular by reference to an identifier such as a name, an identification number, location data, an online identifier or to one or more factors specific to the physical, physiological, genetic, mental, economic, cultural or social identity of that natural person;

(2) **‘processing’** means any operation or set of operations which is performed on personal data or on sets of personal data, whether or not by automated means, such as collection, recording, organisation, structuring, storage, adaptation or alteration, retrieval, consultation, use, disclosure by transmission, dissemination or otherwise making available, alignment or combination, restriction, erasure or destruction;

(3) **‘restriction of processing’** means the marking of stored personal data with the aim of limiting their processing in the future;

(4) **‘profiling’** means any form of automated processing of personal data consisting of the use of personal data to evaluate certain personal aspects relating to a natural person, in particular to analyse or predict aspects concerning that natural person's performance at work, economic situation, health, personal preferences, interests, reliability, behaviour, location or movements;

(5) **‘pseudonymisation’** means the processing of personal data in such a manner that the personal data can no longer be attributed to a specific data subject without the use of additional information, provided that such additional information is kept separately and is subject to technical and organisational measures to ensure that the personal data are not attributed to an identified or identifiable natural person;

(6) **‘filing system’** means any structured set of personal data which are accessible according to specific criteria, whether centralised, decentralised or dispersed on a functional or geographical basis;

(7) **‘controller’** means the natural or legal person, public authority, agency or other body which, alone or jointly with others, determines the purposes and means of the processing of personal data; where the purposes and means of such processing are determined by Union or Member State law, the controller or the specific criteria for its nomination may be provided for by Union or Member State law;

(8) **‘processor’** means a natural or legal person, public authority, agency or other body which processes personal data on behalf of the controller;

(9) **‘recipient’** means a natural or legal person, public authority, agency or another body, to which the personal data are disclosed, whether a third party or not. However, public authorities which may receive personal data in the framework of a particular inquiry in accordance with Union or Member State law shall not be regarded as recipients; the processing of those data by those public authorities shall be in compliance with the applicable data protection rules according to the purposes of the processing;

(10) **‘third party’** means a natural or legal person, public authority, agency or body other than the data subject, controller, processor and persons who, under the direct authority of the controller or processor, are authorised to process personal data;

(11) **‘consent’** of the data subject means any freely given, specific, informed and unambiguous indication of the data subject's wishes by which he or she, by a statement or by a clear affirmative action, signifies agreement to the processing of personal data relating to him or her;

(12) **‘personal data breach’** means a breach of security leading to the accidental or unlawful destruction, loss, alteration, unauthorised disclosure of, or access to, personal data transmitted, stored or otherwise processed;

(13) **‘genetic data’** means personal data relating to the inherited or acquired genetic characteristics of a natural person which give unique information about the physiology or the health of that natural person and which result, in particular, from an analysis of a biological sample from the natural person in question;

(14) **‘biometric data’** means personal data resulting from specific technical processing relating to the physical, physiological or behavioural characteristics of a natural person, which allow or confirm the unique identification of that natural person, such as facial images or dactyloscopic data;

(15) **‘data concerning health’** means personal data related to the physical or mental health of a natural person, including the provision of health care services, which reveal information about his or her health status;

(16) **‘main establishment’** means:

   (a) as regards a controller with establishments in more than one Member State, the place of its central administration in the Union, unless the decisions on the purposes and means of the processing of personal data are taken in another establishment of the controller in the Union and the latter establishment has the power to have such decisions implemented, in which case the establishment having taken such decisions is to be considered to be the main establishment;

   (b) as regards a processor with establishments in more than one Member State, the place of its central administration in the Union, or, if the processor has no central administration in the Union, the establishment of the processor in the Union where the main processing activities in the context of the activities of an establishment of the processor take place to the extent that the processor is subject to specific obligations under this Regulation;

(17) **‘representative’** means a natural or legal person established in the Union who, designated by the controller or processor in writing pursuant to Article 27, represents the controller or processor with regard to their respective obligations under this Regulation;

(18) **‘enterprise’** means a natural or legal person engaged in an economic activity, irrespective of its legal form, including partnerships or associations regularly engaged in an economic activity;

(19) **‘group of undertakings’** means a controlling undertaking and its controlled undertakings;

(20) **‘binding corporate rules’** means personal data protection policies which are adhered to by a controller or processor established on the territory of a Member State for transfers or a set of transfers of personal data to a controller or processor in one or more third countries within a group of undertakings, or group of enterprises engaged in a joint economic activity;

(21) **‘supervisory authority’** means an independent public authority which is established by a Member State pursuant to Article 51;

(22) **‘supervisory authority concerned’** means a supervisory authority which is concerned by the processing of personal data because:

   (a) the controller or processor is established on the territory of the Member State of that supervisory authority;

   (b) data subjects residing in the Member State of that supervisory authority are substantially affected or likely to be substantially affected by the processing; or

   (c) a complaint has been lodged with that supervisory authority;

(23) **‘cross-border processing’** means either:

   (a) processing of personal data which takes place in the context of the activities of establishments in more than one Member State of a controller or processor in the Union where the controller or processor is established in more than one Member State; or

   (b) processing of personal data which takes place in the context of the activities of a single establishment of a controller or processor in the Union but which substantially affects or is likely to substantially affect data subjects in more than one Member State.

(24) **‘relevant and reasoned objection’** means an objection to a draft decision as to whether there is an infringement of this Regulation, or whether envisaged action in relation to the controller or processor complies with this Regulation, which clearly demonstrates the significance of the risks posed by the draft decision as regards the fundamental rights and freedoms of data subjects and, where applicable, the free flow of personal data within the Union;

(25) **‘information society service’** means a service as defined in point (b) of Article 1(1) of Directive (EU) 2015/1535 of the European Parliament and of the Council (19);

(26) **‘international organisation’** means an organisation and its subordinate bodies governed by public international law, or any other body which is set up by, or on the basis of, an agreement between two or more countries.

## CHAPTER II: Principles

### Article 5: Principles relating to processing of personal data

1. Personal data shall be:

   (a) processed lawfully, fairly and in a transparent manner in relation to the data subject (‘lawfulness, fairness and transparency’);

   (b) collected for specified, explicit and legitimate purposes and not further processed in a manner that is incompatible with those purposes; further processing for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes shall, in accordance with Article 89(1), not be considered to be incompatible with the initial purposes (‘purpose limitation’);

   (c) adequate, relevant and limited to what is necessary in relation to the purposes for which they are processed (‘data minimisation’);

   (d) accurate and, where necessary, kept up to date; every reasonable step must be taken to ensure that personal data that are inaccurate, having regard to the purposes for which they are processed, are erased or rectified without delay (‘accuracy’);

   (e) kept in a form which permits identification of data subjects for no longer than is necessary for the purposes for which the personal data are processed; personal data may be stored for longer periods insofar as the personal data will be processed solely for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes in accordance with Article 89(1) subject to implementation of the appropriate technical and organisational measures required by this Regulation in order to safeguard the rights and freedoms of the data subject (‘storage limitation’);

   (f) processed in a manner that ensures appropriate security of the personal data, including protection against unauthorised or unlawful processing and against accidental loss, destruction or damage, using appropriate technical or organisational measures (‘integrity and confidentiality’).

2. The controller shall be responsible for, and be able to demonstrate compliance with, paragraph 1 (‘accountability’).

### Article 6: Lawfulness of processing

1. Processing shall be lawful only if and to the extent that at least one of the following applies:

   (a) the data subject has given consent to the processing of his or her personal data for one or more specific purposes;

   (b) processing is necessary for the performance of a contract to which the data subject is party or in order to take steps at the request of the data subject prior to entering into a contract;

   (c) processing is necessary for compliance with a legal obligation to which the controller is subject;

   (d) processing is necessary in order to protect the vital interests of the data subject or of another natural person;

   (e) processing is necessary for the performance of a task carried out in the public interest or in the exercise of official authority vested in the controller;

   (f) processing is necessary for the purposes of the legitimate interests pursued by the controller or by a third party, except where such interests are overridden by the interests or fundamental rights and freedoms of the data subject which require protection of personal data, in particular where the data subject is a child.

   Point (f) of the first subparagraph shall not apply to processing carried out by public authorities in the performance of their tasks.

2. Member States may maintain or introduce more specific provisions to adapt the application of the rules of this Regulation with regard to processing for compliance with points (c) and (e) of paragraph 1 by determining more precisely specific requirements for the processing and other measures to ensure lawful and fair processing including for other specific processing situations as provided for in Chapter IX.

3. The basis for the processing referred to in point (c) and (e) of paragraph 1 shall be laid down by:

   (a) Union law; or

   (b) Member State law to which the controller is subject.

   The purpose of the processing shall be determined in that legal basis or, as regards the processing referred to in point (e) of paragraph 1, shall be necessary for the performance of a task carried out in the public interest or in the exercise of official authority vested in the controller. That legal basis may contain specific provisions to adapt the application of rules of this Regulation, inter alia: the general conditions governing the lawfulness of processing by the controller; the types of data which are subject to the processing; the data subjects concerned; the entities to, and the purposes for which, the personal data may be disclosed; the purpose limitation; storage periods; and processing operations and processing procedures, including measures to ensure lawful and fair processing such as those for other specific processing situations as provided for in Chapter IX. The Union or the Member State law shall meet an objective of public interest and be proportionate to the legitimate aim pursued.

4. Where the processing for a purpose other than that for which the personal data have been collected is not based on the data subject's consent or on a Union or Member State law which constitutes a necessary and proportionate measure in a democratic society to safeguard the objectives referred to in Article 23(1), the controller shall, in order to ascertain whether processing for another purpose is compatible with the purpose for which the personal data are initially collected, take into account, inter alia:

   (a) any link between the purposes for which the personal data have been collected and the purposes of the intended further processing;

   (b) the context in which the personal data have been collected, in particular regarding the relationship between data subjects and the controller;

   (c) the nature of the personal data, in particular whether special categories of personal data are processed, pursuant to Article 9, or whether personal data related to criminal convictions and offences are processed, pursuant to Article 10;

   (d) the possible consequences of the intended further processing for data subjects;

   (e) the existence of appropriate safeguards, which may include encryption or pseudonymisation.

### Article 7: Conditions for consent

1. Where processing is based on consent, the controller shall be able to demonstrate that the data subject has consented to processing of his or her personal data.

2. If the data subject's consent is given in the context of a written declaration which also concerns other matters, the request for consent shall be presented in a manner which is clearly distinguishable from the other matters, in an intelligible and easily accessible form, using clear and plain language. Any part of such a declaration which constitutes an infringement of this Regulation shall not be binding.

3. The data subject shall have the right to withdraw his or her consent at any time. The withdrawal of consent shall not affect the lawfulness of processing based on consent before its withdrawal. Prior to giving consent, the data subject shall be informed thereof. It shall be as easy to withdraw as to give consent.

4. When assessing whether consent is freely given, utmost account shall be taken of whether, inter alia, the performance of a contract, including the provision of a service, is conditional on consent to the processing of personal data that is not necessary for the performance of that contract.

### Article 8: Conditions applicable to child's consent in relation to information society services

1. Where point (a) of Article 6(1) applies, in relation to the offer of information society services directly to a child, the processing of the personal data of a child shall be lawful where the child is at least 16 years old. Where the child is below the age of 16 years, such processing shall be lawful only if and to the extent that consent is given or authorised by the holder of parental responsibility over the child.

   Member States may provide by law for a lower age for those purposes provided that such lower age is not below 13 years.

2. The controller shall make reasonable efforts to verify in such cases that consent is given or authorised by the holder of parental responsibility over the child, taking into consideration available technology.

3. Paragraph 1 shall not affect the general contract law of Member States such as the rules on the validity, formation or effect of a contract in relation to a child.

### Article 9: Processing of special categories of personal data

1. Processing of personal data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data for the purpose of uniquely identifying a natural person, data concerning health or data concerning a natural person's sex life or sexual orientation shall be prohibited.

2. Paragraph 1 shall not apply if one of the following applies:

   (a) the data subject has given explicit consent to the processing of those personal data for one or more specified purposes, except where Union or Member State law provide that the prohibition referred to in paragraph 1 may not be lifted by the data subject;

   (b) processing is necessary for the purposes of carrying out the obligations and exercising specific rights of the controller or of the data subject in the field of employment and social security and social protection law in so far as it is authorised by Union or Member State law or a collective agreement pursuant to Member State law providing for appropriate safeguards for the fundamental rights and the interests of the data subject;

   (c) processing is necessary to protect the vital interests of the data subject or of another natural person where the data subject is physically or legally incapable of giving consent;

   (d) processing is carried out in the course of its legitimate activities with appropriate safeguards by a foundation, association or any other not-for-profit body with a political, philosophical, religious or trade union aim and on condition that the processing relates solely to the members or to former members of the body or to persons who have regular contact with it in connection with its purposes and that the personal data are not disclosed outside that body without the consent of the data subjects;

   (e) processing relates to personal data which are manifestly made public by the data subject;

   (f) processing is necessary for the establishment, exercise or defence of legal claims or whenever courts are acting in their judicial capacity;

   (g) processing is necessary for reasons of substantial public interest, on the basis of Union or Member State law which shall be proportionate to the aim pursued, respect the essence of the right to data protection and provide for suitable and specific measures to safeguard the fundamental rights and the interests of the data subject;

   (h) processing is necessary for the purposes of preventive or occupational medicine, for the assessment of the working capacity of the employee, medical diagnosis, the provision of health or social care or treatment or the management of health or social care systems and services on the basis of Union or Member State law or pursuant to contract with a health professional and subject to the conditions and safeguards referred to in paragraph 3;

   (i) processing is necessary for reasons of public interest in the area of public health, such as protecting against serious cross-border threats to health or ensuring high standards of quality and safety of health care and of medicinal products or medical devices, on the basis of Union or Member State law which provides for suitable and specific measures to safeguard the rights and freedoms of the data subject, in particular professional secrecy;

   (j) processing is necessary for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes in accordance with Article 89(1) based on Union or Member State law which shall be proportionate to the aim pursued, respect the essence of the right to data protection and provide for suitable and specific measures to safeguard the fundamental rights and the interests of the data subject.

3. Personal data referred to in paragraph 1 may be processed for the purposes referred to in point (h) of paragraph 2 when those data are processed by or under the responsibility of a professional subject to the obligation of professional secrecy under Union or Member State law or rules established by national competent bodies or by another person also subject to an obligation of secrecy under Union or Member State law or rules established by national competent bodies.

4. Member States may maintain or introduce further conditions, including limitations, with regard to the processing of genetic data, biometric data or data concerning health.

### Article 10: Processing of personal data relating to criminal convictions and offences

Processing of personal data relating to criminal convictions and offences or related security measures based on Article 6(1) shall be carried out only under the control of official authority or when the processing is authorised by Union or Member State law providing for appropriate safeguards for the rights and freedoms of data subjects. Any comprehensive register of criminal convictions shall be kept only under the control of official authority.

### Article 11: Processing which does not require identification

1. If the purposes for which a controller processes personal data do not or do no longer require the identification of a data subject by the controller, the controller shall not be obliged to maintain, acquire or process additional information in order to identify the data subject for the sole purpose of complying with this Regulation.

2. Where, in cases referred to in paragraph 1 of this Article, the controller is able to demonstrate that it is not in a position to identify the data subject, the controller shall inform the data subject accordingly, if possible. In such cases, Articles 15 to 20 shall not apply except where the data subject, for the purpose of exercising his or her rights under those articles, provides additional information enabling his or her identification.

## CHAPTER III: Rights of the data subject
## Section 1: Transparency and modalities
### Article 12: Transparent information, communication and modalities for the exercise of the rights of the data subject

1. The controller shall take appropriate measures to provide any information referred to in Articles 13 and 14 and any communication under Articles 15 to 22 and 34 relating to processing to the data subject in a concise, transparent, intelligible and easily accessible form, using clear and plain language, in particular for any information addressed specifically to a child. The information shall be provided in writing, or by other means, including, where appropriate, by electronic means. When requested by the data subject, the information may be provided orally, provided that the identity of the data subject is proven by other means.

2. The controller shall facilitate the exercise of data subject rights under Articles 15 to 22. In the cases referred to in Article 11(2), the controller shall not refuse to act on the request of the data subject for exercising his or her rights under Articles 15 to 22, unless the controller demonstrates that it is not in a position to identify the data subject.

3. The controller shall provide information on action taken on a request under Articles 15 to 22 to the data subject without undue delay and in any event within one month of receipt of the request. That period may be extended by two further months where necessary, taking into account the complexity and number of the requests. The controller shall inform the data subject of any such extension within one month of receipt of the request, together with the reasons for the delay. Where the data subject makes the request by electronic form means, the information shall be provided by electronic means where possible, unless otherwise requested by the data subject.

4. If the controller does not take action on the request of the data subject, the controller shall inform the data subject without delay and at the latest within one month of receipt of the request of the reasons for not taking action and on the possibility of lodging a complaint with a supervisory authority and seeking a judicial remedy.

5. Information provided under Articles 13 and 14 and any communication and any actions taken under Articles 15 to 22 and 34 shall be provided free of charge. Where requests from a data subject are manifestly unfounded or excessive, in particular because of their repetitive character, the controller may either:

   (a) charge a reasonable fee taking into account the administrative costs of providing the information or communication or taking the action requested; or

   (b) refuse to act on the request.

   The controller shall bear the burden of demonstrating the manifestly unfounded or excessive character of the request.

6. Without prejudice to Article 11, where the controller has reasonable doubts concerning the identity of the natural person making the request referred to in Articles 15 to 21, the controller may request the provision of additional information necessary to confirm the identity of the data subject.

7. The information to be provided to data subjects pursuant to Articles 13 and 14 may be provided in combination with standardised icons in order to give in an easily visible, intelligible and clearly legible manner a meaningful overview of the intended processing. Where the icons are presented electronically they shall be machine-readable.

8. The Commission shall be empowered to adopt delegated acts in accordance with Article 92 for the purpose of determining the information to be presented by the icons and the procedures for providing standardised icons.

## Section 2: Information and access to personal data

### Article 13

Information to be provided where personal data are collected from the data subject

1. Where personal data relating to a data subject are collected from the data subject, the controller shall, at the time when personal data are obtained, provide the data subject with all of the following information:

   (a) the identity and the contact details of the controller and, where applicable, of the controller's representative;

   (b) the contact details of the data protection officer, where applicable;

   (c) the purposes of the processing for which the personal data are intended as well as the legal basis for the processing;

   (d) where the processing is based on point (f) of Article 6(1), the legitimate interests pursued by the controller or by a third party;

   (e) the recipients or categories of recipients of the personal data, if any;

   (f) where applicable, the fact that the controller intends to transfer personal data to a third country or international organisation and the existence or absence of an adequacy decision by the Commission, or in the case of transfers referred to in Article 46 or 47, or the second subparagraph of Article 49(1), reference to the appropriate or suitable safeguards and the means by which to obtain a copy of them or where they have been made available.

2. In addition to the information referred to in paragraph 1, the controller shall, at the time when personal data are obtained, provide the data subject with the following further information necessary to ensure fair and transparent processing:

   (a) the period for which the personal data will be stored, or if that is not possible, the criteria used to determine that period;

   (b) the existence of the right to request from the controller access to and rectification or erasure of personal data or restriction of processing concerning the data subject or to object to processing as well as the right to data portability;

   (c) where the processing is based on point (a) of Article 6(1) or point (a) of Article 9(2), the existence of the right to withdraw consent at any time, without affecting the lawfulness of processing based on consent before its withdrawal;

   (d) the right to lodge a complaint with a supervisory authority;

   (e) whether the provision of personal data is a statutory or contractual requirement, or a requirement necessary to enter into a contract, as well as whether the data subject is obliged to provide the personal data and of the possible consequences of failure to provide such data;

   (f) the existence of automated decision-making, including profiling, referred to in Article 22(1) and (4) and, at least in those cases, meaningful information about the logic involved, as well as the significance and the envisaged consequences of such processing for the data subject.

3. Where the controller intends to further process the personal data for a purpose other than that for which the personal data were collected, the controller shall provide the data subject prior to that further processing with information on that other purpose and with any relevant further information as referred to in paragraph 2.

4. Paragraphs 1, 2 and 3 shall not apply where and insofar as the data subject already has the information.

### Article 14: Information to be provided where personal data have not been obtained from the data subject

1. Where personal data have not been obtained from the data subject, the controller shall provide the data subject with the following information:

   (a) the identity and the contact details of the controller and, where applicable, of the controller's representative;

   (b) the contact details of the data protection officer, where applicable;

   (c) the purposes of the processing for which the personal data are intended as well as the legal basis for the processing;

   (d) the categories of personal data concerned;

   (e) the recipients or categories of recipients of the personal data, if any;

   (f) where applicable, that the controller intends to transfer personal data to a recipient in a third country or international organisation and the existence or absence of an adequacy decision by the Commission, or in the case of transfers referred to in Article 46 or 47, or the second subparagraph of Article 49(1), reference to the appropriate or suitable safeguards and the means to obtain a copy of them or where they have been made available.

2. In addition to the information referred to in paragraph 1, the controller shall provide the data subject with the following information necessary to ensure fair and transparent processing in respect of the data subject:

   (a) the period for which the personal data will be stored, or if that is not possible, the criteria used to determine that period;

   (b) where the processing is based on point (f) of Article 6(1), the legitimate interests pursued by the controller or by a third party;

   (c) the existence of the right to request from the controller access to and rectification or erasure of personal data or restriction of processing concerning the data subject and to object to processing as well as the right to data portability;

   (d) where processing is based on point (a) of Article 6(1) or point (a) of Article 9(2), the existence of the right to withdraw consent at any time, without affecting the lawfulness of processing based on consent before its withdrawal;

   (e) the right to lodge a complaint with a supervisory authority;

   (f) from which source the personal data originate, and if applicable, whether it came from publicly accessible sources;

   (g) the existence of automated decision-making, including profiling, referred to in Article 22(1) and (4) and, at least in those cases, meaningful information about the logic involved, as well as the significance and the envisaged consequences of such processing for the data subject.

3. The controller shall provide the information referred to in paragraphs 1 and 2:

   (a) within a reasonable period after obtaining the personal data, but at the latest within one month, having regard to the specific circumstances in which the personal data are processed;

   (b) if the personal data are to be used for communication with the data subject, at the latest at the time of the first communication to that data subject; or

   (c) if a disclosure to another recipient is envisaged, at the latest when the personal data are first disclosed.

4. Where the controller intends to further process the personal data for a purpose other than that for which the personal data were obtained, the controller shall provide the data subject prior to that further processing with information on that other purpose and with any relevant further information as referred to in paragraph 2.

5. Paragraphs 1 to 4 shall not apply where and insofar as:

   (a) the data subject already has the information;

   (b) the provision of such information proves impossible or would involve a disproportionate effort, in particular for processing for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes, subject to the conditions and safeguards referred to in Article 89(1) or in so far as the obligation referred to in paragraph 1 of this Article is likely to render impossible or seriously impair the achievement of the objectives of that processing. In such cases the controller shall take appropriate measures to protect the data subject's rights and freedoms and legitimate interests, including making the information publicly available;

   (c) obtaining or disclosure is expressly laid down by Union or Member State law to which the controller is subject and which provides appropriate measures to protect the data subject's legitimate interests; or

   (d) where the personal data must remain confidential subject to an obligation of professional secrecy regulated by Union or Member State law, including a statutory obligation of secrecy.
### Article 15: Right of access by the data subject

1. The data subject shall have the right to obtain from the controller confirmation as to whether or not personal data concerning him or her are being processed, and, where that is the case, access to the personal data and the following information:

   (a) the purposes of the processing;

   (b) the categories of personal data concerned;

   (c) the recipients or categories of recipient to whom the personal data have been or will be disclosed, in particular recipients in third countries or international organisations;

   (d) where possible, the envisaged period for which the personal data will be stored, or, if not possible, the criteria used to determine that period;

   (e) the existence of the right to request from the controller rectification or erasure of personal data or restriction of processing of personal data concerning the data subject or to object to such processing;

   (f) the right to lodge a complaint with a supervisory authority;

   (g) where the personal data are not collected from the data subject, any available information as to their source;

   (h) the existence of automated decision-making, including profiling, referred to in Article 22(1) and (4) and, at least in those cases, meaningful information about the logic involved, as well as the significance and the envisaged consequences of such processing for the data subject.

2. Where personal data are transferred to a third country or to an international organisation, the data subject shall have the right to be informed of the appropriate safeguards pursuant to Article 46 relating to the transfer.

3. The controller shall provide a copy of the personal data undergoing processing. For any further copies requested by the data subject, the controller may charge a reasonable fee based on administrative costs. Where the data subject makes the request by electronic means, and unless otherwise requested by the data subject, the information shall be provided in a commonly used electronic form.

4. The right to obtain a copy referred to in paragraph 3 shall not adversely affect the rights and freedoms of others.

## Section 3: Rectification and erasure
### Article 16: Right to rectification

The data subject shall have the right to obtain from the controller without undue delay the rectification of inaccurate personal data concerning him or her. Taking into account the purposes of the processing, the data subject shall have the right to have incomplete personal data completed, including by means of providing a supplementary statement.

### Article 17: Right to erasure (‘right to be forgotten’)

1. The data subject shall have the right to obtain from the controller the erasure of personal data concerning him or her without undue delay and the controller shall have the obligation to erase personal data without undue delay where one of the following grounds applies:

   (a) the personal data are no longer necessary in relation to the purposes for which they were collected or otherwise processed;

   (b) the data subject withdraws consent on which the processing is based according to point (a) of Article 6(1), or point (a) of Article 9(2), and where there is no other legal ground for the processing;

   (c) the data subject objects to the processing pursuant to Article 21(1) and there are no overriding legitimate grounds for the processing, or the data subject objects to the processing pursuant to Article 21(2);

   (d) the personal data have been unlawfully processed;

   (e) the personal data have to be erased for compliance with a legal obligation in Union or Member State law to which the controller is subject;

   (f) the personal data have been collected in relation to the offer of information society services referred to in Article 8(1).

2. Where the controller has made the personal data public and is obliged pursuant to paragraph 1 to erase the personal data, the controller, taking account of available technology and the cost of implementation, shall take reasonable steps, including technical measures, to inform controllers which are processing the personal data that the data subject has requested the erasure by such controllers of any links to, or copy or replication of, those personal data.

3. Paragraphs 1 and 2 shall not apply to the extent that processing is necessary:

   (a) for exercising the right of freedom of expression and information;

   (b) for compliance with a legal obligation which requires processing by Union or Member State law to which the controller is subject or for the performance of a task carried out in the public interest or in the exercise of official authority vested in the controller;

   (c) for reasons of public interest in the area of public health in accordance with points (h) and (i) of Article 9(2) as well as Article 9(3);

   (d) for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes in accordance with Article 89(1) in so far as the right referred to in paragraph 1 is likely to render impossible or seriously impair the achievement of the objectives of that processing; or

   (e) for the establishment, exercise or defence of legal claims.

### Article 18: Right to restriction of processing

1. The data subject shall have the right to obtain from the controller restriction of processing where one of the following applies:

   (a) the accuracy of the personal data is contested by the data subject, for a period enabling the controller to verify the accuracy of the personal data;

   (b) the processing is unlawful and the data subject opposes the erasure of the personal data and requests the restriction of their use instead;

   (c) the controller no longer needs the personal data for the purposes of the processing, but they are required by the data subject for the establishment, exercise or defence of legal claims;

   (d) the data subject has objected to processing pursuant to Article 21(1) pending the verification whether the legitimate grounds of the controller override those of the data subject.

2. Where processing has been restricted under paragraph 1, such personal data shall, with the exception of storage, only be processed with the data subject's consent or for the establishment, exercise or defence of legal claims or for the protection of the rights of another natural or legal person or for reasons of important public interest of the Union or of a Member State.

3. A data subject who has obtained restriction of processing pursuant to paragraph 1 shall be informed by the controller before the restriction of processing is lifted.

### Article 19: Notification obligation regarding rectification or erasure of personal data or restriction of processing

The controller shall communicate any rectification or erasure of personal data or restriction of processing carried out in accordance with Article 16, Article 17(1) and Article 18 to each recipient to whom the personal data have been disclosed, unless this proves impossible or involves disproportionate effort. The controller shall inform the data subject about those recipients if the data subject requests it.

### Article 20: Right to data portability

1. The data subject shall have the right to receive the personal data concerning him or her, which he or she has provided to a controller, in a structured, commonly used and machine-readable format and have the right to transmit those data to another controller without hindrance from the controller to which the personal data have been provided, where:

   (a) the processing is based on consent pursuant to point (a) of Article 6(1) or point (a) of Article 9(2) or on a contract pursuant to point (b) of Article 6(1); and

   (b) the processing is carried out by automated means.

2. In exercising his or her right to data portability pursuant to paragraph 1, the data subject shall have the right to have the personal data transmitted directly from one controller to another, where technically feasible.

3. The exercise of the right referred to in paragraph 1 of this Article shall be without prejudice to Article 17. That right shall not apply to processing necessary for the performance of a task carried out in the public interest or in the exercise of official authority vested in the controller.

4. The right referred to in paragraph 1 shall not adversely affect the rights and freedoms of others.

## Section 4: Right to object and automated individual decision-making

### Article 21: Right to object

1. The data subject shall have the right to object, on grounds relating to his or her particular situation, at any time to processing of personal data concerning him or her which is based on point (e) or (f) of Article 6(1), including profiling based on those provisions. The controller shall no longer process the personal data unless the controller demonstrates compelling legitimate grounds for the processing which override the interests, rights and freedoms of the data subject or for the establishment, exercise or defence of legal claims.

2. Where personal data are processed for direct marketing purposes, the data subject shall have the right to object at any time to processing of personal data concerning him or her for such marketing, which includes profiling to the extent that it is related to such direct marketing.

3. Where the data subject objects to processing for direct marketing purposes, the personal data shall no longer be processed for such purposes.

4. At the latest at the time of the first communication with the data subject, the right referred to in paragraphs 1 and 2 shall be explicitly brought to the attention of the data subject and shall be presented clearly and separately from any other information.

5. In the context of the use of information society services, and notwithstanding Directive 2002/58/EC, the data subject may exercise his or her right to object by automated means using technical specifications.

6. Where personal data are processed for scientific or historical research purposes or statistical purposes pursuant to Article 89(1), the data subject, on grounds relating to his or her particular situation, shall have the right to object to processing of personal data concerning him or her, unless the processing is necessary for the performance of a task carried out for reasons of public interest.

### Article 22: Automated individual decision-making, including profiling

1. The data subject shall have the right not to be subject to a decision based solely on automated processing, including profiling, which produces legal effects concerning him or her or similarly significantly affects him or her.

2. Paragraph 1 shall not apply if the decision:

   (a) is necessary for entering into, or performance of, a contract between the data subject and a data controller;

   (b) is authorised by Union or Member State law to which the controller is subject and which also lays down suitable measures to safeguard the data subject's rights and freedoms and legitimate interests; or

   (c) is based on the data subject's explicit consent.

3. In the cases referred to in points (a) and (c) of paragraph 2, the data controller shall implement suitable measures to safeguard the data subject's rights and freedoms and legitimate interests, at least the right to obtain human intervention on the part of the controller, to express his or her point of view and to contest the decision.

4. Decisions referred to in paragraph 2 shall not be based on special categories of personal data referred to in Article 9(1), unless point (a) or (g) of Article 9(2) applies and suitable measures to safeguard the data subject's rights and freedoms and legitimate interests are in place.

## Section 5: Restrictions

### Article 23: Restrictions

1. Union or Member State law to which the data controller or processor is subject may restrict by way of a legislative measure the scope of the obligations and rights provided for in Articles 12 to 22 and Article 34, as well as Article 5 in so far as its provisions correspond to the rights and obligations provided for in Articles 12 to 22, when such a restriction respects the essence of the fundamental rights and freedoms and is a necessary and proportionate measure in a democratic society to safeguard:

   (a) national security;

   (b) defence;

   (c) public security;

   (d) the prevention, investigation, detection or prosecution of criminal offences or the execution of criminal penalties, including the safeguarding against and the prevention of threats to public security;

   (e) other important objectives of general public interest of the Union or of a Member State, in particular an important economic or financial interest of the Union or of a Member State, including monetary, budgetary and taxation a matters, public health and social security;

   (f) the protection of judicial independence and judicial proceedings;

   (g) the prevention, investigation, detection and prosecution of breaches of ethics for regulated professions;

   (h) a monitoring, inspection or regulatory function connected, even occasionally, to the exercise of official authority in the cases referred to in points (a) to (e) and (g);

   (i) the protection of the data subject or the rights and freedoms of others;

   (j) the enforcement of civil law claims.

2. In particular, any legislative measure referred to in paragraph 1 shall contain specific provisions at least, where relevant, as to:

   (a) the purposes of the processing or categories of processing;

   (b) the categories of personal data;

   (c) the scope of the restrictions introduced;

   (d) the safeguards to prevent abuse or unlawful access or transfer;

   (e) the specification of the controller or categories of controllers;

   (f) the storage periods and the applicable safeguards taking into account the nature, scope and purposes of the processing or categories of processing;

   (g) the risks to the rights and freedoms of data subjects; and

   (h) the right of data subjects to be informed about the restriction, unless that may be prejudicial to the purpose of the restriction.

## CHAPTER IV: Controller and processor

## Section 1: General obligations

### Article 24: Responsibility of the controller

1. Taking into account the nature, scope, context and purposes of processing as well as the risks of varying likelihood and severity for the rights and freedoms of natural persons, the controller shall implement appropriate technical and organisational measures to ensure and to be able to demonstrate that processing is performed in accordance with this Regulation. Those measures shall be reviewed and updated where necessary.

2. Where proportionate in relation to processing activities, the measures referred to in paragraph 1 shall include the implementation of appropriate data protection policies by the controller.

3. Adherence to approved codes of conduct as referred to in Article 40 or approved certification mechanisms as referred to in Article 42 may be used as an element by which to demonstrate compliance with the obligations of the controller.

### Article 25: Data protection by design and by default

1. Taking into account the state of the art, the cost of implementation and the nature, scope, context and purposes of processing as well as the risks of varying likelihood and severity for rights and freedoms of natural persons posed by the processing, the controller shall, both at the time of the determination of the means for processing and at the time of the processing itself, implement appropriate technical and organisational measures, such as pseudonymisation, which are designed to implement data-protection principles, such as data minimisation, in an effective manner and to integrate the necessary safeguards into the processing in order to meet the requirements of this Regulation and protect the rights of data subjects.

2. The controller shall implement appropriate technical and organisational measures for ensuring that, by default, only personal data which are necessary for each specific purpose of the processing are processed. That obligation applies to the amount of personal data collected, the extent of their processing, the period of their storage and their accessibility. In particular, such measures shall ensure that by default personal data are not made accessible without the individual's intervention to an indefinite number of natural persons.

3. An approved certification mechanism pursuant to Article 42 may be used as an element to demonstrate compliance with the requirements set out in paragraphs 1 and 2 of this Article.

### Article 26: Joint controllers

1. Where two or more controllers jointly determine the purposes and means of processing, they shall be joint controllers. They shall in a transparent manner determine their respective responsibilities for compliance with the obligations under this Regulation, in particular as regards the exercising of the rights of the data subject and their respective duties to provide the information referred to in Articles 13 and 14, by means of an arrangement between them unless, and in so far as, the respective responsibilities of the controllers are determined by Union or Member State law to which the controllers are subject. The arrangement may designate a contact point for data subjects.

2. The arrangement referred to in paragraph 1 shall duly reflect the respective roles and relationships of the joint controllers vis-à-vis the data subjects. The essence of the arrangement shall be made available to the data subject.

3. Irrespective of the terms of the arrangement referred to in paragraph 1, the data subject may exercise his or her rights under this Regulation in respect of and against each of the controllers.

### Article 27: Representatives of controllers or processors not established in the Union

1. Where Article 3(2) applies, the controller or the processor shall designate in writing a representative in the Union.

2. The obligation laid down in paragraph 1 of this Article shall not apply to:

   (a) processing which is occasional, does not include, on a large scale, processing of special categories of data as referred to in Article 9(1) or processing of personal data relating to criminal convictions and offences referred to in Article 10, and is unlikely to result in a risk to the rights and freedoms of natural persons, taking into account the nature, context, scope and purposes of the processing; or

   (b) a public authority or body.

3. The representative shall be established in one of the Member States where the data subjects, whose personal data are processed in relation to the offering of goods or services to them, or whose behaviour is monitored, are.

4. The representative shall be mandated by the controller or processor to be addressed in addition to or instead of the controller or the processor by, in particular, supervisory authorities and data subjects, on all issues related to processing, for the purposes of ensuring compliance with this Regulation.

5. The designation of a representative by the controller or processor shall be without prejudice to legal actions which could be initiated against the controller or the processor themselves.

### Article 28: Processor

1. Where processing is to be carried out on behalf of a controller, the controller shall use only processors providing sufficient guarantees to implement appropriate technical and organisational measures in such a manner that processing will meet the requirements of this Regulation and ensure the protection of the rights of the data subject.

2. The processor shall not engage another processor without prior specific or general written authorisation of the controller. In the case of general written authorisation, the processor shall inform the controller of any intended changes concerning the addition or replacement of other processors, thereby giving the controller the opportunity to object to such changes.

3. Processing by a processor shall be governed by a contract or other legal act under Union or Member State law, that is binding on the processor with regard to the controller and that sets out the subject-matter and duration of the processing, the nature and purpose of the processing, the type of personal data and categories of data subjects and the obligations and rights of the controller. That contract or other legal act shall stipulate, in particular, that the processor:

   (a) processes the personal data only on documented instructions from the controller, including with regard to transfers of personal data to a third country or an international organisation, unless required to do so by Union or Member State law to which the processor is subject; in such a case, the processor shall inform the controller of that legal requirement before processing, unless that law prohibits such information on important grounds of public interest;

   (b) ensures that persons authorised to process the personal data have committed themselves to confidentiality or are under an appropriate statutory obligation of confidentiality;

   (c) takes all measures required pursuant to Article 32;

   (d) respects the conditions referred to in paragraphs 2 and 4 for engaging another processor;

   (e) taking into account the nature of the processing, assists the controller by appropriate technical and organisational measures, insofar as this is possible, for the fulfilment of the controller's obligation to respond to requests for exercising the data subject's rights laid down in Chapter III;

   (f) assists the controller in ensuring compliance with the obligations pursuant to Articles 32 to 36 taking into account the nature of processing and the information available to the processor;

   (g) at the choice of the controller, deletes or returns all the personal data to the controller after the end of the provision of services relating to processing, and deletes existing copies unless Union or Member State law requires storage of the personal data;

   (h) makes available to the controller all information necessary to demonstrate compliance with the obligations laid down in this Article and allow for and contribute to audits, including inspections, conducted by the controller or another auditor mandated by the controller.

With regard to point (h) of the first subparagraph, the processor shall immediately inform the controller if, in its opinion, an instruction infringes this Regulation or other Union or Member State data protection provisions.

4. Where a processor engages another processor for carrying out specific processing activities on behalf of the controller, the same data protection obligations as set out in the contract or other legal act between the controller and the processor as referred to in paragraph 3 shall be imposed on that other processor by way of a contract or other legal act under Union or Member State law, in particular providing sufficient guarantees to implement appropriate technical and organisational measures in such a manner that the processing will meet the requirements of this Regulation. Where that other processor fails to fulfil its data protection obligations, the initial processor shall remain fully liable to the controller for the performance of that other processor's obligations.

5. Adherence of a processor to an approved code of conduct as referred to in Article 40 or an approved certification mechanism as referred to in Article 42 may be used as an element by which to demonstrate sufficient guarantees as referred to in paragraphs 1 and 4 of this Article.

6. Without prejudice to an individual contract between the controller and the processor, the contract or the other legal act referred to in paragraphs 3 and 4 of this Article may be based, in whole or in part, on standard contractual clauses referred to in paragraphs 7 and 8 of this Article, including when they are part of a certification granted to the controller or processor pursuant to Articles 42 and 43.

7. The Commission may lay down standard contractual clauses for the matters referred to in paragraph 3 and 4 of this Article and in accordance with the examination procedure referred to in Article 93(2).

8. A supervisory authority may adopt standard contractual clauses for the matters referred to in paragraph 3 and 4 of this Article and in accordance with the consistency mechanism referred to in Article 63.

9. The contract or the other legal act referred to in paragraphs 3 and 4 shall be in writing, including in electronic form.

10. Without prejudice to Articles 82, 83 and 84, if a processor infringes this Regulation by determining the purposes and means of processing, the processor shall be considered to be a controller in respect of that processing.

### Article 29: Processing under the authority of the controller or processor

The processor and any person acting under the authority of the controller or of the processor, who has access to personal data, shall not process those data except on instructions from the controller, unless required to do so by Union or Member State law.

### Article 30: Records of processing activities

1. Each controller and, where applicable, the controller's representative, shall maintain a record of processing activities under its responsibility. That record shall contain all of the following information:

   (a) the name and contact details of the controller and, where applicable, the joint controller, the controller's representative and the data protection officer;

   (b) the purposes of the processing;

   (c) a description of the categories of data subjects and of the categories of personal data;

   (d) the categories of recipients to whom the personal data have been or will be disclosed including recipients in third countries or international organisations;

   (e) where applicable, transfers of personal data to a third country or an international organisation, including the identification of that third country or international organisation and, in the case of transfers referred to in the second subparagraph of Article 49(1), the documentation of suitable safeguards;

   (f) where possible, the envisaged time limits for erasure of the different categories of data;

   (g) where possible, a general description of the technical and organisational security measures referred to in Article 32(1).

2. Each processor and, where applicable, the processor's representative shall maintain a record of all categories of processing activities carried out on behalf of a controller, containing:

   (a) the name and contact details of the processor or processors and of each controller on behalf of which the processor is acting, and, where applicable, of the controller's or the processor's representative, and the data protection officer;

   (b) the categories of processing carried out on behalf of each controller;

   (c) where applicable, transfers of personal data to a third country or an international organisation, including the identification of that third country or international organisation and, in the case of transfers referred to in the second subparagraph of Article 49(1), the documentation of suitable safeguards;

   (d) where possible, a general description of the technical and organisational security measures referred to in Article 32(1).

3. The records referred to in paragraphs 1 and 2 shall be in writing, including in electronic form.

4. The controller or the processor and, where applicable, the controller's or the processor's representative, shall make the record available to the supervisory authority on request.

5. The obligations referred to in paragraphs 1 and 2 shall not apply to an enterprise or an organisation employing fewer than 250 persons unless the processing it carries out is likely to result in a risk to the rights and freedoms of data subjects, the processing is not occasional, or the processing includes special categories of data as referred to in Article 9(1) or personal data relating to criminal convictions and offences referred to in Article 10.

### Article 31: Cooperation with the supervisory authority

The controller and the processor and, where applicable, their representatives, shall cooperate, on request, with the supervisory authority in the performance of its tasks.

## Section 2: Security of personal data

### Article 32: Security of processing

1. Taking into account the state of the art, the costs of implementation and the nature, scope, context and purposes of processing as well as the risk of varying likelihood and severity for the rights and freedoms of natural persons, the controller and the processor shall implement appropriate technical and organisational measures to ensure a level of security appropriate to the risk, including inter alia as appropriate:

   (a) the pseudonymisation and encryption of personal data;

   (b) the ability to ensure the ongoing confidentiality, integrity, availability and resilience of processing systems and services;

   (c) the ability to restore the availability and access to personal data in a timely manner in the event of a physical or technical incident;

   (d) a process for regularly testing, assessing and evaluating the effectiveness of technical and organisational measures for ensuring the security of the processing.

2. In assessing the appropriate level of security account shall be taken in particular of the risks that are presented by processing, in particular from accidental or unlawful destruction, loss, alteration, unauthorised disclosure of, or access to personal data transmitted, stored or otherwise processed.

3. Adherence to an approved code of conduct as referred to in Article 40 or an approved certification mechanism as referred to in Article 42 may be used as an element by which to demonstrate compliance with the requirements set out in paragraph 1 of this Article.

4. The controller and processor shall take steps to ensure that any natural person acting under the authority of the controller or the processor who has access to personal data does not process them except on instructions from the controller, unless he or she is required to do so by Union or Member State law.

### Article 33: Notification of a personal data breach to the supervisory authority

1. In the case of a personal data breach, the controller shall without undue delay and, where feasible, not later than 72 hours after having become aware of it, notify the personal data breach to the supervisory authority competent in accordance with Article 55, unless the personal data breach is unlikely to result in a risk to the rights and freedoms of natural persons. Where the notification to the supervisory authority is not made within 72 hours, it shall be accompanied by reasons for the delay.

2. The processor shall notify the controller without undue delay after becoming aware of a personal data breach.

3. The notification referred to in paragraph 1 shall at least:

   (a) describe the nature of the personal data breach including where possible, the categories and approximate number of data subjects concerned and the categories and approximate number of personal data records concerned;

   (b) communicate the name and contact details of the data protection officer or other contact point where more information can be obtained;

   (c) describe the likely consequences of the personal data breach;

   (d) describe the measures taken or proposed to be taken by the controller to address the personal data breach, including, where appropriate, measures to mitigate its possible adverse effects.

4. Where, and in so far as, it is not possible to provide the information at the same time, the information may be provided in phases without undue further delay.

5. The controller shall document any personal data breaches, comprising the facts relating to the personal data breach, its effects and the remedial action taken. That documentation shall enable the supervisory authority to verify compliance with this Article.

### Article 34: Communication of a personal data breach to the data subject

1. When the personal data breach is likely to result in a high risk to the rights and freedoms of natural persons, the controller shall communicate the personal data breach to the data subject without undue delay.

2. The communication to the data subject referred to in paragraph 1 of this Article shall describe in clear and plain language the nature of the personal data breach and contain at least the information and measures referred to in points (b), (c) and (d) of Article 33(3).

3. The communication to the data subject referred to in paragraph 1 shall not be required if any of the following conditions are met:

   (a) the controller has implemented appropriate technical and organisational protection measures, and those measures were applied to the personal data affected by the personal data breach, in particular those that render the personal data unintelligible to any person who is not authorised to access it, such as encryption;

   (b) the controller has taken subsequent measures which ensure that the high risk to the rights and freedoms of data subjects referred to in paragraph 1 is no longer likely to materialise;

   (c) it would involve disproportionate effort. In such a case, there shall instead be a public communication or similar measure whereby the data subjects are informed in an equally effective manner.

4. If the controller has not already communicated the personal data breach to the data subject, the supervisory authority, having considered the likelihood of the personal data breach resulting in a high risk, may require it to do so or may decide that any of the conditions referred to in paragraph 3 are met.

## Section 3: Data protection impact assessment and prior consultation

### Article 35: Data protection impact assessment

1. Where a type of processing in particular using new technologies, and taking into account the nature, scope, context and purposes of the processing, is likely to result in a high risk to the rights and freedoms of natural persons, the controller shall, prior to the processing, carry out an assessment of the impact of the envisaged processing operations on the protection of personal data. A single assessment may address a set of similar processing operations that present similar high risks.

2. The controller shall seek the advice of the data protection officer, where designated, when carrying out a data protection impact assessment.

3. A data protection impact assessment referred to in paragraph 1 shall in particular be required in the case of:

   (a) a systematic and extensive evaluation of personal aspects relating to natural persons which is based on automated processing, including profiling, and on which decisions are based that produce legal effects concerning the natural person or similarly significantly affect the natural person;

   (b) processing on a large scale of special categories of data referred to in Article 9(1), or of personal data relating to criminal convictions and offences referred to in Article 10; or

   (c) a systematic monitoring of a publicly accessible area on a large scale.

4. The supervisory authority shall establish and make public a list of the kind of processing operations which are subject to the requirement for a data protection impact assessment pursuant to paragraph 1. The supervisory authority shall communicate those lists to the Board referred to in Article 68.

5. The supervisory authority may also establish and make public a list of the kind of processing operations for which no data protection impact assessment is required. The supervisory authority shall communicate those lists to the Board.

6. Prior to the adoption of the lists referred to in paragraphs 4 and 5, the competent supervisory authority shall apply the consistency mechanism referred to in Article 63 where such lists involve processing activities which are related to the offering of goods or services to data subjects or to the monitoring of their behaviour in several Member States, or may substantially affect the free movement of personal data within the Union.

7. The assessment shall contain at least:

   (a) a systematic description of the envisaged processing operations and the purposes of the processing, including, where applicable, the legitimate interest pursued by the controller;

   (b) an assessment of the necessity and proportionality of the processing operations in relation to the purposes;

   (c) an assessment of the risks to the rights and freedoms of data subjects referred to in paragraph 1; and

   (d) the measures envisaged to address the risks, including safeguards, security measures and mechanisms to ensure the protection of personal data and to demonstrate compliance with this Regulation taking into account the rights and legitimate interests of data subjects and other persons concerned.

8. Compliance with approved codes of conduct referred to in Article 40 by the relevant controllers or processors shall be taken into due account in assessing the impact of the processing operations performed by such controllers or processors, in particular for the purposes of a data protection impact assessment.

9. Where appropriate, the controller shall seek the views of data subjects or their representatives on the intended processing, without prejudice to the protection of commercial or public interests or the security of processing operations.

10. Where processing pursuant to point (c) or (e) of Article 6(1) has a legal basis in Union law or in the law of the Member State to which the controller is subject, that law regulates the specific processing operation or set of operations in question, and a data protection impact assessment has already been carried out as part of a general impact assessment in the context of the adoption of that legal basis, paragraphs 1 to 7 shall not apply unless Member States deem it to be necessary to carry out such an assessment prior to processing activities.

11. Where necessary, the controller shall carry out a review to assess if processing is performed in accordance with the data protection impact assessment at least when there is a change of the risk represented by processing operations.

### Article 36: Prior consultation

1. The controller shall consult the supervisory authority prior to processing where a data protection impact assessment under Article 35 indicates that the processing would result in a high risk in the absence of measures taken by the controller to mitigate the risk.

2. Where the supervisory authority is of the opinion that the intended processing referred to in paragraph 1 would infringe this Regulation, in particular where the controller has insufficiently identified or mitigated the risk, the supervisory authority shall, within period of up to eight weeks of receipt of the request for consultation, provide written advice to the controller and, where applicable to the processor, and may use any of its powers referred to in Article 58. That period may be extended by six weeks, taking into account the complexity of the intended processing. The supervisory authority shall inform the controller and, where applicable, the processor, of any such extension within one month of receipt of the request for consultation together with the reasons for the delay. Those periods may be suspended until the supervisory authority has obtained information it has requested for the purposes of the consultation.

3. When consulting the supervisory authority pursuant to paragraph 1, the controller shall provide the supervisory authority with:

   (a) where applicable, the respective responsibilities of the controller, joint controllers and processors involved in the processing, in particular for processing within a group of undertakings;

   (b) the purposes and means of the intended processing;

   (c) the measures and safeguards provided to protect the rights and freedoms of data subjects pursuant to this Regulation;

   (d) where applicable, the contact details of the data protection officer;

   (e) the data protection impact assessment provided for in Article 35; and

   (f) any other information requested by the supervisory authority.

4. Member States shall consult the supervisory authority during the preparation of a proposal for a legislative measure to be adopted by a national parliament, or of a regulatory measure based on such a legislative measure, which relates to processing.

5. Notwithstanding paragraph 1, Member State law may require controllers to consult with, and obtain prior authorisation from, the supervisory authority in relation to processing by a controller for the performance of a task carried out by the controller in the public interest, including processing in relation to social protection and public health.

## Section 4: Data protection officer

### Article 37: Designation of the data protection officer

1. The controller and the processor shall designate a data protection officer in any case where:

   (a) the processing is carried out by a public authority or body, except for courts acting in their judicial capacity;

   (b) the core activities of the controller or the processor consist of processing operations which, by virtue of their nature, their scope and/or their purposes, require regular and systematic monitoring of data subjects on a large scale; or

   (c) the core activities of the controller or the processor consist of processing on a large scale of special categories of data pursuant to Article 9 and personal data relating to criminal convictions and offences referred to in Article 10.

2. A group of undertakings may appoint a single data protection officer provided that a data protection officer is easily accessible from each establishment.

3. Where the controller or the processor is a public authority or body, a single data protection officer may be designated for several such authorities or bodies, taking account of their organisational structure and size.

4. In cases other than those referred to in paragraph 1, the controller or processor or associations and other bodies representing categories of controllers or processors may or, where required by Union or Member State law shall, designate a data protection officer. The data protection officer may act for such associations and other bodies representing controllers or processors.

5. The data protection officer shall be designated on the basis of professional qualities and, in particular, expert knowledge of data protection law and practices and the ability to fulfil the tasks referred to in Article 39.

6. The data protection officer may be a staff member of the controller or processor, or fulfil the tasks on the basis of a service contract.

7. The controller or the processor shall publish the contact details of the data protection officer and communicate them to the supervisory authority.

### Article 38: Position of the data protection officer

1. The controller and the processor shall ensure that the data protection officer is involved, properly and in a timely manner, in all issues which relate to the protection of personal data.

2. The controller and processor shall support the data protection officer in performing the tasks referred to in Article 39 by providing resources necessary to carry out those tasks and access to personal data and processing operations, and to maintain his or her expert knowledge.

3. The controller and processor shall ensure that the data protection officer does not receive any instructions regarding the exercise of those tasks. He or she shall not be dismissed or penalised by the controller or the processor for performing his tasks. The data protection officer shall directly report to the highest management level of the controller or the processor.

4. Data subjects may contact the data protection officer with regard to all issues related to processing of their personal data and to the exercise of their rights under this Regulation.

5. The data protection officer shall be bound by secrecy or confidentiality concerning the performance of his or her tasks, in accordance with Union or Member State law.

6. The data protection officer may fulfil other tasks and duties. The controller or processor shall ensure that any such tasks and duties do not result in a conflict of interests.

### Article 39: Tasks of the data protection officer

1. The data protection officer shall have at least the following tasks:

   (a) to inform and advise the controller or the processor and the employees who carry out processing of their obligations pursuant to this Regulation and to other Union or Member State data protection provisions;

   (b) to monitor compliance with this Regulation, with other Union or Member State data protection provisions and with the policies of the controller or processor in relation to the protection of personal data, including the assignment of responsibilities, awareness-raising and training of staff involved in processing operations, and the related audits;

   (c) to provide advice where requested as regards the data protection impact assessment and monitor its performance pursuant to Article 35;

   (d) to cooperate with the supervisory authority;

   (e) to act as the contact point for the supervisory authority on issues relating to processing, including the prior consultation referred to in Article 36, and to consult, where appropriate, with regard to any other matter.

2. The data protection officer shall in the performance of his or her tasks have due regard to the risk associated with processing operations, taking into account the nature, scope, context and purposes of processing.

## Section 5: Codes of conduct and certification

### Article 40: Codes of conduct

1. The Member States, the supervisory authorities, the Board and the Commission shall encourage the drawing up of codes of conduct intended to contribute to the proper application of this Regulation, taking account of the specific features of the various processing sectors and the specific needs of micro, small and medium-sized enterprises.

2. Associations and other bodies representing categories of controllers or processors may prepare codes of conduct, or amend or extend such codes, for the purpose of specifying the application of this Regulation, such as with regard to:

   (a) fair and transparent processing;

   (b) the legitimate interests pursued by controllers in specific contexts;

   (c) the collection of personal data;

   (d) the pseudonymisation of personal data;

   (e) the information provided to the public and to data subjects;

   (f) the exercise of the rights of data subjects;

   (g) the information provided to, and the protection of, children, and the manner in which the consent of the holders of parental responsibility over children is to be obtained;

   (h) the measures and procedures referred to in Articles 24 and 25 and the measures to ensure security of processing referred to in Article 32;

   (i) the notification of personal data breaches to supervisory authorities and the communication of such personal data breaches to data subjects;

   (j) the transfer of personal data to third countries or international organisations; or

   (k) out-of-court proceedings and other dispute resolution procedures for resolving disputes between controllers and data subjects with regard to processing, without prejudice to the rights of data subjects pursuant to Articles 77 and 79.

3. In addition to adherence by controllers or processors subject to this Regulation, codes of conduct approved pursuant to paragraph 5 of this Article and having general validity pursuant to paragraph 9 of this Article may also be adhered to by controllers or processors that are not subject to this Regulation pursuant to Article 3 in order to provide appropriate safeguards within the framework of personal data transfers to third countries or international organisations under the terms referred to in point (e) of Article 46(2). Such controllers or processors shall make binding and enforceable commitments, via contractual or other legally binding instruments, to apply those appropriate safeguards including with regard to the rights of data subjects.

4. A code of conduct referred to in paragraph 2 of this Article shall contain mechanisms which enable the body referred to in Article 41(1) to carry out the mandatory monitoring of compliance with its provisions by the controllers or processors which undertake to apply it, without prejudice to the tasks and powers of supervisory authorities competent pursuant to Article 55 or 56.

5. Associations and other bodies referred to in paragraph 2 of this Article which intend to prepare a code of conduct or to amend or extend an existing code shall submit the draft code, amendment or extension to the supervisory authority which is competent pursuant to Article 55. The supervisory authority shall provide an opinion on whether the draft code, amendment or extension complies with this Regulation and shall approve that draft code, amendment or extension if it finds that it provides sufficient appropriate safeguards.

6. Where the draft code, or amendment or extension is approved in accordance with paragraph 5, and where the code of conduct concerned does not relate to processing activities in several Member States, the supervisory authority shall register and publish the code.

7. Where a draft code of conduct relates to processing activities in several Member States, the supervisory authority which is competent pursuant to Article 55 shall, before approving the draft code, amendment or extension, submit it in the procedure referred to in Article 63 to the Board which shall provide an opinion on whether the draft code, amendment or extension complies with this Regulation or, in the situation referred to in paragraph 3 of this Article, provides appropriate safeguards.

8. Where the opinion referred to in paragraph 7 confirms that the draft code, amendment or extension complies with this Regulation, or, in the situation referred to in paragraph 3, provides appropriate safeguards, the Board shall submit its opinion to the Commission.

9. The Commission may, by way of implementing acts, decide that the approved code of conduct, amendment or extension submitted to it pursuant to paragraph 8 of this Article have general validity within the Union. Those implementing acts shall be adopted in accordance with the examination procedure set out in Article 93(2).

10. The Commission shall ensure appropriate publicity for the approved codes which have been decided as having general validity in accordance with paragraph 9.

11. The Board shall collate all approved codes of conduct, amendments and extensions in a register and shall make them publicly available by way of appropriate means.

### Article 41: Monitoring of approved codes of conduct

1. Without prejudice to the tasks and powers of the competent supervisory authority under Articles 57 and 58, the monitoring of compliance with a code of conduct pursuant to Article 40 may be carried out by a body which has an appropriate level of expertise in relation to the subject-matter of the code and is accredited for that purpose by the competent supervisory authority.

2. A body as referred to in paragraph 1 may be accredited to monitor compliance with a code of conduct where that body has:

   (a) demonstrated its independence and expertise in relation to the subject-matter of the code to the satisfaction of the competent supervisory authority;

   (b) established procedures which allow it to assess the eligibility of controllers and processors concerned to apply the code, to monitor their compliance with its provisions and to periodically review its operation;

   (c) established procedures and structures to handle complaints about infringements of the code or the manner in which the code has been, or is being, implemented by a controller or processor, and to make those procedures and structures transparent to data subjects and the public; and

   (d) demonstrated to the satisfaction of the competent supervisory authority that its tasks and duties do not result in a conflict of interests.

3. The competent supervisory authority shall submit the draft criteria for accreditation of a body as referred to in paragraph 1 of this Article to the Board pursuant to the consistency mechanism referred to in Article 63.

4. Without prejudice to the tasks and powers of the competent supervisory authority and the provisions of Chapter VIII, a body as referred to in paragraph 1 of this Article shall, subject to appropriate safeguards, take appropriate action in cases of infringement of the code by a controller or processor, including suspension or exclusion of the controller or processor concerned from the code. It shall inform the competent supervisory authority of such actions and the reasons for taking them.

5. The competent supervisory authority shall revoke the accreditation of a body as referred to in paragraph 1 if the conditions for accreditation are not, or are no longer, met or where actions taken by the body infringe this Regulation.

6. This Article shall not apply to processing carried out by public authorities and bodies.

### Article 42: Certification

1. The Member States, the supervisory authorities, the Board and the Commission shall encourage, in particular at Union level, the establishment of data protection certification mechanisms and of data protection seals and marks, for the purpose of demonstrating compliance with this Regulation of processing operations by controllers and processors. The specific needs of micro, small and medium-sized enterprises shall be taken into account.

2. In addition to adherence by controllers or processors subject to this Regulation, data protection certification mechanisms, seals or marks approved pursuant to paragraph 5 of this Article may be established for the purpose of demonstrating the existence of appropriate safeguards provided by controllers or processors that are not subject to this Regulation pursuant to Article 3 within the framework of personal data transfers to third countries or international organisations under the terms referred to in point (f) of Article 46(2). Such controllers or processors shall make binding and enforceable commitments, via contractual or other legally binding instruments, to apply those appropriate safeguards, including with regard to the rights of data subjects.

3. The certification shall be voluntary and available via a process that is transparent.

4. A certification pursuant to this Article does not reduce the responsibility of the controller or the processor for compliance with this Regulation and is without prejudice to the tasks and powers of the supervisory authorities which are competent pursuant to Article 55 or 56.

5. A certification pursuant to this Article shall be issued by the certification bodies referred to in Article 43 or by the competent supervisory authority, on the basis of criteria approved by that competent supervisory authority pursuant to Article 58(3) or by the Board pursuant to Article 63. Where the criteria are approved by the Board, this may result in a common certification, the European Data Protection Seal.

6. The controller or processor which submits its processing to the certification mechanism shall provide the certification body referred to in Article 43, or where applicable, the competent supervisory authority, with all information and access to its processing activities which are necessary to conduct the certification procedure.

7. Certification shall be issued to a controller or processor for a maximum period of three years and may be renewed, under the same conditions, provided that the relevant requirements continue to be met. Certification shall be withdrawn, as applicable, by the certification bodies referred to in Article 43 or by the competent supervisory authority where the requirements for the certification are not or are no longer met.

8. The Board shall collate all certification mechanisms and data protection seals and marks in a register and shall make them publicly available by any appropriate means.

### Article 43: Certification bodies

1. Without prejudice to the tasks and powers of the competent supervisory authority under Articles 57 and 58, certification bodies which have an appropriate level of expertise in relation to data protection shall, after informing the supervisory authority in order to allow it to exercise its powers pursuant to point (h) of Article 58(2) where necessary, issue and renew certification. Member States shall ensure that those certification bodies are accredited by one or both of the following:

   (a) the supervisory authority which is competent pursuant to Article 55 or 56;

   (b) the national accreditation body named in accordance with Regulation (EC) No 765/2008 of the European Parliament and of the Council (20) in accordance with EN-ISO/IEC 17065/2012 and with the additional requirements established by the supervisory authority which is competent pursuant to Article 55 or 56.

2. Certification bodies referred to in paragraph 1 shall be accredited in accordance with that paragraph only where they have:

   (a) demonstrated their independence and expertise in relation to the subject-matter of the certification to the satisfaction of the competent supervisory authority;

   (b) undertaken to respect the criteria referred to in Article 42(5) and approved by the supervisory authority which is competent pursuant to Article 55 or 56 or by the Board pursuant to Article 63;

   (c) established procedures for the issuing, periodic review and withdrawal of data protection certification, seals and marks;

   (d) established procedures and structures to handle complaints about infringements of the certification or the manner in which the certification has been, or is being, implemented by the controller or processor, and to make those procedures and structures transparent to data subjects and the public; and

   (e) demonstrated, to the satisfaction of the competent supervisory authority, that their tasks and duties do not result in a conflict of interests.

3. The accreditation of certification bodies as referred to in paragraphs 1 and 2 of this Article shall take place on the basis of criteria approved by the supervisory authority which is competent pursuant to Article 55 or 56 or by the Board pursuant to Article 63. In the case of accreditation pursuant to point (b) of paragraph 1 of this Article, those requirements shall complement those envisaged in Regulation (EC) No 765/2008 and the technical rules that describe the methods and procedures of the certification bodies.

4. The certification bodies referred to in paragraph 1 shall be responsible for the proper assessment leading to the certification or the withdrawal of such certification without prejudice to the responsibility of the controller or processor for compliance with this Regulation. The accreditation shall be issued for a maximum period of five years and may be renewed on the same conditions provided that the certification body meets the requirements set out in this Article.

5. The certification bodies referred to in paragraph 1 shall provide the competent supervisory authorities with the reasons for granting or withdrawing the requested certification.

6. The requirements referred to in paragraph 3 of this Article and the criteria referred to in Article 42(5) shall be made public by the supervisory authority in an easily accessible form. The supervisory authorities shall also transmit those requirements and criteria to the Board. The Board shall collate all certification mechanisms and data protection seals in a register and shall make them publicly available by any appropriate means.

7. Without prejudice to Chapter VIII, the competent supervisory authority or the national accreditation body shall revoke an accreditation of a certification body pursuant to paragraph 1 of this Article where the conditions for the accreditation are not, or are no longer, met or where actions taken by a certification body infringe this Regulation.

8. The Commission shall be empowered to adopt delegated acts in accordance with Article 92 for the purpose of specifying the requirements to be taken into account for the data protection certification mechanisms referred to in Article 42(1).

9. The Commission may adopt implementing acts laying down technical standards for certification mechanisms and data protection seals and marks, and mechanisms to promote and recognise those certification mechanisms, seals and marks. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 93(2).

## CHAPTER V: Transfers of personal data to third countries or international organisations

### Article 44: General principle for transfers

Any transfer of personal data which are undergoing processing or are intended for processing after transfer to a third country or to an international organisation shall take place only if, subject to the other provisions of this Regulation, the conditions laid down in this Chapter are complied with by the controller and processor, including for onward transfers of personal data from the third country or an international organisation to another third country or to another international organisation. All provisions in this Chapter shall be applied in order to ensure that the level of protection of natural persons guaranteed by this Regulation is not undermined.

### Article 45: Transfers on the basis of an adequacy decision

1. A transfer of personal data to a third country or an international organisation may take place where the Commission has decided that the third country, a territory or one or more specified sectors within that third country, or the international organisation in question ensures an adequate level of protection. Such a transfer shall not require any specific authorisation.

2. When assessing the adequacy of the level of protection, the Commission shall, in particular, take account of the following elements:

   (a) the rule of law, respect for human rights and fundamental freedoms, relevant legislation, both general and sectoral, including concerning public security, defence, national security and criminal law and the access of public authorities to personal data, as well as the implementation of such legislation, data protection rules, professional rules and security measures, including rules for the onward transfer of personal data to another third country or international organisation which are complied with in that country or international organisation, case-law, as well as effective and enforceable data subject rights and effective administrative and judicial redress for the data subjects whose personal data are being transferred;

   (b) the existence and effective functioning of one or more independent supervisory authorities in the third country or to which an international organisation is subject, with responsibility for ensuring and enforcing compliance with the data protection rules, including adequate enforcement powers, for assisting and advising the data subjects in exercising their rights and for cooperation with the supervisory authorities of the Member States; and

   (c) the international commitments the third country or international organisation concerned has entered into, or other obligations arising from legally binding conventions or instruments as well as from its participation in multilateral or regional systems, in particular in relation to the protection of personal data.

3. The Commission, after assessing the adequacy of the level of protection, may decide, by means of implementing act, that a third country, a territory or one or more specified sectors within a third country, or an international organisation ensures an adequate level of protection within the meaning of paragraph 2 of this Article. The implementing act shall provide for a mechanism for a periodic review, at least every four years, which shall take into account all relevant developments in the third country or international organisation. The implementing act shall specify its territorial and sectoral application and, where applicable, identify the supervisory authority or authorities referred to in point (b) of paragraph 2 of this Article. The implementing act shall be adopted in accordance with the examination procedure referred to in Article 93(2).

4. The Commission shall, on an ongoing basis, monitor developments in third countries and international organisations that could affect the functioning of decisions adopted pursuant to paragraph 3 of this Article and decisions adopted on the basis of Article 25(6) of Directive 95/46/EC.

5. The Commission shall, where available information reveals, in particular following the review referred to in paragraph 3 of this Article, that a third country, a territory or one or more specified sectors within a third country, or an international organisation no longer ensures an adequate level of protection within the meaning of paragraph 2 of this Article, to the extent necessary, repeal, amend or suspend the decision referred to in paragraph 3 of this Article by means of implementing acts without retro-active effect. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 93(2).

   On duly justified imperative grounds of urgency, the Commission shall adopt immediately applicable implementing acts in accordance with the procedure referred to in Article 93(3).

6. The Commission shall enter into consultations with the third country or international organisation with a view to remedying the situation giving rise to the decision made pursuant to paragraph 5.

7. A decision pursuant to paragraph 5 of this Article is without prejudice to transfers of personal data to the third country, a territory or one or more specified sectors within that third country, or the international organisation in question pursuant to Articles 46 to 49.

8. The Commission shall publish in the Official Journal of the European Union and on its website a list of the third countries, territories and specified sectors within a third country and international organisations for which it has decided that an adequate level of protection is or is no longer ensured.

9. Decisions adopted by the Commission on the basis of Article 25(6) of Directive 95/46/EC shall remain in force until amended, replaced or repealed by a Commission Decision adopted in accordance with paragraph 3 or 5 of this Article.

### Article 46: Transfers subject to appropriate safeguards

1. In the absence of a decision pursuant to Article 45(3), a controller or processor may transfer personal data to a third country or an international organisation only if the controller or processor has provided appropriate safeguards, and on condition that enforceable data subject rights and effective legal remedies for data subjects are available.

2. The appropriate safeguards referred to in paragraph 1 may be provided for, without requiring any specific authorisation from a supervisory authority, by:

   (a) a legally binding and enforceable instrument between public authorities or bodies;

   (b) binding corporate rules in accordance with Article 47;

   (c) standard data protection clauses adopted by the Commission in accordance with the examination procedure referred to in Article 93(2);

   (d) standard data protection clauses adopted by a supervisory authority and approved by the Commission pursuant to the examination procedure referred to in Article 93(2);

   (e) an approved code of conduct pursuant to Article 40 together with binding and enforceable commitments of the controller or processor in the third country to apply the appropriate safeguards, including as regards data subjects' rights; or

   (f) an approved certification mechanism pursuant to Article 42 together with binding and enforceable commitments of the controller or processor in the third country to apply the appropriate safeguards, including as regards data subjects' rights.

3. Subject to the authorisation from the competent supervisory authority, the appropriate safeguards referred to in paragraph 1 may also be provided for, in particular, by:

   (a) contractual clauses between the controller or processor and the controller, processor or the recipient of the personal data in the third country or international organisation; or

   (b) provisions to be inserted into administrative arrangements between public authorities or bodies which include enforceable and effective data subject rights.

4. The supervisory authority shall apply the consistency mechanism referred to in Article 63 in the cases referred to in paragraph 3 of this Article.

5. Authorisations by a Member State or supervisory authority on the basis of Article 26(2) of Directive 95/46/EC shall remain valid until amended, replaced or repealed, if necessary, by that supervisory authority. Decisions adopted by the Commission on the basis of Article 26(4) of Directive 95/46/EC shall remain in force until amended, replaced or repealed, if necessary, by a Commission Decision adopted in accordance with paragraph 2 of this Article.

### Article 47: Binding corporate rules

1. The competent supervisory authority shall approve binding corporate rules in accordance with the consistency mechanism set out in Article 63, provided that they:

   (a) are legally binding and apply to and are enforced by every member concerned of the group of undertakings, or group of enterprises engaged in a joint economic activity, including their employees;

   (b) expressly confer enforceable rights on data subjects with regard to the processing of their personal data; and

   (c) fulfil the requirements laid down in paragraph 2.

2. The binding corporate rules referred to in paragraph 1 shall specify at least:

   (a) the structure and contact details of the group of undertakings, or group of enterprises engaged in a joint economic activity and of each of its members;

   (b) the data transfers or set of transfers, including the categories of personal data, the type of processing and its purposes, the type of data subjects affected and the identification of the third country or countries in question;

   (c) their legally binding nature, both internally and externally;

   (d) the application of the general data protection principles, in particular purpose limitation, data minimisation, limited storage periods, data quality, data protection by design and by default, legal basis for processing, processing of special categories of personal data, measures to ensure data security, and the requirements in respect of onward transfers to bodies not bound by the binding corporate rules;

   (e) the rights of data subjects in regard to processing and the means to exercise those rights, including the right not to be subject to decisions based solely on automated processing, including profiling in accordance with Article 22, the right to lodge a complaint with the competent supervisory authority and before the competent courts of the Member States in accordance with Article 79, and to obtain redress and, where appropriate, compensation for a breach of the binding corporate rules;

   (f) the acceptance by the controller or processor established on the territory of a Member State of liability for any breaches of the binding corporate rules by any member concerned not established in the Union; the controller or the processor shall be exempt from that liability, in whole or in part, only if it proves that that member is not responsible for the event giving rise to the damage;

   (g) how the information on the binding corporate rules, in particular on the provisions referred to in points (d), (e) and (f) of this paragraph is provided to the data subjects in addition to Articles 13 and 14;

   (h) the tasks of any data protection officer designated in accordance with Article 37 or any other person or entity in charge of the monitoring compliance with the binding corporate rules within the group of undertakings, or group of enterprises engaged in a joint economic activity, as well as monitoring training and complaint-handling;

   (i) the complaint procedures;

   (j) the mechanisms within the group of undertakings, or group of enterprises engaged in a joint economic activity for ensuring the verification of compliance with the binding corporate rules. Such mechanisms shall include data protection audits and methods for ensuring corrective actions to protect the rights of the data subject. Results of such verification should be communicated to the person or entity referred to in point (h) and to the board of the controlling undertaking of a group of undertakings, or of the group of enterprises engaged in a joint economic activity, and should be available upon request to the competent supervisory authority;

   (k) the mechanisms for reporting and recording changes to the rules and reporting those changes to the supervisory authority;

   (l) the cooperation mechanism with the supervisory authority to ensure compliance by any member of the group of undertakings, or group of enterprises engaged in a joint economic activity, in particular by making available to the supervisory authority the results of verifications of the measures referred to in point (j);

   (m) the mechanisms for reporting to the competent supervisory authority any legal requirements to which a member of the group of undertakings, or group of enterprises engaged in a joint economic activity is subject in a third country which are likely to have a substantial adverse effect on the guarantees provided by the binding corporate rules; and

   (n) the appropriate data protection training to personnel having permanent or regular access to personal data.

3. The Commission may specify the format and procedures for the exchange of information between controllers, processors and supervisory authorities for binding corporate rules within the meaning of this Article. Those implementing acts shall be adopted in accordance with the examination procedure set out in Article 93(2).

### Article 48: Transfers or disclosures not authorised by Union law

Any judgment of a court or tribunal and any decision of an administrative authority of a third country requiring a controller or processor to transfer or disclose personal data may only be recognised or enforceable in any manner if based on an international agreement, such as a mutual legal assistance treaty, in force between the requesting third country and the Union or a Member State, without prejudice to other grounds for transfer pursuant to this Chapter.

### Article 49: Derogations for specific situations

1. In the absence of an adequacy decision pursuant to Article 45(3), or of appropriate safeguards pursuant to Article 46, including binding corporate rules, a transfer or a set of transfers of personal data to a third country or an international organisation shall take place only on one of the following conditions:

   (a) the data subject has explicitly consented to the proposed transfer, after having been informed of the possible risks of such transfers for the data subject due to the absence of an adequacy decision and appropriate safeguards;

   (b) the transfer is necessary for the performance of a contract between the data subject and the controller or the implementation of pre-contractual measures taken at the data subject's request;

   (c) the transfer is necessary for the conclusion or performance of a contract concluded in the interest of the data subject between the controller and another natural or legal person;

   (d) the transfer is necessary for important reasons of public interest;

   (e) the transfer is necessary for the establishment, exercise or defence of legal claims;

   (f) the transfer is necessary in order to protect the vital interests of the data subject or of other persons, where the data subject is physically or legally incapable of giving consent;

   (g) the transfer is made from a register which according to Union or Member State law is intended to provide information to the public and which is open to consultation either by the public in general or by any person who can demonstrate a legitimate interest, but only to the extent that the conditions laid down by Union or Member State law for consultation are fulfilled in the particular case.

 Where a transfer could not be based on a provision in Article 45 or 46, including the provisions on binding corporate rules, and none of the derogations for a specific situation referred to in the first subparagraph of this paragraph is applicable, a transfer to a third country or an international organisation may take place only if the transfer is not repetitive, concerns only a limited number of data subjects, is necessary for the purposes of compelling legitimate interests pursued by the controller which are not overridden by the interests or rights and freedoms of the data subject, and the controller has assessed all the circumstances surrounding the data transfer and has on the basis of that assessment provided suitable safeguards with regard to the protection of personal data. The controller shall inform the supervisory authority of the transfer. The controller shall, in addition to providing the information referred to in Articles 13 and 14, inform the data subject of the transfer and on the compelling legitimate interests pursued.

2. A transfer pursuant to point (g) of the first subparagraph of paragraph 1 shall not involve the entirety of the personal data or entire categories of the personal data contained in the register. Where the register is intended for consultation by persons having a legitimate interest, the transfer shall be made only at the request of those persons or if they are to be the recipients.

3. Points (a), (b) and (c) of the first subparagraph of paragraph 1 and the second subparagraph thereof shall not apply to activities carried out by public authorities in the exercise of their public powers.

4. The public interest referred to in point (d) of the first subparagraph of paragraph 1 shall be recognised in Union law or in the law of the Member State to which the controller is subject.

5. In the absence of an adequacy decision, Union or Member State law may, for important reasons of public interest, expressly set limits to the transfer of specific categories of personal data to a third country or an international organisation. Member States shall notify such provisions to the Commission.

6. The controller or processor shall document the assessment as well as the suitable safeguards referred to in the second subparagraph of paragraph 1 of this Article in the records referred to in Article 30.

### Article 50: International cooperation for the protection of personal data

In relation to third countries and international organisations, the Commission and supervisory authorities shall take appropriate steps to:

   (a) develop international cooperation mechanisms to facilitate the effective enforcement of legislation for the protection of personal data;

   (b) provide international mutual assistance in the enforcement of legislation for the protection of personal data, including through notification, complaint referral, investigative assistance and information exchange, subject to appropriate safeguards for the protection of personal data and other fundamental rights and freedoms;

   (c) engage relevant stakeholders in discussion and activities aimed at furthering international cooperation in the enforcement of legislation for the protection of personal data;

   (d) promote the exchange and documentation of personal data protection legislation and practice, including on jurisdictional conflicts with third countries.

## CHAPTER VI: Independent supervisory authorities

## Section 1: Independent status

### Article 51: Supervisory authority

1. Each Member State shall provide for one or more independent public authorities to be responsible for monitoring the application of this Regulation, in order to protect the fundamental rights and freedoms of natural persons in relation to processing and to facilitate the free flow of personal data within the Union (‘supervisory authority’).

2. Each supervisory authority shall contribute to the consistent application of this Regulation throughout the Union. For that purpose, the supervisory authorities shall cooperate with each other and the Commission in accordance with Chapter VII.

3. Where more than one supervisory authority is established in a Member State, that Member State shall designate the supervisory authority which is to represent those authorities in the Board and shall set out the mechanism to ensure compliance by the other authorities with the rules relating to the consistency mechanism referred to in Article 63.

4. Each Member State shall notify to the Commission the provisions of its law which it adopts pursuant to this Chapter, by 25 May 2018 and, without delay, any subsequent amendment affecting them.

### Article 52: Independence

1. Each supervisory authority shall act with complete independence in performing its tasks and exercising its powers in accordance with this Regulation.

2. The member or members of each supervisory authority shall, in the performance of their tasks and exercise of their powers in accordance with this Regulation, remain free from external influence, whether direct or indirect, and shall neither seek nor take instructions from anybody.

3. Member or members of each supervisory authority shall refrain from any action incompatible with their duties and shall not, during their term of office, engage in any incompatible occupation, whether gainful or not.

4. Each Member State shall ensure that each supervisory authority is provided with the human, technical and financial resources, premises and infrastructure necessary for the effective performance of its tasks and exercise of its powers, including those to be carried out in the context of mutual assistance, cooperation and participation in the Board.

5. Each Member State shall ensure that each supervisory authority chooses and has its own staff which shall be subject to the exclusive direction of the member or members of the supervisory authority concerned.

6. Each Member State shall ensure that each supervisory authority is subject to financial control which does not affect its independence and that it has separate, public annual budgets, which may be part of the overall state or national budget.

### Article 53: General conditions for the members of the supervisory authority

1. Member States shall provide for each member of their supervisory authorities to be appointed by means of a transparent procedure by:

   -  their parliament;

   -  their government;

   -  their head of State; or

   -  an independent body entrusted with the appointment under Member State law.

2. Each member shall have the qualifications, experience and skills, in particular in the area of the protection of personal data, required to perform its duties and exercise its powers.

3. The duties of a member shall end in the event of the expiry of the term of office, resignation or compulsory retirement, in accordance with the law of the Member State concerned.

4. A member shall be dismissed only in cases of serious misconduct or if the member no longer fulfils the conditions required for the performance of the duties.

### Article 54: Rules on the establishment of the supervisory authority

1. Each Member State shall provide by law for all of the following:

   (a) the establishment of each supervisory authority;

   (b) the qualifications and eligibility conditions required to be appointed as member of each supervisory authority;

   (c) the rules and procedures for the appointment of the member or members of each supervisory authority;

   (d) the duration of the term of the member or members of each supervisory authority of no less than four years, except for the first appointment after 24 May 2016, part of which may take place for a shorter period where that is necessary to protect the independence of the supervisory authority by means of a staggered appointment procedure;

   (e) whether and, if so, for how many terms the member or members of each supervisory authority is eligible for reappointment;

   (f) the conditions governing the obligations of the member or members and staff of each supervisory authority, prohibitions on actions, occupations and benefits incompatible therewith during and after the term of office and rules governing the cessation of employment.

2. The member or members and the staff of each supervisory authority shall, in accordance with Union or Member State law, be subject to a duty of professional secrecy both during and after their term of office, with regard to any confidential information which has come to their knowledge in the course of the performance of their tasks or exercise of their powers. During their term of office, that duty of professional secrecy shall in particular apply to reporting by natural persons of infringements of this Regulation.

## Section 2: Competence, tasks and powers

### Article 55: Competence

1. Each supervisory authority shall be competent for the performance of the tasks assigned to and the exercise of the powers conferred on it in accordance with this Regulation on the territory of its own Member State.

2. Where processing is carried out by public authorities or private bodies acting on the basis of point (c) or (e) of Article 6(1), the supervisory authority of the Member State concerned shall be competent. In such cases Article 56 does not apply.

3. Supervisory authorities shall not be competent to supervise processing operations of courts acting in their judicial capacity.

### Article 56: Competence of the lead supervisory authority

1. Without prejudice to Article 55, the supervisory authority of the main establishment or of the single establishment of the controller or processor shall be competent to act as lead supervisory authority for the cross-border processing carried out by that controller or processor in accordance with the procedure provided in Article 60.

2. By derogation from paragraph 1, each supervisory authority shall be competent to handle a complaint lodged with it or a possible infringement of this Regulation, if the subject matter relates only to an establishment in its Member State or substantially affects data subjects only in its Member State.

3. In the cases referred to in paragraph 2 of this Article, the supervisory authority shall inform the lead supervisory authority without delay on that matter. Within a period of three weeks after being informed the lead supervisory authority shall decide whether or not it will handle the case in accordance with the procedure provided in Article 60, taking into account whether or not there is an establishment of the controller or processor in the Member State of which the supervisory authority informed it.

4. Where the lead supervisory authority decides to handle the case, the procedure provided in Article 60 shall apply. The supervisory authority which informed the lead supervisory authority may submit to the lead supervisory authority a draft for a decision. The lead supervisory authority shall take utmost account of that draft when preparing the draft decision referred to in Article 60(3).

5. Where the lead supervisory authority decides not to handle the case, the supervisory authority which informed the lead supervisory authority shall handle it according to Articles 61 and 62.

6. The lead supervisory authority shall be the sole interlocutor of the controller or processor for the cross-border processing carried out by that controller or processor.

### Article 57: Tasks

1. Without prejudice to other tasks set out under this Regulation, each supervisory authority shall on its territory:

   (a) monitor and enforce the application of this Regulation;

   (b) promote public awareness and understanding of the risks, rules, safeguards and rights in relation to processing. Activities addressed specifically to children shall receive specific attention;

   (c) advise, in accordance with Member State law, the national parliament, the government, and other institutions and bodies on legislative and administrative measures relating to the protection of natural persons' rights and freedoms with regard to processing;

   (d) promote the awareness of controllers and processors of their obligations under this Regulation;

   (e) upon request, provide information to any data subject concerning the exercise of their rights under this Regulation and, if appropriate, cooperate with the supervisory authorities in other Member States to that end;

   (f) handle complaints lodged by a data subject, or by a body, organisation or association in accordance with Article 80, and investigate, to the extent appropriate, the subject matter of the complaint and inform the complainant of the progress and the outcome of the investigation within a reasonable period, in particular if further investigation or coordination with another supervisory authority is necessary;

   (g) cooperate with, including sharing information and provide mutual assistance to, other supervisory authorities with a view to ensuring the consistency of application and enforcement of this Regulation;

   (h) conduct investigations on the application of this Regulation, including on the basis of information received from another supervisory authority or other public authority;

   (i) monitor relevant developments, insofar as they have an impact on the protection of personal data, in particular the development of information and communication technologies and commercial practices;

   (j) adopt standard contractual clauses referred to in Article 28(8) and in point (d) of Article 46(2);

   (k) establish and maintain a list in relation to the requirement for data protection impact assessment pursuant to Article 35(4);

   (l) give advice on the processing operations referred to in Article 36(2);

   (m) encourage the drawing up of codes of conduct pursuant to Article 40(1) and provide an opinion and approve such codes of conduct which provide sufficient safeguards, pursuant to Article 40(5);

   (n) encourage the establishment of data protection certification mechanisms and of data protection seals and marks pursuant to Article 42(1), and approve the criteria of certification pursuant to Article 42(5);

   (o) where applicable, carry out a periodic review of certifications issued in accordance with Article 42(7);

   (p) draft and publish the criteria for accreditation of a body for monitoring codes of conduct pursuant to Article 41 and of a certification body pursuant to Article 43;

   (q) conduct the accreditation of a body for monitoring codes of conduct pursuant to Article 41 and of a certification body pursuant to Article 43;

   (r) authorise contractual clauses and provisions referred to in Article 46(3);

   (s) approve binding corporate rules pursuant to Article 47;

   (t) contribute to the activities of the Board;

   (u) keep internal records of infringements of this Regulation and of measures taken in accordance with Article 58(2); and

   (v) fulfil any other tasks related to the protection of personal data.

2. Each supervisory authority shall facilitate the submission of complaints referred to in point (f) of paragraph 1 by measures such as a complaint submission form which can also be completed electronically, without excluding other means of communication.

3. The performance of the tasks of each supervisory authority shall be free of charge for the data subject and, where applicable, for the data protection officer.

4. Where requests are manifestly unfounded or excessive, in particular because of their repetitive character, the supervisory authority may charge a reasonable fee based on administrative costs, or refuse to act on the request. The supervisory authority shall bear the burden of demonstrating the manifestly unfounded or excessive character of the request.

### Article 58: Powers

1. Each supervisory authority shall have all of the following investigative powers:

   (a) to order the controller and the processor, and, where applicable, the controller's or the processor's representative to provide any information it requires for the performance of its tasks;

   (b) to carry out investigations in the form of data protection audits;

   (c) to carry out a review on certifications issued pursuant to Article 42(7);

   (d) to notify the controller or the processor of an alleged infringement of this Regulation;

   (e) to obtain, from the controller and the processor, access to all personal data and to all information necessary for the performance of its tasks;

   (f) to obtain access to any premises of the controller and the processor, including to any data processing equipment and means, in accordance with Union or Member State procedural law.

2. Each supervisory authority shall have all of the following corrective powers:

   (a) to issue warnings to a controller or processor that intended processing operations are likely to infringe provisions of this Regulation;

   (b) to issue reprimands to a controller or a processor where processing operations have infringed provisions of this Regulation;

   (c) to order the controller or the processor to comply with the data subject's requests to exercise his or her rights pursuant to this Regulation;

   (d) to order the controller or processor to bring processing operations into compliance with the provisions of this Regulation, where appropriate, in a specified manner and within a specified period;

   (e) to order the controller to communicate a personal data breach to the data subject;

   (f) to impose a temporary or definitive limitation including a ban on processing;

   (g) to order the rectification or erasure of personal data or restriction of processing pursuant to Articles 16, 17 and 18 and the notification of such actions to recipients to whom the personal data have been disclosed pursuant to Article 17(2) and Article 19;

   (h) to withdraw a certification or to order the certification body to withdraw a certification issued pursuant to Articles 42 and 43, or to order the certification body not to issue certification if the requirements for the certification are not or are no longer met;

   (i) to impose an administrative fine pursuant to Article 83, in addition to, or instead of measures referred to in this paragraph, depending on the circumstances of each individual case;

   (j) to order the suspension of data flows to a recipient in a third country or to an international organisation.

3. Each supervisory authority shall have all of the following authorisation and advisory powers:

   (a) to advise the controller in accordance with the prior consultation procedure referred to in Article 36;

   (b) to issue, on its own initiative or on request, opinions to the national parliament, the Member State government or, in accordance with Member State law, to other institutions and bodies as well as to the public on any issue related to the protection of personal data;

   (c) to authorise processing referred to in Article 36(5), if the law of the Member State requires such prior authorisation;

   (d) to issue an opinion and approve draft codes of conduct pursuant to Article 40(5);

   (e) to accredit certification bodies pursuant to Article 43;

   (f) to issue certifications and approve criteria of certification in accordance with Article 42(5);

   (g) to adopt standard data protection clauses referred to in Article 28(8) and in point (d) of Article 46(2);

   (h) to authorise contractual clauses referred to in point (a) of Article 46(3);

   (i) to authorise administrative arrangements referred to in point (b) of Article 46(3);

   (j) to approve binding corporate rules pursuant to Article 47.

4. The exercise of the powers conferred on the supervisory authority pursuant to this Article shall be subject to appropriate safeguards, including effective judicial remedy and due process, set out in Union and Member State law in accordance with the Charter.

5. Each Member State shall provide by law that its supervisory authority shall have the power to bring infringements of this Regulation to the attention of the judicial authorities and where appropriate, to commence or engage otherwise in legal proceedings, in order to enforce the provisions of this Regulation.

6. Each Member State may provide by law that its supervisory authority shall have additional powers to those referred to in paragraphs 1, 2 and 3. The exercise of those powers shall not impair the effective operation of Chapter VII.

### Article 59: Activity reports

Each supervisory authority shall draw up an annual report on its activities, which may include a list of types of infringement notified and types of measures taken in accordance with Article 58(2). Those reports shall be transmitted to the national parliament, the government and other authorities as designated by Member State law. They shall be made available to the public, to the Commission and to the Board.

## CHAPTER VII: Cooperation and consistency

## Section 1: Cooperation

### Article 60: Cooperation between the lead supervisory authority and the other supervisory authorities concerned

1. The lead supervisory authority shall cooperate with the other supervisory authorities concerned in accordance with this Article in an endeavour to reach consensus. The lead supervisory authority and the supervisory authorities concerned shall exchange all relevant information with each other.

2. The lead supervisory authority may request at any time other supervisory authorities concerned to provide mutual assistance pursuant to Article 61 and may conduct joint operations pursuant to Article 62, in particular for carrying out investigations or for monitoring the implementation of a measure concerning a controller or processor established in another Member State.

3. The lead supervisory authority shall, without delay, communicate the relevant information on the matter to the other supervisory authorities concerned. It shall without delay submit a draft decision to the other supervisory authorities concerned for their opinion and take due account of their views.

4. Where any of the other supervisory authorities concerned within a period of four weeks after having been consulted in accordance with paragraph 3 of this Article, expresses a relevant and reasoned objection to the draft decision, the lead supervisory authority shall, if it does not follow the relevant and reasoned objection or is of the opinion that the objection is not relevant or reasoned, submit the matter to the consistency mechanism referred to in Article 63.

5. Where the lead supervisory authority intends to follow the relevant and reasoned objection made, it shall submit to the other supervisory authorities concerned a revised draft decision for their opinion. That revised draft decision shall be subject to the procedure referred to in paragraph 4 within a period of two weeks.

6. Where none of the other supervisory authorities concerned has objected to the draft decision submitted by the lead supervisory authority within the period referred to in paragraphs 4 and 5, the lead supervisory authority and the supervisory authorities concerned shall be deemed to be in agreement with that draft decision and shall be bound by it.

7. The lead supervisory authority shall adopt and notify the decision to the main establishment or single establishment of the controller or processor, as the case may be and inform the other supervisory authorities concerned and the Board of the decision in question, including a summary of the relevant facts and grounds. The supervisory authority with which a complaint has been lodged shall inform the complainant on the decision.

8. By derogation from paragraph 7, where a complaint is dismissed or rejected, the supervisory authority with which the complaint was lodged shall adopt the decision and notify it to the complainant and shall inform the controller thereof.

9. Where the lead supervisory authority and the supervisory authorities concerned agree to dismiss or reject parts of a complaint and to act on other parts of that complaint, a separate decision shall be adopted for each of those parts of the matter. The lead supervisory authority shall adopt the decision for the part concerning actions in relation to the controller, shall notify it to the main establishment or single establishment of the controller or processor on the territory of its Member State and shall inform the complainant thereof, while the supervisory authority of the complainant shall adopt the decision for the part concerning dismissal or rejection of that complaint, and shall notify it to that complainant and shall inform the controller or processor thereof.

10. After being notified of the decision of the lead supervisory authority pursuant to paragraphs 7 and 9, the controller or processor shall take the necessary measures to ensure compliance with the decision as regards processing activities in the context of all its establishments in the Union. The controller or processor shall notify the measures taken for complying with the decision to the lead supervisory authority, which shall inform the other supervisory authorities concerned.

11. Where, in exceptional circumstances, a supervisory authority concerned has reasons to consider that there is an urgent need to act in order to protect the interests of data subjects, the urgency procedure referred to in Article 66 shall apply.

12. The lead supervisory authority and the other supervisory authorities concerned shall supply the information required under this Article to each other by electronic means, using a standardised format.

### Article 61: Mutual assistance

1. Supervisory authorities shall provide each other with relevant information and mutual assistance in order to implement and apply this Regulation in a consistent manner, and shall put in place measures for effective cooperation with one another. Mutual assistance shall cover, in particular, information requests and supervisory measures, such as requests to carry out prior authorisations and consultations, inspections and investigations.

2. Each supervisory authority shall take all appropriate measures required to reply to a request of another supervisory authority without undue delay and no later than one month after receiving the request. Such measures may include, in particular, the transmission of relevant information on the conduct of an investigation.

3. Requests for assistance shall contain all the necessary information, including the purpose of and reasons for the request. Information exchanged shall be used only for the purpose for which it was requested.

4. The requested supervisory authority shall not refuse to comply with the request unless:

   (a) it is not competent for the subject-matter of the request or for the measures it is requested to execute; or

   (b) compliance with the request would infringe this Regulation or Union or Member State law to which the supervisory authority receiving the request is subject.

5. The requested supervisory authority shall inform the requesting supervisory authority of the results or, as the case may be, of the progress of the measures taken in order to respond to the request. The requested supervisory authority shall provide reasons for any refusal to comply with a request pursuant to paragraph 4.

6. Requested supervisory authorities shall, as a rule, supply the information requested by other supervisory authorities by electronic means, using a standardised format.

7. Requested supervisory authorities shall not charge a fee for any action taken by them pursuant to a request for mutual assistance. Supervisory authorities may agree on rules to indemnify each other for specific expenditure arising from the provision of mutual assistance in exceptional circumstances.

8. Where a supervisory authority does not provide the information referred to in paragraph 5 of this Article within one month of receiving the request of another supervisory authority, the requesting supervisory authority may adopt a provisional measure on the territory of its Member State in accordance with Article 55(1). In that case, the urgent need to act under Article 66(1) shall be presumed to be met and require an urgent binding decision from the Board pursuant to Article 66(2).

9. The Commission may, by means of implementing acts, specify the format and procedures for mutual assistance referred to in this Article and the arrangements for the exchange of information by electronic means between supervisory authorities, and between supervisory authorities and the Board, in particular the standardised format referred to in paragraph 6 of this Article. Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 93(2).

### Article 62: Joint operations of supervisory authorities

1. The supervisory authorities shall, where appropriate, conduct joint operations including joint investigations and joint enforcement measures in which members or staff of the supervisory authorities of other Member States are involved.

2. Where the controller or processor has establishments in several Member States or where a significant number of data subjects in more than one Member State are likely to be substantially affected by processing operations, a supervisory authority of each of those Member States shall have the right to participate in joint operations. The supervisory authority which is competent pursuant to Article 56(1) or (4) shall invite the supervisory authority of each of those Member States to take part in the joint operations and shall respond without delay to the request of a supervisory authority to participate.

3. A supervisory authority may, in accordance with Member State law, and with the seconding supervisory authority's authorisation, confer powers, including investigative powers on the seconding supervisory authority's members or staff involved in joint operations or, in so far as the law of the Member State of the host supervisory authority permits, allow the seconding supervisory authority's members or staff to exercise their investigative powers in accordance with the law of the Member State of the seconding supervisory authority. Such investigative powers may be exercised only under the guidance and in the presence of members or staff of the host supervisory authority. The seconding supervisory authority's members or staff shall be subject to the Member State law of the host supervisory authority.

4. Where, in accordance with paragraph 1, staff of a seconding supervisory authority operate in another Member State, the Member State of the host supervisory authority shall assume responsibility for their actions, including liability, for any damage caused by them during their operations, in accordance with the law of the Member State in whose territory they are operating.

5. The Member State in whose territory the damage was caused shall make good such damage under the conditions applicable to damage caused by its own staff. The Member State of the seconding supervisory authority whose staff has caused damage to any person in the territory of another Member State shall reimburse that other Member State in full any sums it has paid to the persons entitled on their behalf.

6. Without prejudice to the exercise of its rights vis-à-vis third parties and with the exception of paragraph 5, each Member State shall refrain, in the case provided for in paragraph 1, from requesting reimbursement from another Member State in relation to damage referred to in paragraph 4.

7. Where a joint operation is intended and a supervisory authority does not, within one month, comply with the obligation laid down in the second sentence of paragraph 2 of this Article, the other supervisory authorities may adopt a provisional measure on the territory of its Member State in accordance with Article 55. In that case, the urgent need to act under Article 66(1) shall be presumed to be met and require an opinion or an urgent binding decision from the Board pursuant to Article 66(2).

## Section 2: Consistency

### Article 63: Consistency mechanism

In order to contribute to the consistent application of this Regulation throughout the Union, the supervisory authorities shall cooperate with each other and, where relevant, with the Commission, through the consistency mechanism as set out in this Section.

### Article 64: Opinion of the Board

1. The Board shall issue an opinion where a competent supervisory authority intends to adopt any of the measures below. To that end, the competent supervisory authority shall communicate the draft decision to the Board, when it:

   (a) aims to adopt a list of the processing operations subject to the requirement for a data protection impact assessment pursuant to Article 35(4);

   (b) concerns a matter pursuant to Article 40(7) whether a draft code of conduct or an amendment or extension to a code of conduct complies with this Regulation;

   (c) aims to approve the criteria for accreditation of a body pursuant to Article 41(3) or a certification body pursuant to Article 43(3);

   (d) aims to determine standard data protection clauses referred to in point (d) of Article 46(2) and in Article 28(8);

   (e) aims to authorise contractual clauses referred to in point (a) of Article 46(3); or

   (f) aims to approve binding corporate rules within the meaning of Article 47.

2. Any supervisory authority, the Chair of the Board or the Commission may request that any matter of general application or producing effects in more than one Member State be examined by the Board with a view to obtaining an opinion, in particular where a competent supervisory authority does not comply with the obligations for mutual assistance in accordance with Article 61 or for joint operations in accordance with Article 62.

3. In the cases referred to in paragraphs 1 and 2, the Board shall issue an opinion on the matter submitted to it provided that it has not already issued an opinion on the same matter. That opinion shall be adopted within eight weeks by simple majority of the members of the Board. That period may be extended by a further six weeks, taking into account the complexity of the subject matter. Regarding the draft decision referred to in paragraph 1 circulated to the members of the Board in accordance with paragraph 5, a member which has not objected within a reasonable period indicated by the Chair, shall be deemed to be in agreement with the draft decision.

4. Supervisory authorities and the Commission shall, without undue delay, communicate by electronic means to the Board, using a standardised format any relevant information, including as the case may be a summary of the facts, the draft decision, the grounds which make the enactment of such measure necessary, and the views of other supervisory authorities concerned.

5. The Chair of the Board shall, without undue, delay inform by electronic means:

   (a) the members of the Board and the Commission of any relevant information which has been communicated to it using a standardised format. The secretariat of the Board shall, where necessary, provide translations of relevant information; and

   (b) the supervisory authority referred to, as the case may be, in paragraphs 1 and 2, and the Commission of the opinion and make it public.

6. The competent supervisory authority shall not adopt its draft decision referred to in paragraph 1 within the period referred to in paragraph 3.

7. The supervisory authority referred to in paragraph 1 shall take utmost account of the opinion of the Board and shall, within two weeks after receiving the opinion, communicate to the Chair of the Board by electronic means whether it will maintain or amend its draft decision and, if any, the amended draft decision, using a standardised format.

8. Where the supervisory authority concerned informs the Chair of the Board within the period referred to in paragraph 7 of this Article that it does not intend to follow the opinion of the Board, in whole or in part, providing the relevant grounds, Article 65(1) shall apply.

### Article 65: Dispute resolution by the Board

1. In order to ensure the correct and consistent application of this Regulation in individual cases, the Board shall adopt a binding decision in the following cases:

   (a) where, in a case referred to in Article 60(4), a supervisory authority concerned has raised a relevant and reasoned objection to a draft decision of the lead authority or the lead authority has rejected such an objection as being not relevant or reasoned. The binding decision shall concern all the matters which are the subject of the relevant and reasoned objection, in particular whether there is an infringement of this Regulation;

   (b) where there are conflicting views on which of the supervisory authorities concerned is competent for the main establishment;

   (c) where a competent supervisory authority does not request the opinion of the Board in the cases referred to in Article 64(1), or does not follow the opinion of the Board issued under Article 64. In that case, any supervisory authority concerned or the Commission may communicate the matter to the Board.

2. The decision referred to in paragraph 1 shall be adopted within one month from the referral of the subject-matter by a two-thirds majority of the members of the Board. That period may be extended by a further month on account of the complexity of the subject-matter. The decision referred to in paragraph 1 shall be reasoned and addressed to the lead supervisory authority and all the supervisory authorities concerned and binding on them.

3. Where the Board has been unable to adopt a decision within the periods referred to in paragraph 2, it shall adopt its decision within two weeks following the expiration of the second month referred to in paragraph 2 by a simple majority of the members of the Board. Where the members of the Board are split, the decision shall by adopted by the vote of its Chair.

4. The supervisory authorities concerned shall not adopt a decision on the subject matter submitted to the Board under paragraph 1 during the periods referred to in paragraphs 2 and 3.

5. The Chair of the Board shall notify, without undue delay, the decision referred to in paragraph 1 to the supervisory authorities concerned. It shall inform the Commission thereof. The decision shall be published on the website of the Board without delay after the supervisory authority has notified the final decision referred to in paragraph 6.

6. The lead supervisory authority or, as the case may be, the supervisory authority with which the complaint has been lodged shall adopt its final decision on the basis of the decision referred to in paragraph 1 of this Article, without undue delay and at the latest by one month after the Board has notified its decision. The lead supervisory authority or, as the case may be, the supervisory authority with which the complaint has been lodged, shall inform the Board of the date when its final decision is notified respectively to the controller or the processor and to the data subject. The final decision of the supervisory authorities concerned shall be adopted under the terms of Article 60(7), (8) and (9). The final decision shall refer to the decision referred to in paragraph 1 of this Article and shall specify that the decision referred to in that paragraph will be published on the website of the Board in accordance with paragraph 5 of this Article. The final decision shall attach the decision referred to in paragraph 1 of this Article.

### Article 66: Urgency procedure

1. In exceptional circumstances, where a supervisory authority concerned considers that there is an urgent need to act in order to protect the rights and freedoms of data subjects, it may, by way of derogation from the consistency mechanism referred to in Articles 63, 64 and 65 or the procedure referred to in Article 60, immediately adopt provisional measures intended to produce legal effects on its own territory with a specified period of validity which shall not exceed three months. The supervisory authority shall, without delay, communicate those measures and the reasons for adopting them to the other supervisory authorities concerned, to the Board and to the Commission.

2. Where a supervisory authority has taken a measure pursuant to paragraph 1 and considers that final measures need urgently be adopted, it may request an urgent opinion or an urgent binding decision from the Board, giving reasons for requesting such opinion or decision.

3. Any supervisory authority may request an urgent opinion or an urgent binding decision, as the case may be, from the Board where a competent supervisory authority has not taken an appropriate measure in a situation where there is an urgent need to act, in order to protect the rights and freedoms of data subjects, giving reasons for requesting such opinion or decision, including for the urgent need to act.

4. By derogation from Article 64(3) and Article 65(2), an urgent opinion or an urgent binding decision referred to in paragraphs 2 and 3 of this Article shall be adopted within two weeks by simple majority of the members of the Board.

### Article 67: Exchange of information

The Commission may adopt implementing acts of general scope in order to specify the arrangements for the exchange of information by electronic means between supervisory authorities, and between supervisory authorities and the Board, in particular the standardised format referred to in Article 64.

Those implementing acts shall be adopted in accordance with the examination procedure referred to in Article 93(2).

## Section 3: European data protection board

### Article 68: European Data Protection Board

1. The European Data Protection Board (the ‘Board’) is hereby established as a body of the Union and shall have legal personality.

2. The Board shall be represented by its Chair.

3. The Board shall be composed of the head of one supervisory authority of each Member State and of the European Data Protection Supervisor, or their respective representatives.

4. Where in a Member State more than one supervisory authority is responsible for monitoring the application of the provisions pursuant to this Regulation, a joint representative shall be appointed in accordance with that Member State's law.

5. The Commission shall have the right to participate in the activities and meetings of the Board without voting right. The Commission shall designate a representative. The Chair of the Board shall communicate to the Commission the activities of the Board.

6. In the cases referred to in Article 65, the European Data Protection Supervisor shall have voting rights only on decisions which concern principles and rules applicable to the Union institutions, bodies, offices and agencies which correspond in substance to those of this Regulation.

### Article 69: Independence

1. The Board shall act independently when performing its tasks or exercising its powers pursuant to Articles 70 and 71.

2. Without prejudice to requests by the Commission referred to in point (b) of Article 70(1) and in Article 70(2), the Board shall, in the performance of its tasks or the exercise of its powers, neither seek nor take instructions from anybody.

### Article 70: Tasks of the Board

1. The Board shall ensure the consistent application of this Regulation. To that end, the Board shall, on its own initiative or, where relevant, at the request of the Commission, in particular:

   (a) monitor and ensure the correct application of this Regulation in the cases provided for in Articles 64 and 65 without prejudice to the tasks of national supervisory authorities;

   (b) advise the Commission on any issue related to the protection of personal data in the Union, including on any proposed amendment of this Regulation;

   (c) advise the Commission on the format and procedures for the exchange of information between controllers, processors and supervisory authorities for binding corporate rules;

   (d) issue guidelines, recommendations, and best practices on procedures for erasing links, copies or replications of personal data from publicly available communication services as referred to in Article 17(2);

   (e) examine, on its own initiative, on request of one of its members or on request of the Commission, any question covering the application of this Regulation and issue guidelines, recommendations and best practices in order to encourage consistent application of this Regulation;

   (f) issue guidelines, recommendations and best practices in accordance with point (e) of this paragraph for further specifying the criteria and conditions for decisions based on profiling pursuant to Article 22(2);

   (g) issue guidelines, recommendations and best practices in accordance with point (e) of this paragraph for establishing the personal data breaches and determining the undue delay referred to in Article 33(1) and (2) and for the particular circumstances in which a controller or a processor is required to notify the personal data breach;

   (h) issue guidelines, recommendations and best practices in accordance with point (e) of this paragraph as to the circumstances in which a personal data breach is likely to result in a high risk to the rights and freedoms of the natural persons referred to in Article 34(1).

   (i) issue guidelines, recommendations and best practices in accordance with point (e) of this paragraph for the purpose of further specifying the criteria and requirements for personal data transfers based on binding corporate rules adhered to by controllers and binding corporate rules adhered to by processors and on further necessary requirements to ensure the protection of personal data of the data subjects concerned referred to in Article 47;

   (j) issue guidelines, recommendations and best practices in accordance with point (e) of this paragraph for the purpose of further specifying the criteria and requirements for the personal data transfers on the basis of Article 49(1);

   (k) draw up guidelines for supervisory authorities concerning the application of measures referred to in Article 58(1), (2) and (3) and the setting of administrative fines pursuant to Article 83;

   (l) review the practical application of the guidelines, recommendations and best practices referred to in points (e) and (f);

   (m) issue guidelines, recommendations and best practices in accordance with point (e) of this paragraph for establishing common procedures for reporting by natural persons of infringements of this Regulation pursuant to Article 54(2);

   (n) encourage the drawing-up of codes of conduct and the establishment of data protection certification mechanisms and data protection seals and marks pursuant to Articles 40 and 42;

   (o) carry out the accreditation of certification bodies and its periodic review pursuant to Article 43 and maintain a public register of accredited bodies pursuant to Article 43(6) and of the accredited controllers or processors established in third countries pursuant to Article 42(7);

   (p) specify the requirements referred to in Article 43(3) with a view to the accreditation of certification bodies under Article 42;

   (q) provide the Commission with an opinion on the certification requirements referred to in Article 43(8);

   (r) provide the Commission with an opinion on the icons referred to in Article 12(7);

   (s) provide the Commission with an opinion for the assessment of the adequacy of the level of protection in a third country or international organisation, including for the assessment whether a third country, a territory or one or more specified sectors within that third country, or an international organisation no longer ensures an adequate level of protection. To that end, the Commission shall provide the Board with all necessary documentation, including correspondence with the government of the third country, with regard to that third country, territory or specified sector, or with the international organisation.

   (t) issue opinions on draft decisions of supervisory authorities pursuant to the consistency mechanism referred to in Article 64(1), on matters submitted pursuant to Article 64(2) and to issue binding decisions pursuant to Article 65, including in cases referred to in Article 66;

   (u) promote the cooperation and the effective bilateral and multilateral exchange of information and best practices between the supervisory authorities;

   (v) promote common training programmes and facilitate personnel exchanges between the supervisory authorities and, where appropriate, with the supervisory authorities of third countries or with international organisations;

   (w) promote the exchange of knowledge and documentation on data protection legislation and practice with data protection supervisory authorities worldwide.

   (x) issue opinions on codes of conduct drawn up at Union level pursuant to Article 40(9); and

   (y) maintain a publicly accessible electronic register of decisions taken by supervisory authorities and courts on issues handled in the consistency mechanism.

2. Where the Commission requests advice from the Board, it may indicate a time limit, taking into account the urgency of the matter.

3. The Board shall forward its opinions, guidelines, recommendations, and best practices to the Commission and to the committee referred to in Article 93 and make them public.

4. The Board shall, where appropriate, consult interested parties and give them the opportunity to comment within a reasonable period. The Board shall, without prejudice to Article 76, make the results of the consultation procedure publicly available.

### Article 71: Reports

1. The Board shall draw up an annual report regarding the protection of natural persons with regard to processing in the Union and, where relevant, in third countries and international organisations. The report shall be made public and be transmitted to the European Parliament, to the Council and to the Commission.

2. The annual report shall include a review of the practical application of the guidelines, recommendations and best practices referred to in point (l) of Article 70(1) as well as of the binding decisions referred to in Article 65.

### Article 72: Procedure

1. The Board shall take decisions by a simple majority of its members, unless otherwise provided for in this Regulation.

2. The Board shall adopt its own rules of procedure by a two-thirds majority of its members and organise its own operational arrangements.

### Article 73: Chair

1. The Board shall elect a chair and two deputy chairs from amongst its members by simple majority.

2. The term of office of the Chair and of the deputy chairs shall be five years and be renewable once.

### Article 74: Tasks of the Chair

1. The Chair shall have the following tasks:

   (a) to convene the meetings of the Board and prepare its agenda;

   (b) to notify decisions adopted by the Board pursuant to Article 65 to the lead supervisory authority and the supervisory authorities concerned;

   (c) to ensure the timely performance of the tasks of the Board, in particular in relation to the consistency mechanism referred to in Article 63.

2. The Board shall lay down the allocation of tasks between the Chair and the deputy chairs in its rules of procedure.

### Article 75: Secretariat

1. The Board shall have a secretariat, which shall be provided by the European Data Protection Supervisor.

2. The secretariat shall perform its tasks exclusively under the instructions of the Chair of the Board.

3. The staff of the European Data Protection Supervisor involved in carrying out the tasks conferred on the Board by this Regulation shall be subject to separate reporting lines from the staff involved in carrying out tasks conferred on the European Data Protection Supervisor.

4. Where appropriate, the Board and the European Data Protection Supervisor shall establish and publish a Memorandum of Understanding implementing this Article, determining the terms of their cooperation, and applicable to the staff of the European Data Protection Supervisor involved in carrying out the tasks conferred on the Board by this Regulation.

5. The secretariat shall provide analytical, administrative and logistical support to the Board.

6. The secretariat shall be responsible in particular for:

   (a) the day-to-day business of the Board;

   (b) communication between the members of the Board, its Chair and the Commission;

   (c) communication with other institutions and the public;

   (d) the use of electronic means for the internal and external communication;

   (e) the translation of relevant information;

   (f) the preparation and follow-up of the meetings of the Board;

   (g) the preparation, drafting and publication of opinions, decisions on the settlement of disputes between supervisory authorities and other texts adopted by the Board.

### Article 76: Confidentiality

1. The discussions of the Board shall be confidential where the Board deems it necessary, as provided for in its rules of procedure.

2. Access to documents submitted to members of the Board, experts and representatives of third parties shall be governed by Regulation (EC) No 1049/2001 of the European Parliament and of the Council (21).

## CHAPTER VIII: Remedies, liability and penalties

### Article 77: Right to lodge a complaint with a supervisory authority

1. Without prejudice to any other administrative or judicial remedy, every data subject shall have the right to lodge a complaint with a supervisory authority, in particular in the Member State of his or her habitual residence, place of work or place of the alleged infringement if the data subject considers that the processing of personal data relating to him or her infringes this Regulation.

2. The supervisory authority with which the complaint has been lodged shall inform the complainant on the progress and the outcome of the complaint including the possibility of a judicial remedy pursuant to Article 78.

### Article 78: Right to an effective judicial remedy against a supervisory authority

1. Without prejudice to any other administrative or non-judicial remedy, each natural or legal person shall have the right to an effective judicial remedy against a legally binding decision of a supervisory authority concerning them.

2. Without prejudice to any other administrative or non-judicial remedy, each data subject shall have the right to a an effective judicial remedy where the supervisory authority which is competent pursuant to Articles 55 and 56 does not handle a complaint or does not inform the data subject within three months on the progress or outcome of the complaint lodged pursuant to Article 77.

3. Proceedings against a supervisory authority shall be brought before the courts of the Member State where the supervisory authority is established.

4. Where proceedings are brought against a decision of a supervisory authority which was preceded by an opinion or a decision of the Board in the consistency mechanism, the supervisory authority shall forward that opinion or decision to the court.

### Article 79: Right to an effective judicial remedy against a controller or processor

1. Without prejudice to any available administrative or non-judicial remedy, including the right to lodge a complaint with a supervisory authority pursuant to Article 77, each data subject shall have the right to an effective judicial remedy where he or she considers that his or her rights under this Regulation have been infringed as a result of the processing of his or her personal data in non-compliance with this Regulation.

2. Proceedings against a controller or a processor shall be brought before the courts of the Member State where the controller or processor has an establishment. Alternatively, such proceedings may be brought before the courts of the Member State where the data subject has his or her habitual residence, unless the controller or processor is a public authority of a Member State acting in the exercise of its public powers.

### Article 80: Representation of data subjects

1. The data subject shall have the right to mandate a not-for-profit body, organisation or association which has been properly constituted in accordance with the law of a Member State, has statutory objectives which are in the public interest, and is active in the field of the protection of data subjects' rights and freedoms with regard to the protection of their personal data to lodge the complaint on his or her behalf, to exercise the rights referred to in Articles 77, 78 and 79 on his or her behalf, and to exercise the right to receive compensation referred to in Article 82 on his or her behalf where provided for by Member State law.

2. Member States may provide that any body, organisation or association referred to in paragraph 1 of this Article, independently of a data subject's mandate, has the right to lodge, in that Member State, a complaint with the supervisory authority which is competent pursuant to Article 77 and to exercise the rights referred to in Articles 78 and 79 if it considers that the rights of a data subject under this Regulation have been infringed as a result of the processing.

### Article 81: Suspension of proceedings

1. Where a competent court of a Member State has information on proceedings, concerning the same subject matter as regards processing by the same controller or processor, that are pending in a court in another Member State, it shall contact that court in the other Member State to confirm the existence of such proceedings.

2. Where proceedings concerning the same subject matter as regards processing of the same controller or processor are pending in a court in another Member State, any competent court other than the court first seized may suspend its proceedings.

3. Where those proceedings are pending at first instance, any court other than the court first seized may also, on the application of one of the parties, decline jurisdiction if the court first seized has jurisdiction over the actions in question and its law permits the consolidation thereof.

### Article 82: Right to compensation and liability

1. Any person who has suffered material or non-material damage as a result of an infringement of this Regulation shall have the right to receive compensation from the controller or processor for the damage suffered.

2. Any controller involved in processing shall be liable for the damage caused by processing which infringes this Regulation. A processor shall be liable for the damage caused by processing only where it has not complied with obligations of this Regulation specifically directed to processors or where it has acted outside or contrary to lawful instructions of the controller.

3. A controller or processor shall be exempt from liability under paragraph 2 if it proves that it is not in any way responsible for the event giving rise to the damage.

4. Where more than one controller or processor, or both a controller and a processor, are involved in the same processing and where they are, under paragraphs 2 and 3, responsible for any damage caused by processing, each controller or processor shall be held liable for the entire damage in order to ensure effective compensation of the data subject.

5. Where a controller or processor has, in accordance with paragraph 4, paid full compensation for the damage suffered, that controller or processor shall be entitled to claim back from the other controllers or processors involved in the same processing that part of the compensation corresponding to their part of responsibility for the damage, in accordance with the conditions set out in paragraph 2.

6. Court proceedings for exercising the right to receive compensation shall be brought before the courts competent under the law of the Member State referred to in Article 79(2).

### Article 83: General conditions for imposing administrative fines

1. Each supervisory authority shall ensure that the imposition of administrative fines pursuant to this Article in respect of infringements of this Regulation referred to in paragraphs 4, 5 and 6 shall in each individual case be effective, proportionate and dissuasive.

2. Administrative fines shall, depending on the circumstances of each individual case, be imposed in addition to, or instead of, measures referred to in points (a) to (h) and (j) of Article 58(2). When deciding whether to impose an administrative fine and deciding on the amount of the administrative fine in each individual case due regard shall be given to the following:

   (a) the nature, gravity and duration of the infringement taking into account the nature scope or purpose of the processing concerned as well as the number of data subjects affected and the level of damage suffered by them;

   (b) the intentional or negligent character of the infringement;

   (c) any action taken by the controller or processor to mitigate the damage suffered by data subjects;

   (d) the degree of responsibility of the controller or processor taking into account technical and organisational measures implemented by them pursuant to Articles 25 and 32;

   (e) any relevant previous infringements by the controller or processor;

   (f) the degree of cooperation with the supervisory authority, in order to remedy the infringement and mitigate the possible adverse effects of the infringement;

   (g) the categories of personal data affected by the infringement;

   (h) the manner in which the infringement became known to the supervisory authority, in particular whether, and if so to what extent, the controller or processor notified the infringement;

   (i) where measures referred to in Article 58(2) have previously been ordered against the controller or processor concerned with regard to the same subject-matter, compliance with those measures;

   (j) adherence to approved codes of conduct pursuant to Article 40 or approved certification mechanisms pursuant to Article 42; and

   (k) any other aggravating or mitigating factor applicable to the circumstances of the case, such as financial benefits gained, or losses avoided, directly or indirectly, from the infringement.

3. If a controller or processor intentionally or negligently, for the same or linked processing operations, infringes several provisions of this Regulation, the total amount of the administrative fine shall not exceed the amount specified for the gravest infringement.

4. Infringements of the following provisions shall, in accordance with paragraph 2, be subject to administrative fines up to 10 000 000 EUR, or in the case of an undertaking, up to 2 % of the total worldwide annual turnover of the preceding financial year, whichever is higher:

   (a) the obligations of the controller and the processor pursuant to Articles 8, 11, 25 to 39 and 42 and 43;

   (b) the obligations of the certification body pursuant to Articles 42 and 43;

   (c) the obligations of the monitoring body pursuant to Article 41(4).

5. Infringements of the following provisions shall, in accordance with paragraph 2, be subject to administrative fines up to 20 000 000 EUR, or in the case of an undertaking, up to 4 % of the total worldwide annual turnover of the preceding financial year, whichever is higher:

   (a) the basic principles for processing, including conditions for consent, pursuant to Articles 5, 6, 7 and 9;

   (b) the data subjects' rights pursuant to Articles 12 to 22;

   (c) the transfers of personal data to a recipient in a third country or an international organisation pursuant to Articles 44 to 49;

   (d) any obligations pursuant to Member State law adopted under Chapter IX;

   (e) non-compliance with an order or a temporary or definitive limitation on processing or the suspension of data flows by the supervisory authority pursuant to Article 58(2) or failure to provide access in violation of Article 58(1).

6. Non-compliance with an order by the supervisory authority as referred to in Article 58(2) shall, in accordance with paragraph 2 of this Article, be subject to administrative fines up to 20 000 000 EUR, or in the case of an undertaking, up to 4 % of the total worldwide annual turnover of the preceding financial year, whichever is higher.

7. Without prejudice to the corrective powers of supervisory authorities pursuant to Article 58(2), each Member State may lay down the rules on whether and to what extent administrative fines may be imposed on public authorities and bodies established in that Member State.

8. The exercise by the supervisory authority of its powers under this Article shall be subject to appropriate procedural safeguards in accordance with Union and Member State law, including effective judicial remedy and due process.

9. Where the legal system of the Member State does not provide for administrative fines, this Article may be applied in such a manner that the fine is initiated by the competent supervisory authority and imposed by competent national courts, while ensuring that those legal remedies are effective and have an equivalent effect to the administrative fines imposed by supervisory authorities. In any event, the fines imposed shall be effective, proportionate and dissuasive. Those Member States shall notify to the Commission the provisions of their laws which they adopt pursuant to this paragraph by 25 May 2018 and, without delay, any subsequent amendment law or amendment affecting them.

### Article 84: Penalties

1. Member States shall lay down the rules on other penalties applicable to infringements of this Regulation in particular for infringements which are not subject to administrative fines pursuant to Article 83, and shall take all measures necessary to ensure that they are implemented. Such penalties shall be effective, proportionate and dissuasive.

2. Each Member State shall notify to the Commission the provisions of its law which it adopts pursuant to paragraph 1, by 25 May 2018 and, without delay, any subsequent amendment affecting them.

## CHAPTER IX: Provisions relating to specific processing situations

### Article 85: Processing and freedom of expression and information

1. Member States shall by law reconcile the right to the protection of personal data pursuant to this Regulation with the right to freedom of expression and information, including processing for journalistic purposes and the purposes of academic, artistic or literary expression.

2. For processing carried out for journalistic purposes or the purpose of academic artistic or literary expression, Member States shall provide for exemptions or derogations from Chapter II (principles), Chapter III (rights of the data subject), Chapter IV (controller and processor), Chapter V (transfer of personal data to third countries or international organisations), Chapter VI (independent supervisory authorities), Chapter VII (cooperation and consistency) and Chapter IX (specific data processing situations) if they are necessary to reconcile the right to the protection of personal data with the freedom of expression and information.

3. Each Member State shall notify to the Commission the provisions of its law which it has adopted pursuant to paragraph 2 and, without delay, any subsequent amendment law or amendment affecting them.

### Article 86: Processing and public access to official documents

Personal data in official documents held by a public authority or a public body or a private body for the performance of a task carried out in the public interest may be disclosed by the authority or body in accordance with Union or Member State law to which the public authority or body is subject in order to reconcile public access to official documents with the right to the protection of personal data pursuant to this Regulation.

### Article 87: Processing of the national identification number

Member States may further determine the specific conditions for the processing of a national identification number or any other identifier of general application. In that case the national identification number or any other identifier of general application shall be used only under appropriate safeguards for the rights and freedoms of the data subject pursuant to this Regulation.

### Article 88: Processing in the context of employment

1. Member States may, by law or by collective agreements, provide for more specific rules to ensure the protection of the rights and freedoms in respect of the processing of employees' personal data in the employment context, in particular for the purposes of the recruitment, the performance of the contract of employment, including discharge of obligations laid down by law or by collective agreements, management, planning and organisation of work, equality and diversity in the workplace, health and safety at work, protection of employer's or customer's property and for the purposes of the exercise and enjoyment, on an individual or collective basis, of rights and benefits related to employment, and for the purpose of the termination of the employment relationship.

2. Those rules shall include suitable and specific measures to safeguard the data subject's human dignity, legitimate interests and fundamental rights, with particular regard to the transparency of processing, the transfer of personal data within a group of undertakings, or a group of enterprises engaged in a joint economic activity and monitoring systems at the work place.

3. Each Member State shall notify to the Commission those provisions of its law which it adopts pursuant to paragraph 1, by 25 May 2018 and, without delay, any subsequent amendment affecting them.

### Article 89: Safeguards and derogations relating to processing for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes

1. Processing for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes, shall be subject to appropriate safeguards, in accordance with this Regulation, for the rights and freedoms of the data subject. Those safeguards shall ensure that technical and organisational measures are in place in particular in order to ensure respect for the principle of data minimisation. Those measures may include pseudonymisation provided that those purposes can be fulfilled in that manner. Where those purposes can be fulfilled by further processing which does not permit or no longer permits the identification of data subjects, those purposes shall be fulfilled in that manner.

2. Where personal data are processed for scientific or historical research purposes or statistical purposes, Union or Member State law may provide for derogations from the rights referred to in Articles 15, 16, 18 and 21 subject to the conditions and safeguards referred to in paragraph 1 of this Article in so far as such rights are likely to render impossible or seriously impair the achievement of the specific purposes, and such derogations are necessary for the fulfilment of those purposes.

3. Where personal data are processed for archiving purposes in the public interest, Union or Member State law may provide for derogations from the rights referred to in Articles 15, 16, 18, 19, 20 and 21 subject to the conditions and safeguards referred to in paragraph 1 of this Article in so far as such rights are likely to render impossible or seriously impair the achievement of the specific purposes, and such derogations are necessary for the fulfilment of those purposes.

4. Where processing referred to in paragraphs 2 and 3 serves at the same time another purpose, the derogations shall apply only to processing for the purposes referred to in those paragraphs.

### Article 90: Obligations of secrecy

1. Member States may adopt specific rules to set out the powers of the supervisory authorities laid down in points (e) and (f) of Article 58(1) in relation to controllers or processors that are subject, under Union or Member State law or rules established by national competent bodies, to an obligation of professional secrecy or other equivalent obligations of secrecy where this is necessary and proportionate to reconcile the right of the protection of personal data with the obligation of secrecy. Those rules shall apply only with regard to personal data which the controller or processor has received as a result of or has obtained in an activity covered by that obligation of secrecy.

2. Each Member State shall notify to the Commission the rules adopted pursuant to paragraph 1, by 25 May 2018 and, without delay, any subsequent amendment affecting them.

### Article 91: Existing data protection rules of churches and religious associations

1. Where in a Member State, churches and religious associations or communities apply, at the time of entry into force of this Regulation, comprehensive rules relating to the protection of natural persons with regard to processing, such rules may continue to apply, provided that they are brought into line with this Regulation.

2. Churches and religious associations which apply comprehensive rules in accordance with paragraph 1 of this Article shall be subject to the supervision of an independent supervisory authority, which may be specific, provided that it fulfils the conditions laid down in Chapter VI of this Regulation.

## CHAPTER X: Delegated acts and implementing acts

### Article 92: Exercise of the delegation

1. The power to adopt delegated acts is conferred on the Commission subject to the conditions laid down in this Article.

2. The delegation of power referred to in Article 12(8) and Article 43(8) shall be conferred on the Commission for an indeterminate period of time from 24 May 2016.

3. The delegation of power referred to in Article 12(8) and Article 43(8) may be revoked at any time by the European Parliament or by the Council. A decision of revocation shall put an end to the delegation of power specified in that decision. It shall take effect the day following that of its publication in the Official Journal of the European Union or at a later date specified therein. It shall not affect the validity of any delegated acts already in force.

4. As soon as it adopts a delegated act, the Commission shall notify it simultaneously to the European Parliament and to the Council.

5. A delegated act adopted pursuant to Article 12(8) and Article 43(8) shall enter into force only if no objection has been expressed by either the European Parliament or the Council within a period of three months of notification of that act to the European Parliament and the Council or if, before the expiry of that period, the European Parliament and the Council have both informed the Commission that they will not object. That period shall be extended by three months at the initiative of the European Parliament or of the Council.

### Article 93: Committee procedure

1. The Commission shall be assisted by a committee. That committee shall be a committee within the meaning of Regulation (EU) No 182/2011.

2. Where reference is made to this paragraph, Article 5 of Regulation (EU) No 182/2011 shall apply.

3. Where reference is made to this paragraph, Article 8 of Regulation (EU) No 182/2011, in conjunction with Article 5 thereof, shall apply.

## CHAPTER XI: Final provisions

### Article 94: Repeal of Directive 95/46/EC

1. Directive 95/46/EC is repealed with effect from 25 May 2018.

2. References to the repealed Directive shall be construed as references to this Regulation. References to the Working Party on the Protection of Individuals with regard to the Processing of Personal Data established by Article 29 of Directive 95/46/EC shall be construed as references to the European Data Protection Board established by this Regulation.

### Article 95: Relationship with Directive 2002/58/EC

This Regulation shall not impose additional obligations on natural or legal persons in relation to processing in connection with the provision of publicly available electronic communications services in public communication networks in the Union in relation to matters for which they are subject to specific obligations with the same objective set out in Directive 2002/58/EC.

### Article 96: Relationship with previously concluded Agreements

International agreements involving the transfer of personal data to third countries or international organisations which were concluded by Member States prior to 24 May 2016, and which comply with Union law as applicable prior to that date, shall remain in force until amended, replaced or revoked.

### Article 97: Commission reports

1. By 25 May 2020 and every four years thereafter, the Commission shall submit a report on the evaluation and review of this Regulation to the European Parliament and to the Council. The reports shall be made public.

2. In the context of the evaluations and reviews referred to in paragraph 1, the Commission shall examine, in particular, the application and functioning of:

   (a) Chapter V on the transfer of personal data to third countries or international organisations with particular regard to decisions adopted pursuant to Article 45(3) of this Regulation and decisions adopted on the basis of Article 25(6) of Directive 95/46/EC;

   (b) Chapter VII on cooperation and consistency.

3. For the purpose of paragraph 1, the Commission may request information from Member States and supervisory authorities.

4. In carrying out the evaluations and reviews referred to in paragraphs 1 and 2, the Commission shall take into account the positions and findings of the European Parliament, of the Council, and of other relevant bodies or sources.

5. The Commission shall, if necessary, submit appropriate proposals to amend this Regulation, in particular taking into account of developments in information technology and in the light of the state of progress in the information society.

### Article 98: Review of other Union legal acts on data protection

The Commission shall, if appropriate, submit legislative proposals with a view to amending other Union legal acts on the protection of personal data, in order to ensure uniform and consistent protection of natural persons with regard to processing. This shall in particular concern the rules relating to the protection of natural persons with regard to processing by Union institutions, bodies, offices and agencies and on the free movement of such data.

### Article 99: Entry into force and application

1. This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

2. It shall apply from 25 May 2018.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 27 April 2016.

---

# European Health Data Space
Source: https://docs.igrant.io/regulations/reg-eu-health-data-space/

---
id: reg-european-health-data-space
title: European Health Data Space
description: Discover how the EU Health Data Space enables secure, consent‑based access and exchange of healthcare data, empowering patient-centred digital services.
sidebar_label: European Health Data Space
keywords: [European Health Data Space, EHDS, healthcare data, consent, patient data, EU regulation, health records, digital health]
slug: /reg-eu-health-data-space/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Guide to the EU Health Data space vision | iGrant.io DevDocs</title>
   <meta name="description" content="Discover how the EU Health Data Space enables secure, consent‑based access and exchange of healthcare data, empowering patient-centred digital services."/>
</head>

The European Health Data Space is a health specific ecosystem comprised of rules, common standards and practices, infrastructures and a governance framework that aims at the following. The proposal was first announced within the 2020 European strategy for data on **03 May 2022**.  

1) empowering individuals through increased digital access to and control of their electronic personal health data, nationally and cross-borders, as well as support to their free movement, fostering a genuine single market for electronic health record systems, relevant medical devices and high risk artificial intelligence (AI) systems 

2) providing a consistent, trustworthy and efficient set-up for the use of health data for research, innovation, policy-making and regulatory activities (secondary use of data)

This section reproduces the European Health Data Space to make it easier for our readers. The original pdf can be found [here](https://igrant.io/papers/European_HealthDataSpace_02-May-2022.pdf).

## CHAPTER I: GENERAL PROVISIONS

### Article 1: Subject matter and scope

1. This Regulation establishes the European Health Data Space (‘EHDS’) by providing for rules, common standards and practices, infrastructures and a governance framework for the primary and secondary use of electronic health data. 

2. This Regulation:

   (a) strengthens the rights of natural persons in relation to the availability and control of their electronic health data;

   (b) lays down rules for the placing on the market, making available on the market or putting into service of electronic health records systems (‘EHR systems’) in the Union;

   (c) lays down rules and mechanisms supporting the secondary use of electronic health data;

   (d) establishes a mandatory cross-border infrastructure enabling the primary use of electronic health data across the Union;

   (e) establishes a mandatory cross-border infrastructure for the secondary use of electronic health data.

3. This Regulation applies to:

   (a) manufacturers and suppliers of EHR systems and wellness applications placed on the market and put into service in the Union and the users of such products;

   (b) controllers and processors established in the Union processing electronic health data of Union citizens and third-country nationals legally residing in the territories of Member States;

   (c) controllers and processors established in a third country that has been connected to or are interoperable with MyHealth@EU, pursuant to Article 12(5);

   (d) data users to whom electronic health data are made available by data holders in the Union.

4. This Regulation shall be without prejudice to other Union legal acts regarding access to, sharing of or secondary use of electronic health data, or requirements related to the processing of data in relation to electronic health data, in particular Regulations (EU) 2016/679, (EU) 2018/1725, […] [Data Governance Act COM/2020/767 final] and […] [Data Act COM/2022/68 final].

5. This Regulation shall be without prejudice to Regulations (EU) 2017/745 and […] [AI Act COM/2021/206 final], as regards the security of medical devices and AI systems that interact with EHR systems.

6. This Regulation shall not affect the rights and obligations laid down in Union or national law concerning data processing for the purposes of reporting, complying with information requests or demonstrating or verifying compliance with legal obligations.

### Article 2: Definitions

1. For the purposes of this Regulation, following definitions shall apply:

   (a) the definitions in Regulation (EU) 2016/679;

   (b) the definitions of ‘healthcare’, ‘Member State of affiliation’, ‘Member State of treatment’, ‘health professional’, ‘healthcare provider’, ‘medicinal product’ and ‘prescription’, pursuant to Article 3 (a), (c), (d), (f), (g), (i) and (k) of Article 3 of the Directive 2011/24/EU;

   (c) the definitions of ‘data’, ‘access’, ‘data altruism’, ‘public sector body’ and ‘secure processing environment’, pursuant to Article 2 (1), (8), (10), (11) and (14) of [Data Governance Act COM/2020/767 final];

   (d) the definitions of ‘making available on the market’, ‘placing on the market’, ‘market surveillance’, ‘market surveillance authority’, ‘non-compliance’, ‘manufacturer’, ‘importer’, ‘distributor’, ‘economic operator’, ‘corrective action’, ‘risk’, ‘recall’ and ‘withdrawal’, pursuant to Article 2 (1), (2), (3), (4), (7), (8), (9), (10), (13), (16), (18), (22) and (23) of the Regulation (EU) 2019/1020;

   (e) the definitions of ‘medical device’, ‘intended purpose’, ‘instructions for use’, ‘performance’, ‘health institution’ and ‘common specifications’, pursuant to Article 2 (1), (12), (14), (22), (36) and (71) of the Regulation (EU) 2017/745;

   (f) the definitions of ‘electronic identification’, ‘electronic identification means’ and ‘person identification data’ pursuant to Article 3 (1), (2) and (3) of the Regulation (EU) No 910/2014.

2. In addition, for the purposes of this Regulation the following definitions shall apply:

   (a)**‘personal electronic health data’** means data concerning health and genetic data as defined in Regulation (EU) 2016/679, as well as data referring to determinants of health, or data processed in relation to the provision of healthcare services, processed in an electronic form;

   (b)**‘non-personal electronic health data’** means data concerning health and genetic data in electronic format that falls outside the definition of personal data provided in Article 4(1) of Regulation (EU) 2016/679;

   (c)**‘electronic health data’** means personal or non-personal electronic health data;

   (d)**‘primary use of electronic health data’** means the processing of personal electronic health data for the provision of health services to assess, maintain or restore the state of health of the natural person to whom that data relates, including the prescription, dispensation and provision of medicinal products and medical devices, as well as for relevant social security, administrative or reimbursement services;

   (e)**‘secondary use of electronic health data’** means the processing of electronic health data for purposes set out in Chapter IV of this Regulation. The data used may include personal electronic health data initially collected in the context of primary use, but also electronic health data collected for the purpose of the secondary use; 

   (f)**‘interoperability’** means the ability of organisations as well as software applications or devices from the same manufacturer or different manufacturers to interact towards mutually beneficial goals, involving the exchange of information and knowledge without changing the content of the data between these organisations, software applications or devices, through the processes they support;

   (g)**‘European electronic health record exchange format’** means a structured, commonly used and machine-readable format that allows transmission of personal electronic health data between different software applications, devices and healthcare providers;

   (h)**‘registration of electronic health data’** means the recording of health data in an electronic format, through manual entry of data, through the collection of data by a device, or through the conversion of non-electronic health data into an electronic format, to be processed in an EHR system or a wellness application;

   (i)**‘electronic health data access service’** means an online service, such as a portal or a mobile application, that enables natural persons not acting in their professional role to access their own electronic health data or electronic health data of those natural persons whose electronic health data they are legally authorised to access;

   (j)**‘health professional access service’** means a service, supported by an EHR system, that enables health professionals to access data of natural persons under their treatment;

   (k)**‘data recipient’** means a natural or legal person that receives data from another controller in the context of the primary use of electronic health data;

   (l)**‘telemedicine’** means the provision of healthcare services, including remote care and online pharmacies, through the use of information and communication technologies, in situations where the health professional and the patient (or several health professionals) are not in the same location;

   (m)**‘EHR’** (electronic health record) means a collection of electronic health data related to a natural person and collected in the health system, processed for healthcare purposes; 

   (n)**‘EHR system’** (electronic health record system) means any appliance or software intended by the manufacturer to be used for storing, intermediating, importing, exporting, converting, editing or viewing electronic health records; 

   (o)**‘wellness application’** means any appliance or software intended by the manufacturer to be used by a natural person for processing electronic health data for other purposes than healthcare, such as well-being and pursuing healthy life-styles;

   (p)**‘CE marking of conformity’** means a marking by which the manufacturer indicates that the EHR system is in conformity with the applicable requirements set out in this Regulation and other applicable Union legislation providing for its affixing;

   (q)**‘serious incident’** means any malfunction or deterioration in the characteristics or performance of an EHR system made available on the market that directly or indirectly leads, might have led or might lead to any of the following:

   - (i)the death of a natural person or serious damage to a natural person’s health;

   - (ii)a serious disruption of the management and operation of critical infrastructure in the health sector; 

   (r)**‘national contact point for digital health’** means an organisational and technical gateway for the provision of cross-border digital health information services for primary use of electronic health data, under the responsibility of the Member States;
  
   (s)**‘central platform for digital health’** means an interoperability platform providing services to support and facilitate the exchange of electronic health data between national contact points for digital health;

   (t)**‘MyHealth@EU’** means the cross-border infrastructure for primary use of electronic health data formed by the combination of national contact points for digital health and the central platform for digital health;

   (u)**‘national contact point for secondary use of electronic health data’** means an organisational and technical gateway enabling the cross-border secondary use of electronic health data, under the responsibility of the Member States;

   (v)**‘central platform for secondary use of electronic health data’** means an interoperability platform established by the Commission, providing services to support and facilitate the exchange of information between national contact points for secondary use of electronic health data;

   (x)**‘HealthData@EU’** means the infrastructure connecting national contact points for secondary use of electronic health data and the central platform; 

   (y)**‘data holder’** means any natural or legal person, which is an entity or a body in the health or care sector, or performing research in relation to these sectors, as well as Union institutions, bodies, offices and agencies who has the right or obligation, in accordance with this Regulation, applicable Union law or national legislation implementing Union law, or in the case of non-personal data, through control of the technical design of a product and related services, the ability to make available, including to register, provide, restrict access or exchange certain data;
  
   (z)**‘data user’** means a natural or legal person who has lawful access to personal or non-personal electronic health data for secondary use;

   (aa)**‘data permit’** means an administrative decision issued to a data user by a health data access body or data holder to process the electronic health data specified in the data permit for the secondary use purposes specified in the data permit based on conditions laid down in this Regulation;

   (ab)**‘dataset’** means a structured collection of electronic health data;

   (ac)**‘dataset catalogue’** means a collection of datasets descriptions, which is arranged in a systematic manner and consists of a user-oriented public part, where information concerning individual dataset parameters is accessible by electronic means through an online portal;

   (ad)**‘data quality’** means the degree to which characteristics of electronic health data are suitable for secondary use;

   (ae)**‘data quality and utility label’** means a graphic diagram, including a scale, describing the data quality and conditions of use of a dataset. 
## CHAPTER II: PRIMARY USE OF ELECTRONIC HEALTH DATA

### Section 1: Access to and transmission of personal electronic health data for primary use
### Article 3: Rights of natural persons in relation to the primary use of their personal electronic health data

1. Natural persons shall have the right to access their personal electronic health data processed in the context of primary use of electronic health data, immediately, free of charge and in an easily readable, consolidated and accessible form.

2. Natural persons shall have the right to receive an electronic copy, in the European electronic health record exchange format referred to in Article 6, of at least their electronic health data in the priority categories referred to in Article 5.

3. In accordance with Article 23 of Regulation (EU) 2016/679, Member States may restrict the scope of this right whenever necessary for the protection of the natural person based on patient safety and ethics by delaying their access to their personal electronic health data for a limited period of time until a health professional can properly communicate and explain to the natural person information that can have a significant impact on his or her health.

4. Where the personal health data have not been registered electronically prior to the application of this Regulation, Member States may require that such data is made available in electronic format pursuant to this Article. This shall not affect the obligation to make personal electronic health data registered after the application of this Regulation available in electronic format pursuant to this Article. 

5. Member States shall:

   (a) establish one or more electronic health data access services at national, regional or local level enabling the exercise of rights referred to in paragraphs 1 and 2;

   (b) establish one or more proxy services enabling a natural person to authorise other natural persons of their choice to access their electronic health data on their behalf.

   The proxy services shall provide authorisations free of charge, electronically or on paper. They shall enable guardians or other representatives to be authorised, either automatically or upon request, to access electronic health data of the natural persons whose affairs they administer. Member States may provide that authorisations do not apply whenever necessary for reasons related to the protection of the natural person, and in particular based on patient safety and ethics. The proxy services shall be interoperable among Member States.

6. Natural persons may insert their electronic health data in their own EHR or in that of natural persons whose health information they can access, through electronic health data access services or applications linked to these services. That information shall be marked as inserted by the natural person or by his or her representative.

7. Member States shall ensure that, when exercising the right to rectification under Article 16 of Regulation (EU) 2016/679, natural persons can easily request rectification online through the electronic health data access services referred to in paragraph 5, point (a), of this Article. 

8. Natural persons shall have the right to give access to or request a data holder from the health or social security sector to transmit their electronic health data to a data recipient of their choice from the health or social security sector, immediately, free of charge and without hindrance from the data holder or from the manufacturers of the systems used by that holder. 

Natural persons shall have the right that, where the data holder and the data recipient are located in different Member States and such electronic health data belongs to the categories referred to in Article 5, the data holder shall transmit the data in the European electronic health record exchange format referred to in Article 6 and the data recipient shall read and accept it.

By way of derogation from Article 9 of Regulation […] [Data Act COM/2022/68 final], the data recipient shall not be required to compensate the data holder for making electronic heath data available.

Natural persons shall have the right that, where priority categories of personal electronic health data referred to in Article 5 are transmitted or made available by the natural person according to the European electronic health record exchange format referred to in Article 6, such data shall be read and accepted by other healthcare providers.

9. Notwithstanding Article 6(1), point (d), of Regulation (EU) 2016/679, natural persons shall have the right to restrict access of health professionals to all or part of their electronic health data. Member States shall establish the rules and specific safeguards regarding such restriction mechanisms. 

10. Natural persons shall have the right to obtain information on the healthcare providers and health professionals that have accessed their electronic health data in the context of healthcare. The information shall be provided immediately and free of charge through electronic health data access services. 

11. The supervisory authority or authorities responsible for monitoring the application of Regulation (EU) 2016/679 shall also be responsible for monitoring the application of this Article, in accordance with the relevant provisions in Chapters VI, VII and VIII of Regulation (EU) 2016/679. They shall be competent to impose administrative fines up to the amount referred to in Article 83(5) of that Regulation. Those supervisory authorities and the digital health authorities referred to in Article 10 of this Regulation shall, where relevant, cooperate in the enforcement of this Regulation, within the remit of their respective competences. 

12. The Commission shall, by means of implementing acts, determine the requirements concerning the technical implementation of the rights set out in this Article. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

### Article 4: Access by health professionals to personal electronic health data

1. Where they process data in an electronic format, health professionals shall:

   (a) have access to the electronic health data of natural persons under their treatment, irrespective of the Member State of affiliation and the Member State of treatment; 

   (b) ensure that the personal electronic health data of the natural persons they treat are updated with information related to the health services provided.

2. In line with the data minimisation principle provided for in Regulation (EU) 2016/679, Member States may establish rules providing for the categories of personal electronic health data required by different health professions. Such rules shall not be based on the source of electronic health data.

3. Member States shall ensure that access to at least the priority categories of electronic health data referred to in Article 5 is made available to health professionals through health professional access services. Health professionals who are in possession of recognised electronic identification means shall have the right to use those health professional access services, free of charge.

4. Where access to electronic health data has been restricted by the natural person, the healthcare provider or health professionals shall not be informed of the content of the electronic health data without prior authorisation by the natural person, including where the provider or professional is informed of the existence and nature of the restricted electronic health data. In cases where processing is necessary in order to protect the vital interests of the data subject or of another natural person, the healthcare provider or health professional may get access to the restricted electronic health data. Following such access, the healthcare provider or health professional shall inform the data holder and the natural person concerned or his/her guardians that access to electronic health data had been granted. Member States’ law may add additional safeguards.

### Article 5: Priority categories of personal electronic health data for primary use

1. Where data is processed in electronic format, Member States shall implement access to and exchange of personal electronic health data for primary use fully or partially falling under the following categories: 

   (a) patient summaries;

   (b) electronic prescriptions;

   (c) electronic dispensations;

   (d) medical images and image reports;

   (e) laboratory results;

   (f) discharge reports.

The main characteristics of the categories of electronic health data in the first subparagraph shall be as set out in Annex I.

Access to and exchange of electronic health data for primary use may be enabled for other categories of personal electronic health data available in the EHR of natural persons.

2. The Commission is empowered to adopt delegated acts in accordance with Article 67 to amend the list of priority categories of electronic health data in paragraph 1. Such delegated acts may also amend Annex I by adding, modifying or removing the main characteristics of the priority categories of electronic health data and indicating, where relevant, deferred application date. The categories of electronic health data added through such delegated acts shall satisfy the following criteria:

   (a) the category is relevant for health services provided to natural persons;

   (b) according to the most recent information, the category is used in a significant number of EHR systems used in Member States;

   (c) international standards exist for the category that have been examined for the possibility of their application in the Union.

### Article 6: European electronic health record exchange format

1. The Commission shall, by means of implementing acts, lay down the technical specifications for the priority categories of personal electronic health data referred to in Article 5, setting out the European electronic health record exchange format. The format shall include the following elements:

   (a) datasets containing electronic health data and defining structures, such as data fields and data groups for the content representation of clinical content and other parts of the electronic health data;

   (b) coding systems and values to be used in datasets containing electronic health data;

   (c) technical specifications for the exchange of electronic health data, including its content representation, standards and profiles.

2. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2). Member States shall ensure that where the priority categories of personal electronic health data referred to in Article 5 are provided by a natural person directly or transmitted to a healthcare provider by automatic means in the format referred to in paragraph 1, such data shall be read and accepted by the data recipient.

3. Member States shall ensure that the priority categories of personal electronic health data referred to in Article 5 are issued in the format referred to in paragraph 1 and such data shall be read and accepted by the data recipient.

### Article 7: Registration of personal electronic health data

1. Member States shall ensure that, where data is processed in electronic format, health professionals systematically register the relevant health data falling under at least the priority categories referred to in Article 5 concerning the health services provided by them to natural persons, in the electronic format in an EHR system. 

2. Where electronic health data of a natural person is registered in a Member State that is not the Member State of affiliation of that person, the Member State of treatment shall ensure that the registration is performed under the person identification data of the natural person in the Member State of affiliation.

3. The Commission shall, by means of implementing acts, determine the requirements for the registration of electronic health data by healthcare providers and natural persons, as relevant. Those implementing acts shall establish the following:

   (a) categories of healthcare providers that are to register health data electronically; 

   (b) categories of health data that are to be registered systematically in electronic format by healthcare providers referred to in point (a);

   (c) data quality requirements pertaining to the electronic registration of health data.

Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

### Article 8: Telemedicine in the context of cross-border healthcare

Where a Member State accepts the provision of telemedicine services, it shall, under the same conditions, accept the provision of the services of the same type by healthcare providers located in other Member States.

### Article 9: Identification management 

1. Where a natural person uses telemedicine services or personal health data access services referred to in Article 3(5), point (a), that natural person shall have the right to identify electronically using any electronic identification means which is recognised pursuant to Article 6 of Regulation (EU) No 910/2014.

2. The Commission shall, by means of implementing acts, determine the requirements for the interoperable, cross-border identification and authentication mechanism for natural persons and health professionals, in accordance with Regulation (EU) No 910/2014 as amended by [COM(2021) 281 final]. The mechanism shall facilitate the transferability of electronic health data in a cross-border context. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

3. The Commission shall implement services required by the interoperable, cross-border identification and authentication mechanism referred to in paragraph 2 of this Article at Union level, as part of the cross-border digital health infrastructure referred to in Article 12(3).

4. The digital health authorities and the Commission shall implement the cross-border identification and authentication mechanism at Union and Member States’ level, respectively.

### Article 10: Digital health authority

1. Each Member State shall designate a digital health authority responsible for the implementation and enforcement of this Chapter at national level. The Member State shall communicate the identity of the digital health authority to the Commission by the date of application of this Regulation. Where a designated digital health authority is an entity consisting of multiple organisations, the Member State shall communicate to the Commission a description of the separation of tasks between the organisations. The Commission shall make this information publicly available.

2. Each digital health authority shall be entrusted with the following tasks:

   (a) ensure the implementation of the rights and obligations provided for in Chapters II and III by adopting necessary national, regional or local technical solutions and by establishing relevant rules and mechanisms;

   (b) ensure that complete and up to date information about the implementation of rights and obligations provided for in in Chapters II and III is made readily available to natural persons, health professionals and healthcare providers;

   (c) in the implementation of technical solutions referred to in point (a), enforce their compliance with Chapter II, III and Annex II;

   (d) contribute, at Union level, to the development of technical solutions enabling natural persons and health professionals to exercise their rights and obligations set out in this Chapter;

   (e) facilitate for persons with disabilities to exercise their rights listed in Article 3 of this Regulation in accordance with Directive (EU) 2019/882 of the European Parliament and of the Council 55 .

   (f) supervise the national contact points for digital health and cooperate with other digital health authorities and the Commission on further development of MyHealth@EU;

   (g) ensure the implementation, at national level, of the European electronic health record exchange format, in cooperation with national authorities and stakeholders;

   (h) contribute, at Union level, to the development of the European electronic health record exchange format and to the elaboration of common specifications addressing interoperability, security, safety or fundamental right concerns in accordance with Article 23 and of the specifications of the EU database for EHR systems and wellness applications referred to in Article 32;

   (i) where applicable, perform market surveillance activities in accordance with Article 28, while ensuring that any conflict of interest is avoided;

   (j) build national capacity for implementing interoperability and security of the primary use of electronic health data and participate in information exchanges and capacity building activities at Union level;

   (k) offer, in compliance with national legislation, telemedicine services and ensure that such services are easy to use, accessible to different groups of natural persons and health professionals, including natural persons with disabilities, do not discriminate and offer the possibility of choosing between in person and digital services;

   (l) cooperate with market surveillance authorities, participate in the activities related to handling of risks posed by EHR systems and of serious incidents and supervise the implementation of corrective actions in accordance with Article 29;

   (m) cooperate with other relevant entities and bodies at national or Union level, to ensure interoperability, data portability and security of electronic health data, as well as with stakeholders representatives, including patients’ representatives, healthcare providers, health professionals, industry associations;

   (n) cooperate with supervisory authorities in accordance with Regulation (EU) 910/2014, Regulation (EU) 2016/679 and Directive (EU) 2016/1148 of the European Parliament and of the Council 56 with other relevant authorities, including those competent for cybersecurity, electronic identification, the European Artificial Intelligence Board, the Medical Device Coordination Group, the European Data Innovation Board and the competent authorities under Regulation […] [Data Act COM/2022/68 final];

   (o) draw up, in collaboration where relevant with market surveillance authorities, an annual activity report, which shall contain a comprehensive overview of its activities. The report shall be transmitted to the Commission. The annual activity report shall follow a structure that is agreed at Union level within EHDS Board, to support benchmarking pursuant to Article 59. The report shall contain at least information concerning:

   - (i) measures taken to implement this Regulation;

   - (ii) percentage of natural persons having access to different data categories of their electronic health records;

   - (iii) information on the handling of requests from natural persons on the exercise of their rights pursuant to this Regulation;

   - (iv) number of healthcare providers of different types, including pharmacies, hospitals and other points of care, connected to MyHealth@EU calculated a) in absolute terms, b) as share of all healthcare providers of the same type and c) as share of natural persons that can use the services;

   - (v) volumes of electronic health data of different categories shared across borders through MyHealth@EU;

   - (vi) level of natural person satisfaction with MyHealth@EU services;

   - (vii) number of certified EHR systems and labelled wellness applications enrolled in the EU database;

   - (viii) number of non-compliance cases with the mandatory requirements;

   - (ix) a description of its activities carried out in relation to engagement with and consultation of relevant stakeholders, including representatives of natural persons, patient organisations, health professionals, researchers, and ethical committees;

   - (x) information on cooperation with other competent bodies in particular in the area of data protection, cybersecurity, and artificial intelligence.

3. The Commission is empowered to adopt delegated acts in accordance with Article 67 to supplement this Regulation by entrusting the digital health authorities with additional tasks necessary to carry out the missions conferred on them by this Regulation and to modify the content of the annual report.

4. Each Member State shall ensure that each digital health authority is provided with the human, technical and financial resources, premises and infrastructure necessary for the effective performance of its tasks and exercise of its powers.

5. In the performance of its tasks, the digital health authority shall actively cooperate with stakeholders’ representatives, including patients’ representatives. Members of the digital health authority shall avoid any conflicts of interest. 

### Article 11: Right to lodge a complaint with a digital health authority

1. Without prejudice to any other administrative or judicial remedy, natural and legal persons shall have the right to lodge a complaint, individually or, where relevant, collectively, with the digital health authority. Where the complaint concerns the rights of natural persons pursuant to Article 3 of this Regulation, the digital health authority shall inform the supervisory authorities under Regulation (EU) 2016/679.

2. The digital health authority with which the complaint has been lodged shall inform the complainant of the progress of the proceedings and of the decision taken.

3. Digital health authorities shall cooperate to handle and resolve complaints, including by exchanging all relevant information by electronic means, without undue delay.

### Section 2: Cross-border infrastructure for primary use of electronic health data
### Article 12: MyHealth@EU

1. The Commission shall establish a central platform for digital health to provide services to support and facilitate the exchange of electronic health data between national contact points for digital health of the Member States.

2. Each Member State shall designate one national contact point for digital health to ensure the connection to all other national contact points for digital health and to the central platform for digital health. Where a designated national contact point is an entity consisting of multiple organisations responsible for implementing different services, the Member State shall communicate to the Commission a description of the separation of tasks between the organisations. The national contact point for digital health shall be considered an authorised participant in the infrastructure. Each Member State shall communicate the identity of its national contact point to the Commission by [the date of application of this Regulation]. Such contact point may be established within the digital health authority established by Article 10 of this Regulation. Member States shall communicate to the Commission any subsequent modification of the identity of those contact points. The Commission and the Member States shall make this information publicly available.

3. Each national contact point for digital health shall enable the exchange of the personal electronic health data referred to in Article 5 with all other national contact points. The exchange shall be based on the European electronic health record exchange format.

4. The Commission shall, by means of implementing acts, adopt the necessary measures for the technical development of MyHealth@EU, detailed rules concerning the security, confidentiality and protection of electronic health data and the conditions and compliance checks necessary to join and remain connected to MyHealth@EU and conditions for temporary or definitive exclusion from MyHealth@EU. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

5. Member States shall ensure connection of all healthcare providers to their national contact points for digital health and shall ensure that those connected are enabled to perform two-way exchange of electronic health data with the national contact point for digital health.

6. Member States shall ensure that pharmacies operating on their territories, including online pharmacies, are enabled to dispense electronic prescriptions issued by other Member States, under the conditions laid down in Article 11 of Directive 2011/24/EU. The pharmacies shall access and accept electronic prescriptions transmitted to them from other Member States through MyHealth@EU. Following dispensation of medicinal products based on an electronic prescription from another Member State, pharmacies shall report the dispensation to the Member State that issued the prescription, through MyHealth@EU.

7. The national contact points for digital health shall act as joint controllers of the electronic health data communicated through ‘MyHealth@EU’ for the processing operations in which they are involved. The Commission shall act as processor.

8. The Commission shall, by means of implementing acts, allocate responsibilities among controllers and as regards the processor referred to in paragraph 7 of this Article, in accordance with Chapter IV of Regulation (EU) 2016/679. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2). 

9. The approval for individual authorised participants to join MyHealth@EU for different services, or to disconnect a participant shall be issued by the Joint Controllership group, based on the results of the compliance checks.

### Article 13: Supplementary cross-border digital health services and infrastructures

1. Member States may provide through MyHealth@EU supplementary services that facilitate telemedicine, mobile health, access by natural persons to their translated health data, exchange or verification of health-related certificates, including vaccination card services supporting public health and public health monitoring or digital health systems, services and interoperable applications, with a view to achieving a high level of trust and security, enhancing continuity of care and ensuring access to safe and high-quality healthcare. The Commission shall, by means of implementing acts, set out the technical aspects of such provision. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

2. The Commission and Member States may facilitate the exchange of electronic health data with other infrastructures, such as the Clinical Patient Management System or other services or infrastructures in the health, care or social security fields which may become authorised participants to MyHealth@EU. The Commission shall, by means of implementing acts, set out the technical aspects of such exchanges. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2). The connection of another infrastructure to the central platform for digital health shall be subject to a decision of the joint controllership group for MyHealth@EU referred to in Article 66.

3. Member States and the Commission shall seek to ensure interoperability of MyHealth@EU with technological systems established at international level for the exchange of electronic health data. The Commission may adopt an implementing act establishing that a national contact point of a third country or a system established at an international level is compliant with requirements of MyHealth@EU for the purposes of the electronic health data exchange. Before adopting such an implementing act, a compliance check of the national contact point of the third country or of the system established at an international level shall be performed under the control of the Commission.

The implementing acts referred to in the first subparagraph of this paragraph shall be adopted in accordance with the procedure referred to in Article 68. The connection of the national contact point of the third country or of the system established at an international level to the central platform for digital health, as well as the decision to be disconnected shall be subject to a decision of the joint controllership group for MyHealth@EU referred to in Article 66.

The Commission shall make the list of implementing acts adopted pursuant to this paragraph publicly available.

## CHAPTER III: EHR SYSTEMS AND WELLNESS APPLICATIONS

### Section 1: General provisions for EHR systems

### Article 14: Interplay with legislation governing medical devices and AI systems

1. EHR systems intended by their manufacturer for primary use of priority categories of electronic health data referred to in Article 5 shall be subject to the provisions laid down in this Chapter.

2. This Chapter shall not apply to general software used in a healthcare environment.

3. Manufacturers of medical devices as defined in Article 2(1) of Regulation (EU) 2017/745 that claim interoperability of those medical devices with EHR systems shall prove compliance with the essential requirements on interoperability laid down in Section 2 of Annex II of this Regulation. Article 23 of this Chapter shall be applicable to those medical devices. 

4. Providers of high-risk AI systems as defined in Article 6 of Regulation […] [AI act COM/2021/206 final], which does not fall within the scope of Regulation (EU) 2017/745, that claim interoperability of those AI systems with EHR systems will need to prove compliance with the essential requirements on interoperability laid down in Section 2 of Annex II of this Regulation. Article 23 of this Chapter shall be applicable to those high-risk AI systems. 

5. Member States may maintain or define specific rules for the procurement, reimbursement or financing of EHR systems in the context of the organisation, delivery or financing of healthcare services.

### Article 15: Placing on the market and putting into service

1. EHR systems may be placed on the market or put into service only if they comply with the provisions laid down in this Chapter.

2. EHR systems that are manufactured and used within health institutions established in the Union and EHR systems offered as a service within the meaning of Article 1(1), point (b), of Directive (EU) 2015/1535 of the European Parliament and of the Council 57 to a natural or legal person established in the Union shall be considered as having been put into service.

### Article 16: Claims

In the information sheet, instructions for use or other information accompanying EHR systems, and in the advertising of EHR systems, it shall be prohibited to use text, names, trademarks, pictures and figurative or other signs that may mislead the user with regard to its intended purpose, interoperability and security by:

   (a) ascribing functions and properties to the EHR system which it does not have;

   (b) failing to inform the user of likely limitations related to interoperability or security features of the EHR system in relation to its intended purpose;

   (c) suggesting uses for the EHR system other than those stated in the technical documentation to form part of the intended purpose.

### Section 2: Obligations of economic operators with regard to EHR systems

### Article 17: Obligations of manufacturers of EHR systems

1. Manufacturers of EHR systems shall:

   (a) ensure that their EHR systems are in conformity with the essential requirements laid down in Annex II and with the common specifications in accordance with Article 23;

   (b) draw up the technical documentation of their EHR systems in accordance with Article 24;

   (c) ensure that their EHR systems are accompanied, free of charge for the user, by the information sheet provided for in Article 25 and clear and complete instructions for use;

   (d) draw up an EU declaration of conformity as referred to in Article 26;

   (e) affix the CE marking in accordance with Article 27;

   (f) comply with the registration obligations in Article 32;

   (g) take without undue delay any necessary corrective action in respect of their EHR systems which are not in conformity with the essential requirements laid down in Annex II, or recall or withdraw such systems;

   (h) inform the distributors of their EHR systems and, where applicable, the authorised representative and importers of any corrective action, recall or withdrawal;

   (i) inform the market surveillance authorities of the Member States in which they made their EHR systems available or put them into service of the non-conformity and of any corrective action taken;

   (j) upon request of a market surveillance authority, provide it with all the information and documentation necessary to demonstrate the conformity of their EHR system with the essential requirements laid down in Annex II.

   (k) cooperate with market surveillance authorities, at their request, on any action taken to bring their EHR systems in conformity with the essential requirements laid down in Annex II.

   - 1. Manufacturers of EHR systems shall ensure that procedures are in place to ensure that the design, development and deployment of an EHR system continues to comply with the essential requirements laid down in Annex II and the common specifications referred to in Article 23. Changes in EHR system design or characteristics shall be adequately taken into account and reflected in the technical documentation.

   - 2. Manufacturers of EHR systems shall keep the technical documentation and the EU declaration of conformity for 10 years after the last EHR system covered by the EU declaration of conformity has been placed on the market.

### Article 18: Authorised representatives

1. Prior to making an EHR system available on the Union market, a manufacturer of an EHR system established outside of the Union shall, by written mandate, appoint an authorised representative which is established in the Union.

2. An authorised representative shall perform the tasks specified in the mandate received from the manufacturer. The mandate shall allow the authorised representative to do at least the following:

   (a) keep the EU declaration of conformity and the technical documentation at the disposal of market surveillance authorities for the period referred to in Article 17(3);

   (b) further to a reasoned request from a market surveillance authority, provide that authority with all the information and documentation necessary to demonstrate the conformity of an EHR system with the essential requirements laid down in Annex II;

   (c) cooperate with the market surveillance authorities, at their request, on any corrective action taken in relation to the EHR systems covered by their mandate.

### Article 19: Obligations of importers

1. Importers shall place on the Union market only EHR systems which are in conformity with the essential requirements laid down in Annex II.

2. Before making an EHR system available on the market, importers shall ensure that:

   (a) the manufacturer has drawn up the technical documentation and the EU declaration of conformity;

   (b) the EHR system bears the CE marking of conformity;

   (c) the EHR system is accompanied by the information sheet referred to in Article 25 and appropriate instructions for use.

3. Importers shall indicate their name, registered trade name or registered trade mark and the address at which they can be contacted in a document accompanying the EHR system.

4. Importers shall ensure that, while an EHR system is under their responsibility, the EHR system is not altered in such a way that its conformity with the essential requirements laid down in Annex II is jeopardised.

5. Where an importer considers or has reason to believe that an EHR system is not in conformity with the essential requirements in Annex II, it shall not make that system available on the market until that system has been brought into conformity. The importer shall inform without undue delay the manufacturer of such EHR system and the market surveillance authorities of the Member State in which it made the EHR system available, to that effect.

6. Importers shall keep a copy of the EU declaration of conformity at the disposal of the market surveillance authorities for the period referred to in Article 17(3) and ensure that the technical documentation can be made available to those authorities, upon request.

7. Importers shall, further to a reasoned request from a market surveillance authority, provide it with all the information and documentation necessary to demonstrate the conformity of an EHR system in the official language of the Member State where the market surveillance authority is located. They shall cooperate with that authority, at its request, on any action taken to bring their EHR systems in conformity with the essential requirements laid down in Annex II.

### Article 20: Obligations of distributors

1. Before making an EHR system available on the market, distributors shall verify that:

   (a) the manufacturer has drawn up the EU declaration of conformity;

   (b) the EHR system bears the CE marking of conformity;

   (c) the EHR system is accompanied by the information sheet referred to in Article 25 and appropriate instructions for use;

   (d) where applicable, the importer has complied with the requirements set out in Article 19(3). 

2. Distributors shall ensure that, while an EHR system is under their responsibility, the EHR system is not altered in such a way that its conformity with the essential requirements laid down in Annex II is jeopardised.

3. Where a distributor considers or has reason to believe that an EHR system is not in conformity with the essential requirements laid down in Annex II, it shall not make the EHR system available on the market until it has been brought into conformity. Furthermore, the distributor shall inform without undue delay the manufacturer or the importer, as well as the market surveillance authorities of the Member states where the EHR system has been made available on the market, to that effect.

4. Distributors shall, further to a reasoned request from a market surveillance authority, provide it with all the information and documentation necessary to demonstrate the conformity of an EHR system. They shall cooperate with that authority, at its request, on any action taken to bring their EHR systems in conformity with the essential requirements laid down in Annex II.

### Article 21: Cases in which obligations of manufacturers of an EHR system apply to importers and distributors

An importer or distributor shall be considered a manufacturer for the purposes of this Regulation and shall be subject to the obligations laid down in Article 17, where they made an EHR system available on the market under their own name or trademark or modify an EHR system already placed on the market in such a way that conformity with the applicable requirements may be affected.

### Article 22: Identification of economic operators

Economic operators shall, on request, identify the following to the market surveillance authorities, for 10 years after the last EHR system covered by the EU declaration of conformity has been placed on the market:

   (a) any economic operator who has supplied them with an EHR system;

   (b) any economic operator to whom they have supplied an EHR system.

### Section 3: Conformity of the EHR system

### Article 23: Common specifications

1. The Commission shall, by means of implementing acts, adopt common specifications in respect of the essential requirements set out in Annex II, including a time limit for implementing those common specifications. Where relevant, the common specifications shall take into account the specificities of medical devices and high risk AI systems referred to in paragraphs 3 and 4 of Article 14.

Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

2. The common specifications referred to in paragraph 1 shall include the following elements:

   (a) scope;

   (b) applicability to different categories of EHR systems or functions included in them;

   (c) version;

   (d) validity period;

   (e) normative part;

   (f) explanatory part, including any relevant implementation guidelines.

3. The common specifications may include elements related to the following:

   (a) datasets containing electronic health data and defining structures, such as data fields and data groups for the representation of clinical content and other parts of the electronic health data;

   (b) coding systems and values to be used in datasets containing electronic health data;

   (c) other requirements related to data quality, such as the completeness and accuracy of electronic health data;

   (d) technical specifications, standards and profiles for the exchange of electronic health data;

   (e) requirements and principles related to security, confidentiality, integrity, patient safety and protection of electronic health data;

   (f) specifications and requirements related to identification management and the use of electronic identification.

4. EHR systems, medical devices and high risk AI systems referred to in Article 14 that are in conformity with the common specifications referred to in paragraph 1 shall be considered to be in conformity with the essential requirements covered by those specifications or parts thereof, set out in Annex II covered by those common specifications or the relevant parts of those common specifications.

5. Where common specifications covering interoperability and security requirements of EHR systems affect medical devices or high-risk AI systems falling under other acts, such as Regulations (EU) 2017/745 or […] [AI Act COM/2021/206 final], the adoption of those common specifications may be preceded by a consultation with the Medical Devices Coordination Group (MDCG) referred to in Article 103 of Regulation (EU) 2017/745 or the European Artificial Intelligence Board referred to in Article 56 of Regulation […] [AI Act COM/2021/206 final], as applicable.

6. Where common specifications covering interoperability and security requirements of medical devices or high-risk AI systems falling under other acts such as Regulation (EU) 2017/745 or Regulation […] [AI Act COM/2021/206 final], impact EHR systems, the adoption of those common specifications shall be preceded by a consultation with the EHDS Board, especially its subgroup for Chapters II and III of this Regulation.
### Article 24: Technical documentation

1. The technical documentation shall be drawn up before the EHR system is placed on the market or put into service and shall be kept up-to-date.

2. The technical documentation shall be drawn up in such a way as to demonstrate that the EHR system complies with the essential requirements laid down in Annex II and provide market surveillance authorities with all the necessary information to assess the conformity of the EHR system with those requirements. It shall contain, at a minimum, the elements set out in Annex III.

3. The technical documentation shall be drawn up in one of the official languages of the Union. Following a reasoned request from the market surveillance authority of a Member State, the manufacturer shall provide a translation of the relevant parts of the technical documentation into the official language of that Member State.

4. When a market surveillance authority requests the technical documentation or a translation of parts thereof from a manufacturer, it shall set a deadline of 30 days for receipt of such documentation or translation, unless a shorter deadline is justified because of a serious and immediate risk. If the manufacturer does not comply with the requirements of paragraphs 1, 2 and 3, the market surveillance authority may require it to have a test performed by an independent body at its own expense within a specified period in order to verify the conformity with the essential requirements laid down in Annex II and the common specifications referred to in Article 23.

### Article 25: Information sheet accompanying the EHR system

1. EHR systems shall be accompanied by an information sheet that includes concise, complete, correct and clear information that is relevant, accessible and comprehensible to users.

2. The information sheet referred to in paragraph 1 shall specify:

   (a) the identity, registered trade name or registered trademark, and the contact details of the manufacturer and, where applicable, of its authorised representative;

   (b) the name and version of the EHR system and date of its release; 

   (c) its intended purpose;

   (d) the categories of electronic health data that the EHR system has been designed to process;

   (e) the standards, formats and specifications and versions thereof supported by the EHR system.

3. The Commission is empowered to adopt delegated acts in accordance with Article 67 to supplement this Regulation by allowing manufacturers to enter the information referred to in paragraph 2 into the EU database of EHR systems and wellness applications referred to in Article 32, as an alternative to supplying the information sheet referred to in paragraph 1 with the EHR system.

### Article 26: EU declaration of conformity

1. The EU declaration of conformity shall state that the manufacturer of the EHR system has demonstrated that the essential requirements laid down in Annex II have been fulfilled.

2. Where EHR systems are subject to other Union legislation in respect of aspects not covered by this Regulation, which also requires an EU declaration of conformity by the manufacturer that fulfilment of the requirements of that legislation has been demonstrated, a single EU declaration of conformity shall be drawn up in respect of all Union acts applicable to the EHR system. The declaration shall contain all the information required for the identification of the Union legislation to which the declaration relates.

3. The EU declaration of conformity shall, as a minimum, contain the information set out in Annex IV and shall be translated into one or more official Union languages determined by the Member State(s) in which the EHR system is made available.

4. By drawing up the EU declaration of conformity, the manufacturer shall assume responsibility for the conformity of the EHR system.

### Article 27: CE marking

1. The CE marking shall be affixed visibly, legibly and indelibly to the accompanying documents of the EHR system and, where applicable, to the packaging.

2. The CE marking shall be subject to the general principles set out in Article 30 of Regulation (EC) 765/2008 of the European Parliament and of the Council <sup>58</sup> .
### Section 4: Market surveillance of EHR systems
### Article 28: Market surveillance authorities

1. Regulation (EU) 2019/1020 shall apply to EHR systems covered by Chapter III of this Regulation.

2. Member States shall designate the market surveillance authority or authorities responsible for the implementation of this Chapter. They shall entrust their market surveillance authorities with the powers, resources, equipment and knowledge necessary for the proper performance of their tasks pursuant to this Regulation. Member States shall communicate the identity of the market surveillance authorities to the Commission which shall publish a list of those authorities.

3. Market surveillance authorities designated pursuant to this Article may be the digital health authorities designated pursuant to Article 10. Where a digital health authority carries out tasks of market surveillance authority, any conflict of interest shall be avoided.

4. Market surveillance authorities shall report to the Commission on a regular basis the outcomes of relevant market surveillance activities.

5. The market surveillance authorities of the Member States shall cooperate with each other and with the Commission. The Commission shall provide for the organisation of exchanges of information necessary to that effect. 

6. For medical devices or high-risk AI systems referred to in Article 14 (3) and (4), the responsible authorities for market surveillance shall be those referred to in Article 93 of Regulation (EU) 2017/745 or Article 59 of Regulation […] [AI act COM/2021/206 final], as applicable.

### Article 29: Handling of risks posed by EHR systems and of serious incidents

1. Where a market surveillance authority finds that an EHR system presents a risk to the health or safety of natural persons or to other aspects of public interest protection, it shall require the manufacturer of the EHR system concerned, its authorised representative and all other relevant economic operators to take all appropriate measures to ensure that the EHR system concerned no longer presents that risk when placed on the market to withdraw the EHR system from the market or to recall it within a reasonable period.

2. The economic operator referred to in paragraph 1 shall ensure that corrective action is taken in respect of all the EHR systems concerned that it has placed on market throughout the Union.

3. The market surveillance authority shall immediately inform the Commission and the market surveillance authorities of other Member States of the measures ordered pursuant to paragraph 1. That information shall include all available details, in particular the data necessary for the identification of the EHR system concerned, the origin and the supply chain of the EHR system, the nature of the risk involved and the nature and duration of the national measures taken.

4. Manufacturers of EHR systems placed on the market shall report any serious incident involving an EHR system to the market surveillance authorities of the Member States where such serious incident occurred and the corrective actions taken or envisaged by the manufacturer.

Such notification shall be made, without prejudice to incident notification requirements under Directive (EU) 2016/1148, immediately after the manufacturer has established a causal link between the EHR system and the serious incident or the reasonable likelihood of such a link, and, in any event, not later than 15 days after the manufacturer becomes aware of the serious incident involving the EHR system.

5. The market surveillance authorities referred to in paragraph 4 shall inform the other market surveillance authorities, without delay, of the serious incident and the corrective action taken or envisaged by the manufacturer or required of it to minimise the risk of recurrence of the serious incident.

6. Where the tasks of the market surveillance authority are not performed by the digital health authority, it shall cooperate with the digital health authority. It shall inform the digital health authority of any serious incidents and of EHR systems presenting a risk, including risks related to interoperability, security and patient safety, and of any corrective action, recall or withdrawal of such EHR systems.

### Article 30: Handling of non-compliance

1. Where a market surveillance authority makes one of the following findings, it shall require the manufacturer of the EHR system concerned, its authorised representative and all other relevant economic operators to put an end to the non-compliance concerned:

   (a) the EHR system is not in conformity with essential requirements laid down in Annex II;

   (b) the technical documentation is either not available or not complete;

   (c) the EU declaration of conformity has not been drawn up or has not been drawn up correctly;

   (d) the CE marking has been affixed in violation of Article 27 or has not been affixed.

2. Where the non-compliance referred to in paragraph 1 persists, the Member State concerned shall take all appropriate measures to restrict or prohibit the EHR system being placed on the market or ensure that it is recalled or withdrawn from the market.

### Section 5: Other provisions on interoperability

### Article 31: Voluntary labelling of wellness applications

1. Where a manufacturer of a wellness application claims interoperability with an EHR system and therefore compliance with the essential requirements laid down in Annex II and common specifications in Article 23, such wellness application may be accompanied by a label, clearly indicating its compliance with those requirements. The label shall be issued by the manufacturer of the wellness application.

2. The label shall indicate the following information:

   (a) categories of electronic health data for which compliance with essential requirements laid down in Annex II has been confirmed;

   (b) reference to common specifications to demonstrate compliance;

   (c) validity period of the label.

3. The Commission may, by means of implementing acts, determine the format and content of the label. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2). 

4. The label shall be drawn-up in one or more official languages of the Union or languages determined by the Member State(s) in which the in which the wellness application is placed on the market. 

5. The validity of the label shall not exceed 5 years.

6. If the wellness application is embedded in a device, the accompanying label shall be placed on the device. 2D barcodes may also be used to display the label.

7. The market surveillance authorities shall check the compliance of wellness applications with the essential requirements laid down in Annex II.

8. Each supplier of a wellness application, for which a label has been issued, shall ensure that the wellness application that is placed on the market or put into service is accompanied with the label for each individual unit, free of charge.

9. Each distributor of a wellness application for which a label has been issued shall make the label available to customers at the point of sale in electronic form or, upon request, in physical form.

10. The requirements of this Article shall not apply to wellness applications which are high-risk AI systems as defined under Regulation […] [AI Act COM/2021/206 final].

### Article 32: Registration of EHR systems and wellness applications

1. The Commission shall establish and maintain a publicly available database with information on EHR systems for which an EU declaration of conformity has been issued pursuant to Article 26 and wellness applications for which a label has been issued pursuant to Article 31. 

2. Before placing on the market or putting into service an EHR system referred to in Article 14 or a wellness application referred to in Article 31, the manufacturer of such EHR system or wellness application or, where applicable, its authorised representative shall register the required data into the EU database referred to in paragraph 1. 

3. Medical devices or high-risk AI systems referred to in paragraphs 3 and 4 of Article 14 of this Regulation shall be registered in the database established pursuant to Regulations (EU) 2017/745 or […] [AI Act COM/2021/206 final], as applicable.

4. The Commission is empowered to adopt delegated acts in accordance with Article 67 to determine the list of required data to be registered by the manufacturers of EHR systems and wellness applications pursuant to paragraph 2.
## CHAPTER IV: SECONDARY USE OF ELETRONIC HEALTH DATA 
### Section 1: General conditions with regard to the secondary use of electronic health data

### Article 33: Minimum categories of electronic data for secondary use

1. Data holders shall make the following categories of electronic data available for secondary use in accordance with the provisions of this Chapter:

   (a) EHRs;

   (b) data impacting on health, including social, environmental behavioural determinants of health;

   (c) relevant pathogen genomic data, impacting on human health;

   (d) health-related administrative data, including claims and reimbursement data;

   (e) human genetic, genomic and proteomic data;

   (f) person generated electronic health data, including medical devices, wellness applications or other digital health applications;

   (g) identification data related to health professionals involved in the treatment of a natural person;

   (h) population wide health data registries (public health registries);

   (i) electronic health data from medical registries for specific diseases;

   (j) electronic health data from clinical trials;

   (k) electronic health data from medical devices and from registries for medicinal products and medical devices;

   (l) research cohorts, questionnaires and surveys related to health;

   (m) electronic health data from biobanks and dedicated databases;

   (n) electronic data related to insurance status, professional status, education, lifestyle, wellness and behaviour data relevant to health;

   (o) electronic health data containing various improvements such as correction, annotation, enrichment received by the data holder following a processing based on a data permit.

2. The requirement in the first subparagraph shall not apply to data holders that qualify as micro enterprises as defined in Article 2 of the Annex to Commission Recommendation 2003/361/EC 59 .

3. The electronic health data referred to in paragraph 1 shall cover data processed for the provision of health or care or for public health, research, innovation, policy making, official statistics, patient safety or regulatory purposes, collected by entities and bodies in the health or care sectors, including public and private providers of health or care, entities or bodies performing research in relation to these sectors, and Union institutions, bodies, offices and agencies.

4. Electronic health data entailing protected intellectual property and trade secrets from private enterprises shall be made available for secondary use. Where such data is made available for secondary use, all measures necessary to preserve the confidentiality of IP rights and trade secrets shall be taken. 

5. Where the consent of the natural person is required by national law, health data access bodies shall rely on the obligations laid down in this Chapter to provide access to electronic health data.

6. Where a public sector body obtains data in emergency situations as defined in Article 15, point (a) or (b) of the Regulation […] [Data Act COM/2022/68 final], in accordance with the rules laid down in that Regulation, it may be supported by a health data access body to provide technical support to process the data or combing it with other data for joint analysis.

7. The Commission is empowered to adopt delegated acts in accordance with Article 67 to amend the list in paragraph 1 to adapt it to the evolution of available electronic health data.

8. Health data access bodies may provide access to additional categories of electronic health data that they have been entrusted with pursuant to national law or based on voluntary cooperation with the relevant data holders at national level, in particular to electronic health data held by private entities in the health sector.

### Article 34

Purposes for which electronic health data can be processed for secondary use

1. Health data access bodies shall only provide access to electronic health data referred to in Article 33 where the intended purpose of processing pursued by the applicant complies with: 

   (a) activities for reasons of public interest in the area of public and occupational health, such as protection against serious cross-border threats to health, public health surveillance or ensuring high levels of quality and safety of healthcare and of medicinal products or medical devices;

   (b) to support public sector bodies or Union institutions, agencies and bodies including regulatory authorities, in the health or care sector to carry out their tasks defined in their mandates;

   (c) to produce national, multi-national and Union level official statistics related to health or care sectors;

   (d) education or teaching activities in health or care sectors;

   (e) scientific research related to health or care sectors;

   (f) development and innovation activities for products or services contributing to public health or social security, or ensuring high levels of quality and safety of health care, of medicinal products or of medical devices;

   (g) training, testing and evaluating of algorithms, including in medical devices, AI systems and digital health applications, contributing to the public health or social security, or ensuring high levels of quality and safety of health care, of medicinal products or of medical devices;

   (h) providing personalised healthcare consisting in assessing, maintaining or restoring the state of health of natural persons, based on the health data of other natural persons.

2. Access to electronic health data referred to in Article 33 where the intended purpose of processing pursued by the applicant fulfils one of the purposes referred to in points (a) to (c) of paragraph 1 shall only be granted to public sector bodies and Union institutions, bodies, offices and agencies exercising their tasks conferred to them by Union or national law, including where processing of data for carrying out these tasks is done by a third party on behalf of that public sector body or of Union institutions, agencies and bodies. 

3. The access to privately held data for the purpose of preventing, responding to or assisting in the recovery from public emergencies shall be ensured in accordance with Article 15 of the Regulation […] [Data Act COM/2022/68 final].

4. Public sector bodies or Union institutions, agencies and bodies that obtain access to electronic health data entailing IP rights and trade secrets in the exercise of the tasks conferred to them by Union law or national law, shall take all specific measures necessary to preserve the confidentiality of such data.

### Article 35: Prohibited secondary use of electronic health data

Seeking access to and processing electronic health data obtained via a data permit issued pursuant to Article 46 for the following purposes shall be prohibited:

   (a) taking decisions detrimental to a natural person based on their electronic health data; in order to qualify as “decisions”, they must produce legal effects or similarly significantly affect those natural persons; 

   (b) taking decisions in relation to a natural person or groups of natural persons to exclude them from the benefit of an insurance contract or to modify their contributions and insurance premiums;

   (c) advertising or marketing activities towards health professionals, organisations in health or natural persons;

   (d) providing access to, or otherwise making available, the electronic health data to third parties not mentioned in the data permit;

   (e) developing products or services that may harm individuals and societies at large, including, but not limited to illicit drugs, alcoholic beverages, tobacco products, or goods or services which are designed or modified in such a way that they contravene public order or morality.

### Section 2: Governance and mechanisms for the secondary use of electronic health data

### Article 36: Health data access bodies

1. Member States shall designate one or more health data access bodies responsible for granting access to electronic health data for secondary use. Member States may either establish one or more new public sector bodies or rely on existing public sector bodies or on internal services of public sector bodies that fulfil the conditions set out in this Article. Where a Member State designates several health data access bodies, it shall designate one health data access body to act as coordinator, with responsibility for coordinating requests with the other health data access bodies.

2. Member States shall ensure that each health data access body is provided with the human, technical and financial resources, premises and infrastructure necessary for the effective performance of its tasks and the exercise of its powers.

3. In the performance of their tasks, health data access bodies shall actively cooperate with stakeholders’ representatives, especially with representatives of patients, data holders and data users. Staff of health data access bodies shall avoid any conflicts of interest. Health data access bodies shall not be bound by any instructions, when making their decisions.

4. Member States shall communicate to the Commission the identity of the health data access bodies designated pursuant to paragraph 1 by the date of application of this Regulation. They shall also communicate to the Commission any subsequent modification of the identity of those bodies. The Commission and the Member States shall make this information publicly available.

### Article 37: Tasks of health data access bodies

1. Health data access bodies shall carry out the following tasks:

   (a) decide on data access applications pursuant to Article 45, authorise and issue data permits pursuant to Article 46 to access electronic health data falling within their national remit for secondary use and decide on data requests in accordance with Chapter II of Regulation […] [Data Governance Act COM/2020/767 final] and this Chapter;

   (b) support public sector bodies in carrying out the tasks enshrined in their mandate, based on national or Union law;

   (c) support Union institutions, bodies, offices and agencies in carrying out tasks enshrined in the mandate of Union institutions, bodies, offices and agencies, based on national or Union law;

   (d) process electronic health data for the purposes set out in Article 34, including the collection, combination, preparation and disclosure of those data for secondary use on the basis of a data permit; 

   (e) process electronic health data from other relevant data holders based on a data permit or a data request for a purposes laid down in Article 34; 

   (f) take all measures necessary to preserve the confidentiality of IP rights and of trade secrets;

   (g) gather and compile or provide access to the necessary electronic health data from the various data holders whose electronic health data fall within the scope of this Regulation and put those data at the disposal of data users in a secure processing environment in accordance with the requirements laid down in Article 50;

   (h) contribute to data altruism activities in accordance with Article 40;

   (i) support the development of AI systems, the training, testing and validating of AI systems and the development of harmonised standards and guidelines under Regulation […] [AI Act COM/2021/206 final] for the training, testing and validation of AI systems in health;

   (j) cooperate with and supervise data holders to ensure the consistent and accurate implementation of the data quality and utility label set out in Article 56; 

   (k) maintain a management system to record and process data access applications, data requests and the data permits issued and data requests answered, providing at least information on the name of the data applicant, the purpose of access the date of issuance, duration of the data permit and a description of the data application or the data request;

   (l) maintain a public information system to comply with the obligations laid down in Article 38;

   (m) cooperate at Union and national level to lay down appropriate measures and requirements for accessing electronic health data in a secure processing environment;

   (n) cooperate at Union and national level and provide advice to the Commission on techniques and best practices for electronic health data use and management;

   (o) facilitate cross-border access to electronic health data for secondary use hosted in other Member States through HealthData@EU and cooperate closely with each other and with the Commission.

   (p) send to the data holder free of charge, by the expiry of the data permit, a copy of the corrected, annotated or enriched dataset, as applicable, and a description of the operations performed on the original dataset; 

   (q) make public, through electronic means:

   - (i) a national dataset catalogue that shall include details about the source and nature of electronic health data, in accordance with Articles 56 and 58, and the conditions for making electronic health data available. The national dataset catalogue shall also be made available to single information points under Article 8 of Regulation […] [Data Governance Act COM/2020/767 final];

   - (ii) all data permits, requests and applications on their websites within 30 working days after issuance of the data permit or reply to a data request;

   - (iii) penalties applied pursuant to Article 43;

   - (iv) results communicated by data users pursuant to Article 46(11);

   (r) fulfil obligations towards natural persons pursuant to Article 38;

   (s) request from data users and data holders all the relevant information to verify the implementation of this Chapter; 

   (t) fulfil any other tasks related to making available the secondary use of electronic health data in the context of this Regulation.

2. In the exercise of their tasks, health data access bodies shall: 

   (a) cooperate with supervisory authorities under Regulation (EU) 2016/679 and Regulation (EU) 2018/1725 in relation to personal electronic health data and the EHDS Board;

   (b) inform the relevant supervisory authorities under Regulation (EU) 2016/679 and Regulation (EU) 2018/1725 where a health data access body has imposed penalties or other measures pursuant to Article 43 in relation to processing personal electronic health data and where such processing refers to an attempt to re-identify an individual or unlawful processing of personal electronic health data; 

   (c) cooperate with stakeholders, including patient organisations, representatives from natural persons, health professionals, researchers, and ethical committees, where applicable in accordance with Union and national law; 

   (d) cooperate with other national competent bodies, including the national competent bodies supervising data altruism organisations under Regulation […] [Data Governance Act COM/2020/767 final], the competent authorities under Regulation […] [Data Act COM/2022/68 final] and the national competent authorities for Regulations (EU) 2017/745 and Regulation […] [AI Act COM/2021/206 final] .

3. The health data access bodies may provide assistance to public sector bodies where those public sector bodies access electronic health data on the basis of Article 14 of Regulation […] [Data Act COM/2022/68 final].

4. The Commission is empowered to adopt delegated acts in accordance with Article 67 to amend the list of tasks in paragraph 1 of this Article, to reflect the evolution of activities performed by health data access bodies.

### Article 38

Obligations of health data access bodies towards natural persons

1. Health data access bodies shall make publicly available and easily searchable the conditions under which electronic health data is made available for secondary use, with information concerning:

   (a) the legal basis under which access is granted;

   (b) the technical and organisational measures taken to protect the rights of natural persons;

   (c) the applicable rights of natural persons in relation to secondary use of electronic health data;

   (d) the arrangements for natural persons to exercise their rights in accordance with Chapter III of Regulation (EU) 2016/679;

   (e) the results or outcomes of the projects for which the electronic health data were used. 

2. Health data access bodies shall not be obliged to provide the specific information under Article 14 of Regulation (EU) 2016/679 to each natural person concerning the use of their data for projects subject to a data permit and shall provide general public information on all the data permits issued pursuant to Article 46. 

3. Where a health data access body is informed by a data user of a finding that may impact on the health of a natural person, the health data access body may inform the natural person and his or her treating health professional about that finding.

4. Member States shall regularly inform the public at large about the role and benefits of health data access bodies.

### Article 39: Reporting by health data access bodies

1. Each health data access body shall publish an annual activity report which shall contain at least the following:

   (a) information relating to the data access applications for electronic health data access submitted, such as the types of applicants, number of data permits granted or refused, purposes of access and categories of electronic health data accessed, and a summary of the results of the electronic health data uses, where applicable;

   (b) a list of data permits involving access to electronic health data processed by the health data access body based on data altruism and a summary description of the general interests purposes pursued, where applicable, including the outcomes of the data permits granted;

   (c) information on the fulfilment of regulatory and contractual commitments by data users and data holders, as well as penalties imposed;

   (d) information on audits carried out on data users to ensure compliance of the processing with this Regulation,

   (e) information on audits on compliance of secure processing environments with the defined standards, specifications and requirements;

   (f) information on the handling of requests from natural persons on the exercise of their data protection rights;

   (g) a description of its activities carried out in relation to engagement with and consultation of relevant stakeholders, including representatives of natural persons, patient organisations, health professionals, researchers, and ethical committees;

   (h) information on cooperation with other competent bodies in particular in the area of data protection, cybersecurity, data altruism, and artificial intelligence;

   (i) revenues from data permits and data requests;

   (j) satisfaction from applicants requesting access to data;

   (k) average number of days between application and access to data;

   (l) number of data quality labels issued, disaggregated per quality category;

   (m) number of peer-reviewed research publications, policy documents, regulatory procedures using data accessed via the EHDS;

   (n) number of digital health products and services, including AI applications, developed using data accessed via EHDS.

2. The report shall be transmitted to the Commission.

3. The Commission is empowered to adopt delegated acts in accordance with Article 67 to modify the content of the annual activity report.

### Article 40: Data altruism in health

1. When processing personal electronic health data, data altruism organisations shall comply with the rules set out in Chapter IV of Regulation […] [Data Governance Act COM/2020/767 final]. Where data altruism organisations process personal electronic health data using a secure processing environment, such environments shall also comply with the requirements set out in Article 50 of this Regulation.

2. Health data access bodies shall support the competent authorities designated in accordance with Article 23 of Regulation […] [Data Governance Act COM/2020/767 final] in the monitoring of entities carrying out data altruism activities.

### Article 41: Duties of data holders

1. Where a data holder is obliged to make electronic health data available under Article 33 or under other Union law or national legislation implementing Union law, it shall cooperate in good faith with the health data access bodies, where relevant. 

2. The data holder shall communicate to the health data access body a general description of the dataset it holds in accordance with Article 55.

3. Where a data quality and utility label accompanies the dataset pursuant to Article 56, the data holder shall provide sufficient documentation to the health data access body for that body to confirm the accuracy of the label.

4. The data holder shall put the electronic health data at the disposal of the health data access body within 2 months from receiving the request from the health data access body. In exceptional cases, that period may be extended by the health data access body for an additional period of 2 months.

5. Where a data holder has received enriched datasets following a processing based on a data permit, it shall make available the new dataset, unless it considers it unsuitable and notifies the health data access body in this respect.

6. Data holders of non-personal electronic health data shall ensure access to data through trusted open databases to ensure unrestricted access for all users and data storage and preservation. Trusted open public databases shall have in place a robust, transparent and sustainable governance and a transparent model of user access.

7. The Commission is empowered to adopt delegated acts in accordance with Article 67 to amend the duties of the data holders in this Article, to reflect the evolution of activities performed by data holders.

### Article 42: Fees

1. Health data access bodies and single data holders may charge fees for making electronic health data available for secondary use. Any fees shall include and be derived from the costs related to conducting the procedure for requests, including for assessing a data application or a data request, granting, refusing or amending a data permit pursuant to Articles 45 and 46 or providing an answer to a data request pursuant to Article 47, in accordance with Article 6 of Regulation […] [Data Governance Act COM/2020/767 final]

2. Where the data in question are not held by the data access body or a public sector body, the fees may also include compensation for part of the costs for collecting the electronic health data specifically under this Regulation in addition to the fees that may be charged pursuant to paragraph 1. The part of the fees linked to the data holder’s costs shall be paid to the data holder.

3. The electronic health data referred to in Article 33(1), point (o), shall be made available to a new user free of charge or against a fee matching the compensation for the costs of the human and technical resources used to enrich the electronic health data. That fee shall be paid to the entity that enriched the electronic health data. 

4. Any fees charged to data users pursuant to this Article by the health data access bodies or data holders shall be transparent and proportionate to the cost of collecting and making electronic health data available for secondary use, objectively justified and shall not restrict competition. The support received by the data holder from donations, public national or Union funds, to set up, develop or update tat dataset shall be excluded from this calculation. The specific interests and needs of SMEs, public bodies, Union institutions, bodies, offices and agencies involved in research, health policy or analysis, educational institutions and healthcare providers shall be taken into account when setting the fees, by reducing those fees proportionately to their size or budget.

5. Where data holders and data users do not agree on the level of the fees within 1 month of the data permit being granted, the health data access body may set the fees in proportion to the cost of making available electronic health data for secondary use. Where the data holder or the data user disagree with the fee set out by the health data access body, they shall have access to dispute settlement bodies set out in accordance with Article 10 of the Regulation […] [Data Act COM/2022/68 final].

6. The Commission may, by means of implementing acts, lay down principles and rules for the fee policies and fee structures. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

### Article 43: Penalties by health data access bodies

1. Health data access bodies shall monitor and supervise compliance by data users and data holders with the requirements laid down in this Chapter.

2. When requesting from data users and data holders the information that is necessary to verify compliance with this Chapter, the health data access bodies shall be proportionate to the performance of the compliance verification task.

3. Where health data access bodies find that a data user or data holder does not comply with the requirements of this Chapter, they shall immediately notify the data user or data holder of those findings and shall give it the opportunity to state its views within 2 months. 

4. Health data access bodies shall have the power to revoke the data permit issued pursuant to Article 46 and stop the affected electronic health data processing operation carried out by the data user in order to ensure the cessation of the non-compliance referred to in paragraph 3, immediately or within a reasonable time limit, and shall take appropriate and proportionate measures aimed at ensuring compliant processing by the data users. In this regard, the health data access bodies shall be able, where appropriate, to revoke the data permit and to exclude the data user from any access to electronic health data for a period of up to 5 years.

5. Where data holders withhold the electronic health data from health data access bodies with the manifest intention of obstructing the use of electronic health data, or do not respect the deadlines set out in Article 41, the health data access body shall have the power to fine the data holder with fines for each day of delay, which shall be transparent and proportionate. The amount of the fines shall be established by the health data access body. In case of repeated breaches by the data holder of the obligation of loyal cooperation with the health data access body, that body can exclude the data holder from participation in the EHDS for a period of up to 5 years. Where a data holder has been excluded from the participation in the EHDS pursuant to this Article, following manifest intention of obstructing the secondary use of electronic health data, it shall not have the right to provide access to health data in accordance with Article 49. 

6. The health data access body shall communicate the measures imposed pursuant to paragraph 4 and the reasons on which they are based to the data user or holder concerned, without delay, and shall lay down a reasonable period for the data user or holder to comply with those measures.

7. Any penalties and measures imposed pursuant to paragraph 4 shall be made available to other health data access bodies.

8. The Commission may, by means of implementing act, set out the architecture of an IT tool aimed to support and make transparent to other health data access bodies the activities referred to in this Article, especially penalties and exclusions. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

9. Any natural or legal person affected by a decision of a health data access body shall have the right to an effective judicial remedy against such decision. 

10. The Commission may issues guidelines on penalties to be applied by the health data access bodies.

### Section 3: Data permit for the secondary use of electronic health data

### Article 44: Data minimisation and purpose limitation

1. The health data access body shall ensure that access is only provided to requested electronic health data relevant for the purpose of processing indicated in the data access application by the data user and in line with the data permit granted.

2. The health data access bodies shall provide the electronic health data in an anonymised format, where the purpose of processing by the data user can be achieved with such data, taking into account the information provided by the data user.

3. Where the purpose of the data user’s processing cannot be achieved with anonymised data, taking into account the information provided by the data user, the health data access bodies shall provide access to electronic health data in pseudonymised format. The information necessary to reverse the pseudonymisation shall be available only to the health data access body. Data users shall not re-identify the electronic health data provided to them in pseudonymised format. The data user’s failure to respect the health data access body’s measures ensuring pseudonymisation shall be subject to appropriate penalties. 

### Article 45: Data access applications

1. Any natural or legal person may submit a data access application for the purposes referred to in Article 34.

2. The data access application shall include:

   (a) a detailed explanation of the intended use of the electronic health data, including for which of the purposes referred to in Article 34(1) access is sought;

   (b) a description of the requested electronic health data, their format and data sources, where possible, including geographical coverage where data is requested from several Member States;

   (c) an indication whether electronic health data should be made available in an anonymised format;

   (d) where applicable, an explanation of the reasons for seeking access to electronic health data in a pseudonymised format;

   (e) a description of the safeguards planned to prevent any other use of the electronic health data;

   (f) a description of the safeguards planned to protect the rights and interests of the data holder and of the natural persons concerned;

   (g) an estimation of the period during which the electronic health data is needed for processing;

   (h) a description of the tools and computing resources needed for a secure environment.

3. Data users seeking access to electronic health data from more than one Member State shall submit a single application to one of the concerned health data access bodies of their choice which shall be responsible for sharing the request with other health data access bodies and authorised participants in HealthData@EU referred to in Article 52, which have been identified in the data access application. For requests to access electronic health data from more than one Member States, the health data access body shall notify the other relevant health data access bodies of the receipt of an application relevant to them within 15 days from the date of receipt of the data access application.

4. Where the applicant intends to access the personal electronic health data in a pseudonymised format, the following additional information shall be provided together with the data access application:

   (a) a description of how the processing would comply with Article 6(1) of Regulation (EU) 2016/679;

   (b) information on the assessment of ethical aspects of the processing, where applicable and in line with national law.

5. For the implementation of the tasks referred to in Article 37(1), points (b) and (c), the public sector bodies and the Union institutions, bodies, offices and agencies shall provide the same information as requested under Article 45(2), except for point (g), where they shall submit information concerning the period for which the data can be accessed, the frequency of that access or the frequency of the data updates.

Where the public sector bodies and the Union institutions, bodies, offices and agencies intend to access the electronic health data in pseudonymised format, a description of how the processing would comply with Article 6(1) of Regulation (EU) 2016/679 or Article 5(1) of Regulation (EU) 2018/1725, as applicable, shall also be provided.

6. The Commission may, by means of implementing acts, set out the templates for the data access application referred to in this Article, the data permit referred to in Article 46 and the data request referred to in Article 47. Those implementing acts shall be adopted in accordance with the procedure referred to in Article 68(2). 

7. The Commission is empowered to adopt delegated acts in accordance with Article 67 to amend the list of information in paragraphs 2, 4, 5 and 6 of this Article, to ensure the adequacy of the list for processing a data access application at national or cross-border level.

### Article 46: Data permit

1. Health data access bodies shall assess if the application fulfils one of the purposes listed in Article 34(1) of this Regulation, if the requested data is necessary for the purpose listed in the application and if the requirements in this Chapter are fulfilled by the applicant. If that is the case, the health data access body shall issue a data permit.

2. Health data access bodies shall refuse all applications including one or more purposes listed in Article 35 or where requirements in this Chapter are not met.

3. A health data access body shall issue or refuse a data permit within 2 months of receiving the data access application. By way of derogation from that Regulation […] [Data Governance Act COM/2020/767 final], the health data access body may extend the period for responding to a data access application by 2 additional months where necessary, taking into account the complexity of the request. In such cases, the health data access body shall notify the applicant as soon as possible that more time is needed for examining the application, together with the reasons for the delay. Where a health data access body fails to provide a decision within the time limit, the data permit shall be issued.

4. Following the issuance of the data permit, the health data access body shall immediately request the electronic health data from the data holder. The health data access body shall make available the electronic health data to the data user within 2 months after receiving them from the data holders, unless the health data access body specifies that it will provide the data within a longer specified timeframe.

5. When the health data access body refuses to issue a data permit, it shall provide a justification for the refusal to the applicant.

6. The data permit shall set out the general conditions applicable to the data user, in particular:

   (a) types and format of electronic health data accessed, covered by the data permit, including their sources;

   (b) purpose for which data are made available;

   (c) duration of the data permit;

   (d) information about the technical characteristics and tools available to the data user within the secure processing environment;

   (e) fees to be paid by the data user;

   (f) any additional specific conditions in the data permit granted.

7. Data users shall have the right to access and process the electronic health data in accordance with the data permit delivered to them on the basis of this Regulation.

8. The Commission is empowered to adopt delegated acts to amend the list of aspects to be covered by a data permit in paragraph 7 of this Article, in accordance with the procedure set out in Article 67.

9. A data permit shall be issued for the duration necessary to fulfil the requested purposes which shall not exceed 5 years. This duration may be extended once, at the request of the data user, based on arguments and documents to justify this extension provided, 1 month before the expiry of the data permit, for a period which cannot exceed 5 years. By way of derogation from Article 42, the health data access body may charge increasing fees to reflect the costs and risks of storing electronic health data for a longer period of time exceeding the initial 5 years. In order to reduce such costs and fees, the health data access body may also propose to the data user to store the dataset in storage system with reduced capabilities. The data within the secure processing environment shall be deleted within 6 months following the expiry of the data permit. Upon request of the data user, the formula on the creation of the requested dataset shall be stored by the health data access body.

10. If the data permit needs to be updated, the data user shall submit a request for an amendment of the data permit.

11. Data users shall make public the results or output of the secondary use of electronic health data, including information relevant for the provision of healthcare, no later than 18 months after the completion of the electronic health data processing or after having received the answer to the data request referred to in Article 47. Those results or output shall only contain anonymised data. The data user shall inform the health data access bodies from which a data permit was obtained and support them to make the information public on health data access bodies’ websites. Whenever the data users have used electronic health data in accordance with this Chapter, they shall acknowledge the electronic health data sources and the fact that electronic health data has been obtained in the context of the EHDS. 

12. Data users shall inform the health data access body of any clinically significant findings that may influence the health status of the natural persons whose data are included in the dataset.

13. The Commission may, by means of implementing act, develop a logo for acknowledging the contribution of the EHDS. That implementing act shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

14. The liability of health data access bodies as joint controller is limited to the scope of the issued data permit until the completion of the processing activity.

### Article 47: Data request

1. Any natural or legal person may submit a data request for the purposes referred to in Article 34. A health data access body shall only provide an answer to a data request in an anonymised statistical format and the data user shall have no access to the electronic health data used to provide this answer.

2. A data request shall include the elements mentioned in paragraphs 2 (a) and (b) of Article 45 and if needed may also include:

   (a) a description of the result expected from the health data access body;

   (b) a description of the statistic’s content.

3. Where an applicant has requested a result in an anonymised form, including statistical format, based on a data request, the health data access body shall assess, within 2 months and, where possible, provide the result to the data user within 2 months.

### Article 48: Making data available for public sector bodies and Union institutions, bodies, offices and agencies without a data permit

By derogation from Article 46 of this Regulation, a data permit shall not be required to access the electronic health data under this Article. When carrying out those tasks under Article 37 (1), points (b) and (c), the health data access body shall inform public sector bodies and the Union institutions, offices, agencies and bodies, about the availability of data within 2 months of the data access application, in accordance with Article 9 of Regulation […] [Data Governance Act COM/2020/767 final]. By way of derogation from that Regulation […] [Data Governance Act COM/2020/767 final ], the health data access body may extend the period by 2 additional months where necessary, taking into account the complexity of the request. The health data access body shall make available the electronic health data to the data user within 2 months after receiving them from the data holders, unless it specifies that it will provide the data within a longer specified timeframe.

### Article 49: Access to electronic health data from a single data holder

1. Where an applicant requests access to electronic health data only from a single data holder in a single Member State, by way of derogation from Article 45(1), that applicant may file a data access application or a data request directly to the data holder. The data access application shall comply with the requirements set out in Article 45 and the data request shall comply with requirements in Article 47. Multi-country requests and requests requiring a combination of datasets from several data holders shall be adressed to health data access bodies.

2. In such case, the data holder may issue a data permit in accordance with Article 46 or provide an answer to a data request in accordance with Article 47. The data holder shall then provide access to the electronic health data in a secure processing environment in compliance with Article 50 and may charge fees in accordance with Article 42.

3. By way of derogation from Article 51, the single data provider and the data user shall be deemed joint controllers.

4. Within 3 months the data holder shall inform the relevant health data access body by electronic means of all data access applications filed and all the data permits issued and the data requests fulfilled under this Article in order to enable the health data access body to fulfil its obligations under Article 37(1) and Article 39.
### Article 50: Secure processing environment

1. The health data access bodies shall provide access to electronic health data only through a secure processing environment, with technical and organisational measures and security and interoperability requirements. In particular, they shall take the following security measures:

   (a) restrict access to the secure processing environment to authorised persons listed in the respective data permit;

   (b) minimise the risk of the unauthorised reading, copying, modification or removal of electronic health data hosted in the secure processing environment through state-of-the-art technological means;

   (c) limit the input of electronic health data and the inspection, modification or deletion of electronic health data hosted in the secure processing environment to a limited number of authorised identifiable individuals;

   (d) ensure that data users have access only to the electronic health data covered by their data permit, by means of individual and unique user identities and confidential access modes only;

   (e) keep identifiable logs of access to the secure processing environment for the period of time necessary to verify and audit all processing operations in that environment;

   (f) ensure compliance and monitor the security measures referred to in this Article to mitigate potential security threats.

2. The health data access bodies shall ensure that electronic health data can be uploaded by data holders and can be accessed by the data user in a secure processing environment. The data users shall only be able to download non-personal electronic health data from the secure processing environment.

3. The health data access bodies shall ensure regular audits of the secure processing environments.

4. The Commission shall, by means of implementing acts, provide for the technical, information security and interoperability requirements for the secure processing environments. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

### Article 51: Joint controllers

1. The health data access bodies and the data users, including Union institutions, bodies, offices and agencies, shall be deemed joint controllers of electronic health data processed in accordance with data permit.

2. The Commission shall, by means of implementing acts, establish a template for the joint controllers’ arrangement. Those implementing acts shall be adopted in accordance with the advisory procedure set out in Article 68(2).

### Section 4: Cross-Border access to electronic health data for secondary use
### Article 52: Cross-border infrastructure for secondary use of electronic health data (HealthData@EU)

1. Each Member State shall designate a national contact point for secondary use of electronic health data, responsible for making electronic health data available for secondary use in a cross-border context and shall communicate their names and contact details to the Commission. The national contact point may be the coordinator health data access body pursuant to Article 36. The Commission and the Member States shall make this information publicly available.

2. The national contact points referred to in paragraph 1 shall be authorised participants in the cross-border infrastructure for secondary use of electronic health data (HealthData@EU). The national contact points shall facilitate the cross-border access to electronic health data for secondary use for different authorised participants in the infrastructure and shall cooperate closely with each other and with the Commission. 

3. Union institutions, bodies, offices and agencies involved in research, health policy or analysis, shall be authorised participants of HealthData@EU.

4. Health-related research infrastructures or similar structures whose functioning is based on Union law and which support the use of electronic health data for research, policy making, statistical, patient safety or regulatory purposes shall be authorised participants of HealthData@EU.

5. Third countries or international organisations may become authorised participants where they comply with the rules of Chapter IV of this Regulation and provide access to data users located in the Union, on equivalent terms and conditions, to the electronic health data available to their health data access bodies. The Commission may adopt implementing acts establishing that a national contact point of a third country or a system established at an international level is compliant with requirements of HealthData@EU for the purposes of secondary use of health data, is compliant with the Chapter IV of this Regulation and provides access to data users located in the Union to the electronic health data it has access to on equivalent terms and conditions. The compliance with these legal, organisational, technical and security requirements, including with the standards for secure processing environments pursuant to Article 50 shall be checked under the control of the Commission. These implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68 (2). The Commission shall make the list of implementing acts adopted pursuant to this paragraph publicly available.

6. Each authorised participant shall acquire the required technical capability to connect to and participate in HealthData@EU. Each participant shall comply with the requirements and technical specifications needed to operate the cross-border infrastructure and to allow the authorised participants to connect to each other within it.

7. The Commission is empowered to adopt delegated acts in accordance with Article 67 in order to amend this Article to add or remove categories of authorised participants in HealthData@EU, taking into account the opinion of the joint controllership group pursuant to Article 66 of this Regulation.

8. The Member States and the Commission shall set up HealthData@EU to support and facilitate the cross-border access to electronic health data for secondary use, connecting the national contact points for secondary use of electronic health data of all Member States and authorised participants in that infrastructure.

9. The Commission shall develop, deploy and operate a core platform for HealthData@EU by providing information technology services needed to facilitate the connection between health data access bodies as part of the cross-border infrastructure for the secondary use of electronic health data. The Commission shall only process electronic health data on behalf of the joint controllers as a processor.

10. Where requested by two or more health data access bodies, the Commission may provide a secure processing environment for data from more than one Member State compliant with the requirements of Article 50. Where two or more health data access bodies put electronic health data in the secure processing environment managed by the Commission, they shall be joint controllers and the Commission shall be processor.

11. The authorised participants shall act as joint controllers of the processing operations in which they are involved carried out in HealthData@EU and the Commission shall act as a processor.

12. Member States and the Commission shall seek to ensure interoperability of HealthData@EU with other relevant common European data spaces as referred to in Regulations […] [Data Governance Act COM/2020/767 final] and […] [Data Act COM/2022/68 final].

13. The Commission may, by means of implementing acts, set out:

   (a) requirements, technical specifications, the IT architecture of HealthData@EU, conditions and compliance checks for authorised participants to join and remain connected to HealthData@EU and conditions for temporary or definitive exclusion from HealthData@EU; 

   (b) the minimum criteria that need to be met by the authorised participants in the infrastructure;

   (c) the responsibilities of the joint controllers and processor(s) participating in the cross-border infrastructures;

   (d) the responsibilities of the joint controllers and processor(s) for the secure environment managed by the Commission;

   (e) common specifications for the interoperability and architecture concerning HealthData@EU with other common European data spaces.

   Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

14. The approval for individual authorised participant to join HealthData@EU or to disconnect a participant from the infrastructure shall be issued by the Joint Controllership group, based on the results of the compliance checks.

### Article 53: Access to cross-border sources of electronic health data for secondary use

1. In the case of cross-border registries and databases, the health data access body in which the data holder is registered shall be competent to decide on data access applications to provide access to electronic health data. Where the registry has joint controllers, the health data access body that shall provide access to electronic health data shall be the body in the Member State where one of the joint controllers is established.

2. Where registries or databases from a number of Member States organise themselves into a single network of registries or databases at Union level, the associated registries may designate one of their members as a coordinator to ensure the provision of data from the registries’ network for secondary use. The health data access body of the Member State in which the coordinator of the network is located shall be competent to decide on the data access applications to provide access to electronic health data for the network of registries or databases. 

3. The Commission may, by means of implementing acts, adopt the necessary rules for facilitating the handling of data access applications for HealthData@EU, including a common application form, a common data permit template, standard forms for common electronic health data access contractual arrangements, and common procedures for handling cross-border requests, pursuant to Articles 45, 46, 47 and 48. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

### Article 54: Mutual recognition

1. When handling an access application for cross-border access to electronic health data for secondary use, health data access bodies and relevant authorised participants shall remain responsible for taking decisions to grant or refuse access to electronic health data within their remit in accordance with the requirements for access laid down in this Chapter.

2. A data permit issued by one concerned health data access body may benefit from mutual recognition by the other concerned health data access bodies.
### Section 5: Health data quality and utility for secondary use

### Article 55: Dataset description 

1. The health data access bodies shall inform the data users about the available datasets and their characteristics through a metadata catalogue. Each dataset shall include information concerning the source, the scope, the main characteristics, nature of electronic health data and conditions for making electronic health data available.

2. The Commission shall, by means of implementing acts, set out the minimum information elements data holders are to provide for datasets and their characteristics. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

### Article 56: Data quality and utility label

1. Datasets made available through health data access bodies may have a Union data quality and utility label provided by the data holders.

2. Datasets with electronic health data collected and processed with the support of Union or national public funding shall have a data quality and utility label, in accordance with the principles set out in paragraph 3.

3. The data quality and utility label shall comply with the following elements:

   (a) for data documentation: meta-data, support documentation, data model, data dictionary, standards used, provenance;

   (b) technical quality, showing the completeness, uniqueness, accuracy, validity, timeliness and consistency of the data;

   (c) for data quality management processes: level of maturity of the data quality management processes, including review and audit processes, biases examination;

   (d) coverage: representation of multi-disciplinary electronic health data, representativity of population sampled, average timeframe in which a natural person appears in a dataset;

   (e) information on access and provision: time between the collection of the electronic health data and their addition to the dataset, time to provide electronic health data following electronic health data access application approval;

   (f) information on data enrichments: merging and adding data to an existing dataset, including links with other datasets;

4. The Commission is empowered to adopt delegated acts in accordance with Article 67 to amend the list of principles for data quality and utility label. Such delegated acts may also amend the list set out under paragraph 3 by adding, modifying or removing requirements for data quality and utility label.

5. The Commission shall, by means of implementing acts, set out the visual characteristics and technical specifications of the data quality and utility label, based on the elements referred to in paragraph 3. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2). Those implementing acts shall take into account the requirements in Article 10 of Regulation […] [AI Act COM/2021/206 final] and any adopted common specifications or harmonised standards supporting those requirements.

### Article 57: EU Datasets Catalogue

1. The Commission shall establish an EU Datasets Catalogue connecting the national catalogues of datasets established by the health data access bodies and other authorised participants in HealthData@EU.

2. The EU Datasets Catalogue and the national datasets catalogues shall be made publicly available.

### Article 58: Minimum dataset specifications

The Commission may, by means of implementing acts, determine the minimum specifications for cross-border datasets for secondary use of electronic health data, taking into account existing Union infrastructures, standards, guidelines and recommendations. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).
## CHAPTER V: ADDITIONAL ACTIONS
### Article 59: Capacity building

The Commission shall support sharing of best practices and expertise, aimed to build the capacity of Member States to strengthen digital health systems for primary and secondary use of electronic health data. To support capacity building, the Commission shall draw up benchmarking guidelines for the primary and secondary use of electronic health data.

### Article 60: Additional requirements for public procurement and Union funding

1. Public procurers, national competent authorities, including digital health authorities and health data access bodies, and the Commission shall make reference to the applicable technical specifications, standards and profiles as referred to in Articles 6, 23, 50, 56, as relevant, as points of orientation for public procurements and when formulating their tender documents or calls for proposals, as well as when defining the conditions for Union funding regarding this Regulation, including enabling conditions for the structural and cohesion funds.

2. The ex-ante conditionality for Union funding shall take into account the requirements developed in the framework of Chapters II, III and IV.

### Article 61: Third country transfer of non-personal electronic data

1. Non-personal electronic data made available by health data access bodies, that are based on a natural person’s electronic data falling within one of the categories of Article 33 [(a), (e), (f), (i), (j), (k), (m)] shall be deemed highly sensitive within the meaning of Article 5(13) of Regulation […] [Data Governance Act COM/2020/767 final], provided that their transfer to third countries presents a risk of re-identification through means going beyond those likely reasonably to be used, in view of the limited number of natural persons involved in that data, the fact that they are geographically scattered or the technological developments expected in the near future.

2. The protective measures for the categories of data mentioned in paragraph 1 shall depend on the nature of the data and anonymization techniques and shall be detailed in the Delegated Act under the empowerment set out in Article 5(13) of Regulation […] [Data Governance Act COM/2020/767 final].

### Article 62: International access and transfer of non-personal electronic health data

1. The digital health authorities, health data access bodies, the authorised participants in the cross-border infrastructures provided for in Articles 12 and 52 and data users shall take all reasonable technical, legal and organisational measures, including contractual arrangements, in order to prevent international transfer or governmental access to non-personal electronic health data held in the Union where such transfer or access would create a conflict with Union law or the national law of the relevant Member State, without prejudice to paragraph 2 or 3 of this Article.

2. Any judgment of a third-country court or tribunal and any decision of a third-country administrative authority requiring a digital health authority, health data access body or data users to transfer or give access to non-personal electronic health data within the scope of this Regulation held in the Union shall be recognised or enforceable in any manner only if based on an international agreement, such as a mutual legal assistance treaty, in force between the requesting third country and the Union or any such agreement between the requesting third country and a Member State.

3. In the absence of an international agreement as referred to in paragraph 2 of this Article, where a digital health authority, a health data access body, data users is the addressee of a decision or judgment of a third-country court or tribunal or a decision of a third-country administrative authority to transfer or give access to non-personal data within the scope of this Regulation held in the Union and compliance with such a decision would risk putting the addressee in conflict with Union law or with the national law of the relevant Member State, transfer to or access to such data by that third-country authority shall take place only where:

   (a) the third-country system requires the reasons and proportionality of such a decision or judgment to be set out and requires such a decision or judgment to be specific in character, for instance by establishing a sufficient link to certain suspected persons or infringements;

   (b) the reasoned objection of the addressee is subject to a review by a competent third-country court or tribunal; and

   (c) the competent third-country court or tribunal issuing the decision or judgment or reviewing the decision of an administrative authority is empowered under the law of that third country to take duly into account the relevant legal interests of the provider of the data protected under Union law or the national law of the relevant Member State

4. If the conditions laid down in paragraph 2 or 3 are met, digital health authority, a health data access body or a data altruism body shall provide the minimum amount of data permissible in response to a request, based on a reasonable interpretation of the request.

5. The digital health authorities, health data access bodies, data users shall inform the data holder about the existence of a request of a third-country administrative authority to access its data before complying with that request, except where the request serves law enforcement purposes and for as long as this is necessary to preserve the effectiveness of the law enforcement activity.

### Article 63: International access and transfer of personal electronic health data

In the context of international access and transfer of personal electronic health data, Member States may maintain or introduce further conditions, including limitations, in accordance with and under the conditions of article 9(4) of the Regulation (EU) 2016/679.
## CHAPTER VI: EUROPEAN GOVERNANCE AND COORDINATION 
### Article 64: European Health Data Space Board (EHDS Board)

1. A European Health Data Space Board (EHDS Board) is hereby established to facilitate cooperation and the exchange of information among Member States. The EHDS Board shall be composed of the high level representatives of digital health authorities and health data access bodies of all the Member States. Other national authorities, including market surveillance authorities referred to in Article 28, European Data Protection Board and European Data Protection Supervisor may be invited to the meetings, where the issues discussed are of relevance for them. The Board may also invite experts and observers to attend its meetings, and may cooperate with other external experts as appropriate. Other Union institutions, bodies, offices and agencies, research infrastructures and other similar structures shall have an observer role.

2. Depending on the functions related to the use of electronic health data, the EHDS Board may work in subgroups, where digital health authorities or health data access bodies for a certain area shall be represented. The subgroups may have joint meetings, as required.

3. The composition, organisation, functioning and cooperation of the sub-groups shall be set out in the rules of procedure put forward by the Commission.

4. Stakeholders and relevant third parties, including patients’ representatives, shall be invited to attend meetings of the EHDS Board and to participate in its work, depending on the topics discussed and their degree of sensitivity.

5. The EHDS Board shall cooperate with other relevant bodies, entities and experts, such as the European Data Innovation Board referred to in Article 26 of Regulation […] [Data Governance Act COM/2020/767 final], competent bodies set up under Article 7 of Regulation […] [Data Act COM/2022/68 final], supervisory bodies set up under Article 17 of Regulation […] [eID Regulation], European Data Protection Board referred to in Article 68 of Regulation (EU) 2016/679 and cybersecurity bodies.

6. The Commission shall chair the meetings of the EHDS Board.

7. The EHDS Board shall be assisted by a secretariat provided by the Commission.

8. The Commission shall, by means of implementing acts, adopt the necessary measures for the establishment, management and functioning of the EHDS Board. Those implementing acts shall be adopted in accordance with the advisory procedure referred to in Article 68(2).

### Article 65: Tasks of the EHDS Board

1. The EHDS Board shall have the following tasks relating to the primary use of electronic health data in accordance with Chapters II and III:

   (a) to assist Member States in coordinating practices of digital health authorities;

   (b) to issue written contributions and to exchange best practices on matters related to the coordination of the implementation at Member State level of this Regulation and of the delegated and implementing acts adopted pursuant to it, in particular as regards: 

   - (i) the provisions set out in Chapters II and III;

   - (ii) development of online services facilitating secure access, including secure electronic identification, to electronic health data for health professionals and natural persons;

   - (iii) other aspects of the primary use of electronic health data.

   (c) to facilitate cooperation between digital health authorities through capacity-building, establishing the structure for annual activity reporting, peer-review of annual activity reports and exchange of information;

   (d) to share information concerning risks posed by EHR systems and serious incidents as well as their handling;

   (e) to facilitate the exchange of views on the primary use of electronic health data with the relevant stakeholders, including representatives of patients, health professionals, researchers, regulators and policy makers in the health sector.

2. The EHDS Board shall have the following tasks related to the secondary use of electronic health data in accordance with Chapter IV:

   (a) to assist Member States in coordinating practices of health data access bodies in the implementation of provisions set out in Chapters IV, to ensure a consistent application of this Regulation;

   (b) to issue written contributions and to exchange best practices on matters related to the coordination of the implementation at Member State level of this Regulation and of the delegated and implementing acts adopted pursuant to it, in particular as regards:

   - (xi) implementation of rules for access to electronic health data;

   - (xii) technical specifications or existing standards regarding the requirements set out in Chapter IV; 

   - (xiii) incentives policy for promoting data quality and interoperability improvement;

   - (xiv) policies concerning fees to be charged by the health data access bodies and data holders;

   - (xv) the establishment and application of penalties;

   - (xvi) other aspects of the secondary use of electronic health data.

   (c) to facilitate cooperation between health data access bodies through capacity-building, establishing the structure for annual activity reporting, peer-review of annual activity reports and exchange of information;

   (d) to share information concerning risks and data protection incidents related to secondary use of electronic health data, as well as their handling;

   (e) to contribute to the work of the European Data Innovation Board to be established in accordance with Article 29 of the Regulation […] [Data Governance Act COM/2020/767 final];

   (f) to facilitate the exchange of views on the secondary use of electronic health data with the relevant stakeholders, including representatives of patients, health professionals, researchers, regulators and policy makers in the health sector.

### Article 66: Joint controllership groups for Union infrastructures

1. The Commission shall establish two groups dealing with joint controllership for the cross-border infrastructures provided for in Articles 12 and 52. The groups shall be composed of the representatives of the national contact points and other authorised participants in those infrastructures. 

2. The composition, organisation, functioning and cooperation of the sub-groups shall be set out in the rules of procedure adopted by those groups.

3. Stakeholders and relevant third parties, including patients’ representatives, may be invited to attend meetings of the groups and to participate in their work.

4. The groups shall elect chairs for their meetings.

5. The groups shall be assisted by a secretariat provided by the Commission.

6. The groups shall take decisions concerning the development and operation of the cross-border infrastructures pursuant to Chapters II and IV, on changes of infrastructure, adding additional infrastructures or services, or ensuring interoperability with other infrastructures, digital systems or data spaces. The group shall also take decisions to accept individual authorised participants to join the infrastructures or to disconnect them.
## CHAPTER VII: DELEGATION AND COMMITTEE 
### Article 67: Exercise of the delegation

1. The power to adopt delegated acts is conferred on the Commission subject to the conditions laid down in this Article.

2. The power to adopt delegated acts referred to in Articles 5(2), 10(3), 25(3), 32(4), 33(7), 37(4), 39(3), 41(7), 45(7), 46(8), 52(7), 56(4) shall be conferred on the Commission for an indeterminate period of time from the date of entry into force of this Regulation.

3. The power to adopt delegated acts referred to in Articles 5(2), 10(3), 25(3), 32(4), 33(7), 37(4), 39(3), 41(7), 45(7), 46(8), 52(7), 56(4) may be revoked at any time by the European Parliament or by the Council. A decision to revoke shall put an end to the delegation of the power specified in that decision. It shall take effect the day following the publication of the decision in the Official Journal of the European Union or at a later date specified therein. It shall not affect the validity of any delegated acts already in force.

4. Before adopting a delegated act, the Commission shall consult experts designated by each Member State in accordance with the principles laid down in the Inter-institutional Agreement of 13 April 2016 on Better Law-Making.

5. As soon as it adopts a delegated act, the Commission shall notify it simultaneously to the European Parliament and to the Council.

6. A delegated act adopted pursuant to Articles 5(2), 10(3), 25(3), 32(4), 33(7), 37(4), 39(3), 41(7), 45(7), 46(8), 52(7), 56(4) shall enter into force only if no objection has been expressed either by the European Parliament or by the Council within a period of 3 months of notification of that act to the European Parliament and to the Council or if, before the expiry of that period, the European Parliament and the Council have both informed the Commission that they will not object. That period shall be extended by 3 months at the initiative of the European Parliament or of the Council.

### Article 68: Committee procedure

1. The Commission shall be assisted by a committee. That committee shall be a committee within the meaning of Regulation (EU) No 182/2011.

2. Where reference is made to this paragraph, Article 4 of Regulation (EU) No 182/2011 shall apply.

## CHAPTER VIII: MISCELLANEOUS 
### Article 69: Penalties

Member States shall lay down the rules on penalties applicable to infringements of this Regulation and shall take all measures necessary to ensure that they are implemented. The penalties shall be effective, proportionate and dissuasive. Member States shall notify the Commission of those rules and measures by date of application of this Regulation and shall notify the Commission without delay of any subsequent amendment affecting them.

### Article 70: Evaluation and review

1. After 5 years from the entry into force of this Regulation, the Commission shall carry out a targeted evaluation of this Regulation especially with regards to Chapter III, and submit a report on its main findings to the European Parliament and to the Council, the European Economic and Social Committee and the Committee of the Regions, accompanied, where appropriate, by a proposal for its amendment. The evaluation shall include an assessment of the self-certification of EHR systems and reflect on the need to introduce a conformity assessment procedure performed by notified bodies.

2. After 7 years from the entry into force of this Regulation, the Commission shall carry out an overall evaluation of this Regulation, and submit a report on its main findings to the European Parliament and to the Council, the European Economic and Social Committee and the Committee of the Regions, accompanied, where appropriate, by a proposal for its amendment.

3. Member States shall provide the Commission with the information necessary for the preparation of that report.
### Article 71: Amendment to Directive 2011/24/EU

Article 14 of Directive 2011/24/EU is deleted.
## CHAPTER IX: DEFERRED APPLICATION AND FINAL PROVISIONS 
### Article 72: Entry into force and application

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

It shall apply from 12 months after its entry into force.

However, Articles 3, 4, 5, 6, 7, 12, 14, 23 and 31 shall apply as follows:

(a) from 1 year after date of entry into application to categories of personal electronic health data referred to in Article 5(1), points (a), (b) and (c), and to EHR systems intended by the manufacturer to process such categories of data.;

(b) from 3 years after date of entry into application to categories of personal electronic health data referred to in Article 5(1), points (d), (e) and (f), and to EHR systems intended by the manufacturer to process such categories of data;

(c) from the date established in delegated acts pursuant to Article 5(2) for other categories of personal electronic health data.

Chapter III shall apply to EHR systems put into service in the Union pursuant to Article 15(2) from 3 years after date of entry into application.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

---

# EUDI Wallet - Accreditation of conformity assessment bodies
Source: https://docs.igrant.io/regulations/implementing-acts-accreditation-conformity/

---
id: implementing-acts-accreditation-conformity
title: EUDI Wallet - Accreditation of conformity assessment bodies
description: Learn about the EU Implementing Acts on accreditation of conformity assessment bodies for EU Digital Identity Wallets.
sidebar_label: Accreditation of conformity assessment
keywords: [Implementing Acts, EUDI Wallet, accreditation, conformity assessment, certification body, eIDAS 2.0]
slug: /implementing-acts-accreditation-conformity/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on accreditation of conformity assessment bodies for EU Digital Identity Wallets."/>
</head>

Commission Implementing **Regulation (EU) 2025/2162** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/2162/oj).


### Article 1: Definitions  

For the purpose of this Regulation, the following definitions shall apply:  

1. **'scheme owner'** means an entity or a group of entities which is responsible for developing and maintaining a conformity assessment scheme;  

2. **'certification decision'** means a certification decision, which follows a conformity assessment conducted by a conformity assessment body where that body positively or negatively confirms the conformity of a specific qualified trust service provider and the qualified trust service it provides with the requirements laid down in Regulation (EU) No 910/2014 and with Article 21 of Directive (EU) 2022/2555;  

3. **'certificate of conformity'** means a document by which a conformity assessment body attests a certification decision that positively confirms that a specific qualified trust service provider and the qualified trust service it provides comply with the requirements laid down in Regulation (EU) No 910/2014 and with Article 21 of Directive (EU) 2022/2555;  

4. **'conformity assessment scheme'** means a set of rules and procedures to be used by conformity assessment bodies for the purpose of the assessment of the conformity of qualified trust service providers and the qualified trust services that they provide with the requirements laid down in Regulation (EU) No 910/2014 and with Article 21 of Directive (EU) 2022/2555;  

5. **'conformity assessment report'** means a document that provides detailed information, where applicable supplementary to that contained in a certification decision and associated certificate of conformity, on the method used to carry out, in accordance with a conformity assessment scheme, a conformity assessment of the compliance of a specific qualified trust service provider and the qualified trust service it provides with the requirements of Regulation (EU) No 910/2014 and of Article 21 of Directive (EU) 2022/2555 and on the results of the conformity assessment;  

6. **'accreditation'** means an accreditation, as defined in Article 2, point 10 of Regulation (EC) No 765/2008;  

7. **'flexible scope accreditation'** means an accreditation where the specific conformity assessment activities for which accreditation is sought, or has been granted, are expressed to allow conformity assessment bodies to make changes in methodology and other parameters which fall within the competence of the conformity assessment body as confirmed by the national accreditation body;  

8. **'national accreditation body'** means a national accreditation body as defined in Article 2, point 11, of Regulation (EC) No 765/2008.  

### Article 2: Accreditation of conformity assessment bodies  

1. For the purposes of making certification decisions in accordance with a specific conformity assessment scheme, conformity assessment bodies shall be accredited in accordance with standard EN ISO/IEC 17065:2012 supplemented by standard ETSI EN 319 403-1 v2.3.1.  

2. The accreditation of conformity assessment bodies referred to in paragraph 1 shall be performed by a national accreditation body in compliance with standard EN ISO/IEC 17011:2017.  

### Article 3: Accreditation certificate issued to conformity assessment bodies  

1. National accreditation bodies shall ensure that the accreditation certificates they issue to conformity assessment bodies contain at least the following information:  

   (a) the unique accreditation certificate identity code;  

   (b) the issuance date of the accreditation certificate;  

   (c) the name and country, as stated in the national official records, of the national accreditation body issuing the accreditation certificate;  

   (d) the name and, where applicable, registration number as stated in the national official records, of the accredited conformity assessment body;  

   (e) the scope of accreditation, with regard to one or more of the following qualified trust services:  

   - the issuance of qualified certificates for electronic signatures;  

   - the issuance of qualified certificates for electronic seals;  

   - the issuance of qualified certificates for website authentication;  

   - the qualified validation service for qualified electronic signatures;  

   - the qualified validation service for qualified electronic seals,  

   - the qualified preservation service for qualified electronic signatures;  

   - the qualified preservation service for qualified electronic seals;  

   - the creation of qualified electronic timestamps;  

   - the provision of qualified electronic registered delivery services;  

   - the qualified service for the management of remote qualified electronic signature creation devices;  

   - the qualified service for the management of remote qualified electronic seal creation devices;  

   - the provision of qualified electronic archiving services;  

   - the issuance of qualified electronic attestations of attributes;  

   - the recording of electronic data in a qualified electronic ledger.  

   (f) the identification, including, where relevant, the specific version, of the conformity assessment scheme for which the conformity assessment body has been accredited;  

   (g) the indication of the use of the flexible scope accreditation, where relevant;  

   (h) the identification, where relevant, of the document outlining the design and implementation process of the flexible scope accreditation.  

2. National accreditation bodies shall ensure that the start date, and where applicable, the end date of the accreditation of the conformity assessment body for conducting the conformity assessment of the qualified trust services as referred to in paragraph 1, point (e), including specific dates for each qualified trust service as applicable, are part of the accreditation details referred to in Article 20(1b) of Regulation (EU) No 910/2014.  

3. National accreditation bodies shall ensure that any relevant changes made in relation to the information provided in accordance with paragraph 1 shall be clearly reflected in the accreditation certificate.  

4. The accreditation certificate shall clearly describe the scope of the accreditation of the conformity assessment body, in accordance with Article 2(1).  

### Article 4: Reconsideration of existing accreditation  

1. The scheme owner shall implement procedures to monitor any changes in the standards referred to in Article 2(1) or in Article 6(3), or to a conformity assessment scheme owned by it and on the basis of which a conformity assessment body has been accredited in accordance with Article 2.  

2. The scheme owner shall notify the national accreditation body of the changes identified as a result of the procedures referred to in paragraph 1, in a timely manner.  

3. Where the national accreditation body did not apply flexible scope accreditation to accredited conformity assessment bodies, the national accreditation body shall determine whether the changes, identified as a result of the procedures referred to in paragraph 1, are likely to materially affect the ability of accredited conformity assessment bodies to conduct conformity assessments pursuant to schemes for which they have been accredited.  

4. Where the national accreditation body determines, pursuant to paragraph 3, that changes do affect the ability of conformity assessment bodies to conduct conformity assessments, it shall request the conformity assessment body to take appropriate measures within a reasonable prescribed period.  

5. If the conformity assessment body is unable or unwilling to take the measures referred to in paragraph 4 within the period prescribed, the national accreditation body shall immediately withdraw or suspend the accreditation.  

6. Where the national accreditation body determines, pursuant to paragraph 3, that changes do not affect the ability of conformity assessment bodies to conduct conformity assessments, it may, where appropriate, extend the validity and scope of the accreditation of the assessed conformity assessment body.  

7. Where appropriate, the national accreditation body shall update the accreditation certificate in a timely manner to reflect the outcome of the reconsideration of the accreditation pursuant to this Article.  

8. Where a conformity assessment body receives a request pursuant to paragraph 4, it shall, in a timely manner, inform any qualified trust service providers that it has previously assessed under the relevant conformity assessment scheme of any impacts that the reconsideration of the conformity assessment body's accreditation may have on those qualified trust service providers, including with respect to future certification decisions made by the conformity assessment body under that scheme.  

### Article 5: Conformity assessment bodies  

1. Conformity assessment bodies shall make the certificates of conformity they issue available in a public repository maintained by that conformity assessment body for that purpose.  

2. Any subcontracting by the conformity assessment body of the performance of conformity assessment activities shall duly consider the nature of the activity to be performed. The conformity assessment body shall ensure that the subcontractor complies with the standards set out in Annex I for the specific activity being subcontracted.  

3. Conformity assessment bodies shall ensure, upon issuing a certification decision, that the qualified trust services provider to whom the decision relates, is able to submit the complete conformity assessment reports corresponding to that decision to the supervisory bodies.  

### Article 6: Conformity assessment schemes  

1. Each conformity assessment scheme shall identify a scheme owner.  

2. A conformity assessment scheme shall comply with scheme type 6 of standard EN ISO/IEC 17067:2013 and with the requirements laid down in this Article.  

3. Scheme owners shall ensure that their conformity assessment schemes include at least the standards, as applicable, set out in Annex II by indicating the year and version number of these standards.  

4. Scheme owners shall ensure that where a flexible scope accreditation is applicable, this is indicated in the conformity assessment scheme.  

5. Scheme owners shall ensure that their conformity assessment schemes establish processes and procedures, regarding at least the following:  

   (a) receiving and handling complaints to the scheme owner on the implementation of the conformity assessment scheme;  

   (b) notifications by the conformity assessment body to the supervisory body designated in accordance with Article 46b(1) of Regulation (EU) No 910/2014 on the issuance of certificates of conformity and any changes thereto;  

   (c) where applicable, subcontracting the performance of conformity assessment activities by the conformity assessment body;  

   (d) the performance of yearly surveillance activities on the basis of the applicable requirements of clause 7.9 of standard ISO/IEC 17065:2012;  

   (e) the management and notification by the qualified trust service provider to the conformity assessment body and to the competent supervisory body of any change impacting the operation of qualified trust service providers or the qualified trust services they provide;  

   (f) the verification of evidence demonstrating that the conformity assessment body:  

   - has sufficient knowledge and expertise in the application of specific standards related to the qualified trust service provided by the qualified trust service provider, as referred to in paragraph 3;  

   - has professional experience in conformity assessment in at least three assessments of trust service providers or three assessments of information security management systems; and  

   - can ensure the availability of a team of no fewer than two qualified persons possessing the necessary expertise to carry out such conformity assessment.  

6. Scheme owners shall ensure that their conformity assessment schemes require the qualified trust service providers to have processes, procedures and work instructions in place to notify the conformity assessment body at least one month before the qualified trust service providers implement any significant change in the provision of the qualified trust services certified under that scheme and at least three months before it intends to cease the provision of the services or parts thereof.  

7. Scheme owners shall ensure that their conformity assessment schemes do not allow positive certification decisions, or any certificate of conformity, to be issued where the conformity assessment leads to the identification of non-conformity of the assessed qualified trust service providers and the qualified trust service they provide with the requirements of Regulation (EU) No 910/2014 and of Article 21 of Directive (EU) 2022/2555.  

8. Scheme owners shall ensure that their conformity assessment schemes set out the procedure for the attestation of a certificate of conformity. They shall require, in particular, that the qualified trust service providers immediately inform the competent supervisory body of any change to a certificate of conformity. They shall also require that qualified trust services providers refrain from providing the qualified trust services concerned or from advertising any reference thereto until the competent supervisory body reconfirms the qualified status. This procedure shall comply with the requirements set out in clause 7.11 of standard ISO/IEC 17065:2012.  

9. Scheme owners shall ensure that their conformity assessment schemes set out the conformity assessment process to be conducted over a sufficient number of person-days and shall ensure that sufficient resources and time are allocated for the conformity assessment, taking into account the scope and the complexity of the assessment.  

10. Scheme owners shall make a summary of the conformity assessment scheme publicly available for download. The summary shall contain a description of the set of rules and procedures followed for the assessment of the conformity of qualified trust service providers and the qualified trust services they provide with the requirements of Regulation (EU) No 910/2014 and of Article 21 of Directive (EU) 2022/2555.  

11. Scheme owners shall ensure that their conformity assessment schemes require that at least one surveillance conformity assessment is conducted annually for every evaluated qualified trust service.  

### Article 7: Conformity assessment reports  

1. The conformity assessment report referred to in Article 20(1) of Regulation (EU) No 910/2014, shall comply with the specifications set out in Annex III.  

2. The conformity assessment report shall be considered a part of the certification documentation specified in clause 7.7 of standard ETSI EN 319 403-1.  

### Article 8: Accreditation information  

1. Any interested party can request, free of charge, current and past information about the scope, start date and, where applicable, end date of the accreditation of conformity assessment bodies, for each type of qualified trust service that the conformity assessment body is or has been accredited to assess. This information shall be made available by national accreditation bodies.  

2. Current and past information, as referred to in paragraph 1, should be made available for at least a period of 6 years after the accreditation of the conformity assessment body.  

### Article 9: Grandfathering provision  

Conformity assessment bodies that have, before 17 November 2025, been accredited with reference to standard ETSI EN 319 403 version 2.2.2, or earlier version, for the purposes of the assessment of conformity with Regulation (EU) No 910/2014 of qualified trust service providers and the qualified trust services they provide shall have their accreditation be considered to meet the requirements of Article 2(1) until 17 May 2027.  

### Article 10: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 27 October 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX I  

### Reference standards for the subcontracting of conformity assessment activities  

   1. EN ISO/IEC 17025:2017 for testing activities;  

   2. EN ISO/IEC 17021-1:2015 for audit activities of management systems;  

   3. EN ISO/IEC 17020:2012 for inspection activities;  

   4. EN ISO/IEC 17065:2012 for conformity assessments activities.  

## ANNEX II  

### Reference standards for conformity assessment schemes  

The standards referred to in Article 6(3) are ETSI TS 119 612 v2.4.1 and the following:  

| **Qualified Trust Service** | **Relevant standards** |
| ----------------------- | ------------------ |
| The issuance of qualified certificates for electronic signatures | ETSI EN 319 411 -2; ETSI EN 301 549; ETSI EN 319 412 -1; ETSI EN 319 412 -2; ETSI EN 319 412 -5; ETSI TS 119 461; ETSI EN 319 401 |
| The issuance of qualified certificates for electronic seals | ETSI EN 319 411 -2; ETSI TS 119 495; ETSI EN 301 549; ETSI EN 319 412 -1; ETSI EN 319 412 -2; ETSI EN 319 412 -3; ETSI EN 319 412 -5; ETSI TS 119 461; ETSI EN 319 401 |
| The issuance of qualified certificates for website authentication | ETSI EN 319 411 -2; ETSI TS 119 411 -5; ETSI TS 119 495; ETSI EN 301 549; ETSI EN 319 412 -1; ETSI EN 319 412 -4; ETSI EN 319 412 -5; ETSI TS 119 461; ETSI EN 319 401 |
| The qualified validation service for qualified electronic signatures | ETSI TS 119 441; ETSI TS 119 442; ETSI EN 319 102 -1; ETSI TS 119 102 -2; ETSI TS 119 172 -4; ETSI EN 301 549; ETSI EN 319 401 |
| The qualified validation service for qualified electronic seals | ETSI TS 119 441; ETSI TS 119 442; ETSI EN 319 102 -1; ETSI TS 119 102 -2; ETSI TS 119 172 -4; ETSI EN 301 549; ETSI EN 310 401 |
| The qualified preservation service for qualified electronic signatures | ETSI TS 119 511; ETSI TS 119 172 -4; ETSI TS 119 512; ETSI EN 301 549; ETSI EN 310 401 |
| The qualified preservation service for qualified electronic seals | ETSI TS 119 511; ETSI TS 119 172 -4; ETSI TS 119 512; ETSI EN 301 549; ETSI EN 319 401 |
| The creation of qualified electronic time stamps | ETSI EN 319 421; ETSI EN 319 422; ETSI EN 301 549; ETSI EN 319 401 |
| The provision of qualified electronic registered delivery services | ETSI EN 319 521; ETSI EN 319 522; ETSI EN 319 531; ETSI EN 319 532; ETSI EN 301 549; ETSI TS 119 461; ETSI EN 319 401 |
| The qualified service for the management of remote qualified electronic signature creation devices | ETSI TS 119 431 -1; ETSI EN 301 549; ETSI TS 119 461; ETSI EN 319 401 |
| The qualified service for the management of remote qualified electronic seal creation devices | ETSI TS 119 431 -1; ETSI EN 301 549; ETSI TS 119 461; ETSI EN 319 401 |
| The provision of qualified electronic archiving services | ISO 14641; ISO 14721; CEN/TS 18170; ETSI TS 301 549; ETSI EN 319 401; ETSI EN 119 511 |
| The issuance of qualified electronic attestations of attributes | ETSI TS 119 471; ETSI EN 301 549; ETSI TS 119 461; ETSI EN 319 401 |
| The recording of electronic data in a qualified electronic ledger | ETSI EN 319 401; ETSI EN 301 549; CEN/TS 18170; ISO 23257; ISO/TS 23635; ETSI EN 319 122 -1; ETSI EN 319 132 -1; ETSI EN 319 182 -1 |

## ANNEX III  

### Specifications for conformity assessment reports  

The conformity assessment report as referred to in Article 7(1) shall

1. be accompanied by a clear certification decision in accordance with clause 7.6 of standard ETSI EN 319403-1 v2.3.1 ('ETSI EN 319403-1'), confirming, whether the assessed trust service provider and the assessed qualified trust services it provides or aims to provide meet the requirements laid down in Regulation (EU) No 910/2014 and in Article 21 of Directive (EU) 2022/2555;

2. specify the name of the qualified trust service provider and, where applicable, its registration number, as stated in the official records, its official postal address, and its electronic address as well as, where applicable, the same information for all subsidiaries, affiliated legal entities, contractors and subcontractors that are operating trust service components in the scope of the provision of the qualified trust services by the qualified trust service provider;

3. include a detailed description of the scope of the assessment of the qualified trust service provider, including the specific qualified trust services covered by the assessment;

4. contain sufficient evidence to demonstrate that the qualified trust service provider and the qualified trust services it provides fulfil the requirements laid down in Regulation (EU) No 910/2014 and in Article 21 of Directive (EU) 2022/2555;

5. specify the name of the conformity assessment body, and, where applicable its registration number, as stated in the official records, its registered postal address, and its electronic address;

6. specify the following:
    (a) the name and country of the national accreditation body having accredited the conformity assessment body
    (b) the names of the natural persons involved by the conformity assessment body in performing the conformity assessment and their respective role in that assessment
    (c) the link to the official website of the national accreditation body and containing the accreditation certificate issued by the national accreditation body to the conformity assessment body
    (d) where applicable, the digital accreditation symbol
    (e) the conformity assessment scheme for which the conformity assessment body has been accredited in accordance with Article 2(1)
    (f) conformity assessment enquiries of the conformity assessment conducted, the rationale behind their selection, and the methodology employed, including sampling methodology and test procedures
    (g) the accredited conformity assessment scheme and relevant documents or a link to the location from where that conformity assessment scheme and relevant documents are available

7. contain at least one qualified electronic signature, where the report is provided in an electronic form, or handwritten signature, where provided paper-based, identifying the name and title of the responsible person or persons that authorised to adopt the certification decision on behalf of the conformity assessment body;  

8. concern one qualified trust service provider;  

9. identify, in accordance with clause 5.5.3 of standard ETSI TS 119612 v.2.4.1, the service digital identities per type of qualified trust service for which it confirms the conformity with the requirements laid down in Regulation (EU) No 910/2014 and in Article 21 of Directive (EU) 2022/2555, providing the following information:
    (a) when the qualified trust service is not public key infrastructure technology based, an identifier expressed as a URI that uniquely identifies the qualified trust service  
    (b) when the qualified trust service is based on public key infrastructure technology, at least the following:  
     - the Subject Key Identifier as defined in IETF RFC 5280
     - the Base64 PEM representation of the associated X.509v3 digital certificate
     - where applicable, an indication whether specific sets or subsets of end-entity certificates issued by or under the service digital identity are excluded from or specifically included in the certification decision and on the basis of which criteria they may be identified
     - an indication whether the service digital identity relates to an end-entity or a certification authority, clarifying whether it is an issuing, intermediate or root certificate
     - a description on how the service digital identity is used in the context of the corresponding qualified trust service

10. provide, where applicable, a detailed description of the public key infrastructure functional hierarchy, per type of qualified trust service and for all service digital identities identified in accordance with point 11, including at least:
    (a) the illustration of the public key infrastructure hierarchy identifying the root certification authorities, the intermediate certification authorities, the issuing certification authorities and the certification paths between them  
    (b) the identification of each certification authority illustrated in point (a) through the Subject Key Identifier as defined in IETF RFC 5280  
    (c) for each of the issuing certification authorities identified in accordance with point (b), the list of the different policy sets of certificates that each certification authority is issuing, together with for each set:  
     - criteria that unambiguously identify the certificates of the set, being either a list of certificate policy identifiers to match with the content of the certificate policy certificate extension as defined in IETF RFC 5280 or other criteria as set out in implementing acts adopted pursuant to Article 22(5) of Regulation (EU) No 910/2014
     - an indication of whether the certificates of the set are either qualified or non-qualified
     - an indication of whether the certificates of the set are either for electronic signatures, or for electronic seals, or for web site authentication or for none of those purposes and, in the latter case, for which other purposes their use is intended
     - an indication of whether the private key corresponding to the public key certified in the certificates of the sets resides in a local or remote qualified signature or seal creation device

11. include, in accordance with point 2
    (a) an exhaustive list of third parties, including subcontractors, which provide qualified trust service components or service components by indicating their name, as identified in point 2, together with the location of the sites where the corresponding component services are operated;
    (b) an indication whether those third parties and sites have been subject to the conformity assessment and to which extent;  

12. describe, where appropriate, the content of the entry to be included, or to be updated, in the relevant national trusted list, in accordance with the result of the assessment;  

13. include an exhaustive list of public and qualified trust service providers' internal documents, which are properly identified including versioning, which have been part of the scope of the conformity assessment, including at least the following documentation as referred to in point 8, for which a copy shall be either provided together with the conformity assessment report or made otherwise available to the competent supervisory body on its request:
    (a) the declaration of the practices used by the qualified trust service provider to provide the qualified trust services  
    (b) the set of rules that indicates the applicability of the qualified trust services to a particular community or class of application with common security requirements ('qualified trust service policies')  
    (c) the terms and conditions related to subscriber agreements  
    (d) the termination plan of the qualified trust services  
    (e) the documentation which is related to the assessment of risks and which aims to demonstrate that the requirements of Article 24(2), points (fa) and (fb) of Regulation (EU) No 910/2014 and Article 21 of Directive (EU) 2022/2555 have been fulfilled  
    (f) the security breaches notification plan which aims to demonstrate that the requirements of Article 24(2), points (fa) and (fb) of Regulation (EU) No 910/2014 and Article 21 of Directive (EU) 2022/2555 have been fulfilled  
    (g) the list of all internal documents supporting the effective implementation of the practices declared and used by the qualified trust service provider to provide the qualified trust services  
    (h) the memorandum and articles of incorporation or statutes of the qualified trust service provider, in accordance with the applicable national laws, together with the following elements:  
     - statement of business activities not relating to the provision of trust services
     - organisational chart
     - ownership structure information
     - where applicable and available, report of the accounts of the accounts auditor for the previous two accounting years, or from the date of its incorporation until the date of signing the conformity assessment report, whichever period is shorter

    (i) evidence that the qualified trust service provider, in accordance with applicable national laws, maintains sufficient financial resources and, where applicable, has obtained appropriate liability insurance with regard to the provision of the qualified trust services  
    (j) the list of standards with which the operations are claimed to be compliant  
    (k) the list of standards with which the operations are audited, evaluated, certified, or assessed to be compliant, together with details about the underlying audit, evaluation, certification or assessment scheme, as applicable  
    (l) the list of qualified electronic signature creation devices or qualified electronic seal creation devices and their certification related information when the qualified trust service provider delivers or makes available such devices to its users  
    (m) the list of devices used by the qualified trust service provider as trustworthy system or product, including hardware security modules or secure cryptographic devices, to protect its own keys, and information related to their certification, when the qualified trust service provider uses such devices to secure the processes supporting the qualified trust services it provides  

14. contain an assessment of the fulfilment of the requirements that apply to the relevant qualified trust services pursuant to Regulation (EU) No 910/2014, and, where applicable, as set out in the implementing and delegated acts that apply to that qualified trust service as adopted in accordance with:
    - Article 24(1c) of Regulation (EU) No 910/2014 with respect to the verification of the identity and attributes of persons to whom the qualified certificate or the qualified electronic attestation is to be issued
    - Article 24(5) of Regulation (EU) No 910/2014 with respect to the requirements for qualified trust service providers providing qualified trust services
    - Article 28(6) of Regulation (EU) No 910/2014 with respect to the issuance of qualified certificates for electronic signatures
    - Article 38(6) of Regulation (EU) No 910/2014 with respect to the issuance of qualified certificates for electronic seals
    - Article 45(2) of Regulation (EU) No 910/2014 with respect to the issuance of qualified certificates for website authentication
    - Article 33(2) of Regulation (EU) No 910/2014 with respect to the qualified validation service for qualified electronic signatures
    - Article 33(2) and Article 40 of Regulation (EU) No 910/2014 with respect to the qualified validation service for qualified electronic seals,
    - Article 34(2) of Regulation (EU) No 910/2014 with respect to the qualified preservation service for qualified electronic signatures
    - Article 34(2) and Article 40 of Regulation (EU) No 910/2014 with respect to the qualified preservation service for qualified electronic seals
    - Article 42(2) of Regulation (EU) No 910/2014 with respect to the creation of qualified electronic timestamps
    - Article 44(2) of Regulation (EU) No 910/2014 with respect to the provision of qualified electronic registered delivery services
    - Article 29a(2) of Regulation (EU) No 910/2014 with respect to the qualified service for the management of remote qualified electronic signature creation devices
    - Article 29a(2) and Article 39a of Regulation (EU) No 910/2014 with respect to the qualified service for the management of remote qualified electronic seal creation devices
    - Article 45j(2) of Regulation (EU) No 910/2014 with respect to the provision of qualified electronic archiving services
    - Article 45d(5) of Regulation (EU) No 910/2014 with respect to the issuance of qualified electronic attestation of attributes
    - Article 45l(3) of Regulation (EU) No 910/2014 with respect to the recording of electronic data in a qualified electronic ledger

15. contains an assessment of the fulfilment of the requirements that apply to qualified trust service provider and to the relevant qualified trust services pursuant to Article 21 of Directive (EU) 2022/2555, and under the implementing acts that apply to that qualified trust service as adopted in accordance with of Article 21(5) of that Directive;  

16. contains a statement declaring, where applicable, the absence of any non-conformities, irrespective of their level of criticality; where any non-conformity is identified in the report, the report shall provide a plan of corrective actions and their timescale, provided by the qualified trust service provider and agreed by the conformity assessment body, together with the description of the planned evaluation tasks the conformity assessment body shall undertake to evaluate that those non-conformities have been corrected;  

17. contains, where appropriate and necessary, an indication of opportunities for improvement concerning the fulfilment by the qualified trust service provider and the qualified trust services it provides of relevant requirements;  

18. identify, for each stage of the conformity assessment, including documentation audit, implementation assessment and onsite inspections, the period in relation to which the assessment has been conducted and the time taken by the conformity assessment body in person-days to conduct the assessment;  

19. identify in the corresponding specific requirement report the detailed conformity assessment controls and control objectives that have been conducted during the assessment or include a reference to separately available assessment reports in which such information is included, provided that such separated assessment reports are:
    (a) issued by conformity assessment bodies accredited in accordance with Regulation (EU) No 910/2014  
    (b) endorsed by the conformity assessment bodies issuing the conformity assessment report  

20. include the scope, the description, and the results of a significant set of tests or production samples and their assessment for all relevant and applicable types of outputs from the assessed qualified trust services;  

21. indicate the following deadlines:
    (a) the deadline within which the next surveillance conformity assessment must be conducted  
    (b) the deadline within which the next conformity assessment must be conducted in accordance with Article 20(1) of Regulation (EU) No 910/2014  

22. contain an explicit declaration stating that the certification documents, including the conformity assessment report, are also intended for the use by the competent national supervisory body.  

---

# eIDAS - Annual reports by supervisory bodies
Source: https://docs.igrant.io/regulations/implementing-acts-annual-reports/

---
id: implementing-acts-annual-reports
title: eIDAS - Annual reports by supervisory bodies
description: Understand the EU Implementing Acts on annual reports by supervisory bodies on trust services and digital identity.
sidebar_label: Annual reports by supervisory bodies
keywords: [Implementing Acts, eIDAS, annual reports, supervisory bodies, trust services]
slug: /implementing-acts-annual-reports/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on annual reports by supervisory bodies on trust services and digital identity."/>
</head>

Commission Implementing **Regulation (EU) 2025/1571** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1571/oj).

### Article 1: Format and procedures of annual reports

1. Supervisory bodies shall submit their annual reports referred to in Article 46a(6) and Article 46b(6) of Regulation (EU) No 910/2014 to the Commission, through a secure electronic channel made available by the Commission.

2. Supervisory bodies shall submit the information in their annual reports only once, by re-using previously submitted information where appropriate.

3. Supervisory bodies for the European Digital Identity Wallets referred to in Article 46a(1) of Regulation (EU) No 910/2014 shall ensure that their annual reports include at least the information set out in Annex I to this Regulation.

4. Supervisory bodies for trust services referred to in Article 46b(1) of Regulation (EU) No 910/2014 shall ensure that their annual reports include at least the information set out in Annex II to this Regulation.

### Article 2: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 29 July 2025.

For the Commission

The President

Ursula VON DER LEYEN


---

# EUDI Wallet - Certification
Source: https://docs.igrant.io/regulations/implementing-acts-certification/

---
id: implementing-acts-certification
title: EUDI Wallet - Certification
description: Explore how the EU Implementing Act defines certification rules and requirements to ensure secure and compliant digital identity solutions for EUDI wallets.
sidebar_label: Certification
keywords: [Implementing Acts, EUDI Wallet, certification, national certification scheme, eIDAS 2.0, compliance]
slug: /implementing-acts-certification/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


Commission Implementing **Regulation (EU) 2024/2981**, adopted on 28 November 2024, establishes **certification requirements** for European Digital Identity Wallets under Regulation (EU) No 910/2014. This regulation defines the functional, cybersecurity, and data protection standards that wallets must meet to ensure secure and interoperable digital identity solutions across EU Member States. By setting these certification criteria, the regulation fosters trust and reliability within the European Digital Identity ecosystem, enabling seamless cross-border digital interactions for citizens and businesses.

An electronic edition of the regulation is available [here](https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=OJ:L_202402981).

## CHAPTER I - GENERAL PROVISIONS

### Article 1 - Subject matter and scope

This Regulation sets out reference standards and establishes specifications and procedures to build a robust framework for the certification of wallets to be updated on a regular basis to keep in line with technology and standards developments and with the work carried out on the basis of Recommendation (EU) 2021/946 on a common Union Toolbox for a coordinated approach towards a European Digital Identity Framework, and in particular the Architecture and Reference Framework.

### Article 2 - Definitions

For the purpose of this Regulation, the following definitions apply:

1. **‘wallet solution’** means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;

2. **‘scheme owner’** means an organisation which is responsible for developing and maintaining a certification scheme;

3. **‘object of certification’** means products, processes and services or a combination thereof to which specified requirements apply;

4. **‘wallet secure cryptographic application’** means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;

5. **‘wallet instance’** means the application installed and configured on a wallet user’s device or environment, which is part of a wallet unit, and that the wallet user uses to interact with the wallet unit;

6. **‘wallet secure cryptographic device’** means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;

7. **‘risk register’** means a record of information relevant to the certification process about identified risks;

8. **‘wallet provider’** means a natural or legal person who provides wallet solutions;

9. **‘certification body’** means a third-party conformity assessment body operating certification schemes;

10. **‘wallet unit’** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;

11. **‘critical assets’** means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;

12. **‘wallet user’** means a user who is in control of the wallet unit;

13. **‘incident’** means an incident as defined in point (6) of Article 6 of Directive (EU) 2022/2555 of the European Parliament and of the Council;

14. **‘embedded disclosure policy’** means a set of rules, embedded in an electronic attestation of attributes by its provider, that indicates the conditions that a wallet-relying party has to meet to access the electronic attestation of attributes.

## CHAPTER II - NATIONAL CERTIFICATION SCHEMES

### Article 3 - Establishment of national certification schemes

1. Member States shall assign a scheme owner for each national certification scheme.

2. The object of certification defined in national certification schemes shall be the provision and operation of wallet solutions and of the electronic identification schemes under which they are provided.

3. In accordance with Implementing Regulation (EU) 2015/1502, the object of certification in national certification schemes shall include the following elements:

   a. the software components, including settings and configurations of a wallet solution and of the electronic identification scheme under which the wallet solutions are provided;

   b. the hardware components and platforms on which the software components referred to in point (b) run on or rely upon for critical operations, in cases where they are provided directly or indirectly by the wallet solution and electronic identification scheme under which they are provided and when they are required to meet the desired level of assurance for those software components. When the hardware components and platforms are not provided by the wallet provider, national certification schemes shall formulate assumptions for evaluation of the hardware components and platforms, under which resistance against attackers with high attack potential in line with Implementing Regulation (EU) 2015/1502 can be provided, and specify the evaluation activities to confirm these assumptions as referred in Annex IV;

   c. the processes that support the provision and operation of a wallet solution, including the user onboarding process as referred to in Article 5a of Regulation (EU) No 910/2014, covering at least enrolment, electronic means management and organisation pursuant to section 2.1, 2.2, and 2.4 of Annex I to Implementing Regulation (EU) 2015/1502.

4. National certification schemes shall include a description of the specific architecture of the wallet solutions and of the electronic identification scheme under which they are provided. When national certification schemes cover more than one specific architecture, they shall include a profile for each specific architecture.

5. For each profile, national certification schemes shall set out at least the following:

   a. the specific architecture of a wallet solution and of the electronic identification scheme under which they are provided;

   b. the security controls associated to assurance levels set out in Article 8 of Regulation (EU) No 910/2014;

   c. an evaluation plan drawn-up in accordance with section 7.4.1 of EN ISO/IEC 17065;2012;

   d. the security requirements necessary to address the cybersecurity risks and threats listed in the risk register set out in Annex I of this Regulation, up to the required assurance level, and to meet, where applicable, the objectives defined in Article 51 of Regulation (EU) 2019/881;

   e. a mapping of the controls referred to in point (b) of this paragraph to the components of the architecture;

   f. a description of how the security controls, the mapping, the security requirements and the evaluation plan referred to in points (b) to (c) allow providers of wallet solutions and the electronic identification scheme under which they are provided to adequately address the cybersecurity risks and threats identified in the risk register referred to in point (d), up to the required assurance level based on a risk assessment to refine and complement the risks and threats listed in the risk register with risks and threats specific to the architecture.

6. The evaluation plan referred to in paragraph 5, point (c) shall list evaluation activities to be included in the evaluation of wallet solutions and of the electronic identification scheme under which they are provided.

7. The evaluation activity referred to in paragraph 6 shall require providers of wallet solutions and the electronic identification scheme under which they are provided to provide information meeting the requirements listed in Annex II.

### Article 4 - General requirements

1. National certification schemes shall cover functional, cybersecurity and data protection requirements by using, when available and applicable, the following certification schemes:

   a. European cybersecurity certification schemes established pursuant to Regulation (EU) 2019/881, including the EUCC;

   b. national cybersecurity certification schemes covered by the EUCC, in accordance with Article 49 of Implementing Regulation (EU) 2024/482.

2. National certification schemes may, in addition, when available and applicable, refer to:

   a. other relevant national certification schemes;

   b. international, European, and national standards;

   c. technical specifications that meet the requirements set out in Annex II to Regulation (EU) No 1025/2012 of the European Parliament and of the Council.

3. National certification schemes shall:

   a. specify the elements listed in section 6.5 of EN ISO/IEC 17067:2013;

   b. be implemented as a type 6 scheme, in accordance with section 5.3.8 of EN ISO/IEC 17067:2013.

4. National certification schemes shall comply with the following requirements:

   a. only providers referred to in Article 5a(2) of Regulation (EU) No 910/2014 are eligible to be issued certificates under the national certification schemes;

   b. only the Trust Mark is used as mark of conformity;

   c. providers of wallet solutions and the electronic identification scheme under which they are provided include references to Regulation (EU) No 910/2014 and this Regulation when referring to the scheme;

   d. providers of wallet solutions and the electronic identification scheme under which they are provided, complement the scheme’s risk assessment as referred to in Article 3, paragraph 5 point (f), to identify risks and threats specific to their implementation and propose appropriate treatment measures for all relevant risks and threats;

   e. responsibilities and the legal action are established and include references to the applicable national legislation, which defines the responsibilities and possible legal action, where certification under the scheme is being used fraudulently.

5. The assessment referred to in paragraph 4, point (d) shall be shared with the certification body for evaluation.

### Article 5 - Incident and vulnerability management

1. National certification schemes shall contain incident and vulnerability management requirements in accordance with paragraphs 2 to 9.

2. The holder of a certificate of conformity of a wallet solution and of the electronic identification scheme under which it is provided shall notify their certification body without undue delay of any breach or compromise of the wallet solution, or of the electronic identification scheme under which it is provided, that is likely to impact its conformity with the requirements of the national certification schemes’ requirements.

3. The holder of a certificate of conformity shall establish, maintain and operate a vulnerability management policy and procedures, taking into account the procedures set out in existing European and international standards, including EN ISO/IEC 30111:2019.

4. The holder of the certificate of conformity shall notify the issuing certification body of the vulnerabilities and changes affecting the wallet solution, based on defined criteria on the impact of these vulnerabilities and changes.

5. The holder of the certificate of conformity shall prepare a vulnerability impact analysis report for any vulnerability that affects the software components of the wallet solution. The report shall include the following information:

   a. the impact of the vulnerability on the certified wallet solution;

   b. possible risks associated with the proximity or likelihood of an attack;

   c. whether the vulnerability can be remedied using available means;

   d. where the vulnerability can be remedied using available means, possible ways to remedy the vulnerability.

6. Where notification is required in paragraph 4, the holder of the certificate of conformity shall transmit, without undue delay, the vulnerability impact analysis report referred to in paragraph 5 to the certification body.

7. The holder of a certificate of conformity shall establish, maintain and operate a vulnerability management policy meeting the requirements set out in Annex I to the Cyber Resilience Act.

8. National certification schemes shall establish vulnerability disclosure requirements applicable to certification bodies.

9. The holder of a certificate of conformity shall disclose and register any publicly known and remediated vulnerability in the wallet solution or in one of the online repositories referred to in Annex V.

### Article 6 - Maintenance of national certification schemes

1. National certification schemes shall contain a process for reviewing their operation on a periodic basis. That process shall aim at confirming their adequacy and at identifying aspects requiring improvement, taking into account feedback from stakeholders.

2. National certification schemes shall include provisions concerning their maintenance. This process shall include at least the following requirements:

   a. rules for the governance of the national certification schemes’ definition and requirements;

   b. the establishment of timelines for the issuance of certificates following the adoption of updated versions of the national certification schemes, both for new certificates of conformity and for previously issued ones;

   c. a periodic review of the national certification schemes, to ensure that the national certification schemes' requirements are being applied in a consistent manner, taking into account at least the following aspects:
      - requests for clarification addressed to the scheme owner related to the national certification scheme requirements;

      - feedback from stakeholders and other interested parties;

      - responsiveness of the national certification scheme owner to requests of information.

   d. rules for monitoring reference documents and procedures for the evolution of national certification schemes’ reference versions, including at least transition periods;

   e. a process to ensure the latest cybersecurity risks and threats as listed in the risk register set out in Annex I of this Regulation are covered;

   f. a process for managing other changes in national certification schemes.

3. National certification schemes shall contain requirements for performing evaluations on currently certified products within a certain period after the revision of the scheme, or after the release of new specifications or standards, or new versions thereof, with which the wallet solutions and the electronic identification scheme under which they are provided shall comply.

## CHAPTER III - REQUIREMENTS RELATING TO SCHEME OWNERS

### Article 7 - General requirements

1. Scheme owners shall develop and maintain national certification schemes and govern their operations.

2. Scheme owners may subcontract all or part of their tasks to a third party. When subcontracting to a private party, scheme owners shall set out the duties and responsibilities of all parties by contract. Scheme owners shall remain responsible for all subcontracted activities performed by their subcontractors.

3. Scheme owners shall perform their monitoring activities, if applicable, at least on the basis of the following information:

   a. information coming from certification bodies, national accreditation bodies, and relevant market surveillance authorities;

   b. information resulting from its own or another authority's audits and investigations;

   c. complaints and appeals received pursuant to Article 15.

4. Scheme owners shall inform the Cooperation Group of revisions to the national certification schemes. That notification shall provide adequate information for the Cooperation Group to issue recommendations to scheme owners and opinions about the updated national certification schemes.

## CHAPTER IV - REQUIREMENTS RELATING TO PROVIDERS OF WALLET SOLUTIONS AND THE ELECTRONIC IDENTIFICATION SCHEME UNDER WHICH THEY ARE PROVIDED

### Article 8 - General requirements

1. National certification schemes shall contain cybersecurity requirements based on a risk assessment of each specific supported architecture. Those cybersecurity requirements shall aim to treat the identified cybersecurity risks and threats, as established in the risk register set out in Annex I.

2. In line with Article 5a(23) of Regulation (EU) No 910/2014, national certification schemes shall require wallet solutions, and the electronic identification schemes under which they are provided, to be resistant against attackers with high attack potential for assurance level high, as referred to Implementing Regulation (EU) 2015/1502.

3. National certification schemes shall establish security criteria, which shall include the following requirements:

   a. Cyber Resilience Act where applicable, or requirements meeting the security objectives set out in Article 51 of Regulation (EU) 2019/881;

   b. the establishment and implementation of policies and procedures concerning the management of risks associated with the operation of a wallet solution, including the identification and assessment of risks and the mitigation of the identified risks;

   c. the establishment and implementation of policies and procedures related to the management of changes and to the management of vulnerabilities in accordance with Article 5 of this Regulation;

   d. the establishment and implementation of human resource management policies and procedures, including requirements on expertise, reliability, experience, security training, and qualifications of personnel involved in the development or operation of the wallet solution;

   e. requirements relating to the wallet solution’s operating environment, including in the form of assumptions on the security of the devices and platforms on which the software components of the wallet solution run, including WSCDs and where applicable and relevant, conformity assessment requirements to confirm that those assumptions are verified on the relevant devices and platforms;

   f. for each assumption that is not backed by a certificate of conformity or other acceptable assurance information, a description of the mechanism that the wallet provider uses to enforce the assumption, as well as a justification that the mechanism is sufficient to ensure that the assumption is verified;

   g. the establishment and implementation of measures to ensure the use of a currently certified version of the wallet solution.

4. National certification schemes shall contain functional requirements relating to update mechanisms for every software component of the wallet solutions and the electronic identification scheme under which they are provided for the operations listed in Annex III.

5. National certification schemes shall require that the following information and documentation is provided or otherwise made available to the certification body by the applicant for certification:

   a. evidence related to the information referred to in Annex IV, point 1, including where necessary details on the wallet solution and its source code, including:
   
      - *architecture information:* for every component of the wallet solution (including product, process and service components), a description of its essential security properties, including its external dependencies;

      - *controls and assurance levels:* for every security control of the wallet solution, a description of the control and the required assurance level, based on the Annex to Implementing Regulation (EU) 2015/1502, which sets out a number of technical specifications and procedures that apply to the various controls implemented by the electronic identification means;
      
      - *mapping the controls to architecture components:* a description of how the controls of the wallet are implemented using the different components of the wallet solution, based on a rationale explaining why a given assurance level is required, and how the control is implemented with all required security aspects at the appropriate level;
      
      - *rationale and justification of risk coverage:* a justification of:

         - the mapping of controls to components;

         - the suitability of the proposed evaluation plan to appropriately cover all controls;

         - the coverage provided by the controls of the cybersecurity risks and threats identified in the risk register, complemented by controls of risks and threats specific to the implementation, at the appropriate assurance level;

   b. the information listed in Annex V;

   c. a complete list of the certificates of conformity and other assurance information used as evidence during the evaluation activities;

   d. any other information relevant for the evaluation activities.

## CHAPTER V - REQUIREMENTS RELATING TO CERTIFICATION BODIES

### Article 9 - General requirements

1. Certification bodies shall be accredited by national accreditation bodies appointed pursuant to Regulation (EC) No 765/2008 of the European Parliament and of the Council in accordance with EN ISO/IEC 17065:2012, provided that they comply with the requirements set out in national certification schemes in accordance with paragraph 2.

2. For the purposes of accreditation, certification bodies shall comply with all the following competence requirements:

   a. detailed and technical knowledge of the relevant architectures of a wallet solution and of the electronic identification scheme under which they are provided, as well as of the threats and risks relevant to those architectures;

   b. knowledge of available security solutions and of their properties pursuant to the Annex of Implementing Regulation (EU) 2015/1502;

   c. knowledge of the activities performed in virtue of certificates of conformity applied to components of the wallet solution and the electronic identification scheme under which they are provided, as being the object of certification;

   d. detailed knowledge of the applicable national certification scheme as established in accordance with Chapter II.

3. Certification bodies shall perform their surveillance activities in particular on the basis of the following information:

   a. information coming from national accreditation bodies, and relevant market surveillance authorities;

   b. information resulting from their own or another authority’s audits and investigations;

   c. complaints and appeals received pursuant to Article 15.

### Article 10 - Subcontracting

Certification bodies may subcontract the evaluation activities, as set out in Article 13, to third parties. Where evaluation activities are subcontracted, national certification schemes shall establish the following:

1. all subcontractors of the certification body performing evaluation activities shall, as applicable and appropriate for the activities to be performed, meet the requirements of harmonised standards like EN ISO/IEC 17025:2017 for testing, EN ISO/IEC 17020:2012 for inspection, EN ISO/IEC 17021-1:2015 for audit, and EN ISO/IEC 17029:2019 for validation and verification;

2. certification bodies shall take responsibility for all evaluation activities outsourced to other bodies and demonstrate that they have taken appropriate measures during their accreditation, including by relying on their subcontractors’ own accreditation, when applicable;

3. the degree to which prior agreement to outsourcing needs shall be obtained from scheme owners or the client whose wallet solution is being certified under the certification scheme.

### Article 11 - Notification to the supervisory body

Certification bodies shall notify the supervisory body referred to in Article 46a(1) of Regulation (EU) No 910/2014 of the issuance, suspension and cancellation of certificates of conformity of wallet solutions and the electronic identification scheme under which they are provided.

### Article 12 - Incident and vulnerability management

1. Certification bodies shall suspend, without undue delay, the certificate of conformity of the wallet solutions and the electronic identification scheme under which they are provided after they confirm that the notified security breach or compromise impacts the conformity with the national certification schemes’ requirements, of the wallet solution or of the electronic identification scheme under which they are provided.

2. Certification bodies shall cancel the certificate of conformity that has been suspended following a security breach or compromise that has not been remedied in a timely manner.

3. Certification bodies shall cancel certificates of conformity where an identified vulnerability has not been remedied commensurately with its severity and potential impact in a timely manner, in accordance with Articles 5c(4) and 5e(2) of Regulation (EU) No 910/2014.

## CHAPTER VI - CONFORMITY ASSESSMENT ACTIVITIES

### Article 13 - Evaluation activities

1. National certification schemes shall contain methods and procedures to be used by the conformity assessment bodies when conducting their evaluation activities in accordance with EN ISO/IEC 17065:2012, which shall cover at least the following aspects:

   a. the methods and procedures to conduct evaluation activities, including those related to WSCD, as set out in Annex IV;

   b. the audit of the implementation of the wallet solution and the electronic identification scheme under which they are provided, based on the risk register, set out in Annex I and complemented where necessary by implementation-specific risks;

   c. functional testing activities, based, when available and appropriate, on test suites that are defined according to technical specifications or standards;

   d. assessment of the existence and suitability of maintenance processes, including at least version management, update management and vulnerability management;

   e. assessment of the operating effectiveness of the maintenance processes, including at least version management, update management and vulnerability management;

   f. dependency analysis provided by the wallet provider, including a methodology to assess the acceptability of assurance information, which shall include the elements set out in Annex VI;

   g. vulnerability assessment, at the appropriate level, including:
   
      - a review of the design of the wallet solution, and where applicable, of its source code;

      - testing of the resistance of the wallet solution against attackers with high attack potential for assurance level ‘high’ pursuant to Section 2.2.1 of the Annex to Implementing Regulation (EU) 2015/1502;

   h. assessment of the evolution of the threat environment and its impact on the coverage of the risks by the wallet solution, to determine which evaluation activities are required on the various components of the wallet solution.

2. National certification schemes shall contain an evaluation to determine whether the implementation of wallet solutions and the electronic identification scheme under which those wallet solutions are provided match the architecture set out in Article 3 paragraph 5, point (a), as well as an evaluation to determine whether the evaluation plan proposed together with the implementation matches the evaluation plan referred to in Article 3 paragraph 5, point (c).

3. National certification schemes shall set out sampling rules, in order to avoid the repetition of identical evaluation activities and to focus on activities that are specific to a given variant. Those sampling rules shall allow functional and security tests to be performed only on a sample of variants of a target component of a wallet solution and the electronic identification scheme under which they a provided and on a sample of target devices. National certification schemes shall require all certification bodies to justify their use of sampling.

4. National certification schemes shall require the evaluation, by the certification body, of the WSCA based on the methods and procedures set out in Annex IV.

### Article 14 - Certification activities

1. National certification schemes shall set out an attestation activity for the purpose of issuing a certificate of conformity, in accordance with section V(a) of EN ISO/IEC 17067:2013, Table 1, including the following aspects:

   a. the content of the certificate of conformity as set out in Annex VII;

   b. how the results of the evaluation are to be reported in the public certification report, including at least a summary of the preliminary audit and validation plan, as set out in Annex VIII;

   c. the content of the evaluation results reported in the certification assessment report, including the elements set out in Annex VIII.

2. The certification assessment report may be made available to the Cooperation Group and to the Commission.

### Article 15 - Complaints and appeals

National certification schemes shall contain procedures or references to the applicable national legislation, which define the mechanism to effectively lodge and handle complaints and appeals in relation to their implementation of the certification scheme or to a certificate of conformity issued. These procedures shall include the provision of information to the complainant of the progress of the proceedings and on the decision taken, and information to the complainant on the right to an effective judicial remedy. National certification schemes shall require that all complaints and appeals that have not been or cannot be resolved by the certification body are sent to the scheme owner for assessment and resolution.

### Article 16 - Surveillance activities

1. National certification schemes shall require certification bodies to implement surveillance activities consisting of surveillance evaluation of processes combined with random tests or inspections.

2. National certification schemes shall contain requirements for scheme owners to monitor the compliance of certification bodies with their obligations pursuant to Regulation (EU) No 910/2014 and pursuant to national certification schemes, if applicable.

3. National certification schemes shall contain requirements for certification bodies to monitor the following:

   a. compliance by holders of a certificate of conformity issued under national certification schemes with their obligations concerning certification pursuant to Regulation (EU) No 910/2014 and pursuant to national certification schemes;

   b. compliance of the certified wallet solution with the requirements set out in national certification schemes.

### Article 17 - Consequences of non-compliance

National certification schemes shall set out the consequences of non-conformity of a certified wallet solution and of the electronic identification scheme under which they are provided, with the requirements set out in this Regulation. Those consequences shall include the following aspects:

1. the obligation on the certification body to inform the holder of the certificate of conformity and to request the holder of the certificate of conformity to apply remedial actions;

2. the obligation on the certification body to inform other relevant market surveillance authorities where the non-conformity concerns relevant Union legislation;

3. the conditions for carrying out remedial actions by the holder of the certificate of conformity;

4. the conditions for the suspension of a certificate of conformity by the certification body and for restoration of the certificate of conformity after the non-conformity has been remediated;

5. the conditions for cancellation of a certificate of conformity by the certification body;

6. the consequences of non-compliance by the certification body with the requirements of the national certification scheme.

## CHAPTER VII - CERTIFICATION LIFECYCLE

### Article 18 - Certification lifecycle

1. The validity of certificates of conformity issued under national certification schemes shall be subject to regular evaluation activities by the certification body carried out in accordance with the requirements set out in Annex IX.

2. National certification schemes shall contain a process for the recertification of wallet solutions and the electronic identification scheme under which they are provided, upon request of the holder of the certificate of conformity before the expiry of the initial certificate of conformity. That process for recertification shall include a full evaluation of the wallet solution and of the electronic identification scheme under which they are provided, including a vulnerability assessment, following the principles set out in Annex IX.

3. National certification schemes shall contain a process for managing changes in a certified wallet solution and the electronic identification scheme under which they are provided. That process shall include rules for determining whether a change is to be covered by a special evaluation as referred to in paragraph 4 or by the verification of the operating effectiveness of the maintenance processes as referred to Annex IV.

4. National certification schemes shall contain a process for special evaluations in accordance with EN ISO/IEC 17065:2012. That process for special evaluations shall include a selection of activities to be performed to address the specific issue that triggered the special evaluation.

5. National certification schemes shall set out rules related to the cancellation of a certificate of conformity.

## CHAPTER VIII - RECORDKEEPING AND PROTECTION OF INFORMATION

### Article 19 - Retention of records

1. National certification schemes shall contain requirements for certification bodies concerning a record system for all relevant information produced in connection with the conformity assessment activities that they perform, including data issued and received by providers of wallet solutions and the electronic identification schemes under which they are provided. The records of such information shall be stored in a secure manner. The records may be kept electronically and shall remain accessible for as long as required by Union law or national law, and for at least five years, after the cancellation or expiry of the relevant certificate of conformity.

2. National certification schemes shall set out requirements for the holder of the certificate of conformity to store the following information securely for the purpose of this Regulation, and for at least five years after the cancellation or expiry of the relevant certificate of conformity:

   a. records of the information provided to the certification body or any of its sub-contractors during the certification process;

   b. specimens of hardware components that have been included in the scope of certification for the wallet solution.

3. National certification schemes shall require the holder of the certificate of conformity to make the information referred to in paragraph 1 available to the certification body or the supervisory body referred to in Article 46a(1) of Regulation (EU) No 910/2014 upon request.

### Article 20 - Protection of information

Under national certification schemes, all persons or organisations that are granted access to information in the execution of activities under the national certification scheme shall be required to ensure the security and protection of trade secrets and other confidential information, as well as preserving intellectual property rights, and take the necessary and appropriate technical and organisational measures to ensure this confidentiality.

## CHAPTER IX - FINAL PROVISIONS

### Article 21 - Transition to a European cybersecurity certification scheme

This Regulation shall be subject to review, on the adoption of the first European cybersecurity certification scheme for wallet solutions and the electronic identification schemes under which they are provided, with the objective of taking into account the contribution of such a European cybersecurity certification scheme to the overall certification of wallet solutions and the electronic identification schemes under which they are provided.

### Article 22 - Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 28 November 2024.

For the Commission

The President

Ursula VON DER LEYEN

---

# eIDAS - Certified creation devices
Source: https://docs.igrant.io/regulations/implementing-acts-certified-creation-devices/

---
id: implementing-acts-certified-creation-devices
title: eIDAS - Certified creation devices
description: Understand the EU Implementing Acts on notification of certified qualified electronic signature and seal creation devices.
sidebar_label: Certified creation devices
keywords: [Implementing Acts, eIDAS, certified creation devices, electronic signatures, electronic seals, notification]
slug: /implementing-acts-certified-creation-devices/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on notification of certified qualified electronic signature and seal creation devices."/>
</head>

Commission Implementing **Regulation (EU) 2025/1570** of 29 July 2025 lays down rules for the application of Regulation (EU) No 910/2014 as regards notification of information on certified qualified electronic signature creation devices and certified qualified electronic seal creation devices.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1570/oj).

### Article 1: Notification requirements

1. The notification referred to in Article 31(1) of Regulation (EU) No 910/2014 shall contain at least the information set out in the Annex to this Regulation and shall be made in electronic form through a secure electronic channel made available by the Commission.

2. Where there are any changes to the submitted information after the initial submission, including changes to the certification status of qualified electronic signature creation devices and qualified electronic seal creation devices, Member States shall submit the updated information with the relevant accompanying documents through the channel referred to in paragraph 1.

### Article 2: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

This Regulation shall apply from 19 December 2025.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 29 July 2025.

For the Commission

The President

Ursula VON DER LEYEN

## ANNEX

### Information to be notified by Member States in accordance with Article 31(1)

1. The identification of the qualified electronic signature creation device or qualified electronic seal creation device, as covered by the certification or certification cancellation notification and specified through the following elements:

   (a) product name;

   (b) reference to the configured software component, including the relevant version;

   (c) reference to the configured hardware component, including the relevant version;

   (d) version;

2. The identity of the body that applied for certification;

3. The description of the qualified electronic signature creation device or qualified electronic seal creation device, including:

   (a) whether it is a qualified electronic signature creation device or/and a qualified electronic seal creation device;

   (b) which of the following categories the device belongs to:
   - devices where the electronic signature creation data or electronic seal creation data is held in an entirely (but not necessarily exclusively) user-managed environment;
   - devices where a qualified trust service provider manages the electronic signature creation data or electronic seal creation data on behalf of a signatory or of a creator of a seal;

4. The certificate of conformity of the device with the requirements of Annex II to Regulation (EU) No 910/2014;

5. A reference to the certification report issued in accordance with Article 30 of Regulation (EU) No 910/2014 that shall not change at least for the validity period of the certificate of conformity;

6. The identity of the issuer of the certification report, including appropriate reference to its qualification as a certification body designated by a Member State in accordance with Article 30(1) of Regulation (EU) No 910/2014 and as compliant for the certification of those devices in accordance with Article 30(3) of that Regulation;

7. A uniform resource locator ('URL') of a location from where the certification report is publicly available free of charge;

8. The effective starting date of certification;

9. The certification status;

10. The expiry date of certification;

11. Whether certification is planned not to be continued after the current certification for the current configuration of the qualified electronic signature creation devices or qualified electronic seal creation devices;

12. Contact details of the designated body;

13. Whether the certification method is in accordance with Article 30(3), first subparagraph, point (a) or point (b) of Regulation (EU) No 910/2014, and as applicable, the reference and URL to the alternative procedures that have been notified to the Commission pursuant to Article 30(3), first subparagraph, point (b), of that Regulation;

14. All related certification reports established in accordance with the implementing acts adopted pursuant to Article 30(3), second subparagraph of Regulation (EU) No 910/2014 including:

   (a) a reference to each certification report;

   (b) the identification of the issuer of each certification report;

   (c) a URL to a location from where each certification report is publicly available free of charge;

   (d) the issuance date of each certification report;

   (e) where publicly available, a version of the corresponding security target document describing the device, or any component thereof, being targeted by the certification evaluation covered by the certification report.


---

# EUDI Wallet - Cross-border identity matching
Source: https://docs.igrant.io/regulations/implementing-acts-cross-border-identity/

---
id: implementing-acts-cross-border-identity
title: EUDI Wallet - Cross-border identity matching
description: Understand the EU Implementing Acts on cross-border identity matching for EU Digital Identity Wallets.
sidebar_label: Cross-border identity matching
keywords: [Implementing Acts, EUDI Wallet, cross-border, identity matching, Member States, eIDAS 2.0]
slug: /implementing-acts-cross-border-identity/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on cross-border identity matching for EU Digital Identity Wallets."/>
</head>

Commission Implementing **Regulation (EU) 2025/846** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/846/oj).


### Article 1: Subject matter  

This Regulation lays down rules for cross-border identity matching of natural persons by public sector bodies or by bodies acting on behalf of a public sector body, to be updated on a regular basis to keep in line with technology and standards developments and with the work carried out on the basis of Recommendation (EU) 2021/946, and in particular the Architecture and Reference Framework.  

### Article 2: General requirements  

1. Where a public sector body acts as a relying party in the context of an online cross-border service offered by or on behalf of that public sector body, Member States shall ensure that the process set out in paragraph 2 is used to ensure unequivocal identity matching of natural persons.  

2. Unequivocal identity matching shall be done by, or on behalf of, the relying party, or a register relied upon by relying parties, or a centralised system, by requesting, as applicable, receiving, and validating the authenticity of the information listed in paragraphs 3 or 4.  

3. When reliance is on a wallet, the information to be used for unequivocal identity matching shall be the mandatory person identification data set out in Section 1 of the Annex to Implementing Regulation (EU) 2024/2977, together with any optional data that is needed to ensure that the presented dataset is unique including, where appropriate, additional information or complementary procedures.  

4. When reliance is on a notified electronic identification scheme, the information to be used for unequivocal identity matching shall be the mandatory attributes of the minimum data set for a natural person set out in Section 1 of the Annex to Implementing Regulation (EU) 2015/1501 including, where appropriate, any additional information or complementary procedures.  

5. When determining whether there is an unequivocal identity match, the relying party, or the party acting on its behalf, shall match the information provided by the user to those the relying party or a party acting on its behalf or a register relied upon by relying parties that has already registered.  

6. The outcome of the process described in paragraph 5 shall, to the extent possible, not be affected by differences in transliteration, blank spaces, hyphenation, concatenation, and similar orthographic variations that are required under Union law or national law of the Member State.  

7. Where the match is exact for the information referred to in paragraph 2 and relates to only one natural person or the outcome of the process leads to a new registration of the user that is equivalent in its function to a successful identity matching process, the identity matching process shall be deemed successful resulting in an unequivocal identity match. Where the match is not exact or relates to more than one natural person, or the party performing the identity matching cannot guarantee that the match is unequivocal, the identity matching process shall be deemed unsuccessful.  

8. Member States may rely on centralised identity matching systems, operated by a public sector body established in that Member State, to ensure that notified electronic identification means or wallets from another Member State can be matched with existing registrations and records using online procedures.  

9. Where Member States enable wallet-relying parties which are not public sector bodies to perform identity matching the mechanisms and procedures laid down in this Regulation shall apply, where applicable.  

### Article 3: Obligations of relying parties where the identity matching process is successful  

1. The first time a user performs the identity matching process and it is deemed successful pursuant to Article 2(7), the relying party or the party acting on its behalf, or a register relied upon by relying parties or the centralised system shall ensure that the user is informed of the fact that the user has been granted access to the service to which that they requested access to.  

2. Where applicable, the user shall also be informed if he or she:  

   (a) has been registered as a new user;  

   (b) has been successfully matched to a single existing user of the relying party or;  

   (c) has been successfully matched to a single existing user in a register relied upon by the relying party or the party acting on its behalf;  

   (d) can reuse completed identity matching processes in the future by choosing one of the following options including the retention time:  

   - storage of an association in a register operated by the relying party or in a register relied upon by the relying party that can be reused in future access requests;  

   - issuance of a dedicated electronic attestation of attributes containing an association that can be reused in future access requests;  

   - alternative options provided by the relying party or the party acting on behalf of the relying party or the centralised system that can be reused in future access requests.  

### Article 4: Obligations of relying parties where the identity matching process is not successful  

1. Where an identity matching process is deemed unsuccessful pursuant to Article 2(7), the relying party or the party acting on its behalf or the centralised system shall ensure that the user of a notified electronic identification means or of a wallet is informed if:  

   (a) the data made available was not successfully and unequivocally matched to any existing user of the relying party or in a register relied upon by the relying party or the party acting on its behalf;  

   (b) other options for identity matching available to the user or other methods for gaining access to the service are available.  

2. The options or other methods referred to in paragraph 1, point (b) may include:  

   (a) a different notified electronic identification means or a different wallet;  

   (b) an update of information already registered with the relying party, the party acting on its behalf or a register relied upon by the relying party or the centralised identity matching system;  

   (c) additional information provided by the relying party or a party acting on their behalf for identity matching or the centralised system.  

3. Where the complementary methods result in a successful and unequivocal match or registration, the outcome shall follow the obligations set out in Article 3.  

4. Where the relying party or the centralised system determines either initially or after unsuccessfully performing the complementary identity matching processes that the user has not previously been registered, the relying party or the centralised system may consider this user as a new user and where applicable, register the user in accordance with national law or administrative practices.  

5. Where the complementary methods do not result in a successful and unequivocal match, the party performing the identity matching may assess if the user has no prior interaction or interactions with the relying party or a register relied upon by the relying party and therefore shall be considered as a new user.  

6. Where there is a new user relying parties shall apply the process set out in Article 3. Relying parties may register new users in accordance with national law or administrative practices.  

### Article 5: Obligations of relying parties following the completion of the identity matching process  

1. Where an identity matching process as set out in Article 2 is completed, whether successfully or unsuccessfully, the relying party or the party acting on its behalf or the register relied upon by the relying party shall keep the logs relating to the identity matching process and its outcome, including where available, the following:  

   (a) the values provided by the user and the relying party that is used to perform the identity matching process;  

   (b) the date and time of the identity matching process;  

   (c) any relevant documentation provided as part of the complementary methods referred to in Article 4(1) and (2) necessary for dispute handling;  

   (d) where applicable, any identifiers or account numbers used by the relying party, or a register relied upon by relying parties, or the party acting on its behalf, or the centralised identity matching system that relates to the natural person.  

2. Relying parties or the parties acting on their behalf, shall consider security and privacy by design principles related to the logging of the information included in paragraph 1.  

3. Relying parties or the parties acting on their behalf, shall retain the logs for a minimum of 6 months and a maximum of 12 months for security purposes. For other purposes, including enabling the registration and processing of user complaints, the retention time may be extended if required by Union or national law.  

### Article 6: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

It shall apply from 24 December 2026.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 6 May 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

---

# eIDAS - Formats of advanced electronic signatures and seals
Source: https://docs.igrant.io/regulations/implementing-acts-formats-signatures-seals/

---
id: implementing-acts-formats-signatures-seals
title: eIDAS - Formats of advanced electronic signatures and seals
description: Understand the EU Implementing Acts on formats for advanced electronic signatures and seals under eIDAS.
sidebar_label: Formats of advanced electronic signatures and seals
keywords: [Implementing Acts, eIDAS, advanced electronic signatures, electronic seals, formats]
slug: /implementing-acts-formats-signatures-seals/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on formats for advanced electronic signatures and seals under eIDAS."/>
</head>

Commission Implementing **Regulation (EU) 2026/248** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2026/248/oj).

### Article 1: Advanced electronic signature formats

1. Member States requiring an advanced electronic signature or an advanced electronic signature based on a qualified certificate in accordance with Article 27(1) and (2) of Regulation (EU) No 910/2014, shall recognise advanced electronic signatures, using formats or associated signature containers, that comply with the technical specifications listed in Annex I to this Regulation.

2. Member States shall recognise advanced electronic signatures, using formats or associated signature containers, that comply with the technical specifications listed in Annex II to this Regulation, where those electronic signatures were created before 23 February 2028.

### Article 2: Alternative advanced electronic signature validation methods

1. Member States requiring an advanced electronic signature or an advanced electronic signature based on a qualified certificate in accordance with Article 27(1) and (2) of Regulation (EU) No 910/2014, shall recognise formats of advanced electronic signatures other than those referred to in Article 1 of this Regulation, where:

   (a) the Member State, in which the trust service provider used by the signatory is established, offers other Member States signature validation methods for those formats; and

   (b) those validation methods shall be carried out in accordance with paragraph 2.

2. The validation methods for alternative signature formats shall fulfil all the following conditions:

   (a) be, where possible, suitable for automated processing;

   (b) allow other Member States to validate the received electronic signature online, free of charge;

   (c) provide clear, comprehensive, easily understandable and accessible instructions to perform the validation;

   (d) be indicated in the signed document, in the electronic signature or in the electronic document container;

   (e) confirm the validity of an advanced electronic signature provided that:

   - the certificate supporting the advanced electronic signature was valid at the time of signing,
   - where the advanced electronic signature is supported by a qualified certificate, the qualified certificate supporting the advanced electronic signature was, at the time of signing, a qualified certificate for electronic signature in compliance with Annex I to Regulation (EU) No 910/2014 and issued by a qualified trust service provider,
   - the signature validation data corresponds to the data provided to the relying party,
   - the unique set of data representing the signatory is correctly provided to the relying party,
   - if a pseudonym was used at the time of signing, the use of any pseudonym is clearly indicated to the relying party,
   - where the advanced electronic signature is created by a qualified electronic signature creation device, the use of any such device is clearly indicated to the relying party,
   - the integrity of the signed data has not been compromised,
   - the requirements set out in Article 26 of Regulation (EU) No 910/2014 were met at the time of signing,
   - the system used for validating the advanced electronic signature provides to the relying party the correct result of the validation process and allows the relying party to detect any security relevant issues.

3. The indication referred to in paragraph 2, point (d) shall enable relying parties to easily access the complete specifications of the signature validation method, free of charge.

### Article 3: Advanced electronic seal formats

1. Member States requiring an advanced electronic seal or an advanced electronic seal based on a qualified certificate in accordance with Article 37(1) and (2) of Regulation (EU) No 910/2014, shall recognise advanced electronic seals, using formats or using associated seal containers, that comply with the technical specifications listed in Annex I to this Regulation.

2. Member States shall recognise advanced electronic seals, using formats or using associated seal containers, that comply with the technical specifications listed in Annex II to this Regulation, where those electronic seals were created before 23 February 2028.

### Article 4: Alternative advanced electronic seal validation methods

1. Member States requiring an advanced electronic seal or an advanced electronic seal based on a qualified certificate in accordance with Article 37(1) and (2) of Regulation (EU) No 910/2014, shall recognise formats of advanced electronic seals other than those referred to in Article 3 of this Regulation, where:

   (a) the Member State in which the trust service provider used by the creator of the seal is established offers other Member States seal validation methods for those formats; and

   (b) those validation methods shall be carried out in accordance with paragraph 2.

2. The validation methods for alternative seal formats shall fulfil all the following conditions:

   (a) be, where possible, suitable for automated processing;

   (b) allow other Member States to validate the received electronic seal online, free of charge;

   (c) provide clear, comprehensive, easily understandable and accessible instructions to perform the validation;

   (d) be indicated in the sealed document, in the electronic seal or in the electronic document container; and

   (e) confirm the validity of an advanced electronic seal provided that:

   - the certificate that supports the advanced electronic seal was valid at the time of sealing,
   - where the advanced electronic seal is supported by a qualified certificate, the qualified certificate that supports the advanced electronic seal was, at the time of sealing, a qualified certificate for electronic seal in compliance with Annex III to Regulation (EU) No 910/2014 and issued by a qualified trust service provider,
   - the seal validation data corresponds to the data provided to the relying party,
   - the unique set of data representing the creator of the seal is correctly provided to the relying party,
   - if a pseudonym was used at the time of sealing, the use of any pseudonym is clearly indicated to the relying party,
   - where the advanced electronic seal is created by a qualified electronic seal creation device, the use of any such device is clearly indicated to the relying party,
   - the integrity of the sealed data has not been compromised,
   - the requirements set out in Article 36 of Regulation (EU) No 910/2014 were met at the time of sealing, and
   - the system used for validating the advanced electronic seal provides to the relying party the correct result of the validation process and allows the relying party to detect any security relevant issues.

3. The indication referred to in paragraph 2, point (d) shall enable relying parties to easily access the complete specifications of the seal validation method, free of charge.

### Article 5: Repeal

Implementing Decision (EU) 2015/1506 is repealed. References to the repealed Decision shall be construed as references to this Regulation.

### Article 6: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

Article 1(1) and Article 3(1) shall apply from 23 February 2027.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 2 February 2026.

For the Commission

The President

Ursula VON DER LEYEN


---

# EUDI Wallet - Identity and qualified certificates
Source: https://docs.igrant.io/regulations/implementing-acts-identity-qualified-certificates/

---
id: implementing-acts-identity-qualified-certificates
title: EUDI Wallet - Identity and qualified certificates
description: Learn about the EU Implementing Acts on identity verification and qualified certificates for EU Digital Identity Wallets.
sidebar_label: Identity and qualified certificates
keywords: [Implementing Acts, EUDI Wallet, identity verification, qualified certificates, authentication, eIDAS 2.0]
slug: /implementing-acts-identity-qualified-certificates/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on identity verification and qualified certificates for EU Digital Identity Wallets."/>
</head>

Commission Implementing **Regulation (EU) 2025/1566** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1566/oj).


### Article 1  

The reference standards and specifications referred to in Article 24(1c) of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.  

### Article 2  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall apply from 19 August 2027.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 July 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX - Reference standard for the verification of the identity and attributes of persons to whom a qualified certificate or qualified electronic attestation of attributes is to be issued  

The standard ETSI TS 119 461 V2.1.1 (2025-02) for conformance with Annex C clause C.3 applies, with the following adaptations:  

   1. 2.1 Normative references; [1] ETSI EN 319 401 V3.1.1 (2024-06): 'Electronic Signatures and Trust Infrastructures (ESI); General Policy Requirements for Trust Service Providers'.  

   2. C.3 Use cases for issuance of qualified certificate or qualified electronic attestations of attributes in accordance with Article 24(1), (1a) and (1b) of Regulation (EU) No 910/2014; [CONDITIONAL] QTS-C3-01: If identity verification for qualified certificate or a qualified electronic attestation is done in conjunction with identity verification to issue authoritative evidence, that identity verification process shall:
      - have been peer reviewed or certified by an accredited conformity assessment body to comply with assurance level high in accordance with Regulation (EU) No 910/2014, or
      - comply with the requirements set out in clauses C3.1 to C3.6.

   3. C.3.4 Use case for identity proofing by other identification means; QTS-C.3.4-06A: The independent conformity assessment body referred to in [CONDITIONAL] QTS-C.3.4-06, point c) shall be accredited as per Article 3 (18) of Regulation (EU) No 910/2014, and, if all applicable requirements are fulfilled, the assessment should result in a certificate of compliance based on a certification audit. This formal certification process shall be based on a security evaluation process that refers to the levels of assurance defined for notified electronic identification means or certified European Digital Identity Wallets under Regulation (EU) No 910/2014 and shall include rigorous testing to evaluate resistance against potential security threats. These evaluations shall employ pertinent technical standards to demonstrate robustness against such attacks.  

   4. 9.2.3.4 Use case for automated operation; USE-9.2.3.4-04: The IPSP shall establish target values for the FAR and FRR, based on a risk analysis and its threats intelligence procedure, by following the methodology established in the ENISA report 'Methodology for sectoral cybersecurity assessments' [i.28] or an equivalent methodology, in fully automated identity proofing processes. These target values shall be equal to or lower than those set for hybrid use cases, when they exist. The IPSP shall maintain these target values for FAR and FRR consistently, supported by a risk analysis and its threats intelligence procedure.  

   5. 8.3.3 Validation of physical identity document; VAL-8.3.3-21: The effectiveness of the measures for complying with the requirements VAL-8.3.3-05X, VAL-8.3.3-05A, VAL-8.3.3-05B, VAL-8.3.3-05C, VAL-8.3.3-07A and VAL-8.3.3-07X, shall be tested by an accredited laboratory or a national competent authority, whenever they are designated, at the latest by 19 August 2027 and then be repeated every second year.  

   6. 7.12. Termination and termination plans; OVR-7.12-02: The termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.1]  

---

# EUDI Wallet - Integrity and core functionalities
Source: https://docs.igrant.io/regulations/implementing-acts-integrity-and-core-functions/

---
id: implementing-acts-integrity-and-core-functions
title: EUDI Wallet - Integrity and core functionalities
description: Learn how the EU Implementing Acts define integrity and core functions for EU Digital Identity Wallets, ensuring interoperability and trust across borders.
sidebar_label: Integrity and core functionalities
keywords: [Implementing Acts, EUDI Wallet, integrity, core functionalities, interoperability, eIDAS 2.0, EU regulation]
slug: /implementing-acts-integrity-and-core-functions/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn how the EU Implementing Acts define integrity and core functions for EU Digital Identity Wallets, ensuring interoperability and trust across borders."/>
</head>

Commission Implementing **Regulation (EU) 2024/2979**, adopted on 28 November 2024, establishes detailed rules under Regulation (EU) No 910/2014 concerning the **integrity and core functionalities** of European Digital Identity Wallets. This regulation aims to ensure that these digital wallets, which allow citizens and businesses to securely store and manage their electronic identification and authentication credentials, meet consistent standards across EU Member States. By defining specific technical and operational requirements, it seeks to enhance trust and interoperability within the European Digital Identity ecosystem, facilitating seamless cross-border digital interactions.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2024/2979/oj).

## CHAPTER I - GENERAL PROVISIONS  

### Article 1: Subject matter and scope  

This Regulation lays down rules for the integrity and core functionalities of the wallets, to be updated on a regular basis to keep in line with technology and standards developments and with the work carried out on the basis of Recommendation (EU) 2021/946, and in particular the Architecture and Reference Framework.  

### Article 2: Definitions  

For the purpose of this Regulation, the following definitions apply:  

1. **‘wallet secure cryptographic application’** means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;  

2. **‘wallet unit’** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;  

3. **‘critical assets’** means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;  

4. **‘provider of person identification data’** means a natural or legal person responsible for issuing and revoking the person identification data and ensuring that the person identification data of a user is cryptographically bound to a wallet unit;  

5. **‘wallet user’** means a user who is in control of the wallet unit;  

6. **‘wallet-relying party’** means a relying party that intends to rely upon wallet units for the provision of public or private services by means of digital interaction;  

7. **‘wallet provider’** means a natural or legal person who provides wallet solutions;  

8. **‘wallet unit attestation’** means a data object that describes the components of the wallet unit or allows authentication and validation of those components;  

9. **‘embedded disclosure policy’** means a set of rules, embedded in an electronic attestation of attributes by its provider, that indicates the conditions that a wallet-relying party has to meet to access the electronic attestation of attributes;  

10. **‘wallet instance’** means the application installed and configured on a wallet user’s device or environment, which is part of a wallet unit, and that the wallet user uses to interact with the wallet unit;  

11. **‘wallet solution’** means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;  

12. **‘wallet secure cryptographic device’** means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;  

13. **‘wallet cryptographic operation’** means a cryptographic mechanism necessary in the context of authentication of the wallet user and the issuance or presentation of person identification data or electronic attestations of attributes;  

14. **‘wallet-relying party access certificate’** means a certificate for electronic seals or signatures authenticating and validating the wallet-relying party issued by a provider of wallet-relying party access certificates;  

15. **‘provider of wallet-relying party access certificates’** means a natural or legal person mandated by a Member State to issue relying party access certificates to wallet-relying parties registered in that Member State.  

## CHAPTER II  - INTEGRITY OF EUROPEAN DIGITAL IDENTITY WALLETS  

### Article 3: Wallet unit integrity  

1. Wallet units shall not perform any functionality listed in Article 5a(4) of Regulation (EU) No 910/2014, except wallet user authentication to access the wallet unit, until the wallet unit has successfully authenticated the wallet user.  

2. Wallet providers shall, for each wallet unit, sign or seal, at least one wallet unit attestation compliant with the requirements laid down in Article 6. The certificate used to sign or seal the wallet unit attestation shall be issued under a certificate listed in the trusted list referred to in Implementing Regulation (EU) 2024/2980.  

### Article 4: Wallet instances  

1. Wallet instances shall use at least one wallet secure cryptographic device to manage critical assets.  

2. Wallet providers shall ensure integrity, authenticity and confidentiality of the communication between wallet instances and wallet secure cryptographic applications.  

3. Where critical assets relate to performing electronic identification at assurance level high, the wallet cryptographic operations or other operations processing critical assets shall be performed in accordance with the requirements for the characteristics and design of electronic identification means at assurance level high, as set out in Commission Implementing Regulation (EU) 2015/1502 (11).  

### Article 5: Wallet secure cryptographic applications  

1. Wallet providers shall ensure that wallet secure cryptographic applications:  
  
   (a) perform wallet cryptographic operations involving critical assets other than those needed for the wallet unit to authenticate the wallet user only in cases where those applications have successfully authenticated wallet users;  
   
   (b) where they authenticate wallet users in the context of performing electronic identification at assurance level high; perform authentication of wallet users, in accordance with, the requirements for the characteristics and design of electronic identification means at assurance level high, as set out in Implementing Regulation (EU) 2015/1502;  
   
   (c) are able to securely generate new cryptographic keys;  
   
   (d) are able to perform secure erasure of critical assets;  
   
   (e) are able to generate a proof of possession of private keys;  
   
   (f) protect the private keys generated by those wallet secure cryptographic applications during the existence of the keys;  
   
   (g) comply with the requirements for the characteristics and design of electronic identification means at assurance level high, as set out in Implementing Regulation (EU) 2015/1502;  
   
   (h) are the only components able to execute wallet cryptographic operations and any other operation with critical assets in the context of performing electronic identification at assurance level high.  

2. Where wallet providers decide to provide a wallet secure cryptographic application to an embedded secure element these wallet providers shall base their technical solution on the technical specifications listed in Annex I or on other equivalent technical specifications.  

### Article 6: Wallet unit authenticity and validity  

1. Wallet providers shall ensure that each wallet unit contains wallet unit attestations.  

2. Wallet providers shall ensure that the wallet unit attestations referred to in paragraph 1 contain public keys and that the corresponding private keys are protected by a wallet secure cryptographic device.  

3. Wallet providers shall:  

   (a) inform wallet users of their rights and obligations in relation to their wallet unit;  
   
   (b) provide mechanisms, independent of wallet units, for the secure identification and authentication of wallet users;  
   
   (c) ensure wallet users have the right to request revocation of their wallet unit attestations, using the authentication mechanisms referred to in point (b).  

### Article 7: Revocation of wallet unit attestations  

1. Wallet providers shall be the only entities capable of revoking wallet unit attestations for wallet units that they have provided.  

2. Wallet providers shall establish a publicly available policy specifying the conditions and the timeframe for the revocation of wallet unit attestations.  

3. Where wallet providers have revoked wallet unit attestations, they shall inform affected wallet users within 24 hours of the revocation of their wallet units, including the reason for the revocation and the consequences for the wallet user. This information shall be provided in a manner that is concise, easily accessible and using clear and plain language.  

4. Where wallet providers have revoked wallet unit attestations, they shall make publicly available the validity status of the wallet unit attestation in a privacy preserving manner and describe the location of that information in the wallet unit attestation.  

## CHAPTER III  - CORE FUNCTIONALITIES AND FEATURES OF EUROPEAN DIGITAL IDENTITY WALLETS  

### Article 8: Formats for person identification data and electronic attestations of attributes  

Wallet providers shall ensure that wallet solutions support the usage of person identification data and electronic attestations of attributes issued in compliance with the list of standards set out in Annex II.  

### Article 9: Transaction logs  

1. Irrespective of whether or not a transaction is successfully completed, wallet instances shall log all transactions with wallet-relying parties and other wallet units, including electronic signing and sealing.  

2. The logged information shall at least contain:  

   (a) the time and date of the transaction;  
   
   (b) the name, contact details, and the unique identifier of the corresponding wallet-relying party and the Member State in which that wallet-relying party is established, or in case of other wallet units, relevant information from the wallet unit attestation;  
   
   (c) the type or types of data requested and presented in the transaction;  
   
   (d) in the case of non-completed transactions, the reason for such non-completion.  

3. Wallet providers shall ensure integrity, authenticity and confidentiality of the logged information.  

4. Wallet instances shall log reports sent by the wallet user to the data protection authorities via their wallet unit.  

5. The logs referred to in paragraphs 1 and 2 shall be accessible to the wallet provider, where it is necessary for the provision of wallet services, on the basis of explicit prior consent by the wallet user.  

6. The logs referred to in paragraphs 1 and 2 shall remain accessible for as long as they are required by Union law or national law.  

7. Wallet providers shall enable wallet users to export the logged information referred to in paragraph 2.  

### Article 10: Embedded disclosure  

1. Wallet providers shall ensure that electronic attestations of attributes with common embedded disclosure policies set out in Annex III can be processed by the wallet units that they provide.  

2. Wallet instances shall be able to process and present such embedded disclosure policies referred to in paragraph 1 in conjunction with data received from the requesting wallet-relying party.  

3. Wallet instances shall verify whether the wallet-relying party complies with the requirements of the embedded disclosure policy and inform the wallet user of the result.  

### Article 11: Qualified electronic signatures and seals  

1. Wallet providers shall ensure that wallet users are able to receive, qualified certificates for qualified electronic signatures or seals which are linked to qualified signature or seal creation devices that are either local, external, or remote in relation to the wallet instances.  

2. Wallet providers shall ensure that wallet solutions are able to securely interface with one of the following types of qualified signature or seal creation devices: local, external, or remotely managed qualified signature or seal creation devices for the purposes of using the qualified certificates referred to in paragraph 1.  

3. Wallet providers shall ensure that wallet users who are natural persons have, at least for non-professional purposes, free-of-charge access to signature creation applications which allow the creation of free-of-charge qualified electronic signatures using the certificates referred to in paragraph 1.  

### Article 12: Signature creation applications  

1. The signature creation applications used by wallet units may be provided either by wallet providers, by providers of trust services or by wallet-relying parties.  

2. Signature creation applications shall have the following functions:  

   (a) signing or sealing wallet user-provided data;  
   (b) signing or sealing relying party-provided data;  
   (c) creating signatures or seals in accordance with at least the mandatory formats referred to in Annex IV;  
   (d) informing wallet users about the result of the signature or seal creation process.  

3. The signature creation applications may either be integrated into or be external to wallet instances. Where signature creation applications rely on remote qualified signature creation devices and where they are integrated into wallet instances, they shall support the application programming interface referred to in Annex IV.  

### Article 13: Data export and portability  

Wallet units shall, where technically feasible and excepting cases of critical assets, support secure export and portability of personal data of the wallet user, to allow the wallet user to migrate to a wallet unit of a different wallet solution in a way that ensures level of assurance high as set out in Implementing Regulation (EU) 2015/1502.  

### Article 14: Pseudonyms  

1. Wallet units shall support the generation of pseudonyms for wallet users in compliance with the technical specifications set out in Annex V.  

2. Wallet units shall support the generation, upon the request of a wallet-relying party, of a pseudonym which is specific and unique to that wallet-relying party and provide this pseudonym to the wallet-relying party, either standalone or in combination with any person identification data or electronic attribute attestation requested by that wallet-relying party.  

## CHAPTER IV - FINAL PROVISIONS  

### Article 15: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

**Done at Brussels, 28 November 2024.**

---

## ANNEX I - LIST OF STANDARDS REFERRED TO IN ARTICLE 5  

- **SAM.01** Secured Applications for Mobile – Requirements for supporting 3rd party Applets on eSIM and eSE via SAM. v1.1 2023, GSMA;  
- **GPC_GUI_217** GlobalPlatform SAM Configuration Technical specification for implementation of SAM v1.0 2024-04;  
- **GPC_SPE_034** GlobalPlatform Card Specification Technical specification for smart cards v2.3.1 2018-03;  
- **GPC_SPE_007** GlobalPlatform Amendment A Confidential Card Content Management v1.2 2019-07;  
- **GPC_SPE_013** GlobalPlatform Amendment D Secure Channel Protocol 03 v1.2 2020-04;  
- **GPC_SPE_093** GlobalPlatform Amendment F Secure Channel Protocol 11 v1.4 2024-03;  
- **GPD_SPE_075** Open Mobile API Specification OMAPI API for mobile apps to access secure elements on user devices. v3.3 2018-08, GlobalPlatform.  

## ANNEX II - LIST OF STANDARDS REFERRED TO IN ARTICLE 8  

- **ISO/IEC 18013-5:2021**;  
- **Verifiable Credentials Data Model 1.1**, W3C Recommendation, 3 March 2022.  

## ANNEX III - LIST OF COMMON EMBEDDED DISCLOSURE POLICIES REFERRED TO IN ARTICLE 10  

1. **No policy**: Indicates that no policy applies to the electronic attestations of attributes.  
2. **Authorised relying parties only policy**: Indicates that wallet users may only disclose electronic attestations of attributes to authenticated relying parties which are explicitly listed in the disclosure policies.  
3. **Specific root of trust**: Indicates that wallet users should only disclose the specific electronic attestation of attributes to authenticated wallet-relying parties with wallet-relying party access certificates derived from a specific root (or list of specific roots) or intermediate certificate(s).  

## ANNEX IV - SIGNATURE AND SEAL FORMATS REFERRED TO IN ARTICLE 12  

1. Mandatory signature or seal format:  

- **PAdES (PDF Advanced Electronic Signature)**: As specified in ETSI EN 319 142-1 V1.1.1 (2016-04); Electronic Signatures and Infrastructures (ESI); PAdES digital signatures; Part 1: Building blocks and PAdES baseline signatures.  

2. List of optional signature or seal formats:  

   (a) **XAdES**: As specified in ‘ETSI EN 319 132-1 V1.2.1 (2022-02) Electronic Signatures and Infrastructures (ESI); XAdES digital signatures; Part 1: Building blocks and XAdES baseline signatures (XAdES)’ for signing of XML format;  

   (b) **JAdES**: As specified in ‘ETSI TS 119 182-1 V1.2.1 (2024-07) Electronic Signatures and Infrastructures (ESI); JAdES digital signatures; Part 1: Building blocks and JAdES baseline signatures’ for signing of JSON format;  

   (c) **CAdES (CMS Advanced Electronic Signature)**: As specified in ‘ETSI EN 3191 22-1 V1.3.1 (2023-06) Electronic Signatures and Infrastructures (ESI); CAdES digital signatures; Part 1: Building blocks and CAdES baseline signatures’ for the signing of CMS format;  

   (d) **ASiC (Associated Signature Container)**:

   - As specified in ‘ETSI EN 319 162-1 V1.1.1 (2016-04) Electronic Signatures and Infrastructures (ESI); Associated Signature Containers (ASiC); Part 1: Building blocks and ASiC baseline containers’ and  

   - ETSI EN 319 162-2 V1.1.1 (2016-04) Electronic Signatures and Infrastructures (ESI); Associated Signature Containers (ASiC); Part 2: Additional ASiC containers’ for the signing of containers.  

3. Application programming interface:  

   - **Cloud Signature Consortium (CSC) specification v2.0 (20 April 2023)**.  

## ANNEX V - TECHNICAL SPECIFICATIONS FOR PSEUDONYM GENERATION REFERRED TO IN ARTICLE 14  

### Technical specifications:  

- **WebAuthn** – W3C Recommendation, 8 April 2021, Level 2, [https://www.w3.org/TR/2021/REC-webauthn-2-20210408/](https://www.w3.org/TR/2021/REC-webauthn-2-20210408/).  


---

# eIDAS - List of certificates
Source: https://docs.igrant.io/regulations/implementing-acts-list-certificates/

---
id: implementing-acts-list-certificates
title: eIDAS - List of certificates
description: Understand the EU Implementing Acts on the list of certificates for trust services.
sidebar_label: List of certificates
keywords: [Implementing Acts, eIDAS, list of certificates, trust services, transparency, certificate formats]
slug: /implementing-acts-list-certificates/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on the list of certificates for trust services."/>
</head>

Commission Implementing **Regulation (EU) 2025/849** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/849/oj).


### Article 1: Subject matter  

This Regulation lays down the formats and procedures as regards the submission of information by Member States to the Commission and the Cooperation Group for the list of certified wallets pursuant to Article 5d of Regulation (EU) No 910/2014, to be updated on a regular basis to keep in line with technology and standards developments and with the work carried out on the basis of Commission Recommendation (EU) 2021/946 (5), and in particular the Architecture and Reference Framework.  

### Article 2: Definitions  

For the purposes of this Regulation, the following definitions apply:  

1. **'wallet solution'** means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;  

2. **'wallet instance'** means the application installed and configured on a wallet user's device or environment, which is part of a wallet unit, and that the wallet user uses to interact with the wallet unit;  

3. **'wallet unit'** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;  

4. **'wallet provider'** means a natural or legal person who provides wallet solutions;  

5. **'wallet user'** means a user who is in control of the wallet unit;  

6. **'wallet secure cryptographic application'** means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;  

7. **'wallet secure cryptographic device'** means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;  

8. **'critical assets'** means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;  

9. **'provider of person identification data'** means a natural or legal person responsible for issuing and revoking the person identification data and ensuring that the person identification data of a user is cryptographically bound to a wallet unit.  

### Article 3: Format, procedure for submissions and information to be submitted by Member States to the Commission  

1. Member States shall submit the information set out in the Annex to the Commission and to the Cooperation Group through a secure electronic channel made available by the Commission.  

2. Member States shall submit the information required under paragraph 1 at least in English.  

3. Where there are any changes to the submitted information, including changes to the certification status of the wallets, Member States shall submit the updated information through the channel referred to in paragraph 1.  

### Article 4: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 6 May 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX  

### Information to be submitted by Member States  

1. The purpose of the submission, indicated as one of the following:
   - (a) a provided and certified wallet  
   - (b) a change is made to any previously submitted information regarding a wallet  
   - (c) a request to remove a wallet from the list of provided and certified wallets.  

2. Information to be submitted about a provided and certified wallet:
   - (a) a description of the wallet solution, including:  
   - the name of the wallet solution
   - a unique reference identifier of the wallet solution
   - the name, the trade name where applicable, address, and, where relevant, additional information on the wallet provider
   - a description of the management of the wallet solution, including:
   - characteristics and design
   - issuance, delivery, and activation
   - suspension, revocation, and reactivation
   - recovery and backup, where applicable
   - renewal and replacement
   - management practices for wallet transaction logs
   - (b) a description of the electronic identification scheme under which the wallet solution is provided and certified, including:  
   - the title of the electronic identification scheme
   - a unique identifier for the electronic identification scheme
   - the name of the authority or names of the authorities responsible for the electronic identification scheme
   - a description of the management and organisation of the electronic identification scheme
   - the name, trade name where applicable, address, and, where relevant, additional information on the provider or providers of person identification data
   - for each provider of person identification data:
   - the set or sets of person identification data provided to natural and legal persons under the electronic identification scheme
   - a description of the set or sets of person identification data for which the Member State ensures uniqueness
   - a description of the supervisory regime in accordance with Article 46a of Regulation (EU) No 910/2014 as regards to:
   - the providers of person identification data, including identification of the supervisory body
   - the wallet provider, including identification of the supervisory body
   - a description of the liability regime in accordance with Article 5a(19) of Regulation (EU) No 910/2014, as regards to:
   - the provider or providers of person identification data
   - the wallet provider
   - a description of the enrolment process, including descriptions of:
   - applying for wallet units and person identification data
   - the registration of wallet users
   - where applicable, the identity proofing and verification of natural persons
   - where applicable, the identity proofing and verification of legal persons
   - any policies that apply to the authority or authorities responsible for the electronic identification scheme including arrangements for suspension or revocation of:
   - the electronic identification schemes
   - wallet unit attestations issued by the wallet provider
   - any other compromised parts of the wallets
   - (c) the certificate and certification assessment report in compliance with Article 5c of Regulation (EU) No 910/2014.  

---

# EUDI Wallet - Peer review of electronic identification schemes
Source: https://docs.igrant.io/regulations/implementing-acts-peer-review-eid/

---
id: implementing-acts-peer-review-eid
title: EUDI Wallet - Peer review of electronic identification schemes
description: Learn about the EU Implementing Acts on peer review processes for electronic identification schemes.
sidebar_label: Peer review of eID schemes
keywords: [Implementing Acts, eIDAS, peer review, eID schemes, electronic identification, Member States, quality]
slug: /implementing-acts-peer-review-eid/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on peer review processes for electronic identification schemes."/>
</head>

Commission Implementing **Regulation (EU) 2025/1568** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1568/oj).


### Article 1: General principles for the peer review  

1. Where a Member State makes a pre-notification of an electronic identification scheme to the Commission and to the other Member States, the peer review shall be initiated in accordance with Article 2.  

2. The Member State that makes a pre-notification of an electronic identification scheme may, at any point, withdraw its pre-notification. Where the Member State withdraws their pre-notification of the electronic identification scheme, the peer review shall be considered as terminated.  

3. Any Member State may decide to participate in the peer review of the electronic identification scheme of another Member State.  

4. Each Member State involved in a peer review shall bear the costs it incurs in the process.  

5. Representatives of the Member States that conduct the peer review shall use the information obtained through the peer review solely for the purposes of that review and shall not disclose any sensitive or confidential information obtained during the peer review to third parties.  

6. A Member State that decides to participate in the peer review of an electronic identification scheme of another Member State shall disclose any conflict of interest in relation to representatives appointed by that Member State. Where there is a conflict of interest, the Member State whose electronic identification scheme is being peer-reviewed may refuse the participation of the relevant representative in the assessment of its electronic identification scheme.  

7. Any disputes arising during the peer review in relation to the peer review activities as laid down in Article 4(4) of this Regulation shall be settled in accordance with the Cooperation Group's rules of procedure.  

8. An electronic identification scheme shall not be subject to further peer review within two years from the conclusion of a peer review, except where significant changes set out in Article 6(1) were made to the peer-reviewed electronic identification scheme.  

### Article 2: Initiation of the peer review  

1. The pre-notification shall include at least:  

   (a) a comparison between the pre-notified electronic identification scheme and requirements laid down in Implementing Regulation (EU) 2015/1502, under the form of a level of assurance mapping document for the peer review in accordance with Annex I to this Regulation;  

   (b) a high-level description of the electronic identification scheme, of its ecosystem and of electronic identification in the Member State having made the pre-notification, under the form of a whitepaper in accordance with Annex II to this Regulation;  

   (c) information regarding interoperability of the electronic identification scheme and the requirements laid down in Implementing Regulation (EU) 2015/1501, under the form of an interoperability framework mapping document in accordance with the template set out in Annex III to this Regulation.  

2. The Commission shall disseminate the pre-notification information to the Cooperation Group.  

3. The information required under paragraph 1, point (c), shall be provided at least in English. Member States shall not be obliged to translate any document where this would create an unreasonable administrative or financial burden.  

### Article 3: Preparation of the peer review  

1. Upon confirmation of receipt of a complete pre-notification, the Commission shall inform the Cooperation Group of the initiation of the peer review and schedule a meeting where the pre-notified electronic identification scheme is put on the meeting agenda for presentation to the Cooperation Group by the Member State having made the pre-notification.  

2. The chair of the Cooperation Group shall ensure that the scheduled meeting referred to in paragraph 1 takes place no later than two months after the Cooperation Group is informed of the initiation of the peer review.  

3. The date of the presentation shall be considered the official start date of the peer review.  

4. After the Member State having made the pre-notification has given the presentation referred to in paragraph 3, the other Member States may appoint representatives to participate in the peer review on their behalf. If they do so, they shall provide the names and contact details of their representatives. Those appointed representatives shall form the peer review group. The members of the peer review group shall agree on assigning the following roles:  

   (a) one coordinator who shall be responsible for organising the peer review and managing communication with Member States, the Cooperation Group and the Commission;  

   (b) up to three rapporteurs depending on the scope of the peer review and each one of them to lead a working group as referred to in Article 4(2);  

   (c) at least one active member per working group, who shall assist in generating questions and providing feedback to the rapporteurs and contribute to drafting the final peer review report.  

5. The coordinator referred to in paragraph 4, point (a), shall oversee proper execution of the peer review and monitor compliance with the procedural requirements set out in this Regulation. To that end, the coordinator shall carry out the following tasks in a timely manner:  

   (a) organisation of the questions and answers;  

   (b) finalisation of the peer review report;  

   (c) drafting of the opinion on the peer reviewed electronic identification scheme.  

6. The rapporteurs referred to in paragraph 4, point (b), shall identify questions for the Member State having made the pre-notification and draft the elements of the peer review report that relate to the area of responsibility of their respective working group.  

7. Taking into account the guidance provided by the Cooperation Group, the Member State having made the pre-notification and the Member States involved in the peer review shall agree on any organisational arrangements relating to the peer review not specifically provided for in this Regulation, including rules and guidelines regarding confidentiality and conflicts of interest.  

8. The duration of the peer review shall not exceed three months from the official start date of the peer review referred to in paragraph 3 and may be extended by a maximum of two months where all Member States involved in the peer review agree to do so.  

### Article 4: Organisation of the peer review  

1. The peer review group shall conduct the peer review based on the information provided in accordance with Article 2(1) by the Member State having made the pre-notification.  

2. The peer review shall be organised in three working groups, or using any other process agreed in the Cooperation Group in accordance with its Rules of Procedure. Where working groups are used, each working group shall be composed of one rapporteur and at least one active member.  

3. The working groups referred to in paragraph 2 shall be the following:  

   (a) an enrolment working group, peer-reviewing the alignment of the pre-notified electronic identification scheme with the requirements in relation to enrolment as set out in section 2.1 of the Annex to Implementing Regulation (EU) 2015/1502;  

   (b) an electronic identification means management and authentication working group, peer-reviewing the alignment of the pre-notified electronic identification scheme with the requirements in relation to electronic identification means management and authentication as set out in sections 2.2 and 2.3 of the Annex to Implementing Regulation (EU) 2015/1502;  

   (c) a management and organisation working group peer-reviewing the alignment of the pre-notified electronic identification scheme with the requirements in relation to management and organisation as set out in section 2.4 of Implementing Regulation (EU) 2015/1502.  

4. The peer review shall include, but is not limited to, one or more of the following activities:  

   (a) assessment of relevant documentation provided by the Member State having made the pre-notification;  

   (b) examination of processes described as part of that documentation;  

   (c) technical seminars;  

   (d) consideration of independent third-party assessments, where relevant assessments of this kind are available;  

   (e) drafting of the peer review report that summarises the peer review's findings and results.  

5. The working groups may make duly justified requests for additional information, supported by additional documentation, from the Member State having made the pre-notification where the information provided in accordance with Article 2(1) is not sufficient, for the termination of the peer review.  

6. The Member State having made the pre-notification shall comply with such requests except where one of the following applies:  

   (a) it does not possess the information or documentation and obtaining it would generate an unreasonable administrative burden;  

   (b) the information or documentation requested concerns matters of public security or national security;  

   (c) the information concerns business matters, professional or company secrets;  

   (d) the sensitivity of the information makes it impossible to establish a secure channel to communicate the information to the members of the peer review group.  

7. In such cases, the Member State having made the pre-notification shall inform the coordinator of the reasons for refusing to provide the requested information or documentation and shall provide a high-level summary of the information or a redacted version of the documentation.  

### Article 5: Outcome of the peer review  

1. Without prejudice to Article 3(9), the peer review group shall:  

   (a) provide a draft peer review report to the Member State having made the pre-notification no later than three months after the start date of the peer review referred to in Article 3(3) unless the peer review is subject to an extension in accordance with Article 3(8) where the report is due according to the agreed extension;  

   (b) provide the draft final peer review report to the Commission and the Cooperation Group after taking into consideration any observations from the Member State having made the pre-notification on the content of the draft peer review report, and no later than three months and two weeks after the official start date of the peer review pursuant to Article 3(3) unless the peer review is subject to an extension in accordance with Article 3(8) where the report is due according to the agreed extension;  

   (c) provide the Member State having made the pre-notification with a draft opinion on the pre-notified electronic identification scheme no later than three months and two weeks after the official start date of the peer review referred to in Article 3(3) unless the peer review is subject to an extension in accordance with Article 3(8) where the opinion is due according to the agreed extension and shall prepare the draft opinion using the template set out in Annex IV;  

   (d) provide the Commission and the Cooperation Group with a draft final opinion on the pre-notified electronic identification scheme no later than three months and three weeks after the start date of the peer review referred to in Article 3 (3) unless the peer review is subject to an extension in accordance with Article 3(8) where the opinion is due according to the agreed extension.  

2. Before the Cooperation Group adopts and publishes, on a dedicated website of the Commission, its final opinion on the conclusion of the peer review in accordance with paragraph 9, it may require additional information or clarification from the Member State having made the pre-notification or from the peer review group.  

3. The Member State having made the pre-notification shall provide the required additional information referred to in paragraph 2, except where one of the following applies:  

   (a) the Member State does not possess the information and obtaining it would cause an unreasonable administrative burden;  

   (b) the information concerns matters of public or national security;  

   (c) the information concerns matters of business, professional or company secrets;  

   (d) the sensitivity of the information makes it impossible to establish a secure channel to communicate the information to the Cooperation Group.  

4. The final peer review report shall list the information that was requested by the peer review group or by the Cooperation Group but could not be provided on one or more grounds set out in paragraph 3, without specifying the reasons provided by the Member State having made the pre-notification. The impact of any unavailability of information may be examined by the peer review group in the final peer review report.  

5. The peer review group shall present the final peer review report and its draft final opinion to the Cooperation Group no later than four months, or in the case of prolongation in accordance with Article 3(8) no later than six months after the official start date of the peer review pursuant to Article 3(3).  

6. The final opinion of the peer review group on the electronic identification scheme of the Member State having made the pre-notification shall list any commitments made by that Member State.  

7. After the presentation of the final peer review report and the final opinion of the peer review group, the Cooperation Group shall adopt and publish its own opinion on the conclusion of the peer review, indicating if and how the peer-reviewed electronic identification scheme meets the requirements set out in Implementing Regulation (EU) 2015/1502 that apply to the assurance levels indicated by the Member State having made the pre-notification, in accordance with Annex I of this Regulation. The adoption process shall follow the rules of procedure of the Cooperation Group.  

8. The opinion of the Cooperation Group shall identify the Member State having made the pre-notification as well as the pre-notified electronic identification scheme and its assurance level. The opinion shall also state whether the peer review was completed successfully.  

9. Information provided in accordance with Article 2(1) shall be published by the Cooperation Group, except where the Member State that provided the information has indicated in writing that such information should not be made public.  

### Article 6: Significant changes in peer-reviewed electronic identification schemes  

1. Where a notified electronic identification scheme changes in a manner that is likely to impact its interoperability, security or trustworthiness, the Member State having made the notification shall without undue delay notify the Cooperation Group of those changes and update the information previously provided.  

2. Following the receipt of a notification referred to in paragraph 1, and provided the notified electronic identification scheme has been peer-reviewed, any Member State of the Cooperation Group may request an update to the peer review.  

3. In case of a request for an update, the procedures set out in Articles 3 to 5 shall apply accordingly and the peer review group shall limit the peer review to the elements that have been changed pursuant to the original notification and to the impacts of those changes.  

### Article 7: Repeal  

Implementing Decision (EU) 2015/296 is hereby repealed.  

### Article 8: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 July 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX I - List of minimum information to be provided in the levels of assurance mapping document for the peer review referred to in Article 2(1), point (a)  

The level of assurance mapping document for the peer review referred to in Article 2, paragraph 1, point (a) shall include at least the following information:  

   1. general information, including:
      - (a) the name of the notifying Member State  
      - (b) the title of the electronic identification scheme (if any)  
      - (c) the level or levels of assurance of the electronic identification scheme, indicated as low, substantial or high.  

   2. the authority or authorities responsible for the electronic identification scheme, including:
      - (a) the name or names of the authority or authorities responsible for the electronic identification scheme  
      - (b) the email address of the authority or authorities responsible for the electronic identification scheme.  

   3. information on relevant parties, entities and bodies involved in the electronic identification scheme, including:
      - (a) the name of the entity or entities managing the registration process of the unique person identification data  
      - (b) the name of the party or parties issuing the electronic identification means, and where applicable, an indication whether the party or parties are referred to in Article 7(a), point (i), (ii) or (iii) of Regulation (EU) No 910/2014  
      - (c) the name of the party or parties operating the authentication procedure (the 'eIDAS node')  
      - (d) the name or names of the governance organisation or organisations participating in the supervisory regime related to the electronic identification scheme.  

   4. a description of the electronic identification scheme, including:
      - (a) where applicable, the document or documents that shall be enclosed for each of the following topics:  
      - a brief description of the electronic identification scheme, including the context in which it operates, its scope, and availability to private relying parties
      - a list of the additional attributes which may be provided in relation to natural persons under the electronic identification scheme if requested by a relying party
      - a list of the additional attributes which may be provided in relation to legal persons under the electronic identification scheme if requested by a relying party.
      - (b) the applicable supervisory, liability and management regime, including:  
      - a description of the supervisory regime of the electronic identification scheme including the evaluation process with respect to the following:
      - the supervisory regime applicable to the party or parties issuing the electronic identification means
      - the supervisory regime applicable to the party or parties operating the eIDAS node.
      - Where applicable, these descriptions shall include the roles, responsibilities and powers of the governance organisations that participate in the supervisory regime referred to in point 3(d), and the entity to which they report. If the organisations do not report to the authority responsible for the scheme, full details of the entity to which they report shall be provided.
      - a description of the applicable national liability regime, including:
      - a description of the liability of the Member State under Article 11(1) of Regulation (EU) No 910/2014
      - a description of the liability of the party or parties issuing the electronic identification means under Article 11(2) of Regulation (EU) No 910/2014
      - a description of the liability of the party or parties operating the eIDAS node under Article 11(3) of Regulation (EU) No 910/2014.
      - arrangements for managing, suspending or revoking either the entire identification scheme, or specific electronic identification means, or the eIDAS node, or its compromised parts.
      - (c) a description of the electronic identification scheme components, including:  
      - a description of how the requirements in relation to minimum technical specifications and procedures for assurance levels for electronic identification means, as set out in Implementing Regulation (EU) 2015/1502, have been met, to substantiate the indicated assurance level for the enrolment
      - a description of how the following processes are addressed under the electronic identification scheme, including documentation for the combination of options that were chosen by the Member State, for:
      - application and registration
      - identity proofing and verification of a natural person:
      - identity proofing and verification of a legal person
      - binding between the electronic identification means for natural and legal persons.
      - with regards to the electronic identification means management, a description of how the following processes are addressed under the electronic identification means:
      - characteristics and design of the electronic identification means, including, where appropriate, information on security certification
      - issuance, delivery and activation
      - suspension, revocation and reactivation
      - renewal and replacement.
      - with regards to authentication, a description of the authentication mechanism, including terms of access to authentication by relying parties other than public sector bodies
      - with regards to the management and organisation, a description of the management and organisation of the following aspects:
      - general provisions on management and organisation
      - published notices and user information
      - information security management
      - record keeping.
      - facilities and staff
      - technical controls.
      - compliance and audit.
      - (d) a description of how interoperability and minimum technical and operational security requirements are met  
      - (e) a list of all the supporting documentation submitted and a statement to which of the elements above they relate, including references to any domestic legislation which relates to the electronic identification provision relevant to the notification and relevant audit reports, certification practice statements, and test reports.  
      - (f) the relevant documents and information as regards the certification of the electronic identification scheme pursuant to Article 12a(1) and, where applicable, to Article 12a(5), of Regulation (EU) No 910/2014.  

## ANNEX II - List of minimum information to be provided in the white paper referred to in Article 2(1), point (b)  

1. The white paper shall describe the overall ecosystem of the electronic identification scheme being pre-notified, as well as the history of the electronic identification scheme and of electronic identification in the Member State.  

2. The white paper shall also provide a description of the electronic identification scheme and the electronic identification means provided under this scheme, including a brief description of the elements that are also covered by the levels of assurance mapping document referred to in Article 2(1), point (a) of this Regulation, the interoperability framework mapping document referred to in Article 2(1), point (c) of this Regulation, and other documents.  

3. The white paper shall also describe the role of the electronic identification scheme in the overall ecosystem and its relation to relying parties and other services provided within the ecosystem.  

## ANNEX III - Template for the interoperability framework mapping document  

### Interoperability Requirements  
 
| **Article of Implementing Regulation (EU) 2015/1501** | **Requirement** | **Description** |
| ------------------------------------------------- | ----------- | ----------- |
| 4 | **Mapping of national assurance levels**<br/>The mapping of national assurance levels of the notified electronic identification schemes shall follow the requirements laid down in Implementing Regulation (EU) 2015/1502.<br/>The results of the mapping shall be notified to the Commission using the notification template laid down in Implementing Decision (EU) 2015/1984. | &lt;To be filled out by the Member State&gt; |
| 5 | **Nodes**<br/>1. A node in one Member State shall be able to connect with nodes of other Member States.<br/>2. The nodes shall be able to distinguish between public sector bodies and other relying parties through technical means.<br/>3. A Member State implementation of the technical requirements set out in this Regulation shall not impose disproportionate technical requirements and costs on other Member States in order for them to interoperate with the implementation adopted by the first Member State. | &lt;To be filled out by the Member State&gt; |
| 6 | **Data Privacy and confidentiality**<br/>1. Protection of privacy and confidentiality of the data exchanged and the maintenance of data integrity between the nodes shall be ensured by using best available technical solutions and protection practices.<br/>2. The nodes shall not store any personal data, except for the purpose set out in Article 9(3) of Implementing Regulation (EU) 2015/1501. | &lt;To be filled out by the Member State&gt; |
| 7 | **Data integrity and authenticity for the communication**<br/>Communication between the nodes shall ensure data integrity and authenticity to make certain that all requests and responses are authentic and have not been tampered with. For this purpose, nodes shall use solutions which have been successfully employed in cross-border operational use. | &lt;To be filled out by the Member State&gt; |
| 8 | **Message format for the communication**<br/>The nodes shall use for syntax common message formats based on standards that have already been deployed more than once between Member States and proven to work in an operational environment.<br/>The syntax shall allow:<br/>(a) proper processing of the minimum set of person identification data uniquely representing a natural or legal person;<br/>(b) proper processing of the assurance level of the electronic identification means;<br/>(c) distinction between public sector bodies and other relying parties;<br/>(d) flexibility to meet the needs of additional attributes relating to identification. | &lt;To be filled out by the Member State&gt; |
| 9 | **Management of security information and metadata**<br/>1. The node operator shall communicate the metadata of the node management in a standardised machine processable manner and in a secure and trustworthy way.<br/>2. At least the parameters relevant to security shall be retrieved automatically.<br/>3. The node operator shall store data which, in the event of an incident, enable reconstruction of the sequence of the message exchange for establishing the place and the nature of the incident. The data shall be stored for a period of time in accordance with national requirements and, as a minimum, shall consist of the following elements:<br/>(a) node's identification;<br/>(b) message identification;<br/>(c) message date and time. | &lt;To be filled out by the Member State&gt; |
| 10 | **Information assurance and security standards**<br/>1. Node operators of nodes providing authentication shall prove that, in respect of the nodes participating in the interoperability framework, the node fulfils the requirements of standard ISO/IEC 27001 by certification, or by equivalent methods of assessment, or by complying with national legislation.<br/>2. Node operators shall deploy security critical updates without undue delay. | &lt;To be filled out by the Member State&gt; |
| 11 | **Person identification data**<br/>1. A minimum data set of person identification data uniquely representing a natural or a legal person shall meet the requirements set out in the Annex to Implementing Regulation (EU) 2015/1501 when used in a cross-border context.<br/>2. A minimum data set for a natural person representing a legal person shall contain the combination of the attributes listed in the Annex to Implementing Regulation (EU) 2015/1501 for natural persons and legal persons when used in a cross-border context.<br/>3. Data shall be transmitted based on original characters and, where appropriate, also transliterated into Latin characters. | &lt;To be filled out by the Member State&gt; |

## ANNEX IV - Template for the opinion on the electronic identification scheme of a Member State  

**Opinion No. XX/202X of the Cooperation Group on the &lt;insert Member State&gt; eID scheme &lt;insert scheme name&gt;**
 
Having regard to Article 12(5) of Regulation (EU) 910/2014 ('the European Digital Identity Regulation'),  

Having regard to Implementing Regulation (EU) 2025/1568.  

Having regard to the Rules of Procedure of the Cooperation Group,  

Whereas:  

Article 12(5) of the European Digital Identity Regulation obliges Member States to carry out peer reviews of electronic identification schemes to be notified under Article 9(1), point (a) of the European Digital Identity Regulation.  

Article 5(10) of Commission Implementing Regulation (EU) 2025/1568 on cooperation mandates the Cooperation Group to adopt opinions on how an electronic identification scheme to be notified meets the requirements of the European Digital Identity Regulation.  

&lt;insert Member State&gt;, with a view to notifying its eID scheme &lt;insert scheme name&gt; in accordance with Article 9(1) of the European Digital Identity Regulation, provided the following information to the Member States on &lt;insert date&gt; (hereinafter referred to as: 'pre-notification') in line with Article 7(g) of the European Digital Identity Regulation:  

   - Notification form;  

   - Supporting Documentation.  

On &lt;insert date of CG meeting&gt;, the Cooperation Group:  

   - agreed to organise the peer review of the &lt;insert Member State&gt; eID scheme &lt;insert scheme name&gt; according to Article 46e(5)(d) of the European Digital Identity Regulation and Implementing Regulation (EU) 2025/1568;  

   - formed a 'Peer Review Group'; and  

   - agreed which topics the peer review process would cover and how it would be organised according to the provisions of Implementing Regulation (EU) 2025/1568.  

The Peer Review Group submitted its report according to Article 5 of Implementing Regulation (EU) 2025/1568 to the Cooperation Group on &lt;insert date&gt;. The Cooperation Group has examined and discussed the Peer Review Report.  

Taking into account the outcomes of the peer review, the peer review report and the additional information provided by &lt;insert Member State&gt; regarding:  

–  

and that &lt;insert Member State&gt; commits to:  

–  

The Cooperation Group adopted the following opinion:  

### Opinion  

Based on the examination of the pre-notification documents provided by &lt;insert Member State&gt; and the findings of the Peer Review Report, the Cooperation Group is of the opinion that the pre-notification documents and additional information provided by &lt;insert Member State&gt; demonstrate sufficiently how the &lt;insert Member State&gt;eID scheme &lt;insert scheme name&gt; to be notified meets the requirements  

   - for assurance level 'High';  

   - for assurance level 'Substantial';  

   - for assurance level 'Low';  

in line with the requirements of Articles 7, 8(1)-(2), 12(1), 12a(1) and 12a(5) of the European Digital Identity Regulation and with the requirements of Implementing Regulation (EU) 2015/1502.  

According to Article &lt;insert number&gt; of the Rules of Procedure, the Cooperation Group agrees to publish this opinion.  

&lt;insert Member State&gt;, &lt;insert date&gt;  

---

# EUDI Wallet - Person identification data and electronic attestations of attributes
Source: https://docs.igrant.io/regulations/implementing-acts-pid-and-eaass/

---
id: implementing-acts-pid-and-eaas
title: EUDI Wallet - Person identification data and electronic attestations of attributes
description: Learn how the EU Implementing Acts define using PID and Electronic Attestation Attributes (EAAs) for secure and trusted digital identity verification.
sidebar_label: Person identification data and electronic attestations of attributes
keywords: [Implementing Acts, EUDI Wallet, PID, person identification data, electronic attestation, EAA, eIDAS 2.0]
slug: /implementing-acts-pid-and-eaass/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Discover PID and EAAs in the EU Implementing Acts | iGrant.io DevDocs</title>
   <meta name="description" content="Learn how the EU Implementing Acts define using PID and Electronic Attestation Attributes (EAAs) for secure and trusted digital identity verification."/>
</head>

Commission Implementing **Regulation (EU) 2024/2977**, adopted on 28 November 2024, establishes detailed rules under Regulation (EU) No 910/2014 concerning issuing **person identification data** and **electronic attestations of attributes** to European Digital Identity Wallets. This regulation ensures that wallet solutions meet consistent standards across EU Member States, enabling secure and reliable electronic identification and authentication credentials storage. Defining technical and procedural requirements for data issuance and revocation enhances trust and interoperability within the European Digital Identity ecosystem, facilitating seamless and secure digital interactions across borders.

An electronic edition of the same is available [here](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=OJ:L_202402977).

:::info Amended in July 2026
This regulation was amended by <a href="/regulations/implementing-acts-wallet-standards-update/">Commission Implementing Regulation (EU) 2026/1731</a> of 15 July 2026. Among other changes, the amendment replaced the Annex: person identification data is now issued in the **SD-JWT VC** and **ISO/IEC-mdoc** formats, in accordance with Annex II to Implementing Regulation (EU) 2024/2979 (ETSI TS 119 472-1 V1.2.1, clauses 5 and 6). The W3C Verifiable Credentials Data Model is no longer referenced in the operative text. The article and annex summaries below describe the regulation as originally adopted; refer to the [current consolidated text on EUR-Lex](https://eur-lex.europa.eu/eli/reg_impl/2024/2977/oj) for the current wording.
::: 

## Article 1: Subject matter and scope  

This Regulation lays down rules for the issuance of person identification data and electronic attestations of attributes to wallet units, to be updated on a regular basis to keep in line with technology and standards developments and with the work carried out on the basis of Recommendation (EU) 2021/946, and in particular the architecture and reference framework.  

## Article 2: Definitions  

For the purpose of this Regulation, the following definitions apply:  

1. **‘wallet user’** means a user who is in control of the wallet unit;  

2. **‘wallet unit’** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;  

3. **‘wallet solution’** means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;  

4. **‘provider of person identification data’** means a natural or legal person responsible for issuing and revoking the person identification data and ensuring that the person identification data of a user is cryptographically bound to a wallet unit;  

5. **‘wallet unit attestation’** means a data object that describes the components of the wallet unit or allows authentication and validation of those components;  

6. **‘wallet instance’** means the application installed and configured on a wallet user’s device or environment, which is part of a wallet unit, and that the wallet user uses to interact with the wallet unit;  

7. **‘wallet secure cryptographic application’** means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;  

8. **‘wallet secure cryptographic device’** means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;  

9. **‘wallet provider’** means a natural or legal person who provides wallet solutions;  

10. **‘critical assets’** means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;  

11. **‘wallet-relying party’** means a relying party that intends to rely upon wallet units for the provision of public or private services by means of digital interaction;  

12. **‘wallet-relying party access certificate’** means a certificate for electronic seals or signatures authenticating and validating the wallet-relying party issued by a provider of wallet-relying party access certificates;  

13. **‘provider of wallet-relying party access certificates’** means a natural or legal person mandated by a Member State to issue relying party access certificates to wallet-relying parties registered in that Member State.  

## Article 3: Issuance of person identification data to wallet units  

1. Providers of person identification data shall issue person identification data to wallet units in accordance with the electronic identification schemes under which wallet solutions are provided.  

2. Providers of person identification data shall ensure that person identification data issued to wallet units contains the information necessary for authentication and validation of the person identification data.  

3. Providers of person identification data shall ensure that person identification data issued to wallet units comply with the technical specifications set out in the Annex.  

4. Member States shall ensure that the person identification data issued to a given wallet user is unique for the Member State.  

5. Providers of person identification data shall ensure that person identification data that they issue is cryptographically bound to the wallet unit to which it is issued.  

6. Member States shall make publicly available a list of wallet solutions that are supported by providers of person identification data that is part of electronic identification schemes of that Member State.  

7. Member States shall enroll wallet users in accordance with the requirements relating to enrolment at assurance level high, as set out in Commission Implementing Regulation (EU) 2015/1502 (11). In the context of the enrolment process, providers of person identification data shall perform identity verification of the wallet user in accordance with the requirements related to identity proofing and verification before issuing the person identification data to the wallet unit of the corresponding wallet user.  

8. When issuing person identification data to wallet units, providers of person identification data shall identify themselves to wallet units using their wallet-relying party access certificate or by using another authentication mechanism in accordance with an electronic identity scheme notified at assurance level high.  

9. Before issuing person identification data to a wallet unit, providers of person identification data shall authenticate and validate the wallet unit attestation of the wallet unit and verify that the wallet unit belongs to a wallet solution the provider of person identification data accepts or use another authentication mechanism in accordance with an electronic identity scheme notified at assurance level high.  

## Article 4: Issuance of electronic attestations of attributes to wallet units  

1. Electronic attestations of attributes issued to wallet units shall comply with at least one of the standards in the list set out in Annex I of Implementing Regulation (EU) 2024/2979.  

2. Providers of electronic attestations of attributes shall identify themselves to wallet units using their wallet-relying party access certificate.  

3. Providers of electronic attestations of attributes shall ensure that electronic attestations of attributes issued to wallet units contain the information necessary for authentication and validation of those electronic attestations of attributes.  

## Article 5: Revocation of person identification data  

1. Providers of person identification data issued to a wallet unit shall have written and publicly accessible policies relating to validity status management, including, where applicable, the conditions under which such person identification data can be revoked without delay.  

2. Only providers of person identification data or electronic attestation of attributes can revoke the person identification data or electronic attestations of attributes issued by them.  

3. Where providers of person identification data have revoked person identification data, they shall, through dedicated and secure channels, inform wallet users subject of those person identification data within 24 hours of the revocation and of the reasons for the revocation. This shall be done in a manner that is concise, easily accessible and using clear and plain language.  

4. Where providers of person identification data revoke person identification data issued to wallet units, they shall do so in each of the following circumstances:  
   - (a) upon the explicit request of the wallet user to whose wallet unit the person identification data or electronic attestation of attributes were issued to;  
   - (b) where the wallet unit attestation to which the person identification data was issued to has been revoked;  
   - (c) in other situations determined by the providers of person identification data or electronic attestations of attributes in their policies referred to in paragraph 1.  

5. Providers of person identification data issued to a wallet unit shall ensure that revocations cannot be reverted.  

6. The revoked person identification data shall remain accessible for as long as required by Union law or national law.  

7. Where providers of person identification data revoke person identification data issued to wallet units, they shall make publicly available the validity status of person identification data they issue, in a privacy preserving manner, and indicate the location of that information in the person identification data.  

8. Providers of person identification data shall enable privacy preserving techniques which ensure unlinkability where the electronic attestations of attributes do not require the identification of the user.  


## Article 6: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

**Done at Brussels, 28 November 2024.**  

## ANNEX - TECHNICAL SPECIFICATIONS FOR PERSON IDENTIFICATION DATA REFERRED TO IN ARTICLE 3(3)

### 1. Set of natural person identification data

**Table 1:** Mandatory person identification data for the natural person

| **Data Identifier** | **Definition**                                                                                                                                                                                                                         | **Presence** |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| family_name         | Current last name(s) or surname(s) of the user to whom the person identification data relates.                                                                                                                                         | Mandatory    |
| given_name          | Current first name(s), including middle name(s) where applicable, of the user to whom the person identification data relates.                                                                                                          | Mandatory    |
| birth_date          | Day, month, and year on which the user to whom the person identification data relates was born.                                                                                                                                        | Mandatory    |
| birth_place         | The country as an alpha-2 country code as specified in ISO 3166-1, or the state, province, district, or local area or the municipality, city, town, or village where the user to whom the person identification data relates was born. | Mandatory    |
| nationality         | One or more alpha-2 country codes as specified in ISO 3166-1, representing the nationality of the user to whom the person identification data relates.                                                                                 | Mandatory    |

*Where an attribute value is not known for the person or cannot otherwise be issued as part of the person identification dataset, Member States shall use an attribute value appropriate to the situation instead.*

**Table 2:** Optional person identification data for the natural person

### Table 2: Optional person identification data for the natural person

| **Data Identifier**            | **Definition**                                                                                                                                                                                                                                                                                                                                                                                                                                                              | **Presence** |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| resident_address               | The full address of the place where the user to whom the person identification data relates currently resides or can be contacted (street name, house number, city, etc.).                                                                                                                                                                                                                                                                                                  | Optional     |
| resident_country               | The country where the user to whom the person identification data relates currently resides, as an alpha-2 country code as specified in ISO 3166-1.                                                                                                                                                                                                                                                                                                                         | Optional     |
| resident_state                 | The state, province, district, or local area where the user to whom the person identification data relates currently resides.                                                                                                                                                                                                                                                                                                                                               | Optional     |
| resident_city                  | The municipality, city, town, or village where the user to whom the person identification data relates currently resides.                                                                                                                                                                                                                                                                                                                                                   | Optional     |
| resident_postal_code           | The postal code of the place where the user to whom the person identification data relates currently resides.                                                                                                                                                                                                                                                                                                                                                               | Optional     |
| resident_street                | The name of the street where the user to whom the person identification data relates currently resides.                                                                                                                                                                                                                                                                                                                                                                     | Optional     |
| resident_house_number          | The house number where the user to whom the person identification data relates currently resides, including any affix or suffix.                                                                                                                                                                                                                                                                                                                                            | Optional     |
| personal_administrative_number | A value assigned to the natural person that is unique among all personal administrative numbers issued by the provider of person identification data. Where Member States opt to include this attribute, they shall describe in their electronic identification schemes under which the person identification data is issued the policy that they apply to the values of this attribute, including, where applicable, specific conditions for the processing of this value. | Optional     |
| portrait                       | Facial image of the wallet user compliant with ISO 19794-5 or ISO 39794 specifications.                                                                                                                                                                                                                                                                                                                                                                                     | Optional     |
| family_name_birth              | Last name(s) or surname(s) of the person identification data user at the time of birth.                                                                                                                                                                                                                                                                                                                                                                                     | Optional     |
| given_name_birth               | First name(s), including middle name(s), of the person identification data user at the time of birth.                                                                                                                                                                                                                                                                                                                                                                       | Optional     |
| sex                            | Values shall be one of the following:  0 = not known;  1 = male;  2 = female;  3 = other;  4 = inter;  5 = diverse;  6 = open;  9 = not applicable. For values 0, 1, 2, and 9, ISO/IEC 5218 applies.                                                                                                                                                                                                                                                                        | Optional     |
| email_address                  | Electronic mail address of the user to whom the person identification data relates [in conformance with RFC 5322].                                                                                                                                                                                                                                                                                                                                                          | Optional     |
| mobile_phone_number            | Mobile telephone number of the user to whom the person identification data relates, starting with the '+' symbol as the international code prefix and the country code, followed by numbers only.                                                                                                                                                                                                                                                                           | Optional     |

### 2. Set of legal person identification data

Table 3: Mandatory person identification data for the legal person

| **Data Element**                                                                                                                                                                                            | **Presence** |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| Current legal name                                                                                                                                                                                          | Mandatory    |
| A unique identifier constructed by the sending Member State in accordance with the technical specifications for the purposes of cross-border identification and which is as persistent as possible in time. | Mandatory    |

*Where a data element is not known for the person or cannot otherwise be issued as part of the person identification dataset, Member States shall use an attribute value appropriate to the situation instead.*

***Table 4:*** Optional person identification data for the legal person

| **Data Element**                                                                                                             | **Presence** |
| ---------------------------------------------------------------------------------------------------------------------------- | ------------ |
| Current address                                                                                                              | Optional     |
| VAT registration number                                                                                                      | Optional     |
| Tax reference number                                                                                                         | Optional     |
| European unique identifier referred to in Directive (EU) 2017/1132 of the European Parliament and of the Council             | Optional     |
| Legal Entity Identifier (LEI) referred to in Commission Implementing Regulation (EU) 2022/1860                               | Optional     |
| Economic Operator Registration and Identification (EORI) referred to in Commission Implementing Regulation (EU) No 1352/2013 | Optional     |
| Excise number provided in Article 2(12) of Council Regulation (EU) No 389/2012                                               | Optional     |

### 3. Set of metadata about person identification data

**Table 5:** Metadata about the person identification data

| **Data Identifier**  | **Definition**                                                                                                                                                                                                                       | **Presence** |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ |
| expiry_date          | Date (and if possible, time) when the person identification data will expire.                                                                                                                                                        | Mandatory    |
| issuing_authority    | Name of the administrative authority that issued the person identification data, or the ISO 3166 alpha-2 country code of the respective Member State if there is no separate authority entitled to issue person identification data. | Mandatory    |
| issuing_country      | Alpha-2 country code, as specified in ISO 3166-1, of the country or territory of the provider of the person identification data.                                                                                                     | Mandatory    |
| document_number      | A number for the person identification data, assigned by the provider of person identification data.                                                                                                                                 | Optional     |
| issuing_jurisdiction | Country subdivision code of the jurisdiction that issued the person identification data, as specified in ISO 3166-2:2020, Clause 8. The first part of the code shall be the same as the value for the issuing country.               | Optional     |
| location_status      | The location of validity status information on the person identification data where the providers of person identification data revoke person identification data.                                                                   | Optional     |

### 4. Encoding of person identification data attributes

As originally adopted, person identification data was to be issued in two formats:

1. The format specified in ISO/IEC 18013-5:2021.
2. [Verifiable Credentials Data Model 1.1](https://www.w3.org/TR/vc-data-model/), W3C Recommendation, 3 March 2022.

Since the July 2026 amendment by Implementing Regulation (EU) 2026/1731, natural person identification data shall be issued in accordance with the standards set out in Annex II to Implementing Regulation (EU) 2024/2979, clauses 5 (**SD-JWT VC** format) and 6 (**ISO/IEC-mdoc** format), as applicable to electronic attestations of attributes.

### 5. Trust infrastructure details

The list of providers of person identification data made available by the Commission in accordance with Implementing Regulation (EU) 2024/2980 laying down rules for the application of Regulation (EU) No 910/2014 of the European Parliament and of the Council as regards notifications to the Commission concerning the European Digital Identity Wallet ecosystem shall enable authentication of person identification data.

---

# EUDI Wallet - Protocols and interfaces to be supported
Source: https://docs.igrant.io/regulations/implementing-acts-protocols-and-interfaces-to-be-supported/

---
id: implementing-acts-protocols-and-interfaces-to-be-supported
title: EUDI Wallet - Protocols and interfaces to be supported
description: See which protocols and interfaces are mandated by the Implementing Acts to ensure EU Digital Identity Wallet compatibility and secure data exchange.
sidebar_label: Protocol and interfaces to be supported
keywords: [Implementing Acts, EUDI Wallet, protocols, interfaces, interoperability, eIDAS 2.0, EU regulation]
slug: /implementing-acts-protocols-and-interfaces-to-be-supported/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Explore Protocols in the EU Digital ID Implementing Acts | iGrant.io DevDocs</title>
   <meta name="description" content="See which protocols and interfaces are mandated by the Implementing Acts to ensure EU Digital Identity Wallet compatibility and secure data exchange."/>
</head>

Commission Implementing **Regulation (EU) 2024/2982**, adopted on 28 November 2024, sets out specific **protocols and interfaces** for the European Digital Identity Framework, as outlined in Regulation (EU) No 910/2014. This regulation aims to standardise and improve the interoperability of digital identity systems across EU Member States, enabling seamless and secure electronic interactions for citizens and businesses within the Union. Defining such technical specifications ensures that various national digital identity schemes can work together cohesively, fostering trust and efficiency in cross-border digital services.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2024/2982/oj).

## Article 1: Subject matter and scope

This Regulation lays down rules on the protocols and interfaces of wallet solutions for:

1. the issuance of person identification data and electronic attestations of attributes to wallet units;

2. the presentation of attributes of person identification data and electronic attestations of attributes, to wallet-relying parties and other wallet units;

3. the communication of data erasure requests to wallet-relying parties;

4. the reporting of wallet-relying parties to supervisory authorities established under Article 51 of Regulation (EU) 2016/679; to be updated on a regular basis to keep in line with technology and standards developments and with the work carried out on the basis of Recommendation (EU) 2021/946, and in particular the Architecture and Reference Framework.

## Article 2: Definitions

For the purpose of this Regulation, the following definitions apply:

1. ‘wallet-relying party’ means a relying party that intends to rely upon wallet units for the provision of public or private services by means of digital interaction;

2. ‘wallet user’ means a user who is in control of the wallet unit;

3. ‘wallet solution’ means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;

4. ‘wallet unit’ means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;

5. ‘wallet provider’ means a natural or legal person who provides wallet solutions;

6. ‘wallet instance’ means the application installed and configured on a wallet user’s device or environment, which is part of a wallet unit, and that the wallet user uses to interact with the wallet unit;

7. ‘wallet secure cryptographic application’ means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;

8. ‘wallet secure cryptographic device’ means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;

9. ‘critical assets’ means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;

10. ‘wallet-relying party access certificate’ means a certificate for electronic seals or signatures authenticating and validating the wallet-relying party issued by a provider of wallet-relying party access certificates;

11. ‘provider of wallet-relying party access certificates’ means a natural or legal person mandated by a Member State to issue relying party access certificates to wallet-relying parties registered in that Member State;

12. ‘wallet unit attestation’ means a data object that describes the components of the wallet unit or allows authentication and validation of those components;

13. ‘embedded disclosure policy’ means a set of rules, embedded in an electronic attestation of attributes by its provider, that indicates the conditions that a wallet-relying party has to meet to access the electronic attestation of attributes;

14. ‘wallet-relying party registration certificate’ means a data object that indicates the attributes the relying party has registered to intend to request from users;

15. ‘provider of person identification data’ means a natural or legal person responsible for issuing and revoking the person identification data and ensuring that the person identification data of a user is cryptographically bound to a wallet unit;

16. ‘cryptographic binding’ means the method to link person identification data or electronic attestations of attributes to wallet units through cryptographic means.

## Article 3: General provisions

Regarding the protocols and interfaces referred to in Articles 4 and 5, wallet providers shall ensure that wallet units:

1. authenticate and validate the wallet-relying party access certificates where interacting with wallet-relying parties;

2. authenticate and validate the wallet unit attestations of other wallet units where interacting with other wallet units;

3. authenticate and validate requests made using wallet-relying party access certificates or wallet unit attestations from other wallet units, where applicable;

4. authenticate and validate the wallet-relying party registration certificate, where applicable;

5. display to wallet users information contained in the wallet-relying party access certificates or in the wallet unit attestations;

6. display to wallet users, where applicable, the attributes that wallet users are requested to present;

7. display to wallet users, where applicable, information contained in the wallet-relying party registration certificate;

8. present wallet unit attestations of the wallet unit to wallet-relying parties or wallet units that request it;

9. do not present any requested attributes to wallet-relying parties or wallet units until the following requirements are met:
   - (a) verify the wallet secure cryptographic application has authenticated the identity of the wallet user;
   - (b) verify embedded disclosure policies have been processed within the wallet unit in accordance with Article 11 of Implementing Regulation (EU) 2024/2979, where applicable;
   - (c) verify wallet users have partially or in full approved the presentation.

10. enable privacy preserving techniques which ensure unlinkability where the electronic attestations of attributes do not require the identification of the wallet user, when presenting attestations or person identification data across different wallet-relying parties.


## Article 4: Issuance of person identification data and electronic attestations of attributes to wallet units

1. Wallet providers shall ensure that wallet solutions support protocols and interfaces for the issuance of person identification data and electronic attestations of attributes to wallet units.

2. Wallet providers shall ensure that wallet units request issuance of person identification data and electronic attestations of attributes only from parties having an authentic and valid wallet-relying party access certificate attesting them as:  
   (a) a provider of person identification data;  
   (b) a provider of a qualified electronic attestation of attributes;  
   (c) a provider of an electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source; or  
   (d) a provider of non-qualified electronic attestations of attributes.

3. In relation to the issuance of person identification data and electronic attestations of attributes to a wallet unit, wallet providers shall ensure that the following requirements are complied with:  

   (a) where wallet users use their wallet unit to request the issuance of person identification data or of electronic attestations of attributes from providers of person identification data or providers of electronic attestations of attributes that enable issuance of person identification data or electronic attestations in more than one format, the wallet unit shall request it in all formats referred to in Article 8 of Implementing Regulation (EU) 2024/2979 laying down rules for the application of Regulation (EU) No 910/2014 as regards the integrity and core functionalities of European Digital Identity Wallets;  

   (b) where wallet users use their wallet unit to interact with providers of person identification data or electronic attestations of attributes, wallet units shall enable authentication and validation of the wallet unit components by presenting the wallet unit attestations to those providers upon their request;  

   (c) wallet solutions shall support mechanisms that enable providers of person identification data to verify issuance, delivery and activation in compliance with assurance level high requirements set out in Commission Implementing Regulation (EU) 2015/1502 (11);  

   (d) wallet units shall verify the authenticity and validity of person identification data and electronic attestations of attributes.

## Article 5: Presentation of attributes to wallet-relying parties

1. Wallet providers shall ensure that wallet solutions support protocols and interfaces for the presentation of attributes to wallet-relying parties, remotely, and where appropriate in proximity, in accordance with the standards set out in the Annex.

2. Wallet providers shall ensure that, at the request of users, wallet units respond to successfully authenticated and validated requests from wallet-relying parties referred to in Article 3, in accordance with the standards set out in the Annex.

3. Wallet providers shall ensure that wallet units support proving the possession of private keys corresponding to public keys used in cryptographic bindings.

4. Wallet providers shall ensure that wallet solutions support the selective disclosure of attributes of personal identification data and of electronic attestations of attributes.

5. Paragraphs 1 to 4 shall apply mutatis mutandis to interactions between two wallet units in proximity.

## Article 6: Communication of data erasure requests

1. Wallet providers shall ensure that wallet units support protocols and interfaces allowing wallet users to request from wallet-relying parties, with whom they have interacted through those wallet units, the erasure of their personal data provided through those wallet units, in accordance with Article 17 of Regulation (EU) 2016/679.

2. The protocols and interfaces referred to in paragraph 1 shall allow wallet users to select the wallet-relying parties to which data erasure requests are to be submitted.

3. Wallet units shall display to the wallet user previously submitted data erasure requests made through those wallet units.

## Article 7: Reporting of wallet-relying parties to supervisory authorities established under Article 51 of Regulation (EU) 2016/679

1. Wallet providers shall ensure that wallet units allow wallet users to easily report wallet-relying parties to supervisory authorities established under Article 51 of Regulation (EU) 2016/679.

2. Wallet providers shall implement the protocols and interfaces for reporting wallet-relying parties in compliance with national procedural laws of the Member States.

3. Wallet providers shall ensure that wallet units allow wallet users to substantiate the reports, including by attaching relevant information to identify the wallet-relying parties, and the wallet users’ claims in machine-readable format.

## Article 8: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

**Done at Brussels, 28 November 2024.**

## ANNEX - STANDARDS REFERRED TO IN ARTICLE 5(1) AND (2)

* [ISO/IEC 18013-5:2021](https://www.iso.org/standard/69084.html)
* [ISO/IEC TS 18013-7:2024](https://www.iso.org/standard/82772.html)

---

# eIDAS - Qualified certificates for electronic signatures and seals
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-certificates/

---
id: implementing-acts-qualified-certificates
title: eIDAS - Qualified certificates for electronic signatures and seals
description: Understand the EU Implementing Acts on qualified certificates for electronic signatures and seals.
sidebar_label: Qualified certificates
keywords: [Implementing Acts, eIDAS, qualified certificates, electronic signatures, electronic seals, trust services]
slug: /implementing-acts-qualified-certificates/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on qualified certificates for electronic signatures and seals."/>
</head>

Commission Implementing **Regulation (EU) 2025/1945** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1945/oj).


### Article 1: Reference standards and specifications  

1. The reference standards and specifications referred to in Article 32(3) and Article 40 of Regulation (EU) No 910/2014 are set out in Annex I to this Regulation.  

2. The reference standards and specifications referred to in Article 32a(3) and Article 40a of Regulation (EU) No 910/2014 are set out in Annex II to this Regulation.  

### Article 2: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 September 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX I - List of reference standards and specifications for the validation of qualified electronic signatures and of qualified electronic seals  

The standards ETSI TS 119 172-4 V1.1.1 (2021-05) (1) ('ETSI TS 119 172-4'), and ETSI TS 119 102-2 V1.4.1 (2023-06) (2) ('ETSI TS 119 102-2') apply with the following adaptations:  

1. For ETSI TS 119 172-4
   (1) 2.1 Normative references:
   - [1] ETSI EN 319 102-1 V1.4.1 (2024-06) 'Electronic Signatures and Trust Infrastructures (ESI)
   - Procedures for Creation and Validation of AdES Digital Signatures
   - Part 1: Creation and Validation'.
   - All references to 'ETSI TS 119 102-1 [1]' shall be understood as references to 'ETSI EN 319 102-1 [1]'.
   - [2] ETSI TS 119 612 V2.3.1 (2024-11) 'Electronic Signatures and Infrastructures (ESI)
   - Trusted Lists'.
   - [13] ETSI TS 119 101 V1.1.1 (2016-03) 'Electronic Signatures and Infrastructures (ESI)
   - Policy and security requirements for applications for signature creation and signature validation'.
   - (2) 4.2 Validation constraints and validation procedures, requirement REQ-4.2-03, section 'X.509 validation constraints', point c):  
   - (i) If an end-entity certificate represents a trust anchor, the RevocationCheckingConstraints shall not be used.
   - (ii) If an end-entity certificate does not represent a trust anchor, the RevocationCheckingConstraints shall be set to 'eitherCheck' as defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.1.
   - (iii) If an end-entity certificate represents a trust anchor, the RevocationFreshnessConstraints defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.2 shall not be used.
   - (iv) If an end-entity certificate does not represent a trust anchor, the RevocationFreshnessConstraints defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.2 shall be used with a maximum value of 24 hours for the signing certificate. No value shall be set for the RevocationFreshnessConstraints for certificates other than the signing certificate, including certificates supporting time-stamps.
   - (3) 4.3 Requirements on signature validation and applicability rules checking practices  
   - REQ-4.3-02 Signature validation applications shall be compliant with ETSI TS 119 101 [13].
   - (4) 4.4 Technical applicability (rules) checking process  
   - REQ-4.4.2-03 If any of the checks specified in REQ-4.4.2-01 fails, then:
   - (a) the process stops  
   - (b) the signature shall be technically determined as indeterminate, i.e. as neither an EU qualified electronic signature, nor as an EU qualified electronic seal  
   - and
   - (c) the above result and the results of processes of all the intermediate processes shall be reflected in the signature applicability rules checking report.  

## ANNEX II - List of reference standards and specifications for the validation of advanced electronic signatures based on qualified certificates and of advanced electronic seals based on qualified certificates  

The standards ETSI TS 119 172-4 V1.1.1 (2021-05) (1) ('ETSI TS 119 172-4'), and ETSI TS 119 102-2 V1.4.1 (2023-06) (2) ('ETSI TS 119 102-2') apply with the following adaptations:  

1. For ETSI TS 119 172-4
   (1) 2.1 Normative references:
   - [1] ETSI EN 319 102-1 V1.4.1 (2024-06) 'Electronic Signatures and Trust Infrastructures (ESI)
   - Procedures for Creation and Validation of AdES Digital Signatures
   - Part 1: Creation and Validation'.
   - All references to 'ETSI TS 119 102-1 [1]' shall be understood as references to 'ETSI EN 319 102-1 [1]'.
   - [2] ETSI TS 119 612 V2.3.1 (2024-11) 'Electronic Signatures and Infrastructures (ESI)
   - Trusted Lists'.
   - [13] ETSI TS 119 101 V1.1.1 (2016-03) 'Electronic Signatures and Infrastructures (ESI)
   - Policy and security requirements for applications for signature creation and signature validation'.
   - (2) 4.2 Validation constraints and validation procedures, requirement REQ-4.2-03, section 'X.509 validation constraints', point (c):  
   - (i) If an end-entity certificate represents a trust anchor, the RevocationCheckingConstraints shall not be used.
   - (ii) If an end-entity certificate does not represent a trust anchor, the RevocationCheckingConstraints shall be set to 'eitherCheck' as defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.1.
   - (iii) If an end-entity certificate represents a trust anchor, the RevocationFreshnessConstraints defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.2 shall not be used.
   - (iv) If an end-entity certificate does not represent a trust anchor, the RevocationFreshnessConstraints defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.2 shall be used with a maximum value of 24 hours for the signing certificate. No value shall be set for the RevocationFreshnessConstraints for certificates other than the signing certificate, including certificates supporting time-stamps.
   - (3) 4.3 Requirements on signature validation and applicability rules checking practices  
   - REQ-4.3-02 Signature validation applications shall be compliant with ETSI TS 119 101 [13].
   - (4) 4.4 Technical applicability (rules) checking process  
   - REQ-4.4.2-03 If any of the checks specified in REQ-4.4.2-01 fails, then:
   - (a) the process stops  
   - (b) the signature shall be technically determined as indeterminate, i.e. as neither an advanced electronic signature based on EU qualified certificate, nor as an advanced electronic seal based on EU qualified certificate  
   - and
   - (c) the above result and the results of processes of all the intermediate processes shall be reflected in the signature applicability rules checking report.  
   - REQ-4.4.2-04 void.
   - REQ-4.4.2-05 void.
   - REQ-4.4.2-06 At that point of the TARC process, if the following conditions are met:
   - (a) the signing certificate is determined, at the best signature time, as an EU qualified certificate for electronic signatures (respectively for electronic seals), as specified in REQ-4.4.2-02 a)  
   - and
   - (b) the result of the process performed as specified in clause 4.2 of the present document is TOTAL-PASSED,  
   - then the digital signature shall be determined as technically suitable to implement an EU advanced electronic signature based on a qualified certificate (respectively an EU advanced electronic seal based on a qualified certificate), otherwise the signature shall not be determined technically either as an EU advanced electronic signature based on a qualified certificate, or as an EU advanced electronic seal based on a qualified certificate.

---

# eIDAS - Qualified electronic archiving services
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-electronic-archiving/

---
id: implementing-acts-qualified-electronic-archiving
title: eIDAS - Qualified electronic archiving services
description: Understand the EU Implementing Acts on requirements for qualified electronic archiving services under eIDAS.
sidebar_label: Qualified electronic archiving services
keywords: [Implementing Acts, eIDAS, qualified electronic archiving, data preservation, trust services]
slug: /implementing-acts-qualified-electronic-archiving/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on requirements for qualified electronic archiving services under eIDAS."/>
</head>

Commission Implementing **Regulation (EU) 2025/2532** establishes detailed rules under Regulation (EU) No 910/2014. This regulation sets out requirements for qualified electronic archiving services for long-term data preservation within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/2532/oj).


### Article 1: Electronic archiving of documents bearing a qualified electronic signature or a qualified electronic seal

1. When archiving electronic data or electronic documents that contain qualified electronic signatures or qualified electronic seals, providers of qualified electronic archiving services shall ensure that the trustworthiness of those qualified electronic signatures or qualified electronic seals is maintained, including beyond their technological validity period, and that the integrity and the accuracy of the origin of the qualified electronic signatures and seals is maintained, at least until the end of the legal or contractual preservation period.

2. For the purposes of paragraph 1, providers of qualified electronic archiving services may rely on a qualified preservation service for qualified electronic signatures or on a qualified preservation service for qualified electronic seals.

### Article 2: Reference standards and specifications for the provision of qualified electronic archiving services

The reference standards and specifications referred to in Article 45j(2) of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.

### Article 3: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 16 December 2025.

For the Commission

The President

Ursula VON DER LEYEN

## ANNEX - List of reference standards and specifications for qualified electronic archiving services

CEN/TS 18170:2025 ('CEN/TS 18170') applies with the following adaptations:

(a) **Normative references (clause 2)**
   - ETSI EN 319 401 V3.1.1 (2024-06), Electronic Signatures and Trust Infrastructures (ESI); General Policy Requirements for Trust Service Providers
   - ETSI EN 319 421 V1.3.1 (2025-07), Electronic Signatures and Infrastructures (ESI); Policy and Security Requirements for Trust Service Providers issuing Time-Stamps
   - ISO 14721:2025, Space Data System Practices -- Reference model for an open archival information system (OAIS)
   - ACM-ECCG, European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by the European Union Agency for Cybersecurity ('ENISA')
   - CIR (EU) 2024/482, Commission Implementing Regulation (EU) 2024/482 (1)
   - CIR (EU) 2024/3144, Commission Implementing Regulation (EU) 2024/3144 (2)
   - ISO/IEC 15408:2022 (parts 1 to 5), 'Information security, cybersecurity and privacy protection -- Evaluation criteria for IT security'
   - FIPS PUB 140-3 (2019), 'Security Requirements for Cryptographic Modules'

(b) **Policy and practice statement (clause 6.1)**
   - The requirements of CEN/TS 18170, clause 6.1 shall apply.
   - The requirements of ETSI EN 319 401, clause 5 shall apply.
   - The EATSP shall establish procedures to notify the supervisory body of any changes in the provision of the electronic archiving trust service and on the intention to cease those activities, in accordance with business requirements and relevant laws and regulations, including in accordance with the requirements of the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.2].
   - The EATSP shall notify the competent supervisory body at least:
     - one month before implementing any change;
     - three months before the planned cessation of a trust service provision.

(c) **Terms and Conditions (clause 6.2)**
   - The requirements of CEN/TS 18170, clause 6.2 shall apply.
   - Subscribers and parties relying on the electronic archiving trust service shall be informed, in a clear, comprehensive and easily accessible manner, in a publicly accessible space and individually, of precise terms and conditions, before entering into a contractual relationship.

(d) **Human resources (clause 7.3)**
   - The requirements of CEN/TS 18170, clause 7.3 shall apply.
   - EATSP's personnel in trusted roles, and if applicable its subcontractors in trusted roles, shall be able to fulfil the requirement of 'expert knowledge, experience and qualifications' through formal training and credentials, or actual experience, or a combination of the two. This shall include regular updates (at least every 12 months) on new threats and current security practices.

(e) **Cryptographic controls and monitoring (clause 7.6)**
   - The archiving system must guarantee the confidentiality of data and documents through the lifecycle of the archive from its deposit to its elimination.
   - The requirements specified in ETSI EN 319 401, sub-clause 7.5 "Cryptographic controls" shall apply.
   - The origin of the data to be archived in the electronic archiving system shall be established by the EATSP. If they use electronic signatures or electronic seals to do so, those electronic signatures or electronic seals shall be qualified.
   - When EATSP digitally signs (part of) a digital object or record, the EATSP private signing key shall be held and used within either a qualified electronic signature or seal creation device or a secure cryptographic device which is a trustworthy system certified in accordance with:
     - (a) Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 or in Common Criteria for Information Technology Security Evaluation, version CC:2022, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher; or
     - (b) the European Common Criteria-based cybersecurity certification scheme (CIR (EU) 2024/482, CIR (EU) 2024/3144) and certified to EAL 4 or higher; or
     - (c) until 31.12.2030, FIPS PUB 140-3 level 3.
   - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
   - If the secure cryptographic device benefits from an EUCC certification (CIR (EU) 2024/482, CIR (EU) 2024/3144), then this device shall be configured and used in accordance with that certification.
   - The EATSP shall monitor the strength of cryptographic algorithm that was and are used. In case, one of the used algorithms or parameters is thought to become not suitable as defined in the risk management, the EATSP shall either update the related archiving policy or create a new archiving profile to handle the AIPs and define and perform appropriate measures.
   - The evaluation of the cryptographic algorithms and their use by the EATSP shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA (ACM-ECCG).
   - Technical components of the EATS shall authenticate each other based on cryptographic techniques before communicating.

(f) **Network (clause 7.9)**
   - The requirements specified in ETSI EN 319 401, sub-clause 7.8 "Network security" shall apply.
   - The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 shall be performed at least once per quarter.
   - The penetration test requested by REQ-7.8-17X of ETSI EN 319 401 shall be performed at least once per year.
   - Firewalls shall be configured to prevent all protocols and accesses not required for the operation of the EATSP.

(g) **Collection of evidence (clause 7.11)**
   - The requirements specified in ETSI EN 319 401, sub-clause 7.10 "Collection of evidence" shall apply, including for critical and non-critical events (see subclause 13.2).

(h) **EATSP termination and termination plan (clause 7.13)**
   - The requirements of CEN/TS 18170, clause 7.13 shall apply.
   - The EATSP's termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014.

(i) **Reliable time of events (clause 13.3.1)**
   - The requirements of CEN/TS 18170, clause 13.3.1 shall apply.
   - When using timestamps the EATSP shall use a qualified timestamp.

---

(1) Commission Implementing Regulation (EU) 2024/482 of 31 January 2024 laying down rules for the application of Regulation (EU) 2019/881 of the European Parliament and of the Council as regards the adoption of the European Common Criteria-based cybersecurity certification scheme (EUCC) (OJ L, 2024/482, 7.2.2024, ELI: http://data.europa.eu/eli/reg_impl/2024/482/oj).

(2) Commission Implementing Regulation (EU) 2024/3144 of 18 December 2024 amending Implementing Regulation (EU) 2024/482 as regards applicable international standards and correcting that Implementing Regulation (OJ L, 2024/3144, 19.12.2024, ELI: http://data.europa.eu/eli/reg_impl/2024/3144/oj).


---

# eIDAS - Qualified electronic registered delivery services
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-delivery/

---
id: implementing-acts-qualified-delivery
title: eIDAS - Qualified electronic registered delivery services
description: Learn about the EU Implementing Acts on qualified electronic registered delivery services.
sidebar_label: Qualified electronic delivery
keywords: [Implementing Acts, eIDAS, qualified delivery, registered delivery, secure document exchange, trust services]
slug: /implementing-acts-qualified-delivery/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on qualified electronic registered delivery services."/>
</head>

Commission Implementing **Regulation (EU) 2025/1944** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1944/oj).


### Article 1: Reference standards and specifications for qualified electronic registered delivery services  

The reference standards and specifications referred to in Article 44(2) of Regulation (EU) No 910/2014 are set out in the Annex I to this Regulation.  

### Article 2: Reference standards and specifications for the interoperability between qualified electronic registered delivery services  

The reference standards and specifications referred to in Article 44(2b) of Regulation (EU) No 910/2014 are set out in the Annex II to this Regulation.  

### Article 3: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 September 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX I - List of reference standards and specifications referred to in Article 1  

The standard ETSI EN 319 521 V1.1.1 (2019-02) ('ETSI EN 319 521 ') applies with the following adaptations:  

1. For ETSI EN 319 521
   (1) 2.1 Normative references:
   - [1] ETSI EN 319 401 V3.1.1 (2024-06) 'Electronic Signatures and Infrastructures (ESI)
   - General Policy Requirements for Trust Service Providers'.
   - [2] ETSI EN 319 411-1 V1.5.1 (2025-04) 'Electronic Signatures and Infrastructures (ESI)
   - Policy and security requirements for Trust Service Providers issuing certificates
   - Part 1: General requirements'.
   - [3] ETSI EN 319 522-1 V1.2.1 (2024-01) 'Electronic Signatures and Infrastructures (ESI)
   - Electronic Registered Delivery Services
   - Part 1: Framework and Architecture'.
   - [4] ETSI EN 319 522-2 V1.2.1 (2024-01) 'Electronic Signatures and Infrastructures (ESI)
   - Electronic Registered Delivery Services
   - Part 2: Semantic content'.
   - [5] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by the European Union Agency for Cybersecurity ('ENISA') (1).
   - [6] ISO/IEC 15408-1:2022 – Information security, cybersecurity and privacy protection – Evaluation criteria for IT security.
   - [7] Commission Implementing Regulation (EU) 2024/482 (2) laying down rules for the application of Regulation (EU) 2019/881 of the European Parliament and of the Council as regards the adoption of the European Common Criteria-based cybersecurity certification scheme (EUCC).
   - [8] Commission Implementing Regulation (EU) 2024/3144 (3) amending Implementing Regulation (EU) 2024/482 as regards applicable international standards and correcting that Implementing Regulation.
   - [9] FIPS PUB 140-3 (2019) 'Security Requirements for Cryptographic Modules'.
   - (2) 3.1 Terms  
   - advanced electronic seal: As defined in Regulation (EU) No 910/2014 [i.1].
   - advanced electronic signature: As defined in Regulation (EU) No 910/2014 [i.1].
   - qualified electronic seal: As defined in Regulation (EU) No 910/2014 [i.1].
   - qualified electronic signature: As defined in Regulation (EU) No 910/2014 [i.1].
   - secure cryptographic device: device which holds the user's private key, protects this key against compromise and performs signing or decryption functions on behalf of the user.
   - (3) 5.1.1 Common provisions  
   - REQ-ERDS-5.1.1-01 The ERDS shall ensure that availability, integrity and confidentiality of the user content is adequately guaranteed while it is handled by the ERDS, selecting suitable integrity and confidentiality cryptographic techniques compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [5].
   - (4) 5.2.1.1 General  
   - REQ-QERDS-5.2.1.1-01 The QERDSP shall verify with a very high level of confidence the identity of the recipient either directly or by relying on a third party, and by using one of the following means or a combination thereof as required:
   - (a) through the physical presence of the natural person or of an authorised representative of the legal person, by means of appropriate evidence and procedures, in accordance with national law  
   - (b) remotely, using an electronic identification means, which meets the requirements set out in Article 8 of Regulation (EU) No 910/2014 [i.1] with regard to the assurance level 'high', or by means of the European Digital Identity Wallet  
   - (c) by means of a certificate of a qualified electronic signature or of a qualified electronic seal  
   - (d) by using other identification methods, which ensure that the natural person or the authorised representative of the legal person can be identified with a very high level of confidence. The assurance that this identification is performed with a very high level of confidence shall be confirmed by a conformity assessment body.  
   - REQ-QERDS-5.2.1.1-01A The QERDSP shall verify the identity of the sender by appropriate means, either directly or by relying on a third party, on the basis of one of the following methods or on a combination thereof:
   - (a) through the physical presence of the natural person or of an authorised representative of the legal person, by means of appropriate evidence and procedures, in accordance with national law  
   - (b) remotely, by means of the European Digital Identity Wallet or a notified electronic identification means which meets the requirements set out in Article 8 of Regulation (EU) No 910/2014 [i.1] with regard to the assurance level 'substantial' provided that it has been issued based on prior physical presence of the natural person or of an authorised representative of the legal person  
   - (c) by means of a certificate of an advanced electronic signature or of an advanced electronic seal, provided the certificate has been issued to the natural person or to an authorised representative of the legal person under Normalised Certificate Policy (NCP) as defined in ETSI EN 319 411-1 [2]  
   - or
   - (d) by using other identification methods, which ensure that the natural person or the authorised representative of the legal person can be identified with a very high level of confidence. The assurance that this identification is performed with a high level of confidence shall be confirmed by a conformity assessment body.  
   - NOTE The third party verifying the identity of the sender and the recipient may be another QERDSP if the sender and the recipient are subscribed to different QERDSPs.
   - (5) 5.2.1.2 Recipient identification and handover of user content  
   - REQ-QERDS-5.2.1.2-03 If the identification of the recipient is based on a QERDS internal process, the QERDSP shall conduct the whole process in a secured and controlled environment.
   - (6) 5.2.2 Provisions for EU QERDS authentication  
   - REQ-QERDS-5.2.2-03 [CONDITIONAL] When the QERDSP binds means of authentication to a sender identity verified as per clause 5.2.1, it shall be one of the following:
   - (a) two factor authentication mechanisms  
   - (b) European Digital Identity Wallet or a notified electronic identification means which meets the requirements set out in Article 8 of Regulation (EU) No 910/2014 [i.1] with regard to the assurance level 'high' or 'substantial'  
   - (c) a mutual TLS authentication, which includes the certificate issued to the sender under NCP as defined in ETSI EN 319 411-1 [2]  
   - (d) a digital signature supported by a certificate issued under NCP as defined in ETSI EN 319 411-1 [2]  
   - (e) other means that ensure the authentication of the identified sender. The conformity of the binding shall be confirmed by a conformity assessment body. Example: This can include the use of one of the above means from letters (a), (b) and (d) to register a Transport Layer Security (TLS) client certificate for automated sending via mutual TLS, or to register a digital seal certificate used to seal assertions to authenticate with the ERDS. Other mechanisms where the identified senders are making use of delegated third-party services can also apply.  
   - REQ-QERDS-5.2.2-03A [CONDITIONAL] When the QERDSP binds means of authentication to a recipient identity verified as per clause 5.2.1, it shall be one of the following, provided that the means, or any combination of means, ensure very high level of confidence regarding the identity of the authenticated recipient:
   - (a) a multi factor authentication mechanism  
   - (b) European Digital Identity Wallet or a notified electronic identification means which meets the requirements set out in Article 8 of Regulation (EU) No 910/2014 [i.1] with regard to the assurance level 'high' or 'substantial'  
   - (c) a certificate of a qualified electronic signature or of a qualified electronic seal  
   - (d) other means that ensure the authentication of the identified recipient. The conformity of the binding shall be confirmed by a conformity assessment body. Example: This can include the use of one of the above means from letters (a) to (c) to register a Transport Layer Security (TLS) client certificate for automated sending via mutual TLS, or to register a digital seal certificate used to seal assertions to authenticate with the ERDS. Other mechanisms where the identified senders are making use of delegated third-party services can also apply.  
   - REQ-QERDS-5.2.2-04 [CONDITIONAL] If the sender connects to the QERDS on a secured connection which requires machine-to-machine mutual authentication between the sender's machine and the QERDS's server based on certificates issued according to NCP as defined in ETSI EN 319 411-1 [2], then after this secure connection has been established, single factor authentication mechanisms may be adopted for a second phase of sender authentication if the organisational procedures and security measures put in place ensure confidence in the authentication of the sender.
   - (7) 5.4.1 Common provisions  
   - REQ-ERDS-5.4.1-06 The ERDS shall generate and make available to legitimate interested parties ERDS evidence about ERD events as defined in clause 6 of ETSI EN 319 522-1 [3].
   - REQ-ERDS-5.4.1-07 The ERDSP shall archive the evidence and/or evidence digests for each evidence that it issued.
   - REQ-ERDS-5.4.1-08 The ERDS evidence generated by the ERDS shall comply with evidence semantic defined in clause 8 of ETSI EN 319 522-2 [4].
   - (8) 7.2.1 Common provisions  
   - REQ-ERDS-7.2.1-02 The ERDSP's personnel in trusted roles shall be able to fulfil the requirement of 'expert knowledge, experience and qualifications' through formal training and credentials, or actual experience, or a combination of the two.
   - REQ-ERDS-7.2.1-03 Compliance with REQ-ERDS-7.2.1-02 shall include regular updates (at least every 12 months) on new threats and current security practices.
   - (9) 7.3.2 Media handling  
   - REQ-ERDS-7.3.1-02 All requirements from ETSI EN 319 401 [1], clause 7.3.3 shall apply.
   - (10) 7.5 Cryptographic controls  
   - REQ-ERDS-7.5-01A The ERDS shall select and use suitable cryptographic techniques in accordance with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [5].
   - REQ-ERDSP-7.5-03 The ERDS signing private key shall be held and used within a secure cryptographic device which is a trustworthy system certified in accordance with:
   - (a) Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 [6] or in Common Criteria for Information Technology Security Evaluation, version CC:2002, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher  
   - or
   - (b) the European Common Criteria-based cybersecurity certification scheme (EUCC) [7][8], and certified to EAL 4 or higher  
   - or
   - (c) until 31.12.2030, FIPS PUB 140-3 [9] level 3.  
   - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
   - If the secure cryptographic device benefits from an EUCC [7][8] certification, then this device shall be configured and used in accordance with that certification.
   - (11) 7.8 Network security  
   - REQ-ERDSP-7.8-04 The ERDSP shall use state-of-the-art protocols and algorithms for encryption on transport layer level in compliance with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [5].
   - REQ-ERDSP-7.8-06 The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 [1] shall be performed at least once per quarter.
   - REQ-ERDSP-7.8-07 The penetration test requested by REQ-7.8-17X of ETSI EN 319 401 [1] shall be performed at least once per year.
   - REQ-ERDSP-7.8-08 Firewalls shall be configured to prevent all protocols and accesses not required for the operation of the TSP.
   - (12) 7.12 ERDSP termination and ERDS termination plans  
   - REQ-ERDS-7.12-03 The ERDSP's termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.1].
   - (13) 7.14 Supply chain  
   - REQ-ERDS-7.14-01 The requirements specified in ETSI EN 319 401 [1], clause 7.14 shall apply.

## ANNEX II - List of reference standards and specifications referred to in Article 2  

The standards ETSI EN 319 522-1 V1.2.1 (2024-01) ('ETSI EN 319 522-1'), ETSI EN 319 522-2 V1.2.1 (2024-01) ('ETSI EN 319 522-2'), ETSI EN 319 522-3 V1.2.1 (2024-01) ('ETSI EN 319 522-3'), ETSI EN 319 522-4-1 V1.2.1 (2019-01) ('ETSI EN 319 522-4-1'), ETSI EN 319 522-4-2 V1.1.1 (2018-09) ('ETSI EN 319 522-4-2') and ETSI EN 319 522-4-3 V1.1.1 (2018-09) ('ETSI EN 319 522-4-3') apply.  

---

# eIDAS - Qualified electronic ledgers
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-electronic-ledgers/

---
id: implementing-acts-qualified-electronic-ledgers
title: eIDAS - Qualified electronic ledgers
description: Understand the EU Implementing Acts on requirements for qualified electronic ledgers under eIDAS.
sidebar_label: Qualified electronic ledgers
keywords: [Implementing Acts, eIDAS, qualified electronic ledgers, distributed ledger, trust services]
slug: /implementing-acts-qualified-electronic-ledgers/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on requirements for qualified electronic ledgers under eIDAS."/>
</head>

Commission Implementing **Regulation (EU) 2025/2531** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/2531/oj).


### Article 1: Reference standards and specifications

The reference standards and specifications referred to in Article 45l(3) of Regulation (EU) No 910/2014 are set out, for qualified electronic ledgers, in the Annex to this Regulation.

### Article 2: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 16 December 2025.

For the Commission

The President

Ursula VON DER LEYEN

## ANNEX - List of technical specifications and reference standards for qualified distributed electronic ledgers

### 1. Definitions

For the purposes of this Regulation, the following definitions apply:

   (a) **'finality'** means the state of a data record of an electronic ledger wherein it has become irreversible and cannot be modified or removed;

   (b) **'distributed electronic ledger'** means an electronic ledger that is shared across a set of distributed electronic ledger nodes and which is synchronized between the distributed electronic ledger nodes using a consensus mechanism;

   (c) **'distributed electronic ledger node'** means a device or process that is part of a distributed electronic ledger network and stores a complete or partial copy of the data records of an electronic ledger;

   (d) **'distributed electronic ledger network'** means a network of distributed electronic ledger nodes which makes up a distributed electronic ledger system;

   (e) **'distributed electronic ledger system'** means a system that implements a distributed electronic ledger;

   (f) **'consensus'** means an agreement among distributed electronic ledger nodes on the validity of transactions and the maintenance of a consistent and ordered set of validated transactions across the distributed electronic ledger system;

   (g) **'consensus mechanism'** means the set of rules and procedures by which consensus is reached;

   (h) **'governing rules'** means the set of protocols, policies, and mechanisms that dictates how the distributed electronic ledger system operates, how data is validated and added to an electronic ledger, and how participants interact with the distributed electronic ledger system;

   (i) **'smart contract'** means a computer programme stored in a distributed electronic ledger system wherein the outcome of the execution of the programme is recorded in the distributed electronic ledger;

   (j) **'data records'** means data, including but not limited to data transactions, control transactions, status transactions or smart contracts, recorded in an electronic ledger;

   (k) **'originator'** means a natural or legal person, or any other entity, which is the source of a data record, and which may be a user of the qualified electronic ledger service;

   (l) **'transactions'** means a group of actions that write a data record, a set of data records or a modification of a data record to the electronic ledger;

   (m) **'ledger report'** means a statement produced as a result of the evaluation of data records in an electronic ledger according to predefined rules, which provides insights into specific activities, states, or compliance with predefined rules;

   (n) **'provider of qualified electronic ledger'** means a qualified trust service provider that provides a qualified trust service consisting in the recording of data in a qualified electronic ledger.

   (o) **'qualified distributed electronic ledger'** means a distributed electronic ledger that meets the requirements of a qualified electronic ledger.

### 2. Ledger reports

Where the qualified trust service provider needs to produce a ledger report, it shall be produced in an automated manner.

### 3. Technical specifications and reference standards

Providers of qualified electronic ledgers shall create, record electronic data in, update and maintain a qualified electronic ledger in accordance with the specifications established in:

**(a) For all providers of qualified electronic ledgers**, ETSI EN 319 401 v3.1.1 (2024-06) with the following adaptations:

   (1) 2.1 Normative references:
   - [1] European Cybersecurity Certification Group, Sub-group on Cryptography: "Agreed Cryptographic Mechanisms" published by the European Union Agency for Cybersecurity ("ENISA").
   - [2] IETF RFC 7515 (May 2015): "JSON Web Signature (JWS)".
   - [3] FIPS PUB 140-3 (2019) "Security Requirements for Cryptographic Modules".
   - [4] Commission Implementing Regulation (EU) 2024/482 of 31 January 2024 laying down rules for the application of Regulation (EU) 2019/881 of the European Parliament and of the Council as regards the adoption of the European Common Criteria-based cybersecurity certification scheme (EUCC).
   - [5] Commission Implementing Regulation (EU) 2024/3144 of 18 December 2024 amending Implementing Regulation (EU) 2024/482 as regards applicable international standards and correcting that Implementing Regulation.
   - [6] ISO/IEC 15408:2022 (parts 1 to 5): "Information security, cybersecurity and privacy protection -- Evaluation criteria for IT security".

   (2) 6.1 Trust service practice statement:
   - REQ-6.1-12 The electronic ledger practice statement shall include at least the following information:
     - the functional and technical capabilities of the electronic ledger platform and its use throughout the provision of the recording of data in a qualified electronic ledger as a qualified trust service;
     - the specific data origin authentication mechanisms used when providing the service;
     - the specific sequential chronological ordering mechanisms used when providing the service;
     - where applicable, the cryptographic link used to ensure the sequence of data records;
     - where applicable, the consensus mechanism ensuring finality and integrity of data records and transactions stored in the ledger, including any cautionary time until finality and integrity are achieved;
     - the specific data integrity mechanisms used when providing the service.

   (3) 6.2 Terms and conditions:
   - REQ-6.2-03 Subscribers and parties relying on the trust service shall be informed, in a clear, comprehensive and easily accessible manner, in a publicly accessible space and individually, of precise terms and conditions, including the items listed above, before entering into a contractual relationship.

   (4) 6.3 Information security policy:
   - REQ-6.3-04X The TSP shall establish procedures to notify any changes in the provision of the trust service to the supervisory body, in accordance with business requirements and relevant laws and regulations. The TSP shall notify the supervisory body at least:
     - one month before implementing any planned change that may significantly affect the provision of the trust service,
     - and no later than 24 hours after becoming aware of any unplanned change that significantly affects the provision of the trust service.

   (5) 7.2 Asset management:
   - REQ-7.2-04X An electronic ledger practice statement according to the requirements of clause 6.1 of this document shall be maintained.
   - REQ-7.2-05X The electronic ledger practice statement shall be approved by the TSP's management and published.

   (6) 7.5 Cryptographic controls:
   - REQ-7.5-01X The TSP shall establish procedures to manage cryptographic keys, cryptographic algorithms, and cryptographic devices throughout their lifecycle, following, where appropriate, a cryptographic agility approach.
   - REQ-7.5-02 For the purpose of the provision of its trust services, the TSP shall select and use suitable cryptographic techniques compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [1].

   In particular:
   - REQ-7.5-03 Providers of qualified electronic ledgers shall establish the origin of data records in the electronic ledger. To this extent, they shall use advanced electronic signatures based on qualified certificates or advanced electronic seals based on qualified certificates created by the users of the service in accordance with the following standards and specifications:
     - (a) ETSI EN 319 122-1 V1.3.1 (2023-06). Electronic Signatures and Infrastructures (ESI); CAdES digital signatures; Part 1: Building blocks and CAdES baseline signatures.
     - (b) ETSI EN 319 132-1 V1.3.1 (2024-07). Electronic Signatures and Trust Infrastructures (ESI); XAdES digital signatures; Part 1: Building blocks and XAdES baseline signatures.
     - (c) ETSI TS 119 182-1 V1.2.1 (2024-07). Electronic Signatures and Trust Infrastructures (ESI); JAdES digital signatures; Part 1: Building blocks and JAdES baseline signatures, with the following adaptation:
       - 5.1.8 The x5c (X.509 Certificate Chain) header parameter
       - The x5c header parameter as defined in clause 4.1.6 of IETF RFC 7515 [2] shall be present in the JAdES signature, either as a signed or unsigned header parameter.
       - The x5c header parameter shall have the semantics specified in IETF RFC 7515 [2], clause 4.1.6.
       - The x5c header parameter shall have the syntax specified in IETF RFC 7515 [2], clause 4.1.6.

   - REQ-7.5-04 Providers of qualified electronic ledgers shall ensure the unique sequential chronological ordering of data records in the electronic ledger. To this extent, they shall use cryptographic links, based in hash lists or hash trees, using cryptographic hash functions, in accordance with the following specifications and standards:
     - (a) SHA-256 or higher output hash size, in compliance with the "Agreed Cryptographic Mechanisms" endorsed by the European Cybersecurity Certification Group and published by ENISA [1].
     - (b) SHA-512/256 or higher output hash size, in compliance with the "Agreed Cryptographic Mechanisms" endorsed by the European Cybersecurity Certification Group and published by ENISA [1].
     - (c) SHA3-256 or higher output hash size, in compliance with the "Agreed Cryptographic Mechanisms" endorsed by the European Cybersecurity Certification Group and published by ENISA [1].

   - REQ-7.5-05 Providers of qualified electronic ledgers shall ensure the data integrity of data records in the electronic ledger. To this extent, they shall use advanced electronic signatures based on qualified certificates or advanced electronic seals based on qualified certificates, in accordance with the following standards and specifications:
     - (a) any signature or seal formats that are compliant with the "Agreed Cryptographic Mechanisms" endorsed by the European Cybersecurity Certification Group and published by ENISA [1];
     - (b) SHA-256 or higher output hash size, in compliance with the "Agreed Cryptographic Mechanisms" endorsed by the European Cybersecurity Certification Group and published by ENISA [1];
     - (c) SHA3-256 or higher output hash size, in compliance with the "Agreed Cryptographic Mechanisms" endorsed by the European Cybersecurity Certification Group and published by ENISA [1].
     - (d) Providers of qualified electronic ledgers shall ensure the immediate detectability of any subsequent change to data recorded in a qualified electronic ledger.

   - REQ-7.5-06 Where digital signature mechanisms are used, signing private keys of the provider of qualified electronic ledger shall be held and used within a secure cryptographic device which is a trustworthy system certified in accordance with:
     - (a) Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 [6] or in Common Criteria for Information Technology Security Evaluation, version CC:2022, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher
     - or
     - (b) EUCC [4][5], and certified to EAL 4 or higher
     - or
     - (c) until 31.12.2030, FIPS PUB 140-3 [3] level 3.
     - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
     - If the secure cryptographic device benefits from an EUCC [4][5] certification, then this device shall be configured and used in accordance with that certification.

   (7) 7.8 Network security:
   - REQ-7.8-14X The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 shall be performed at least once per quarter.
   - REQ-7.8-13 The vulnerability scans shall be performed at least once per quarter on all public-facing systems and networks.
   - REQ-7.8-18X The penetration test requested by REQ-7.8-17X of ETSI EN 319 401 shall be performed at least once per year.
   - REQ-7.8-17X Penetration tests shall be performed at least once per year.
   - REQ-7.8-21X Firewalls shall also be configured to prevent all protocols and accesses not required for the operation of the TSP.

   (8) 7.9.1 Monitoring and logging:
   - REQ-7.9.1-02X Monitoring activities shall take account of the sensitivity of any information collected or analysed.

   (9) 7.12 TSP termination and termination plans:
   - REQ-7.12-02A The TSP's termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Art. 24(5) of Regulation (EU) No 910/2014 [i.1].

**(b) Additionally for all providers of qualified electronic ledgers making use of distributed electronic ledger technologies:**

   (1) ISO 23257:2022 Blockchain and distributed ledger technologies -- Reference architecture, clause 9, providing a complete description of the distributed electronic ledger technology system, the corresponding distributed electronic ledger technology network and distributed electronic ledger technology nodes;

   (2) ISO/TS 23635:2022. Blockchain and distributed ledger technologies -- Guidelines for governance, with respect to written and publicly accessible policies and practices related to the governance structure for the electronic ledger service they provide.


---

# eIDAS - Qualified preservation services for electronic signatures and seals
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-preservation/

---
id: implementing-acts-qualified-preservation
title: eIDAS - Qualified preservation services for electronic signatures and seals
description: Learn about the EU Implementing Acts on qualified preservation services for electronic signatures and seals.
sidebar_label: Qualified preservation services
keywords: [Implementing Acts, eIDAS, qualified preservation, electronic signatures, long-term validity, trust services]
slug: /implementing-acts-qualified-preservation/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on qualified preservation services for electronic signatures and seals."/>
</head>

Commission Implementing **Regulation (EU) 2025/1946** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1946/oj).


### Article 1: Reference standards and specifications  

The reference standards and specifications referred to in Article 34(2) and Article 40 of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.  

### Article 2: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 September 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX - List of reference standards and specifications referred to in Article 2  

The standards ETSI TS 119 511 V1.1.1 (2019-06) ('ETSI TS 119 511 '), and ETSI TS 119 172-4 V1.1.1 (2021-05) ('ETSI TS 119 172-4') apply with the following adaptations:  

1. For ETSI TS 119 511
   (1) 2.1 Normative references:
   - [1] ETSI EN 319 401 V3.1.1 (2024-06) 'Electronic Signatures and Infrastructures (ESI)
   - General Policy Requirements for Trust Service Providers'.
   - [2] ETSI TS 119 612 (V2.3.1) 'Electronic Signatures and Infrastructures (ESI)
   - Trusted Lists'.
   - [5] FIPS PUB 140-3 (2019) 'Security Requirements for Cryptographic Modules'.
   - [6] Commission Implementing Regulation (EU) 2024/482 (1) laying down rules for the application of Regulation (EU) 2019/881 of the European Parliament and of the Council as regards the adoption of the European Common Criteria-based cybersecurity certification scheme (EUCC).
   - [7] Commission Implementing Regulation (EU) 2024/3144 (2) amending Implementing Regulation (EU) 2024/482 as regards applicable international standards and correcting that Implementing Regulation.
   - [8] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by the European Union Agency for Cybersecurity ('ENISA') (3).
   - [9] ETSI TS 119 172-4 V1.1.1 (2021-05) 'Electronic Signatures and Infrastructures (ESI)
   - Signature Policies
   - Part 4: Signature applicability rules (validation policy) for European qualified electronic signatures/seals using trusted lists'.
   - [10] ISO/IEC 15408:2022 (parts 1 to 5) 'Information security, cybersecurity and privacy protection – Evaluation criteria for IT security'
   - (2) 3.1 Terms  
   - secure cryptographic device: device which holds the user's private key, protects this key against compromise and performs signing or decryption functions on behalf of the user.
   - (3) 6.4 Preservation profiles  
   - OVR-6.4-08A [WTS][WOS] The expected evidence duration shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA[8].
   - NOTE 3 void.
   - (4) 6.5 Preservation evidence policy  
   - OVR-6.5-04A The cryptographic algorithms used shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA[8].
   - NOTE 1 void.
   - (5) 7.2 Human resources  
   - OVR-7.2-02 PSP's personnel in trusted roles, and if applicable its subcontractors in trusted roles, shall be able to fulfil the requirement of 'expert knowledge, experience and qualifications' through formal training and credentials, or actual experience, or a combination of the two.
   - OVR-7.2-03 Compliance with OVR-7.2-02 shall include regular updates (at least every 12 months) on new threats and current security practices.
   - (6) 7.5 Cryptographic controls  
   - OVR-7.5-05 [CONDITIONAL] When PSP signs (part of) a preservation evidence, the PSP private signing key shall be held and used within a secure cryptographic device which is a trustworthy system certified in accordance with:
   - (a) Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 [10] or in Common Criteria for Information Technology Security Evaluation, version CC:2022, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher  
   - or
   - (b) EUCC [6][7] and certified to EAL 4 or higher  
   - or
   - (c) until 31.12.2030, FIPS PUB 140-3 [5] level 3.  
   - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
   - If the secure cryptographic device benefits from an EUCC [6][7] certification, then this device shall be configured and used in accordance with that certification.
   - OVR-7.5-06 [CONDITIONAL] void.
   - OVR-7.5-07 [CONDITIONAL] When PSP signs (part of) a preservation evidence, any backup copies of the PSP private signing keys shall be protected to ensure its integrity and confidentiality by the secure cryptographic device before being stored outside that device.
   - OVR-7.5-08 A PSP's private signing key shall only be exported and imported into a different secure cryptographic device where this export and import are implemented securely and in accordance with the certification of those devices.
   - (7) 7.8 Network security  
   - OVR-7.8-03 The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 [1] shall be performed at least once per quarter.
   - OVR-7.8-04 The penetration test requested by REQ-7.8-17X of ETSI EN 319 401 [1] shall be performed at least once per year.
   - OVR-7.8-05 Firewalls shall be configured to prevent all protocols and accesses not required for the operation of the PSP.
   - (8) 7.14 Cryptographic monitoring  
   - OVR-7.14-03A The evaluation of the cryptographic algorithms in OVR-7.14.01 and OVR-7.14.02 shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [8].
   - NOTE void.
   - (9) 7.12 TSP termination and termination plans  
   - OVR-7.12-01A The TSP's termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.2].
   - (10) 7.17 Supply chain  
   - OVR-7.17-01 The requirements specified in ETSI EN 319 401 [1], clause 7.14 shall apply.
   - (11) Annex A (normative): Qualified preservation service for QES as defined by article 34 of the Regulation (EU) No 910/2014  
   - OVR-A-02 [PDS][PDS+PGD]
   - (a) the preservation service shall preserve all information needed to check the qualified status of the electronic signature or seal that would not be publicly available until the end of the preservation period  
   - (b) the preservation service shall ensure that, at any given time during the preservation period, the information preserved is such that, when provided as input to the process specified in clause 4.4 of ETSI TS 119 172-4 [9], the output of this process clearly determines whether or not the digital signature or seal was, at the time of its preservation, technically suitable to implement an EU qualified electronic signature or EU qualified electronic seal.  
   - OVR-A-03 [PDS][PDS+PGD] Time-stamps used within the preservation evidence shall be qualified time-stamps in accordance with Regulation (EU) No 910/2014 [i.2].

2. For ETSI TS 119 172-4
   (1) 2.1 Normative references:
   - [1] ETSI EN 319 102-1 V1.4.1 (2024-06) 'Electronic Signatures and Trust Infrastructures (ESI)
   - Procedures for Creation and Validation of AdES Digital Signatures
   - Part 1: Creation and Validation'.
   - All references to 'ETSI TS 119 102-1 [1]' shall be understood as references to 'ETSI EN 319 102-1 [1]'.
   - [2] ETSI TS 119 612 (V2.3.1) 'Electronic Signatures and Infrastructures (ESI)
   - Trusted Lists'.
   - [13] ETSI TS 119 101 V1.1.1 (2016-03) 'Electronic Signatures and Infrastructures (ESI)
   - Policy and security requirements for applications for signature creation and signature validation'.
   - (2) 4.2 Validation constraints and validation procedures, requirement REQ-4.2-03, section 'X.509 validation constraints', point c):  
   - (i) If an end-entity certificate represents a trust anchor, the RevocationCheckingConstraints shall not be used.
   - (ii) If an end-entity certificate does not represent a trust anchor, the RevocationCheckingConstraints shall be set to 'eitherCheck' as defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.1.
   - (iii) If an end-entity certificate represents a trust anchor, the RevocationFreshnessConstraints defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.2 shall not be used.
   - (iv) If an end-entity certificate does not represent a trust anchor, the RevocationFreshnessConstraints defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.2 shall be used with a maximum value of 0 for the signing certificate, ensuring that the revocation information is only accepted if it has been issued after the best signature time. No value shall be set for the RevocationFreshnessConstraints for certificates other than the signing certificate, including certificates supporting time-stamps.
   - (3) 4.3 Requirements on signature validation and applicability rules checking practices  
   - REQ-4.3-02 Signature validation applications shall be compliant with ETSI TS 119 101 [13].
   - (4) 4.4 Technical applicability (rules) checking process  
   - REQ-4.4.2-03 If any of the checks specified in REQ-4.4.2-01 fails, then:
   - (a) the process stops
   - (b) the signature shall be technically determined as indeterminate, i.e. as neither an EU qualified electronic signature, nor as an EU qualified electronic seal
   - (c) the above result and the results of processes of all the intermediate processes shall be reflected in the signature applicability rules checking report.

---

# eIDAS - Qualified electronic time stamps
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-timestamps/

---
id: implementing-acts-qualified-timestamps
title: eIDAS - Qualified electronic time stamps
description: Understand the EU Implementing Acts on qualified electronic time stamps.
sidebar_label: Qualified time stamps
keywords: [Implementing Acts, eIDAS, qualified time stamps, temporal verification, trust services]
slug: /implementing-acts-qualified-timestamps/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on qualified electronic time stamps."/>
</head>

Commission Implementing **Regulation (EU) 2025/1929** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1929/oj).


### Article 1  

The reference standards and specifications referred to in Article 42(2) of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.  

### Article 2  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 September 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX - List of reference standards and specifications for qualified time stamp services  

The standards ETSI EN 319 421 V1.3.1 (1) ('ETSI EN 319 421 ') and ETSI EN 319 422 V1.1.1 (2) ('ETSI EN 319 422 ') apply with the following adaptations:  

1. For ETSI EN 319 421
   (1) 2.1 Normative references:
   - [3] ISO/IEC 15408:2022 (parts 1 to 5) 'Information security, cybersecurity and privacy protection – Evaluation criteria for IT security'.
   - [4] ETSI EN 319 401 V3.1.1 (2024-06) 'Electronic Signatures and Infrastructures (ESI)
   - General Policy Requirements for Trust Service Providers'.
   - [5] ETSI EN 319 422 V1.1.1 (2016-03) 'Electronic Signatures and Infrastructures (ESI)
   - Time-stamping protocol and time-stamp token profiles'.
   - [6] void.
   - [9] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by the European Union Agency for Cybersecurity ('ENISA') (3).
   - [10] Commission Implementing Regulation (EU) 2024/482 (4) of 31 January 2024 laying down rules for the application of Regulation (EU) 2019/881 of the European Parliament and of the Council as regards the adoption of the European Common Criteria-based cybersecurity certification scheme ('EUCC').
   - [11] Commission Implementing Regulation (EU) 2024/3144 (5) of 18 December 2024 amending Implementing Regulation (EU) 2024/482 as regards applicable international standards and correcting that Implementing Regulation.
   - (2) 3.1 Terms  
   - certificate validity period: time interval from notBefore to notAfter inclusive, during which the certification authority ('CA') warrants that it will maintain information about the status of the certificate.
   - (3) 3.3 Abbreviations  
   - EUCC European Common Criteria-based cybersecurity certification scheme
   - (4) 6.2 Trust Service Practice Statement  
   - OVR-6.2-03 The TSA shall include statements about the availability of its time-stamping service in its TSA disclosure statement.
   - (5) 7.3 Personnel security  
   - OVR-7.3-02 The TSA's personnel in trusted roles, and if applicable its subcontractors in trusted roles, shall be able to fulfil the requirement of 'expert knowledge, experience and qualifications' through formal training and credentials, or actual experience, or a combination of the two.
   - OVR-7.3-03 Compliance with OVR-7.3-02 shall include regular updates (at least every 12 months) on new threats and current security practices.
   - (6) 7.6.2 TSU key generation  
   - TIS-7.6.2-03 The generation of the TSU's key(s) shall be carried out within a secure cryptographic device which is a trustworthy system certified in accordance with:
   - (a) Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 [3] or in Common Criteria for Information Technology Security Evaluation, version CC:2022, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher  
   - or
   - (b) EUCC [10][11], and certified to EAL 4 or higher  
   - or
   - (c) until 31.12.2030, FIPS PUB 140-3 [7] level 3.  
   - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
   - If the secure cryptographic device benefits from an EUCC [10][11] certification, then this device shall be configured and used in accordance with that certification.
   - TIS-7.6.2-04 void.
   - NOTE 3 void.
   - TIS-7.6.2-05A The TSU key generation algorithm, the resulting signing key length and signature algorithm used for signing time-stamps and for signing TSU public key certificates respectively shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group [9] and published by ENISA.
   - NOTE 4 void.
   - TIS-7.6.2-06 A TSU's signing key shall only be exported and imported into a different secure cryptographic device where this export and import are implemented securely and in accordance with the certification of those devices.
   - (7) 7.6.3 TSU private key protection  
   - TIS-7.6.3-02 The TSU private key shall be held and used within a secure cryptographic device which is a trustworthy system certified in accordance with:
   - (a) Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 [3] or in Common Criteria for Information Technology Security Evaluation, version CC:2002, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher  
   - or
   - (b) the European Common Criteria-based cybersecurity certification scheme (EUCC) [10][11], and certified to EAL 4 or higher  
   - or
   - (c) until 31.12.2030, FIPS PUB 140-3 [7] level 3.  
   - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
   - If the secure cryptographic device benefits from an EUCC [10][11] certification, then this device shall be configured and used in accordance with that certification.
   - TIS-7.6.3-03 void.
   - NOTE 2 void.
   - (8) 7.6.7 End of TSU key life cycle  
   - TIS-7.6.7-03A The expiration date for TSU's private keys shall be compliant with the Agreed Cryptographic Mechanisms [9].
   - NOTE 1 void.
   - (9) 7.10 Network security  
   - OVR-7.10-05 The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 [1] shall be performed at least once per quarter.
   - OVR-7.10-06 The penetration test requested by REQ-7.8-17X of ETSI EN 319 401 [1] shall be performed at least once per year.
   - OVR-7.10-07 Firewalls shall be configured to prevent all protocols and accesses not required for the operation of the TSA.
   - (10) 7.14 TSA termination and termination plans  
   - OVR-7.14-01A The TSP's termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.4].

2. For ETSI EN 319 422
   (1) 2.1 Normative references; [5] void.; [6] void.; [8] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms'.; [9] RFC 9110 HTTP Semantics.
   (2) 4.1.3 Hash algorithms to be used; The following clause shall apply:
   - Hash algorithms used to hash the information to be time-stamped, the expected duration of the time stamp and selected hash functions versus time shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [8].
   - NOTE void.
   - (3) 4.2.3 Algorithms to be supported  
   - The following clause shall apply:
   - Time-stamp token signature algorithms to be supported shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [8].
   - NOTE void.
   - (4) 4.2.4 Key lengths to be supported  
   - The following clause shall apply:
   - Signature algorithm key lengths for the selected signature algorithm shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA.
   - NOTE void.
   - (5) 5.1.3 Algorithms to be supported  
   - The following clause shall apply:
   - Hash algorithms for the time-stamp data to be supported, the expected duration of the time-stamp and selected hash functions versus time shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [8].
   - NOTE void.
   - (6) 5.2.3 Algorithms to be used  
   - The following clause shall apply:
   - Hash algorithms used to hash the information to be time-stamped and time-stamp token signature algorithms shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [8].
   - NOTE void.
   - (7) 6.3 Key lengths requirements  
   - The following clause shall apply:
   - The key length for the selected signature algorithm of the TSU certificate shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [8].
   - NOTE void.
   - (8) 6.5 Algorithm requirements  
   - The following clause shall apply:
   - The TSU public key and the TSU certificate signature shall use the algorithms that are compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [8].
   - NOTE void.
   - (9) 7 Profiles for the transport protocols to be supported  
   - The time-stamping client and the time-stamping server shall support the time-stamping protocol via HTTPS [9] as defined in clause 3.4 of IETF RFC 3161 [1].
   - (10) 8 Object identifiers of the cryptographic algorithms  
   - The following clause shall apply:
   - The TSU public key and the TSU certificate signature shall use algorithms in compliance with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [8].
   - (11) 9.1 Regulation compliance statement  
   - If a time-stamp token is declared by the TSA to be a qualified electronic time stamp in accordance with Regulation (EU) No 910/2014 [i.2], it shall contain one instance of the qcStatements extension in the time stamp token extension field with the syntax as defined in IETF RFC 3739 [i.3], clause 3.2.6.
   - The qcStatements extension shall contain one instance of the statement 'esi4-qtstStatement-1' as defined in Annex B.
   - The extension qcStatements shall not be marked as critical.

---

# eIDAS - Qualified trust service applications
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-trust-apps/

---
id: implementing-acts-qualified-trust-apps
title: eIDAS - Qualified trust service applications
description: Understand the EU Implementing Acts on qualified trust service applications.
sidebar_label: Qualified trust service apps
keywords: [Implementing Acts, eIDAS, qualified trust services, trust service applications, trust services]
slug: /implementing-acts-qualified-trust-apps/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on qualified trust service applications."/>
</head>

Commission Implementing **Regulation (EU) 2025/1572** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1572/oj).


### Article 1: Verification methodology  

1. Supervisory bodies shall establish a methodology for verifying compliance of trust service providers having notified their intention to start providing a qualified trust service with the requirements laid down in Regulation (EU) No 910/2014 and Article 21(2) of Directive (EU) 2022/2555 of the European Parliament and of the Council (5).  

2. The verification methodology shall include procedures and processes for involving competent authorities designated or established pursuant to Article 8(1) of Directive (EU) 2022/2555, which carry out supervisory actions to verify the trust service provider's compliance with the requirements laid down in Article 21 of Directive (EU) 2022/2555.  

### Article 2: Transparency  

Supervisory bodies shall make the following information publicly available:  

1. contact details of the supervisory body;  

2. the communication channels to be used when trust service providers submit a notification of the intention to start providing a qualified trust service;  

3. the list of documentation that trust service providers are to provide as a part of a notification of intention to start providing a qualified trust service;  

4. the procedures for handling complaints relating to the process of verification of compliance of trust service providers having notified their intention to start providing a qualified trust service with the requirements laid down in Regulation (EU) No 910/2014 and Article 21(2) of Directive (EU) 2022/2555;  

5. a general description of the methodology referred to in Article 1.  

### Article 3: Trust service provider notifications  

Trust service providers shall provide at least the following information in their notifications of intention to start providing a qualified trust service:  

1. where the trust service provider is a legal person, its name and, where applicable, a registration number, name of the Member State where it is established and the name of the person(s) signing or submitting the notification on behalf of the legal person;  

2. where the trust service provider is a natural person, their name and personal identification number, and in the absence thereof their date of birth and the type and number of their identity document;  

3. the telephone number, email address and postal address of the trust service provider;  

4. the Uniform Resource Identifiers (URI) where users can obtain additional information concerning that trust service provider, including the practice statements and policies, the general terms and conditions and the customer care policies that apply to the trust service being notified;  

5. the risk analysis underlying the measures referred to in Article 24(2), point (fa) of Regulation (EU) No 910/2014, and the risk analysis underlying the measures referred to in Article 21 of Directive (EU) 2022/2555;  

6. each qualified trust service which the trust service provider intends to start providing;  

7. for each trust service that the trust service provider intends to start providing as a qualified trust service:  

   - one or more identifiers and, where applicable, certificates of the trust service, for inclusion in the national trusted list in accordance with the implementing acts adopted pursuant to Article 22(5) of Regulation (EU) No 910/2014;  

   - the intended start date of the provision of the trust service;  

   - the conformity assessment reports(s) of the trust service and the contact details of the conformity assessment body;  

   - where applicable, technical reports supporting the conformity assessment report.  
  

8. the termination plan referred to in Article 24(2), point (i) of Regulation (EU) No 910/2014.  

### Article 4: Verifications by supervisory bodies  

1. To determine whether the trust service provider and the qualified trust service it intends to provide comply with the requirements of Regulation (EU) No 910/2014 and Article 21 of Directive (EU) 2022/2555, supervisory bodies shall analyse the trust service provider's provided information and may, in addition to any measures described in the methodology established pursuant to Article 1, perform on-site verifications, as well as interviews with representatives of the trust service provider and the conformity assessment body.  

2. Supervisory bodies shall verify at least the following elements:  

   (a) the submitted conformity assessment report sufficiently demonstrates compliance of the trust service provider and the qualified trust service it intends to provide with the requirements set out in Regulation (EU) No 910/2014 and in Article 21 of Directive (EU) 2022/2555;  

   (b) the submitted conformity assessment report complies with the requirements set out in the implementing acts adopted pursuant to Article 20(4) of Regulation (EU) No 910/2014;  

   (c) any information contained in the submitted conformity assessment report indicating non-conformity with the requirements of Regulation (EU) No 910/2014;  

   (d) any additional information considered necessary to verify compliance with the requirements laid down in Regulation (EU) No 910/2014 and in Article 21 of Directive (EU) 2022/2555.  

### Article 5: Entry into force and applicability  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall apply from 19 August 2026.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 July 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

---

# eIDAS - Qualified trust service providers
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-trust-service-providers/

---
id: implementing-acts-qualified-trust-service-providers
title: eIDAS - Qualified trust service providers
description: Understand the EU Implementing Acts on requirements for qualified trust service providers under eIDAS.
sidebar_label: Qualified trust service providers
keywords: [Implementing Acts, eIDAS, qualified trust service providers, trust services]
slug: /implementing-acts-qualified-trust-service-providers/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on requirements for qualified trust service providers under eIDAS."/>
</head>

Commission Implementing **Regulation (EU) 2025/2530** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/2530/oj).

### Article 1: Notifications to the supervisory body

1. In notifications referred to in Article 24(2), point (a), of Regulation (EU) No 910/2014, qualified trust service providers shall cover at least significant changes to all of the following elements:

   (a) the service descriptions, policies, practice statements or associated terms and conditions;

   (b) the technical architecture of the qualified trust services, or any trustworthy systems or products referred to in Article 24(2), points (e) and (f), of Regulation (EU) No 910/2014;

   (c) the hosting of any technical components required for the provision of the qualified trust services, or the technical services pertaining to these technical components;

   (d) the use of cryptographic techniques or cryptographic materials in the provision of the qualified trust services;

   (e) the registration and identification procedures;

   (f) the organisational structure or governance of the trust service provider;

   (g) the termination plan;

   (h) financial resources and liability insurance referred to in Article 24(2), point (c) of Regulation (EU) No 910/2014;

   (i) elements with an impact on the content of the corresponding national trusted list;

   (j) third parties involved in the provision of the qualified trust services, including subcontractors or service providers, or to contractual terms with these third parties.

2. Notifications referred to in paragraph 1 shall include:

   (a) description of the change;

   (b) planned date and time of the change;

   (c) reasons for the change and, where applicable, evidence for the reasons;

   (d) where applicable, updated documents.

### Article 2: Risk management framework

The requirements laid down in Article 2, Article 3 and Article 4 of Commission Implementing Regulation 2025/2160 shall apply mutatis mutandis to qualified trust service providers with regard to the requirement to have a risk management framework laid down in Article 24(2), point (fa), of Regulation (EU) No 910/2014.

### Article 3: Termination plan

1. Qualified trust service providers shall establish a termination plan for each qualified trust service they provide, that establishes the necessary provisions for the effective and correct application of the termination of the service or parts thereof, for the purposes of ensuring continuity of the service and of providing evidence in legal proceedings, including how information is kept accessible in accordance with Article 24(2), point (h) of Regulation (EU) No 910/2014.

2. Qualified trust service providers shall set up controls and procedures to ensure the availability for internal use of documented policies, practices, procedures, third party arrangements and any other documents required to ensure the effectiveness of the termination plan.

3. Qualified trust service providers shall set up controls and procedures to ensure that their termination plan and any document associated with it are up to date.

4. Qualified trust service providers shall review the termination plan, and any associated documents, at least every two years and as part of the implementation of any changes to the qualified trust service provider or to the qualified trust services it provides and update the termination plan accordingly.

5. Qualified trust service providers shall manage the risks that are specific to the termination of the provision of their qualified trust services as part of the risk management framework referred to in Article 2.

6. Qualified trust service providers shall ensure maintenance of sufficient financial resources or obtain appropriate insurance to cover the costs required to effectively execute the termination plan, including in case of unanticipated termination.

7. Qualified trust service providers shall ensure that the termination plan specifies appropriate procedures and arrangements for at least the following:

   (a) the termination of the qualified trust services, including, where relevant, in relation to the decommissioning of any technical components or services used to provide the concerned qualified trust service;

   (b) a timely update of the related service entries as listed in the corresponding national trusted list;

   (c) the revocation of any existing and unrevoked qualified certificates issued by them before concluding the termination of the qualified trust service for the issuance of qualified certificates, unless all relevant obligations of the terminated qualified trust services are transferred to another qualified trust service provider in a manner that ensures that the qualified certificates and all related services continue to meet the requirements of Regulation (EU) No 910/2014 in an uninterrupted manner;

   (d) ensuring that after the termination of the provision of qualified trust services, no further qualified trust service output can be created or enabled through the use of the signature or seal creation data of the qualified trust service provider;

   (e) ensuring the accessibility and usability of all relevant records held by the qualified trust service provider;

   (f) addressing scenarios of anticipated, unanticipated, partial and complete termination;

   (g) ensuring that the interests of the subscribers of the terminated qualified trust services are safeguarded upon termination, including continued maintenance of information required for the subscribers to verify the legal validity of the outputs of the qualified trust services;

   (h) where applicable, specifying any arrangements made to allow provision of alternative qualified trust services by other qualified trust service providers for the purpose of minimising disruptions for the subscribers;

   (i) providing notices to parties known to the qualified trust service provider that will be directly or indirectly affected by the termination.

8. The procedures and arrangements referred to in paragraph 7, point (e) shall ensure the accessibility and usability of the records necessary to:

   (a) provide evidence in relation to the compliance of the qualified trust services with Regulation (EU) No 910/2014 and Regulation (EU) 2016/679;

   (b) ensure continuity of the qualified trust services, as regards the signature or seal validation data of the qualified trust service provider and as regards enabling continued maintenance of information required to verify the correctness of previously created trust service outputs.

9. Qualified trust service providers shall ensure that the termination plan and records associated with it include at least the following documentation:

   (a) procedures for the termination of qualified trust services;

   (b) procedures for and records of regular review of the termination plan referred to in paragraph 4;

   (c) audit reports relating to the termination plan;

   (d) termination arrangements with third parties involved in the provision of the qualified trust services that are to be terminated;

   (e) terms and conditions, practices and policy documents relating to the qualified trust services.

### Article 4: Reference standards and specifications for qualified trust services

1. In addition to the requirements set out in Article 1, Article 2 and Article 3, the reference standards and specifications referred to in Article 24(5) of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.

2. Where there are discrepancies between the reference standards and specifications established by the Implementing Regulations and as set out in the Annex to this Regulation and the requirements set out in Article 1, Article 2 and Article 3 of this Regulation, the requirements set out in Article 1, Article 2 and Article 3 of this Regulation shall prevail.

### Article 5: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 16 December 2025.

For the Commission

The President

Ursula VON DER LEYEN


---

# eIDAS - Qualified certificates for website authentication
Source: https://docs.igrant.io/regulations/implementing-acts-qualified-website-auth-certs/

---
id: implementing-acts-qualified-website-auth-certs
title: eIDAS - Qualified certificates for website authentication
description: Understand the EU Implementing Acts on qualified certificates for website authentication under eIDAS.
sidebar_label: Qualified certificates for website authentication
keywords: [Implementing Acts, eIDAS, qualified certificates, website authentication, QWACs]
slug: /implementing-acts-qualified-website-auth-certs/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on qualified certificates for website authentication under eIDAS."/>
</head>

Commission Implementing **Regulation (EU) 2025/2527** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/2527/oj).

### Article 1: Reference standards

The reference standards referred to in Article 45(2) of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.

### Article 2: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

It shall apply from 6 January 2027.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 16 December 2025.

For the Commission

The President

Ursula VON DER LEYEN


---

# eIDAS - Recognition of qualified validation services
Source: https://docs.igrant.io/regulations/implementing-acts-recognition-validation/

---
id: implementing-acts-recognition-validation
title: eIDAS - Recognition of qualified validation services
description: Learn about the EU Implementing Acts on recognition of qualified validation services.
sidebar_label: Recognition of validation services
keywords: [Implementing Acts, eIDAS, validation services, cross-border trust, recognition, trust services]
slug: /implementing-acts-recognition-validation/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on recognition of qualified validation services."/>
</head>

Commission Implementing **Regulation (EU) 2025/1942** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1942/oj).


### Article 1: Reference standards and specifications  

The reference standards and specifications referred to in Article 33(2) and Article 40 of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.  

### Article 2: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 September 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX  

### List of reference standards and specifications for qualified validation services for qualified electronic signatures and for qualified validation services for qualified electronic seals  

The standards ETSI TS 119 441 V1.2.1 (2023-10) (1) ('ETSI TS 119 441 '), and ETSI TS 119 172-4 V1.1.1 (2021-05) (2) ('ETSI TS 119 172-4') apply with the following adaptations:  

1. For ETSI TS 119 441
   (1) 2.1; Normative references; [1] ETSI TS 119 101 V1.1.1 (2016-03) 'Electronic Signatures and Infrastructures (ESI); Policy and security requirements for applications for signature creation and signature validation'.; [2] ETSI EN 319 401 V3.1.1 (2024-06) 'Electronic Signatures and Infrastructures (ESI); General Policy Requirements for Trust Service Providers'.; [3] ETSI EN 319 102-1 V1.4.1 (2024-06) 'Electronic Signatures and Infrastructures (ESI); Procedures for Creation and Validation of AdES Digital Signatures; Part 1: Creation and Validation'.; [4] ISO/IEC 15408-1:2022 – Information security, cybersecurity and privacy protection – Evaluation criteria for IT security.; [5] void.; [6] FIPS PUB 140-3 (2019) 'Security Requirements for Cryptographic Modules'.; [7] Commission Implementing Regulation (EU) 2024/482 (3) laying down rules for the application of Regulation (EU) 2019/881 of the European Parliament and of the Council as regards the adoption of the European Common Criteria-based cybersecurity certification scheme (EUCC).; [8] ETSI TS 119 172-4 V1.1.1 (2021-05) 'Electronic Signatures and Infrastructures (ESI); Signature Policies; Part 4: Signature applicability rules (validation policy) for European qualified electronic signatures/seals using trusted lists'.; [9] ETSI TS 119 102-2 V1.4.1 (2023-06) 'Electronic Signatures and Infrastructures (ESI); Procedures for Creation and Validation of AdES Digital Signatures; Part 2: Signature Validation Report'.; [10] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by the European Union Agency for Cybersecurity ('ENISA') (4).; [11] Commission Implementing Regulation (EU) 2024/3144 (5) amending Implementing Regulation (EU) 2024/4822 as regards applicable international standards and correcting that Implementing Regulation.; [12] ETSI EN 319 411-1 'Electronic Signatures and Infrastructures (ESI); Policy and security requirements for Trust Service Providers issuing certificates; Part 1: General requirements'
   (2) 2.2 Informative references; [i.11] void.
   (3) 3.3 Abbreviations; EUCC European Common Criteria-based cybersecurity certification scheme
   (4) 4.3.3 Process; NOTE 10 See ETSI EN 319 102-1 [3] for guidance and ETSI TS 119 172-4 [8] for additional guidance for the EU qualified signature or seal case.
   (5) 6.1 Signature Validation Service practice statement; OVR-6.1-02 The SVS practice statement shall be structured as per Annex A.; OVR-6.1-03 The SVS practice statement shall list or make reference to the supported SVS policies (e.g. through OIDs) and briefly describe them.
   (6) 6.3 Information security policy; OVR-6.3-02 The security policy shall document the security and privacy controls implemented to protect personal data.
   (7) 7.2 Human resources; OVR-7.2-02 SVSP's personnel in trusted roles, and if applicable its subcontractors in trusted roles, shall be able to fulfil the requirement of 'expert knowledge, experience and qualifications' through formal training and credentials, or actual experience, or a combination of the two.; OVR-7.2-03 Compliance with OVR-7.2-02 shall include regular updates (at least every 12 months) on new threats and current security practices.
   (8) 7.5 Cryptographic controls; OVR-7.5-02 [CONDITIONAL] When validation reports are signed, the SVSP public signing certificate corresponding to the SVSP private signing key shall be issued, by a trustworthy CA, in compliance with the NCP+ certificate policy as specified in ETSI EN 319 411-1 [12]. It should be issued in compliance with an appropriate certificate policy specified in ETSI EN 319 411-2 [i.17].; OVR-7.5-03 [CONDITIONAL] When validation reports are signed, the SVSP private signing key shall be held and used within a secure cryptographic device which is a trustworthy system certified in accordance with:
   - (a) Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 [4] or in Common Criteria for Information Technology Security Evaluation, version CC:2022, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher  
   - or
   - (b) EUCC [7][11] and certified to EAL 4 or higher  
   - or
   - (c) until 31.12.2030, FIPS PUB 140-3 [6] level 3.  
   - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
   - If the secure cryptographic device benefits from an EUCC [7][11] certification, then this device shall be configured and used in accordance with that certification.
   - OVR-7.5-04 void.
   - OVR-7.5-06 A SVSP's private signing key shall only be exported and imported into a different secure cryptographic device where this export and import are implemented securely and in accordance with the certification of those devices.
   (9) 7.7 Operation security  
   - OVR-7.7-02 To ensure that the systems on which the application is developed apply appropriate security measures and adapt to specific application environments, the SVA shall use application environment that is maintained with up-to-date security fixes.
   - OVR-7.7-03 The following requirements specified in ETSI TS 119 101 [1], clause 5.2 shall apply to the SVA: GSM 1.3.
   (10) 7.8 Network security  
   - OVR-7.8-02 If remote access to systems storing or processing confidential data is allowed, a formal policy shall be adopted and described as part of elements required by OVR-6.3-02.
   - OVR-7.8-04 The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 [1] shall be performed at least once per quarter.
   - OVR-7.8-05 The penetration test requested by REQ-7.8-17X of ETSI EN 319 401 [1] shall be performed at least once per year.
   - OVR-7.8-06 Firewalls shall be configured to prevent all protocols and accesses not required for the operation of the SVSP.
   (11) 7.12 Signature Validation Service provisioning termination and termination plans  
   - OVR-7.12-02 The TSP's termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.1].
   (12) 7.14 Supply chain  
   - OVR-7.14-01 The requirements specified in ETSI EN 319 401 [2], clause 7.14 shall apply.
   (13) 8.1 Signature validation process  
   - VPR-8.1-07 The validation application (SVA) shall comply with the requirements in ETSI TS 119 101 [1], clause 7.4 SIA 1 to SIA 4.
   - VPR-8.1-11 [CONDITIONAL] When the SVS aims to validate qualified electronic signatures or qualified electronic seals such in accordance with Article 32(1) (or Article 40 respectively) of Regulation (EU) No 910/2014 [i.1], validation process shall follow the requirements of ETSI TS 119 172-4 [8].
   (14) 8.2 Signature validation protocol  
   - SVP-8.2-03 The signature validation response shall bear the OID of the SVS policy.
   (15) 8.4 Signature validation report  
   - SVR-8.4-02 The validation report shall conform to ETSI TS 119 102-2 [9].
   - SVR-8.4-07 [CONDITIONAL] When a signature validation policy is not completely processed by the SVS, the report shall, in addition to reporting on validated constraints, report on constraints that have been ignored or overridden.
   - SVR-8.4-15 The validation report shall clearly indicate the origin of each PoE (from within the signature, from the client, from the server).
   - SVR-8.4-16 The validation report shall bear a validation report signature, which shall be the SVSP's digital signature.
   - SVR-8.4-17 [CONDITIONAL] When validation reports are signed, the format and the target of the signature shall conform to ETSI TS 119 102-2 [9].
   (16) 9 Framework for definition of validation service policies built on a trust service policy defined in the present document:  
   - OVR-9-05 [CONDITIONAL] When building a SVS policy on a trust service policy defined in the present document, a risk assessment shall be carried out to evaluate business requirements and determine the security requirements to be included in the policy for the stated community and applicability.
   - OVR-9-06 [CONDITIONAL] When building a SVS policy on a trust service policy defined in the present document, the policy shall be approved and modified in accordance with a defined review process, including responsibilities for maintaining the policy.
   - OVR-9-07 [CONDITIONAL] When building a SVS policy on a trust service policy defined in the present document, a defined review process shall exist to ensure that the policy is supported by the practices statements.
   - OVR-9-08 [CONDITIONAL] When building a SVS policy on a trust service policy defined in the present document, the TSP shall make available the policies supported by the TSP to its user community.
   - OVR-9-09 [CONDITIONAL] When building a SVS policy on a trust service policy defined in the present document, revisions to policies supported by the TSP shall be made available to subscribers.
   (17) Annex B (normative) Qualified Validation Service for QES as defined by Article 33 of Regulation (EU) No 910/2014:  
   - VPR-B-02 [CONDITIONAL] If the SVSP is a QSVSP the implementation shall comply with ETSI TS 119 172-4 [8].
   - NOTE 2 void.
   - OVR-B-04 [CONDITIONAL] If the SVSP is a QSVSP, the tests in OVR-B-03 shall check different use-cases, positive and negative ones.
   - VPR-B-11 [CONDITIONAL] If the SVSP is a QSVSP, the SVSP shall control the hash computation (either perform the computation on the server side or control the client if it is allowed on the client side).
   - NOTE 5 void.
   - NOTE 6 void.
   - VPR-B-15 [CONDITIONAL] If the SVSP is a QSVSP, in order to satisfy VPR-B-13 to VPR-B-14 the validation report shall comply with ETSI TS 119 102-2 [9].
   - VPR-B-16 [CONDITIONAL] If the SVSP is a QSVSP, the implementation shall comply with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [10] for use of suitable cryptographic techniques when providing qualified validation services for QES.
   (18) Annex C (informative) Mapping of requirements to Regulation (EU) No 910/2014, section 'Providing validation in compliance with Article 32(1)', second paragraph:  
   - To ensure that all conditions required by Articles 32(1) and 40 of Regulation (EU) No 910/2014 [i.1] are verified, a correct validation algorithm is needed. It provides the same deterministic result for a signature or seal submitted to validation. The signature validation policy is crucial for this purpose. ETSI TS 119 172-4 [8], based on the validation algorithm specified in ETSI EN 319 102-1 [3] has been issued with this perspective.

2. For ETSI TS 119 172-4
   (1) 2.1 Normative references:
   - [1] ETSI EN 319 102-1 V1.4.1 (2024-06) 'Electronic Signatures and Trust Infrastructures (ESI)
   - Procedures for Creation and Validation of AdES Digital Signatures
   - Part 1: Creation and Validation'.
   - All references to 'ETSI TS 119 102-1 [1]' shall be understood as references to 'ETSI EN 319 102-1 [1]'.
   - [2] ETSI TS 119 612 V2.3.1 (2024-11) 'Electronic Signatures and Infrastructures (ESI)
   - Trusted Lists'.
   - [13] ETSI TS 119 101 V1.1.1 (2016-03) 'Electronic Signatures and Infrastructures (ESI)
   - Policy and security requirements for applications for signature creation and signature validation'.
   - (2) 4.2 Validation constraints and validation procedures, requirement REQ-4.2-03, section 'X.509 validation constraints', point (c):  
   - (i) If an end-entity certificate represents a trust anchor, the RevocationCheckingConstraints shall not be used.
   - (ii) If an end-entity certificate does not represent a trust anchor, the RevocationCheckingConstraints shall be set to 'eitherCheck' as defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.1.
   - (iii) If an end-entity certificate represents a trust anchor, the RevocationFreshnessConstraints defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.2 shall not be used.
   - (iv) If an end-entity certificate does not represent a trust anchor, the RevocationFreshnessConstraints defined in ETSI TS 119 172-1 [3], clause A.4.2.1, table A.2 rows (m)2.2 shall be used with a maximum value of 24 hours for the signing certificate. No value shall be set for the RevocationFreshnessConstraints for certificates other than the signing certificate, including certificates supporting time-stamps.
   - (3) 4.4 Technical applicability (rules) checking process  
   - REQ-4.4.2-03 If any of the checks specified in REQ-4.4.2-01 fails, then:
   - (a) the process stops  
   - (b) the signature shall be technically determined as indeterminate, i.e. as neither an EU qualified electronic signature, nor as an EU qualified electronic seal  
   - (c) the above result and the results of processes of all the intermediate processes shall be reflected in the signature applicability rules checking report.  

---

# eIDAS - Reference standards and validation procedures
Source: https://docs.igrant.io/regulations/implementing-acts-reference-standards/

---
id: implementing-acts-reference-standards
title: eIDAS - Reference standards and validation procedures
description: Understand the EU Implementing Acts on reference standards and validation procedures for qualified trust services.
sidebar_label: Reference standards & validation
keywords: [Implementing Acts, eIDAS, reference standards, validation procedures, trust services, qualified trust services]
slug: /implementing-acts-reference-standards/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on reference standards and validation procedures for qualified trust services."/>
</head>

Commission Implementing **Regulation (EU) 2025/1943** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1943/oj).


### Article 1: Reference standards and specifications for qualified certificates for electronic signatures and electronic seals  

1. The reference standards and specifications referred to in Article 28(6) of Regulation (EU) No 910/2014 are set out in Annex I to this Regulation.  

2. The reference standards and specifications referred to in Article 38(6) of Regulation (EU) No 910/2014 are set out in Annex II to this Regulation.  

### Article 2: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 September 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX I  

### List of reference standards and specifications for qualified certificates for electronic signatures  

The standards ETSI EN 319 411-2 V2.6.1 ('ETSI EN 319 411-2'), ETSI EN 319 412-1 V1.6.1 ('ETSI EN 319 412-1'), ETSI EN 319 412-2 V2.4.1 ('ETSI EN 319 412-2'), and ETSI EN 319 412-5 V2.5.1 ('ETSI EN 319 412-5') apply with the following adaptations:  

1. For ETSI EN 319 411-2
   (1) 2.1 Normative references; [1] ETSI EN 319 401 V3.1.1 (2024-06) 'Electronic Signatures and Trust Infrastructures (ESI); General Policy Requirements for Trust Service Providers'.; [2] ETSI EN 319 411-1 V1.5.1 (2025-04) 'Electronic Signatures and Trust Infrastructures (ESI); Policy and security requirements for trust service providers issuing certificates; Part 1: General requirements', with the following adaptations:
   - Clause 2.1 Normative references of ETSI EN 319 411-1 V1.5.1 shall be amended as follows:
   - [9] ETSI EN 319 401 V3.1.1 (2024-06) 'Electronic Signatures and Trust Infrastructures (ESI)
   - General Policy Requirements for Trust Service Providers'.
   - [10] ETSI EN 319 412-2 V2.4.1 'Electronic Signatures and Infrastructures (ESI)
   - Certificate Profiles
   - Part 2: Certificate profile for certificates issued to natural persons'.
   - [14] ETSI EN 319 412-1 V1.6.1 'Electronic Signatures and Infrastructures (ESI)
   - Certificate Profiles
   - Part 1: Overview and common data structures'.
   - [3] ETSI EN 319 412-5 V2.5.1 'Electronic Signatures and Trust Infrastructures (ESI)
   - Certificate Profiles
   - Part 5: QCStatements'.
   - [5] ETSI EN 319 412-1 V1.6.1 'Electronic Signatures and Trust Infrastructures (ESI)
   - Certificate Profiles
   - Part 1: Overview and common data structures'.
   - [6] CEN/TS 419261:2015 'Security requirements for trustworthy systems managing certificates and time-stamps'.
   - [7] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by the European Union Agency for Cybersecurity ('ENISA') (1).
   - [8] Commission Implementing Regulation (EU) 2024/482 (2) laying down rules for the application of Regulation (EU) 2019/881 of the European Parliament and of the Council as regards the adoption of the European Common Criteria-based cybersecurity certification scheme (EUCC).
   - [9] Commission Implementing Regulation (EU) 2024/3144 (3) amending Implementing Regulation (EU) 2024/482 as regards applicable international standards and correcting that Implementing Regulation.
   - [10] ISO/IEC 15408:2022 (parts 1 to 5): 'Information security, cybersecurity and privacy protection – Evaluation criteria for IT security'.
   - [11] FIPS PUB 140-3 (2019) 'Security Requirements for Cryptographic Modules'.
   (2) 5.2 Certification Practice Statement Requirements  
   - OVR-5.2-02 The CP(s) identified by the TSP's documentation shall specify the requirements on certificate profiles to be used.
   (3) 5.3 Certificate Policy name and identification  
   - OVR-5.3-01 If any changes are made to a CP as described in clause 4.2.2 which affects the applicability, then the policy identifier shall be changed.
   (4) 6.1 Publication and repository responsibilities  
   - OVR-6.1-02 The information identified in DIS-6.1-04 of ETSI EN 319 411-1 [2] shall be publicly and internationally available.
   (5) 6.2.2 Initial identity validation  
   - REG-6.2.2-01A The collection of attributes and evidence on the subject's identity as well as their validation shall be as specified in accordance with the implementing acts adopted pursuant to Article 24(1c) of Regulation (EU) No 910/2014 [i.1].
   - REG-6.2.2-02 [QCP-n] and [QCP-n-qscd] The identity of the natural person and, if applicable, any specific attributes of the person, shall be verified in accordance with the implementing acts adopted pursuant to Article 24(1c) of Regulation (EU) No 910/2014 [i.1].
   - NOTE 1 void.
   (6) 6.3.3 Certificate issuance  
   - GEN-6.3.3-01 The requirements GEN-6.3.3-01 to GEN-6.3.3-10 identified in ETSI EN 319 411-1 [2], clause 6.3.3 shall apply.
   - GEN-6.3.3-02 [CONDITIONAL] If a certificate is issued to a natural person identified in association with the legal person, then the subject attributes identifying the organisation in the certificate shall represent the legal person or sub-entity of that legal person and the subject identifier in the certificate shall be the natural person.
   - GEN-6.3.3-03 The CP identifier shall be [CHOICE]:
   - (a) [QCP-n]  
   - as specified in clause 5.3, item (a), and/or
   - an OID, allocated by the TSP, other relevant stakeholder or further standardisation for a certificate policy enhancing the corresponding applicable policy requirements defined in the present document.
   - (b) [QCP-n-qscd]  
   - as specified in clause 5.3, item (c), and/or
   - an OID, allocated by the TSP, other relevant stakeholder or further standardisation for a certificate policy enhancing the corresponding applicable policy requirements defined in the present document.
   (7) 6.3.5 Key Pair and Certificate Usage  
   - SDP-6.3.5-02A [CONDITIONAL] If the TSP manages the QSCD for the subject, the TSP shall be a qualified trust service provider providing a qualified trust service for the management of a remote qualified electronic signature creation device, in accordance with Regulation (EU) No 910/2014 [i.1].
   - SDP-6.3.5-11A The subscriber's obligations (see clause 6.3.4) shall include, if the subscriber or subject generates the subject's keys:
   - (a) an obligation to generate the subject keys using an algorithm compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group [7] and published by ENISA for the uses of the certified key as identified in the CP  
   - (b) an obligation to use key length and algorithm compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group [7] and published by ENISA for the uses of the certified key as identified in the CP during the validity time of the certificate.  
   (8) 6.3.10 Certificate Status Services  
   - CSS-6.3.10-08 [CONDITIONAL] If CRLs are provided, the TSP shall preserve the integrity and the availability of the last CRL at least for the period specified in the CPS as requested in CSS-6.3.10-12.
   (9) 6.4.4 Personnel Controls  
   - OVR-6.4.4-02 TSP's personnel in trusted roles, and if applicable its subcontractors in trusted roles, shall be able to fulfil the requirement of 'expert knowledge, experience and qualifications' through formal training and credentials, or actual experience, or a combination of the two.
   - OVR-6.4.4-03 Compliance with OVR-6.4.4-02 shall include regular (at least every 12 months) updates on new threats and current security practices.
   - OVR-6.4.4-04 In addition to the trusted roles identified in ETSI EN 319 401 [1], (clause 7.2-15), the trusted roles of the registration and revocation officers with responsibilities as defined in TS 419261 [6] shall be supported. In cases where the QTSP is directly managed by or operated on behalf of a Member State or public sector body, those additional trusted roles may be fulfilled by one or more formal representatives acting for and on behalf of the registration and revocation officers officiating in local or regional administrations.
   (10) 6.4.9 CA or RA Termination  
   - OVR-6.4.9-02 The TSP's termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.1].
   (11) 6.5.1 Key Pair Generation and Installation  
   - OVR-6.5.1-01A CA key pair generation shall be performed using an algorithm compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [7] for the CA's signing purposes.
   - OVR-6.5.1-01B The selected key length and algorithm for CA signing key shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [7] for the CA's signing purposes.
   - OVR-6.5.1-01C [CONDITIONAL] If the CA generates the subject's keys, CA-generated subject keys shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [7] for the purposes stated in the CP during the validity time of the certificate.
   (12) 6.5.2 Private key protection and cryptographic module engineering controls  
   - GEN-6.5.2-01 All requirements identified in ETSI EN 319 411-1 [2], clause 6.5.2 shall apply, except requirements OVR-6.5.2-01, OVR-6.5.2-03 and OVR-6.5.2-04.
   - GEN-6.5.2-02 TSP's key pair generation, including keys used by revocation and registration services, shall be carried out within a secure cryptographic device which is a trustworthy system certified in accordance with:
   - Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 [10] or in Common Criteria for Information Technology Security Evaluation, version CC:2002, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher
   - or
   - the European Common Criteria-based cybersecurity certification scheme (EUCC) [8][9] and certified to EAL 4 or higher
   - or
   - until 31.12.2030, FIPS PUB 140-3 [11] level 3.
   - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
   - If the secure cryptographic device benefits from an EUCC [8][9] certification, then this device shall be configured and used in accordance with that certification.
   - GEN-6.5.2-03 The CA private signing key shall be held and used within a secure cryptographic device meeting the requirements of GEN-6.5.2-01 and GEN-6.5.2-02.
   (13) 6.5.7 Network Security Controls  
   - OVR-6.5.7-02 The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 [1] shall be performed at least once per quarter.
   - OVR-6.5.7-03 The penetration test requested by REQ-7.8-17X of ETSI EN 319 401 [1] shall be performed at least once per year.
   - OVR-6.5.7-04 Firewalls shall be configured to prevent all protocols and accesses not required for the operation of the TSP.
   (14) 6.6.1 Certificate Profile  
   - GEN-6.6.1-05 The certificate shall include one of the policy identifiers identified in GEN-6.3.3-03 [CHOICE]. The certificate may include other OIDs allocated by the TSP.

2. For ETSI EN 319 412-2
   (1) 2.1 Normative references; [2] ETSI EN 319 412-5 V2.5.1 'Electronic Signatures and Trust Infrastructures (ESI); Certificate Profiles; Part 5: QCStatements'.; [9] European Cybersecurity Certification Group, Sub-group on Cryptography 'Agreed Cryptographic Mechanisms' published by ENISA.
   (2) 4.2.2 Signature; GEN-4.2.2-2 Signature algorithm shall be selected in accordance with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [9].; NOTE void.
   (3) 4.2.3.1 Legal person issuers; GEN-4.2.3.1-3 If an appropriate registration number is known to exist, then the identity of the issuer shall contain organizationIdentifier with a value of that registration number as stated in the corresponding official record establishing that registration number.
   (4) 4.2.5 Subject public key info; GEN-4.2.5-2 The subject public key shall be selected in accordance with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [9].; NOTE void.
   (5) 4.2.6 Serial number; GEN-4.2.6-01 The certificate serialNumber (as specified in IETF RFC 5280 [1] clause 4.1.2.2) shall be unique for each certificate issued by the TSP.  

## ANNEX II  

### List of reference standards and specifications for qualified certificates for electronic seals  

The standards ETSI EN 319 411-2 V2.6.1 ('ETSI EN 319 411-2'), ETSI EN 319 412-1 V1.6.1 ('ETSI EN 319 412-1'), ETSI EN 319 412-3 V1.3.1 ('ETSI EN 319 412-3'), ETSI EN 319 412-2 V2.4.1 ('ETSI EN 319 412-2'), and ETSI EN 319 412-5 V2.5.1 ('ETSI EN 319 412-5') apply with the following adaptations:  

1. For ETSI EN 319 411-2
   (1) 2.1 Normative references; [1] ETSI EN 319 401 V3.1.1 (2024-06) 'Electronic Signatures and Trust Infrastructures (ESI); General Policy Requirements for Trust Service Providers'.; [2] ETSI EN 319 411-1 V1.5.1 (2025-04) 'Electronic Signatures and Trust Infrastructures (ESI); Policy and security requirements for trust service providers issuing certificates; Part 1: General requirements', with the following adaptations:
   - Clause 2.1 Normative references of ETSI EN 319 411-1 V1.5.1 shall be amended as follows:
   - [9] ETSI EN 319 401 V3.1.1 (2024-06) 'Electronic Signatures and Trust Infrastructures (ESI)
   - General Policy Requirements for Trust Service Providers'.
   - [10] ETSI EN 319 412-2 V2.4.1 'Electronic Signatures and Infrastructures (ESI)
   - Certificate Profiles
   - Part 2: Certificate profile for certificates issued to natural persons'.
   - [14] ETSI EN 319 412-1 V1.6.1 'Electronic Signatures and Infrastructures (ESI)
   - Certificate Profiles
   - Part 1: Overview and common data structures'.
   - [3] ETSI EN 319 412-5 V2.5.1 'Electronic Signatures and Trust Infrastructures (ESI)
   - Certificate Profiles
   - Part 5: QCStatements'.
   - [5] ETSI EN 319 412-1 V1.6.1 'Electronic Signatures and Trust Infrastructures (ESI)
   - Certificate Profiles
   - Part 1: Overview and common data structures'.
   - [6] CEN/TS 419261:2015 'Security requirements for trustworthy systems managing certificates and time-stamps', (produced by CEN).
   - [7] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by ENISA.
   - [8] Implementing Regulation (EU) 2024/482 laying down rules for the application of Regulation (EU) 2019/881 of the European Parliament and of the Council as regards the adoption of the European Common Criteria-based cybersecurity certification scheme (EUCC).
   - [9] Implementing Regulation (EU) 2024/3144 amending Implementing Regulation (EU) 2024/482 as regards applicable international standards and correcting that Implementing Regulation.
   - [10] ISO/IEC 15408:2022 (parts 1 to 5) 'Information security, cybersecurity and privacy protection – Evaluation criteria for IT security'.
   - [11] FIPS PUB 140-3 (2019) 'Security Requirements for Cryptographic Modules'.
   (2) 5.2 Certification Practice Statement Requirements  
   - OVR-5.2-02 The CP(s) identified by the TSP's documentation shall specify the requirements on certificate profiles to be used.
   (3) 5.3 Certificate Policy name and identification  
   - OVR-5.3-01 If any changes are made to a CP as described in clause 4.2.2 which affects the applicability, then the policy identifier shall be changed.
   (4) 6.1 Publication and repository responsibilities  
   - OVR-6.1-02 The information identified in DIS-6.1-04 of ETSI EN 319 411-1 [2] shall be publicly and internationally available.
   (5) 6.2.2 Initial identity validation  
   - REG-6.2.2-01A The collection of attributes and evidence on the subject's identity as well as their validation shall be as specified in accordance with the implementing acts adopted pursuant to Article 24(1c) of Regulation (EU) No 910/2014 [i.1].
   - REG-6.2.2-03 [QCP-l] and [QCP-l-qscd] The identity of the legal person and, if applicable, any specific attributes of the person, shall be verified in accordance with the implementing acts adopted pursuant to Article 24(1c) of Regulation (EU) No 910/2014 [i.1].
   - NOTE 3 See note 2.
   (6) 6.3.3 Certificate issuance  
   - GEN-6.3.3-01 The requirements GEN-6.3.3-01 to GEN-6.3.3-10 identified in ETSI EN 319 411-1 [2], clause 6.3.3 shall apply.
   - GEN-6.3.3-02 The CP identifier shall be [CHOICE]:
   - (a) [QCP-l]  
   - as specified in clause 5.3, item (b), and/or
   - an OID, allocated by the TSP, other relevant stakeholder or further standardisation for a certificate policy enhancing the corresponding applicable policy requirements defined in the present document.
   - (b) [QCP-l-qscd]  
   - as specified in clause 5.3, item (d), and/or
   - an OID, allocated by the TSP, other relevant stakeholder or further standardisation for a certificate policy enhancing the applicable policy requirements defined in the present document.
   (7) 6.3.5 Key Pair and Certificate Usage  
   - SDP-6.3.5-02A [CONDITIONAL] If the TSP manages the QSCD for the subject, the TSP shall be a qualified trust service provider providing a qualified trust service for the management of a remote qualified electronic seal creation device, in accordance with Regulation (EU) No 910/2014 [i.1]
   - SDP-6.3.5-11A The subscriber's obligations (see clause 6.3.4) shall include, if the subscriber or subject generates the subject's keys:
   - (a) an obligation to generate the subject keys using an algorithm compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [7] for the uses of the certified key as identified in the CP  
   - and
   - (b) an obligation to use key length and algorithm compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA[7] for the uses of the certified key as identified in the CP during the validity time of the certificate.  
   (8) 6.3.10 Certificate Status Services  
   - CSS-6.3.10-08 [CONDITIONAL] If CRLs are provided, the TSP shall preserve the integrity and the availability of the last CRL at least for the period specified in the CPS as requested in CSS-6.3.10-12.
   (9) 6.4.4 Personnel Controls  
   - OVR-6.4.4-02 TSP's personnel in trusted roles, and if applicable its subcontractors in trusted roles, shall be able to fulfil the requirement of 'expert knowledge, experience and qualifications' through formal training and credentials, or actual experience, or a combination of the two.
   - OVR-6.4.4-03 Compliance with OVR-6.4.4-02 shall include regular (at least every 12 months) updates on new threats and current security practices.
   - OVR-6.4.4-04 In addition to the trusted roles identified in ETSI EN 319 401 [1], (clause 7.2-15), the trusted roles of the registration and revocation officers with responsibilities as defined in TS 419261 [6] shall be supported. In cases where the QTSP is directly managed by or operated on behalf of a Member State or public sector body, those additional trusted roles may be fulfilled by one or more formal representatives acting for and on behalf of the registration and revocation officers officiating in local or regional administrations.
   (10) 6.4.9 CA or RA Termination  
   - OVR-6.4.9-02 The TSP's termination plan shall comply with the requirements set out in the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.1]].
   (11) 6.5.1 Key Pair Generation and Installation  
   - OVR-6.5.1-01A CA key pair generation shall be performed using an algorithm compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group published by ENISA [7] for the CA's signing purposes.
   - OVR-6.5.1-01B The selected key length and algorithm for CA signing key shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group published by ENISA [7] for the CA's signing purposes.
   - OVR-6.5.1-01C [CONDITIONAL] If the CA generates the subject's keys, CA-generated subject keys shall be compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group published by ENISA [7] for the purposes stated in the CP during the validity time of the certificate.
   (12) 6.5.2 Private key protection and cryptographic module engineering controls  
   - GEN-6.5.2-01 All requirements identified in ETSI EN 319 411-1 [2], clause 6.5.2 shall apply, except requirements OVR-6.5.2-01, OVR-6.5.2-03 and OVR-6.5.2-04.
   - GEN-6.5.2-02 TSP's key pair generation, including keys used by revocation and registration services, shall be carried out within a secure cryptographic device which is a trustworthy system certified in accordance with:
   - Common Criteria for Information Technology Security Evaluation, as set out in ISO/IEC 15408 [10] or in Common Criteria for Information Technology Security Evaluation, version CC:2002, Parts 1 through 5, published by the participants of the Arrangement on the Recognition of Common Criteria Certificates in the field of IT Security, and certified to EAL 4 or higher
   - or
   - the European Common Criteria-based cybersecurity certification scheme (EUCC) [8][9] and certified to EAL 4 or higher
   - or
   - until 31.12.2030, FIPS PUB 140-3 [11] level 3.
   - This certification shall be to a security target or protection profile, or to a module design and security documentation, which meets the requirements of the present document, based on a risk analysis and taking into account physical and other non-technical security measures.
   - If the secure cryptographic device benefits from an EUCC [8][9] certification, then this device shall be configured and used in accordance with that certification.
   - GEN-6.5.2-03 The CA private signing key shall be held and used within a secure cryptographic device meeting the requirements of GEN-6.5.2-01 and GEN-6.5.2-02.
   (13) 6.5.7 Network Security Controls  
   - OVR-6.5.7-02 The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 [1] shall be performed at least once per quarter.
   - OVR-6.5.7-03 The penetration test requested by REQ-7.8-17X of ETSI EN 319 401 [1] shall be performed at least once per year.
   - OVR-6.5.7-04 Firewalls shall be configured to prevent all protocols and accesses not required for the operation of the TSP.
   (14) 6.6.1 Certificate Profile  
   - GEN-6.6.1-05 The certificate shall include one of the policy identifiers identified in GEN-6.3.3-02 [CHOICE].

2. For ETSI EN 319 412-3
   (1) 2.1 Normative references; [2] ETSI EN 319 412-2 V2.4.1 'Electronic Signatures and Infrastructures (ESI); Certificate Profiles; Part 2: Certificate Profile for certificates issued to natural persons'.
   (2) 4.2.1 Subject; LEG-4.2.1-6 The organizationIdentifier attribute shall contain an identification of the subject organization different from the organization name. If an appropriate registration number is known to exist, then the organizationIdentifier attribute shall contain a value of that registration number as stated in the corresponding official record establishing that registration number.  

3. For ETSI EN 319 412-2:
   (1) 2.1 Normative references  
   - [2] ETSI EN 319 412-5 V2.5.1 'Electronic Signatures and Trust Infrastructures (ESI)
   - Certificate Profiles
   - Part 5: QCStatements'.
   - [9] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by ENISA.
   (2) 2.2 Informative references  
   - [i.7] void.
   (3) 4.2.2 Signature  
   - GEN-4.2.2-2 Signature algorithm shall be selected in accordance with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [9].
   - NOTE void.
   (4) 4.2.3.1 Legal person issuers  
   - GEN-4.2.3.1-3 If an appropriate registration number is known to exist, then the identity of the issuer shall contain organizationIdentifier with a value of that registration number as stated in the corresponding official record establishing that registration number.
   (5) 4.2.5 Subject public key info  
   - GEN-4.2.5-2 The subject public key shall be selected in accordance with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [9].
   - NOTE void.
   (6) 4.2.6 Serial number  
   - GEN-4.2.6-01 The certificate serialNumber (as specified in IETF RFC 5280 [1] clause 4.1.2.2) shall be unique for each certificate issued by the TSP.

---

# eIDAS - Registration of relying parties (standards update)
Source: https://docs.igrant.io/regulations/implementing-acts-registration-relying-parties-update/

---
id: implementing-acts-registration-relying-parties-update
title: eIDAS - Registration of relying parties (standards update)
description: Understand Implementing Regulation (EU) 2026/1730, which updates the standards and specifications for the registration of wallet-relying parties.
sidebar_label: Registration of relying parties (standards update)
keywords: [Implementing Acts, eIDAS, EUDI Wallet, relying party registration, standards and specifications, 2026/1730, 2025/848]
slug: /implementing-acts-registration-relying-parties-update/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand Implementing Regulation (EU) 2026/1730, which updates the standards and specifications for the registration of wallet-relying parties."/>
</head>

Commission Implementing **Regulation (EU) 2026/1730** of 15 July 2026 amends Implementing Regulation (EU) 2025/848 as regards applicable standards and specifications. It operates under Regulation (EU) No 910/2014 on electronic identification and trust services, and refines the rules on the <a href="/regulations/implementing-acts-registration-relying-parties/">registration of wallet-relying parties</a> so that Member States apply consistent, up to date technical specifications across the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2026/1730/oj).

:::note
This regulation is an amending act. The summary below describes the changes it makes to Implementing Regulation (EU) 2025/848. For the authoritative wording of each amendment, refer to the official text in the Official Journal linked above.
:::

### Article 1: Amendments to Implementing Regulation (EU) 2025/848

This Article amends the rules for registering wallet-relying parties:

- It modifies the accuracy requirements for the information held in the registers (Article 6(3)).
- It inserts Article 6(3a), providing that registrars collect certain information automatically for transparency purposes, without a prior authorisation step.
- It amends Article 8 so that the responsible certificate authorities issue wallet-relying party registration certificates automatically and without undue delay.
- It updates the technical specifications set out in Annexes I, IV and V to reflect the applicable standards.

### Article 2: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 15 July 2026.

For the Commission

The President

Ursula VON DER LEYEN


---

# EUDI Wallet - Registration of relying parties
Source: https://docs.igrant.io/regulations/implementing-acts-registration-relying-parties/

---
id: implementing-acts-registration-relying-parties
title: EUDI Wallet - Registration of relying parties
description: Learn about the EU Implementing Acts on registration of relying parties for EU Digital Identity Wallets.
sidebar_label: Registration of relying parties
keywords: [Implementing Acts, EUDI Wallet, relying parties, registration, wallet relying party, eIDAS 2.0]
slug: /implementing-acts-registration-relying-parties/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on registration of relying parties for EU Digital Identity Wallets."/>
</head>

Commission Implementing **Regulation (EU) 2025/848** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/848/oj).


### Article 1: Subject matter and scope  

This Regulation lays down rules for the registration of wallet-relying parties.  

### Article 2: Definitions  

For the purposes of this Regulation, the following definitions apply:  

1. **'wallet-relying party'** means a relying party that intends to rely upon wallet units for the provision of public or private services by means of digital interaction;  

2. **'wallet unit'** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;  

3. **'wallet solution'** means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;  

4. **'wallet instance'** means the application installed and configured on a wallet user's device or environment, which is part of a wallet unit, and that the wallet user uses to interact with the wallet unit;  

5. **'wallet secure cryptographic application'** means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;  

6. **'wallet secure cryptographic device'** means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;  

7. **'critical assets'** means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;  

8. **'wallet provider'** means a natural or legal person who provides wallet solutions;  

9. **'wallet user'** means a user who is in control of the wallet unit;  

10. **'national register of wallet-relying parties'** means a national electronic register used by a Member State to make information on wallet-relying parties registered in that Member State publicly available as set out in Article 5b(5) of Regulation (EU) No 910/2014;  

11. **'provider of wallet-relying party access certificates'** means a natural or legal person mandated by a Member State to issue wallet-relying party access certificates to wallet-relying parties registered in that Member State;  

12. **'wallet-relying party access certificate'** means a certificate for electronic seals or signatures authenticating and validating the wallet-relying party issued by a provider of wallet-relying party access certificates;  

13. **'provider of person identification data'** means a natural or legal person responsible for issuing and revoking the person identification data and ensuring that the person identification data of a user is cryptographically bound to a wallet unit;  

14. **'registrar of wallet-relying parties'** means the body responsible for establishing and maintaining the list of registered wallet-relying parties established in their territory and who has been designated by a Member State;  

15. **'wallet-relying party registration certificate'** means a data object that describes the intended use of the relying party and indicates the attributes the relying party has registered to intend to request from users;  

16. **'provider of wallet-relying party registration certificates'** means a natural or legal person mandated by a Member State to issue wallet-relying party registration certificates to wallet-relying parties registered in that Member State.  

### Article 3: National registers  

1. Member States shall establish and maintain at least one national register of wallet-relying parties with information regarding registered wallet-relying parties established in that Member State.  

2. The register shall include at least the information set out in Annex I.  

3. Member States shall designate at least one registrar to manage and operate at least one national register of wallet-relying parties.  

4. Member States shall make the information set out in Annex I on registered wallet-relying parties publicly available online, both in human-readable form and in a form suitable for automated processing.  

5. The information referred to in paragraph 2 shall be available through a single common application programming interface ('API') and through a national website. It shall be electronically signed or sealed by or on behalf of the registrar, in accordance with the common requirements for a single API set out in Section 1 of Annex II.  

6. Member States shall ensure that the API referred to in paragraph 5 complies with the common requirements set out in Section 2 of Annex II.  

7. Member States shall ensure that the registers comply with the relevant common registration policies set out in Article 4.  

### Article 4: Registration policies  

1. Member States shall lay down and publish one or more national registration policies applicable to the national registers established in their territory.  

2. Member States may include or reuse existing sectoral or national registration policies.  

3. The national registration policy shall include at least information on:  

   (a) the identification and authentication procedures applicable to wallet-relying parties during the registration process;  

   (b) the required supporting documentation, regarding the identity, business registration, applicable entitlement or entitlements, and other relevant information on the wallet-relying party;  

   (c) the authentic sources or other official electronic records and where those sources or records can be relied upon to provide accurate data;  

   (d) any other information or other evidence required as part of the registration process;  

   (e) where applicable, the automated means of enabling wallet-relying parties to register or to update an existing registration;  

   (f) the redress mechanism available to wallet-relying parties under the laws and procedures of the Member State where the national register is established;  

   (g) the rules and procedures for the verification of the identity of the registered wallet-relying parties and of any other relevant information provided by that party.  

4. The procedures and documentation referred to in paragraph 3, points (a) and (b), shall enable the wallet-relying parties to indicate which specific entitlement or entitlements it is acting under, as set out in Annex I.  

5. Where appropriate, the requirements set out in the national registration policy shall not impede an automated registration process.  

### Article 5: Information to be provided to the national registers  

1. Wallet-relying parties shall at least provide the information set out in Annex I to national registers.  

2. Wallet-relying parties shall ensure that the information provided is accurate at the time of registration.  

3. Wallet-relying parties shall update any information previously registered in the national register of wallet-relying parties without undue delay.  

### Article 6: Registration processes  

1. Registrars shall establish easy to use electronic, and where possible, automated registration processes for wallet-relying parties.  

2. Registrars shall process applications for registration without undue delay and provide a response to the application for registration to the applicant within the timeframe defined in the applicable registration policy, using appropriate means and in accordance with the laws and procedures of the Member State where the national register is established.  

3. Where possible, registrars shall verify in an automated manner:  

   (a) the accuracy, validity, authenticity and integrity of the information required under Article 5;  

   (b) where applicable, the power of attorney of representatives of the wallet-relying parties drawn up and submitted in accordance with the laws and procedures of the Member State where the national register is established;  

   (c) the type of entitlement or entitlements of the wallet-relying parties as set out in Annex I;  

   (d) the absence of an existing registration in another national register.  

4. Registrars shall verify the information set out in paragraph 3 against the supporting documentation provided by the wallet-relying parties or against appropriate authentic sources or other official electronic records in the Member State where the national register is established and to which the registrars have access in accordance with the applicable national laws and procedures.  

5. The verification of entitlements of wallet-relying parties referred to in paragraph 3, point (c) shall be carried out in accordance with Annex III.  

6. Where the registrar cannot verify the information in accordance with paragraphs 3 to 5, the registrar shall reject the registration.  

7. When a wallet-relying party no longer intends to rely upon wallet units for the provision of public or private services under a specific registration, it shall notify the relevant registrar without undue delay and request the cancellation of that registration.  

### Article 7: Wallet-relying party access certificates  

1. Member States shall authorise at least one certificate authority to issue wallet-relying party access certificates.  

2. Member States shall ensure that providers of wallet-relying party access certificates issue wallet-relying party access certificates exclusively to registered wallet-relying parties.  

3. Member States shall implement in a syntactically and semantically harmonised manner the certificate policies and certificate practice statements for the wallet-relying party access certificates, in accordance with the requirements set out in Annex IV.  

### Article 8: Wallet-relying party registration certificates  

1. Member States may authorise at least one certificate authority to issue wallet-relying party registration certificates.  

2. Where a Member State authorised the issuance of a wallet-relying party registration certificate, that Member State shall;  

   (a) require providers of wallet-relying party registration certificates to issue wallet-relying party registration certificates exclusively to registered wallet-relying parties;  

   (b) ensure that each intended use is expressed in the wallet-relying party registration certificates;  

   (c) ensure that wallet-relying party registration certificates include a general access policy, being syntactically and semantically harmonised across the Union, informing users that the wallet-relying party is only allowed to request the data specified in the registration certificates for the intended use registered in the registration certificates;  

   (d) ensure that providers of wallet solutions established in that Member State comply with the general access policy by informing users when a wallet-relying party requests data that is not specified in the registration certificates;  

   (e) implement wallet-relying party registration certificates in a syntactically and semantically harmonised manner and in line with the requirements set out in Annex V;  

   (f) implement dedicated certificate policies and certificate practice statements for the wallet-relying party registration certificates in accordance with the requirements set out in Annex V;  

   (g) ensure that wallet-relying parties provide a URL to the privacy policy regarding the intended use.  

3. The policy referred to in point (g) shall be expressed in the wallet-relying party registration certificate.  

### Article 9: Suspension and cancellation of registration  

1. Registrars shall suspend or cancel a registration of a wallet-relying party where such a suspension or cancellation is requested by a supervisory body pursuant to Article 46a(4), point (f) of Regulation (EU) No 910/2014.  

2. Registrars may suspend or cancel a registration of a wallet-relying party where the registrars have reasons to believe one of the following:  

   (a) the registration contains information, which is inaccurate, out of date or misleading;  

   (b) the wallet-relying party is not compliant with the registration policy;  

   (c) the wallet-relying party is requesting more attributes than they have registered in accordance with Article 5 and Article 6;  

   (d) the wallet-relying party is otherwise acting in breach of Union or national law in a manner related to their role as wallet-relying party.  

3. Registrars shall suspend or cancel a registration of a wallet-relying party where the request for cancellation or suspension is made by the same wallet-relying party.  

4. When considering the suspension or cancellation in accordance with paragraph 2, the registrar shall conduct a proportionality assessment, taking into account the impact on the fundamental rights, security and confidentiality of the users in the ecosystem, as well as the severity of the disruption envisaged to be caused by the suspension or cancellation and the associated costs, both for the wallet-relying party and the user. Based on the result of this assessment, the registrar may suspend or cancel the registration with or without prior notice to the affected wallet-relying party.  

5. Where the registration of a wallet-relying party is suspended or cancelled, the registrar shall inform the provider of the relevant wallet-relying party access certificates, the provider of the relevant wallet-relying party registration certificates, and the affected wallet-relying party of this action without undue delay and not later than 24 hours after the suspension or cancellation. This notification shall include information on the reasons for the suspension or cancellation and on the available means of redress or appeal.  

6. The provider of wallet-relying party access certificates and the provider of wallet-relying registration certificates, shall, where applicable, revoke without undue delay the wallet-relying party access certificates, and the wallet-relying party registration certificates, respectively, of the wallet-relying party for which registration has been suspended or cancelled.  

### Article 10: Record keeping  

Registrars shall keep records of the information provided by wallet-relying parties and registered in accordance with Annex I for the registration of a wallet-relying party and the issuance of the wallet-relying party access certificates and the wallet-relying party registration certificates, and of any subsequent changes to this information, for 10 years.  

### Article 11: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

It shall apply from the 24 December 2026.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 6 May 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX I  

### Information regarding wallet-relying parties  

1. Where applicable, the name of the wallet-relying party, as stated in an official record together with identification data of that official record.
   (a) if none are applicable, paragraph 2 shall be used.  

2. Where applicable, a user-friendly name of the wallet-relying party that can be either a trade name or service name that is recognisable to the user.  

3. Where applicable, one or more identifiers of the wallet-relying party, as stated in an official record together with identification data of that official record, expressed as:
   - (a) an economic operators registration and identification ('EORI') number as referred to in Commission Implementing Regulation (EU) No 1352/2013 (1)  
   - (b) a registration number as registered in a national business register  
   - (c) a legal entity identifier ('LEI') as referred to in Commission Implementing Regulation (EU) 2022/1860 (2)  
   - (d) a value-added tax ('VAT') registration number  
   - (e) an excise number as referred to in Article 2(12) of Council Regulation (EU) No 389/2012 (3)  
   - (f) a tax reference number  
   - (g) an european unique identifier ('EUID') as referred to in Commission Implementing Regulation (EU) 2021/1042 (4)  
   - (h) other national identifier or identifiers.  

4. The physical address where the wallet-relying party is established.  

5. Where applicable, a uniform resource locator ('URL') belonging to the wallet-relying party.  

6. Where the identifier is expressed in accordance with points 3(a), (d), (f) or (h), the country indicator of the Member State where the wallet-relying party is established shall be prefixed using ISO 3166-1 Alpha 2 codes, with the exception of the country indicator for Greece which shall be 'EL'.  

7. Contact information of the wallet-relying party, at least one of the following:
   - (a) a website where the wallet-relying party can be contacted for matters pertaining to provision of helpdesk and support  
   - (b) a phone number where the wallet-relying party can be contacted for matters pertaining to its registration and intended use of the wallet units  
   - (c) an email address where the wallet-relying party can be contacted for matters pertaining to its registration and intended use of the wallet unit.  

8. A description of the type of services the wallet-relying party provides.  

9. For each intended use, a list of the data, including attestations and attributes, that the relying party intends to request, a user-friendly name and a technical name, the attestation type and any other syntaxes that the data is grouped under, in a machine-readable format for automated processing.  

10. For each intended use, a description of intended use of the data that the wallet-relying party intends to request from wallet units.  

11. An indication whether the wallet-relying party is a public sector body.  

12. The entitlement or entitlments of the wallet-relying party, that shall be expressed as follows:
   - (a) 'Service_Provider' to express the entitlement of the wallet-relying party as a provider of services  
   - (b) 'QEAA_Provider' to express the entitlement of the wallet-relying party as a qualified trust service provider issuing qualified electronic attestations of attributes  
   - (c) 'Non_Q_EAA_Provider' to express the entitlement of the wallet-relying party as a trust service provider issuing non-qualified electronic attestations of attributes  
   - (d) 'PUB_EAA_Provider' to express the entitlement of the wallet-relying party as a provider of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source  
   - (e) 'PID_Provider' to express the entitlement of the wallet-relying party as a provider of person identification data  
   - (f) 'QCert_for_ESeal_Provider' to express the entitlement of the wallet-relying party as a qualified trust service provider issuing qualified certificates for electronic seals  
   - (g) 'QCert_for_ESig_Provider' to express the entitlement of the wallet-relying party as a qualified trust service provider issuing qualified certificates for electronic signatures  
   - (h) 'rQSigCDs_Provider' to express the entitlement of the wallet-relying party as a qualified trust service provider providing qualified trust services for the management of a remote qualified electronic signature creation device  
   - (i) 'rQSealCDs_Provider' to express the entitlement of the wallet-relying party as a qualified trust service provider providing qualified trust services for the management of a remote qualified electronic seal creation device  
   - (j) 'ESig_ESeal_Creation_Provider' to express the entitlement of the wallet-relying party as a non-qualified trust service provider providing a non-qualified trust service for remote creation of electronic signatures or electronic seals.  

13. With regard to paragraph 12, point (c), Member States may provide additional sub-entitlements to state which attestations a specific non-qualified issuer of electronic attestation of attributes shall issue.  

14. Where applicable, an indication that the wallet-relying party relies upon an intermediary acting on behalf of the relying party who intends to rely upon the wallet.  

15. Where applicable, an association to the intermediary that the wallet-relying party is relying upon that is acting on behalf of the relying party who intends to rely upon the wallet.  

## ANNEX II  

### 1. REQUIREMENTS FOR ELECTRONIC SIGNATURES OR SEALS APPLIED TO THE INFORMATION MADE AVAILABLE ON REGISTERED WALLET-RELYING PARTIES REFERRED TO IN ARTICLE 3  


   - JavaScript Object Notation ('JSON');  

   - IETF 7515 for JSON Web Signatures.  

### 2. REQUIREMENTS ON THE SINGLE COMMON API REFERRED TO IN ARTICLE 3  
   1. The single common API shall:
      - (a) be a REST API, supporting JSON as a format and signed in accordance with the relevant requirements specified in Section 1  
      - (b) allow any requestor, without prior authentication, to search and request complete lists to the register, for information about registered wallet-relying parties, allowing for partial matches based on defined parameters including, where applicable, the official or business registration number of the wallet-relying party, the name of the wallet-relying party or the information referred to in Article 8, paragraph 2, point (g) and Annex I points 12, 13, 14 and 15  
      - (c) ensure that replies to requests referred to in point (b) that match at least one wallet-relying party shall include one or more statements on information about registered wallet-relying parties and information according to Annex I, current and historic wallet-relying party access certificates and wallet-relying party registration certificates but exclude the contact information in Annex I point 4  
      - (d) be published as an OpenAPI version 3, together with the appropriate documentation and technical specifications ensuring interoperability across the Union  
      - (e) provide security functions, including security by default and by design, to ensure the availability and integrity of the API and the availability of information through it.  

   2. The statements referred to in point (c) shall be expressed under the form of electronically signed or sealed JSON files, with a format and structure in accordance with the requirements on electronic signatures or seals set out Section 1.  

## ANNEX III  

### Source of documentary evidence for the verification of entitlements of wallet-relying parties referred to in Article 6  

1. The verification that a wallet-relying party is a provider of qualified electronic attestations of attributes, a provider of qualified certificates for electronic signatures or seals, or a provider of a qualified trust service for the management of remote qualified electronic signature or seal creation devices, shall be based on the national trusted lists published in accordance with Article 22 of Regulation (EU) No 910/2014.  

2. The verification that a wallet-relying party is a provider of non-qualified electronic attestations of attributes or a provider of remote creation of electronic signatures or seals as a non-qualified trust service shall be based, where applicable, on the national trusted lists published in accordance with Article 22 of Regulation (EU) No 910/2014, or, for non-qualified trust service providers who are not registered in the national trusted lists, on verification procedures that Members States have set out in their registration policies as laid out in Article 4.  

3. The verification that a wallet-relying party is a provider of person identification data shall be based on the list of providers of person identification data published by the Commission in accordance with Article 5a(18) of Regulation (EU) No 910/2014.  

4. The verification that a wallet-relying party is a provider of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source shall be based on the list published by the Commission in accordance with Article 45f(3) of Regulation (EU) No 910/2014.  

## ANNEX IV  

### Requirements for wallet-relying party access certificates referred to in Article 7  

1. The wallet-relying party access certificate policy applicable to the provision of wallet-relying party access certificates shall describe the security requirements that apply to, and the rules that indicate the applicability of, a wallet-relying party access certificate so that wallet-relying parties can be issued with and use those certificates in their interactions with wallet solutions.  

2. The wallet-relying party access certificate practice statement applicable to the provision of wallet-relying party access certificates shall describe the practices that a provider of wallet-relying party access certificates employs in issuing, managing, revoking, and re-keying wallet-relying party access certificates.  

3. The certificate policy and certificate practice statement applicable to the provision of wallet-relying party access certificates shall be syntactically and semantically harmonised across the Union and shall, as applicable, comply with at least the normalised certificate policy ('NCP') requirements as specified in standard ETSI EN 319411-1 version 1.4.1 (2023-10), and shall include:
   - (a) a clear description of the public key infrastructure hierarchy and certification paths from the end-entity wallet-relying party access certificates up to the top of the hierarchy used for issuing them, indicating the expected trust anchor(s) in such hierarchy and paths which should rely on the trust framework established in accordance with Article 5a(18) of Regulation (EU) No 910/2014  
   - (b) a comprehensive description of the procedures for the issuance of wallet-relying party access certificates, including for the verification of the identity and any other attributes of the wallet-relying party to which a wallet-relying party certificate is to be issued  
   - (c) the obligation for the providers of wallet-relying party access certificates, when issuing a wallet-relying party access certificate, to verify that:  
   - the wallet-relying party is included, with a valid registration status, in a national register of wallet-relying parties of the Member State in which that wallet-relying party is established
   - any information in the wallet-relying party access certificate is accurate and consistent with the registration information available from that register.
   - (d) a comprehensive description of the procedures for revocation of wallet-relying party access certificates  
   - (e) the obligation for the providers of wallet-relying party access certificates to implement measures and processes on:  
   - continuously monitoring any changes in the national register for wallet-relying parties in which wallet-relying parties to whom they have issued wallet-relying party access certificates are registered
   - revoking, when changes require, any wallet-relying party certificate that the provider issued to the corresponding wallet-relying party, in particular when the content of the certificate is no longer accurate and consistent with the information registered, or when the registration of the wallet-relying party is suspended or cancelled.
   - (f) a comprehensive description of the procedures and mechanisms for the harmonised validation of wallet-relying party access certificates across the Union  
   - (g) the obligation for the providers of wallet-relying party access certificates to allow relevant stakeholders, including wallet-relying parties as regards their own certificates, competent supervisory bodies and data protection authorities, to request the revocation of wallet-relying party access certificates  
   - (h) the obligation for the providers of wallet-relying party access certificates to register all such revocations in its certificate database and to publish the revocation status of the certificate in a timely manner, and in any event within 24 hours after receipt of the revocation request  
   - (i) the obligation for the providers of wallet-relying party access certificates to provide information on the validity or revocation status of wallet-relying party certificates issued by that provider  
   - (j) a description, where relevant, on how a provider of wallet-relying party access certificates logs all wallet-relying party access certificates they have issued, in compliance with internet engineering task force ('IETF') request for comments ('RFC') 9162 Certificate Transparency version 2.0  
   - (k) the obligation for the wallet-relying party access certificates to include:  
   - the location where the certificate supporting the advanced electronic signature or advanced electronic seal on that certificate is available, for the entire certification path to be built up to the expected trust anchor in the public key infrastructure hierarchy used by the provider
   - a machine processable reference to the applicable certificate policy and certificate practice statement
   - the information referred to in Annex I, points 1, 2, 3, 5, 6 and 7, (a), (b) and (c).

4. The revocation set out in point 3(g) shall become effective immediately upon its publication.  

5. The information set out in point 3(h) shall be made available at least on a per certificate basis at any time and at least beyond the validity period of the certificate in an automated manner that is reliable, free of charge and effectively in accordance with the certificate policy.  

## ANNEX V  

### Requirements for wallet-relying party registration certificates referred to in Article 8  

1. The wallet-relying party registration certificate policy applicable to the provision of wallet-relying party registration certificates shall describe the security requirements that apply to, and the rules that indicate the applicability of, a wallet-relying party registration certificate for their issuance to and use by wallet-relying parties in their interactions with wallet solutions. The wallet relying party registration certificate policy shall be published in human-readable.  

2. The wallet-relying party registration certificate practice statement applicable to the provisioning of wallet-relying party registration certificates shall describe the practices that a provider of wallet-relying party registration certificates employs in issuing, managing, revoking, and re-keying wallet-relying party registration certificates, and, where applicable, how they relate to wallet-relying party access certificates issued to wallet-relying parties. The wallet relying party registration certificate practice statement shall be published in human-readable.  

3. The wallet-relying party registration certificate policy and certificate practice statement applicable to the provisioning of wallet-relying party registration certificates shall be syntactically and semantically harmonised across the Union and shall comply with at least the applicable NCP requirements as specified in standard ETSI EN 319411-1 version 1.4.1 (2023-10), and shall include:
   - (a) a clear description of the public key infrastructure hierarchy and certification paths from the end-entity wallet-relying party registration certificates up to the top of the hierarchy used for issuing them, while indicating the expected trust anchor(s) in such hierarchy and paths  
   - (b) a comprehensive description of the procedures for the issuance of wallet-relying party registration certificates, including for the verification of the identity and of any attribute of the wallet-relying party to which a wallet-relying party certificate is to be issued  
   - (c) the obligation for the provider of wallet-relying party registration certificates, when issuing a wallet-relying party registration certificate, to verify that:  
   - the wallet-relying party is included, with a valid registration status, in a national register for wallet-relying parties of the Member State in which that wallet-relying party is established
   - the information in the wallet-relying party registration certificate is accurate and consistent with the registration information available from that register
   - the wallet-relying party access certificate is valid
   - the description of the procedures for revocation of wallet-relying party registration certificates is comprehensive.
   - (d) the obligation for the provider of wallet-relying party registration certificates implements measures and processes on:  
   - continuously monitoring in an automated manner any changes in the national register for wallet-relying parties in which wallet-relying parties to whom they have issued wallet-relying party registration certificates are registered
   - reissue the wallet-relying party registration certificate
   - revoking any wallet-relying party registration certificate that they issued to the corresponding wallet-relying party, when such changes so require, in particular when the content of the certificate is no longer accurate and consistent with the information registered, or when the registration of the wallet-relying party is modified, suspended or cancelled.
   - (e) a comprehensive description of the procedures and mechanisms for the harmonised validation of wallet-relying party registration certificates  
   - (f) the obligation for the provider of wallet-relying party registration certificates to allow relevant stakeholders, including wallet-relying parties as regards their own certificates, competent supervisory bodies and data protection authorities, to request the revocation of wallet-relying party registration certificates  
   - (g) the obligation for the provider of wallet-relying party registration certificates to register all such revocations in its certificate database and to publish the revocation status of the certificate in a timely manner, and in any event within 24 hours after the receipt of the request for revocation  
   - (h) the obligation for the providers of wallet-relying party registration certificates to provide information on the validity or revocation status of wallet-relying party registration certificates issued by that provider  
   - (i) a description, where relevant, on how a provider of wallet-relying party registration certificates logs all wallet-relying party registration certificates they have issued  
   - (j) the obligation for the wallet-relying party registration certificates:  
   - to include the location where the validation data of the advanced electronic signature or advanced electronic seal for the certificate used to sign or seal the registration certificate is available, for the entire trust chain to be built up to the expected trust anchor
   - to include a machine-readable reference to the applicable certificate policy and certificate practice statement
   - to include the information referred to in Annex I, points 1, 2, 3, 5, 6 and 8, 9, 10, 11, 12, 13, 14 and 15
   - to include the URL to the privacy policy referred to in Article 8(2)g
   - to include a general access policy as referred to in Article 8(3)

4. The data exchange format for the relying party registration certificate shall be signed JSON Web Tokens (IETF RFC 7519) and CBOR Web Tokens (IETF RFC 8392).  

5. The revocation referred to in point 3(g) shall become effective immediately upon its publication.  

6. The information referred to in point 3(h) shall be made available at least on a per certificate basis at any time and at least beyond the validity period of the certificate in an automated manner that is reliable, free of charge and effectively in accordance with the certificate policy.  

---

# EUDI Wallet - Remote onboarding
Source: https://docs.igrant.io/regulations/implementing-acts-remote-onboarding/

---
id: implementing-acts-remote-onboarding
title: EUDI Wallet - Remote onboarding
description: Understand the EU Implementing Acts on reference standards and specifications for remote onboarding of users to EUDI Wallets using eID means at assurance level substantial.
sidebar_label: Remote onboarding
keywords: [Implementing Acts, EUDI Wallet, remote onboarding, identity proofing, assurance level substantial, eIDAS 2.0]
slug: /implementing-acts-remote-onboarding/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on reference standards and specifications for remote onboarding of users to EUDI Wallets."/>
</head>

Commission Implementing **Regulation (EU) 2026/798**, adopted on 7 April 2026, laying down rules for the application of Regulation (EU) No 910/2014 of the European Parliament and of the Council as regards **reference standards and specifications for the remote onboarding** of users to the European Digital Identity Wallets by electronic identification means conforming to assurance level substantial in conjunction with additional remote onboarding procedures where the combination meets the requirements of assurance level high.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2026/798/oj).


### Article 1

The reference standards and specifications referred to in Article 5a(24) of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.

### Article 2

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 7 April 2026.

For the Commission

The President

Ursula VON DER LEYEN

## ANNEX

### List of reference standards and specifications

Conformance is assessed against the clauses of ETSI TS 119 461 V2.1.1 (2025-02) listed in section 1, subject to the adaptations listed in section 2.

### Section 1 - Applicable clauses

<table>
  <tr><td>-</td><td>5</td><td>Operational risk assessment;</td></tr>
  <tr><td>-</td><td>6</td><td>Policies and practices;</td></tr>
  <tr><td>-</td><td>7</td><td>Identity proofing service management and operation;</td></tr>
  <tr><td>-</td><td>8</td><td>Identity proofing service requirements;</td></tr>
  <tr><td>-</td><td>9.1</td><td>Introduction, compliance with the present document, general requirements for all use cases;</td></tr>
  <tr><td>-</td><td>9.2.2</td><td>Use cases using an identity document for attended remote identity proofing;</td></tr>
  <tr><td>-</td><td>9.2.3</td><td>Use cases using an identity document for unattended remote identity proofing;</td></tr>
  <tr><td>-</td><td>9.2.4</td><td>Use case for identity proofing by authentication using eID means;</td></tr>
  <tr><td>-</td><td>9.5</td><td>Use cases for additional identity proofing to enhance an identity proven by use of an eID from Baseline LoIP to Extended LoIP.</td></tr>
</table>

### Section 2 - Adaptations

<table>
  <tr><td>(1)</td><td>5</td><td>Operational risk assessment</td></tr>
  <tr><td rowspan="2">&nbsp;</td><td>-</td><td>OVR-5-01: The requirements specified in ETSI EN 319 401 [1], clause 5 shall apply.</td></tr>
  <tr><td>-</td><td>NOTE 1: When the identity proofing is done by the provider of person identification data itself, the risk assessment of the provider of person identification data can cover the identity proofing.</td></tr>
  <tr><td>(2)</td><td>6.1</td><td>Identity proofing service practice statement</td></tr>
  <tr><td rowspan="2">&nbsp;</td><td>-</td><td>OVR-6.1-02: An IPSP shall identify in its practice statement the use cases for which compliance with the present document is claimed.</td></tr>
  <tr><td>-</td><td>NOTE 1: When the identity proofing is done by the provider of person identification data itself, the identity proofing service practice statement of the provider of person identification data can cover the information on the identity proofing and there is no need for a specific practice statement for identity proofing.</td></tr>
  <tr><td>(3)</td><td>7.9</td><td>Vulnerabilities and incident management</td></tr>
  <tr><td rowspan="2">&nbsp;</td><td>-</td><td>OVR-7.9-02: Reporting obligations according to ETSI EN 319401 [1] REQ-7.9.2-02X and clause 7.9.3 shall be fulfilled as required by the identity proofing context and the obligations of the provider of person identification data relying on the IPSP's service.</td></tr>
  <tr><td>-</td><td>EXAMPLE: Reporting to the supervisory authority supervising a provider of European Digital Identity Wallets established in the designating Member State can be done in cooperation between the IPSP and the provider of person identification data.</td></tr>
  <tr><td>(4)</td><td>7.10</td><td>Collection of evidence</td></tr>
  <tr><td rowspan="3">&nbsp;</td><td>-</td><td>OVR-7.10-01: The requirements specified in ETSI EN 319 401 [1], clause 7.10 shall apply.</td></tr>
  <tr><td>-</td><td>NOTE 1: Long-term requirements for retention of evidence can be fulfilled by the provider of person identification data requesting the identity proofing instead of by the IPSP when the two are different entities.</td></tr>
  <tr><td>-</td><td>NOTE 2: The requirements of clause 8.5.2 of the present document apply.</td></tr>
  <tr><td>(5)</td><td>7.11</td><td>Business continuity management</td></tr>
  <tr><td>&nbsp;</td><td>-</td><td>OVR-7.11-02: Processes for crisis management according to ETSI EN 319401 [1], REQ-7.11.3-01X shall be as required by the identity proofing context and the obligations of the provider of person identification data relying on the IPSP's service.</td></tr>
  <tr><td>(6)</td><td>7.12</td><td>Termination and termination plans</td></tr>
  <tr><td rowspan="2">&nbsp;</td><td>-</td><td>OVR-7.12-01: The requirements specified in ETSI EN 319401 [1], clause 7.12, excluding REQ-7.12-11, shall apply.</td></tr>
  <tr><td>-</td><td>NOTE: When the IPSP and the provider of person identification data requesting the identity proofing are different entities, they can agree mutual or unilateral assistance in establishing termination plans.</td></tr>
  <tr><td>(7)</td><td>8.1</td><td>Initiation</td></tr>
  <tr><td>&nbsp;</td><td>-</td><td>INI-8.1-05: In the event that the remote identity proofing process is aborted or fails, the IPSP shall ensure that individuals are provided with sufficient explanations and remedies particularly in the case of unattended remote identity proofing. The information should ensure that individuals can effectively contribute to the prompt resolution of the problem and, if needed, exercise their data subject rights – such as the right to rectification or the ability to contest the decision – against the relevant controller.</td></tr>
  <tr><td>(8)</td><td>8.2.1</td><td>General requirements</td></tr>
  <tr><td>&nbsp;</td><td>-</td><td>COL-8.2.1-08: The IPSP shall implement measures to ensure compliance with the requirements of data protection by design and by default in accordance with Article 25 of Regulation (EU) 2016/679 during the onboarding process especially as regards to the processing of biometric data. Relevant measures may consist of adequate privacy-enhancing cryptographic controls, devices and organisational measures. Those measures should limit the data collection to what is strictly necessary for the processing of biometric data and any other personal data to be collected from the physical and digital sources of identification for the binding of the User's personal identification data to their wallets and to the User's device in which the Wallet Unit is installed.</td></tr>
  <tr><td>(9)</td><td>8.2.4</td><td>Use of existing eID means as evidence</td></tr>
  <tr><td rowspan="2">&nbsp;</td><td>-</td><td>[CONDITIONAL] COL-8.2.4-02X: If the Baseline LoIP is targeted, the eID means shall have been notified at least at eIDAS LoA substantial or its assurance level shall have been confirmed by an accredited conformity assessment body defined in Article 2(13) of Regulation (EC) No 765/2008 or by an equivalent body, and, if all applicable requirements are fulfilled, the assessment shall result in a certificate of compliance based on a certification audit. This formal certification process shall be based on a security evaluation process that refers to the levels of assurance defined for notified electronic identification means or for certified European Digital Identity Wallets under Regulation (EU) No 910/2014 [i.25].</td></tr>
  <tr><td>-</td><td>COL-8.2.4-02A: void.</td></tr>
  <tr><td>(10)</td><td>8.3.1</td><td>General requirements</td></tr>
  <tr><td>&nbsp;</td><td>-</td><td>VAL-8.3.1-11X: The identity proofing process shall verify that the evidence is valid at the time of the identity proofing.</td></tr>
  <tr><td>(11)</td><td>8.3.3</td><td>Validation of physical identity document</td></tr>
  <tr><td rowspan="2">&nbsp;</td><td>-</td><td>VAL-8.3.3-21: The effectiveness of the measures for complying with the requirements VAL-8.3.3-05X, VAL-8.3.3-05A, VAL-8.3.3-05B, VAL-8.3.3-05C, VAL-8.3.3-07A and VAL-8.3.3-07X, shall be confirmed by an accredited conformity assessment body defined in Article 2(13) of Regulation (EC) No 765/2008 or an equivalent body.</td></tr>
  <tr><td>-</td><td>VAL-8.3.3-22: The reference face image from the physical identity document shall be collected using near field communication and the process shall perform passive or active authentication of the chip on the physical identity document.</td></tr>
  <tr><td>(12)</td><td>9.1</td><td>Introduction, compliance with the present document, general requirements for all use cases</td></tr>
  <tr><td rowspan="2">&nbsp;</td><td>-</td><td>USE-9.1-01X: To be compliant with the present document, an identity proofing process shall conform to use case in clause 9.5 of the present document for Extended LoIP.</td></tr>
  <tr><td>-</td><td>USE-9.1-03X: void.</td></tr>
  <tr><td>(13)</td><td>9.2.3.4</td><td>Use case for automated operation</td></tr>
  <tr><td>&nbsp;</td><td>-</td><td>USE-9.2.3.4-04: The IPSP shall establish target values for the FAR and FRR, based on a risk analysis and its threats intelligence procedure, by following the methodology established in the ENISA report 'Methodology for sectoral cybersecurity assessments' [i.28] or an equivalent methodology, in fully automated identity proofing processes. The target values used by the IPSP shall be equal to or lower than those set for hybrid use cases, when they exist. The IPSP shall maintain these target values for FAR and FRR consistently, supported by a risk analysis and its threats intelligence procedure.</td></tr>
  <tr><td>(14)</td><td>9.5.1</td><td>General requirements</td></tr>
  <tr><td rowspan="2">&nbsp;</td><td>-</td><td>First paragraph: Where the applicant is a natural person, including a natural person representing a legal person, and the identity of the applicant has been proven to Baseline LoIP by means of authentication using an eID, and an enhancement to Extended LoIP is required, the following requirements shall apply.</td></tr>
  <tr><td>-</td><td>USE-9.5.1-08: The additional identity proofing required to strengthen the reliability of an identity is only applicable for eID that have not been issued with a reliance on automated comparison between face images for the initial issuance process.</td></tr>
  <tr><td>(15)</td><td>9.5.2</td><td>Use case for enhancing identity proofing to Extended LoIP by a full identity proofing using an identity document</td></tr>
  <tr><td>&nbsp;</td><td>-</td><td>USE-9.5.2-01: The identity proofing to enhance from Baseline to Extended LoIP shall be according to the requirements for Extended LoIP from one of the use cases described in clauses 9.2.2, or 9.2.3 of the present document for Extended LoIP.</td></tr>
  <tr><td>(16)</td><td>9.5.3</td><td>Use case for enhancing identity proofing to Extended LoIP by use of a previously captured reference face image</td></tr>
  <tr><td>&nbsp;</td><td>-</td><td>USE-9.5.3-01: An identity proofing process fulfilling the requirements for Extended LoIP from one of the use cases described in clauses 9.2.2, or 9.2.3 of the present document, or the identity proofing process has been peer reviewed or certified by an accredited conformity assessment body defined in Article 2(13) of Regulation (EC) No 765/2008 or an equivalent body to comply with assurance level high in accordance with Regulation (EU) No 910/2014 [i.25] shall be used to capture a reference face image and to bind the necessary identity attributes to this reference face image.</td></tr>
</table>


---

# eIDAS - Remote qualified electronic signature and seal creation devices
Source: https://docs.igrant.io/regulations/implementing-acts-remote-creation-devices/

---
id: implementing-acts-remote-creation-devices
title: eIDAS - Remote qualified electronic signature and seal creation devices
description: Understand the EU Implementing Acts on remote qualified electronic signature and seal creation devices.
sidebar_label: Remote creation devices
keywords: [Implementing Acts, eIDAS, remote signing, qualified creation devices, electronic signature, electronic seal]
slug: /implementing-acts-remote-creation-devices/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on remote qualified electronic signature and seal creation devices."/>
</head>

Commission Implementing **Regulation (EU) 2025/1567** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1567/oj).


### Article 1: Reference standards and specifications  

The reference standards and specifications for the management of remote qualified electronic signature creation devices and of remote qualified electronic seal creation devices as qualified trust services referred to in Article 29a(2) and Article 39a of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.  

### Article 2: Entry into force and applicability  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall apply from 19 August 2027.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 July 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX - List of reference standards and specifications for the management of remote qualified electronic signature creation devices and of remote qualified electronic seal creation devices  

The standard ETSI TS 119 431-1 V1.3.1 (2024-12) ('ETSI TS 119 431-1') applies for the purpose of assessing conformance with the EU Server Signing Application Service v2 Policy in compliance with Annex A of that standard, with the following adaptations:  

   1. 2.1 Normative references; [1] ETSI EN 319 401 V3.1.1 (2024-06): 'Electronic Signatures and Trust Infrastructures (ESI); General Policy Requirements for Trust Service Providers';; [7] European Cybersecurity Certification Group, Sub-group on Cryptography: 'Agreed Cryptographic Mechanisms' published by the European Union Agency for Cybersecurity ('ENISA') (1).  

   2. 6.1 Publication and repository responsibilities; OVR-6.1-04: The information identified in OVR-6.1-01 above shall be publicly and internationally available.  

   3. 6.4.4 Personnel controls; OVR-6.4.4-02: SSASP's shall employ personnel in trusted roles and, if applicable, subcontractors in trusted roles, who possess the necessary expert knowledge, experience and qualifications through formal training and credentials, or experience, or a combination of the two.; OVR-6.4.4-03: Compliance with OVR-6.4.4-02 shall include regular (at least every 12 months) updates on new threats and current security practices.  

   4. 6.4.9 SSASP service termination; OVR-6.4.9-02: The SSASP's termination plan shall comply with the implementing acts adopted pursuant to Article 24(5) of Regulation (EU) No 910/2014 [i.1].  

   5. 6.5.5 Network security controls; OVR-6.5.5-02: The vulnerability scan requested by REQ-7.8-13 of ETSI EN 319 401 [1] shall be performed at least once per quarter.; OVR-6.5.5-03: Firewalls shall be configured to prevent all protocols and accesses not required for the operation of the TSP.  

   6. 6.8.5 Cryptographic controls; OVR-6.8.5-01: Appropriate security controls shall be in place for the management of any cryptographic techniques of the SSASP throughout their lifecycle.; OVR-6.8.5-02: As regards OVR-6.8.5-01, the SSASP shall select and use suitable cryptographic techniques compliant with the Agreed Cryptographic Mechanisms endorsed by the European Cybersecurity Certification Group and published by ENISA [7].  

   7. Annex A, section A.3 General requirements; OVR-A.3-02 [EUSPv2]: The TSP's practice statement shall include the reference to the certification of the employed QSCD in accordance with the requirements of Regulation (EU) No 910/2014 [i.1], Annex II.  

---

# eIDAS - Risk management for non-qualified trust service providers
Source: https://docs.igrant.io/regulations/implementing-acts-risk-management/

---
id: implementing-acts-risk-management
title: eIDAS - Risk management for non-qualified trust service providers
description: Learn about the EU Implementing Acts on risk management procedures for non-qualified trust service providers.
sidebar_label: Risk management procedures
keywords: [Implementing Acts, eIDAS, risk management, non-qualified providers, trust services, security, compliance]
slug: /implementing-acts-risk-management/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on risk management procedures for non-qualified trust service providers."/>
</head>

Commission Implementing **Regulation (EU) 2025/2160** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/2160/oj).


### Article 1: Reference standards  

The reference standards referred to in Article 19a(2) of Regulation (EU) No 910/2014 are set out in the Annex to this Regulation.  

### Article 2: Risk management policies  

1. The risk management policies referred to in Article 19a(1) of Regulation (EU) No 910/2014 shall clearly identify the trust services they apply to, shall be specific to the trust services concerned and shall be approved by the management body of the non-qualified trust service provider.  

2. The risk management policies shall include at least all the following elements:  

   (a) the overall risk tolerance level in accordance with the criticality and required level of security of the trust services, having regard to the latest technological developments;  

   (b) the relevant risk criteria, including at least the likelihood, impact and level of the risk, taking into account cyber threat intelligence and vulnerabilities;  

   (c) an approach for the identification and documentation of the risks to the provision of the trust services, taking into account the complete scope of the information system used by the non-qualified trust service provider, including risks associated with the components of the system as well as with any active or passive parties involved in the implementation of the system or in the provision of the trust services;  

   (d) a process for the evaluation of the identified risks based on the risk criteria referred to in point (b);  

   (e) a process for the identification, prioritisation and continuous monitoring of the implementation of appropriate risk treatment measures;  

   (f) a process for continuous monitoring of the implementation of the risk management policies.  

3. Non-qualified trust service providers shall establish appropriate procedures and maintain documents to ensure that the requirements set out in the applicable legislation are implemented.  

4. Non-qualified trust service providers shall establish appropriate documented procedures ensuring the monitoring of Union and national legislative and regulatory changes that may impact the provision of trust services.  

### Article 3: Identification, documentation and evaluation of risks  

Non-qualified trust service providers shall identify, document and evaluate all risks referred to in Article 19a(1) of Regulation (EU) No 910/2014 in accordance with the risk management policies referred to in Article 2, and shall in particular:  

   (a) identify risks in relation to third parties;  

   (b) identify potential single point of failure in the provision of the trust services;  

   (c) evaluate the identified risks based on the risk criteria referred to in Article 2(2), point (b).  

### Article 4: Risk treatment measures  

1. In accordance with the policies referred to in Article 2, non-qualified trust service providers shall plan, document and implement risk treatment measures, and shall, in particular, carry out the following tasks:  

   (a) identify and prioritise appropriate risk treatment measures;  

   (b) select, approve and document the chosen risk treatment measures, including their security requirements and operational procedures, in a risk treatment plan, identify who is responsible for implementing the risk treatment measures and when they are to be implemented;  

   (c) continuously monitor the implementation of the risk treatment measures.  

2. The risk treatment plan set out in paragraph 1, point (b), shall provide reasons justifying the acceptance of residual risks in a comprehensible manner.  

3. As part of the risk treatment measures referred to in paragraph 1, non-qualified trust service providers shall also:  

   (a) verify, where applicable, the identity of the users of the trust service directly or by means of a third party and publish information on the identity verification methods used;  

   (b) for the purposes of providing evidence in legal proceedings and of ensuring service continuity, record and securely retain for as long as necessary in accordance with Union or national laws, including after the activities of the non-qualified trust service provider have ceased, the following information:  

   - all relevant information collected in the process of registration and onboarding of the trust service users, including, where applicable, the identity verification of the users,  

   - authentication data assigned to the user of the trust service, where applicable, and  

   - any change of the status of public key certificates or other cryptographic material used in the provision of the trust service.  

   (c) ensure, where applicable, that authentication data assigned to the user of the trust service are unique.  

4. When identifying, selecting, approving and prioritising appropriate risk treatment measures, non-qualified trust service providers shall take into account the following elements:  

   (a) the results of the risk evaluation referred to in Article 3;  

   (b) the effectiveness of the risk treatment measures;  

   (c) conformity assessments;  

   (d) significant incidents;  

   (e) the cost of implementation in relation to the expected benefit;  

   (f) the applicable appropriate asset classification;  

   (g) the analysis of any business impact of the risks identified in accordance with Article 3.  

5. The management bodies of non-qualified trust service providers shall approve the residual risks remaining after the implementation of the risk treatment measures as set out in the risk treatment plan.  

6. Non-qualified trust service providers shall review, document and, where appropriate, update the risk evaluation results and the risk treatment plan at planned intervals, and at least annually, and when significant changes to the infrastructure, operations or risks, or significant incidents, occur.  

7. Non-qualified trust service providers shall ensure the availability, integrity and confidentiality of the information referred to in paragraph 3, point (b).  

### Article 5: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 27 October 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX - List of reference standards for non-qualified trust service providers  

Requirements under the following clauses of the standard ETSI EN 319 401 V3.1.1 (2024-06): 'Electronic Signatures and Trust Infrastructures (ESI); General Policy Requirements for Trust Service Providers' shall apply:  

5. Risk Assessment;  

6. Policies and practices;  

7.1 Internal organization;  

7.2 Human resources;  

7.3 Asset management;  

7.4 Access control;  

7.6 Physical and environmental security.  

---

# EUDI Wallet - Security breaches
Source: https://docs.igrant.io/regulations/implementing-acts-security-breaches/

---
id: implementing-acts-security-breaches
title: EUDI Wallet - Security breaches
description: Understand the EU Implementing Acts on handling security breaches for EU Digital Identity Wallets.
sidebar_label: Security breaches
keywords: [Implementing Acts, EUDI Wallet, security breaches, incident response, mitigation, eIDAS 2.0]
slug: /implementing-acts-security-breaches/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on handling security breaches for EU Digital Identity Wallets."/>
</head>

Commission Implementing **Regulation (EU) 2025/847** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/847/oj).


### Article 1: Subject matter  

This Regulation lays down rules for reactions to security breaches of the wallets, of the validation mechanisms referred to in Article 5a(8) of Regulation (EU) No 910/2014, and of the electronic identification scheme under which the wallets are provided.  

### Article 2: Definitions  

For the purpose of this Regulation, the following definitions apply:  

1. **'wallet solution'** means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;  

2. **'wallet user'** means a user who is in control of the wallet unit;  

3. **'wallet-relying party'** means a relying party that intends to rely upon wallet units for the provision of public or private services by means of digital interaction;  

4. **'wallet instance'** means the application installed and configured on a wallet user's device or environment, which is part of a wallet unit, and that the wallet user uses to interact with the wallet unit;  

5. **'wallet secure cryptographic application'** means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;  

6. **'wallet secure cryptographic device'** means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;  

7. **'wallet provider'** means a natural or legal person who provides wallet solutions;  

8. **'wallet unit'** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;  

9. **'critical assets'** means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;  

10. **'wallet unit attestation'** means a data object that describes the components of the wallet unit or allows authentication and validation of those components.  

### Article 3: Establishing a security breach or compromise  

1. Without prejudice to Directive (EU) 2022/2555 and to Regulations (EU) 2019/881 and (EU) 2024/2847, Member States shall duly consider the criteria set out in the Annex I to this Regulation to assess whether a security breach or compromise of a wallet solution, of the validation mechanisms referred to in Article 5a(8) of Regulation (EU) No 910/2014, or of the electronic identification scheme under which the wallet solution is provided, is affecting their reliability or the reliability of other wallet solutions.  

2. Where a Member State establishes, on the basis of the assessment laid down in paragraph 1, that a security breach or compromise is affecting the reliability of a wallet solution and suspends the provision and the use of that wallet solution, that Member State shall take the measures set out in Articles 4 and 5. Where a Member State withdraws the wallet solution, that Member State shall take the measures set out in Articles 8 and 9.  

3. Where a Member State becomes aware of information relating to a possible security breach or compromise possibly affecting the reliability of one or more wallet solutions provided by another Member State, that Member State shall, without undue delay, communicate to the Commission and the single points of contact of the affected Member States designated pursuant to Article 46c(1) of Regulation (EU) No 910/2014 on that fact. This communication shall include the information set out in Article 5(2).  

4. The Member State receiving information provided pursuant to paragraph 3 shall take the measures set out in paragraphs 1 and 2 without undue delay.  

### Article 4: Suspension of the provision and the use of wallets and other remedies  

1. Member States shall ensure that no wallet units are provided, used or activated under the suspended wallet solution.  

2. Member States shall evaluate whether revoking wallet unit attestations of the wallet units affected by the suspension of a wallet solution, or any other additional remedy, is necessary to react adequately to the security breach or compromise.  

3. The measures set out in paragraphs 1 and 2 shall be taken without undue delay, and in any event no later than 24 hours after the suspension of the provision and the use of the wallet solution affected by the security breach or compromise.  

4. The measures set out in paragraphs 1 and 2 shall not hinder affected wallet users from exercising their right to data portability set out in Article 5a(4), point (g) of Regulation (EU) No 910/2014. This is under the condition that this right may be exercised by wallet users without impairing the security of the critical assets of the affected wallet units, in particular considering the reasons for suspension and the need to ensure the effective protection of those assets against misuse.  

### Article 5: Information about suspensions and remedies  

1. Information in a clear, comprehensive and easily accessible manner about the suspension of the provision and the use of a wallet solution shall be provided, without undue delay and no later than 24 hours after the suspension of the provision and the use of the wallet solution, to:  

   (a) the single points of contact designated pursuant to Article 46c(1) of Regulation (EU) No 910/2014;  

   (b) the Commission;  

   (c) the wallet-users affected;  

   (d) the wallet-relying parties registered in accordance with Article 5b of Regulation (EU) No 910/2014.  

2. The information provided in accordance with paragraph 1 shall include at least the following:  

   (a) the name of the provider of the wallet solution the provision and the use of which has been suspended;  

   (b) the name and reference identifier of that wallet solution, as indicated in the list of certified wallets drawn up pursuant to Article 5d of Regulation (EU) No 910/2014, and, where applicable, the concerned versions;  

   (c) the date and time when the security breach or compromise was detected;  

   (d) if known, the date and time when the security breach or compromise became effective, based on network or system logs or other data sources;  

   (e) the date and time of the suspension of the wallet solution;  

   (f) contact details, including at least an email address and a telephone number for the notifying Member State, and, where different, for the wallet provider referred to in point (a);  

   (g) a description of the security breach or compromise;  

   (h) a description of the data compromised, including, where applicable, the categories of personal data as defined in Article 9(1) and Article 10 of Regulation (EU) 2016/679;  

   (i) where possible, an estimate of the approximate number of wallet users affected and of other natural persons affected;  

   (j) a description of the potential impacts on wallet-relying parties or on wallet users, and in the latter case, where relevant, any indications of measures that wallet users can take to mitigate those potential impacts;  

   (k) a description of the measures taken or planned to remedy the security breach or compromise, together with a planning and deadline for such remedy;  

   (l) where applicable and appropriate, a description of the measures taken or planned for transitioning wallet users affected to alternative wallet solutions or services.  

### Article 6: Re-establishment of the provision and the use of wallets  

Where necessary to ensure the re-establishment of the provision, the activation and the use of a wallet solution, Member States shall without undue delay:  

1. re-establish the provision and use of the wallet units provided under that wallet solution by issuing a wallet unit provided under a new version of the wallet solution to all affected users;  

2. issue new wallet unit attestations to new wallet units or, where applicable, to previously issued wallet units, provided those wallet units fulfil the security requirements in place after the security breach or compromise is remedied;  

3. repeal any measure implemented pursuant to Article 4 and hindering the provision of new wallet units under the affected wallet solution, where that measure was linked solely to the now remedied security breach or compromise.  

### Article 7: Information about re-establishment  

Where a Member State re-establishes a wallet solution, that Member State shall ensure that:  

1. information about that fact is provided without undue delay to all parties having received information on the suspension of the provision and the use of that wallet solution in accordance with Article 5(1).  

2. information provided pursuant to point (1) shall include at least the elements referred to in Article 5(2), points (a), (b) and (f) to (h) and the following:  

   (a) the date and time when the security breach or compromise was remedied;  

   (b) the date and time of the re-establishment of the affected wallet solution, and, where appropriate, of the affected wallet units provided under that wallet solution;  

   (c) a description of the measures taken to remedy the security breach or compromise;  

   (d) a description of the potential residual impacts on wallet-relying parties or on wallet users, and in the latter case, where relevant, any indications of measures that wallet users can take to mitigate those potential residual impacts.  

### Article 8: Withdrawal of wallets  

1. If a security breach or compromise having led to the suspension of the provision and the use of a wallet solution is not remedied within three months after the date of suspension of the provision and the use of that wallet solution, the Member State providing that wallet solution shall ensure the affected wallet solution is withdrawn and its validity is revoked, without undue delay and in any event within 72 hours after the period of three months has expired.  

2. When a Member State withdraws a wallet solution, it shall ensure that:  

   (a) the wallet unit attestations of the wallet unit of the affected wallet solution are revoked;  

   (b) the wallet unit attestations cannot revert to a valid state;  

   (c) no new wallet unit attestation can be issued to existing wallet units provided under the affected wallet solution;  

   (d) no new wallet unit can be provided under the affected wallet solution.  

3. The measures set out in paragraphs 1 and 2 shall not hinder affected wallet users from exercising their right to data portability set out in Article 5a(4) point (g) of Regulation (EU) No 910/2014. This is under the condition that this right may be exercised by wallet users without impairing the security of the critical assets of the affected wallet units, in particular considering the reasons for withdrawal and the need to ensure the effective protection of those assets against misuse.  

### Article 9: Information about withdrawal  

1. Information in a clear, comprehensive and easily accessible manner about the withdrawal of a wallet solution shall be provided, without undue delay and no later than 24 hours after the withdrawal of the wallet solution, to:  

   (a) the single points of contact designated pursuant to Article 46c(1) of Regulation (EU) No 910/2014;  

   (b) the Commission;  

   (c) the wallet users affected;  

   (d) the wallet-relying parties registered in accordance with Article 5b of Regulation (EU) No 910/2014.  

2. Information provided in accordance with paragraph 1 shall include at least the following:  

   (a) the name of the provider of the wallet solution which has been withdrawn;  

   (b) the name and reference identifier of that wallet solution, as indicated on the list of certified wallets drawn up pursuant to Article 5d of Regulation (EU) No 910/2014, and, where applicable, the concerned versions;  

   (c) the date and time of the detection of the security breach or compromise that led to the withdrawal of the affected wallet solution because of its severity or because it was not remedied within three months;  

   (d) if known, the date and time when the security breach or compromise became effective, based on network or system logs or other data sources;  

   (e) the date and time of the withdrawal of the wallet solution and of the effective revocation of the wallet unit attestations of the wallet units provided under the wallet solution;  

   (f) whether the withdrawal is the result of the severity of the security breach or compromise or is the consequence of the security breach or compromise not being remedied;  

   (g) contact details, including at least an email address and a telephone number for the notifying Member State, and, where different, for the wallet provider referred to in point (a);  

   (h) a description of the security breach or compromise;  

   (i) a description of the data compromised, including, where applicable, the categories of personal data as specified in Article 9(1) and Article 10 of Regulation (EU) 2016/679;  

   (j) where possible, an estimate of the approximate number of wallet users affected and of other natural persons affected;  

   (k) a description of the potential impacts on wallet-relying parties or on wallet users, and in the latter case, where relevant, any indications of measures that wallet users can take to mitigate those potential impacts;  

   (l) a description of the measures taken or planned for transitioning wallet users affected to alternative wallet solutions or, where applicable and appropriate, alternative services.  

### Article 10: Information system  

Member States shall send information set out in Articles 3, 5, 7 and 9 to the Commission and the single points of contact of the Member States designated pursuant to Article 46c(1) of Regulation (EU) No 910/2014, via the CIRAS operated by ENISA, or an equivalent system agreed by the Member States and the Commission.  

### Article 11: Entry into force  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States, except for Article 10, which shall apply from 7 May 2026.  

Done at Brussels, 6 May 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX  

### Criteria for the assessment of a security breach or compromise  

1. Member States shall base their assessment of a security breach or compromise on the following criteria:
   - (a) the breach or compromise has caused or is capable of causing the death of a natural person or considerable damage to a natural person's health  
   - (b) a successful suspectedly malicious or unauthorised access to the network and information systems of a wallet provider, of provider of validation mechanisms referred to in Article 5a(8) of Regulation (EU) No 910/2014, or of a provider of the electronic identification scheme under which a wallet solution is provided ('concerned entities') has occurred, or is capable of occurring, in a way that is capable of causing severe operational disruption, and those systems are critical components of the affected wallet solution, of the affected validation mechanisms referred to in Article 5a(8) of Regulation (EU) No 910/2014 or of the affected electronic identification scheme under which a wallet solution is provided  
   - (c) a wallet solution, a validation mechanism referred to in Article 5a(8) of Regulation (EU) No 910/2014, or an electronic identification scheme under which a wallet solution is provided, or a part of them:  
   - is completely or projected to be completely unavailable to wallet users or wallet-relying parties for more than 12 consecutive hours
   - is unavailable or projected to be unavailable to wallet users or wallet-relying parties, for more than 16 hours calculated on a calendar week basis
   - (d) it is suspected that more than 1 % of the wallet users or wallet-relying parties are impacted or are projected to be impacted by limited availability of the wallet solution, or of the services provided by concerned entities as regards the wallet solution  
   - (e) there is a capability of compromise or there has been a compromise of physical access restricted to trusted personnel of concerned entities, or of the protection of such physical access, to one or more of the locations of network and information systems supporting the wallet solution, the provision of the validation mechanisms referred to in Article 5a(8) of Regulation (EU) No 910/2014 associated with a wallet solution, or the electronic identification scheme under which a wallet solution is provided  
   - (f) the privacy, integrity, confidentiality or authenticity of data stored, transmitted or processed in the wallet solution is compromised, or is capable of being compromised, in one or more of the following ways:  
   - it has an impact on more than 1 % of the wallet users of the affected wallet solution or on more than 100 000 of those wallet users, whichever number is smaller
   - it is a result of a successful suspectedly malicious activity
   - it is a result or is likely to be a result of one or more known vulnerabilities, including those handled in accordance with Commission Implementing Regulation (EU) 2024/2981 (1)
   - it is likely to impact personal data in a manner that is likely to result in a risk to the rights and freedoms of the natural persons concerned and, in particular, in case of breach of personal data as defined in Articles 9(1) and 10 of Regulation (EU) 2016/679
   - it is likely to impact personal electronic communications
   - it is likely to result in a high risk to the rights and freedoms of natural persons
   - it is likely to impact vulnerable natural persons
   - (g) the certification of the wallet solution has been cancelled or is projected to be cancelled  
   - (h) the breach or compromise has caused or is capable of causing direct financial loss for a concerned entity, and that loss exceeds EUR 500 000 or, where applicable, 5 % of the concerned entity's total annual turnover in the preceding financial year, whichever is lower.  

2. Member States shall not consider planned consequences of a maintenance operation carried out by or on behalf of the concerned entities, provided such maintenance operation:
   - (a) has been notified in advance to potentially affected wallet users, wallet-relying parties and relevant competent supervisory bodies  
   - (b) does not meet any of the criteria set out in paragraph 1 of this Annex.  

3. As regards to point (c) of paragraph 1, the duration of an incident affecting availability shall be measured from the moment the proper provision of the affected service is disrupted until the moment the service is restored and operational again. Where a concerned entity is unable to determine the moment when the disruption began, the duration of the incident shall be measured from the moment the incident was detected, or from the moment when the incident was recorded in network or system logs or other data sources, whichever is earlier. Complete unavailability of a service shall be measured from the moment the service is fully unavailable to users, to the moment when regular activities or operations have been restored to the level of service provided prior to the incident. Where a concerned entity is unable to determine when the complete unavailability of a service began, the unavailability shall be measured from the moment it was detected by that entity.  

4. As regards point (d) of paragraph 1, limited availability of a service is considered to occur in particular when a service is considerably slower than the average response time, or where not all functionalities of a service are available. Where possible, objective criteria based on the average response times of services shall be used to assess delays in response time.  

5. To determine the direct financial losses resulting from a breach or compromise referred to in point (h) of paragraph 1, concerned entities shall take into account all financial losses incurred as a result of the incident, such as costs for replacement or relocation of software, hardware or infrastructure, staff costs, including costs associated with replacement or relocation of staff, recruitment of extra staff, remuneration of overtime and recovery of lost or impaired skills, fees due to non-compliance with contractual obligations, costs for redress and compensation to customers, losses due to forgone revenues, costs associated with internal and external communication, and advisory costs, including costs associated with legal counselling, forensic services and remediation services. Costs necessary for the day-to-day operation of the business, such as costs for general maintenance of infrastructure, equipment, hardware and software, improvements and risk assessment initiatives, and insurance premiums shall not be considered as financial losses resulting from an incident. The concerned entities shall calculate the amounts of financial losses based on available data and, where the actual amounts of financial losses cannot be determined, those entities shall estimate those amounts.  

---

# eIDAS - Trusted lists
Source: https://docs.igrant.io/regulations/implementing-acts-trusted-lists/

---
id: implementing-acts-trusted-lists
title: eIDAS - Trusted lists
description: Understand the EU Implementing Acts on trusted lists for trust service providers.
sidebar_label: Trusted lists
keywords: [Implementing Acts, eIDAS, trusted lists, trust service providers, transparency, trust services]
slug: /implementing-acts-trusted-lists/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand the EU Implementing Acts on trusted lists for trust service providers."/>
</head>

Commission Implementing **Decision (EU) 2025/2164** establishes detailed rules under Regulation (EU) No 910/2014. This decision aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/dec_impl/2025/2164/oj).


### Article 1  

Annex I to Implementing Decision (EU) 2015/1505 is amended as set out in the Annex to this Decision.  

### Article 2  

This Decision shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Implementing Decision shall apply from 29 April 2026.  

Done at Brussels, 27 October 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX  
















Annex I to Implementing Decision (EU) 2015/1505 is amended as follows:  

   1. In Chapter II, the first paragraph is replaced by the following:
      - 'The present specifications leverage the specifications and requirements set in ETSI TS 119 612 v2.4.1 (hereinafter referred to as ETSI TS 119 612).'.

   2. In Chapter II, the section under the title 'Scheme type/community/rules (clause 5.3.9)' is replaced by the following:
      - ' Scheme type/community/rules (clause 5.3.9)
      - This field shall be mandatory and shall comply with the specifications from ETSI TS 119 612 clause 5.3.9.
      - This field shall only include UK English URIs.
      - This field shall include at least two URIs:
      - (1) A URI common to all Member States' Trusted Lists pointing towards a descriptive text that shall be applicable to all Trusted Lists, as follows:  
      - URI: http://uri.etsi.org/TrstSvc/TrustedList/schemerules/EUcommon
      - Descriptive text:
      - 'A. Participation in a scheme
      - Each Member State must create a trusted list including information related to the qualified trust service providers that are under supervision, together with information related to the qualified trust services they provide, in accordance with the relevant provisions laid down in Regulation (EU) No 910/2014.
      - The present implementation of such trusted lists is also to be referred to in the list of links (pointers) towards each Member State's trusted list, compiled by the European Commission.
      - B. Policy/rules for the assessment of the listed services
      - Member States must supervise qualified trust service providers established in the territory of the designating Member State as laid down in Chapter III of Regulation (EU) No 910/2014 to ensure that those qualified trust service providers and the qualified trust services they provide meet the requirements laid down in that Regulation.
      - The trusted lists of Member States include, as a minimum, information specified in Articles 1 and 2 of Implementing Decision (EU) 2015/1505.
      - The trusted lists include both current and historical information about the status of listed trust services.
      - Each Member State's trusted list must provide information on the national supervisory scheme and, where applicable, national approval, including through accreditation scheme(s) under which the trust service providers and the trust services they provide are listed.
      - C. Interpretation of the trusted list
      - The general user guidelines for applications, services or products relying on a trusted list published in accordance with Regulation (EU) No 910/2014 are as follows:
      - C.1 Qualified status of a trust service
      - The qualified status of a trust service is indicated by the combination of:
      - the "Service type identifier" ("Sti") value in a service entry
      - where applicable, the presence of one of the following values in all the fields "additionalServiceInformation extension" in the service entry:
      - " http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/ForeSignatures ": further specifying the "Sti" identified service as being provided for electronic signatures
      - " http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/ForeSeals ": further specifying the "Sti" identified service as being provided for electronic seals
      - or
      - " http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/ForWebSiteAuthentication ": further specifying the "Sti" identified service as being provided for website authentication
      - and
      - the status according to the "Service current status" field value as from the date indicated in the "Current status starting date and time".
      - Historical information about such a qualified status is similarly provided when applicable.
      - C.1.1 Service status under Regulation (EU) No 910/2014
      - Including and after 1 July 2016 (UTC+2), the value of the "Service current status" field used by the Supervisory Body designated in a Member State to indicate that a trust service entry is representing a qualified trust service is the URI " http://uri.etsi.org/TrstSvc/TrustedList/Svcstatus/granted ".
      - C.1.2 Service status under Directive 1999/93/EC
      - Strictly before 1 July 2016 (UTC+2), the value of the "Service current status" field used by the Supervisory Body designated in a Member State to indicate that a trust service entry is representing a certification-service-provider issuing qualified certificates is one of the following URIs:
      - " http://uri.etsi.org/TrstSvc/TrustedList/Svcstatus/undersupervision "
      - " http://uri.etsi.org/TrstSvc/TrustedList/Svcstatus/supervisionincessation "
      - or
      - " http://uri.etsi.org/TrstSvc/TrustedList/Svcstatus/accredited ".
      - C.2 Qualified status of a certificate
      - Regarding qualified trust service providers issuing qualified certificates for electronic signatures, for electronic seals and/or for website authentication, a "CA/QC" "Service type identifier" ("Sti") entry indicates that any end-entity certificate issued by or under the CA represented by the CA's public key and CA's name (both CA data to be considered as trust anchor input) present in the "Service digital identifier" ("Sdi"), is or was a qualified certificate (QC) at a certain date and time provided that the trust service entry indicates a granted qualified status (see clause C.1) and that the below requirements are met with reference to that date and time.
      - C.2.1 Default rules
      - C.2.1.1 Certificate status standardised rule
      - The end-entity certificate contains the ETSI standardised QcStatements extension as specified in standard ETSI EN 319 412-5 with the following requirements:
      - the id-etsi-qcs-QcCompliance (urn:oid:0.4.0.1862.1.1) QcStatement is present
      - and
      - where present, the id-etsi-qcs-QcType (urn:oid:0.4.0.1862.1.6) QcStatement contains exactly one of the following values:
      - the id-etsi-qct-esign (urn:oid:0.4.0.1862.6.1) ETSI defined QC type identifier
      - the id-etsi-qct-eseal (urn:oid:0.4.0.1862.6.2) ETSI defined QC type identifier
      - or
      - the id-etsi-qct-web (urn:oid:0.4.0.1862.6.3) ETSI defined QC type identifier.
      - Optionally, the id-etsi-qct-QcSSCD (urn:oid:0.4.0.1862.4) QcStatement may be present.
      - C.2.1.2 Certificate status under Directive 1999/93/EC
      - Restricted to the context of Directive 1999/93/EC and as a legacy alternative to the above standardised rule, the end-entity certificate contains:
      - the ETSI standardised QcStatements extension (as specified in ETSI EN 319 412-5) with the id-etsi-qcs-QcCompliance (urn:oid:0.4.0.1862.1.1) QcStatement being present
      - the legacy QCP+ (urn:oid:0.4.0.1456.1.1) ETSI defined certificate policy OID
      - or
      - the legacy QCP (urn:oid:0.4.0.1456.1.2) ETSI defined certificate policy OID.
      - C.2.2 Additional rules: Presence of Qualifications Extension
      - If "Sie" "Qualifications Extension" information as specified in clause 5.5.9.2 of standard ETSI TS 119 612 is present, then in addition to the above default rules, those certificates that are identified through the use of "Sie" "Qualifications Extension" information must be considered according to the associated qualifiers. Those qualifiers are used when necessary to compensate for a lack of standardised machine processable information in the corresponding certificate content. They are not to be used to compensate for a lack of machine processable information in certificates issued after 1 July 2016 where that lack would result in a non-compliance with Annex I, III or IV of Regulation (EU) No 910/2014. However, they can be used to provide further machine processable information when the information provided in the certificate, while compliant with the Regulation, does not align with the above default interpretation rules. Where used, they provide additional information regarding:
      - their qualified status:
      - "QCStatement" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCStatement ") meaning the identified certificates are qualified under Directive 1999/93/EC or under Regulation (EU) No 910/2014
      - or
      - "NotQualified" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/NotQualified ") meaning the identified certificates are not to be considered as qualified.
      - the nature of their qualification:
      - "QCForESig" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCForESig ") meaning the identified certificates, when claimed or stated as qualified, are qualified certificates for electronic signature under Regulation (EU) No 910/2014
      - "QCForESeal" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCForESeal ") meaning the identified certificates, when claimed or stated as qualified, are qualified certificates for electronic seal under Regulation (EU) No 910/2014
      - or
      - "QCForWSA" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCForWSA ") meaning the identified certificates, when claimed or stated as qualified, are qualified certificates for website authentication under Regulation (EU) No 910/2014.
      - whether or not the private key resides in a qualified signature or qualified seal creation device (QSCD) and the nature thereof:
      - "QCWithQSCD" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCWithQSCD ") meaning the identified certificates, when claimed or stated as qualified, have their private key residing in a QSCD
      - "QCNoQSCD" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCNoQSCD ") meaning the identified certificates, when claimed or stated as qualified, have not their private key residing in a QSCD
      - "QCQSCDStatusAsInCert" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCQSCDStatusAsInCert ") meaning the identified certificates, when claimed or stated as qualified, do contain proper machine processable information about whether or not their private key is residing in a QSCD
      - or
      - "QCQSCDManagedOnBehalf" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCQSCDManagedOnBehalf ") meaning the identified certificates, when they are claimed or stated as qualified, have their private key is residing in a QSCD for which the generation and management of that private key is done by a qualified TSP on behalf of the entity whose identity is certified in the certificate
      - Restricted to the context of certificates issued under Directive 1999/93/EC, the following qualifiers are defined and provide additional information regarding:
      - whether or not the private key resides in a secure signature creation device (SSCD):
      - "QCWithSSCD" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCWithSSCD ") meaning the identified certificates, when claimed or stated as qualified, have their private key residing in an SSCD
      - "QCNoSSCD" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCNoSSCD ") meaning the identified certificates, when claimed or stated as qualified, do not have their private key residing in an SSCD
      - or
      - "QCSSCDStatusAsInCert" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCSSCDStatusAsInCert ") meaning the identified certificates, when claimed or stated as qualified, do contain proper machine processable information about whether or not their private key is residing in an SSCD.
      - the issuance to a Legal Person:
      - "QCForLegalPerson" (" http://uri.etsi.org/TrstSvc/TrustedList/SvcInfoExt/QCForLegalPerson ") meaning the identified certificates, when claimed or stated as qualified, are issued to a Legal Person under Directive 1999/93/EC.
      - Note:
      - if no "Sie" "Qualifications Extension" information is present for the trust anchor CA/QC corresponding service entry to qualify the certificate with a "QCStatement" qualifier, or
      - a "Sie" "Qualifications Extension" information is present for the trust anchor CA/QC corresponding service entry to qualify the certificate with a "NotQualified" qualifier.
      C.3 Trust anchors  
      - "Service digital identifiers" are to be used as Trust Anchors in the context of validating electronic signatures or seals for which signer's or seal creator's certificate is to be validated against information in the trusted list, hence only the public key and the associated subject name are needed as Trust Anchor information. When more than one certificate represents the public key identifying the service, they are to be considered as Trust Anchor certificates conveying identical information with regard to the information strictly required as Trust Anchor information.
      C.4 General rule for the interpretation of trust service entries  
      - The general rule for interpretation of any "Sti" type entry, possibly further specified through a "Sie" "additionalServiceInformation", not corresponding to qualified trust services is that, for that "Sti" identified service type, and possibly in combination with a "Sie" "additionalServiceInformation" URI, the listed service named according to the "Service name" field value and uniquely identified by the "Service digital identity" field value has the current approval status according to the "Service current status" field value as from the date indicated in the "Current status starting date and time".
      - Specific interpretation rules for any additional information with regard to a listed service (e.g. "Service information extensions" field) may be found, when applicable, in the Member State specific URI as part of the present "Scheme type/community/rules" field.
      - Please refer to the implementing acts adopted pursuant to Article 22(5) of Regulation (EU) No 910/2014 for further details on the specifications of the fields of the Member States' trusted lists.'
      - (2) A URI specific to each Member State's trusted list pointing towards a descriptive text that shall be applicable to this Member State trusted list:  
      - (a) http://uri.etsi.org/TrstSvc/TrustedList/schemerules/CC where CC = the ISO 3166-1 (1) alpha-2 Country Code used in the 'Scheme territory' field (clause 5.3.10)  
      - where users can obtain the referenced Member State's specific policies/rules against which trust services included in the list are assessed, in compliance with the Member State's supervisory regime and where applicable, approval scheme.
      - where users can obtain a referenced Member State's specific description about how to use and interpret the content of the trusted list with regard to the listed non-qualified trust services and/or to nationally defined trust services. This may be used to indicate a potential granularity in the national approval system related to CSPs / TSPs not issuing QCs and how the 'Scheme service definition URI' (clause 5.5.6) and the 'Service information extension' field (clause 5.5.9) are used for this purpose.
      - (b) Member States may define and use additional URIs expanding the above Member State specific URI (i.e. URIs defined from this hierarchical specific URI).'  

   3. In Chapter II, after the section under the title 'Service current status (clause 5.5.4)', the following section is added:
      - ' The Signature element (clause B.1), General (clause B.1.0)
      - This clause shall be mandatory and shall comply with the specifications from TS 119 612 clause B.1.0, where point (2) is replaced by the following:
      - '2)
      - Its ds:SignedInfo element shall contain a ds:Reference element with the URI attribute set to an empty string (i.e. URI=""), so as to refer to the entire document. This ds:Reference element shall satisfy the following requirements:
      - (a) It shall contain only one ds:Transforms element  
      - (b) This ds:Transforms element shall contain two ds:Transform elements. The first one will be one whose Algorithm attribute indicates the enveloped transformation with the value: "http://www.w3.org/2000/09/xmldsig#enveloped-signature". The second one will be one whose Algorithm attribute instructs to perform the exclusive canonicalization "http://www.w3.org/2001/10/xml-exc-c14n#".''  

---

# EUDI Wallet - Trust framework
Source: https://docs.igrant.io/regulations/implementing-acts-trustframework/

---
id: implementing-acts-trustframework
title: EUDI Wallet - Trust framework
description: Learn how the EU Implementing Act supports trust frameworks to ensure the trustworthiness and transparency of entities within the digital wallet ecosystem.
sidebar_label: Trust framework
keywords: [Implementing Acts, EUDI Wallet, trust framework, notification system, transparency, eIDAS 2.0]
slug: /implementing-acts-trustframework/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


Commission Implementing **Regulation (EU) 2024/2980**, adopted on 28 November 2024, establishes detailed rules for the application of Regulation (EU) No 910/2014 concerning notifications to the Commission within the European Digital Identity Wallet ecosystem. This regulation specifies the procedures and requirements for Member States to notify the Commission about trusted entities, including wallet providers, providers of person identification data, and wallet-relying parties. By defining these notification protocols, the regulation aims to **enhance transparency and trust within the European Digital Identity Framework**, ensuring that authenticated entities operate securely and reliably across the Union.

An electronic edition of the regulation is available [here](https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=OJ:L_202402980).

## Article 1: Subject matter and scope

This Regulation establishes obligations in relation to notifications that enable the validation of:

1. the electronic registers used by a Member State to publish information on wallet-relying parties registered in that Member State in accordance with Article 5b(5) of Regulation (EU) No 910/2014 (‘registers of wallet-relying parties’), the location of the registers of wallet-relying parties, and the identification of the registrars of wallet-relying parties;

2. the identity of the registered wallet-relying parties;

3. the authenticity and validity of wallet units;

4. the identification of the wallet providers;

5. the authenticity of person identification data;

6. the identification of the providers of person identification data;

to be updated on a regular basis to keep in line with technology and standards developments and with the work carried out on the basis of Recommendation (EU) 2021/946, and in particular the architecture and reference framework.

## Article 2: Definitions

For the purpose of this Regulation, the following definitions apply:

1. **‘wallet provider’** means a natural or legal person who provides wallet solutions;

2. **‘provider of person identification data’** means a natural or legal person responsible for issuing and revoking the person identification data and ensuring that the person identification data of a user is cryptographically bound to a wallet unit;

3. **‘wallet-relying party’** means a relying party that intends to rely upon wallet units for the provision of public or private services by means of digital interaction;

4. **‘register of wallet-relying parties’** means an electronic register used by a Member State to make information on wallet-relying parties registered in that Member State publicly available as set out in Article 5b(5) of Regulation (EU) No 910/2014;

5. **‘registrar of wallet-relying parties’** means the body responsible for establishing and maintaining the list of registered wallet-relying parties established in their territory who has been designated by a Member State;

6. **‘wallet unit’** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;

7. **‘wallet solution’** means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;

8. **‘wallet instance’** means the application installed and configured on a wallet user’s device or environment, which is part of a wallet unit, and that the wallet user uses to interact with the wallet unit;

9. **‘wallet secure cryptographic application’** means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;

10. **‘wallet secure cryptographic device’** means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;

11. **‘critical assets’** means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;

12. **‘wallet user’** means a user who is in control of the wallet unit;

13. **‘provider of wallet-relying party access certificates’** means a natural or legal person mandated by a Member State to issue relying party access certificates to wallet-relying parties registered in that Member State;

14. **‘wallet-relying party access certificate’** means a certificate for electronic seals or signatures authenticating and validating the wallet-relying party issued by a provider of wallet-relying party access certificates.

## Article 3: Notification system

1. The Commission shall make available to Member States a secure electronic notification system, no later than twelve months after the publication of this Regulation in the Official Journal of the European Union, enabling Member States to notify the information on the bodies and mechanisms referred to in Article 5a(18) of Regulation (EU) No 910/2014.

2. The secure electronic notification system shall comply with the technical requirements laid down in Annex I.

## Article 4: Notifications by Member States

1. Member States shall submit, through the secure electronic notification system referred to in Article 3(1), at least the information specified in Annex II.

2. Member States shall make the notifications at least in English. Member States shall not be obliged to translate any document supporting the notifications where this would create an unreasonable administrative or financial burden.

3. The Commission may request additional information or clarifications from the Member States for the purpose of verifying the completeness and consistency of the notified information.

## Article 5: Publications by the Commission

1. The Commission shall establish, maintain and publish a list compiling the information notified by Member States on registrars of wallet-relying parties and registers of wallet-relying parties as referred to in Annex II section 1.

2. The Commission shall establish, maintain and publish a list compiling the information notified by Member States on wallet providers, providers of person identification data and providers of wallet-relying party access certificates, as referred to in Annex II sections 2, 3 and 4.

3. The Commission shall ensure the lists referred to in paragraphs 1 and 2 of this Article can be accessed:

   (a) in both electronically signed or sealed form suitable for automated processing and through a human-readable website available in at least English;
   
   (b) without the need to register or to be authenticated to obtain or read the lists;
   
   (c) securely by using state-of-the-art transport layer encryption.

4. In addition to the publications of the lists referred to in paragraphs 1 and 2, the Commission shall publish:
   
   (a) the technical specifications the Commission uses for the structure of the lists;
   
   (b) the details of the URL where the lists are published;
   
   (c) the certificates to be used to verify the signature or seal on the lists;
   
   (d) the details on mechanisms used to validate changes to the location referred to in point (b) or to the certificates referred to in point (c).

## Article 6: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the Official Journal of the European Union.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

**Done at Brussels, 28 November 2024.**

---

# eIDAS - Verification of electronic attestations (standards update)
Source: https://docs.igrant.io/regulations/implementing-acts-verification-attestations-update/

---
id: implementing-acts-verification-attestations-update
title: eIDAS - Verification of electronic attestations (standards update)
description: Understand Implementing Regulation (EU) 2026/1735, which updates the standards and specifications for verifying electronic attestations of attributes.
sidebar_label: Verification of attestations (standards update)
keywords: [Implementing Acts, eIDAS, EUDI Wallet, electronic attestations, verification, standards and specifications, 2026/1735, 2025/1569]
slug: /implementing-acts-verification-attestations-update/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand Implementing Regulation (EU) 2026/1735, which updates the standards and specifications for verifying electronic attestations of attributes."/>
</head>

Commission Implementing **Regulation (EU) 2026/1735** of 15 July 2026 amends Implementing Regulation (EU) 2025/1569 as regards applicable standards and specifications. It is made under Regulation (EU) No 910/2014 on electronic identification and trust services (in particular Articles 45d(5), 45e(2), 45f(6) and 45f(7)), and updates the technical basis for the <a href="/regulations/implementing-acts-verification-attestations/">verification of electronic attestations of attributes</a>.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2026/1735/oj).

:::note
This regulation is an amending act. The summary below describes the changes it makes to Implementing Regulation (EU) 2025/1569. For the authoritative wording of each amendment, refer to the official text in the Official Journal linked above.
:::

### Article 1: Amendments to Implementing Regulation (EU) 2025/1569

This Article amends the rules for verifying electronic attestations of attributes:

- It modifies Article 3(2) to require compliance with the schemes for the attestation of attributes, where applicable.
- It amends Article 4 concerning the circumstances of revocation and the use of privacy-preserving techniques.
- It updates Article 9 to include verification mechanism specifications and the signing or sealing requirements for verification results.

The reference standards are set out in technical Annexes I to IV, which include the ETSI TS 119 471 and ETSI TS 119 478 standards.

### Article 2: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

Article 1(3) shall apply from 1 January 2027.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 15 July 2026.

For the Commission

The President

Ursula VON DER LEYEN


---

# EUDI Wallet - Verification of electronic attestation of attributes
Source: https://docs.igrant.io/regulations/implementing-acts-verification-attestations/

---
id: implementing-acts-verification-attestations
title: EUDI Wallet - Verification of electronic attestation of attributes
description: Learn about the EU Implementing Acts on verification of electronic attestation of attributes for EU Digital Identity Wallets.
sidebar_label: Verification of attestations
keywords: [Implementing Acts, EUDI Wallet, verification, electronic attestation, attributes, eIDAS 2.0]
slug: /implementing-acts-verification-attestations/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Learn about the EU Implementing Acts on verification of electronic attestation of attributes for EU Digital Identity Wallets."/>
</head>

Commission Implementing **Regulation (EU) 2025/1569** establishes detailed rules under Regulation (EU) No 910/2014. This regulation aims to ensure consistent standards across EU Member States, enhancing trust and interoperability within the European Digital Identity ecosystem.

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2025/1569/oj).


### Article 1: Subject matter and scope  

This Regulation lays down the reference standards, specifications, and procedures, to be updated on a regular basis to keep in line with technology and standards developments and with the work carried out on the basis of Recommendation (EU) 2021/946, and in particular the Architecture and Reference Framework, relating to:  

1. qualified electronic attestations of attributes;  

2. electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source;  

3. the list of providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source;  

4. catalogue of attributes and catalogue of schemes for the attestations of attributes referred to in points (1) and (2);  

5. the verification of attributes with reference to authentic sources or designated intermediaries.  

### Article 2: Definitions  

For the purpose of this Regulation, the following definitions apply:  

1. **'wallet unit'** means a unique configuration of a wallet solution that includes wallet instances, wallet secure cryptographic applications and wallet secure cryptographic devices provided by a wallet provider to an individual wallet user;  

2. **'wallet user'** means a user who is in control of the wallet unit;  

3. **'catalogue of attributes'** means a digital repository of attributes that is maintained and published online by the Commission;  

4. **'scheme for the attestation of attributes'** means a set of rules applicable to one or more types of electronic attestation of attributes;  

5. **'type of electronic attestation of attributes'** means a specifically named and semantically described group of electronic attestation of attributes;  

6. **'catalogue of schemes for the attestation of attributes'** means a digital repository listing schemes for the attestation of attributes registered in accordance with this Regulation and that is maintained [and published online] by the Commission;  

7. **'wallet solution'** means a combination of software, hardware, services, settings, and configurations, including wallet instances, one or more wallet secure cryptographic applications and one or more wallet secure cryptographic devices;  

8. **'wallet instance'** means the application installed and configured on a wallet user's device or environment, which is part of a wallet unit, and which the wallet user uses to interact with the wallet unit;  

9. **'wallet secure cryptographic application'** means an application that manages critical assets by being linked to and using the cryptographic and non-cryptographic functions provided by the wallet secure cryptographic device;  

10. **'wallet secure cryptographic device'** means a tamper-resistant device that provides an environment that is linked to and used by the wallet secure cryptographic application to protect critical assets and provide cryptographic functions for the secure execution of critical operations;  

11. **'wallet provider'** means a natural or legal person who provides wallet solutions;  

12. **'critical assets'** means assets within or in relation to a wallet unit of such extraordinary importance that where their availability, confidentiality or integrity are compromised, this would have a very serious, debilitating effect on the ability to rely on the wallet unit;  

13. **'owner of a scheme for the attestation of attributes'** means an entity responsible for establishing and maintaining a scheme for the attestation of attributes.  

### Article 3: Issuance of qualified electronic attestations of attributes and electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source  

1. Providers of qualified electronic attestations of attributes and providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source shall comply with the list of reference standards and specifications set out in Annex I and shall ensure that the electronic attestations of attributes they issue comply with the technical specifications set out in Annex II.  

2. Where providers of qualified electronic attestations of attributes and providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source issue electronic attestations of attributes which are included in schemes registered in the catalogue of schemes for the attestation of attributes, they shall comply with the requirements of the corresponding scheme for the attestation of attributes. Policies and procedures established by the issuers of attestations in order to grant compliance with the requirements of the schemes for the attestation of attributes shall be part of the conformity assessment established in Regulation (EU) No 910/2014.  

### Article 4: Revocation of qualified electronic attestations of attributes and electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source  

1. Providers of qualified electronic attestations of attributes and providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source shall have written and publicly accessible policies relating to validity or revocation status management. These policies shall include, where applicable, the conditions under which electronic attestations of attributes can be revoked without delay and measures for ensuring the availability of the validity status information.  

2. Providers of qualified electronic attestations of attributes and providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source shall be the only entities able to revoke the electronic attestations of attributes they issue.  

3. Providers of qualified electronic attestations of attributes and providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source, whenever those attestations are issued with a validity period of more than 24 hours, shall revoke them in at least the following circumstances:  

   (a) upon the explicit request of the person to whom the electronic attestation of attributes was issued or, where applicable, of the subject of the attestation;  

   (b) where it is known to the provider that there has been a compromise of the security or trustworthiness of the qualified electronic attestations of attributes or electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source;  

   (c) in other situations, as required by Union or national law, or as determined by the providers in their policies as referred to in paragraph 1.  

4. Providers of qualified electronic attestations of attributes and providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source shall set up revocation techniques and management methods that are privacy preserving and hindering linkability or traceability.  

5. Providers of qualified electronic attestations of attributes and providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source shall make available to relying parties information on the validity or revocation status of the electronic attestations of attributes they have issued in a manner that ensures the integrity and authenticity of that information.  

### Article 5: Notification of public sector bodies  

1. Member States shall submit at least the information set out in Annex III on public sector bodies as referred to in Article 45f (3) of Regulation (EU) No 910/2014 through a secure electronic notification system provided by the Commission.  

2. Member States shall notify any changes to the notified information.  

3. Member States shall make the notifications at least in English. Member States shall not be obliged to translate any document supporting the notifications where this would create an unreasonable administrative or financial burden.  

4. The Commission may, where appropriate, ask the Member States to provide additional information.  

### Article 6: Publication of the list of public sector bodies  

1. The Commission shall establish, maintain, and publish a list of providers of electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source on the basis of the information notified by Member States pursuant to Article 5.  

2. The Commission shall ensure that the list referred to in paragraph 1 can be accessed:  

   (a) in both electronically signed or sealed form suitable for automated processing, and through a human-readable website;  

   (b) without the need to register or to be authenticated;  

   (c) only by using state of the art transport layer security.  

3. The Commission shall publish through a secure channel and without undue delay:  

   (a) the technical specifications of the list;  

   (b) the details of the URL where the list is published;  

   (c) the certificates to be used to verify the electronic signature or seal on the list;  

   (d) details relating to the mechanisms used to validate future changes to the location or to the certificates referred to in points (b) and (c).  

### Article 7: Creation and maintenance of the catalogue of attributes  

1. The Commission shall establish and publish a catalogue of attributes and set up a secure system to enable requests to include or modify attributes in the catalogue of attributes.  

2. The Commission shall assess requests made using the system referred to in paragraph 1 to include or modify an attribute in the catalogue of attributes, after considering any advice provided by the Cooperation Group. The Commission's assessment shall, take into account whether the inclusion of the attribute contributes to a common foundation for secure and privacy-aware electronic interaction between citizens, businesses and public authorities and to fostering interoperability. The Commission shall also take into account sector-specific regulations, where applicable.  

3. Member States shall request the inclusion of attributes listed in Annex VI to Regulation (EU) No 910/2014 to the catalogue of attributes wherever those attributes rely on authentic sources for the purpose of the verification by qualified trust service providers.  

4. In addition, Member States may request the inclusion of attributes not listed in Annex VI to the catalogue of attributes wherever those attributes rely on authentic sources within the public sector. Private entities that are considered to be a primary source of information or recognised as authentic in accordance with Union or national law, including administrative practice, may request the inclusion of attributes not listed in Annex VI to the catalogue of attributes wherever the requesting entity is responsible for those attributes.  

5. The request to include or to modify an attribute in the catalogue shall contain at least the following information:  

   (a) identification of the entity making the request;  

   (b) where applicable, a reference to Union or national law or administrative practice under which the entity making the request is considered to be a primary source of information or recognised authentic source.  

   (c) if the request refers to an attribute already existing in the catalogue or is a new attribute;  

   (d) a namespace for the identifier of the attributes, the value of which is unique within the catalogue of attributes;  

   (e) an identifier of the attribute, unique within the namespace, and the version of the attribute;  

   (f) semantic description of the attribute;  

   (g) the data type of the attribute;  

   (h) the verification point for the attribute at national level or a link to a description on how to initiate the verification requests.  

6. The request to include or modify an attribute shall be signed or sealed by the requester by means of a qualified electronic signature or seal or an advanced electronic signature or seal based on a qualified certificate.  

7. The Commission, following the assessment referred to in paragraph 2 and having verified that the information provided in the request for the inclusion or modification of an attribute includes all the information listed in paragraph 5, may include the requested attribute or modification in the catalogue of attributes.  

8. The catalogue of attributes sealed by the Commission shall be publicly accessible, through a secure channel, free of charge and without prior identification or authentication, and shall be published in both machine-readable and human-readable forms. The catalogue shall also include a search function.  

9. The Commission shall publish the technical specifications the Commission uses for the catalogue of attributes.  

10. The Commission shall issue a unique identifier to each registered attribute.  

### Article 8: Creation and maintenance of the catalogue of schemes for the attestation of attributes  

1. The Commission shall establish and publish a catalogue of schemes for the attestation of attributes and set up a secure system to enable requests to include or modify schemes for the attestation of attributes in the catalogue of schemes for the attestation of attributes.  

2. Requests to include or modify schemes for the attestation of attributes in the catalogue of schemes for the attestation of attributes shall be assessed by the Commission, after considering any advice provided by the Cooperation Group. The Commission's assessment shall take into account whether the scheme contributes to a common foundation for secure and privacy-aware electronic interaction between citizens, businesses and public authorities and contributes to fostering interoperability. The Commission shall also take into account sector-specific regulations where applicable.  

3. Owners of a scheme for the attestation of attributes may request adding schemes to the catalogue of schemes. A request to include or modify a scheme in the catalogue of schemes for the attestation of attributes shall contain, at least:  

   (a) the name of the scheme, chosen by the scheme for the attestation of attributes owner and unique within the catalogue of schemes for the attestation of attributes;  

   (b) the name and contact information of the scheme for the attestation of attributes owner;  

   (c) the status and version of the scheme;  

   (d) a reference to specific laws, standards or guidelines, where the issuance, validation, or use of an electronic attestation of attributes within the scope of the scheme is subject to them;  

   (e) the format or formats of electronic attestation of attributes within the scope of the scheme;  

   (f) one or more namespaces, attribute identifiers, semantic descriptions and data types of each attribute that is part of an electronic attestation of attributes within the scope of the scheme, either by reference to an attribute in the catalogue of attributes in Article 7, or an attribute defined in an analogue way within the scope of the scheme;  

   (g) a description of the trust model and the governance mechanisms applied under the scheme, including the revocation mechanisms;  

   (h) any requirements concerning the providers of the electronic attestations of attributes or the sources of information on which those providers rely when issuing electronic attestations of attributes, including any authentic sources, if applicable;  

   (i) a statement whether electronic attestations of attributes within the scope of the scheme are to be issued as qualified electronic attestations of attributes, as electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source, or as both.  

4. The schemes for which inclusion in the catalogue is requested shall only contain attributes that are identifiable based on unique identifiers. The request to include or modify a scheme for the attestation of attributes shall be signed or sealed by the requester by means of a qualified electronic signature or seal or an advanced electronic signature or seal based on a qualified certificate.  

5. The Commission, following the assessment referred to in paragraph 2 and having verified that the information provided in the request for the inclusion or modification of an attestation scheme contains all the information listed in paragraphs 3 and 4 may include the requested scheme or modification in the catalogue of schemes for the attestation of attributes.  

6. The catalogue of schemes for the attestation of attributes, sealed by the Commission, shall be publicly accessible, through a secure channel, free of charge and without prior identification or authentication, and shall be machine-readable and human-readable. The catalogue shall also include a search function and shall be in a format that guarantees integrity and authenticity.  

7. The Commission shall publish the technical specifications the Commission uses for the catalogue of schemes for the attestation of attributes.  

8. The Commission shall issue a unique identifier to each registered scheme for the attestation of attributes.  

### Article 9: Verification of attributes against authentic sources or designated intermediaries  

1. To enable the electronic verification of the attributes referred to in Article 45e(1) of Regulation (EU) No 910/2014 by qualified trust service providers issuing qualified electronic attestations of attributes, at the request of the user, Member States shall establish mechanisms that allow that verification and may make available single points of verification for the attributes listed in Annex VI of that Regulation wherever those attributes rely on authentic sources within the public sector. Member States shall publish information on the procedures for initiating the verification requests and for receiving the verification results.  

2. The verification mechanism shall provide an access point where qualified trust service providers issuing qualified electronic attestations of attributes can electronically request the verification against authentic sources or designated intermediaries recognised at national level, of the attributes referred to in Article 45e(1) of Regulation (EU) No 910/2014. Attributes subject to verification will be provided to the verification point by the qualified trust service provider at the user request. The public sector body or designated intermediary shall share, through the verification point, the verification results with the qualified trust service providers issuing qualified electronic attestations of attributes.  

3. The verification request shall set out the attributes and the identification data of the subject of the attribute for which the qualified trust service provider requests the verification.  

4. The verification result shall state exclusively whether the attribute has been verified or not and specify the public sector body responsible for the authentic source or, where applicable, the public sector body designated to act on behalf of the authentic source against which the attribute has been verified.  

5. Member States may impose access controls or other verification mechanisms that provide integrity, authenticity, and confidentiality to determine that the requester is a qualified trust service provider and is acting at the request of a legitimate user. Member States may also impose control mechanisms on the use of the verification methods, where they deem this appropriate, taking into account relevant factors, including whether the authentic sources contain personal confidential or sensitive data. Where Member States establish these control mechanisms, they shall publish information on the extent of the control mechanisms as part of the information referred to in paragraph 1.  

### Article 10: Interoperability and reuse  

1. For the purpose of Articles 3 to 9, Member States may refer to and re-use the common services of the technical system set out in Article 14 of Regulation (EU) 2018/1724, as well as the national components connected to them.  

2. When establishing the secure notification system and the list of public sector bodies referred to in Articles 5 and 6 and the catalogues referred to in Articles 7 and 8 of this Regulation, the European Commission shall refer to and re-use, where appropriate, the common services of the technical system pursuant to Regulation (EU) 2018/1724.  

### Article 11: Entry into force and application  

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.  

This Regulation shall be binding in its entirety and directly applicable in all Member States.  

Done at Brussels, 29 July 2025.  

For the Commission  

The President  

Ursula VON DER LEYEN  

## ANNEX I - List of reference standards and specifications referred to in Article 3  

Providers of qualified electronic attestations of attributes and providers of electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source shall issue their attestations to natural or legal persons according to the specifications for trust service providers established in standard ETSI EN 319 401 v3.1.1 (2024-06) ('ETSI EN 319 401').  

## ANNEX II - Technical specifications for the issuance of qualified electronic attestations of attributes and electronic attestations of attributes issued by or on behalf of a public sector body responsible for an authentic source referred to in Article 3  

   1. Providers of qualified electronic attestations of attributes and providers of electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source shall issue their attestations in a format according to one of the standards listed in Annex II of Commission Implementing Regulation (EU) 2024/2979 (1).  

   2. For the issuance of attestations to natural or legal persons, providers of qualified electronic attestation of attributes and providers of electronic attestation of attributes issued by or on behalf of a public sector body responsible for an authentic source shall:
      - (a) where applicable, verify that the requester of the attestation has the right to act on behalf of the person that is the subject of the attestation  
      - (b) where applicable, verify the identity of the authentic source used as a source for the attributes included in the attestation  
      - (c) process only the minimum set of attributes necessary for the issuance and management of the attestation.  

   3. In addition, where the attestation is issued to a European Digital Identity Wallet, the attestation provider shall:
      - (a) authenticate to the wallet unit  
      - (b) verify that the wallet unit is not revoked or suspended.  

## ANNEX III - Notifications referred to in Article 5  

Member States shall notify to the Commission at least:  

   1. the name of the public sector body, and where applicable, the registration number as used in official records; the Member State in which the public sector body is established; the Union or national law under which the public sector body is established as the responsible for the authentic source on the basis of which the electronic attestation of attributes is issued or is designated to act on behalf of the public sector body that is responsible for the authentic source;  

   2. the contact email and phone number of the public sector body;  

   3. the URL of the webpage for additional information about the public sector body;  

   4. conformity assessment report as specified Article 45f (3) of Regulation (EU) No 910/2014.  

---

# eIDAS - EUDI Wallet core acts (standards update)
Source: https://docs.igrant.io/regulations/implementing-acts-wallet-standards-update/

---
id: implementing-acts-wallet-standards-update
title: eIDAS - EUDI Wallet core acts (standards update)
description: Understand Implementing Regulation (EU) 2026/1731, which updates the standards and specifications across four core EUDI Wallet implementing acts.
sidebar_label: Wallet core acts (standards update)
keywords: [Implementing Acts, eIDAS, EUDI Wallet, standards and specifications, trust mark, 2026/1731, 2024/2977, 2024/2979, 2024/2980, 2024/2982]
slug: /implementing-acts-wallet-standards-update/
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```

<head>
   <title>Understand the EU Implementing Acts for Digital ID | iGrant.io DevDocs</title>
   <meta name="description" content="Understand Implementing Regulation (EU) 2026/1731, which updates the standards and specifications across four core EUDI Wallet implementing acts."/>
</head>

Commission Implementing **Regulation (EU) 2026/1731** of 15 July 2026 amends Implementing Regulations (EU) 2024/2977, (EU) 2024/2979, (EU) 2024/2980 and (EU) 2024/2982 as regards applicable standards and specifications. It is made under Regulation (EU) No 910/2014 on electronic identification and trust services (in particular Article 5a(23)), and brings the technical specifications of four core European Digital Identity Wallet acts into line with the applicable standards.

The four acts it updates are the ones covering <a href="/regulations/implementing-acts-pid-and-eaass/">person identification data and electronic attestations</a> (2024/2977), <a href="/regulations/implementing-acts-integrity-and-core-functions/">integrity and core functionalities</a> (2024/2979), the <a href="/regulations/implementing-acts-trustframework/">trust framework</a> (2024/2980), and the <a href="/regulations/implementing-acts-protocols-and-interfaces-to-be-supported/">protocols and interfaces to be supported</a> (2024/2982).

An electronic edition of the same is available [here](http://data.europa.eu/eli/reg_impl/2026/1731/oj).

:::note
This regulation is an amending act. The summary below describes the changes it makes to the four acts it references. For the authoritative wording of each amendment, refer to the official text in the Official Journal linked above.
:::

### Article 1: Amendments to Implementing Regulation (EU) 2024/2977 (person identification data and electronic attestations)

- Inserts Article 3a requiring wallet providers to warn the user when portrait data is requested, and to obtain the user's explicit confirmation before that data is disclosed.
- Revises the standards for electronic attestations of attributes.
- Amends the technical specifications in the Annex concerning the encoding of person identification data.

### Article 2: Amendments to Implementing Regulation (EU) 2024/2979 (integrity and core functionalities)

- Updates the cryptographic mechanism requirements and the wallet unit attestation specifications.
- Updates the standards for signature creation applications.
- Introduces Article 14a mandating the display of the EU Digital Identity Wallet Trust Mark, with defined visual characteristics and technical requirements.

### Article 3: Amendments to Implementing Regulation (EU) 2024/2980 (trust framework)

- Clarifies the Commission's role in maintaining the lists of ecosystem providers, namely wallet providers, person identification data providers and certificate providers.
- Modifies the related notification procedures accordingly.

### Article 4: Amendments to Implementing Regulation (EU) 2024/2982 (protocols and interfaces)

- Refines the wallet unit requirements for authenticating and validating certificates.
- Removes the delegation of tasks to an intermediary application.
- Establishes presentation protocols for attributes.
- Sets specific entry-into-force dates, including a delayed application date of 11 August 2028 for the validation of wallet-relying party registration certificates.

### Article 5: Entry into force

This Regulation shall enter into force on the twentieth day following that of its publication in the *Official Journal of the European Union*.

This Regulation shall be binding in its entirety and directly applicable in all Member States.

Done at Brussels, 15 July 2026.

For the Commission

The President

Ursula VON DER LEYEN


---

# eIDAS and EU Regulations
Source: https://docs.igrant.io/regulations/

---
id: reg-main
title: eIDAS and EU Regulations
description: Reference documentation for the European regulations underpinning the EUDI Wallet ecosystem, including eIDAS, GDPR, Data Governance Act, and Data Act.
keywords: [EU regulations, GDPR, eIDAS, eIDAS 2.0, data governance, digital identity, data protection, European Digital Identity, consent, implementing regulations]
hide_title: true
sidebar_label: Overview
slug: /
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import {RegulationOverviewGrid} from '@site/src/components/RegulationCard';
import {dataRegulationsOverviewData} from '@site/src/components/RegulationCard/dataRegulationsOverviewData';

# eIDAS and EU Regulations

Reference documentation for the European regulations underpinning the EUDI Wallet ecosystem. Covers the foundational EU regulations governing digital identity, data protection, and data governance (eIDAS, GDPR, Data Governance Act, Data Act) together with the full set of Implementing Regulations adopted under Regulation (EU) 2024/1183 that define the technical, security, and interoperability requirements for EU Digital Identity Wallets.

<RegulationOverviewGrid
  data={dataRegulationsOverviewData}
  title=""
  subtitle="Explore each regulation with a summary and detailed breakdown."
  ctaText="Read More"
  maxDescLength={220}
/>


---

# Data Agreement Vocab - Version 1.0
Source: https://docs.igrant.io/schema/data-agreements/v1.0

---
id: mdo-da-vocab-1.0
title: Data Agreement Vocab - Version 1.0
sidebar_label: Version 1.0
slug: /data-agreements/v1.0
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


The Data Agreement Vocabulary provides terms to describe and represent information related to processing of personal data based on established requirements such as for the EU General Data Protection Regulation (GDPR).

## context
**Description:** Defines the context of any this document. E.g. the link to the JSON-LD

| @type                  | Example value(s)                                                                                                                                                          |
| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| https://schema.org/URL | https://raw.githubusercontent.com/decentralised-dataexchange/automated-data-agreements/main/interface-specs/data-agreement-schema/v1/data-agreement-schema-context.jsonld |

## id

**Description:** Identifier to the data agreement instance addressed to a specific individual (Data Subject).

| @type                                      | Example value(s)                     |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | b728d03e-c983-4322-8a46-2bf126b403de |

## version

**Description:** Version number of the data agreement

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/version | v1.0.0           |

## template_id

**Description:** Identifier to the template of the data agreement.

| @type                                      | Example value(s)                     |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | 91be609a-4acd-468f-b37a-0f379893b65c |

## template_version

**Description:** Version number of the data agreement template

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/version | v1.0.0           |

## data_controller_name

**Description:** An organisation constituted as a legally defined entity in any jurisdiction.

| @type                                      | Example value     |
| :----------------------------------------- | :---------------- |
| https://w3c.github.io/dpv/dpv/#LegalEntity | Happy Shopping AB |

## data_controller_url

**Description:** Organisation or data controller URL.

| @type                  | Example value         |
| :--------------------- | :-------------------- |
| https://schema.org/URL | www.happyshopping.com |

## purpose

**Description:** Describes the purpose for which a data controller (Data Source or Data Using Service) uses personal data for. This is also the purpose for which the data agreeent is being formulated

| @type                            | Example value(s)       |
| :------------------------------- | :--------------------- |
| http://www.w3.org/ns/dpv#Purpose | Marketing and Campaign |

## purpose_description

**Description:** Provides description of the purpose for which the personal data us used, comprehensive to the individual whose data is being used by the data controller.

| @type                   | Example value(s)                                                      |
| :---------------------- | :-------------------------------------------------------------------- |
| https://schema.org/Text | Collecting user data for offering custom tailored shopping experience |

## lawful_basis

**Description:** An organization processing personal data to have a valid lawful basis for that personal data processing activity. GDPR, for e.g., provides six legal bases for processing personal data, consent being one.

Possible values as per GDPR are: consent, legal_obligation, contract, vital_interest, public_task and legitimate_interest.

| @type                               | Example value |
| :---------------------------------- | :------------ |
| http://www.w3.org/ns/dpv#LegalBasis | consent       |

## method_of_use

**Description:** This is used to describe whether controller is using personal data for internal purposes of for data exchange towards an external third party. Data exchange could be for exposing data (as a Data Source) or consuming data as a Data Using Service.

| @type                   | Example value(s)                    |
| :---------------------- | :---------------------------------- |
| https://schema.org/Text | null/data-source/data-using-service |

## policy

Description: Encapsulate the data policies used in the use of personal data.

### data_retention_period

**Description:** The amount of time that an organization holds onto any personal data, in days.

| @type                     | Example value |
| :------------------------ | :------------ |
| https://schema.org/Number | 30            |

:::Note
**Example:** GDPR does not specify retention periods for personal data. Instead, it states that personal data may only be kept in a form that permits identification of the individual for no longer than is necessary for the purposes for which it was processed. Typical limit is for 3 years.
:::

### geographic_restriction

**Description:** The geographic restrictions required or followed regarding storage of data.

| @type                                             | Example value |
| :------------------------------------------------ | :------------ |
| https://w3c.github.io/dpv/dpv/#StorageRestriction | Europe        |

### industry_sector

**Description:** Indicate or restrict scope for interpretation and application of purpose in a domain.

| @type                                 | Example value |
| :------------------------------------ | :------------ |
| https://w3c.github.io/dpv/dpv/#Sector | Public        |

### jurisdiction

**Description:** Indicates a legal jurisdiction, e.g. of some legislation, or where some government service is based.

| @type                           | Example value |
| :------------------------------ | :------------ |
| https://schema.org/jurisdiction | Sweden        |

### policy_url

**Description:** A URL specifying the privacy policy that discloses some or all of the ways an organisation gathers, uses, discloses, and manages a customer or client's personal data.

| @type                  | Example value                            |
| :--------------------- | :--------------------------------------- |
| https://schema.org/URL | https://happyshoping.com/privacy-policy/ |

### storage_location

**Description:** The geographic location where the personal data is stored

| @type                                    | Example value |
| :--------------------------------------- | :------------ |
| http://www.w3.org/ns/dpv#StorageLocation | Europe        |

## personal_data

**Description:** Encapsulates the attributes used for the the usage purpose defined.

### attribute_category

**Description:** A category of personal data.

| @type                                         | Example value(s) |
| :-------------------------------------------- | :--------------- |
| http://www.w3.org/ns/dpv#PersonalDataCategory | Personal, Health |

### attribute_id

**Description:** Identifiery for the attribute.

| @type                                      | Example value(s)                    |
| :----------------------------------------- | :---------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | f216cb1-aedb-571e-46f7-2fef51dedb54 |

### attribute_name

**Description:** Name of the attribute

| @type                   | Example value(s) |
| :---------------------- | :--------------- |
| https://schema.org/Text | Name             |

### attribute_sensitive

**Description:** Indicates that personal data is sensitive or belongs to a special category as per a regulations, typically requiring additional measures of handling.

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/Boolean | true             |

## dpia

**Description:** Encapsulate the organisation performing the Data Protection Impact Assessment (DPIA).

### date

**Description:** The date on which the DPIA report is generated after a DPIA.

| @type                       | Example value             |
| :-------------------------- | :------------------------ |
| https://schema.org/DateTime | 2021-05-08T08:41:59+0000" |

### summary_url

**Description:** The URl providing the DPIA result reports, summary etc that can be verified by any interested parties.

| @type                  | Example value                     |
| :--------------------- | :-------------------------------- |
| https://schema.org/URL | https://org.com/dpia_results.html |

## event

**Description:** Encapsulates the data agreement lifecyle event data. For e.g. Data Agreement Offer, Accept, Reject, Terminate etc.

### did

**Description:** The DID associated with the entity executing the event. E.g. An organisation (Data Controller) or an Individual (Data Subject).

| @type                                                                                                                    | Example value                                               |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp |

### id

**Description:** The identifier of the event.

| @type                                      | Example value                        |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | 3da6f76e-598c-11ec-bf63-0242ac130002 |

### state

**Description:** The current state of the event during a data agreement lifecycle. E.g. Offer, Accept, Reject and Terminate

| @type                   | Example value |
| :---------------------- | :------------ |
| https://schema.org/Text | Offer         |

### timestamp

**Description:** The time at which the event occurred.

| @type                       | Example value            |
| :-------------------------- | :----------------------- |
| https://schema.org/DateTime | 2021-05-08T08:41:59+0000 |

## data_subject_did

**Description:** Decentralised Identifier (DID) of the individual (Data Subject)

| @type                                                                                                                    | Example value(s)                                            |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkGskxnGjLrk3gKS2mesDpuwRBokeWcmrgHxUXfnncxiZP |

## proof

**Description:** Encapsulates the event signatures that allows anyone (e.g. an auditor) to verify the authencity and source of the data agreement. Its uses linked data proofs as per W3C and contains a set of attributes that represent a Linked Data digital proof and the parameters required to verify it.

### id

**Description:** Identifier of the proof

| @type                                                                                                                    | Example value(s)                                              |
| :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#1 |

### type

**Description:** Type of the proof

| @type                                                                                                                    | Example value(s)                                              |
| :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#1 |

### created

**Description:** Creation time of the proof

| @type                                     | Example value(s)         |
| :---------------------------------------- | :----------------------- |
| http://www.w3.org/2001/XMLSchema#dateTime | 2021-05-08T08:41:59+0000 |

### proofPurpose

**Description:** Purpose of the proof

| @type                                  | Example value(s)  |
| :------------------------------------- | :---------------- |
| https://w3id.org/security#proofPurpose | contractAgreement |

### proofValue

**Description:** Value of the proof (Signature digest)

| @type                                | Example value(s)                                                                                 |
| :----------------------------------- | :----------------------------------------------------------------------------------------------- |
| https://w3id.org/security#proofValue | z6MkwW6aqMnjgrhJXFUko3NnZPGzVpkNzhYK7yEhnsibmLwLz6MkwW6aqMnjgrhJXFUko3NnZPGzVpkNzhYK7yEhnsibmLwL |

### verificationMethod

**Description:** Method of verification for the proof

| @type                                                                                                                    | Example value(s)                                            |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp |


---

# Data Disclosure Agreement Vocab - Version 1.0
Source: https://docs.igrant.io/schema/data-disclosure-agreements/v1.0

---
id: mdo-dda-vocab-1.0
title: Data Disclosure Agreement Vocab - Version 1.0
sidebar_label: Version 1.0
slug: /data-disclosure-agreements/v1.0
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


The Data Disclosure Agreement Vocabulary provides terms to describe and represent information related to processing of personal data based on established requirements such as for the EU General Data Protection Regulation (GDPR).

## @context
**Description:** Defines the context of any this document. E.g. the link to the JSON-LD

| @type                  | Example value(s)                                                                                                                               |
| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |
| https://schema.org/URL | https://raw.githubusercontent.com/decentralised-dataexchange/data-exchange-agreements/main/interface-specs/jsonld/contexts/dexa-context.jsonld |

## @id

**Description:** Identifier to the Data Disclosure Agreement instance addressed to an Organisation (Data Using Service).

| @type                                      | Example value(s)                     |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | b728d03e-c983-4322-8a46-2bf126b403de |

## language

**Description:** Language of the Data Disclosure Agreement

| @type                                           | Example value(s) |
| :---------------------------------------------- | :--------------- |
| https://dictionary.mydata.org/prodserv/#language | v1.0.0           |


## version

**Description:** Version number of the Data Disclosure Agreement

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/version | 0.0.1            |

## templateId

**Description:** Identifier to the template of the Data Disclosure Agreement.

| @type                                                                    | Example value(s)                     |
| :----------------------------------------------------------------------- | :----------------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#templateId | 91be609a-4acd-468f-b37a-0f379893b65c |

## templateVersion

**Description:** Version number of the Data Disclosure Agreement template

| @type                                                                         | Example value(s) |
| :---------------------------------------------------------------------------- | :--------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#templateVersion | 0.0.1            |

## dataController

**Description:** An organisation constituted as a legally defined entity in any jurisdiction.

| @type                                                                        | Example value |
| :--------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dataController | nil           |

## dcDid

**Description:** Data controller decentralised identifier

| @type                                                               | Example value  |
| :------------------------------------------------------------------ | :------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dcDid | did:mydata:abc |

## dcIndustrySector

**Description:** Data controller industry sector

| @type                                                                          | Example value |
| :----------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dcIndustrySector | Retail        |

## dcLegalId

**Description:** Data controller legal identifier

| @type                                                                   | Example value |
| :---------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dcLegalId | lei:abc       |

## dcName

**Description:** Data controller name

| @type                                                                | Example value     |
| :------------------------------------------------------------------- | :---------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dcName | Happy Shopping AB |

## dcURL

**Description:** Data controller URL

| @type                                                               | Example value             |
| :------------------------------------------------------------------ | :------------------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dcURL | https://happyshopping.com |

## agreementPeriod

**Description:** Agreement period

| @type                                                                         | Example value |
| :---------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#agreementPeriod | 365           |

## purpose

**Description:** Describes the purpose for which a data controller (Data Source or Data Using Service) uses personal data for. This is also the purpose for which the data agreeent is being formulated

| @type                                                                 | Example value(s)       |
| :-------------------------------------------------------------------- | :--------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#purpose | Marketing and Campaign |

## purposeDescription

**Description:** Provides description of the purpose for which the personal data us used, comprehensive to the individual whose data is being used by the data controller.

| @type                                                                            | Example value(s)                                                      |
| :------------------------------------------------------------------------------- | :-------------------------------------------------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#purposeDescription | Collecting user data for offering custom tailored shopping experience |

## lawfulBasis

**Description:** An organization processing personal data to have a valid lawful basis for that personal data processing activity. GDPR, for e.g., provides six legal bases for processing personal data, consent being one.

Possible values as per GDPR are: consent, legal_obligation, contract, vital_interest, public_task and legitimate_interest.

| @type                                                                     | Example value |
| :------------------------------------------------------------------------ | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#lawfulBasis | consent       |

## codeOfConduct

**Description:** Code of conduct

| @type                                                                       | Example value                                  |
| :-------------------------------------------------------------------------- | :--------------------------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#codeOfConduct | https://happyshopping.com/code_of_conduct.html |

## personalData

**Description:** Personal data exposed by the Data Source

| @type                                                                      | Example value |
| :------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#personalData | nil           |


## pdAttributeId

**Description:** Personal data attribute ID

| @type                                                                       | Example value                        |
| :-------------------------------------------------------------------------- | :----------------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#pdAttributeId | a601c468-4d26-41e1-8ad9-30eb16746751 |


## pdAttributeName

**Description:** Personal data attribute name

| @type                                                                         | Example value |
| :---------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#pdAttributeName | Customer ID   |


## pdAttributeSensitive

**Description:** Personal data attribute sensitive

| @type                                                                              | Example value |
| :--------------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#pdAttributeSensitive | true          |



## pdAttributeCategory

**Description:** Personal data attribute category

| @type                                                                             | Example value |
| :-------------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#pdAttributeCategory | KYC           |

## dataUsingService

**Description:** Data Using Service

| @type                                                                          | Example value |
| :----------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dataUsingService | nil           |

## dusDid

**Description:** Data Using Service decentralised identifier

| @type                                                                | Example value                     |
| :------------------------------------------------------------------- | :-------------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusDid | did:mydata:3Wcyfb5QZ7mvtBXrY8Jg3h |

## dusIndustrySector

**Description:** Data Using Service industry sector

| @type                                                                           | Example value |
| :------------------------------------------------------------------------------ | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusIndustrySector | Retail        |

## dusJurisdiction

**Description:** Data Using Service jurisdiction

| @type                                                                         | Example value |
| :---------------------------------------------------------------------------- | :------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusJurisdiction | EU            |

## dusLegalId

**Description:** Data Using Service legal ID

| @type                                                                    | Example value              |
| :----------------------------------------------------------------------- | :------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusLegalId | lei:3Wcyfb5QZ7mvtBXrY8Jg3h |


## dusName

**Description:** Data Using Service name

| @type                                                                 | Example value     |
| :-------------------------------------------------------------------- | :---------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusName | Happy Shopping AB |


## dusPrivacyRights

**Description:** Data Using Service privacy rights

| @type                                                                          | Example value                 |
| :----------------------------------------------------------------------------- | :---------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusPrivacyRights | https://retail.se/policy.html |


## dusSignatureContact

**Description:** Data Using Service signature contact

| @type                                                                             | Example value                  |
| :-------------------------------------------------------------------------------- | :----------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusSignatureContact | did:sov:3Wcyfb5QZ7mvtBXrY8Jg3h |


## dusUrl

**Description:** Data Using Service URL

| @type                                                                | Example value                         |
| :------------------------------------------------------------------- | :------------------------------------ |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusUrl | https://happyshopping.com/policy.html |


## dusUsagePurposes

**Description:** Data Using Service purposes

| @type                                                                          | Example value               |
| :----------------------------------------------------------------------------- | :-------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusUsagePurposes | Account transaction history |


## dusWithdrawal

**Description:** Data Using Service withdrawal

| @type                                                                       | Example value                     |
| :-------------------------------------------------------------------------- | :-------------------------------- |
| https://docs.igrant.io/schema/data-disclosure-agreement/v1.0/#dusWithdrawal | https://retail.se/withdrawal.html |

## proof

**Description:** Encapsulates the event signatures that allows anyone (e.g. an auditor) to verify the authencity and source of the Data Disclosure Agreement. Its uses linked data proofs as per W3C and contains a set of attributes that represent a Linked Data digital proof and the parameters required to verify it.

### id

**Description:** Identifier of the proof

| @type                                                                                                                    | Example value(s)                                              |
| :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#1 |

### type

**Description:** Type of the proof

| @type                                                                                                                    | Example value(s)                                              |
| :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#1 |

### created

**Description:** Creation time of the proof

| @type                                     | Example value(s)         |
| :---------------------------------------- | :----------------------- |
| http://www.w3.org/2001/XMLSchema#dateTime | 2021-05-08T08:41:59+0000 |

### proofPurpose

**Description:** Purpose of the proof

| @type                                  | Example value(s)  |
| :------------------------------------- | :---------------- |
| https://w3id.org/security#proofPurpose | contractAgreement |

### proofValue

**Description:** Value of the proof (Signature digest)

| @type                                | Example value(s)                                                                                 |
| :----------------------------------- | :----------------------------------------------------------------------------------------------- |
| https://w3id.org/security#proofValue | z6MkwW6aqMnjgrhJXFUko3NnZPGzVpkNzhYK7yEhnsibmLwLz6MkwW6aqMnjgrhJXFUko3NnZPGzVpkNzhYK7yEhnsibmLwL |

### verificationMethod

**Description:** Method of verification for the proof

| @type                                                                                                                    | Example value(s)                                            |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp |


---

# Data Agreement Vocab - Version 1.1
Source: https://docs.igrant.io/schema/data-agreements/v1.1

---
id: mdo-da-vocab-1.1
title: Data Agreement Vocab - Version 1.1
sidebar_label: Version 1.1
slug: /data-agreements/v1.1
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


The Data Agreement Vocabulary provides terms to describe and represent information related to processing of personal data based on established requirements such as for the EU General Data Protection Regulation (GDPR).

## context
**Description:** Defines the context of any this document. E.g. the link to the JSON-LD

| @type                  | Example value(s)                                                                                                                                                          |
| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| https://schema.org/URL | https://raw.githubusercontent.com/decentralised-dataexchange/automated-data-agreements/main/interface-specs/data-agreement-schema/v1/data-agreement-schema-context.jsonld |

## id

**Description:** Identifier to the data agreement instance addressed to a specific individual (Data Subject).

| @type                                      | Example value(s)                     |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | b728d03e-c983-4322-8a46-2bf126b403de |

## version

**Description:** Version number of the data agreement

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/version | v1.0.0           |

## template_id

**Description:** Identifier to the template of the data agreement.

| @type                                      | Example value(s)                     |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | 91be609a-4acd-468f-b37a-0f379893b65c |

## template_version

**Description:** Version number of the data agreement template

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/version | v1.0.0           |

## data_controller_name

**Description:** An organisation constituted as a legally defined entity in any jurisdiction.

| @type                                      | Example value     |
| :----------------------------------------- | :---------------- |
| https://w3c.github.io/dpv/dpv/#LegalEntity | Happy Shopping AB |

## data_controller_url

**Description:** Organisation or data controller URL.

| @type                  | Example value         |
| :--------------------- | :-------------------- |
| https://schema.org/URL | www.happyshopping.com |

## data_controller_legal_id

**Description:** This is the legal ID to the data controller

| @type                      | Example value                                                           |
| :------------------------- | :---------------------------------------------------------------------- |
| https://schema.org/leiCode | Organisation number, e.g. Swedish org no. 559133-2720, DUNS number etc. |

## purpose

**Description:** Describes the purpose for which a data controller (Data Source or Data Using Service) uses personal data for. This is also the purpose for which the data agreeent is being formulated

| @type                            | Example value(s)       |
| :------------------------------- | :--------------------- |
| http://www.w3.org/ns/dpv#Purpose | Marketing and Campaign |

## purpose_description

**Description:** Provides description of the purpose for which the personal data us used, comprehensive to the individual whose data is being used by the data controller.

| @type                   | Example value(s)                                                      |
| :---------------------- | :-------------------------------------------------------------------- |
| https://schema.org/Text | Collecting user data for offering custom tailored shopping experience |

## lawful_basis

**Description:** An organization processing personal data to have a valid lawful basis for that personal data processing activity. GDPR, for e.g., provides six legal bases for processing personal data, consent being one.

Possible values as per GDPR are: consent, legal_obligation, contract, vital_interest, public_task and legitimate_interest.

| @type                               | Example value |
| :---------------------------------- | :------------ |
| http://www.w3.org/ns/dpv#LegalBasis | consent       |

## method_of_use

**Description:** This is used to describe whether controller is using personal data for internal purposes of for data exchange towards an external third party. Data exchange could be for exposing data (as a Data Source) or consuming data as a Data Using Service.

| @type                   | Example value(s)                    |
| :---------------------- | :---------------------------------- |
| https://schema.org/Text | null/data-source/data-using-service |

## policy

Description: Encapsulate the data policies used in the use of personal data.

### data_retention_period

**Description:** The amount of time that an organization holds onto any personal data, in days.

| @type                     | Example value |
| :------------------------ | :------------ |
| https://schema.org/Number | 30            |

:::Note
**Example:** GDPR does not specify retention periods for personal data. Instead, it states that personal data may only be kept in a form that permits identification of the individual for no longer than is necessary for the purposes for which it was processed. Typical limit is for 3 years.
:::

### geographic_restriction

**Description:** The geographic restrictions required or followed regarding storage of data.

| @type                                             | Example value |
| :------------------------------------------------ | :------------ |
| https://w3c.github.io/dpv/dpv/#StorageRestriction | Europe        |

### industry_sector

**Description:** Indicate or restrict scope for interpretation and application of purpose in a domain.

| @type                                 | Example value |
| :------------------------------------ | :------------ |
| https://w3c.github.io/dpv/dpv/#Sector | Public        |

### jurisdiction

**Description:** Indicates a legal jurisdiction, e.g. of some legislation, or where some government service is based.

| @type                           | Example value |
| :------------------------------ | :------------ |
| https://schema.org/jurisdiction | Sweden        |

### policy_url

**Description:** A URL specifying the privacy policy that discloses some or all of the ways an organisation gathers, uses, discloses, and manages a customer or client's personal data.

| @type                  | Example value                            |
| :--------------------- | :--------------------------------------- |
| https://schema.org/URL | https://happyshoping.com/privacy-policy/ |

### storage_location

**Description:** The geographic location where the personal data is stored

| @type                                    | Example value |
| :--------------------------------------- | :------------ |
| http://www.w3.org/ns/dpv#StorageLocation | Europe        |

### third_party_disclosure

**Description:** This is a boolean value to indicate that the DA is used for third party data disclosures. This indicates that some data disclosures will happen and is used to release personal data to DUS based on an agreement

| @type                      | Example value |
| :------------------------- | :------------ |
| https://schema.org/Boolean | True or False |

### code_of_conduct

**Description:** The data controller may follow a code of conduct which sets the proper application of privacy regulation taking into account specific features within a sector. The code of conduct shall reference the name of the code of conduct and with a public accessible reference.

| @type                  | Example value                             |
| :--------------------- | :---------------------------------------- |
| https://schema.org/URL | https://happyshoping.com/code-of-conduct/ |

## personal_data []

**Description:** Encapsulates the attributes used for the the usage purpose defined. Its an array of personal data attributes.

### attribute_category

**Description:** A category of personal data.

| @type                                         | Example value(s) |
| :-------------------------------------------- | :--------------- |
| http://www.w3.org/ns/dpv#PersonalDataCategory | Personal, Health |

### attribute_id

**Description:** Identifiery for the attribute.

| @type                                      | Example value(s)                    |
| :----------------------------------------- | :---------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | f216cb1-aedb-571e-46f7-2fef51dedb54 |

### attribute_name

**Description:** Name of the attribute

| @type                   | Example value(s) |
| :---------------------- | :--------------- |
| https://schema.org/Text | Name             |

### attribute_sensitive

**Description:** Indicates that personal data is sensitive or belongs to a special category as per a regulations, typically requiring additional measures of handling.

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/Boolean | true             |

### attribute_retrictions []

**Description:** [OPTIONAL] If provided, this can be used t restrict where the data is being consumed from. Its an array of attribute retrictions

| @type                         | Example value(s) |
| :---------------------------- | :--------------- |
| https://schema.org/Collection | NIL              |

## dpia

**Description:** Encapsulate the organisation performing the Data Protection Impact Assessment (DPIA).

### date

**Description:** The date on which the DPIA report is generated after a DPIA.

| @type                       | Example value             |
| :-------------------------- | :------------------------ |
| https://schema.org/DateTime | 2021-05-08T08:41:59+0000" |

### summary_url

**Description:** The URl providing the DPIA result reports, summary etc that can be verified by any interested parties.

| @type                  | Example value                     |
| :--------------------- | :-------------------------------- |
| https://schema.org/URL | https://org.com/dpia_results.html |

## event

**Description:** Encapsulates the data agreement lifecyle event data. For e.g. Data Agreement Offer, Accept, Reject, Terminate etc.

### did

**Description:** The DID associated with the entity executing the event. E.g. An organisation (Data Controller) or an Individual (Data Subject).

| @type                                                                                                                    | Example value                                               |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp |

### id

**Description:** The identifier of the event.

| @type                                      | Example value                        |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | 3da6f76e-598c-11ec-bf63-0242ac130002 |

### state

**Description:** The current state of the event during a data agreement lifecycle. E.g. Offer, Accept, Reject and Terminate

| @type                   | Example value |
| :---------------------- | :------------ |
| https://schema.org/Text | Offer         |

### timestamp

**Description:** The time at which the event occurred.

| @type                       | Example value            |
| :-------------------------- | :----------------------- |
| https://schema.org/DateTime | 2021-05-08T08:41:59+0000 |

## data_subject_did

**Description:** Decentralised Identifier (DID) of the individual (Data Subject)

| @type                                                                                                                    | Example value(s)                                            |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkGskxnGjLrk3gKS2mesDpuwRBokeWcmrgHxUXfnncxiZP |

## proof

**Description:** Encapsulates the event signatures that allows anyone (e.g. an auditor) to verify the authencity and source of the data agreement. Its uses linked data proofs as per W3C and contains a set of attributes that represent a Linked Data digital proof and the parameters required to verify it.

### id

**Description:** Identifier of the proof

| @type                                                                                                                    | Example value(s)                                              |
| :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#1 |

### type

**Description:** Type of the proof

| @type                                                                                                                    | Example value(s)                                              |
| :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#1 |

### created

**Description:** Creation time of the proof

| @type                                     | Example value(s)         |
| :---------------------------------------- | :----------------------- |
| http://www.w3.org/2001/XMLSchema#dateTime | 2021-05-08T08:41:59+0000 |

### proofPurpose

**Description:** Purpose of the proof

| @type                                  | Example value(s)  |
| :------------------------------------- | :---------------- |
| https://w3id.org/security#proofPurpose | contractAgreement |

### proofValue

**Description:** Value of the proof (Signature digest)

| @type                                | Example value(s)                                                                                 |
| :----------------------------------- | :----------------------------------------------------------------------------------------------- |
| https://w3id.org/security#proofValue | z6MkwW6aqMnjgrhJXFUko3NnZPGzVpkNzhYK7yEhnsibmLwLz6MkwW6aqMnjgrhJXFUko3NnZPGzVpkNzhYK7yEhnsibmLwL |

### verificationMethod

**Description:** Method of verification for the proof

| @type                                                                                                                    | Example value(s)                                            |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp |

## revocation_list

**Description:** Link to the storage location of the recocation list for the agreement

| @type                  | Example value(s)                        |
| :--------------------- | :-------------------------------------- |
| https://schema.org/URL | https://www.org.com/revocation:list.crl |

## data_expiry

**Description:** Expiry for the agreement (in epoch time - seconds)

| @type                       | Example value(s)     |
| :-------------------------- | :------------------- |
| https://schema.org/Duration | Epoc time in seconds |


---

# Data Disclosure Agreement Vocab - Version 1.0
Source: https://docs.igrant.io/dda/data-disclosure-agreements/v1.0

---
id: mdo-dda-vocab-1.0
title: Data Disclosure Agreement Vocab - Version 1.0
sidebar_label: Version 1.0
slug: /data-disclosure-agreements/v1.0
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


The Data Agreement Vocabulary provides terms to describe and represent information related to processing of personal data based on established requirements such as for the EU General Data Protection Regulation (GDPR).

## context
**Description:** Defines the context of any this document. E.g. the link to the JSON-LD

| @type                  | Example value(s)                                                                                                                                                          |
| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| https://schema.org/URL | https://raw.githubusercontent.com/decentralised-dataexchange/automated-data-agreements/main/interface-specs/data-agreement-schema/v1/data-agreement-schema-context.jsonld |

## id

**Description:** Identifier to the data agreement instance addressed to a specific individual (Data Subject).

| @type                                      | Example value(s)                     |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | b728d03e-c983-4322-8a46-2bf126b403de |

## version

**Description:** Version number of the data agreement

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/version | v1.0.0           |

## template_id

**Description:** Identifier to the template of the data agreement.

| @type                                      | Example value(s)                     |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | 91be609a-4acd-468f-b37a-0f379893b65c |

## template_version

**Description:** Version number of the data agreement template

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/version | v1.0.0           |

## data_controller_name

**Description:** An organisation constituted as a legally defined entity in any jurisdiction.

| @type                                      | Example value     |
| :----------------------------------------- | :---------------- |
| https://w3c.github.io/dpv/dpv/#LegalEntity | Happy Shopping AB |

## data_controller_url

**Description:** Organisation or data controller URL.

| @type                  | Example value         |
| :--------------------- | :-------------------- |
| https://schema.org/URL | www.happyshopping.com |

## purpose

**Description:** Describes the purpose for which a data controller (Data Source or Data Using Service) uses personal data for. This is also the purpose for which the data agreeent is being formulated

| @type                            | Example value(s)       |
| :------------------------------- | :--------------------- |
| http://www.w3.org/ns/dpv#Purpose | Marketing and Campaign |

## purpose_description

**Description:** Provides description of the purpose for which the personal data us used, comprehensive to the individual whose data is being used by the data controller.

| @type                   | Example value(s)                                                      |
| :---------------------- | :-------------------------------------------------------------------- |
| https://schema.org/Text | Collecting user data for offering custom tailored shopping experience |

## lawful_basis

**Description:** An organization processing personal data to have a valid lawful basis for that personal data processing activity. GDPR, for e.g., provides six lawful bases for processing personal data, consent being one.

Possible values as per GDPR are: consent, legal_obligation, contract, vital_interest, public_task and legitimate_interest.

| @type                               | Example value |
| :---------------------------------- | :------------ |
| http://www.w3.org/ns/dpv#LegalBasis | consent       |

## method_of_use

**Description:** This is used to describe whether controller is using personal data for internal purposes of for data exchange towards an external third party. Data exchange could be for exposing data (as a Data Source) or consuming data as a Data Using Service.

| @type                   | Example value(s)                    |
| :---------------------- | :---------------------------------- |
| https://schema.org/Text | null/data-source/data-using-service |

## policy

Description: Encapsulate the data policies used in the use of personal data.

### data_retention_period

**Description:** The amount of time that an organization holds onto any personal data, in days.

| @type                     | Example value |
| :------------------------ | :------------ |
| https://schema.org/Number | 30            |

:::Note
**Example:** GDPR does not specify retention periods for personal data. Instead, it states that personal data may only be kept in a form that permits identification of the individual for no longer than is necessary for the purposes for which it was processed. Typical limit is for 3 years.
:::

### geographic_restriction

**Description:** The geographic restrictions required or followed regarding storage of data.

| @type                                             | Example value |
| :------------------------------------------------ | :------------ |
| https://w3c.github.io/dpv/dpv/#StorageRestriction | Europe        |

### industry_sector

**Description:** Indicate or restrict scope for interpretation and application of purpose in a domain.

| @type                                 | Example value |
| :------------------------------------ | :------------ |
| https://w3c.github.io/dpv/dpv/#Sector | Public        |

### jurisdiction

**Description:** Indicates a legal jurisdiction, e.g. of some legislation, or where some government service is based.

| @type                           | Example value |
| :------------------------------ | :------------ |
| https://schema.org/jurisdiction | Sweden        |

### policy_url

**Description:** A URL specifying the privacy policy that discloses some or all of the ways an organisation gathers, uses, discloses, and manages a customer or client's personal data.

| @type                  | Example value                            |
| :--------------------- | :--------------------------------------- |
| https://schema.org/URL | https://happyshoping.com/privacy-policy/ |

### storage_location

**Description:** The geographic location where the personal data is stored

| @type                                    | Example value |
| :--------------------------------------- | :------------ |
| http://www.w3.org/ns/dpv#StorageLocation | Europe        |

## personal_data

**Description:** Encapsulates the attributes used for the the usage purpose defined.

### attribute_category

**Description:** A category of personal data.

| @type                                         | Example value(s) |
| :-------------------------------------------- | :--------------- |
| http://www.w3.org/ns/dpv#PersonalDataCategory | Personal, Health |

### attribute_id

**Description:** Identifiery for the attribute.

| @type                                      | Example value(s)                    |
| :----------------------------------------- | :---------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | f216cb1-aedb-571e-46f7-2fef51dedb54 |

### attribute_name

**Description:** Name of the attribute

| @type                   | Example value(s) |
| :---------------------- | :--------------- |
| https://schema.org/Text | Name             |

### attribute_sensitive

**Description:** Indicates that personal data is sensitive or belongs to a special category as per a regulations, typically requiring additional measures of handling.

| @type                      | Example value(s) |
| :------------------------- | :--------------- |
| https://schema.org/Boolean | true             |

## dpia

**Description:** Encapsulate the organisation performing the Data Protection Impact Assessment (DPIA).

### date

**Description:** The date on which the DPIA report is generated after a DPIA.

| @type                       | Example value             |
| :-------------------------- | :------------------------ |
| https://schema.org/DateTime | 2021-05-08T08:41:59+0000" |

### summary_url

**Description:** The URl providing the DPIA result reports, summary etc that can be verified by any interested parties.

| @type                  | Example value                     |
| :--------------------- | :-------------------------------- |
| https://schema.org/URL | https://org.com/dpia_results.html |

## event

**Description:** Encapsulates the data agreement lifecyle event data. For e.g. Data Agreement Offer, Accept, Reject, Terminate etc.

### did

**Description:** The DID associated with the entity executing the event. E.g. An organisation (Data Controller) or an Individual (Data Subject).

| @type                                                                                                                    | Example value                                               |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp |

### id

**Description:** The identifier of the event.

| @type                                      | Example value                        |
| :----------------------------------------- | :----------------------------------- |
| https://dictionary.mydata.org/prodserv/#uid | 3da6f76e-598c-11ec-bf63-0242ac130002 |

### state

**Description:** The current state of the event during a data agreement lifecycle. E.g. Offer, Accept, Reject and Terminate

| @type                   | Example value |
| :---------------------- | :------------ |
| https://schema.org/Text | Offer         |

### timestamp

**Description:** The time at which the event occurred.

| @type                       | Example value            |
| :-------------------------- | :----------------------- |
| https://schema.org/DateTime | 2021-05-08T08:41:59+0000 |

## data_subject_did

**Description:** Decentralised Identifier (DID) of the individual (Data Subject)

| @type                                                                                                                    | Example value(s)                                            |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkGskxnGjLrk3gKS2mesDpuwRBokeWcmrgHxUXfnncxiZP |

## proof

**Description:** Encapsulates the event signatures that allows anyone (e.g. an auditor) to verify the authencity and source of the data agreement. Its uses linked data proofs as per W3C and contains a set of attributes that represent a Linked Data digital proof and the parameters required to verify it.

### id

**Description:** Identifier of the proof

| @type                                                                                                                    | Example value(s)                                              |
| :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#1 |

### type

**Description:** Type of the proof

| @type                                                                                                                    | Example value(s)                                              |
| :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp#1 |

### created

**Description:** Creation time of the proof

| @type                                     | Example value(s)         |
| :---------------------------------------- | :----------------------- |
| http://www.w3.org/2001/XMLSchema#dateTime | 2021-05-08T08:41:59+0000 |

### proofPurpose

**Description:** Purpose of the proof

| @type                                  | Example value(s)  |
| :------------------------------------- | :---------------- |
| https://w3id.org/security#proofPurpose | contractAgreement |

### proofValue

**Description:** Value of the proof (Signature digest)

| @type                                | Example value(s)                                                                                 |
| :----------------------------------- | :----------------------------------------------------------------------------------------------- |
| https://w3id.org/security#proofValue | z6MkwW6aqMnjgrhJXFUko3NnZPGzVpkNzhYK7yEhnsibmLwLz6MkwW6aqMnjgrhJXFUko3NnZPGzVpkNzhYK7yEhnsibmLwL |

### verificationMethod

**Description:** Method of verification for the proof

| @type                                                                                                                    | Example value(s)                                            |
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| https://github.com/decentralised-dataexchange/automated-data-agreements/blob/main/docs/did-spec.md#2the-didmydata-format | did:mydata:z6MkiTBz1ymuepAQ4HEHYSF1H8quG5GLVVQR3djdX3mDooWp |